HarmonyOS 鸿蒙Next中场景介绍

HarmonyOS 鸿蒙Next中场景介绍

场景介绍

如应用需要完善用户头像昵称信息，可使用Account Kit提供的头像昵称授权能力，用户允许应用获取头像昵称后，可快速完成个人信息填写。以下对Account kit提供的头像昵称授权能力进行介绍，若要获取头像还可通过场景化控件选择头像Button进行获取。

手机端获取头像昵称

Wearable设备获取头像昵称

约束与限制

获取头像昵称能力支持Phone、Tablet、PC/2in1、Wearable设备，并且从5.1.1(19)版本开始，新增支持TV设备。

业务流程

流程说明：

1. 应用传对应scope调用授权API请求获取用户头像昵称。
2. 如用户已给应用授权，则开发者能直接获取用户头像昵称。
3. 如用户未授权，则授权请求会拉起授权页面，在用户确认授权后，开发者能获取到用户头像昵称。
4. 获取到头像信息，开发者可以下载该url使用该头像。

接口说明

获取头像昵称关键接口如下表所示，具体API说明详见API参考。

注意

1. 上述接口需在页面或自定义组件生命周期内调用。
2. 未设置昵称默认返回华为账号绑定的匿名手机号/邮箱。

开发前提

在进行代码开发前，请先确认您已完成配置公钥指纹和配置Client ID工作。该场景无需申请scope权限。

注意 若未正确配置公钥指纹或Client ID，将报错1001500001 应用指纹证书校验失败。

开发步骤

客户端开发

1. 导入authentication模块及相关公共模块。

   import { authentication } from '[@kit](/user/kit).AccountKit';
   import { hilog } from '[@kit](/user/kit).PerformanceAnalysisKit';
   import { util } from '[@kit](/user/kit).ArkTS';
   import { BusinessError } from '[@kit](/user/kit).BasicServicesKit';
   

2. 创建授权请求并设置参数。

   // 创建授权请求，并设置参数
   const authRequest = new authentication.HuaweiIDProvider().createAuthorizationWithHuaweiIDRequest();
   // 获取头像昵称需要传如下scope
   authRequest.scopes = ['profile'];
   // 若开发者需要进行服务端开发以获取头像昵称，则需传如下permission获取authorizationCode
   authRequest.permissions = ['serviceauthcode'];
   // 用户是否需要登录授权，该值为true且用户未登录或未授权时，会拉起用户登录或授权页面
   authRequest.forceAuthorization = true;
   // 用于防跨站点请求伪造
   authRequest.state = util.generateRandomUUID();
   

3. 调用AuthenticationController对象的executeRequest方法执行授权请求，并处理授权结果，从授权结果中解析出头像昵称和Authorization Code。

   try {
       const controller = new authentication.AuthenticationController(this.getUIContext().getHostContext());
       controller.executeRequest(authRequest).then((data) => {
           const authorizationWithHuaweiIDResponse = data as authentication.AuthorizationWithHuaweiIDResponse;
           const state = authorizationWithHuaweiIDResponse.state;
           if (state && authRequest.state !== state) {
               hilog.error(0x0000, 'testTag', `Failed to authorize. The state is different, response state: ${state}`);
               return;
           }
           hilog.info(0x0000, 'testTag', 'Succeeded in authentication.');
           const authorizationWithHuaweiIDCredential = authorizationWithHuaweiIDResponse?.data;
           const avatarUri = authorizationWithHuaweiIDCredential?.avatarUri;
           const nickName = authorizationWithHuaweiIDCredential?.nickName;
           // 开发者处理avatarUri, nickName
           const authorizationCode = authorizationWithHuaweiIDCredential?.authorizationCode;
           // 涉及服务端开发以获取头像昵称场景，开发者处理authorizationCode
       }).catch((err: BusinessError) => {
           this.dealAllError(err);
       });
   } catch (error) {
       this.dealAllError(error);
   }
   
   // 错误处理
   dealAllError(error: BusinessError): void {
       hilog.error(0x0000, 'testTag', `Failed to obtain userInfo. Code: ${error.code}, message: ${error.message}`);
       // 在应用获取头像昵称场景下，涉及UI交互时，建议按照如下错误码指导提示用户
       if (error.code === ErrorCode.ERROR_CODE_LOGIN_OUT) {
           // 用户未登录华为账号，请登录华为账号并重试
       } else if (error.code === ErrorCode.ERROR_CODE_NETWORK_ERROR) {
           // 网络异常，请检查当前网络状态并重试
       } else if (error.code === ErrorCode.ERROR_CODE_USER_CANCEL) {
           // 用户取消授权
       } else if (error.code === ErrorCode.ERROR_CODE_SYSTEM_SERVICE) {
           // 系统服务异常，请稍后重试
       } else if (error.code === ErrorCode.ERROR_CODE_REQUEST_REFUSE) {
           // 重复请求，应用无需处理
       } else {
           // 获取用户信息失败，请稍后重试
       }
   }
   
   export enum ErrorCode {
       // 账号未登录
       ERROR_CODE_LOGIN_OUT = 1001502001,
       // 网络错误
       ERROR_CODE_NETWORK_ERROR = 1001502005,
       // 用户取消授权
       ERROR_CODE_USER_CANCEL = 1001502012,
       // 系统服务异常
       ERROR_CODE_SYSTEM_SERVICE = 12300001,
       // 重复请求
       ERROR_CODE_REQUEST_REFUSE = 1001500002
   }
   

服务端开发（可选）

开发者根据业务需要选择是否进行服务端开发。

1. 应用服务端使用Client ID、Client Secret、Authorization Code调用获取用户级凭证接口向华为账号服务器请求获取Access Token、Refresh Token。
2. 使用Access Token调用获取用户信息接口获取用户信息，从用户信息中获取用户头像昵称。
   • Access Token过期处理 由于Access Token的有效期仅为60分钟，当Access Token失效或者即将失效时（可通过REST API错误码判断），可以使用Refresh Token（有效期180天）通过刷新凭证接口向华为账号服务器请求获取新的Access Token。
     • 说明
       1. 当Access Token失效时，若您不使用Refresh Token向账号服务器请求获取新的Access Token，账号的授权信息将会失效，导致使用Access Token的功能都会失败。
       2. 当Access Token非正常失效（如修改密码、退出账号、删除设备）时，业务可重新登录授权获取Authorization Code，向账号服务器请求获取新的Access Token。
   • Refresh Token过期处理 由于Refresh Token的有效期为180天，当Refresh Token失效后（可通过REST API错误码判断），应用服务端需要通知客户端，重新调用授权接口，请求用户重新授权。