iOS) Router pattern with Alamofire’s URLRequestConvertible protocol Tutorial 따라해보기 !

안녕하세욥 ! 오늘은 Alamofire라는 

서버통신 라이브러리에서 URLRequestConvertible이라는 프로토콜을 

사용하는 방법에 대해 알아보겠습니다. !

 

오옹 제법 어려워보이지만, 요거를 찾고 공부하게 된 계기를 

설명해보자면.. 작년에 처음으로 알라모로 서버통신을 하고 그 다음에

합동세미나에서는 알라모보다 더 추상화된 모야 라이브러리를 사용하게 됩니다.

Moya 라이브러리는 정말 .. 편했고 그냥 이해도 못하고 후루룩 

적어도 서버통신이 짠 ~ 하고 되는 친구였습니다..

 

버릇이 잘못들어진거죠.. 그런데 앱잼에서 URLSession을 쓰게 되었고,

그렇게 저는 부셔졌습니다.. 서버통신의 ㅅ자도 모르는 감자였기 때문...

뒤죽박죽 서버통신 플로우가 정리가 안되려고 하는데.. 

다시 세미나를 들으면서 Alamofire를 하게 되었습니다 ㅋㅋㅋㅋㅋ

 

그런데 이제와서 다시 보니깐 Alamofire를 활용해서 서버통신하는 코드는

굉장히 많은 부분들이 같은 코드로 이루어져있고, 이 부분을 모야처럼 간편하게 모듈화 할 순 없을까?

대신 모야를 쓰지말고... 알라모로 모야처럼 써보자.. 라는 목적을 가지고 알아보게 되었습니다 !

 

---

1. URLRequestConvertible이 뭐야 !

 

항상 저희는 기본 request 메서드에다가

파라미터를 넘겨주는 방식으로 구현했었죠.. !! 

하지만 URLRequestConvertible이라는 프로토콜을 채택해서 

URLRequest를 따로 정의해서 사용할 수 있습니다 !

 

오오 그러면 프로토콜을 채택해서 초기구현을 해주는데,

그 과정에서 내가 원하는 파라미터를 미리 넣어준다면.. request 할 때마다 

그 함수에서 파라미터를 넣어주는 코드를 줄일 수 있겠네요 !!

 

실제 튜토리얼? 에도 코드 복제 방지에 대한 장점을 언급하고 있네요 !

 

This tutorial teaches about the Alamofire router pattern, 

which helps us have a clean network layer and avoid duplicating code.

 

이 튜토리얼은 Alamofire 라우터 패턴에 대해 설명합니다. 
이 패턴은 깨끗한 네트워크 계층을 만들고 코드 복제를 방지하는 데 도움이 됩니다.

 

이전에 Alamofire를 사용한 적이 있다면 각 요청에 대한

URL 경로, HTTP 메서드 및 쿼리 매개변수를 사용했기 때문에 
코드 중복을 유발하는 API 관리자 또는 일부 네트워크 모델을 앱에 생성했을 것입니다.
앱 크기가 커짐에 따라 네트워크 스택을 구축하기 위해 몇 가지 일반적인 패턴을 사용하는 것이 필수적입니다. 
정답은 URLRequestConvertible 프로토콜과 라우터 디자인 패턴을 사용하는 것입니다.

라우터는 API 관리자(또는 API를 호출하는 모든 항목)가 이를 수행할 필요가 없도록 
URL 요청을 생성할 책임이 있습니다.

 

네.. 그렇다고 하네요.. 

 

 

 

어떻게 사용하나요 ??? ㅇㅂㅇ

it has a single requirement, asURLRequest()

저 프로토콜에는 asURLRequest 라는 단일 요구사항이 있습니다 

 

To start, we will declare a router. 

It will be an enum with a case for each type of call we want to make.

라우더를 선언해주고 URLRequestConvertible 프로토콜을 채택합니다.

그리고 enum으로 케이스를 나눠서 여러 endpoint에 대해서

path, method, parameter를 설정해줄 수 있습니다 ! 

 

import Alamofire
enum UserRouter: URLRequestConvertible {
    
    // 1.
    case login(user: User)
    case getUserInfo
    
    // 2.
    var path: String {
        switch self {
        case .login:
            return "login"
        case .getUserInfo :
            return "userInfo"
        }
    }
    
    // 3.
    var method: HTTPMethod {
        switch self {
        case .login:
            return .post
        case .getUserInfo:
            return .get
        }
    }
    
    // 4.
    var parameters: Parameters? {
        switch self {
        case .login(let user):
            return [
                "username" : user.username,
                "password" : user.password
            ]
        default:
            nil
        }
    }
    
    // 5.
    func asURLRequest() throws -> URLRequest {
       // 6.
        let url = try URL(string: Constant.BaseURL.asURL()
                                                  .appendingPathComponent(path)
                                                  .absoluteString.removingPercentEncoding!)
        // 7.
        var request = URLRequest.init(url: url!)
        // 8.
        request.httpMethod = method.rawValue
        // 9.
        request.timeoutInterval = TimeInterval(10*1000)
        // 10.
        return try URLEncoding.default.encode(request,with: parameters)
    }
}

 

1. First, add a case for each URLRequest endpoint. 

Swift enums can have arguments, and we can pass our data to the router.

: 먼저 각 URLRequest Endpoint에 대한 case들을 추가합니다. 

스위프트 enum으로 만들어둔 뒤 라우터에 전달한다고 합뉘다.

 

2. Define the endpoint for each URLRequest.

: 각 URLRequest에 대한 endpoint를 정의합니다 !

 

3. Add http method like .get, .post, .delete, .put… for each case.

: 각 case에 대하여 HTTPMethod를 추가합니다. 

 

4. You can add parameters property to set API parameters.

: 파라미터를 추가합니다 

 

5. To conform URLRequestConvertible protocol

we must add asURLRequest() function to the router.
: 이 프로토콜을 준수하려면 라우터에

asURLRequest() 함수를 추가해야합니다 !

 

6. In the asURLRequest function,

define URL as BaseURL and append path as request endpoint.

: asURLRequest 함수에서 URL을 baseURL로 정의하고

path를 request Endpoint로 추가합니다 !

 

7. Define request as URLRequest.

: 요청을 우리가 만든 URLRequest로 정의하기 

 

8. Add HTTP method to the request.

: 요청에 HTTP method 추가하기 

 

9. Optionally, we can add a timeout to the request.

: 선택적으로 timeout 추가할 수 있다 !!

 

10. Finally, return URLEncoding with the request I define earlier.

: 마지막으로 앞서 정의한 요청과 함께 URLEncoding 을 반환 !

 

 

 

아래와 같이 라우터만 전달해주면,, 실제 request 할때 코드가 굉장히 간결해지고 

중복되는 부분을 작성하지 않아도 됩니당 !! 

AF.request(UserRouter.login(user: user))
	.validate()
	.responseData { response in
             // Do whatever you wnat with response
        }

we no longer have to declare URL, query parameters, and headers locally for each API call.

더 이상 API 호출에 대해 URL, 쿼리 파라미터, 헤더를 로컬로 선언할 필요가 없어집니다 ! 굳

 

 

 

 

 

 

그냥 찾다가 발견한.,,, 알라모를 쓰는 이유... 정도 ??

 

Why do you need Alamofire at all? 

Apple already provides URLSession and other classes for downloading content via HTTP,

 so why complicate things with another third-party library?
The short answer is Alamofire is based on URLSession,

 but it frees you from writing boilerplate code, which makes writing networking code much easier.

 You can access data on the Internet with minimal effort,

 and your code will be much cleaner and easier to read.

 

요약하자면 URLSession이 있는데 왜 알라모를 쓰는지?

알라모는 유알엘세션을 기반으로 하지만 보일러플레이트 코드를 작성하지 않아도 되기 때문에

네트워킹 코드를 훨씬 쉽게 작성할 수 있다는 장점이 있기 때문 !

최소한의 노력으로 인터넷의 데이터에 엑세스 + 코드가 훨씬 깔끔하고 읽기 쉬움 !

 

이라고 합니다 ~ :) 

 

앱잼때도 URLSession을 모듈화해서 썼었는데, 아직 완벽하게 이해를 못했네요..

나중에 조금 더 이해도가 올라간다면 근본인

URLSession으로 다시 오겠습니다.. 휴 ~~ 

 

 

 

이 튜토리얼을 참고해서 번역.. 했습니다!!

Router pattern with Alamofire’s URLRequestConvertible protocol

이제 실제로 적용해보러 떠나보겠습니다 ~안뇽...