Moya 간단 사용법 - Request sample부터 실제 뷰컨트롤러에서 사용까지

 

 

 

저는 최근 2월에 수료한 연합동아리 UMC 3기에서 협업 프로젝트 와우메이트에서 iOS 파트 리드를 맡았습니다.

2월 16일 UMC 3기 데모데이 현장

 

 

제가 담당한 프로젝트에서는 네트워크 통신을 Moya 를 이용해서 네트워크 통신 정보를 추상화하고 있는데요.

 

UMC 3기의 학기중 수업에서는 Alamofire 만 주로 다뤘기 때문에, 간단한 사용법을 정리해둔 것을 공유해봅니다.

 

---

 

Moya로 더 편하게 관리할 수 있을거라고 생각해서 작업을 해두었는데 처음 해보신다면 많이 헷갈릴 것 같아요. 한 번 보고 해보시면 수월하지 않을까 싶어 정리해봅니다.

 

 

1. Codable 구조체를 선언하기

 

서버 측에서 전달받은 API 명세에 보면 JSON 예시가 있습니다. 게시글을 등록하는 API를 예로 들어봅시다.

{
     "postTitle":"1번째 게시글",
     "categoryName": "운동",
     "postMember": 0,
     "tag1": "umc",
     "tag2": "wowmate",
     "tag3": null,
     "tag4": null,
     "tag5": null,
     "postContext": "첫번째 게시글 등록 완료"
}

 

이걸 그대로 복사해서 quicktype.io 에 가져갑니다.

 

 

퀵타입은 JSON 양식을 언어에 맞게 모델을 자동으로 생성해줍니다.null 값이 있을 경우 Nullable 처리가 되는 경우가 있습니다. Swift에서 Optional 처리는 type-safety를 위해서 강제 해제보다는 guard-let등을 이용한 언래핑이나 nil-coalescing 을 해야되는데 이 경우 처리가 복잡해지므로 웬만하면 null이 없는 값으로 받을 수 있는게 좋을 것 같아요.

 

이렇게 만들어진 구조체는 새로운 파일을 만들어 복사해줍니다. 저는 게시글과 관련된 모델을 한 곳에 모아보는게 좋을 것 같아서 Post.swift 파일에 모아두려고요.

 

// Post.swift 

import Foundation

// MARK: - PostRegister
struct PostRegister: Codable {
    let postTitle, categoryName: String
    let postMember: Int
    let tag1, tag2, tag3, tag4: String
    let tag5, postContext: String
}

 

 

 

2. Moya의 TargetType으로 네트워크 통신할 내용을 선언해둡니다.

이걸 왜 하냐면요. 저희가 이전에 배웠던 Alamofire를 이용해 AF.request 하고 여기에 메서드와 헤더와 파라미터 넣고 등등을 하게 될 경우 뷰컨트롤러 코드에서 너무 많은 의존성이 생기고 코드를 재사용하기가 어렵게 됩니다. 그리고 나중에 수정해야된다면 일일히 찾아 고치기가 번거롭게 되겠죠. 코드에서 관심사를 의미단위로 최대한 나누는 것은 이후 재사용성 및 유지보수를 위해서 꼭 필요한 작업입니다.

 

 

일전에 제가 Data/Model 폴더 안에 정리해둔 내용을 한 번 다시 살펴봅시다.

 

Endpoint.swift 에는 베이스 url이 들어갑니다. 저희가 notion.so/wowmatte 가 있다면 여기서 notion.so 가 베이스에 해당합니다. 이미 넣어두었으니 신경쓰지 않으셔도 됩니다.

 

```swift
// Endpoint.swift

import Foundation

enum ServiceAPI {
    static let baseURL = "<http://ec2-13-209-29-182.ap-northeast-2.compute.amazonaws.com:8080>"
}
```

Post.swift 에 아까 만든 모델을 넣어줍니다. 

```swift
/* 게시글 등록 (post - posts) */
// MARK: - PostRegister
struct PostRegister: Codable {
    let postTitle, categoryName: String
    let postMember: Int
    let tag1, tag2, tag3, tag4, tag5, postContext: String
}
```

 

PostAPI에서 통신 형태에 맞춰 정리해줍니다. 저희는 게시글 등록이고, 모델명도 그에 맞춰 바꿨으니 열거형에 case를 이름맞춰 추가해줍니다.

 

내용을 받아서 넣어주어야 하므로 열거형의 연관값(Associated Value) 을 이용해 파라미터를 넣어줍니다. 추가한 내용과 참고할 내용은 아래 코드에 주석으로 달아놓았습니다.

 

//PostAPI.swift

enum PostAPI {
    case posts
    case mockPosts
		case postRegister(param: PostRegister) // <- New! 연관값으로 값을 받아줍니다.
}

저희는 TargetType으로 extension한 코드에서 나머지 부분을 채울 것입니다.

 

extension PostAPI: TargetType {
    var baseURL: URL {
        switch self {
        case .mockPosts:
            return URL(string: "<https://63ba608856043ab3c79a44ce.mockapi.io/api/v1>")!
        default:
            return URL(string: ServiceAPI.baseURL)! // 이미 열거형에 베이스를 선언했으므로
        }
        
    }
	var path: String {
        switch self {
        case .posts, .postRegister: // path 둘다 동일합니다.
            return "/posts"
        case .mockPosts:
            return "/posts"
        }
    }
	var method: Moya.Method {
        switch self {
        case .posts:
            return .get
        case .postRegister: // 게시글등록하는 경우 .post 메서드를 사용합니다.
            return .post
        case .mockPosts:
            return .get
        }
    }
	var task: Moya.Task {
        switch self {
        case .posts:
            return .requestPlain
        case .postRegister(let param):
            return .requestJSONEncodable(param) // 받아둔 값을 JSON 형태로 보내기
        case .mockPosts:
            return .requestPlain
        }
    }
	var headers: [String : String]? {
        switch self {
        default:
            return ["Content-Type": "application/json"] // 토큰이 들어갈 경우 여기에 들어감.
        }
    }

 

저희가 로그인을 하거나 수정을 하거나 게시글을 작성하는 등 많은 부분들이 헤더쪽에서 인증이 이루어져야 하는데요. 그 부분의 경우 명세가 업데이트 되면 추가하겠습니다. 보통은 content-type 정도는 JSON 형태로 데이터를 보내는 서버에서 기본적으로 사용하는 것 같아요. 전에는 nil 이었는데 일단 추가해봅니다. 저 헤더 부분은 HTTPHeader? 형태로도 정의가 가능합니다.

 

 

3. 싱글톤으로 관리할 네트워크 매니저 파일에 메서드를 추가합니다.

이미 만들어둔 PostManager.swift로 넘어갑니다. 명세서의 response sample을 보면 이렇게 나와있는데요.

 

"isSuccess": true, "code": 200, "message": "SUCCESS!", "data1": { "postId": 2 } }

 

메시지에 성공 및 실패사유가 있어서 메시지만 보내도 될 거 같습니다.

아래처럼 탈출클로저를 이용해서 넣어두었습니다.

 

import Foundation
import Moya

class PostManager { 

	private init() {} 
	static let shared = PostManager() 
	let provider = MoyaProvider<PostAPI>() // 게시글 등록 

	func registerPost(post: PostRegister, completion: @escaping (Result<String, Error>) -> Void ) { 
 		provider.request(.postRegister(param: post)) { result in 
        	switch result { 
            	case .success(let data): 
                	if let json = try? JSONSerialization.jsonObject(with: data.data,options: []) as? [String : Any] { 
                    	if let message = json["message"] as? String { 
                        	completion(.success(message)) 
                            } 
                        } 
                case .failure(let error): 
                	completion(.failure(error)) 
                
           	} 
        } 
    }
}

 

 

4. 실제 뷰컨트롤러에서 사용해보기

사용자에게 받은 내용을 PostRegister 구조체로 저장한 후 해당 내용을 이렇게 넣어둡니다. 네트워크 통신 성공, 실패 여부에 따라 필요한 액션을 추가하면 됩니다.

let postByUser = PostRegister(postTitle: "제목", categoryName: "카테고리", postMember: 2, tag1: "태그1", tag2: "태그2", tag3: "태그3", tag4: "", tag5: "", postContext: "내용")
PostManager.shared.registerPost(post: postByUser) { result in
    switch result {
    case .success(let success):
        print(success)
    case .failure(let failure):
        print(failure)
    }
}

 

---

 

 

오늘도 읽어주셔서 감사합니다. 

 

궁금하거나 나누고 싶은 얘기가 있으시면 댓글로 알려주세요!

재밌게 읽으셨다면 공감과 구독은 큰 힘이 됩니다. 

 

항상 감사합니다.

 

 

이 글은 doy.oopy.io 에도 발행되어 있습니다.