구글 로그인 CredentialManager 마이그레이션 + Firebase Auth

구글 One-Tap 로그인을 파이어베이스로 경유해서 구현했다.

 

기존 구글 로그인 구현한 코드를 먼저 보자. 파이어베이스 공식 문서에 있는 스니펫은 잘 작동하긴 하지만 너무 오래돼서 내 마음대로 개조했다.

 

혹시 구글 로그인을 예시코드대로 따라했을 때

developer console is not set up correctly.

service: oauth2:openid amgv: error when calling server using gmsnetworkstack.

로그에 이런 문장이 보인다면, firebase 프로젝트 설정에 SHA-1 등록이 안돼있는 상태이므로 SHA-1등록을 해주면 해결될 것이다.

https://github.com/firebase/snippets-android/blob/b8f65e9150fe927a5f0473e15e16fa5803189b60/auth/app/src/main/java/com/google/firebase/quickstart/auth/kotlin/GoogleSignInActivity.kt#L49-L54

snippets-android/auth/app/src/main/java/com/google/firebase/quickstart/auth/kotlin/GoogleSignInActivity.kt at b8f65e9150fe927a5f

 

하나하나 뜯어보자. 현재 프로젝트에서 SAA 구조를 사용하고 있어서 Fragment기준으로 작성되었다.

예제 코드에서 onActivityResult로 작성되어있는 부분이 있다. 구글 로그인 액티비티를 띄우고, 그것에 대한 응답값을 받아 처리하는 부분인데 이 코드는 deprecated된지 오래다.

그래서 ActivityResultLauncher를 사용해 코드 구조를 좀 바꿔봤다. 초기화 시점이랑 사용시점이 다르므로 lateinit으로 선언해줬다.

private lateinit var googleSignInLauncher: ActivityResultLauncher<Intent>

그리고 이 런처를 초기화해줘야하는데 fragment에서는 어디서 초기화 해줘야할까?

View가 생성된 뒤에 초기화하면 에러가 발생한다. 그래서 onCreate에서 View가 생성되기 전에 초기화를 해줘야한다.

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    googleSignInLauncher =
        registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
            googleSignIn(result.data)
        }
}

result의 data프로퍼티에 담긴 게 Intent다. 이걸 받아서 로그인 처리를 하면 된다.

이렇게 만든 launcher는 호출할 때 인자로 singInIntent를 받는다.

val gso = GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
            .requestIdToken(activity.getString(R.string.default_web_client_id))
            .requestEmail()
            .build()

val googleSignInClient = GoogleSignIn.getClient(activity, gso)
googleSignInClient.signInIntent // <- 이걸 사용한다

이 코드를 그대로 갖다쓰면 안되고 그냥 흐름만 보면 된다. 

requestIdToken에 사용되는 default_web_client_id는 파이어베이스 auth를 추가했다면 빌드할 때 자동으로 생기는데, google-services 4.4.1버전의 경우 파일이 멀쩡하게 있어도 없다고 나오는 IDE버그가 있다.(런타임 때의 문제는 없다.) 4.3.8로 버전을 내리니까 사라졌는데, 워낙 파이어베이스가 물려있는게 많다보니 버전 수정이 좀 두려웠다.

private fun googleSignIn(data: Intent?) {
    runCatching {
        val task = GoogleSignIn.getSignedInAccountFromIntent(data)
        task.getResult(ApiException::class.java)
    }.onSuccess { account ->
        CoroutineScope(Dispatchers.Main).launch {
            val user = loginRepoInstance.firebaseAuthWithGoogle(account.idToken!!)
            updateUI(user)
        }
    }.onFailure { e ->
        Log.w(TAG, "Google sign in failed $e")
    }
}

updateUI는 로그인에 성공했을 때 ui 업데이트를 해주는 부분이라서 이건 구현에 따라 달라지니 넘어가고, runCatching으로 try-catch를 대신해 가독성을 높여봤다. 
문제는 위에서 client받아올 때도 사용되었던 GoogleSignIn이 deprecated되어서 Credential Manager를 사용해야된다는 점이다. 그래야 아래 사진처럼 줄 그어진 모습을 치워버릴 수가 있다.

미관 상 해롭다

 

# CredentialManager 로 Migration하기

공식문서에 마이그레이션 가이드가 있는데 솔직히 업데이트도 느리고 좀 눈에 잘 안들어온다.

implementation("androidx.credentials:credentials:<latest version>")
implementation("androidx.credentials:credentials-play-services-auth:<latest version>")
implementation("com.google.android.libraries.identity.googleid:googleid:<latest version>")

credential버전은 1.3.0-alpha03, googleid는 1.1.0이 2024-05-11기준 최신버전이다.

 

Credential로 바꾸게 되면 달라지는 점이 몇가지 생긴다.

1. Activity/Fragment에서 처리하던 코드를 분리할 수 있다.
2. 로그인 요청하는 과정이 suspend fun을 사용하기 때문에 코루틴을 무조건 사용해야된다.
3. 로그인 UI가 예쁘게 바뀐다.

그냥 로그인 팝업이었던게 바텀시트로 바뀐다. 애니메이션도 더해져서 너무 보기 좋다.

로그인을 수행할려면 credential을 통해 idToken을 가져와야하는데 그 과정이 suspend fun으로 작성되어있다. 

suspend fun getCredential(
        context: Context,
        request: GetCredentialRequest,
    ): GetCredentialResponse = suspendCancellableCoroutine { continuation ->
    // Any Android API that supports cancellation should be configured to propagate
    // coroutine cancellation as follows:
    val canceller = CancellationSignal()
    continuation.invokeOnCancellation { canceller.cancel() }

    val callback = object : CredentialManagerCallback<GetCredentialResponse,
        GetCredentialException> {
        override fun onResult(result: GetCredentialResponse) {
            if (continuation.isActive) {
                continuation.resume(result)
            }
        }

        override fun onError(e: GetCredentialException) {
            if (continuation.isActive) {
                continuation.resumeWithException(e)
            }
        }
    }

    getCredentialAsync(
        context,
        request,
        canceller,
        // Use a direct executor to avoid extra dispatch. Resuming the continuation will
        // handle getting to the right thread or pool via the ContinuationInterceptor.
        Runnable::run,
        callback)
}

매개변수로는 context(Intent 날리려면 필요하니까), GetCredentialRequest 이렇게 두개가 필요하다. 

준비 과정이 있다. credential manager 인스턴스가 필요하고, 구글로그인에 사용할 google id option 인스턴스, 그리고 idToken을 얻을 때 필요한 get credential request 인스턴스 이렇게 세개를 초기화 해줘야한다.

val credentialManager = CredentialManager.create(context)
val googleIdOption = GetGoogleIdOption.Builder()
    .setFilterByAuthorizedAccounts(false)
    .setAutoSelectEnabled(true)
    .setServerClientId(context.getString(R.string.default_web_client_id))
    .build()

val credentialRequest: GetCredentialRequest = GetCredentialRequest.Builder()
    .addCredentialOption(googleIdOption)
    .build()

googleIdOption에서 setAutoSelectEnabled를 활성화하면, 바텀시트가 올라가면서 계정이 자동선택된다. 나는 파이어베이스 auth를 사용하니까 따로 web client id를 관리하지는 않았다.

setFilterByAuthorizedAccounts(false)는 이전에 로그인 한 계정을 확인할 지 정하는 옵션이다.

 

googleIdOption과 credentialRequest를 build하는 과정이 약간 지연시간이 있다고 느껴서 이건 Splash Activity에서 처리하면 좋을 것 같다는 생각이 들었다.

 

이제 구현을 보자. 내가 작성한 함수는 아래와 같다.

suspend fun requestGoogleLogin(
        context: Context,
        onSuccessListener: (FirebaseUser?) -> Unit,
    ) {
    runCatching {
        credentialManager.getCredential(
            request = credentialRequest,
            context = context,
        )
    }.onSuccess {
        when (val credential = it.credential) {
            is CustomCredential -> {
                if (credential.type == GoogleIdTokenCredential.TYPE_GOOGLE_ID_TOKEN_CREDENTIAL) {
                    runCatching {
                        GoogleIdTokenCredential.createFrom(credential.data)
                    }.onSuccess { googleIdTokenCredential ->
                        onSuccessListener(
                            firebaseAuthWithGoogle(googleIdTokenCredential.idToken)
                        )
                    }.onFailure {
                        Log.e(TAG, "Received an invalid google id token response", it)
                    }
                }
            }
        }
    }.onFailure {
        Log.d(TAG, "requestGoogleLogin: ${it.localizedMessage ?: "unknown error"}")
    }
}

ui업데이트 할 부분은 fragment에서 주입받도록 하고, 파이어베이스로 구글 로그인을 할것이므로 CustomCredential로 캐스팅 해준다. 이렇게 얻은 googleIdToken을 이전에 사용하던 firebaseAuthWithGoogle로 전달하면 끝난다.

 

다른 앱들에서 볼 수 있는 Google 계정으로 로그인으로 로그인하고싶다면 아래 코드를 getCredential의 request에 넣어주면 된다고 한다. 사실 이 부분은 차이점을 잘 모르겠다...

val signInWithGoogleOption: GetSignInWithGoogleOption = GetSignInWithGoogleOption.Builder()
  .setServerClientId(WEB_CLIENT_ID)
  .setNonce(<nonce string to use when generating a Google ID token>)
  .build()

---

Credential Manager로 마이그레이션한 결과를 보면오 히려 전보다 훨씬 간단해진 것 같다. client를 직접 관리할 수 없다 뿐이지 로그인 기능에 충실하고 편리하다고 생각한다. 

 

로그 아웃도 간단하다.

suspend fun logout() {
    credentialManager.clearCredentialState(request = ClearCredentialStateRequest())
    auth.signOut()
}

로그아웃에 사용되는 clearCredentialState역시 suspend fun으로 작성되어있다. 나는 firebase auth도 사용하기 때문에 로그아웃을 하려면 credential, firebase auth 둘 다 해줘야해서 이렇게 만들었다.

 

인자로는 ClearCredentialStateRequest 인스턴스를 그냥 넣어주면 된다. 들어가보면 아무 내용도 없는데, 그냥 flag용도로 사용하는 인스턴스던가, 공개된 라이브러리가 아닐까 추측해본다.

 

도움이 됐다면 댓글이나 공감 버튼 한 번씩 누르고 가주세요!