[Android][Retrofit][OAuth] OAuth2.0 인증 처리로 변경

서버에서 OAuth2.0 인증 도입으로 안드로이드 앱의 사인인 및 api 통신 및 에러처리에 수정 사항이 생겼다.

 

OAuth2.0 

https://oauth.net/2/

** OAuth2.0 문서를 읽고 추가할 예정

 

 

 

Retrofit 에서의 처리

 

API 통신 시, Access Token을 Header에 넣어주고 있고, 이 처리는 OkHttp의 interceptor를 사용해 처리한다.

https://square.github.io/retrofit/

사인인 하면서 받는 토큰 정보에 토큰의 유효 기간 정보도 알려주나, 이를 활용하기 보다는 API 통신 시에 받는 access token 만료 에러코드를 받아 access token을 갱신 후 다시 해당 API 통신을 진행하는 방법으로 구현하기로 했다.

 

OkHttpClient에 add하는 기존 interceptor는 헤더에 access token을 삽입하는 역할을 하고 있었다. 이 interceptor에서 reponse의 에러코드를 파싱해 다음과 로직을 타도록 수정했다.

A) access token 만료 에러코드가 내려오지 않으면 받은 reponse를 리턴해주기

B) access token 만료 에러코드가 내려오면 access token을 갱신해서 해당 API 통신의 response를 리턴해주기

C) access token 만료 에러코드가 내려오면 access token을 갱신하지만 refresh token 만료 에러로 실패할 경우 

C-1) 이메일 계정의 경우 로그아웃해서 로그인 화면으로 진입하기

C-2) SNS 계정의 경우 SNS 서비스의 refresh token을 받아 다시 로그인하고 해당 API 통신의 response를 리턴해주기

 

구현 과정에서 마주한 문제들은 다음과 같다.

 

Q1. 에러응답 파싱을 위해 한 번 소비한 body는 재사용이 불가하다. 에러응답 파싱이 끝난 후 response를 리턴해줘야 하는데 문제 봉착.

A1. 에러 응답 파싱을 위해 body를 한번 소비했기 때문에 새로 만들어주지 않으면 다른 인터셉터에서 body 접근 시 크래시 난다. 같은 콘텐츠의 body를 가진 새 response를 만들어 리턴해준다.

class MyInterceptor : Interceptor {
    override fun intercept(chain : Interceptor.Chain): Response {
        val request = chain.request().newBuilder().addHeader("key",accessToken).build()
        
        val originalResponse = chain.proceed(request)
        
        val body = originalResponse.body ?: return originalResponse
        val bodyString = body.string()
        
        val newResponse = originalResponse.newBuilder().body(bodyString.toResponseBody(body.contentType())).build()
        
        ....
        //에러파싱 후 문제 없는 경우
        return newResponse
    }
}

 

Q2. 에러코드 파싱은 어떻게 하나. 인터넷의 예제들을 보면 repsonse의 code 값으로 200 외의 값들을 확인해서 간단하게 상태를 확인해서 진행하던데. 우리 서버는 code를 200으로 내려주고 response body 안에 status와 error code 값을 따로 제공해줘서 예제들처럼 구현할 수가 없다. 이거 가장 간단하게 파싱할 방법은 없나?

A2. Gson을 이용한다.

//Data : 서버에서 받는 response body의 form.

val type = object : TypeToken<Data<*>>() {}.type

val errorCode : Int = try {
    val data = Gson().fromJson<Data<*>>(bodyString, type) ?: throw JsonSyntaxException()
    
    if(data.status == 200) return newResponse else data.errorCode
} catch (e: JsonSyntaxException) {
    return newResponse
} catch (t: Throwable) {
    return newResponse
}

 

Q3. 이메일 계정이 refresh token 만료로 access token 갱신에 실패하면 로그아웃하고 로그인 화면으로 이동해야 하는데, 이 처리를 어떻게 구현하지? API 통신시 이 interceptor 외에 다른 interceptor들도 존재하고, 수많은 개발자들이 거쳐간 프로젝트라서 API 통신 서비스 기능이 통일되지 않고 다양한 상태이다. 에러 공통처리가 잘 이루어지지 않은 상태에서 가장 간단한 방법은 무엇이 있을까? 

A3. 이메일 계정이 refresh token 만료 에러 코드를 받으면 custom exception를 throw 시키자. custom exception을 받으면 로그아웃시키고 로그인 화면으로 돌아가도록, Throwable에 확장함수를 만들어서 API 통신시 exception 처리로 접근하자. 모든 API 통신 부분들을 살펴야는 하겠지만, throwable에 확장함수를 쓰기만 하면 된다.

 

Q4. SNS 계정이 refresh token 만료 시에는 SNS 로그인을 시도해야 한다. kakao나 facebook 같은 SNS library에서는 callback으로 token 가져오기 및 사용자 정보를 가져오고 있어서 비동기로 동작한다. 그러나 동기로 token 가져오기, 사용자 정보 가져오기를 진행해야 하는 상황이다. callback이 실행된 이후에 다음 작업을 진행하도록 동기로 실행할 수 있는 방법은 무엇인가?

A4. CountDownLatch를 사용한다.

//카카오쪽 

val latch = CountDownLatch(1)
UserApiClient.instance.me { user: User?, error: Thrawable? -> 
    if (error != null) {
       ...
       latch.countDown()
    } else if (user != null) {
       ...
       latch.countDown()
    }
}
latch.await()