[Alamofire Mapper] URLRequestConvertible 사용해보기

Alamofire 조금 더 이해하고 사용해보자

 

들어가기 전에

Alamofire 공식 문서를 보면 URLRequest를 사용자 정의해서 사용할 수 있는

URLRequestConvertible이라는 프로토콜이 있더라구요?

 

항상 기본적인 request 메서드에 파라미터를 사용하고 있었던

우리...

아니 나 자신...

조금 더 서비스 코드를 잘 작성해서 사용할수는 없는지 고민해보기로 했습니다.

아직 갈 길이 멀지만 조금 더 배워보자라는 생각으로 열심히 해봐야죠~

 

기존 vs 개선

기존 서비스 코드

• 각 서비스마다 매번 비슷한 코드를 작성을 하고 있어 효율성에서 좋지 않아 보입니다.
• (저만 그러는 걸까요...ㅎㅎ 통신 코드 작성하는 거 비슷해서 맨날 복붙한다음에 파라미터만 바꾸는... ^^)

서비스 코드 작성부

서비스 코드 사용부

 

개선한 서비스 코드

• 분기처리는 APIRouter에서 하고 있고, APIClient에 작성한 함수 하나만 사용해서 네트워크 통신을 합니다.

아래를 보면, 하나의 request를 이용해서 여러 endpoint에 대한 네트워크 통신을 처리하고 있음

 

일정을 조회(GET)하는 통신

여행을 추가(POST)하는 통신

 

코드 - Networks/

Networks 폴더링 모습

 

APIConstants

1. API 통신에 사용할 다양한 상수들을 모아놓은 파일입니다.

 import Foundation

 struct APIConstants {
     // MARK: - Start Endpoint
     static var baseURL: URL {
         return URL(string: "http://13.209.82.176:5000")!
     }

     static let token = ""
 }

 enum HTTPHeaderField: String {
     case authentication = "Authorization"
     case contentType = "Content-Type"
     case acceptType = "Accept"
     case acceptEncoding = "Accept-Encoding"
     case xAuthToken = "x-auth-token"
 }

 enum ContentType: String {
     case json = "application/json"
 }

 

APIRouter

• Endpoint를 구분해서 제공하는 파일입니다.
• HTTPMethods, Path, Parameter, Encoding 방식을 설정할 수 있습니다.

import Foundation

import Alamofire

enum APIRouter: URLRequestConvertible {
    // MARK: - Cases
    case getTravels
    case addTravel(travelName: String, destination: String, startDate: String, endDate: String, imageIndex: Int)
    case getSchedules(groupId: String, date: String)
    
    // MARK: - Methods
    var method: HTTPMethod {
        switch self {
        case .getTravels, .getSchedules:
            return .get
        case .addTravel:
            return .post
        }
    }
    
    // MARK: - Paths
    var path: String {
        switch self {
        case .getTravels, .addTravel:
            return "/travel"
        case .getSchedules(let groupId, let date):
            return "/schedule/daily/\(groupId)/\(date)"
        }
    }
    
    // MARK: - Parameters
    private var parameters: Parameters? {
        switch self {
        case .getTravels, .getSchedules:
            return nil
        case .addTravel(let travelName, let destination, let startDate, let endDate, let imageIndex):
            return [
                "travelName": travelName,
                "destination": destination,
                "startDate": startDate,
                "endDate": endDate,
                "imageIndex": imageIndex
            ]
        }
    }
    
    // MARK: - Encodings
    var encoding: ParameterEncoding {
        switch self {
        case .getTravels:
            return URLEncoding.default
        default:
            return JSONEncoding.default
        }
    }
    
    // MARK: - URL Request
    func asURLRequest() throws -> URLRequest {
        let url = APIConstants.baseURL.appendingPathComponent(path)
        var urlRequest = URLRequest(url: url)
        
        // HTTP Method
        urlRequest.method = method
        
        // Common Headers
        urlRequest.setValue(ContentType.json.rawValue, forHTTPHeaderField: HTTPHeaderField.contentType.rawValue)
        urlRequest.setValue(APIConstants.token, forHTTPHeaderField: HTTPHeaderField.xAuthToken.rawValue)
        
        // Parameters
        if let parameters = parameters {
            return try encoding.encode(urlRequest, with: parameters)
        }

        return urlRequest
    }
}

 

 

APIClient

• Service 코드를 작성하는 파일입니다.
• responseDecodable을 이용해서 데이터를 파싱해주고 있습니다.

import Foundation

import Alamofire

class APIClient {
    
    typealias onSuccess<T> = ((T) -> Void)
    typealias onFailure = ((_ error: Error) -> Void)
    
    static func request<T>(_ object: T.Type,
                                  router: APIRouter,
                                  success: @escaping onSuccess<T>,
                                  failure: @escaping onFailure) where T: Decodable {
        AF.request(router)
            .validate(statusCode: 200..<500)
            .responseDecodable(of: object) { response in
                switch response.result {
                case .success:
                    guard let decodedData = response.value else { return }
                    success(decodedData)
                case .failure(let err):
                    failure(err)
                }
        }
    }
    
}

 

마무리

사실상 위에 3개의 파일을 만들어놓고 사용하니,
매 통신마다 서비스 코드를 작성하는 수고를 덜 수 있어서 좋아보입니다.

 

그러나 무조건적으로 좋다는 생각은 하지 않는 걸로 해야겠어요...
저도 이제 막 위의 방식을 적용해보고 사용하고 있는지라 막 추천하기는 어려울 것 같네요 👀

 

좀 더 나은 방법이 있는지 더 고민해보도록 하겠습니다 :-)

 

이번 글은 핵심만 적어놔서,,, 내용을 이해하기 어려울 수도 있을 것 같아요...

만약 그렇다면 댓글이나 연락주세요 ..

 

참고링크

• Alamofire/AdvancedUsage.md at master · Alamofire/Alamofire
• Alamofire iOS Advanced Techniques
• Write a Networking Layer in Swift 4 using Alamofire 5 and Codable Part 1: API Router
• AlamofireExample