v5.0.0 미만 가이드
Android용 네이버 로그인 라이브러리는 서드파티 애플리케이션에서 네이버 로그인이 제공하는 로그인, 로그아웃, 토큰 관리 등의 기능을 쉽게 구현할 수 있게 합니다.
네이버 로그인 라이브러리를 사용하려면 다음과 같은 환경이 필요합니다.
- SDK : Android API 15 이상
- JDK : JDK 8 이상
- IDE: Android Studio
참고 네이버 로그인 라이브러리 3.x.x 버전은 OAuth 1.0a를 사용하고, 네이버 로그인 라이브러리 4.x.x 버전은 OAuth 2.0을 사용합니다. 네이버 로그인 라이브러리 3.x.x 버전을 사용하다 네이버 로그인 라이브러리 4.x.x 버전으로 업그레이드할 때는 "3.x.x 버전에서 4.x.x 버전으로 업그레이드 방법"을 참고해서 개발합니다.
Android용 네이버 로그인 라이브러리는 다음과 같이 이루어져 있으며 Github에서도 다운받을 수 있습니다. 프로젝트는 다음의 두 모듈로 구성되어 있습니다.
- naveridlogin_android_sdk: 네이버 로그인 라이브러리 aar파일이 있는 모듈
- naveridlogin_android_sample: 네이버 로그인 라이브러리를 사용하는 예제 프로젝트 모듈
gradle 스크립트에 아래와 같이 추가하시면 사용할 수 있습니다.
<!-- might use implementation in Android Studio 3.0(Gradle 4.1) -->
compile ('com.naver.nid:naveridlogin-android-sdk:4.2.6')네이버 로그인 SDK에서 사용하는 라이브러리는 다음과 같습니다. 필요에 따라 exclude 하여 사용하시면 됩니다.
compile 'com.android.support:appcompat-v7:28.0.0'
compile 'com.android.support:support-core-utils:28.0.0'
compile 'com.android.support:customtabs:28.0.0'
compile 'com.android.support:support-v4:28.0.0'Android 프로젝트의 libs 폴더 밑에 naveridlogin_android_sdk_4.2.6.aar 파일을 복사합니다.
프로젝트의 build.gradle에 다음과 같이 추가합니다.
dependencies {
<!-- might use implementation in Android Studio 3.0(Gradle 4.1) -->
compile files('libs/naveridlogin_android_sdk_4.2.6.aar')
compile 'com.android.support:appcompat-v7:28.0.0'
compile 'com.android.support:support-core-utils:28.0.0'
compile 'com.android.support:customtabs:28.0.0'
compile 'com.android.support:support-v4:28.0.0'
}- [file]-[project structure] 실행
- 좌측 상단의 + 버튼 클릭
- jar/aar 모듈 추가 선택
- 다운받은 naveridlogin_android_sdk_4.2.6.aar 선택
- 프로젝트 build.gradle에 다음과 같이 추가
dependencies {
<!-- might use implementation in Android Studio 3.0(Gradle 4.1) -->
compile project(path: ':naveridlogin_android_sdk_4.2.6')
compile 'com.android.support:appcompat-v7:28.0.0'
compile 'com.android.support:support-core-utils:28.0.0'
compile 'com.android.support:customtabs:28.0.0'
compile 'com.android.support:support-v4:28.0.0'
}네이버 로그인 라이브러리는 ProGuard로 코드 난독화를 적용하면 안 됩니다.
네이버 로그인 라이브러리를 사용하는 애플리케이션을 .apk 파일로 빌드할 때 ProGuard를 적용한다면,
다음과 같이 proguard-project.txt 파일을 수정해 ProGuard 적용 대상에서 네이버 로그인 라이브러리 파일을 제외합니다.
라이브러리 파일의 이름과 폴더는 버전이나 개발 환경에 따라 다를 수 있습니다.
-keep public class com.nhn.android.naverlogin.** {
public protected *;
}네이버 로그인 라이브러리를 애플리케이션에 적용하려면 다음과 같은 코드를 추가해 네이버 로그인 인스턴스를 초기화합니다.
mOAuthLoginModule = OAuthLogin.getInstance();
mOAuthLoginModule.init(
OAuthSampleActivity.this
,OAUTH_CLIENT_ID
,OAUTH_CLIENT_SECRET
,OAUTH_CLIENT_NAME
//,OAUTH_CALLBACK_INTENT
// SDK 4.1.4 버전부터는 OAUTH_CALLBACK_INTENT변수를 사용하지 않습니다.
);- OAUTH_CLIENT_ID: 애플리케이션 등록 후 발급받은 클라이언트 아이디
- OAUTH_CLIENT_SECRET: 애플리케이션 등록 후 발급받은 클라이언트 시크릿
- OAUTH_CLIENT_NAME: 네이버 앱의 로그인 화면에 표시할 애플리케이션 이름. 모바일 웹의 로그인 화면을 사용할 때는 서버에 저장된 애플리케이션 이름이 표시됩니다.
주의
4.1.3 이하 버전의 SDK를 적용한 경우 OAUTH_CALLBACK_INTENT변수를 추가하여 초기화 해야합니다.
참고
OAuthLogin.init() 메서드가 여러 번 실행돼도 기존에 저장된 접근 토큰(access token)과 갱신 토큰(refresh token)은 삭제되지 않습니다.
기존에 저장된 접근 토큰과 갱신 토큰을 삭제하려면 OAuthLogin.logout() 메서드나 OAuthLogin.logoutAndDeleteToken() 메서드를 호출합니다.
로그인은 두 가지 방법으로 구현합니다.
첫 번째는 OAuthLoginButton 객체로 네이버 로그인 버튼을 레이아웃에 추가하는 방법이고,
두 번째는 OAuthLogin.startOAuthLoginActivity() 메서드를 직접 실행하는 방법입니다.
OAuthLoginButton 객체로 네이버 로그인 버튼을 추가하는 방법은 다음과 같습니다.
레이아웃 파일에 다음과 같은 구문을 추가합니다.
<com.nhn.android.naverlogin.ui.view.OAuthLoginButton
android:id="@+id/buttonOAuthLoginImg"
android:layout_width="wrap_content"
android:layout_height="50dp" />액티비티에 로그인이 종료되었을 때 실행할 OAuthLoginHandler 클래스와 배경 타입을 등록하는 코드를 추가합니다.
mOAuthLoginButton = (OAuthLoginButton) findViewById(R.id.buttonOAuthLoginImg);
mOAuthLoginButton.setOAuthLoginHandler(mOAuthLoginHandler);
mOAuthLoginButton.setBgResourceId(R.drawable.img_loginbtn_usercustom);주의
OAuthLoginButton 객체를 이용할 때 네이버 로그인 버튼의 디자인은 반드시 네이버 로그인 버튼 사용 가이드를 따라야 합니다.
네이버 로그인 버튼 사용 가이드
OAuthLogin.startOAuthLoginActivity() 메서드를 직접 실행해 로그인하면 먼저 갱신 토큰이 있는지 확인합니다.
갱신 토큰이 있으면 접근 토큰의 갱신을 시도합니다. − 갱신에 성공하면 OAuthLoginHandler 객체가 호출됩니다. − 갱신에 실패하면 로그인 창이 나타납니다.
갱신 토큰이 없으면 로그인 창이 나타납니다.
접근 토큰 갱신 관련 주의
접근토큰은 일정 시간(현재 1시간)이 지나면 만료되기 때문에 만료시간이 지난 경우 refreshAccessToken() 을 호출해서 access token 을 갱신해줘야 합니다.
또한 refreshAccessToken() 을 사용하시는 경우 메쏘드의 실행이 끝나면 access token 을 받을 수 있기 때문에 좀 더 편리하게 개발하실 수 있습니다.
로그인 창에서 로그인이 완료되거나 취소될 때에도 OAuthLoginHandler가 호출됩니다.
다음은 OAuthLogin.startOAuthLoginActivity() 메서드를 이용한 로그인을 구현한 예제입니다.
/**
* OAuthLoginHandler를 startOAuthLoginActivity() 메서드 호출 시
* 파라미터로 전달하거나 OAuthLoginButton 객체에 등록하면 인증이 종료되는 것을 확인할 수 있습니다.
*/
private OAuthLoginHandler mOAuthLoginHandler = new OAuthLoginHandler() {
@Override
public void run(boolean success) {
if (success) {
String accessToken = mOAuthLoginModule.getAccessToken(mContext);
String refreshToken = mOAuthLoginModule.getRefreshToken(mContext);
long expiresAt = mOAuthLoginModule.getExpiresAt(mContext);
String tokenType = mOAuthLoginModule.getTokenType(mContext);
mOauthAT.setText(accessToken);
mOauthRT.setText(refreshToken);
mOauthExpires.setText(String.valueOf(expiresAt));
mOauthTokenType.setText(tokenType);
mOAuthState.setText(mOAuthLoginModule.getState(mContext).toString());
} else {
String errorCode = mOAuthLoginModule.getLastErrorCode(mContext).getCode();
String errorDesc = mOAuthLoginModule.getLastErrorDesc(mContext);
Toast.makeText(mContext, "errorCode:" + errorCode
+ ", errorDesc:" + errorDesc, Toast.LENGTH_SHORT).show();
}
};
};
mOAuthLoginModule.startOauthLoginActivity(mContext, mOAuthLoginHandler);약전계에서 로그인 호출 시
약전계에서 로그인 과정을 진행할 때는 로그인 방법에 따라 다음과 같이 오류를 반환받습니다.
- 웹뷰에서 로그인할 때는 웹뷰에 웹 페이지를 표시할 수 없다는 오류 화면이 나타납니다. 이때 사용자가 뒤로 가기 버튼을 누르거나 닫기 버튼을 눌러 애플리케이션으로 돌아오면 OAuthErrorCode.CLIENT_USER_CANCEL 오류를 반환받습니다.
- 네이버 앱으로 로그인 과정을 진행하거나 백그라운드에서 토큰을 갱신하고 있는 등 HttpClient 객체를 사용할 때는 타임아웃 시간(최대 10초)이 지나 호출이 실패하면 OAuthErrorCode.CLIENT_ERROR_CONNECTION_ERROR 오류를 반환받습니다.
로그인에 성공했을 때는 OAuthLogin.getAccessToken() 메서드로 접근 토큰 정보를 얻을 수 있습니다.
로그인에 실패했다면 OAuthLogin.getLastErrorCode() 메서드나 OAuthLogin.getLastErrorDesc() 메서드로 실패 이유와 에러 코드를 얻을 수 있습니다.
애플리케이션에서 로그아웃할 때는 다음과 같이 OAuthLogin.logout() 메서드를 호출합니다.
mOAuthLoginModule.logout(mContext);OAuthLogin.logout() 메서드가 호출되면 클라이언트에 저장된 토큰이 삭제되고
OAuthLogin.getState() 메서드가 OAuthLoginState.NEED_LOGIN 값을 반환합니다.
약전계에서 로그아웃 호출 시
저장된 토큰만 삭제하므로 약전계나 네트워크 오류에 영향을 받지 않습니다.
네이버 아이디와 애플리케이션의 연동을 해제하는 기능은 다음과 같이 OAuthLogin.logoutAndDeleteToken() 메서드로 구현합니다.
연동을 해제하면 클라이언트에 저장된 토큰과 서버에 저장된 토큰이 모두 삭제됩니다.
네트워크를 이용하므로 AsyncTask 등으로 스레드를 새로 생성해 호출합니다.
boolean isSuccessDeleteToken = mOAuthLoginInstance.logoutAndDeleteToken(mContext);
if (!isSuccessDeleteToken) {
// 서버에서 토큰 삭제에 실패했어도 클라이언트에 있는 토큰은 삭제되어 로그아웃된 상태입니다.
// 클라이언트에 토큰 정보가 없기 때문에 추가로 처리할 수 있는 작업은 없습니다.
Log.d(TAG, "errorCode:" + mOAuthLoginInstance.getLastErrorCode(mContext));
Log.d(TAG, "errorDesc:" + mOAuthLoginInstance.getLastErrorDesc(mContext));
}연동이 해제된 것은 PC에서 네이버의 내정보 > 보안설정 > 외부 사이트 연결 페이지에 접속해 외부사이트 → 네이버에서 연결 정보 삭제 여부로 확인할 수 있습니다.
약전계에서 연동 해제 시
OAuthLogin.logoutAndDeleteToken() 메서드로 연동을 해제할 때는 클라이언트에 저장된 토큰과 서버에 저장된 토큰을 모두 삭제합니다. 이때 네트워크 오류가 발생하면 서버 호출에 실패하기 때문에 서버에 저장된 토큰을 삭제하지 못할 수 있습니다. PC에서 네이버의 내정보 > 보안설정 > 외부 사이트 연결 페이지에 접속해 외부사이트 → 네이버에서 확인했을 때 연결 정보가 삭제되지 않은 채로 남아 있을 수 있습니다.
접근 토큰으로 오프API와 같이 제한된 리소스에 접근할 때는 OAuthLogin.requestApi() 메서드를 사용합니다.
mOAuthLoginModule.requestApi(mContext, accessToken, url);depedency 설정 변경 배포하는 아카이브 타입이 jar에서 aar로 변경됨에 따라 3의 개발환경 구축 가이드에 따라 변경해야 합니다.
Manifest 변경 aar로 배포함에 따라 Manifest 설정이 아카이브에 포함됩니다. 기존에 Manifest에 설정한 정보들은 모두 삭제합니다.
proguard 변경 기존에 proguard에 아래의 설정은 삭제합니다.
-libraryjars ../PORJECT_NAME/libs/naveroauthloginlib-4.x.x.jarAndroid의 logcat 로그에 네이버 로그인 로그를 확인할 수 있게 하려면 OAuthLogin 객체에서 showDevelopersLog 메소드를 통해 설정합니다.
네이버 로그인 라이브러리가 출력하는 logcat 로그의 접두어는 NaverLoginOAuth입니다.
mOAuthLoginInstance.showDevelopersLog(true);주의
로그 출력이 활성화되면 토큰 등의 민감한 정보가 로그에 표시되기 때문에 배포 버전에는 로그를 남기도록 않도록 false로 설정합니다.
다국어 지원 등으로 대화 상자에 나타나는 문구를 변경하려면 다음 예제와 같이 리소스 파일 (예: res/value/message.xml)을 덮어 쓸 수 있습니다.
<resources>
<string name="naveroauthlogin_string_getting_token">Receiving access token..</string>
</resources>설정 가능한 리소스 이름은 다음과 같습니다.
| 리소스 명 | 기본 설정 |
|---|---|
| use_application | 사용할 어플리케이션 |
| retry | 재시도 |
| naveroauthlogin_string_getting_token | 네이버 로그인 중입니다. |
| naveroauthlogin_string_network_state_not_available | 네트워크에 접속할 수 없습니다. 네트워크 연결상태를 확인해 주세요. |
| naveroauthlogin_string_group_id_not_available | 단체아이디는 네이버 로그인이 지원되지 않습니다. 개인아이디로 로그인 해 주세요. |
| naveroauthlogin_string_update_naverapp | 네이버 앱 업데이트 후 이용할 수 있는 서비스입니다. |
OAuth 인증 과정 중 발생할 수 있는 오류의 에러 코드를 가지고 있는 enum 타입의 클래스.
"The OAuth 2.0 Authorization Framework" 문서 의 '4.1.2.1. Error Response'에서 제시하는 오류 유형에 해당하는 에러 코드를 가지고 있습니다.
OAuthErrorCode 클래스에 있는 에러 코드는 다음과 같습니다.
'SERVER_ERROR_'로 시작하는 에러 코드는 서버에서 발생하는 오류의 에러 코드입니다.
'CLIENT_ERROR_'로 시작하는 에러 코드는 애플리케이션에서 발행하는 오류의 에러 코드입니다.
'ACTIVITY_IS_SINGLE_TASK'는 개발자 설정의 활동 보관 안 함 설정에 관련된 에러 코드입니다.
- NONE
- SERVER_ERROR_INVALID_REQUEST
- SERVER_ERROR_UNAUTHORIZED_CLIENT
- SERVER_ERROR_ACCESS_DENIED
- SERVER_ERROR_UNSUPPORTED_RESPONSE_TYPE
- SERVER_ERROR_INVALID_SCOPE
- SERVER_ERROR_SERVER_ERROR
- SERVER_ERROR_TEMPORARILY_UNAVAILABLE
- ERROR_NO_CATAGORIZED
- CLIENT_ERROR_PARSING_FAIL
- CLIENT_ERROR_NO_CLIENTID
- CLIENT_ERROR_NO_CLIENTSECRET
- CLIENT_ERROR_NO_CLIENTNAME
- CLIENT_ERROR_NO_CALLBACKURL
- CLIENT_ERROR_CONNECTION_ERROR
- CLIENT_ERROR_CERTIFICATION_ERROR
- CLIENT_USER_CANCEL
- ACTIVITY_IS_SINGLE_TASK
OAuthErrorCode 클래스의 메서드는 다음과 같습니다.
- getCode()
- getDesc()
설명 에러 코드를 반환합니다.
구문
public String getCode();파라미터 없음
반환값 에러 코드
코드 예 없음
설명 오류에 대한 설명을 반환합니다.
구문
public String getDesc()파라미터 없음
반환값 오류에 대한 설명
코드 예 없음
네이버 로그인의 모든 연산을 수행하는 클래스.
OAuthLogin 클래스의 메서드는 다음과 같습니다.
- getAccessToken()
- getExpiresAt()
- getInstance()
- getLastErrorCode()
- getLastErrorDesc()
- getRefreshToken()
- getState()
- getTokenType()
- getVersion()
- init()
- logout()
- logoutAndDeleteToken()
- refreshAccessToken()
- requestApi()
- startOAuthLoginActivity()
설명 로그인 결과로 얻은 접근 토큰(access token)을 반환합니다.
구문
public String getAccessToken(Context context);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| context | Context | Y | Shared preference에 접근하기 위한 Context 객체 |
반환값 접근 토큰
코드 예
String at = mOAuthLoginInstance.getAccessToken(mContext);
return mOAuthLoginInstance.requestApi(mContext, at, url);설명 접근 토큰(access token)의 만료 시간을 반환합니다.
구문
public long getExpiresAt(Context context);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| context | Context | Y | Shared preference에 접근하기 위한 Context 객체 |
반환값 타임스탬프(단위: 초)
코드 예
Log.d(TAG, "DEBUG expires at : " + OAuthLogin.getInstance().getExpiresAt(mContext));설명 네이버 로그인 인스턴스(싱글턴 인스턴스)를 얻습니다.
구문
public static OAuthLogin getInstance();파라미터 OAuthLogin 객체. 싱글턴 패턴을 이용해 OAuthLogin 객체를 새로 생성해 반환하거나 기존에 생성했던 객체를 반환합니다.
반환값 오류에 대한 설명
코드 예
mOAuthLoginInstance = OAuthLogin.getInstance();설명 마지막으로 실패한 로그인의 에러 코드를 반환합니다.
구문
public OAuthErrorCode getLastErrorCode(Context context);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| context | Context | Y | Shared preference에 접근하기 위한 Context 객체 |
반환값 OAuthErrorCode 타입의 에러 코드. OAuthErrorCode 클래스에 관한 자세한 내용은 "OAuthErrorCode"를 참고합니다.
코드 예
String errorCode = OAuthLogin.getInstance().getLastErrorCode(mContext).getCode();
String errorDesc = OAuthLogin.getInstance().getLastErrorDesc(mContext);
Toast.makeText(mContext, "errorCode:" + errorCode + ", errorDesc:" + errorDesc, Toast.LENGTH_SHORT).show();설명 마지막으로 실패한 로그인의 에러 메시지를 반환합니다.
구문
public String getLastErrorDesc(Context context);파라미터 context Shared preference에 접근하기 위한 Context 객체
반환값 에러 메시지
코드 예
String errorCode = OAuthLogin.getInstance().getLastErrorCode(mContext).getCode();
String errorDesc = OAuthLogin.getInstance().getLastErrorDesc(mContext);
Toast.makeText(mContext, "errorCode:" + errorCode + ", errorDesc:" + errorDesc, Toast.LENGTH_SHORT).show();설명 로그인 결과로 얻은 갱신 토큰(refresh token)을 반환합니다.
구문
public String getRefreshToken();파라미터 없음
반환값 갱신 토큰
코드 예
Log.d(TAG, "DEBUG refresh token : " + OAuthLogin.getInstance().getRefreshToken(mContext));설명 네이버 로그인 인스턴스의 현재 상태를 반환합니다.
구문
public OAuthLoginState getState(Context context)파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| context | Context | Y | Shared preference에 접근하기 위한 Context 객체 |
반환값 OAuthLoginState 타입의 에러 메시지
- OAuthLoginState.NEED_INIT
- OAuthLoginState.NEED_LOGIN
- OAuthLoginState.OK
코드 예
if (OAuthLoginState.OK.equals(OAuthLogin.getInstance().getState(this))) {
// access token 이 있는 상태로 로그인 버튼 안보여 줌
} else {
showNaverLoginButton();
}설명 로그인 결과로 얻은 토큰의 타입을 반환합니다.
구문
public String getTokenType(Context context);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| context | Context | Y | Shared preference에 접근하기 위한 Context 객체 |
반환값 토큰의 타입
코드 예
Log.d(TAG, "DEBUG token type : " + OAuthLogin.getInstance().getTokenType(mContext));설명 네이버 로그인 라이브러리의 버전을 반환합니다.
구문
public static String getVersion();파라미터 없음
반환값 '4.x.x' 형식으로 된 문자열
코드 예 없음
설명 네이버 로그인 인스턴스에 클라이언트 정보를 설정합니다.
구문
public void init(Context context, String clientId, String clientSecret, String clientName, String callbackIntent);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| context | Context | Y | sharedPreference 객체를 얻을 때 사용할 Context 객체 |
| clientId | String | Y | 애플리케이션 등록 후 발급받은 클라이언트 아이디 |
| lientSecret | String | Y | 애플리케이션 등록 후 발급받은 클라이언트 시크릿 |
| clientName | String | Y | 네이버 앱의 로그인 화면에 표시할 애플리케이션 이름. 모바일 웹의 로그인 화면을 사용할 때는 서버에 저장된 애플리케이션 이름이 표시됩니다. |
| allbackIntent | String | Y | Deprecated.(SDK 4.1.4 이상에서는 사용되지 않습니다.) 애플리케이션을 등록할 때 안드로이드 Intent에 설정한 값 |
반환값 없음
코드 예
mOAuthLoginInstance = OAuthLogin.getInstance();설명 클라이언트에 저장된 접근 토큰(access token)과 갱신 토큰(refresh token)을 삭제합니다.
구문
public void logout(Context context);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| context | Context | Y | Shared preference에 접근하기 위한 Context 객체 |
반환값 없음
코드 예
case R.id.buttonOAuthLogout: {
OAuthLogin.getInstance().logout(mContext);
updateView();
break;
}설명 클라이언트와 서버에 저장된 접근 토큰(access token)과 갱신 토큰(refresh token)을 삭제해 애플리케이션과 네이버 아이디의 연동을 해제합니다.
구문
public boolean logoutAndDeleteToken();파라미터 없음
반환값 연동 해제 성공 여부
- true: 연동 해제 성공
- false: 서버에 저장된 토큰을 삭제하지 못하고 클라이언트의 토큰만 삭제되어 연동 해제에 실패
코드 예
private class DeleteTokenTask extends AsyncTask<Void, Void, Void> {
@Override
protected Void doInBackground(Void... params) {
boolean isSuccessDeleteToken = mOAuthLoginInstance.logoutAndDeleteToken(mContext);
if (!isSuccessDeleteToken) {
// 서버에서 토큰 삭제에 실패했어도 클라이언트에 있는 토큰은 삭제되어 로그아웃된 상태입니다.
// 클라이언트에 토큰 정보가 없기 때문에 추가로 처리할 수 있는 작업은 없습니다.
Log.d(TAG, "errorCode:" + mOAuthLoginInstance.getLastErrorCode(mContext));
Log.d(TAG, "errorDesc:" + mOAuthLoginInstance.getLastErrorDesc(mContext));
}
return null;
}
protected void onPostExecute(Void v) {
updateView();
}
}설명 클라이언트에 저장된 갱신 토큰(refresh token)을 이용해 접근 토큰(access token)을 갱신하고 갱신된 접근 토큰을 반환합니다.
구문
public OAuthLogin refreshAccessToken(Context context);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| context | Context | Y | Shared preference에 접근하기 위한 Context 객체 |
반환값
- 성공: 접근 토큰
- 실패: null
코드 예
private class RefreshTokenTask extends AsyncTask<Void, Void, String> {
@Override
protected String doInBackground(Void... params) {
return OAuthLogin.getInstance().refreshAccessToken(mContext);
}
protected void onPostExecute(String res) {
updateView();
}
}설명 GET 메서드로 API를 호출합니다. 성공하면 결과(content body)를 반환합니다.
구문
public String requestApi(Context context, String accessToken, String url);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| context | Context | Y | Shared preference에 접근하기 위한 Context 객체 |
반환값 API 호출 결과
- API 호출 성공: API 호출 결과(content body)
- API 호출 실패: null
코드 예
private class RequestApiTask extends AsyncTask<Void, Void, String>{
@Override
protected void onPreExecute() {
mApiResultText.setText((String) "");
}
@Override
protected String doInBackground(Void... params) {
String url = "https://apis.naver.com/nidlogin/nid/getHashId_v2.xml";
String at = mOAuthLoginInstance.getAccessToken(mContext);
return mOAuthLoginInstance.requestApi(mContext, at, url);
}
protected void onPostExecute(String content) {
mApiResultText.setText((String) content);
}
}설명 로그인에 성공하면 접근 토큰(access token)과 갱신 토큰(refresh token)을 받아 옵니다.
구문
public void startOauthLoginActivity(Activity activity, OAuthLoginCallback oauthLoginCallback);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| activity | Activity | Y | 메서드를 실행하는 액티비티의 Context 객체 |
| oauthLoginCallback | OAuthLoginCallback | Y | 로그인 결과를 받을 콜백 메서드 |
반환값 없음
참고 접근 토큰이 유효하지 않아 API 호출이 실패했을 때(인증 실패) startOAuthLoginActivity() 메서드로 접근 토큰을 새로 받아 API를 다시 호출합니다.
단, API 인증에 실패했을 때에만 startOAuthLoginActivity() 메서드를 호출해야 합니다.
서버 오류 등으로 실패했을 때에 startOAuthLoginActivity() 메서드를 호출하면 재시도를 무한으로 반복할 수 있습니다.
재시도 횟수를 제한하는 로직을 추가하면 서비스를 더 안정적으로 제공할 수 있습니다.
코드 예
OAuthLogin.getInstance().startOauthLoginActivity(OAuthSampleActivity.this, mOAuthLoginHandler);네이버 로그인 버튼 클래스. OAuthLoginButton 클래스의 메서드는 다음과 같습니다.
- setBgResourceId()
- setOAuthLoginHandler()
설명 버튼의 배경 이미지를 지정합니다. 지정하지 않으면 기본 이미지를 사용합니다.
구문
public void setBgResourceId(int resId);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| activity | Activity | Y | 메서드를 실행하는 액티비티의 Context 객체 |
| resId | int | Y | 기본 배경 이미지 대신 사용할 이미지 리소스의 아이디 |
반환값 없음
코드 예
mOAuthLoginButton.setBgResourceId(R.drawable.img_naver_login_button);설명 네이버 로그인 버튼을 클릭해 로그인하는 경우 로그인 결과를 받을 핸들러를 지정합니다.
구문
public void setOAuthLoginHandler(OAuthLoginHandler oauthLoginHandler);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| oauthLoginHandler | OAuthLoginHandler | Y | 버튼을 눌러서 로그인 요청이 완료되면 수행할 핸들러. 핸들러에 관한 자세한 내용은 "OAuthLoginHandler"를 참고합니다. |
반환값 없음
코드 예
mOAuthLoginButton = (OAuthLoginButton) findViewById(R.id.buttonOAuthLoginImg);
mOAuthLoginButton.setOAuthLoginHandler(mOAuthLoginHandler);OAuth 인증 요청이 종료됐음을 알려 주는 콜백 클래스. OAuthLoginHandler 클래스의 메서드는 다음과 같습니다.
- run()
설명 OAuthLoginHandler 클래스의 인스턴스를 만들어 run() 메서드를 구현한 뒤 생성된 인스턴스를 다음 두 개 메서드의 파라미터로 전달하면 인스턴스의 run() 메서드로 요청이 종료됐음을 확인할 수 있습니다.
- OAuthLogin.startOAuthLoginActivity() 메서드 호출 시 파라미터로 넘겨줌
- OAuthLoginButton.setOAuthLoginHandler() 메서드 호출 시 파라미터로 넘겨줌
위 메서드를 호출해 얻은 데이터는 OAuthLoginHandler로 직접 전달되지 않기 때문에 OAuthLogin.getAccessToken() 메서드나 OAuthLogin.getRefreshToken() 메서드, OAuthLogin.getLastErrorCode() 메서드 등으로 확인합니다.
구문
public abstract void run(boolean success);파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| success | boolean | Y | 인증 성공 여부. |
- true: OAuth 2.0 인증이 성공해 접근 토큰(access token)과 갱신 토큰(refresh token)을 정상적으로 발급받았을 때 라이브러리로부터 반환받는 값입니다.
- false: OAuth 2.0 인증이 실패하거나 다른 이유로 접근 토큰이나 갱신 토큰을 정상적으로 발급받지 못했을 때 라이브러리로부터 반환받는 값입니다.
반환값 없음
코드 예
mOAuthLoginHandler = new OAuthLoginHandler() {
@Override
public void run(boolean success) {
if (success) {
// 네이버 로그인 인증이 성공했을 때 수행할 코드 추가
} else {
String errorCode = OAuthLogin.getInstance()
.getLastErrorCode(mContext).getCode();
String errorDesc = OAuthLogin.getInstance().getLastErrorDesc(mContext);
Toast.makeText(mContext, "errorCode:" + errorCode
+ ", errorDesc:" + errorDesc, Toast.LENGTH_SHORT).show();
}
};
};
mOAuthLoginInstance.startOauthLoginActivity(OAuthSampleActivity.this, mOAuthLoginHandler);네이버 로그인 인스턴스의 현재 로그인 상태를 반환하는 클래스. 네이버 로그인 인스턴스의 상태는 다음과 같습니다.
- NEED_INIT: 초기화가 필요한 상태
- NEED_LOGIN: 로그인이 필요한 상태. 접근 토큰(access token)과 갱신 토큰(refresh token)이 모두 없습니다.
- NEED_REFRESH_TOKEN: 토큰 갱신이 필요한 상태. 접근 토큰은 없고, 갱신 토큰은 있습니다.
- OK: 접근 토큰이 있는 상태. 단, 사용자가 네이버의 내정보 > 보안설정 > 외부 사이트 연결 페이지에서 연동을 해제했다면 서버에서는 상태 값이 유효하지 않을 수 있습니다.