适用于基于Android操作系统的移动端、智慧屏应用,且希望基于OAuth 2.0协议标准接入华为帐号的场景。
Authorization Code模式基于OAuth 2.0协议标准,应用可以通过获取帐号用户的临时授权票据(Authorization Code),使用户通过帐号安全登录您的应用,首次登录时,要求用户同意授权,当身份验证信息到期时,只需要从服务器端通过刷新令牌刷新访问令牌,从而更快,更可靠,更方便。Authorization Code模式仅适用于有自己服务器的应用。
完整的Authorization Code授权登录流程为:
华为帐号提供了一个按钮控件HuaweiIdAuthButton,此控件展示华为风格的登录按钮,可以让您方便快速地实现符合华为图标使用规范的登录按钮。
使用方法:在res > layout目录下的xml布局文件中添加如下声明,并通过不同参数调整风格,详细信息请参见HuaweiIdAuthButton控件使用指导。
<!--id开发者可自定义--> <com.huawei.hms.support.hwid.ui.HuaweiIdAuthButton android:id="@+id/HuaweiIdAuthButton" android:layout_width="wrap_content" android:layout_height="wrap_content"/>
将silentSignInByHwId绑定到登录按钮R.id.HuaweiIdAuthButton的onClick响应事件中,实现华为帐号登录功能。当用户点击登录按钮时,会启动登录视图。
“Java”
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// activity_main为自定义布局文件名称
setContentView(R.layout.activity_main);
findViewById(R.id.HuaweiIdAuthButton).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
silentSignInByHwId();
}
});
} “Kotlin”
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// activity_main为自定义布局文件名称
setContentView(R.layout.activity_main)
findViewById<View>(R.id.HuaweiIdAuthButton).setOnClickListener { silentSignInByHwId() }
} 在silentSignInByHwId方法中,构造了请求参数AccountAuthParams和华为帐号登录授权服务AccountAuthService,通过调用静默登录接口silentSignIn进行静默登录,如果静默登录成功,直接获取华为帐号code信息;如果静默登录失败,再调用前台登录授权接口getSignInIntent,显式拉起登录授权视图进行登录。
“Java” // 华为帐号登录授权服务,提供静默登录接口silentSignIn,获取前台登录视图getSignInIntent,登出signOut等接口 private AccountAuthService mAuthService; // 华为帐号登录授权参数 private AccountAuthParams mAuthParam; // 用户自定义signInIntent请求码 private static final int REQUEST_CODE_SIGN_IN = 1000; // 用户自定义日志标记 private static final String TAG = "Account"; /** * 静默登录,如果设备上的华为帐号系统已经登录,并且用户已经授权过,无需再拉起登录页面和授权页面, * 将直接静默登录成功,在成功监听器中,返回帐号信息; * 如果华为帐号系统帐号未登录或者用户没有授权,静默登录会失败,需要显式拉起前台登录授权视图。 */ private void silentSignInByHwId() { // 1、配置登录请求参数AccountAuthParams,包括请求用户的id(openid、unionid)、email、profile(昵称、头像)等; // 2、DEFAULT_AUTH_REQUEST_PARAM默认包含了id和profile(昵称、头像)的请求; // 3、如需要再获取用户邮箱,需要setEmail(); // 4、通过setAuthorizationCode()来选择使用code模式,最终所有请求的用户信息都可以调服务器的接口获取; mAuthParam = new AccountAuthParamsHelper(AccountAuthParams.DEFAULT_AUTH_REQUEST_PARAM) .setEmail() .setAuthorizationCode() .createParams(); // 使用请求参数构造华为帐号登录授权服务AccountAuthService mAuthService = AccountAuthManager.getService(this, mAuthParam); // 使用静默登录进行华为帐号登录 Task<AuthAccount> task = mAuthService.silentSignIn(); task.addOnSuccessListener(new OnSuccessListener<AuthAccount>() { @Override public void onSuccess(AuthAccount authAccount) { // 静默登录成功,处理返回的帐号对象AuthAccount,获取帐号信息并处理 dealWithResultOfSignIn(authAccount); } }); task.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(Exception e) { // 静默登录失败,使用getSignInIntent()方法进行前台显式登录 if (e instanceof ApiException) { ApiException apiException = (ApiException) e; Intent signInIntent = mAuthService.getSignInIntent(); // 如果应用是全屏显示,即顶部无状态栏的应用,需要在Intent中添加如下参数: // intent.putExtra(CommonConstant.RequestParams.IS_FULL_SCREEN, true); // 具体详情可以参见应用调用登录接口的时候是全屏页面,为什么在拉起登录页面的过程中顶部的状态栏会闪一下?应该如何解决? signInIntent.putExtra(CommonConstant.RequestParams.IS_FULL_SCREEN, true); startActivityForResult(signInIntent, REQUEST_CODE_SIGN_IN); } } }); } /** * 处理返回的AuthAccount,获取帐号信息 * * @param authAccount AuthAccount对象,用于记录帐号信息 */ private void dealWithResultOfSignIn(AuthAccount authAccount) { Log.i(TAG,"code:"+authAccount.getAuthorizationCode()); //TODO 获取到Code信息后,应用需要发送给应用服务器 }
“Kotlin” // 华为帐号登录授权服务,提供静默登录接口silentSignIn,获取前台登录视图getSignInIntent,登出signOut等接口 private var mAuthService: AccountAuthService? = null // 华为帐号登录授权参数 private var mAuthParam: AccountAuthParams? = null // 用户自定义signInIntent请求码 private val REQUEST_CODE_SIGN_IN = 1000 // 用户自定义日志标记 private val TAG = "Account" /** * 静默登录,如果设备上的华为帐号系统帐号已经登录,并且用户已经授权过,无需再拉起登录页面和授权 * 页面,将直接静默登录成功,在成功监听器中,返回帐号信息; * 如果华为帐号系统帐号未登录或者用户没有授权,静默登录会失败,需要显式拉起前台登录授权视图。 */ private fun silentSignInByHwId() { // 1、配置登录请求参数AccountAuthParams,包括请求用户的id(openid、unionid)、email、profile(昵称、头像)等; // 2、DEFAULT_AUTH_REQUEST_PARAM默认包含了id和profile(昵称、头像)的请求; // 3、如需要再获取用户邮箱,需要setEmail(); // 4、通过setAuthorizationCode()来选择使用code模式,最终所有请求的用户信息都可以调服务器的接口获取; mAuthParam = AccountAuthParamsHelper(AccountAuthParams.DEFAULT_AUTH_REQUEST_PARAM) .setEmail() .setAuthorizationCode() .createParams() // 使用请求参数构造华为帐号登录授权服务AccountAuthService mAuthService = AccountAuthManager.getService(this, mAuthParam) // 使用静默登录进行华为帐号登录 val task = mAuthService!!.silentSignIn() task.addOnSuccessListener { authAccount -> // 静默登录成功,处理返回的帐号对象AuthAccount,获取帐号信息并处理 dealWithResultOfSignIn(authAccount) } task.addOnFailureListener { e -> //静默登录失败,使用getSignInIntent()方法进行前台显式登录 if (e is ApiException) { val apiException = e val signInIntent = mAuthService!!.getSignInIntent() // 如果应用是全屏显示,即顶部无状态栏的应用,需要在Intent中添加如下参数: // intent.putExtra(CommonConstant.RequestParams.IS_FULL_SCREEN, true) // 具体详情可以参见应用调用登录接口的时候是全屏页面,为什么在拉起登录页面的过程中顶部的状态栏会闪一下?应该如何解决? signInIntent.putExtra(CommonConstant.RequestParams.IS_FULL_SCREEN, true) startActivityForResult(signInIntent, REQUEST_CODE_SIGN_IN) } } } /** * 处理返回的AuthAccount,获取帐号信息 * * @param authAccount AuthAccount对象,用于记录帐号信息 */ private fun dealWithResultOfSignIn(authAccount: AuthAccount) { Log.i(TAG, "code:" + authAccount.authorizationCode) //TODO 获取到Code信息后,应用需要发送给应用服务器 }
“Java” @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { super.onActivityResult(requestCode, resultCode, data); if (requestCode == REQUEST_CODE_SIGN_IN) { Log.i(TAG, "onActivitResult of sigInInIntent, request code: " + REQUEST_CODE_SIGN_IN); Task<AuthAccount> authAccountTask = AccountAuthManager.parseAuthResultFromIntent(data); if (authAccountTask.isSuccessful()) { // 登录成功,获取到登录帐号信息对象authAccount AuthAccount authAccount = authAccountTask.getResult(); dealWithResultOfSignIn(authAccount); Log.i(TAG, "onActivitResult of sigInInIntent, request code: " + REQUEST_CODE_SIGN_IN); } else { // 登录失败,status code标识了失败的原因,请参见API参考中的错误码了解详细错误原因 Log.e(TAG, "sign in failed : " +((ApiException)authAccountTask.getException()).getStatusCode()); } } }
“Kotlin” override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { super.onActivityResult(requestCode, resultCode, data) if (requestCode == REQUEST_CODE_SIGN_IN) { Log.i(TAG, "onActivitResult of sigInInIntent, request code: $REQUEST_CODE_SIGN_IN") val authAccountTask = AccountAuthManager.parseAuthResultFromIntent(data) if (authAccountTask.isSuccessful) { // 登录成功,获取到登录帐号信息对象authAccount val authAccount = authAccountTask.result dealWithResultOfSignIn(authAccount) Log.i(TAG, "onActivitResult of sigInInIntent, request code: $REQUEST_CODE_SIGN_IN") } else { // 登录失败,status code标识了失败的原因,请参见API参考中的错误码了解详细错误原因 Log.e(TAG, "sign in failed : " + (authAccountTask.exception as ApiException).statusCode) } } }
该部分代码需要您根据应用设计自己开发。
获取到code后调用服务器接口向帐号服务器请求获取Access Token、Refresh Token。接口详细信息请参见获取凭证Access Token,接口调用错误码信息请参见错误码。
如您使用的是Java语言,accountservertool.jar中提供了AuthCodeUtil.getUserInfos(String accessToken,String getNickName)方法供您使用,详细信息请参见accountservertool.jar工具包使用说明。
Access Token过期处理
由于Access Token的有效期(60分钟)较短,当Access Token失效或者即将失效时(可通过NSP_STATUS错误码判断),可以使用Refresh Token(有效期180天)通过获取凭证Access Token接口向帐号服务器请求获取新的Access Token。
RefreshToken过期处理
由于Refresh Token的有效期为180天,当Refresh Token失效(可通过错误码判断)后,应用服务器需要通知客户端,重新调用Account SDK登录授权接口,请求用户重新授权。
应用调用signOut接口退出当前已登录的帐号,并通知HMS Core SDK清除本地当前已经登录的帐号信息。
“Java”
@Override
protected void onCreate(Bundle savedInstanceState) {
findViewById(R.id.HuaweiIdSignOutButton).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
signOut();
}
});
}
“Kotlin”
override fun onCreate(savedInstanceState: Bundle?) {
findViewById<View>(R.id.HuaweiIdSignOutButton).setOnClickListener { signOut() }
} “Java”
private void signOut() {
Task<Void> signOutTask = mAuthService.signOut();
signOutTask.addOnSuccessListener(new OnSuccessListener<Void>() {
@Override
public void onSuccess(Void aVoid) {
Log.i(TAG, "signOut Success");
}
}).addOnFailureListener(new OnFailureListener() {
@Override
public void onFailure(Exception e) {
Log.i(TAG, "signOut fail");
}
});
}
“Kotlin”
private fun signOut() {
val signOutTask = mAuthService!!.signOut()
signOutTask.addOnSuccessListener {
Log.i(TAG, "signOut Success")
}.addOnFailureListener {
Log.i(TAG, "signOut fail")
}
} 为了提升应用隐私安全,应用可以提供入口,供用户取消对应用的授权。
取消授权接口通过调用AccountAuthService类对象的cancelAuthorization方法,实现取消授权。
“Java”
@Override
protected void onCreate(Bundle savedInstanceState) {
findViewById(R.id.HuaweiIdCancelAuthButton).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
cancelAuthorization();
}
});
}
“Kotlin”
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
findViewById<View>(R.id.HuaweiIdCancelAuthButton).setOnClickListener { cancelAuthorization() }
} “Java”
private void cancelAuthorization() {
Task<Void> task = mAuthService.cancelAuthorization();
task.addOnSuccessListener(new OnSuccessListener<Void>() {
@Override
public void onSuccess(Void aVoid) {
Log.i(TAG, "cancelAuthorization success");
}
});
task.addOnFailureListener(new OnFailureListener() {
@Override
public void onFailure(Exception e) {
Log.i(TAG, "cancelAuthorization failure:" + e.getClass().getSimpleName());
}
});
}
“Kotlin”
private fun cancelAuthorization() {
val task = mAuthService!!.cancelAuthorization()
task.addOnSuccessListener {
Log.i(TAG, "cancelAuthorization success")
}
task.addOnFailureListener { e ->
Log.i(TAG, "cancelAuthorization failure:" + e.javaClass.simpleName)
}
}