帐号服务

简介

HMS Core华为帐号注册用户量已达到9亿+，通过华为帐号可以一键登录应用，通过与华为帐号绑定，可以为应用快速引入新用户和登录。华为帐号开放遵循OAuth2.0以及OpenID Connect标准规范。
您需要：

在华为开发者联盟注册开发者帐号，并在AppGallery Connect上创建应用以及配置应用信息和开通华为帐号服务
使用Android Studio IDE创建Project，并配置接入华为帐号依赖的SDK
根据华为帐号服务开发指南，实现华为帐号开放服务的API调用以及调试

您将建立什么

在这个Codelab中，您将使用已经创建好的Demo Project实现对华为帐号开放服务的API调用，通过Demo Project您可以体验到：

使用华为帐号授权登录的流程
获取华为帐号开放的用户基本信息（用户标识、头像、昵称等）
通过取消授权API接口取消应用的授权

您将会学到什么

如何在AppGallery Connect上创建应用
如何开通华为帐号服务
如何导入华为帐号服务的SDK
如何调用华为帐号服务的API接口

硬件要求

开发计算机（台式机或笔记本电脑），运行Windows 10操作系统。
预装了HMS Core（APK）4.0.0.300以上版本的HUAWEI手机一部，用于真机调试运行demo。

软件要求

Android Studio 3.X
JDK 1.8 及以上
SDK Platform 19及以上
Gradle 4.6及以上

集成HUAWEI HMS Core能力，需要完成以下准备工作：

创建AGC应用
创建Android Studio工程
生成签名证书
生成签名证书指纹
配置签名证书指纹
添加应用包名并保存配置文件
配置Maven仓地址及AGC gradle插件
在Android Studio配置签名文件

具体操作，请按照《HUAWEI HMS Core集成准备》中详细说明来完成。

在华为开发者联盟AppGallery Connect中选择"我的项目"，在项目列表中选择创建的应用，在"项目设置"页面中选择"API管理"。
打开"Account Kit"服务开关。

至此，已经为创建的应用开通了"帐号"服务。

获取配置文件

打开华为开发者联盟AppGallery Connect应用管理中之前创建的应用，并选择"开发->常规"，点击数据存储位置设置按钮。
根据应用实际情况，设置对应数据存储位置，然后点击确认按钮。
下载应用中的"agconnect-services.json"。
将 "agconnect-services.json"文件移至Android Studio开发工程应用模块的根目录。

配置HMS Core SDK依赖

打开应用级的build.gradle文件。
在"dependencies"中添加如下编译依赖，其中{version}替换为HMS Core SDK的版本号，例如：5.0.3.301。
```
dependencies {
    implementation 'com.huawei.hms:hwid:{version}'
}
```

点击sync now 同步工程。

配置混淆脚本

打开Android Studio工程的混淆配置文件proguard-rules.pro。

加入混淆配置。


-ignorewarnings 
-keepattributes *Annotation* 
-keepattributes Exceptions 
-keepattributes InnerClasses 
-keepattributes Signature 
-keepattributes SourceFile,LineNumberTable

如果您使用了AndResGuard，需要在混淆配置文件中加入AndResGuard允许清单。


"R.string.hms*", 
"R.string.connect_server_fail_prompt_toast", 
"R.string.getting_message_fail_prompt_toast", 
"R.string.no_available_network_prompt_toast", 
"R.string.third_app_*", 
"R.string.upsdk_*", 
"R.layout.hms*", 
"R.layout.upsdk_*", 
"R.drawable.upsdk*", 
"R.color.upsdk*", 
"R.dimen.upsdk*", 
"R.style.upsdk*",
"R.string.agc*"

帐号的交互接口主要涉及登录、静默登录、退出帐号、取消授权。本次Codelab中您可以在您的Android Studio工程中创建一个布局页面，参照下图进行UI设计。

ID Token模式登录华为帐号

ID Token模式整体流程：

用户点击华为帐号授权登录图标，请求使用华为帐号授权登录。
华为帐号拉起用户登录授权界面，界面上会根据登录请求中携带的授权域（scope）信息，显示告知用户需要授权的内容。
用户手动允许授权后，华为帐号返回ID Token信息。
应用选择使用本地方式验证或华为帐号服务器方式验证ID Token。

ID Token模式代码示例：

展示华为登录方式图标。

应用在登录页面展示华为帐号登录方式的图标，华为登录方式图标规范请参见华为图标规范。

调用HuaweiIdAuthParamsHelper的setIdToken方法请求授权。

Java


HuaweiIdAuthParams authParams = new HuaweiIdAuthParamsHelper(HuaweiIdAuthParams.DEFAULT_AUTH_REQUEST_PARAM).setIdToken().createParams();

Kotlin


val authParams : HuaweiIdAuthParams = HuaweiIdAuthParamsHelper(HuaweiIdAuthParams.DEFAULT_AUTH_REQUEST_PARAM).setIdToken().createParams()

调用HuaweiIdAuthManager的 getService方法初始化HuaweiIdAuthService对象。

Java


HuaweiIdAuthService service = HuaweiIdAuthManager.getService(MainActivity.this, authParams);

Kotlin


val service : HuaweiIdAuthService = HuaweiIdAuthManager.getService(this@MainActivity, authParams)

调用HuaweiIdAuthService的getSignInIntent方法并拉起华为帐号登录授权页面。

Java


startActivityForResult(service.getSignInIntent(), 8888);

Kotlin


startActivityForResult(service.signInIntent, 8888)

登录授权完成后处理登录结果。

Java


@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
    //授权登录结果处理，从AuthHuaweiId中获取ID Token
    super.onActivityResult(requestCode, resultCode, data);
    if (requestCode == 8888) {
        Task<AuthHuaweiId> authHuaweiIdTask = HuaweiIdAuthManager.parseAuthResultFromIntent(data);
        if (authHuaweiIdTask.isSuccessful()) {
            //登录成功，获取用户的华为帐号信息和ID Token
            AuthHuaweiId huaweiAccount = authHuaweiIdTask.getResult();
            Log.i(TAG, "idToken:" + huaweiAccount.getIdToken());
        } else {
            //登录失败，不需要做处理，打点日志方便定位
            Log.e(TAG, "sign in failed : " +((ApiException)authHuaweiIdTask.getException()).getStatusCode());
        }
    }
}

Kotlin


override fun onActivityResult(requestCode: Int, resultCode: Int,  data: Intent?) {
    //授权登录结果处理，从AuthHuaweiId中获取ID Token
    super.onActivityResult(requestCode, resultCode, data)
    if (requestCode == 8888) {
        val authHuaweiIdTask = HuaweiIdAuthManager.parseAuthResultFromIntent(data)
        if (authHuaweiIdTask.isSuccessful) {
            //登录成功，获取用户的华为帐号信息和ID Token
            val huaweiAccount = authHuaweiIdTask.result
            Log.i(TAG, "idToken:" + huaweiAccount.idToken)
        } else {
            //登录失败，不需要做处理，打点日志方便定位
            Log.e(TAG, "sign in failed : " + (authHuaweiIdTask.exception as ApiException).statusCode)
        }
    }
}

Authorization Code模式登录华为帐号

华为帐号还支持使用Authorization Code授权登录。适用于拥有server端的应用授权。

Authorization Code整体流程：

用户点击华为帐号授权登录图标，请求使用华为帐号授权登录。
华为帐号拉起用户授权界面，界面上会根据登录请求中携带的授权域（scope）信息，显示告知用户需要授权的内容。
用户手动允许授权后，华为帐号返回authorization code信息。
第三方应用获取authorization code后通过服务端接口换取access_token、refresh_token、id_token信息。
access_token或id_token过期后，使用refresh_token获取新的access_token、id_token信息。

Authorization Code模式代码示例：

展示华为登录方式图标。

应用在登录页面展示华为帐号登录方式的图标，华为登录方式图标规范请参见华为图标规范。

调用HuaweiIdAuthParamsHelper的 setAuthorizationCode方法请求授权。

Java


HuaweiIdAuthParams authParams = new HuaweiIdAuthParamsHelper(HuaweiIdAuthParams.DEFAULT_AUTH_REQUEST_PARAM).setAuthorizationCode().createParams();

Kotlin


val authParams : HuaweiIdAuthParams =  HuaweiIdAuthParamsHelper(HuaweiIdAuthParams.DEFAULT_AUTH_REQUEST_PARAM).setAuthorizationCode().createParams()

调用HuaweiIdAuthManager的 getService方法初始化HuaweiIdAuthService对象。

Java


HuaweiIdAuthService service = HuaweiIdAuthManager.getService(MainActivity.this, authParams);

Kotlin


val service : HuaweiIdAuthService = HuaweiIdAuthManager.getService(this@MainActivity, authParams)

调用HuaweiIdAuthService的getSignInIntent方法并拉起华为帐号登录授权页面。

Java


startActivityForResult(service.getSignInIntent(), 8888);

Kotlin


startActivityForResult(service.signInIntent, 8888)

登录授权完成后处理登录结果。

Java


@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
    //授权登录结果处理，从AuthHuaweiId中获取Authorization Code
    super.onActivityResult(requestCode, resultCode, data);
    if (requestCode == 8888) {
        Task<AuthHuaweiId> authHuaweiIdTask = HuaweiIdAuthManager.parseAuthResultFromIntent(data);
        if (authHuaweiIdTask.isSuccessful()) {
            //登录成功，获取用户的华为帐号信息和Authorization Code
            AuthHuaweiId huaweiAccount = authHuaweiIdTask.getResult();
            Log.i(TAG, "Authorization code:" + huaweiAccount.getAuthorizationCode());
        } else {
            //登录失败
            Log.e(TAG, "sign in failed : " + ((ApiException)authHuaweiIdTask.getException()).getStatusCode()); 
        }
    }
}

Kotlin


override fun onActivityResult(requestCode: Int, resultCode: Int,  data: Intent?) {
    //授权登录结果处理，从AuthHuaweiId中获取Authorization Code
    super.onActivityResult(requestCode, resultCode, data)
    if (requestCode == 8888) {
        val authHuaweiIdTask = HuaweiIdAuthManager.parseAuthResultFromIntent(data)
        if (authHuaweiIdTask.isSuccessful) {
            //登录成功，获取用户的华为帐号信息和Authorization Code
            val huaweiAccount = authHuaweiIdTask.result
            Log.i(TAG, "Authorization code:" + huaweiAccount.authorizationCode)
        } else {
            //登录失败
            Log.e(TAG, "sign in failed : " + (authHuaweiIdTask.exception as ApiException).statusCode)
        }
    }
}

应用客户端将获取到的code上报给应用服务端，再由其调用/oauth2/v3/token接口向华为帐号服务器请求获取ID Token、Access Token、Refresh Token。

请求样例：


POST /oauth2/v3/token HTTP/1.1
Host: oauth-login.cloud.huawei.com
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code&
code=CF3L7XyCVZi52XMdsUzD7Z6ap0/N2qExcNe0AMqTselTtNd1B4DUwTsQ/23FPZasC8yI29v+N2s2jMT/T2MXiuc+178I/sYuWVoTyqwBaDqVW82KCMqaxbeWBguH4hEENxmDSUIE61Qg5R1F074PiS+qJYnbLI2IBqatS37px8pn5qnuq5oX+UX8XN3/w8HLt4GpakW5Dk1v7hGs&
client_id={app_id}&
client_secret={app_secret}&
redirect_uri=https%3A%2F%2F/www.example.com/%2Fredirect_uri

返回样例：


HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache 
{
"access_token": "CFyJ21sNODl16eV9y2vu3CwQk9DBr32BkOcxxgAd7MZUR5th1giyTk5\/kA+QDAyxou+\/5U2zzBRcf3qgLkkFdtbbC+mM3zFV7xj7CCEMHc5Tw92al0Y=",
"refresh_token": "CF13G0sRaGybtYt7SIyeUILNORtTFwMgz4ao5C7j7vtgLPt6ogmXKjdI8RS\/YlyS71z4DyP6kEMnOrRlmNK0KhdOUNWd+qVLLRsEEHkqRIKpuAkPvL8=",
"expires_in": 3600,
"id_token": "eyJraWQiOiI3YTNlYjRkNTJmMDdhODM0NDU4MmRhOGQ3MWE1MGQ5MDlmNWM0YmRiZTFkNDQ3MjQ2MDNhZTA2NGM0ZTlkZGYyIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdF9oYXNoIjoiM0hPdFZYOEdMcG1GSDBWRVlSc1BjdyIsImF1ZCI6IjEwMDczNTE2NyIsInN1YiI6Ik1ERTlYaWFoc3MwaWFFNXU2c09PaEY5Mlhvell0Rkt4bUdtbWlhNGtTaEJ3dklLR2ciLCJhenAiOiIxMDA3MzUxNjciLCJpc3MiOiJodHRwczovL2FjY291bnRzLmh1YXdlaS5jb20iLCJuYW1lIjoi6Jab5oyv5Y2OIiwiZXhwIjoxNTczMDQ2NDI4LCJnaXZlbl9uYW1lIjoi6Jab5oyv5Y2OIiwiZGlzcGxheV9uYW1lIjoi5rKh5pyJ562U5qGIIiwiaWF0IjoxNTczMDQyODI4LCJwaWN0dXJlIjoiaHR0cHM6Ly91cGZpbGUtZHJjbi5wbGF0Zm9ybS5oaWNsb3VkLmNvbS9GaWxlU2VydmVyL2ltYWdlL2IuMDI2MDA4NjAwMDIzMjQ3MjUxMS4yMDE5MDgyMDExNTQ0Mi5tbmRjWTZyN2JUT0xNcVdiNVBhZDIzZExWNXh0b1Z2WC4xMDAwLkI0QkUyQTdEM0I3NkFGMzBCMkJDNjlBQ0JFNjg3NDIxMTQwMjhEQzYwREZFOTVCMjM5QkI0QzM2OUQwOUVEMkEuanBnIn0.mqy2C3ZNYEM8FKt8r1LX0VFosJjpqVl7E7mw2N-uEhnmAJq3blBco8fp2TCEyUzi1qFMN7-cjv87mQqCEpgfozyU7xV0VXMGdcd9ZhOxtabZtQGxUXRpIPiK5iysp68d95_QJAf2YZIdA4P_1zU8ZGxH57njIXRUVdQWDB8poeuB9gOc72bufe3DmSkqYD9aKvcibpA44Iln58aj-I9xs-FpcDwE6Y9hTfLGT5vk_5hXs32qwt54kEH1JjKbzZRW7B-OaELJIzzOM49oZKrdkViG6c2Tco1xX1WcKSz298Wckj4suLBAqkam4AprQgoSETC__ORTfy9OHIS1m4_8uQ",
"scope": "openid profile email",
"token_type": "Bearer"
}

由于access token的有效期（目前是60分钟）较短，当access token失效，或者即将失效时，可以使用refresh token通过/oauth2/v3/token 接口向华为帐号服务器请求获取新的access token。

请求样例：


POST /oauth2/v3/token HTTP/1.1 
Host: oauth-login.cloud.huawei.com 
Content-Type: application/x-www-form-urlencoded 
  
grant_type=refresh_token& 
client_id=12345& 
client_secret=bKaZ0VE3EYrXaXCdCe3d2k9few& 
refresh_toekn=CF2Mm03n0aos9iZZ8nIhfyDtoXy74CXeBi50gVVhMpB0IUzlv9ZwizEvTBhVoF820ZPim0JwNR9j2p1qgEQWnIVYZRlp4T6ezMgekUnsHBkvNev5rd2MdfQMLP

返回样例：


HTTP/1.1 200 OK 
Content-Type: application/json;charset=UTF-8 
Cache-Control: no-store 
Pragma: no-cache 
  
{ 
"access_token": "CFyJ4J\/l6wuwcFqYOJG4maq2ca8RAV+g0i+mel6qCV5lvqH0PYtW0+BNwfHWg0AqMnW6ZdBvUgs7ijkxMFh1xVP\/B+vQXz3PWsivkKCuL78XtbLt7vs=", 
"id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjExOGRmMjU0YjgzNzE4OWQxYmMyYmU5NjUwYTgyMTEyYzAwZGY1YTQiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiI3ODI0NTY2Njc4OTgtc2M0MzE3Y2l0NGEwMjB0NzdrbGdsbWo1ZjA4YWtnMWIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiI3ODI0NTY2Njc4OTgtN2NkNGJpYWRkaGVwNGc4cnZic2VlOGtwcDA5Zm1hNzIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMDE3MTIxMzkwMzgwNDE2MDc0MTQiLCJlbWFpbCI6Inh1ZXpoZW5odWF0anVAc2luYS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicGljdHVyZSI6Imh0dHBzOi8vbGg1Lmdvb2dsZXVzZXJjb250ZW50LmNvbS8tMm9lTTllT09zNTAvQUFBQUFBQUFBQUkvQUFBQUFBQUFBQkkvMVpOSC0xdmxxc3cvczk2LWMvcGhvdG8uanBnIiwiaWF0IjoxNTYxNDUxMTUyLCJleHAiOjE1NjE0NTQ3NTJ9.Eo9IHMkid596jvt1YYzNsRtDq9c9K9dbougkU41Noh7TXNiko86_RuWwHID6k1kDg398AwC3wwH-t2hLcUjgrXPNd9XYU96Jp4-UxdDszP6ywEJgvvBCyTHzsi2auvKt_MnfSrs3qOKfh7noJvXq8AY-Hi3vqSUks5kGqbZKVzCHhBDO3RD9Fs9YHsB6w0XVKZojPOBDaAT_TiijoChn-Q-e8NbSGUx52OgeH-Nw5lOj6JVb_7fb6ucWRzlhiQuzFjklevLVw2pjw1MxKbl1vfRp0X699uZBVjgl9hj1L7LSDObuPzLiXF7ojji5JKYC6zIwAtZQUZ_VUmSk01GDLQ", 
    "expires_in": 3600, 
    "scope": "openid profile email", 
    "token_type": "Bearer" 
}

登出华为帐号

登出帐号整体流程：

用户在已经登录应用，在应用中执行登出操作。
应用调用HuaweiIdAuthService.signOut方法向HUAWEI Account SDK请求退出华为帐号。
HUAWEI Account SDK清除华为帐号登录信息后向应用返回登出结果。

登出帐号代码示例：

使用华为帐号登录授权时创建的HuaweiIdAuthService实例调用signOut接口。
Java


//service为登录授权时使用getService方法生成的HuaweiIdAuthService实例
Task<Void> signOutTask = service.signOut();

Kotlin


//service为登录授权时使用getService方法生成的HuaweiIdAuthService实例
val signOutTask = service.signOut()

signOut完成后的处理。

Java


signOutTask.addOnCompleteListener(new OnCompleteListener<Void>() {
        @Override   
        public void onComplete(Task<Void> task) {      
                //完成登出后的处理       
                Log.i(TAG, "signOut complete");
        }
});

Kotlin


signOutTask.addOnCompleteListener { it ->
    //完成登出后的处理
    Log.i(TAG, "signOut complete")
}

开发完成后，点击图标，运行Android Studio工程打包生成APK，并安装在测试手机上。运行界面如下图所示：

干得好，您已经成功完成了Codelab并学到了：

如何在AppGallery Connect上创建应用
如何配置开通华为帐号服务
如何导入华为帐号服务的SDK和API调用

帐号服务相关API介绍

您可以点击下方按钮下载源码。

源码下载

已复制代码