[Android][Kakao SDK]안드로이드 카카오 로그인 SDK Legacy v1 -> v2 업데이트

신규로 카카오 로그인 연동하는 블로그들은 꽤나 봤는데, v1.x.x 에서 v2.x.x로 업데이트하는 글들은 제가 못 찾아서 정리하게 되었습니다.

신규로 카카오 계정 로그인 서비스를 넣는 것이 아니라 생략된 과정들(키 해시 등록 등)이 있습니다.😎

6년 전에 만들어져 지금까지 유지보수되고 있는 앱이라 작업을 진행하는 데 자바를 쓰게 되었습니다.👩‍🔧👨‍🔧

Gradle 설정하기

프로젝트의 build.gradle

기존 레거시 코드

allprojects {
    repositories {
        ....
        maven { url 'http://devrepo.kakao.com:8088/nexus/content/groups/public/' }
        ....
    }
}

수정 코드

allprojects {
    repositories {
        ....
        maven { url 'https://devrepo.kakao.com/nexus/content/groups/public/' }
        ....
    }
}

🙄❔ settings.gradle 에 레파지토리를 설정한다?

https://developer.android.com/studio/build#build-files

빌드 구성 | Android 개발자 | Android Developers

Android 빌드 시스템은 앱 리소스 및 소스 코드를 컴파일하고 개발자가 테스트, 구축, 서명 및 배포할 수 있는 APK로 패키징합니다.

developer.android.com

https://developer.android.com/studio/preview/features#settings-gradle

Android 스튜디오 미리보기의 새로운 기능 | Android 개발자 | Android Developers

Android 스튜디오 미리보기의 새로운 기능을 확인하세요.

developer.android.com

오... 바뀐 거 이제 알았다.

작업하는 앱은 옛날 옛적 6년 전에 생성된 오랜 히스토리가 있는 앱이니 이런 변경사항을 적용할 일이 없었다. top level의 build.gradle을 수정했고, 테스트하니 잘 돌아간다.

로그인 모듈 설정하기

app의 build.gradle

기존 레거시 코드

기존 레거시 SDK 버전을 보면 부끄럽다... 너무 업데이트 안하고 살았다.

dependencies {
    ....
    implementation 'com.kakao.sdk:usermgmt:1.27.0'
    ....
}

수정 코드

dependencies {
    ....
    implementation 'com.kakao.sdk:v2-user:2.8.4'
    ....
}

프로가드 설정하기

기존 레거시 코드

없음. (아니면 내가 모르는 것일 수도 있다...)

추가 코드

#카카오 로그인
-keep class com.kakao.sdk.**.model.* { <fields>; }
-keep class * extends com.google.gson.TypeAdapter

😓앱에서 카카오 벡터맵 라이브러리도 사용 중이고, 이와 관련해서 프로가드에 코드가 설정되어 있었다. 해당 프로가드 코드들의 주석이 "#kakao" 라고만 적혀있어서, 카카오 맵은 생각지도 못하고 기존 레거시 로그인 sdk 와 관련된 줄 알고 다 지웠다가 나중에 테스트하며 한참을 헤맸다. 이번 삽질의 교훈은 "프로가드 설정을 위한 릴리즈 테스트는 잘했다. 주석을 더 상세히 써도 되겠다."

Application 수정

기존 레거시 코드

public class App extends Application {

    @Override
    public void onCreate() {
        ....
        KakaoSDk.init(new KakaoSDKAdapter());
        ....
    }
    
    ....
    
    private class KakaoSDKAdapter extends KakaoAdapter {
    
        @Override
        public ISessionConfig getSessionConfig() {
            return new ISessionConfig() {
                @Override
                public AuthType[] getAuthTypes() {
                    return AuthType[]{AuthType.KAKAO_LOGIN_ALL};
                }
                
                @Override
                public boolean isSecureMode() {
                    return false;
                }
                
                @Override
                public boolean isUsingWebviewTimer() {
                    return false;
                }
                
                @Override
                public ApprovalType getApprovalType() {
                    return ApprovalType.INDIVIDUAL;
                }
                
                @Override
                public boolean isSaveFormData() {
                    return true;
                }
            }
        }
        
        @Override
        public IApplicationConfig getApplicationConfig() {
            return () -> {
                return App.this;
            };
        }
    
    }
    
    ....

}

수정 코드

public class App extends Application {

    @Override
    public void onCreate() {
        ....
        //KakaoSDK 초기화 코드 삭제
        
        KakaoSdk.init(this, getString(R.string.kakao_app_key));
        ....
    }
    
    ....
    //카카오 sdk 어뎁터 삭제
    ....
    
}

string value 수정

기존 레거시 코드

<resources>
    ....
    <string name="kakao_app_key" translatable="false">{키}</string>
    ....
</resources>

수정 코드

<resources>
   ....
   <string name="kakao_app_key" translatable="false">{키}</string> <!--기존-->
   <string name="redirect_kakao_app_key" translatable="false">kakao{키}</string> <!--추가-->
   ....
</resources>

AndroidManifest 수정

기존 레거시 코드

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="llll">

    ....
    <application
        android:name=".App"
        ....>

        ....
        <meta-data
            android:name="com.kakao.sdk.AppKey"
            android:value="@string/kakao_app_key" />
        ....

    </application>

    ....
   
</manifest>

수정 코드

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    pacakge="llll">
    
    ...
   <application
        android:name=".App"
        ...>
        
    <!-- 카카오 sdk meta-data 삭제 -->  
        
    </application>
    
    
    <!-- 액티비티 추가 -->
    <activity
        android:name="com.kakao.sdk.auth.AuthCodeHandlerActivity"
        android:exported="true">
        <intent-filter>
            <action android:name="android.intent.action.VIEW" />
            <category android:name="android.intent.category.DEFAULT" />
            <category android:name="android.intent.category.BROWSABLE" />

            <!-- Redirect URI: "kakao{NATIVE_APP_KEY}://oauth" -->
            <data android:host="oauth"
                android:scheme="@string/redirect_kakao_app_key" />
        </intent-filter>
    </activity>

    ...
    
</manifest>

로그인 화면 layout xml 수정

기존 레거시 코드

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">
    
    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content">
        
        ....
        <!--사용자가 클릭하는 버튼-->
        <androidx.appcompat.widget.AppCompatImageButton
            android:id="@+id/btKakao"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="14dp"
            android:layout_marginRight="24dp"
            android:layout_marginBottom="40dp"
            android:background="@drawable/login_btn_kakao"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintHorizontal_chainStyle="packed"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toLeftOf="@id/btnOther"
            app:layout_constraintTop_toBottomOf="@id/description" />
        
        ....
        
        <!--카카오 로그인 sdk 제공 버튼-->
        <com.kakao.usermgmt.LoginButton
            android:id="@+id/btKakaoLogin"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:visibility="gone"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintLeft_toRightOf="@id/btnAnother" />

        ....
        
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

수정 코드

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">
    
    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content">
        
        ....
        <!--사용자가 클릭하는 버튼-->
        <androidx.appcompat.widget.AppCompatImageButton
            android:id="@+id/btKakao"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="14dp"
            android:layout_marginRight="24dp"
            android:layout_marginBottom="40dp"
            android:background="@drawable/login_btn_kakao"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintHorizontal_chainStyle="packed"
            app:layout_constraintLeft_toLeftOf="parent"
            app:layout_constraintRight_toLeftOf="@id/btnOther"
            app:layout_constraintTop_toBottomOf="@id/description" />
        
        ....
        
        <!--카카오 로그인 sdk 제공 버튼 삭제-->
        
        ....
        
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

사용자가 로그인 버튼을 눌러 진행하는 로그인 코드 수정

기존 레거시 코드

~~솔직히 말해서 보기 좋고 잘 쓴 코드라고 생각하지 않는다.~~

SessionCallback으로 세션 open이 성공하면 UserManagement로 사용자 정보를 가져와 MeV2ResponseCallback을 호출해서 진행하고 있었다.

public class LoginFragment extends BaseFragment {

    ....
    private SessionCallback callback;    //KAKAO SESSION
    ....
    
    @Override
    public void onActivityCreated(@Nullable Bundle savedInstanceState) {
        ....
        
        initView();
        
        setSessionLogin();
        ....
    }
    
    private void initView() {
        ....
        
        binding.btnKakao.setOnClickListener(v ->{
            ....
            
            Session.getCurrentSession().addCallback(callback);
            binding.btnKakaoLogin.callOnClick();
        });
        
        ....
    }
    
    private void setSessionLogin() {
        ....
        callback = new SessionCallback();
        Session.getCurrentSession().addCallback(callback);
        ....    
        
        String loginType = Preference.INSTANCE.getAccountType();
        if(AccountType.KAKAO.name().equalsIgnoreCase(loginType)) {
            if(Session.getCurrentSession().checkAndImpliciteOpen()) {
               // 로딩바 노출 코드
               ....
            }
        } else if(...) {
            ....
        }
        ....
    }
    
    ....
    
    private class SessionCallback implements ISessionCallback {
    
        @Override
        public void onSessionOpen() {
            //로딩바 노출 코드
            ....
            requestMe(Session.getCurrentSession().getTokenInfo().getAccessToken());
        }
        
        @Override
        public void onSessionOpenFailed(KakaoExeption exception) {
            String loginType = Preference.INSTANCE.getAccountType();
            
            if(AccountType.KAKAO.name().equalsIgnoreCase(loginType)) {
                Session.getCurrentSession().removeCallback(callback);
                Session.getCurrentSession().close();
                Preference.INSTANCE.clearAccountType()
                //로딩바 제거
                //사용자 알림 토스트
                ....
            }
        }

    }
    
    private void requestMe(String accessToken) {
        UserManagement.getInstance().me(new MeV2ResponseCallback() {
            @Override
            public void onFailure(ErrorResult errorResult) {
                super.onFailure(errorResult)
                Session.getCurrentSession().removeCallback(callback);
                Session.getCurrentSession().close();
                Preference.INSTANCE.clearAccountType()
                //로딩바 제거
                //사용자 알림 토스트
                ....
            }
            
            @Override
            public void onSessionClosed(ErrorResult errorResult) {
            
            if (Session.getCurrentSession() != null) {
                    Session.getCurrentSession().removeCallback(callback);
                    Session.getCurrentSession().close();
                }
            }
            
            @Override
            public void onSuccess(MeV2Response result) {
            
                //필요한 사용자 정보 받기
                String accountId = String.valueOf(result.getId());
                ....
            
            	///서버로 sns 로그인 요청
                singInBySns(...);
            }
        });
    }

}

수정 코드

세션 콜백 부분이 사라졌고, 단말에 카톡 설치 여부를 확인해 로그인 방법이 갈리도록 수정되었다.

카톡 로그인 혹은 카카오 계정 로그인 진행에 따른 콜백 함수는 Function2를 통해 구현했다. 카카오 sdk api들은 코틀린으로 작성되었지만 앱의 코드는 자바이기에 이것이 나의 최선이었다.

public class LoginFragment extends BaseFragment {

    ....
    //Session Callback 삭제
    ....
    
    @Override
    public void onActivityCreated(@Nullable Bundle savedInstanceState) {
        ....
        
        initView();
        
        setSessionLogin();
        ....
    }
    
    private void initView() {
        ....
        
        binding.btnKakao.setOnClickListener(v ->{
            ....
            //세션 콜백 관련 코드 제거
            //카카오 sdk 제공 버튼 클릭 제거

            Function2<OAuthToken, Throwable, Unit> callback = (Function2<OAuthToken, Throwable, Unit>) (token, error) -> {
                if (error != null) {
                    //로그인 실패
                    final String loginType = Prefrence.getACCOUNT_TYPE();
                    if (AccountType.KAKAO.name().equalsIgnoreCase(loginType)) {
                        Pref.Account.INSTANCE.clearAccountType();
                        //로딩바 제거
                        //사용자 알림 토스트
                        ....

                    }
                } else if (token != null) {
                    //로그인 성공
                    //로딩바 노출
                    ....
                    String accessToken = token.getAccessToken();
                   
                    requestMe(accessToken);
                }
                return null;
            };

            // 카카오톡이 설치되어 있으면 카카오톡으로 로그인, 아니면 카카오계정으로 로그인
            if (UserApiClient.getInstance().isKakaoTalkLoginAvailable(requireContext())) {
                UserApiClient.getInstance().loginWithKakaoTalk(requireContext(), callback);
            } else {
                UserApiClient.getInstance().loginWithKakaoAccount(requireContext(), callback);
            }
        });
        
        ....
    }
 
    ....
    
    private void requestMe(String accessToken) {
        //UserManagement 관련 코드 삭제
        UserApiClient.getInstance().me((Function2<User, Throwable, Unit>) (user, error) -> {
            if (error != null) {
                //사용자 정보 요청 실패
                //로딩바 삭제
                //사용자 알림 토스트 노출
                ....
            } else if (user != null) {
                //사용자 정보 요청 성공
                //필요한 사용자 정보 받아오기
                accountId = String.valueOf(user.getId());
                com.kakao.sdk.user.model.Account account = user.getKakaoAccount();
                if (account != null) {
                    com.kakao.sdk.user.model.Profile profile = account.getProfile();
                    if (profile != null) {
                        profileURL = profile.getProfileImageUrl();
                        ...
                    }
                    ...
                }

                //서버로 sns 로그인 요청
                signInBySNS(....);
            }
            return null;
        });
    }

}

세션이 남아 있는 경우 앱 진입시 자동 로그인 코드 수정

이 부분에 대해서 설명하거나 예제가 있는 블로그들을 찾지 못했다. 이렇게 진행하는 것이 맞나 긴가민가 하면서 작업했다. 테스트해보니 정상동작한다.

기존 레거시 코드

~~솔직히 말해서 보기 좋고 잘 쓴 코드라고 생각하지 않는다.~~

사용자가 버튼을 클릭해서 로그인을 시도하는 것과, 남은 세션이 유효해서 바로 로그인을 시도하는 것 모두 session callback으로 진행되고 있었다.

SessionCallback으로 세션 open이 성공하면 UserManagement로 사용자 정보를 가져와 MeV2ResponseCallback을 호출해서 진행하고 있었다.

public class LoginFragment extends BaseFragment {

    ....
    private SessionCallback callback;    //KAKAO SESSION
    ....
    
    @Override
    public void onActivityCreated(@Nullable Bundle savedInstanceState) {
        ....
        
        setSessionLogin();
        ....
    }
    
    private void setSessionLogin() {
        ....
        callback = new SessionCallback();
        Session.getCurrentSession().addCallback(callback);
        ....    
        
        String loginType = Preference.INSTANCE.getAccountType();
        if(AccountType.KAKAO.name().equalsIgnoreCase(loginType)) {
            if(Session.getCurrentSession().checkAndImpliciteOpen()) {
               // 로딩바 노출 코드
               ....
            }
        } else if(...) {
            ....
        }
        ....
    }
    
    ....
    
    private class SessionCallback implements ISessionCallback {
    
        @Override
        public void onSessionOpen() {
            //로딩바 노출 코드
            ....
            requestMe(Session.getCurrentSession().getTokenInfo().getAccessToken());
        }
        
        @Override
        public void onSessionOpenFailed(KakaoExeption exception) {
            String loginType = Preference.INSTANCE.getAccountType();
            
            if(AccountType.KAKAO.name().equalsIgnoreCase(loginType)) {
                Session.getCurrentSession().removeCallback(callback);
                Session.getCurrentSession().close();
                Preference.INSTANCE.clearAccountType()
                //로딩바 제거
                //사용자 알림 토스트
                ....
            }
        }

    }
    
    private void requestMe(String accessToken) {
        UserManagement.getInstance().me(new MeV2ResponseCallback() {
            @Override
            public void onFailure(ErrorResult errorResult) {
                super.onFailure(errorResult)
                Session.getCurrentSession().removeCallback(callback);
                Session.getCurrentSession().close();
                Preference.INSTANCE.clearAccountType()
                //로딩바 제거
                //사용자 알림 토스트
                ....
            }
            
            @Override
            public void onSessionClosed(ErrorResult errorResult) {
            
            if (Session.getCurrentSession() != null) {
                    Session.getCurrentSession().removeCallback(callback);
                    Session.getCurrentSession().close();
                }
            }
            
            @Override
            public void onSuccess(MeV2Response result) {
            
                //필요한 사용자 정보 받기
                String accountId = String.valueOf(result.getId());
                ....
            
            	///서버로 sns 로그인 요청
                singInBySns(...);
            }
        });
    }

}

수정 코드

SessionCallback 클래스는 삭제되었고, requestMe()는 버튼 클릭으로 로그인할 때와 앱 진입 후 세션 로그인할 때 둘 다 공통으로 사용된다.

requestMe(String accessToken)의 파라미터로 토큰값이 필요한데, accessTokenInfo 콜백 함수의 token이 이름만 토큰이라고 잠깐 생각했을 정도로 엑세스 토큰 값을 빼고 다른 정보들을 가지고 있다. 그래서 TokenManager로 직접 토큰값을 가져다가 requestMe()를 호출했다.

public class LoginFragment extends BaseFragment {

    ....
    //Session Callback 삭제
    ....
    
    @Override
    public void onActivityCreated(@Nullable Bundle savedInstanceState) {
        ....
        
        setSessionLogin();
        ....
    }
    
    ....
    
    private void setSessionLogin() {
        ....
        //세션 콜백 관련 코드 삭제
        ....    
        
        String loginType = Preference.INSTANCE.getAccountType();
        if(AccountType.KAKAO.name().equalsIgnoreCase(loginType)) {
            //토큰 존재 여부 확인
            if(AuthApiClient.getInstance().hasToken()) {
                UserApiClient.getInstance().accessTokenInfo((token, error) -> {
                    if(error == null) {
                        //토큰 유효성 체크 성공
                        // 필요시 토큰 갱신 됨
                        // 로딩바 노출 코드
                        ....
                        
                        OAuthToken token = TokenManager.getInstance().getToken();
                        if(token != null) {
                            requestMe(token.getAccessToken());
                        }
                    }
                    return null;
                });
            }
        } else if(...) {
            ....
        }
        ....
    }
    
    ....
    //세션 콜백 클래스 삭제
    ....
    
    private void requestMe(String accessToken) {
        //UserManagement 관련 코드 삭제
        UserApiClient.getInstance().me((Function2<User, Throwable, Unit>) (user, error) -> {
            if (error != null) {
                //사용자 정보 요청 실패
                //로딩바 삭제
                //사용자 알림 토스트 노출
                ....
            } else if (user != null) {
                //사용자 정보 요청 성공
                //필요한 사용자 정보 받아오기
                accountId = String.valueOf(user.getId());
                com.kakao.sdk.user.model.Account account = user.getKakaoAccount();
                if (account != null) {
                    com.kakao.sdk.user.model.Profile profile = account.getProfile();
                    if (profile != null) {
                        profileURL = profile.getProfileImageUrl();
                        ...
                    }
                    ...
                }

                //서버로 sns 로그인 요청
                signInBySNS(....);
            }
            return null;
        });
    }

}

로그아웃 코드 수정

기존 레거시 코드

전임 개발자는 세션을 close 해서 로그아웃을 시켰다.

publid void logout() {
    if (Session.getCurrentSession() != null) {
        Session.getCurrentSession().close()
    }
}

수정 코드

세션을 확인한 전임 개발자의 코드에 의도가 있다고 생각했다. (이직하신 분이라 그 의도를 물어볼 수는 없고, 의도와 비슷하게 구현하는 쪽이 어떤 것일까 고민하다가) 현재 토큰이 유효한지 체크 후 로그아웃을 진행하도록 코드를 삽입했다. 테스트하니 잘 돌아간다.

publid void logout() {
    if (AuthApiClient.getInstance().hasToken()) {
        UserApiClient.getInstance().logout(throwable -> null);
    }
}

완료!!

'빈 구멍 채우기' 카테고리의 다른 글

[Google Play Console] 이의제기 하기 (0)	2022.04.21
[Android][Coroutine][SharedPreferences] 타이머 구현 (0)	2022.04.21
[Android] 프로젝트에 개발자가 작성하지 않은 리소스가 노출된다?!(프로젝트와 라이브러리의 resource conflict. 리소스 이름이 같을 경우) (0)	2021.12.23
[UI/UX] UI 디자인을 위한 휴리스틱 사용성 10가지 / 10 Usability Heuristics for User Interface Design (0)	2021.12.16
[Android] target sdk version을 변경하면 해당 version의 단말에서 테스트해 보아야 합니다. (0)	2021.12.16

⭐🙋‍♀️ 삽질 기록 저장소

[Android][Kakao SDK]안드로이드 카카오 로그인 SDK Legacy v1 -> v2 업데이트

Gradle 설정하기

프로젝트의 build.gradle

로그인 모듈 설정하기

app의 build.gradle

프로가드 설정하기

Application 수정

string value 수정

AndroidManifest 수정

로그인 화면 layout xml 수정

사용자가 로그인 버튼을 눌러 진행하는 로그인 코드 수정

세션이 남아 있는 경우 앱 진입시 자동 로그인 코드 수정

로그아웃 코드 수정

'빈 구멍 채우기' 카테고리의 다른 글

티스토리툴바

[Android][Kakao SDK]안드로이드 카카오 로그인 SDK Legacy v1 -> v2 업데이트

Gradle 설정하기

프로젝트의 build.gradle

로그인 모듈 설정하기

app의 build.gradle

프로가드 설정하기

Application 수정

string value 수정

AndroidManifest 수정

로그인 화면 layout xml 수정

사용자가 로그인 버튼을 눌러 진행하는 로그인 코드 수정

세션이 남아 있는 경우 앱 진입시 자동 로그인 코드 수정

로그아웃 코드 수정

'빈 구멍 채우기' 카테고리의 다른 글

'빈 구멍 채우기' Related Articles

티스토리툴바