Perfect 미니 프로젝트 [3]


1. 사진 게시물 등록하기 
2. URL을 통해 사진 GET 


API를 하나씩 하나씩 완성해 나가도록 합시다!!

참고

2017년 7월 현재 Swift 3 / Perfect 최신버전 2.0.x 환경에서 진행함을 알려드립니다.

* Swift 최신 버전 확인(https://github.com/apple/swift/releases)

* Perfect 최신 버전 확인(https://github.com/PerfectlySoft/Perfect/releases)


지난 내용 돌아보기

2017/06/27 - [Swift/Perfect] - 사진 게시판 API 만들기 [1]

2017/07/11 - [Swift/Perfect] - 사진 게시판 API 만들기 [2]



사진 게시물 등록하기

먼저 CRUD 중, Create를 먼저 해보도록 할게요. 사진 게시물 등록을 위한 API를 구현해 봅니다. 사진 게시물 등록은 /article 경로에 POST 메서드를 통해 multipart/form-data를 전송합니다.

지난 번 정의한 API 스펙 중 사진 게시물 등록 API의 정보입니다.

요청(Request)

  • HTTP Method : POST
  • Content-Type: multipart/form-data

 매개변수

자료형 

값의 범위/기본 값 

비고 

 필수여부

image 

binary data

 

이미지 데이터 

user_name

string 

 

사용자 이름 

Y

description

string 

 

이미지 설명 

N

title

string 

 

이미지 제목 

Y


응답(Response)

Key 

자료형 

비고 

필수여부 

article_id 

string 

업로드된 게시물 고유 식별자 

 image_url

string 

이미지 주소 

user_name 

string 

사용자 이름 

description 

 string

이미지 설명 

title 

string 

이미지 제목 


우선 Sources/handlers.swift 파일로 이동하여 반복적으로 수행할 것 같은 기능이나, 상수를 정의해보려 합니다.

먼저 필수 매개변수가 모두 실려왔는지 확인하는 함수를 만듭니다. handlers.swift 파일 맨 아래쪽에 함수를 만들어봅니다.


// 부족한 매개변수가 없는지 확인하여 부족한 매개변수가 있다면 String Array로 반환
private func lakedParams(paramsNeeded: [String], paramsReceived: [(String, String)]) -> [String]? {
    
    var laked: [String] = []
    
    for param in paramsNeeded {
        if paramsReceived.filter({ (key, _) -> Bool in
            return key == param
        }).isEmpty {
            laked.append(param)
        }
    }
    
    return laked.count > 0 ? laked : nil
}

또, 나중에 해보시면 아시겠지만 JSONConvertible 타입의 데이터를 응답 객체의 body에 셋팅하려면 꼭 오류처리(try)를 해줘야 합니다. 매 번 하기 귀찮아서 그냥 함수를 하나 만들어줬습니다. lakedParams(paramsNeeded:paramsReceived:) 함수 아래에 작성해봅니다.

// 응답 보내기
private func sendCompleteResponse(_ response: HTTPResponse, status: HTTPResponseStatus = .ok, jsonBody: JSONConvertible? = nil) {
    do {
        if let json = jsonBody {
            try response.setBody(json: json)
        }
        response.completed(status: status)
    } catch {
        response.completed(status: .internalServerError)
    }
}


참, 그리고 요청에서 실려온 이미지를 저장할 디렉터리도 미리 지정해 두고 싶구요, 매개변수 이름이나 JSON 키값도 미리 지정해두고 싶습니다. ContentsType 구조체 선언 아래쪽에 아래 코드를 추가해봅니다. 사실 어디에 위치하든 크게 상관은 없지만 그래도 이게 예쁘잖아요 :D

// 이미지 저장 디렉터리
private let imageDir: Dir? = {
    let imageDir = Dir("./image")
    
    if imageDir.exists == false {
        do {
            try imageDir.create()
            print("Working Directory (\(imageDir.path)) for examples created.")
        } catch {
            print("Could not create Working Directory for examples.")
            return nil
        }
    }
    
    return imageDir
}()

// JSON 데이터의 Key 값 혹은 요청 매개변수 이름에 사용
private struct JSONKey {
    static let image = "image"
    static let userName = "user_name"
    static let description = "description"
    static let title = "title"
    static let articles = "articles"
    static let articleId = "article_id"
    static let page = "page"
    static let articlesPerPage = "articles_per_page"
    static let currentPage = "current_page"
    static let totalPage = "total_page"
    static let imageUrl = "image_url"
    static let imagePath = "image_path"
    static let message = "message"
    static let error = "error"
}


자, 밑준비를 마쳤습니다.

사용자가 게시물 작성을 요청하는 postArticleHandler(request: response:) 함수를 본격적으로 작성해봅시다. 기존에 함수 내부에 있던 코드는 지워주세요 :)


먼저, 응답은 JSON 형식이 될 것이므로 맨 윗줄에 아래 코드를 작성합니다. response 객체는 클라이언트에게 응답을 줄 때 사용할 객체입니다.

// 응답 컨텐츠 형식은 JSON response.setHeader(.contentType, value: ContentsType.json)


매개변수로 전달된 request 객체에 클라이언트의 요청 정보가 모두 실려있습니다. 먼저 모든 필수 매개변수가 전달되었는지 확인합니다.


POST 메서드로 전달된 매개변수는 request 객체의 postParams() 메서드를 통해 가져올 수 있습니다. postParams() 메서드의 반환 타입은 (String, String) 튜플의 Array 타입입니다.

필수 매개변수인 user_name, title이 모두 전달되었는지 확인하고 싶습니다(image 매개변수는 파일로 받아올 것이니 다음 차례에서 확인합니다). 

// 부족한 매개변수가 없는지 확인
    if let lakedParams = lakedParams(paramsNeeded: [JSONKey.userName, JSONKey.title], paramsReceived: request.postParams) {
        sendCompleteResponse(response, status: .badRequest, jsonBody: [JSONKey.message:"need more params \(lakedParams)"])
    }
    
    // 이미지 파일이 업로드 되었는지 확인
    guard let imageInformation: MimeReader.BodySpec = request.postFileUploads?.first,
        let imageFile = imageInformation.file else {
        sendCompleteResponse(response, status: .badRequest, jsonBody: [JSONKey.message:"need image file"])
            return
    }

자, 이렇게 모든 전달 데이터가 확인되었다면 이미지를 서버의 이미지 디렉터리에 저장할 차례입니다. 먼저 이미지 이름에 사용자 이름을 넣고 싶기 때문에 클라이언트에서 전달된 데이터를 빼냅니다.

// 사용자 이름, 제목 추출
    guard let userName = request.param(name: JSONKey.userName),
        let title = request.param(name: JSONKey.title) else {
            sendCompleteResponse(response, status: .internalServerError, jsonBody: nil)
            return
    }


그리고 이미지가 저장될 디렉터리에 접근할 수 있는지 확인합니다.

// 이미지가 저장될 디렉터리
    guard let imageDirectory = imageDir else {
        sendCompleteResponse(response, status: .internalServerError, jsonBody: nil)
        return
    }

고유한 이미지 파일 이름을 만들어주기 위해서 타임스탬프 값을 활용했습니다. 위에서 request 객체에서 꺼내온 이미지 파일을 서버의 이미지 디렉터리 내부의 경로로 복사해줍니다.

// 고유한 이미지 이름을 위해 타임스템프 값을 활용
    let timestamp: Int = icuDateToSeconds(getNow())
    
    // 사용자이름_타임스템프.jpg 형식으로 파일이름 지정
    let imageFileName: String = userName + "_" + String(timestamp) + ".jpg"
    
    // 이미지가 저장될 경로
    let imageFilePath: String = imageDirectory.path + imageFileName
    
    // 이미지 저장에 실패할 경우 실패 응답 보내기
    do {
        try imageFile.copyTo(path: imageFilePath, overWrite: false)
    } catch {
        sendCompleteResponse(response, status: .internalServerError, jsonBody: [JSONKey.error:error.localizedDescription])
        return
    }

이미지 복사도 마쳤으니 이제 데이터베이스에 정보를 저장할 차례입니다. mongoDB의 컬렉션도 불러오고, DB에 저장할 데이터를 담은 딕셔너리를 생성해줍니다.
  // mongoDB 컬렉션 가져오기
    guard let collection = DB.collection else {
        sendCompleteResponse(response, status: .internalServerError, jsonBody: [JSONKey.error:"data base initialize failed"])
        return
    }
    
    // DB에 저장할 데이터
    // 차후에 응답 데이터로도 사용합니다
    var jsonDictionary = [JSONKey.userName: userName,
                          JSONKey.description: request.param(name: JSONKey.description),
                          JSONKey.title: title,
                          JSONKey.imagePath:imageFilePath]

이제 실질적으로 DB에 저장합니다. 저장을 하면서 문서의 고유ID도 생성해줍니다. 만약 DB 저장에 실패한다면 아까 복사해온 이미지 파일은 서버 디렉터리에서 삭제해주어야 합니다.

    // DB에 저장
    do {
        let jsonString = try jsonDictionary.jsonEncodedString()
        
        let document: BSON = try BSON(json: jsonString)
        
        // 문서 사용 후에는 닫아주는게 좋겠습니다
        defer {
            document.close()
        }
        
        // 문서 고유 아이디 생성 및 아이디 부여
        let oid: BSON.OID = BSON.OID(imageFileName)
        document.append(oid: oid)
        
        // 컬렉션에 문서 저장
        let result = collection.save(document: document)
        
        // 고유 아이디를 응답 데이터에 추가
        jsonDictionary[JSONKey.articleId] = oid.description
        
        if case .success = result { } else {
            sendCompleteResponse(response, status: .internalServerError, jsonBody: [JSONKey.error:result])
            return
        }
        
    } catch {
        
        // DB 저장에 실패했으므로 이미지 파일은 삭제
        File(imageFilePath).delete()
        
        Log.error(message: error.localizedDescription)
        sendCompleteResponse(response, status: .internalServerError, jsonBody: [JSONKey.error:error.localizedDescription])
        return
    }

DB 저장을 완료하면 응답 데이터를 보내 게시물 등록 처리를 완료합니다.

    // 응답 데이터에는 이미지 경로 대신 이미지 URL 전송
    jsonDictionary[JSONKey.imagePath] = nil
    jsonDictionary[JSONKey.imageUrl] = server.serverAddress + ":\(server.serverPort)" + "/image/" + imageFileName
    
    // 모든 작업을 완료하고 JSON 응답
    sendCompleteResponse(response, status: .created, jsonBody: jsonDictionary)

자 이렇게 postArticleHandler(request:response:) 함수 작성을 마쳤습니다.

// 사진 게시물 등록
func postArticleHandler(request: HTTPRequest, response: HTTPResponse) {
    
    // 응답 컨텐츠 형식은 JSON
    response.setHeader(.contentType, value: ContentsType.json)
    
    // 부족한 매개변수가 없는지 확인
    if let lakedParams = lakedParams(paramsNeeded: [JSONKey.userName, JSONKey.title], paramsReceived: request.postParams) {
        sendCompleteResponse(response, status: .badRequest, jsonBody: [JSONKey.message:"need more params \(lakedParams)"])
    }
    
    // 이미지 파일이 업로드 되었는지 확인
    guard let imageInformation: MimeReader.BodySpec = request.postFileUploads?.first,
        let imageFile = imageInformation.file else {
        sendCompleteResponse(response, status: .badRequest, jsonBody: [JSONKey.message:"need image file"])
            return
    }
    
    // 사용자 이름, 제목 추출
    guard let userName = request.param(name: JSONKey.userName),
        let title = request.param(name: JSONKey.title) else {
            sendCompleteResponse(response, status: .internalServerError, jsonBody: nil)
            return
    }
    
    // 이미지가 저장될 디렉터리
    guard let imageDirectory = imageDir else {
        sendCompleteResponse(response, status: .internalServerError, jsonBody: nil)
        return
    }
    
    // 고유한 이미지 이름을 위해 타임스템프 값을 활용
    let timestamp: Int = icuDateToSeconds(getNow())
    
    // 사용자이름_타임스템프.jpg 형식으로 파일이름 지정
    let imageFileName: String = userName + "_" + String(timestamp) + ".jpg"
    
    // 이미지가 저장될 경로
    let imageFilePath: String = imageDirectory.path + imageFileName
    
    // 이미지 저장에 실패할 경우 실패 응답 보내기
    do {
        try imageFile.copyTo(path: imageFilePath, overWrite: false)
    } catch {
        sendCompleteResponse(response, status: .internalServerError, jsonBody: [JSONKey.error:error.localizedDescription])
        return
    }
    
    // mongoDB 컬렉션 가져오기
    guard let collection = DB.collection else {
        sendCompleteResponse(response, status: .internalServerError, jsonBody: [JSONKey.error:"data base initialize failed"])
        return
    }
    
    // DB에 저장할 데이터
    // 차후에 응답 데이터로도 사용합니다
    var jsonDictionary = [JSONKey.userName: userName,
                          JSONKey.description: request.param(name: JSONKey.description),
                          JSONKey.title: title,
                          JSONKey.imagePath:imageFilePath]
    
    // DB에 저장
    do {
        let jsonString = try jsonDictionary.jsonEncodedString()
        
        let document: BSON = try BSON(json: jsonString)
        
        // 문서 고유 아이디 생성 및 아이디 부여
        let oid: BSON.OID = BSON.OID(imageFileName)
        document.append(oid: oid)
        
        // 컬렉션에 문서 저장
        let result = collection.save(document: document)
        
        // 고유 아이디를 응답 데이터에 추가
        jsonDictionary[JSONKey.articleId] = oid.description
        
        if case .success = result { } else {
            sendCompleteResponse(response, status: .internalServerError, jsonBody: [JSONKey.error:result])
            return
        }
        
    } catch {
        
        // DB 저장에 실패했으므로 이미지 파일은 삭제
        File(imageFilePath).delete()
        
        Log.error(message: error.localizedDescription)
        sendCompleteResponse(response, status: .internalServerError, jsonBody: [JSONKey.error:error.localizedDescription])
        return
    }

    // 응답 데이터에는 이미지 경로 대신 이미지 URL 전송
    jsonDictionary[JSONKey.imagePath] = nil
    jsonDictionary[JSONKey.imageUrl] = server.serverAddress + ":\(server.serverPort)" + "/image/" + imageFileName
    
    // 모든 작업을 완료하고 JSON 응답
    sendCompleteResponse(response, status: .created, jsonBody: jsonDictionary)
}

자 이제 mongoDB도 실행된 상태에서, Perfect 서버 애플리케이션을 실행해봅니다. 그리고는 /article 경로에 새로운 게시물 등록을 요청해봅니다.

 

 


 

짜잔!! 성공했습니다! 올바른 응답이 오고 있어요!



URL을 통해 사진 GET


자, 위 이미지의 응답 데이터를 보면 image_url이 오고 있습니다. 그 URL을 통해서 이미지를 한 번 받아와볼까요?

 


아니, 응답받은 URL인데...!! 왜 다운로드가 안되는거죠!? 흐음... 라우팅을 뭔가 해줘야 할 것 같습니다.


으음... 자 그럼 요청을 핸들링 할 수 있는 함수를 하나 또 만들어줍니다. handlers.swift 파일에 아래 함수를 하나 만들어줬습니다. 요청의 주소의 마지막에 위치한 이미지파일의 이름을 가지고 이미지 디렉터리의 파일이 있는지 확인하여 파일 핸들러를 사용하여 응답합니다.

// 이미지 파일
func imageHandler(request: HTTPRequest, response: HTTPResponse) {
    response.setHeader(.contentType, value: ContentsType.formData)
    
    guard let imageDirectory = imageDir else {
        sendCompleteResponse(response, status: .internalServerError)
        return
    }
    
    guard let imageFileName = request.pathComponents.last, imageFileName.contains(".jpg") else {
        sendCompleteResponse(response, status: .badRequest)
        return
    }
    
    request.path = imageFileName
    
    let handler = StaticFileHandler(documentRoot: imageDirectory.path)
    
    handler.handleRequest(request: request, response: response)
}

main.swift 파일로 이동하여 길을 하나 더 뚫어줍니다. 일단 articleURI 상수 아래에 imageURI도 하나 선언해줍니다.

let articleURI = "/article" let imageURI = "/image" let subArticleURI = articleURI + "/*"


그리고 서버 객체를 생성하는 코드 윗 줄에 아래 코드를 작성해줍니다.

routes.add(method: .get, uri: imageURI + "/*", handler: imageHandler(request:response:))

이렇게 작성하면 /image/xxx.jpg 형식으로 요청이 들어오면 imageHandler(request:response:) 함수가 핸들링 하게 될 것입니다.


자 이제 서버를 재시작하고, 다시 요청해볼까요?



 

으헿, 잘 나왔네요!


이번에는 CRUD 중, Create 먼저 해봤습니다. 다음 번에는 Read를 함께 해봐요~!

뿅!




참고문서



 



by yagom

facebook : http://www.facebook.com/yagomSoft

facebook group : https://www.facebook.com/groups/yagom

p.s 제 포스팅을 RSS 피드로 받아보실 수 있습니다.

RSS Feed 받기   


↓↓↓ 블로거에게 공감은 큰 힘이 됩니다 ↓↓↓ 




저작자 표시 비영리 변경 금지
신고

'Swift > Perfect' 카테고리의 다른 글

사진 게시판 API 만들기 [3]  (0) 2017.08.09
사진 게시판 API 만들기 [2]  (0) 2017.07.11
사진 게시판 API 만들기 [1]  (4) 2017.06.27
Perfect 라우팅  (0) 2017.05.24
Perfect 시작하기  (0) 2017.05.17
우분투(Ubuntu)에 스위프트 설치하기  (0) 2017.04.03
Posted by yagom

더 알아보기

이제까지 포스팅한 내용 외에 추가적으로 알아가야 할 문법과 개념들을 모아봤습니다.

  • 제네릭(Generics)
  • 서브스크립트(Subscript)
  • 접근수준(Access Control)
  • ARC(Automatic Reference Counting)
  • 중첩타입(Nested Types)
  • 사용자정의 연산자(Custom Operators)

스위프트 기본문법 강좌는 여기서 마칩니다. 많은 도움이 되었길 소망합니다.


yagom  



관련저서


스위프트 프로그래밍 - 야곰 지음 (한빛미디어)

http://book.naver.com/bookdb/book_detail.nhn?bid=11445773





by yagom

facebook : http://www.facebook.com/yagomSoft

facebook group : https://www.facebook.com/groups/yagom/


p.s 제 포스팅을 RSS 피드로 받아보실 수 있습니다.

RSS Feed 받기   


↓↓↓ 블로거에게 공감은 큰 힘이 됩니다 ↓↓↓ 

저작자 표시 비영리 변경 금지
신고

'Swift > 기본문법' 카테고리의 다른 글

기본문법을 마치며...  (0) 2017.07.31
고차함수  (0) 2017.07.27
오류처리  (0) 2017.07.24
익스텐션  (0) 2017.07.20
프로토콜  (0) 2017.07.17
assert와 guard  (0) 2017.07.13
Posted by yagom

고차함수

Swift/기본문법 2017.07.27 11:00

고차함수

고차함수(Higher-order function)은 '다른 함수를 전달인자로 받거나 함수실행의 결과를 함수로 반환하는 함수'를 뜻합니다.

스위프트의 함수(클로저)는 일급시민(first-citizen)이기 때문에 함수의 전달인자로 전달할 수 있으며, 함수의 결과값으로 반환할 수 있습니다.


이번 파트에서는 스위프트 표준라이브러리에서 제공하는 유용한 고차함수에 대해 알아봅니다.

  • map
  • filter
  • reduce

map, filter, reduce 함수는 스위프트 표준 라이브러리의 컨테이너 타입(Array, Set, Dictionary 등)에 구현되어 있습니다.


소스코드



map

map함수(메서드)는 컨테이너 내부의 기존 데이터를 변형(transform)하여 새로운 컨테이너를 생성합니다.


> 변형하고자 하는 numbers와 변형 결과를 받을 doubledNumbers, strings

let numbers: [Int] = [0, 1, 2, 3, 4]
var doubledNumbers: [Int]
var strings: [String]


> for 구문 사용

doubledNumbers = [Int]()
strings = [String]()

for number in numbers {
    doubledNumbers.append(number * 2)
    strings.append("\(number)")
}

print(doubledNumbers) // [0, 2, 4, 6, 8]
print(strings) // ["0", "1", "2", "3", "4"]


> map 메서드 사용

// numbers의 각 요소를 2배하여 새로운 배열 반환
doubledNumbers = numbers.map({ (number: Int) -> Int in
    return number * 2
})

// numbers의 각 요소를 문자열로 변환하여 새로운 배열 반환
strings = numbers.map({ (number: Int) -> String in
    return "\(number)"
})

print(doubledNumbers) // [0, 2, 4, 6, 8]
print(strings) // ["0", "1", "2", "3", "4"]

// 매개변수, 반환 타입, 반환 키워드(return) 생략, 후행 클로저
doubledNumbers = numbers.map { $0 * 2 }
print(doubledNumbers) // [0, 2, 4, 6, 8]


filter

filter함수(메서드)는 컨테이너 내부의 값을 걸러서 새로운 컨테이너로 추출합니다.


> for 구문 사용

// 변수 사용에 주목하세요
var filtered: [Int] = [Int]()

for number in numbers {
    if number % 2 == 0 {
        filtered.append(number)
    }
}

print(filtered) // [0, 2, 4]


> filter 메서드 사용

// numbers의 요소 중 짝수를 걸러내어 새로운 배열로 반환
let evenNumbers: [Int] = numbers.filter { (number: Int) -> Bool in
    return number % 2 == 0
}
print(evenNumbers) // [0, 2, 4]

// 매개변수, 반환 타입, 반환 키워드(return) 생략, 후행 클로저
let oddNumbers: [Int] = numbers.filter {
    $0 % 2 != 0
}
print(oddNumbers) // [1, 3]



reduce

reduce함수(메서드)는 컨테이너 내부의 콘텐츠를 하나로 통합합니다.


> 통합하고자 하는 someNumbers

let someNumbers: [Int] = [2, 8, 15]


> for 구문 사용

// 변수 사용에 주목하세요
var result: Int = 0

// someNumbers의 모든 요소를 더합니다
for number in someNumbers {
    result += number
}

print(result) // 25


> reduce 메서드 사용

// 초깃값이 0이고 someNumbers 내부의 모든 값을 더합니다.
let sum: Int = someNumbers.reduce(0, { (first: Int, second: Int) -> Int in
    //print("\(first) + \(second)") //어떻게 동작하는지 확인해보세요
    return first + second
})

print(sum)  // 25

// 초깃값이 0이고 someNumbers 내부의 모든 값을 뺍니다.
var subtract: Int = someNumbers.reduce(0, { (first: Int, second: Int) -> Int in
    //print("\(first) - \(second)") //어떻게 동작하는지 확인해보세요
    return first - second
})

print(subtract) // -25

// 초깃값이 3이고 someNumbers 내부의 모든 값을 더합니다.
let sumFromThree = someNumbers.reduce(3) { $0 + $1 }

print(sumFromThree) // 28



더 알아보기

flatmap








by yagom

facebook : http://www.facebook.com/yagomSoft

facebook group : https://www.facebook.com/groups/yagom/


p.s 제 포스팅을 RSS 피드로 받아보실 수 있습니다.

RSS Feed 받기   


↓↓↓ 블로거에게 공감은 큰 힘이 됩니다 ↓↓↓ 

저작자 표시 비영리 변경 금지
신고

'Swift > 기본문법' 카테고리의 다른 글

기본문법을 마치며...  (0) 2017.07.31
고차함수  (0) 2017.07.27
오류처리  (0) 2017.07.24
익스텐션  (0) 2017.07.20
프로토콜  (0) 2017.07.17
assert와 guard  (0) 2017.07.13
Posted by yagom

오류처리

Swift/기본문법 2017.07.24 11:00

오류처리

스위프트에서 오류(Error)Error라는 프로토콜을 준수하는 타입의 값을 통해 표현됩니다. Error 프로토콜은 사실상 요구사항이 없는 빈 프로토콜일 뿐이지만, 오류를 표현하기 위한 타입(주로 열거형)은 이 프로토콜을 채택합니다.


스위프트의 열거형은 오류의 종류를 나타내기에 아주 적합한 기능입니다. 연관 값을 통해 오류에 관한 부가 정보를 제공할 수도 있습니다. 


이번 예제에는 프로그램 내에서 자판기를 작동시키려고 할 때 발생하는 오류상황을 구현해 보았습니다.


소스코드


오류표현

Error 프로토콜과 (주로)열거형을 통해서 오류를 표현합니다

enum 오류종류이름: Error {
    case 종류1
    case 종류2
    case 종류3
    //...
}


> 자판기 동작 오류의 종류를 표현한 VendingMachineError 열거형

enum VendingMachineError: Error {
    case invalidInput
    case insufficientFunds(moneyNeeded: Int)
    case outOfStock
}



함수에서 발생한 오류 던지기

자판기 동작 도중 발생한 오류를 던지는 메서드를 구현해봅니다.

오류 발생의 여지가 있는 메서드는 throws를 사용하여 오류를 내포하는 함수임을 표시합니다.

class VendingMachine {
    let itemPrice: Int = 100
    var itemCount: Int = 5
    var deposited: Int = 0
    
    // 돈 받기 메서드
    func receiveMoney(_ money: Int) throws {
        
        // 입력한 돈이 0이하면 오류를 던집니다
        guard money > 0 else {
            throw VendingMachineError.invalidInput
        }
        
        // 오류가 없으면 정상처리를 합니다
        self.deposited += money
        print("\(money)원 받음")
    }
    
    // 물건 팔기 메서드
    func vend(numberOfItems numberOfItemsToVend: Int) throws -> String {
        
        // 원하는 아이템의 수량이 잘못 입력되었으면 오류를 던집니다
        guard numberOfItemsToVend > 0 else {
            throw VendingMachineError.invalidInput
        }
        
        // 구매하려는 수량보다 미리 넣어둔 돈이 적으면 오류를 던집니다
        guard numberOfItemsToVend * itemPrice <= deposited else {
            let moneyNeeded: Int
            moneyNeeded = numberOfItemsToVend * itemPrice - deposited
            
            throw VendingMachineError.insufficientFunds(moneyNeeded: moneyNeeded)
        }
        
        // 구매하려는 수량보다 요구하는 수량이 많으면 오류를 던집니다
        guard itemCount >= numberOfItemsToVend else {
            throw VendingMachineError.outOfStock
        }
        
        // 오류가 없으면 정상처리를 합니다
        let totalPrice = numberOfItemsToVend * itemPrice
        
        self.deposited -= totalPrice
        self.itemCount -= numberOfItemsToVend
        
        return "\(numberOfItemsToVend)개 제공함"
    }
}

// 자판기 인스턴스
let machine: VendingMachine = VendingMachine()

// 판매 결과를 전달받을 변수
var result: String?



오류처리

오류를 던질 수도 있지만 오류가 던져지는 것에 대비하여 던져진 오류를 처리하기 위한 코드도 작성해야 합니다. 예를 들어 던져진 오류가 무엇인지 판단하여 다시 문제를 해결한다든지, 다른 방법으로 시도해 본다든지, 사용자에게 오류를 알리고 사용자에게 선택 권한을 넘겨주어 다음에 어떤 동작을 하게 할 것인지 결정하도록 유도하는 등의 코드를 작성해야 합니다.


오류발생의 여지가 있는 throws 함수(메서드)는 try를 사용하여 호출해야합니다.  

trydo-catch, try?try! 등에 대해 알아봅니다.


do-catch

오류발생의 여지가 있는 throws 함수(메서드)는 do-catch 구문을 활용하여 오류발생에 대비합니다.

> 가장 정석적인 방법으로 모든 오류 케이스에 대응합니다

do {
    try machine.receiveMoney(0)
} catch VendingMachineError.invalidInput {
    print("입력이 잘못되었습니다")
} catch VendingMachineError.insufficientFunds(let moneyNeeded) {
    print("\(moneyNeeded)원이 부족합니다")
} catch VendingMachineError.outOfStock {
    print("수량이 부족합니다")
} // 입력이 잘못되었습니다


> 하나의 catch 블럭에서 switch 구문을 사용하여 오류를 분류해봅니다. 굳이 위의 것과 크게 다를 것이 없습니다.

do {
    try machine.receiveMoney(300)
} catch /*(let error)*/ {
    
    switch error {
    case VendingMachineError.invalidInput:
        print("입력이 잘못되었습니다")
    case VendingMachineError.insufficientFunds(let moneyNeeded):
        print("\(moneyNeeded)원이 부족합니다")
    case VendingMachineError.outOfStock:
        print("수량이 부족합니다")
    default:
        print("알수없는 오류 \(error)")
    }
} // 300원 받음


> 딱히 케이스별로 오류처리 할 필요가 없으면 catch 구문 내부를 간략화해도 무방합니다.

do {
    result = try machine.vend(numberOfItems: 4)
} catch {
    print(error)
} // insufficientFunds(100)


> 딱히 케이스별로 오류처리 할 필요가 없으면 do 구문만 써도 무방합니다

do {
    result = try machine.vend(numberOfItems: 4)
}


try? 와 try!

try?

별도의 오류처리 결과를 통보받지 않고 오류가 발생했으면 결과값을 nil로 돌려받을 수 있습니다. 정상동작 후에는 옵셔널 타입으로 정상 반환값을 돌려 받습니다.

result = try? machine.vend(numberOfItems: 2)
result // Optional("2개 제공함")

result = try? machine.vend(numberOfItems: 2)
result // nil


try!

오류가 발생하지 않을 것이라는 강력한 확신을 가질 때 try!를 사용하면 정상동작 후에 바로 결과값을 돌려받습니다. 오류가 발생하면 런타임 오류가 발생하여 애플리케이션 동작이 중지됩니다.

result = try! machine.vend(numberOfItems: 1)
result // 1개 제공함

//result = try! machine.vend(numberOfItems: 1)
// 런타임 오류 발생!


더 알아보기

추가적으로 더 알아보면 좋은 개념입니다.

  • rethrows
  • defer

관련문서

* The Swift Programming Language - Error Handling

* The Swift Programming Language - Enumerations





by yagom

facebook : http://www.facebook.com/yagomSoft

facebook group : https://www.facebook.com/groups/yagom/


p.s 제 포스팅을 RSS 피드로 받아보실 수 있습니다.

RSS Feed 받기   


↓↓↓ 블로거에게 공감은 큰 힘이 됩니다 ↓↓↓ 

저작자 표시 비영리 변경 금지
신고

'Swift > 기본문법' 카테고리의 다른 글

기본문법을 마치며...  (0) 2017.07.31
고차함수  (0) 2017.07.27
오류처리  (0) 2017.07.24
익스텐션  (0) 2017.07.20
프로토콜  (0) 2017.07.17
assert와 guard  (0) 2017.07.13
Posted by yagom

익스텐션

Swift/기본문법 2017.07.20 15:59

익스텐션

익스텐션(Extension) 은 스위프트의 강력한 기능 중 하나입니다. 익스텐션은 구조체, 클래스, 열거형, 프로토콜 타입에 새로운 기능을 추가 할 수 있는 기능입니다. 

기능을 추가하려는 타입의 구현된 소스 코드를 알지 못하거나 볼 수 없다 해도, 타입만 알고 있다면 그 타입의 기능을 확장할 수도 있습니다.


스위프트의 익스텐션이 타입에 추가할 수 있는 기능

  • 연산 타입 프로퍼티 / 연산 인스턴스 프로퍼티 
  • 타입 메서드 / 인스턴스 메서드
  • 이니셜라이저
  • 서브스크립트 
  • 중첩 타입
  • 특정 프로토콜을 준수할 수 있도록 기능 추가 


익스텐션은 타입에 새로운 기능을 추가할 수는 있지만, 기존에 존재하는 기능을 재정의 할 수는 없습니다.


클래스의 상속과 익스텐션을 비교해보겠습니다. 이 둘은 비슷해보이지만 실제 성격은 많이 다릅니다. 

클래스의 상속은 클래스 타입에서만 가능하지만 익스텐션은 구조체, 클래스, 프로토콜 등에 적용이 가능합니다. 또 클래스의 상속은 특정 타입을 물려받아 하나의 새로운 타입을 정의하고 추가 기능을 구현하는 수직 확장이지만, 익스텐션은 기존의 타입에 기능을 추가하는 수평 확장입니다. 또, 상속을 받으면 기존 기능을 재정의할 수 있지만, 익스텐션은 재정의할 수 없다는 것도 큰 차이 중 하나입니다. 상황과 용도에 맞게 상속과 익스텐션을 선택하여 사용하면 됩니다. 

 

 상속

익스텐션 

확장 

수직확장 

수평확장 

사용 

클래스 타입 

클래스, 구조체, 프로토콜, 제네릭 등 모든 타입 

재정의 

가능 

불가능 


익스텐션을 사용하는 대신 원래 타입을 정의한 소스에 기능을 추가하는 방법도 있겠지만, 외부 라이브러리나 프레임워크를 가져다 썼다면 원본 소스를 수정하지 못합니다. 이처럼 외부에서 가져온 타입에 내가 원하는 기능을 추가하고자 할 때 익스텐션을 사용합니다. 따로 상속을 받지 않아도 되며, 구조체와 열거형에도 기능을 추가할 수 있으므로 익스텐션은 매우 편리한 기능입니다. 

익스텐션은 모든 타입에 적용할 수 있습니다. 모든 타입이라 함은 구조체, 열거형, 클래스, 프로토콜, 제네릭 타입 등을 뜻합니다. 즉, 익스텐션을 통해 모든 타입에 연산 프로퍼티, 메서드, 이니셜라이저, 서브스크립트, 중첩 데이터 타입 등을 추가할 수 있습니다.

더불어 익스텐션은 프로토콜과 함께 사용하면 굉장히 강력한 기능을 선사합니다. 이 부분은 프로토콜 중심 프로그래밍(Protocol Oriented Programming)에 대해 더 알아보면 좋습니다.


소스코드


정의 문법

extension 키워드를 사용하여 정의합니다.

extension 확장할 타입 이름 {
    /* 타입에 추가될 새로운 기능 구현 */
}


익스텐션은 기존에 존재하는 타입이 추가적으로 다른 프로토콜을 채택할 수 있도록 확장할 수도 있습니다. 이런 경우에는 클래스나 구조체에서 사용하던 것과 똑같은 방법으로 프로토콜 이름을 나열해줍니다.

extension 확장할 타입 이름: 프로토콜1, 프로토콜2, 프로토콜3... {
    /* 프로토콜 요구사항 구현 */
}


스위프트 라이브러리를 살펴보면 실제로 익스텐션이 굉장히 많이 사용되고 있음을 알 수 있습니다. Double 타입에는 수많은 프로퍼티와 메서드, 이니셜라이저가 정의되어 있으며 수많은 프로토콜을 채택하고 있을 것이라고 예상되지만, 실제로 Double 타입의 정의를 살펴보면 그 모든것이 다 정의되어 있지는 않습니다. 

그러면 Double 타입이 채택하고 준수해야 하는 수많은 프로토콜은 어디로 갔을까요? 어디에서 채택하고 어디에서 준수하도록 정의되어 있을까요? 당연히 답은 익스텐션입니다. 이처럼 스위프트 표준 라이브러리 타입의 기능은 대부분 익스텐션으로 구현되어 있습니다. Double 외에도 다른 타입들의 정의와 익스텐션을 찾아보면 더 많은 예를 보실 수 있습니다. 꼭 한 번 찾아보세요! 


익스텐션 구현

연산 프로퍼티 추가

extension Int {
    var isEven: Bool {
        return self % 2 == 0
    }
    var isOdd: Bool {
        return self % 2 == 1
    }
}

print(1.isEven) // false
print(2.isEven) // true
print(1.isOdd)  // true
print(2.isOdd)  // false

var number: Int = 3
print(number.isEven) // false
print(number.isOdd) // true

number = 2
print(number.isEven) // true
print(number.isOdd) // false

위 코드의 익스텐션은 Int 타입에 두 개의 연산 프로퍼티를 추가한 것입니다. Int 타입의 인스턴스가 홀수인지 짝수인지 판별하여 Bool 타입으로 알려주는 연산 프로퍼티입니다. 익스텐션으로 Int 타입에 추가해준 연산 프로퍼티는 Int 타입의 어떤 인스턴스에도 사용이 가능합니다. 위의 코드처럼 인스턴스 연산 프로퍼티를 추가할 수도 있으며, static 키워드를 사용하여 타입 연산 프로퍼티도 추가할 수 있습니다. 


메서드 추가

extension Int {
    func multiply(by n: Int) -> Int {
        return self * n
    }
}
print(3.multiply(by: 2))  // 6
print(4.multiply(by: 5))  // 20

number = 3
print(number.multiply(by: 2))   // 6
print(number.multiply(by: 3))   // 9

위 코드의 익스텐션을 통해 Int 타입에 인스턴스 메서드multiply(by:) 메서드를 추가했습니다. 여러 기능을 여러 익스텐션 블록으로 나눠서 구현해도 전혀 문제가 없습니다. 관련된 기능별로 하나의 익스텐션 블록에 묶어주는 것도 좋습니다. 


이니셜라이저 추가

extension String {
    init(int: Int) {
        self = "\(int)"
    }
    
    init(double: Double) {
        self = "\(double)"
    }
}

let stringFromInt: String = String(int: 100) 
// "100"

let stringFromDouble: String = String(double: 100.0)    
// "100.0"

인스턴스를 초기화(이니셜라이즈)할 때 인스턴스 초기화에 필요한 다양한 데이터를 전달받을 수 있도록 여러 종류의 이니셜라이저를 만들 수 있습니다. 타입의 정의부에 이니셜라이저를 추가하지 않더라도 익스텐션을 통해 이니셜라이저를 추가할 수 있습니다. 

하지만 익스텐션으로 클래스 타입에 편의 이니셜라이저는 추가할 수 있지만, 지정 이니셜라이저는 추가할 수 없습니다. 지정 이니셜라이저와 디이니셜라이저는 반드시 클래스 타입의 구현부에 위치해야 합니다(값 타입은 상관없습니다).



관련문서

The Swift Programming Language - Extensions





by yagom

facebook : http://www.facebook.com/yagomSoft

facebook group : https://www.facebook.com/groups/yagom/


p.s 제 포스팅을 RSS 피드로 받아보실 수 있습니다.

RSS Feed 받기   


↓↓↓ 블로거에게 공감은 큰 힘이 됩니다 ↓↓↓ 

저작자 표시 비영리 변경 금지
신고

'Swift > 기본문법' 카테고리의 다른 글

고차함수  (0) 2017.07.27
오류처리  (0) 2017.07.24
익스텐션  (0) 2017.07.20
프로토콜  (0) 2017.07.17
assert와 guard  (0) 2017.07.13
타입캐스팅  (2) 2017.07.10
Posted by yagom


티스토리 툴바