[Swift] Moya를 사용해봅시다.

안녕하세요~

 

오늘은 기존 프로젝트에 새롭게 추가하기로 결정한

Moya 라이브러리에 대해서 정리해 볼까 합니다.

 

라이브러리 링크입니다 : - )

GitHub - Moya/Moya: Network abstraction layer written in Swift.

 

---

 

깃허브에 가보면 다음과 같은 이미지가 있습니다.

 

Moya

 

이 이미지 위에는 다음과 같은 글이 적혀있습니다.

당신은 똑똑한 개발자입니다. 당신은 아마 URLSession과 신경 쓰지 않는 모든 불쾌한 세부 사항에 대한 액세스를 추상화하기 위해 Alamofire를 사용할지도 모릅니다. 그러나 똑똑한 개발자 네트워크 추상화 계층을 작성할 겁니다. "APIManager" 또는 "NetworkModel"라고 불리며 하지만 이 작업은 항상 눈물로 끝이 날 겁니다. 
- Moya README.md

 

읽다보니 제 경험담을 늘어놓은 것 같아서 마음이 아팠습니다.

 

---

 

Alamofire를 사용하고 있었지만 

주변에 Moya를 사용하고 계신분들도 있어 

이번 기회에 저도 간단하게라도 사용방법을 익히고 가려고 합니다.

 

간단한 설명

네트워크 통신을 위해 URLSession을 사용할 수 있습니다.

하지만 Moya 라이브러리 README에서 봤던 것처럼 복잡하고 가독성이 떨어지며 추상화를 위해 애쓰게 됩니다.

 

그래서 선택하게 되는 게 가장 잘 알려진 Alamofire입니다.

 

하지만 유지보수와 유닛 테스트가 힘들다는 단점이 있어

이를 조금 더 추상화시켜 탄생한 것이 바로바로 Moya라고 합니다.

 

                           (추상화)                  (추상화)

결론 : URLSession    ->    Alamofire    ->    Moya  

                                 

사용방법

1. 열거형을 하나 작성해 주세요. 사용될 Target들을 작성할 겁니다.

- 필요한 매개변수가 있다면 함께 기입하시면 되고 필요 없다면 적지 않으셔도 됩니다.

- User관련 API가 있다면 UserTarget 등 각각의 조건에 맞게 타겟을 설정하시면 됩니다.

//DefaultTarget은 무시하셔도 됩니다!
enum UserTarget : DefaultTarget {
    case getUser(idToken : String) 				//유저정보
    case signupUser(idToken: String,SignupParameter)		//회원가입
    case withdrawUser(idToken: String) 				//회원탈퇴
    case updateMypage(idToken: String,MypageParameter) 		//내정보 업데이트
    case updateFCMToken(idToken: String,FCMtokenParameter)	//FCM토큰 갱신
}

 

2. TargetType을 구현해주어야 합니다.

- TargetType을 채택하고 나면 다음과 같이 사용하게 될 프로퍼티들이 나옵니다.

extension UserTarget : TargetType {
    var baseURL: URL { }
    
    var path: String { }
    
    var method: Method { }
    
    var task: Task { }
    
    var headers: [String : String]? { }
}

 

평소에 Alamofire를 사용할 때

따로 모듈화를 진행했던 프로퍼티들을 한 번에 관리할 수 있게 도와주는 프로토콜이라고 생각하면 편할 것 같습니다.

 

Moya에서는 MoyaProvider <TargetType>으로 request를 수행하기 때문에 해당 프로토콜을 반드시 구현해야 합니다.

 

그런데 여기서 오류가 발생하실 거예요.

※method 부분에 Moya.Method로 타입을 변환해 주면 해결됩니다   

 

각 프로퍼티들은 다음과 같습니다.

• baseURL: 서버의 endpoint 도메인
• path: 도메인 뒤에 추가될 경로
• method: HTTP method 
• task: request에 사용될 파라미터. requestPlain: no param,. requestParameters(parameter:, encoding:)
• headers: HTTP Header

정리해 보면 다음과 같이 작성할 수 있습니다.

//예시를 위해서 두개만 적어볼게요!
extension UserTarget : TargetType {

    //BaseURL
    var baseURL: URL {
        return URL(string: "http://www.naver.com")!
    }
    
    //Path
    var path: String {
        switch self {
        case .getUser : return "user"
        case .updateFCMToken : return "user/update_fcm_token"
        }
    }
    
    //HTTP Method -> GET, POST, PUT, DELETE
    var method: Moya.Method { 
        switch self {
        case .getUser: return .get
        case .updateFCMToken : return .put
        }
    }
    
    //Task
    var task: Task {
        switch self {
            
        case .getUser:
            return .requestPlain
            
        case .updateFCMToken(_,let parameter):
            return .requestParameters(parameters: [
                "FCMtoken": parameter.FCMtoken
            ], encoding: URLEncoding.default)
        }
    }
    
    //Headers
    var headers: [String : String]? {
        
        switch self {
        case .getUser(let idToken):
            return [
                "idtoken": idToken
            ]
        case .updateFCMToken(let idToken,_):
            return [
                "idtoken": idToken,
                "Content-Type": "application/x-www-form-urlencoded"
            ]
    }
}

 

3. Request는 다음과 같이 작성할 수 있습니다.

 

RxSwift를 이용할 경우 Request는 다음과 같이 작성합니다.

private let provider = MoyaProvider<UserTarget>()

provider.rx.request(.getUser(idToken: idToken))
            .subscribe{ result in
                switch result {
                case .success(let response):
                    onCompletion(try? response.map(User.self),response.statusCode)
                case .failure(let error):
                    onCompletion(nil,error.asAFError?.responseCode)
                }
            }
            .disposed(by: disposeBag)

 

사용하지 않는다면 다음과 같이 작성합니다.

 

provider.request(.getUser)) { result in
    switch result {
    case let .success(response):
         onCompletion(try? response.map(User.self),response.statusCode)
    case let .failure(error):
          onCompletion(nil,error.asAFError?.responseCode)
    }

}

 

 

Moya 라이브러리의 간단한 사용방법에 대해서 정리해 봤습니다.

어렵지 않게 구현할 수 있었고

Moya가 주는 간편함과 가독성이 좋아 자주 사용하게 될 것 같습니다 : - )

 

그럼 이만 👋🏻 👋🏻