[DISCUSSION] APIClient 고도화

[ericKwon95]

개요

• 옵션 설정이 가능한 APIClient 만들기

문제 상황

• 이전 APIClient 구현은 옵션 설정이 어려운 단일 shared 객체를 제공했습니다.
• 그러나 각각의 요청들은 인터셉터가 필요없는 경우도 있고, timeout의 조정이 필요한 경우가 있는 등 주어야 할 옵션이 다른 경우가 있습니다.
• 현재 구조로는 이러한 상황에 대응하기 어려워 APIClient 구조의 변경이 필요합니다.

고민 과정

Session 주입받기

• 이러한 설정들은 보통 Session 생성 시 설정해줄 수 있습니다.
• 한 번 생성된 Session에 대한 설정 변경은 반영되지 않기 때문에 필요한 설정마다 Session을 초기화해 제공해야 합니다.
• 하나의 APIClient를 유지하며 필요한 상황마다 세션을 바꿔끼워주는 방법은 요청이 진행중이던 이전 세션이 사라지기 때문에 좋은 방법이 아닙니다.
• 따라서 APIClient 초기화 시 Session을 초기화해 주입하는 방식을 사용해볼 수 있겠습니다.
• 그런데 Session을 초기화해 주입하는 방식은 APIClient의 사용 방식을 외부에 의존하게 되고, Session에 대한 관리를 사용자에게 맡기게 됩니다.
• 이러한 방식은 사용하는 쪽에서 Session을 알아야 해서 Alamofire까지 import해야 하는 단점이 있습니다.
• 또한 중복되는 세션을 여러 번 생성하는 등의 나쁜 사용 사례가 발생할 가능성을 모듈 차원에서 차단하기 어렵다는 단점도 있습니다.

Request에 옵션 주기

• 인터셉터는 Session이 아닌 Request에 대해서도 지정할 수 있습니다. 인터셉터
• Timeout은 Session에 설정되어 있는 Timeout보다 더 적은 숫자로 Request에 대해 지정 가능합니다. 타임아웃
• 따라서 Session은 건드리지 않아도 Request에 옵션을 주는 것 만으로 원하는 요청 수행이 가능합니다.
• Timeout이 길어야 하는 경우엔 기본 Timeout 설정값이 긴 Session을 APIClient에서 제공하도록 구현할 수 있습니다.
• 각 Request마다 옵션을 주는 방식이 Session에 비해 유연성이 높고 사용성이 좋다고 생각됩니다.

해결 방안 제시

• 따라서 저는 세션 주입에서 Request에 옵션 주입으로 방식을 바꾸면 저희가 취하고 싶은 장점들을 모두 취할 수 있다고 생각합니다.
• 이 접근 방식에서 간과한 부분이 있는지, 추가로 고려해야 할 점이 있을지 여러분의 의견이 궁금합니다!

[ericKwon95]

@HenryVoid
APIClient 문제 어떻게 처리할까 고민하다가...
위와 같이 생각해 보았습니다. 우기님의 의견이 궁금합니다~!

[HenryVoid]

@HenryVoid APIClient 문제 어떻게 처리할까 고민하다가... 위와 같이 생각해 보았습니다. 우기님의 의견이 궁금합니다~!

회의록에서 이야기 나눈 것처럼 APIClient마다 싱글톤을 만들어서 제공하는 것은 어떨까요?
(Request에 옵션을 주어서 timeout 설정을 제어할 수 있다면 더욱 좋은 방법 같습니다!)
Session이 여러개 필요한 case가 없어지니까

[HenryVoid]

저는 필요한 경우가 아래 4개로 가능할것 같은데 더 필요한 경우가 있을까요?

• tokenRefresher 필요여부
• timeOut 제한여부 (ex.동영상)

[ericKwon95]

@HenryVoid APIClient 문제 어떻게 처리할까 고민하다가... 위와 같이 생각해 보았습니다. 우기님의 의견이 궁금합니다~!

회의록에서 이야기 나눈 것처럼 APIClient마다 싱글톤을 만들어서 제공하는 것은 어떨까요? (Request에 옵션을 주어서 timeout 설정을 제어할 수 있다면 더욱 좋은 방법 같습니다!) Session이 여러개 필요한 case가 없어지니까

조금 더 설명해주실 수 있을까요?

[ericKwon95]

저는 필요한 경우가 아래 4개로 가능할것 같은데 더 필요한 경우가 있을까요?

• tokenRefresher 필요여부
• timeOut 제한여부 (ex.동영상)

2개 말씀이신가요? 제 경우엔 없습니당

[HenryVoid]

@HenryVoid APIClient 문제 어떻게 처리할까 고민하다가... 위와 같이 생각해 보았습니다. 우기님의 의견이 궁금합니다~!

회의록에서 이야기 나눈 것처럼 APIClient마다 싱글톤을 만들어서 제공하는 것은 어떨까요? (Request에 옵션을 주어서 timeout 설정을 제어할 수 있다면 더욱 좋은 방법 같습니다!) Session이 여러개 필요한 case가 없어지니까

조금 더 설명해주실 수 있을까요?

아래처럼 만드려고 했는데 request에서 제어하는게 어떻게 되는 지 몰라서
4개라고 했네요 ㅜ session을 여러개 만들어서 사용하듯이

[HenryVoid]

@ericKwon95
Request에서 제어한다는게 어떻게 되는걸까요?
혹시 제어할 때 Endpoint가 무엇인지 알고 있어야한다면 공통화할 수 있는 방법을 찾아야할 것 같아요!
모듈로 분리해놓은 곳이라서

[ericKwon95]

@HenryVoid

AF.request(url) { $0.timeoutInterval = 60 }
    .validate()
    .response { _ in // handle response here }

이런 방식으로 request 자체에 옵션을 걸어줄 수 있어서
세션은 하나로 유지하되 request 메소드에 옵션을 주면 될 것 같습니당

[HenryVoid]

@HenryVoid
이런 방식으로 request 자체에 옵션을 걸어줄 수 있어서 세션은 하나로 유지하되 request 메소드에 옵션을 주면 될 것 같습니당

아하 async/await 구조를 벗어나면 가능할것 같네요!
음.. 하지만 Predict 함수 내 구조가 제가 추구하는 방향이랑 많이 달라서 아래 문제들만 해결할 수 있다면
제가 생각한 구조를 벗어나도 괜찮을 것 같아요!

• AF.Request 중복코드 (Alamofire import 선언 최소화)
• Endpoint 의존 (직접 > 간접)

[ericKwon95]

@HenryVoid
이런 방식으로 request 자체에 옵션을 걸어줄 수 있어서 세션은 하나로 유지하되 request 메소드에 옵션을 주면 될 것 같습니당

아하 async/await 구조를 벗어나면 가능할것 같네요! 음.. 하지만 Predict 함수 내 구조가 제가 추구하는 방향이랑 많이 달라서 아래 문제들만 해결할 수 있다면 제가 생각한 구조를 벗어나도 괜찮을 것 같아요!

• AF.Request 중복코드 (Alamofire import 선언 최소화)
• Endpoint 의존 (직접 > 간접)

위 예시는 인터셉터 / 타임인터벌을 Request 단위로 조작 가능함을 보여드리기 위한 예시입니당
근데 콜백 예시로 드렸군요.. 죄송합니다;
저희 코드에 적용하면 아래와 같이 바꿀 수 있을 듯 합니다

 public func request<T: Decodable>(_ endpoint: Endpoint, timeoutInterval: TimeInterval = 30, interceptor: (any RequestInterceptor)? = nil, decode: T.Type) async throws -> T {
    do {
        var request = try endpoint.asURLRequest()
        request.timeoutInterval = timeoutInterval
        let result = try await self.session.request(request, interceptor: interceptor).serializingData().response
        return try self.manageResponse(data: result.data, response: result.response)
    } catch let error as APIError {
        throw error
    } catch {
        throw APIError(
            errorCode: "ERROR",
            message: "Unknown API error \(error.localizedDescription)"
        )
    }
}

이렇게 하면 중복코드가 발생하지 않고 Endpoint에 간접 의존하며, 각 request마다 인터셉터 / timeoutInterval을 설정해줄 수 있게 됩니다

다만 timeoutInterval은 session에 정의된 것 보다 작은 값이어야 해요.
session에 정의된 값 보다 큰 값을 정의하면 session의 값이 우선적으로 적용됩니다.