[swift] Alamofire란? Alamofire 사용법 뽀개기

Alamofire

: 비동기로 수행하는 swift기반의 HTTP 네트워킹 라이브러리 (통신 라이브러리)

💡 왜 필요한가 ? - 서버와 통신을 하기 위해 ! 더 구체적으론, 서버에서 json형식의 데이터를 받아오려면 HTTP 통신을 해야하며 HTTP 통신 라이브러리의 최강자 Alamofire를 이용해보자 !

• Apple의 Foundation 프레임워크에서 제공하는 URL 로딩 시스템을 기반으로 구축되어있음
  URLSession 및 URLSessionTask 같은 클래스를 사용하기 쉽게 구현되어있음
• Alamofire는 CocoaPods를 사용해 쉽게 설치 가능

사용법

Alamofire를 사용하기 위해선 제일 먼저 import Alamofire 해줌

✱ 참고 ) Alamofire ver5 이후부터는 AF 가 Session.default 에 대한 참조..!!

1. Request

정의

// 1
open func request<Parameters: Encodable>(_ convertible: URLConvertible,
                                         method: HTTPMethod = .get,
                                         parameters: Parameters? = nil,
                                         encoder: ParameterEncoder = URLEncodedFormParameterEncoder.default,
                                         headers: HTTPHeaders? = nil,
                                         interceptor: RequestInterceptor? = nil) -> DataRequest
// 2
open func request(_ urlRequest: URLRequestConvertible, 
                  interceptor: RequestInterceptor? = nil) -> DataRequest

사용

// 1
AF.request(URL, method, parameters, encoder, headers, interceptor)
// 2
AF.request(URL, interceptor)

1번과 2번 방식으로 request를 만들 수 있음
1번 : DataRequest를 생성하면서 method나 parameter같은 개별 구성 요청도 허용
요청마다 Encodable을 만족하는 parameter 허용
2번 : Alamofire의 모든 URLRequestConvertible 프로토콜을 준수하는 모든 유형에 대해 DataRequest를 생성

HTTP Method

Alamofire에서는 HTTP Method 또한 지원
대표적으로 get, post,put,delete 등

AF.request(url, method: .post)
AF.request(url, method: .get)
...

Parameters

Alamofire는 기본적으로 모든 Encodable 타입의 값을 request의 매개변수로 사용하는 것을 허용

Encodable : a type that can encode itself to an external representation
(어떤 데이터 타입이 스스로가 다른 형태의 표현방식으로 인코딩 될 수 있도록 따라야하는 프로토콜)
Encoder : Encodable 객체를 JSON이나 XML와 같은 다른 형식으로 변경하는 작업을 수행하는 인코더의 프로토콜

• parameters 가 없는 경우 nil값이 할당됨

 

Headers

🔎 들어가기전에... Headers는 언제 필요한가?

서버가 보안상의 이유로 인증된 사용자에게만 데이터를 준다고 하자. request가 왔을 때 인증된 사용자가 보낸 요청인지 미인증된 사용자가 보낸 요청인지 어떻게 알 수 있을까?

👉 HTTP header에 “Authorization”이란 key값으로 서버가 “인증된 사용자구나”를 알 수 있는 value값을 보내면 됨
이 access key는 앱에서 여러 API를 호출할 때마다 header에 실어보내야하므로 안전한 곳에 저장하여 어디서나 접근 가능하게 할 수 있어야 함

반응형

이를 위한 라이브러리로 Keychain-swift 추천 !!

1. KeychainSwift에 access 관련데이터 저장 (key-value 값으로)
2. key으로 해당 value값 가져오기

 

2. Response

앞서 보낸 Request 에 따른 response

사용법

Alamofire에서는 requese 뒤에 response를 붙여주면 됨

AF.request(url).response()

 

5가지 response handler

(✱참고 : response handler는 서버에서 반환되는 유효성 검사를 하지 않는다 이는 Response Validation에서 다룰 예정. )

1. response Handler
URLSessionDelegate에서 직접 모든 정보를 전달하고 응답 데이터를 평가하지 않음아래와 같이 사용

1. AF.request(url).response { response in print(response) }
2. URLSessionDelegate : URLSession 인스턴스가 세션 수준의 이벤트를 처리하기 위해 Delegate에서 호출하는 메서드를 정의하는 프로토콜

2. responseData Handler
DataResponseSerializer를 사용해 서버에서 반환된 데이터를 추출하고 유효성 검사를 진행

• ResponseSerializer : 응답을 모두 처리 할 수있는 직렬 변환기
• AF.request(url).responseData { response in print(response) }

• DataResponseSerializer : 최소 응답 검사를 수행하고 모든 응답 데이터를 그대로 반환하는 ResponseSerializer

3. responseString Handler
StringResponseSerializer를 사용해 서버에서 반환된 데이터를 지정된 인코딩을 사용하는 문자열로 변환
만약, 인코딩이 지정되지 않은 경우 Alamofire는 서버의 HTTPURLResponse에 지정된 텍스트 인코딩을 사용

 AF.request(url).resonseString { response in
     print(response)
 }

1. StringResponseSerializer : 응답 데이터를 문자열로 디코딩하는 ResponseSerializer.

4. responseJSON Handler
아마 가장 많이 사용되는 방법..! 
JSONResponseSerializer를 사용해 서버에서 반환된 데이터를 지정된 JSONSerialization.ReadingOptions를 사용하는 Any타입으로 변환

• JSONSerialization.ReadingOptions : JSON 데이터에서 Foundation 개체를 만들 때 사용되는 옵션

• JSONResponseSerializer : JSONSerialization을 사용하여 응답 데이터를 디코딩하는 ResponseSerializer

5. responseDecodable Handler
DecodableResponseSerializer를 사용해 서버에서 반환된 데이터를 지정된 DataDecoder을 사용하는 Decodable타입으로 변환

• DataDecoder : 데이터를 Decodable타입으로 디코딩 할 수 있는 모든 타입

• DecodableResponseSerializer : DataDecoder를 따르는 모든 타입을 사용해 응답 데이터를 제네릭 값으로 디코딩하는 ResponseSerializer

3. Validation

: 유효성 검사
요청에 대한 response를 하기 전에 .validate() 를 호출하여 유효하지 않은 상태 코드나 MIME 타입이 있는 경우 response하지 않도록 함

사용법

AF.request(url)
  .validate()
  .response { response in
     print(response)

• 상태 코드나 MIME 타입 조건을 넣는 방법 👇

AF.request(url)
  .validate(200..<300) // 200~300 사이 상태코드만 허용
  .validate(contentType:["application/json"]) // JSON 포맷만 허용
  .response { response in
      print(response)
}

🔎 MIME 타입 전체목록

 

 

reference

• https://velog.io/@chagmn/Alamofire-사용해보기3
• https://eunjin3786.tistory.com/1