[iOS] Request Methods를 곁들인 Alamofire 간단 사용법

앱을 개발하다 보면, 서버와 통신하는 부분이 필수적입니다. 이럴 때, 기본으로 제공하는 Foundation의 URLSession을 사용하여 네트워킹을 수행합니다.
하지만, URLSession은 다소 번거로운 점이 있기 때문에 오픈 소스 라이브러리인 Alamofire를 주로 사용합니다.

 

Alamofire

Alamofire는 swift를 기반으로 한 HTTP 네트워킹 라이브러리입니다. 앞에서 언급한 Foundation의 URLSession 기반으로 구현되어 있어, 이를 더 쉽게 사용할 수 있도록 합니다.

 

https://github.com/Alamofire/Alamofire

GitHub - Alamofire/Alamofire: Elegant HTTP Networking in Swift

 

 

Alamofire는 다음 기능들을 제공하는데, 이 외에도 다양한 기능을 제공하고 있습니다.

• Chainable request/response methods
• JSON, Codable decoding
• Authentication

요약하자면, Alamofire는 HTTP 네트워킹을 하는데 있어서 자주 사용하는 코드 및 함수를 쉽게 사용할 수 있도록 합니다.

네트워크 통신을 하기 위해 기본적으로 알아야 하는 것이 있습니다.
바로 Request Methods 입니다.

 

 

Request Methods

Request Methods는 클라이언트가 서버에게 사용자 요청의 목적이나 종류를 알리는 수단입니다.
이 중에서도 자주 사용되는 메서드 위주로 설명하겠습니다.

 

 

 

HEAD

GET과 유사하지만, 응답 본문을 포함하지 않는다는 차이가 있습니다. 따라서 리소스의 존재 여부를 확인하거나, Content-Length 및 Last-Modified와 같은 메타데이터를 조회할 때 사용됩니다.

본문을 전송하지 않기 때문에 네트워크 트래픽을 절약할 수 있는 장점이 있습니다.

HEAD /api/resource HTTP/1.1
Host: example.com

 

 

GET

서버로부터 데이터를 조회하는 용도로 사용됩니다. 멱등성을 가지므로 동일한 요청을 여러 번 수행하더라도 서버의 상태가 변경되지 않습니다. 또한 캐싱이 가능하여 브라우저나 프록시 서버가 응답을 저장하고 재사용할 수 있습니다.

데이터 전달 시에는 URL의 쿼리 스트링을 활용합니다.

GET /api/users?id=123 HTTP/1.1
Host: example.com

 

 

POST

서버에 데이터를 전송하여 새로운 리소스를 생성하거나 특정 작업을 수행하는 데 사용됩니다. 요청 본문을 포함할 수 있으며, 멱등성을 가지지 않으므로 동일한 요청을 여러 번 수행하면 서버의 상태가 달라질 가능성이 있습니다.

사용자 등록, 로그인, 데이터 제출 등의 작업에서 주로 활용됩니다.

POST /api/users HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "John Doe",
    "email": "john@example.com"
}

 

 

PUT

지정된 리소스를 생성하거나 전체적으로 수정하는 데 사용됩니다. GET과 마찬가지로 멱등성을 가지기 때문에 동일한 요청을 여러 번 수행하더라도 결과가 변하지 않습니다.

기존 리소스가 존재하면 덮어쓰기가 이루어지며, 존재하지 않는 경우 새로운 리소스가 생성될 수도 있습니다. 요청 본문에는 리소스의 전체 정보가 포함되어야 하며, 부분적인 업데이트보다는 전체 갱신이 필요할 때 적합합니다.

PUT /api/users/123 HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "Jane Doe",
    "email": "jane@example.com"
}

 

 

DELETE

서버에서 특정 리소스를 삭제하기 위해 사용합니다. 멱등성을 가지므로 동일한 요청을 반복하더라도 결과는 동일하게 유지됩니다.

서버의 정책에 따라 요청 즉시 삭제되거나 일정 기간 보관 후 삭제될 수도 있으며, 일부 구현에서는 삭제 요청을 받은 후 비활성화 처리하는 방식도 존재합니다.

DELETE /api/users/123 HTTP/1.1
Host: example.com

 

 

Request/Reponse

이를 기반으로 API 요청 코드를 구현해 보도록 하겠습니다.

 

GET

let url = "https://test.com"

AF.request(
        url,
        method: .get,
        parameters: nil,
        encoding: URLEncoding.default,
        headers: ["Content-Type":"application/json", "Accept":"application/json"]
    ).validate(statusCode: 200..<300)
    .responseJSON { response in
     
    /** 서버로부터 받은 데이터 활용 */
    switch response.result {
        case .success(let data):
            /** 정상적으로 reponse를 받은 경우 */
        case .failure(let error):
            /** 그렇지 않은 경우 */
    }
}

• url : 요청할 url
• method : 어떤 request method를 사용할 것인지 작성
• parameters : request body를 사용할 때 전달할 값 (GET을 사용할 것이므로 nil)
• encoding : 인코딩 방식
• headers : 부가적인 정보를 의미 (코드에서는 송/수신 데이터 타입(JSON)을 나타냄)
• validate : 유효성을 검사 (state code 값이 20x 일 때가 송/수신이 원활하게 된 경우)
• responseJSON : 응답 json 데이터

 

POST

POST 메서드를 사용할 때는 parameters에 데이터를 담아 전달합니다.

let url = "https://test.com"
let params = ["id":"testId", "pw":"testPassword"] as Dictionary

AF.request(
        url,
        method: .post,
        parameters: params,
        encoding: JSONEncoding(options: []),
        headers: ["Content-Type":"application/json", "Accept":"application/json"]
    ).responseJSON { response in

    /** 서버로부터 받은 데이터 활용 */
    switch response.result {
        case .success(let data):
            /** 정상적으로 reponse를 받은 경우 */
        case .failure(let error):
            /** 그렇지 않은 경우 */
    }
}

 

 

File Upload

Alamofire를 사용해서 파일을 다운로드하거나, 업로드하는 것도 가능합니다.

먼저 전달할 데이터를 구조에 맞게 변경해야 합니다.

 

여러 개의 데이터는 for문을 사용해 한 번에 추가합니다.

for (key, value) in parameters {
    multipartFormData.append("\(value)".data(using: .utf8)!, withName: key)
}

 

 

이미지를 추가할 때는 다음과 같습니다.

if let image = imageData?.pngData() {
    multipartFormData.append(image, withName: "activityImage", fileName: "\(image).png", mimeType: "image/png")
}

 

• value : 전달할 파일
• withName : key
• fileName : 서버에 업로드할 파일 이름
• mimeType : 파일 형식

 

let url = "https://test.com"

AF.upload(
        multipartFormData: { multipartData in /** 서버로 전송할 데이터 */ },
        to: url,
        method: .post,
        headers: ["Content-Type" : "multipart/form-data"]
    ).response { response in
    
    if response.error != nil {
        /** 파일 업로드 실패 */
    } else{
        /** 파일 업로드 성공 */
    }
}

 

이때, GET이나 POST 메서드를 사용할 때는 header의 Content-Type가 application/json이었습니다.

파일을 업로드하거나 다운로드할 때는 Content-Type을 multipart/form-data로 작성해야 합니다.

 

 

File Download

let url = "https://test.com/test.jpg"

/** 파일에 저장하기 위한 코드 */
let fileManager = FileManager.default
let appURL = fileManager.urls(for: .documentDirectory, in: .userDomainMask)[0]
let fileName : String = URL(string: url)!.lastPathComponent /** url의 마지막 문자열로 이름 지정 */
let fileURL = appURL.appendingPathComponent(fileName)

/** 파일 경로 지정 및 다운로드 옵션 설정 (이전 파일 삭제, 디렉토리 생성) */
let destination: DownloadRequest.Destination = { _, _ in
    return (fileURL, [.removePreviousFile, .createIntermediateDirectories])
}

AF.download(
        url,
        method: .get,
        parameters: nil,
        encoding: JSONEncoding.default,
        to: destination
    ).downloadProgress { progress in
        /** 다운로드 progress */
        /** progressView를 사용할 때 여기에 작성 */
    }.response { response in

        if response.error != nil {
            /** 파일 다운로드 실패*/
        } else{
            /** 파일 다운로드 성공*/
        }
    }