[iOS] 서버 통신 Base Service

A. 설명

api 통신 필요할 때마다 보일러 플레이트 코드가 너무 많이 생기는 것 같아 base로 사용할 코드 만듦. 프로토콜로 정의해서 재사용성 용이하도록 구현함. 웹 연결에는 Alamofire 프레임워크를 사용함.

 

B. 코드

import Foundation
import Alamofire

protocol BaseService {
    /// api request url
    var url: String { get set }
    var header: HTTPHeaders { get set }
    var param: Encodable? { get set }
    /// Request에 들어가는 .put, .get 등 method
    var method: HTTPMethod { get set }
    /// Request에 들어가는 Parameter encoding 방식
    var encoding: ParameterEncoding? { get set }
}

extension BaseService {
    /// BaseService에 지정한 값으로 api 연동을 수행한 결과(NetworkResult)가 closure 함수의 param이 됨.
    func serverAction<T>(type: T.Type, completion: @escaping(NetworkResult<Any>) -> Void) where T: Decodable {
        var paramAsDictionary: Parameters? = ["Tmp": "Tmp"]
        do {
            let dictionary = try param?.encode()
            paramAsDictionary = dictionary
        } catch {
            print(error)
        }

        let dataRequest = AF.request(
            url,
            method: method,
            parameters: paramAsDictionary,
            encoding: encoding ?? JSONEncoding.default,
            headers: header
        )

        dataRequest.responseData { response in
            switch response.result {
            case .success:
                guard let statusCode = response.response?.statusCode else { return }
                guard let value = response.value else { return }
                let networkResult = self.judgeStatus(by: statusCode, value, type: T.self)
                completion(networkResult)

            case .failure(let error):
                print("network err : \(error)")
                completion(.networkFail)
            }
        }
    }

    func judgeStatus<T>(by statusCode: Int, _ data: Data, type: T.Type) -> NetworkResult<Any> where T: Decodable {
        switch statusCode {
        case ..<300: return isValidData(data: data, type: T.self)
        case 400..<500:
            return isErrorData(data: data)
        case 500..<600: return .serverErr
        default: return .unRecognizedError
        }
    }

    func isValidData<T>(data: Data, type: T.Type) -> NetworkResult<Any> where T: Decodable {
        let decoder = JSONDecoder()

        guard let decodedData = try? decoder.decode(type, from: data) else {
            return .unRecognizedError
        }
        return .success(decodedData as Any)
    }

    func isErrorData(data: Data) -> NetworkResult<Any> {
        let decoder = JSONDecoder()
        guard let errorData = try? decoder.decode(ServerErrorModel.self, from: data) else {
            return .unRecognizedError
        }
        return .pathErr(errorData)
    }
}

enum NetworkResult<T> {
    /// output data에 맞춰서 파싱까지 완료된 경우
    case success(T)
    /// network failure가 아닌 에러가 발생했고
    /// api 문서에 명시된 에러 data에 맞춰서 파싱까지 완료된 경우
    case pathErr(T)
    /// code 500~599로 서버 쪽 에러인 경우
    case serverErr
    /// 기기 네트워크 문제인 경우
    case networkFail
    /**
     1. network failure가 아닌 에러가 발생했지만
     api 문서에 명시된 에러 data에 맞춰서 파싱이 불가능한 경우
     2. code가 200대이기는 한데 Service 호출쪽에서 전달해준
     data 형식에 맞춰 파싱이 불가능한 경우
     3. code가 600 이상인 경우 */
    case unRecognizedError
}

// codable -> dictionary Type
extension Encodable {
    func encode() throws -> [String: Any] {
        let data = try JSONEncoder().encode(self)
        guard let dictionary = try JSONSerialization.jsonObject(with: data, options: .allowFragments) as? [String: Any] else {
            throw NSError()
        }

        return dictionary
    }
}

 

C. 사용 방법

사용하려고 하는 웹서버 연결 클래스에서 BaseService 상속 받은 후 url, header, param, method, encoding 변수 채워준 후 serverAction()로 각 케이스별 내용 구현해주면 됨. 

 

Z. 레퍼런스

이분거 참고해서 구현함 : https://roniruny.tistory.com/141

[iOS] Alamofire를 통해 서버와 통신 해보기 - GET