CountryCodeAPIService 응답 처리 로직 개선

[yeahg-dev]

🚨 문제 설명

• CountryCodeAPIService에서 apikey오류 response도 status code: 200, Content-Type: xml 타입으로 응답
• 따라서 기존 APIService의 request를 요청하는 메서드에서 해당 오류를 걸러낼 수 없었고, 오류 처리를 할 수 없었음

extension APIService {
    
    func execute<T: APIRequest>(request: T) async throws -> T.APIResponse {
        guard let urlRequest = request.urlRequest else {
            throw APIError.invalidURL
        }
        
        let (data, response) = try await session.data(for: urlRequest)
        
        guard let response = response as? HTTPURLResponse,
              // 원하는 json데이터가 아닌 xml데이터가 200으로 도착
              (200...299).contains(response.statusCode) else {
            print("\(T.self) failed to receive success response(status code: 200-299)")
            throw APIError.HTTPResponseFailure
        }
        
        guard let parsedData: T.APIResponse = parse(response: data) else {
            print("parsing failed. type: \(T.APIResponse.Type.self) ")
            throw APIError.invalidParsedData
        }
        
        return parsedData
    }
}

✅ 해결 방법

문제 분석

• response의 header의 Content-Type 필드 값을 조회하면 오류 체크 및 처리가 가능

해결 방법

• Content-Type이 application/json;charset=UTF-8이 아니면 에러를 반환

struct CountryCodeAPIService: APIService {
    
    var session: URLSession = URLSession(configuration: .default)
    
    func requestAllCountryCode() async throws -> [CountryCode] {
        let request = CountryCodeListRequest(pageNo: 1, numOfRows: 240)
        let countryCodeList: CountryCodeList = try await getResponse(request: request)
        return countryCodeList.data
    }
    
    func getResponse<T: APIRequest>(request: T) async throws -> T.APIResponse {
        guard let urlRequest = request.urlRequest else {
            throw APIError.invalidURL
        }
        
        let (data, response) = try await session.data(for: urlRequest)
        
        guard let response = response as? HTTPURLResponse,
              (200...299).contains(response.statusCode) else {
            print("\(T.self) failed to receive success response(status code: 200-299)")
            throw APIError.HTTPResponseFailure
        }
        
        guard let contentType = response.value(forHTTPHeaderField: "Content-Type"),
        contentType == "application/json;charset=UTF-8" else {
            print("\(T.self) : response Content-Type is \(String(describing: response.value(forHTTPHeaderField: "Content-Type")))")
            throw APIError.HTTPResponseFailure
        }
        
        guard let parsedData: T.APIResponse = parse(response: data) else {
            print("parsing failed. type: \(T.APIResponse.Type.self) ")
            throw APIError.invalidParsedData
        }
        
        return parsedData
    }
    
}

• 기존 APIService의 getResponse메서드는 프로토콜 기본 구현으로 다른 Service에서도 사용되므로, 단일책임원칙과 개방폐쇄원칙을 위반한 코드임
• 따라서 getResponse를 프로토콜에 정의, 추상화하여 확장에 용이하도록 리팩터링
• Combine 프레임워크 또한 불필요하게 APIService에 종속되어있으므로, CombineAPIService 프로토콜을 정의하여 역할을 분리

protocol APIService {
    
    var session: URLSession { get set }
    
    func getResponse<T: APIRequest>(request: T) async throws -> T.APIResponse
    
}

protocol CombineAPIService: APIService {
    
    func getResponse<T: APIRequest>(
        request: T)
    -> AnyPublisher<T.APIResponse, Error>
    
}

👩🏻‍💻결과와 피드백

• APIService의 확장성 향상됨
• 불필요한 Combine을 import를 제거함으로써 최적화함