harmony-utils 之 AuthUtil，生物认证相关工具类

2025-06-25
安徽
本文字数：2872 字
阅读完需：约 9 分钟

harmony-utils 之 AuthUtil，生物认证相关工具类

harmony-utils 简介与说明

harmony-utils 一款功能丰富且极易上手的 HarmonyOS 工具库，借助众多实用工具类，致力于助力开发者迅速构建鸿蒙应用。其封装的工具涵盖了 APP、设备、屏幕、授权、通知、线程间通信、弹框、吐司、生物认证、用户首选项、拍照、相册、扫码、文件、日志，异常捕获、字符、字符串、数字、集合、日期、随机、base64、加密、解密、JSON 等一系列的功能和操作，能够满足各种不同的开发需求。

picker_utils 是 harmony-utils 拆分出来的一个子库，包含 PickerUtil、PhotoHelper、ScanUtil。

下载安装

ohpm i @pura/harmony-utils

ohpm i @pura/picker_utils

  //全局初始化方法，在UIAbility的onCreate方法中初始化 AppUtil.init()  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {    AppUtil.init(this.context);  }

复制代码

API 方法与使用

getAvailableStatus 查询指定类型和等级的认证能力是否支持

let status = AuthUtil.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1)if (status.status) {  ToastUtil.showToast("当前设备支持人脸识别");} else {  ToastUtil.showToast("当前设备不支持人脸识别");  LogUtil.error(JSON.stringify(status, null, 2));}

复制代码

onStartEasy 开始认证,使用指纹和密码认证

AuthUtil.onStartEasy(true, (result: userAuth.UserAuthResult) => {  let resultStr = JSON.stringify(result, null, 2);});

复制代码

onStart 开始认证，用户指定类型认证

AuthUtil.onStart({  authType: [userAuth.UserAuthType.FACE],  authTrustLevel: userAuth.AuthTrustLevel.ATL3,  title: '请验证人脸',  showTip: true}, (result) => {  let resultStr = JSON.stringify(result, null, 2);});

复制代码

cancel 取消认证

 AuthUtil.cancel();

复制代码

generateChallenge 生成挑战值,用来防重放攻击

 let challenge = AuthUtil.generateChallenge();

复制代码

getErrorMsg 获取错误 msg

 const errorTip = AuthUtil.getErrorMsg(result.result, '');

复制代码

示例代码

import { router } from '@kit.ArkUI';import { AuthUtil, LogUtil, ToastUtil } from '@pura/harmony-utils';import { DescribeBean } from '../../model/DescribeBean';import userIAM_userAuth from '@ohos.userIAM.userAuth';import userAuth from '@ohos.userIAM.userAuth';import { MockSetup } from '@ohos/hamock';import { TitleBarView } from '../../component/TitleBarView';import { Utils } from '../../utils/Utils';
/** * 手机的生物认证（指纹、人脸、密码）工具类 */@Entry@Componentstruct Index {  private scroller: Scroller = new Scroller();  @State describe: DescribeBean = router.getParams() as DescribeBean;

  @MockSetup  mock() {    this.describe = new DescribeBean("AuthUtil", "手机的生物认证（指纹、人脸、密码）工具类");  }
  build() {    Column() {      TitleBarView({ describe: this.describe })      Divider()      Scroll(this.scroller) {        Column() {          Button("getAvailableStatus()")            .btnStyle()            .onClick(() => {              let status = AuthUtil.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1)              if (status.status) {                ToastUtil.showToast("当前设备支持人脸识别")              } else {                ToastUtil.showToast("当前设备不支持人脸识别");                LogUtil.error(JSON.stringify(status, null, 2));              }            })          Button("getAvailableStatus()")            .btnStyle()            .onClick(() => {              let status = AuthUtil.getAvailableStatus(userIAM_userAuth.UserAuthType.FINGERPRINT, userIAM_userAuth.AuthTrustLevel.ATL2)              if (status.status) {                ToastUtil.showToast("当前设备支持指纹识别")              } else {                ToastUtil.showToast("当前设备不支持指纹识别")                LogUtil.error(JSON.stringify(status, null, 2));              }            })          Button("getAvailableStatus()")            .btnStyle()            .onClick(() => {              let status = AuthUtil.getAvailableStatus(userIAM_userAuth.UserAuthType.PIN, userIAM_userAuth.AuthTrustLevel.ATL2)              if (status.status) {                ToastUtil.showToast("当前设备支持口令识别")              } else {                ToastUtil.showToast("当前设备不支持口令识别");                LogUtil.error(JSON.stringify(status, null, 2));              }            })          Button("onStartEasy()")            .btnStyle()            .onClick(() => {              AuthUtil.onStartEasy(true, (result: userAuth.UserAuthResult) => {                let resultStr = JSON.stringify(result, null, 2);                Utils.showSheetText(resultStr);              });            })          Button("onStart()")            .btnStyle()            .onClick(() => {              AuthUtil.onStart({                authType: [userAuth.UserAuthType.FACE],                authTrustLevel: userAuth.AuthTrustLevel.ATL3,                title: '请验证人脸',                showTip: true              }, (result) => {                let resultStr = JSON.stringify(result, null, 2);                Utils.showSheetText(resultStr);              });            })          Button("cancel()")            .btnStyle()            .onClick(() => {              AuthUtil.cancel();            })          Button("generateChallenge")            .btnStyle()            .onClick(() => {              let challenge = AuthUtil.generateChallenge();              Utils.showSheetText(`挑战值: ${challenge}`);            })
         Blank().layoutWeight(1)        }        .margin({ top: 5, bottom: 5 })      }      .layoutWeight(1)    }    .width('100%')    .height('100%')    .justifyContent(FlexAlign.Start)    .backgroundColor($r('app.color.main_background'))  }}

@Stylesfunction btnStyle() {  .width('90%')  .margin({ top: 10, bottom: 5 })}