OkHttp 결과 데이터의 중복 결과값들을 하나의 data class로 처리하기!

지난 Retrofit관련 포스팅 이후에, 곰곰이 생각해 보니까 빼먹은 내용이 있더라고요. 그래서 추가로 포스팅을 남겨봅니다.

보통 같이 일하는 백엔드 개발자 분에 따라, 회사 정책에 따라, 많이 변화되는 부분인데요.
어떤 결과값을 API에서 넘겨주느냐에 따라서 이 내용이 도움이 될 수도 안될 수도 있겠습니다.

테스트 API에서는 딱히 필요 없는 내용이고, 저희 사내 API 규칙에는 필요한 내용인데요.

API결과 데이터 중, RESULT 데이터가 아닌 Response 구조가 중복처리될 때, 사용합니다.

지난 포스팅에서 inteceptor를 통해 데이터를 받기 전에 여러 처리들을 하는 코드를 넣어보았는데요

• 로그 확인용
• 헤더 삽입용

이번에는 공통 response 값들을 묶어서 하나의 데이터 클래스로 처리하기 위한 방법입니다.

사실 꼭 해줘야 하는 내용은 아니죠, data class를 그냥 여러 개 만들고 계속 사용해도 되기는 합니다.

하지만 우리 모두 중복된 데이터 좋아하지 않잖아요? 똑같은 코드가 반복되는거 역시 좋아하지 않습니다.

그래서 response 내의 값이 변경되는 주요 결과 데이터만 예쁘게 저리할 수 있도록 처리해 주도록 하려고 하는 것입니다.
보기에 예쁘게 정리하는 것이,,,저는 개인적으로 좋습니다.

사실 중복 data class가 많으면 필연적으로 주석을 많이 달게 됩니다.
그러면 유지보수하기 너무 힘들어서요. 그냥 하나로 쌈빡하고 예쁘게 정리하는 것이 나중에도 좋을 것 같습니다.

이 부분은 저번과 동일한 interceptor 코드입니다.
이 코드 내에 결과 데이터를 공통 wrapper response 클래스에 묶고 유효한 데이터들만 넘겨주려고 합니다.

interceptor 클래스 내에서, responseBody 내부함수를 이용하여, responsebody를 재구성하였습니다.
responseWrapper의 result데이터를 responsebody 데이터로 치환하는 내용입니다.

그러면 로그 상으로도 반복적으로 내려오던 데이터가 아닌 result의 데이터가 responsebody데이터로 넘어오는 것을 확인할 수 있습니다.
(이 부분은 따로 사내 데이터 로그이기 때문에 로그 제공이 불가능합니다.)

class NetworkInterceptor: Interceptor {

    private companion object {
        private const val SERVER_ERROR_CODE = 500
    }

    override fun intercept(chain: Interceptor.Chain): Response {

        try {
            val newRequest = chain.request().newBuilder().build()
            val response = chain.proceed(newRequest)

            val rawData = responseBody(response)

            return response.newBuilder()
                .message(response.message)
                .body(rawData?.toResponseBody())
                .build()

        } catch (e: Exception) {
            val message: String = when(e) {
                is SocketTimeoutException -> "SocketTimeoutException"
                else -> "Exception"
            }

            return Response.Builder()
                .request(chain.request())
                .protocol(Protocol.HTTP_2)
                .code(SERVER_ERROR_CODE)
                .message(message)
                .body("{$e}".toResponseBody(null))
                .build()
        }
    }

    private fun responseBody(response: Response): String? {
        val responseBody = response.body ?: return "{}"
        val contentLength = responseBody.contentLength()
        if (contentLength == 0L) {
            return "{}"
        }

        val res = Gson().fromJson<ResponseWrapper<*>>(
            response.body?.string() ?: "{}",
            object : TypeToken<ResponseWrapper<*>>() {}.type
        )

        return if (res.result == null) "{}" else Gson().toJson(res.result)

    }
}

ResponseWrapper 내부에 묶인 code, message, description은 모든 API에서 공통적으로 내려주는 데이터입니다.
그 하위에 result가 실제적으로 필요한 결과 데이터이지요.

아마 이 정도가 가장 베이직한 구조이고 서버 구조 및 서비스 구성에 따라 토큰이 이곳에 오고 갈 수도 있겠고
다른 타입 데이터들이 넘어올 수도 있겠습니다.

공통적으로 처리되는 것들은 ResponsoeWrapper내에 넣어서 하나로 관리 될 수 있도로 하면 됩니다.

@Parcelize
data class ResponseWrapper<T>(

    @SerializedName("code")
    val code: String,
    @SerializedName("message")
    val message: String,
    @SerializedName("description")
    val description: String,

    @SerializedName("result")
    val result: @RawValue T? = null
)

이러면 중복적인 data class는 하나로 처리하고 결과 데이터들의 data class만 잘 관리해서 연결해 주면
그럭저럭 깔끔한 코드 관리가 가능합니다.