华为HarmonyOS实现人脸活体检测

两种模式

人脸活体检测分为静默活体检测和动作后提检测两种模式

场景介绍

人脸活体检测支持动作活体检测模式。

动作活体检测支持实时捕捉人脸，需要用户配合做指定动作就可以判断是真实活体，还是非活体攻击（比如：打印图片、人脸翻拍视频以及人脸面具等）。

注意

我们提供的活体检测是一项纯端侧算法、试用期免费的系统基础服务，推荐您使用在考勤打卡、辅助登录和实名认证等低危业务场景中。

因端侧算法在HarmonyOS NEXT/5.0.x尚未完成权威机构检测认证，鉴于支付和金融应用的高风险性，建议开发者基于现有的安全性，针对不同的功能场景进行风险评估和风控策略评估，并采取必要的安全措施。

图1 活体检测示意图

开发步骤

1. 将实现人脸活体检测相关的类添加至工程。
   1. import { interactiveLiveness } from '@kit.VisionKit';

2. 在module.json5文件中添加CAMERA权限，其中reason，abilities标签必填，配置方式参见requestPermissions标签说明。
   1. "requestPermissions":[
   2. {
   3. "name": "ohos.permission.CAMERA",
   4. "reason": "$string:camera_desc",
   5. "usedScene": {"abilities": []}
   6. }
   7. ]

3. 简单配置页面的布局，选择人脸活体检测验证完后的跳转模式。如果使用back跳转模式，表示的是在检测结束后使用router.back()返回。如果使用replace跳转模式，表示的是检测结束后使用router.replaceUrl()去跳转相应页面。默认选择的是replace跳转模式。
   1. Flex({ direction: FlexDirection.Row, justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
   2. Text("验证完的跳转模式：")
   3. .fontSize(18)
   4. .width("25%")
   5. Flex({ direction: FlexDirection.Row, justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
   6. Row() {
   7. Radio({ value: "replace", group: "routeMode" }).checked(true)
   8. .height(24)
   9. .width(24)
   10. .onChange((isChecked: boolean) => {
   11. this.routeMode = "replace"
   12. })
   13. Text("replace")
   14. .fontSize(16)
   15. }
   16. .margin({ right: 15 })
   18. Row() {
   19. Radio({ value: "back", group: "routeMode" }).checked(false)
   20. .height(24)
   21. .width(24)
   22. .onChange((isChecked: boolean) => {
   23. this.routeMode = "back";
   24. })
   25. Text("back")
   26. .fontSize(16)
   27. }
   28. }
   29. .width("75%")
   30. }

4. 如果选择动作活体模式，可填写验证的动作个数。
   1. Flex({ direction: FlexDirection.Row, justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
   2. Text("动作数量：")
   3. .fontSize(18)
   4. .width("25%")
   5. TextInput({
   6. placeholder: this.actionsNum != 0 ? this.actionsNum.toString() : "动作数量为3或4个"
   7. })
   8. .type(InputType.Number)
   9. .placeholderFont({
   10. size: 18,
   11. weight: FontWeight.Normal,
   12. family: "HarmonyHeiTi",
   13. style: FontStyle.Normal
   14. })
   15. .fontSize(18)
   16. .fontWeight(FontWeight.Bold)
   17. .fontFamily("HarmonyHeiTi")
   18. .fontStyle(FontStyle.Normal)
   19. .width("65%")
   20. .onChange((value: string) => {
   21. this.actionsNum = Number(value) as interactiveLiveness.ActionsNumber;
   22. })
   23. }

5. 点击“开始检测“按钮，触发点击事件。
   1. Button("开始检测", { type: ButtonType.Normal, stateEffect: true })
   2. .width(192)
   3. .height(40)
   4. .fontSize(16)
   5. .backgroundColor(0x317aff)
   6. .borderRadius(20)
   7. .margin({
   8. bottom: 56
   9. })
   10. .onClick(() => {
   11. this.privateStartDetection();
   12. })

6. 触发CAMERA权限校验。
   1. // 校验CAMERA权限
   2. private privateStartDetection() {
   3. abilityAccessCtrl.createAtManager().requestPermissionsFromUser(this.context, this.array).then((res) => {
   4. for (let i = 0; i < res.permissions.length; i++) {
   5. if (res.permissions[i] === "ohos.permission.CAMERA" && res.authResults[i] === 0) {
   6. this.privateRouterLibrary();
   7. }
   8. }
   9. }).catch((err: BusinessError) => {
   10. hilog.error(0x0001, "LivenessCollectionIndex", `Failed to request permissions from user. Code is ${err.code}, message is ${err.message}`);
   11. })
   12. }

7. 配置人脸活体检测控件的配置项InteractiveLivenessConfig，用于跳转到人脸活体检测控件。
   配置中具体的参数可参考API文档。
   1. let routerOptions: interactiveLiveness.InteractiveLivenessConfig = {
   2. isSilentMode: this.isSilentMode as interactiveLiveness.DetectionMode,
   3. routeMode: this.routeMode as interactiveLiveness.RouteRedirectionMode,
   4. actionsNum: this.actionsNum
   5. };

8. 调用interactiveLiveness的startLivenessDetection接口，判断跳转到人脸活体检测控件是否成功。
   1. // 跳转到人脸活体检测控件
   2. private privateRouterLibrary() {
   3. if (canIUse("SystemCapability.AI.Component.LivenessDetect")) {
   4. interactiveLiveness.startLivenessDetection(routerOptions).then((DetectState: boolean) => {
   5. hilog.info(0x0001, "LivenessCollectionIndex", `Succeeded in jumping.`);
   6. }).catch((err: BusinessError) => {
   7. hilog.error(0x0001, "LivenessCollectionIndex", `Failed to jump. Code：${err.code}，message：${err.message}`);
   8. })
   9. } else {
   10. hilog.error(0x0001, "LivenessCollectionIndex", 'this api is not supported on this device');
   11. }
   12. }

9. 检测结束后回到当前界面，可调用interactiveLiveness的getInteractiveLivenessResult接口，验证人脸活体检测的结果。
   1. // 获取验证结果
   2. private getDetectionResultInfo() {
   3. // getInteractiveLivenessResult接口调用完会释放资源
   4. if (canIUse("SystemCapability.AI.Component.LivenessDetect")) {
   5. let resultInfo = interactiveLiveness.getInteractiveLivenessResult();
   6. resultInfo.then(data => {
   7. this.resultInfo = data;
   8. }).catch((err: BusinessError) => {
   9. this.failResult = {
   10. "code": err.code,
   11. "message": err.message
   12. }
   13. })
   14. } else {
   15. hilog.error(0x0001, "LivenessCollectionIndex", 'this api is not supported on this device');
   16. }
   17. }

开发实例

1. import { common, abilityAccessCtrl, Permissions } from '@kit.AbilityKit';
2. import { interactiveLiveness } from '@kit.VisionKit';
3. import { BusinessError } from '@kit.BasicServicesKit';
4. import { hilog } from '@kit.PerformanceAnalysisKit';
6. @Entry
7. @Component
8. struct LivenessIndex {
9. private context: common.UIAbilityContext = getContext(this) as common.UIAbilityContext;
10. private array: Array<Permissions> = ["ohos.permission.CAMERA"];
11. @State actionsNum: number = 0;
12. @State isSilentMode: string = "INTERACTIVE_MODE";
13. @State routeMode: string = "replace";
14. @State resultInfo: interactiveLiveness.InteractiveLivenessResult = {
15. livenessType: 0
16. };
17. @State failResult: Record<string, number | string> = {
18. "code": 1008302000,
19. "message": ""
20. };
22. build() {
23. Stack({
24. alignContent: Alignment.Top
25. }) {
26. Column() {
27. Row() {
28. Flex({ direction: FlexDirection.Row, justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
29. Text("验证完的跳转模式：")
30. .fontSize(18)
31. .width("25%")
32. Flex({ direction: FlexDirection.Row, justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
33. Row() {
34. Radio({ value: "replace", group: "routeMode" }).checked(true)
35. .height(24)
36. .width(24)
37. .onChange((isChecked: boolean) => {
38. this.routeMode = "replace"
39. })
40. Text("replace")
41. .fontSize(16)
42. }
43. .margin({ right: 15 })
45. Row() {
46. Radio({ value: "back", group: "routeMode" }).checked(false)
47. .height(24)
48. .width(24)
49. .onChange((isChecked: boolean) => {
50. this.routeMode = "back";
51. })
52. Text("back")
53. .fontSize(16)
54. }
55. }
56. .width("75%")
57. }
58. }
59. .margin({ bottom: 30 })
61. Row() {
62. Flex({ direction: FlexDirection.Row, justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
63. Text("动作数量：")
64. .fontSize(18)
65. .width("25%")
66. TextInput({
67. placeholder: this.actionsNum != 0 ? this.actionsNum.toString() : "动作数量为3或4个"
68. })
69. .type(InputType.Number)
70. .placeholderFont({
71. size: 18,
72. weight: FontWeight.Normal,
73. family: "HarmonyHeiTi",
74. style: FontStyle.Normal
75. })
76. .fontSize(18)
77. .fontWeight(FontWeight.Bold)
78. .fontFamily("HarmonyHeiTi")
79. .fontStyle(FontStyle.Normal)
80. .width("65%")
81. .onChange((value: string) => {
82. this.actionsNum = Number(value) as interactiveLiveness.ActionsNumber;
83. })
84. }
85. }
86. }
87. .margin({ left: 24, top: 80 })
88. .zIndex(1)
90. Stack({
91. alignContent: Alignment.Bottom
92. }) {
93. if (this.resultInfo?.mPixelMap) {
94. Image(this.resultInfo?.mPixelMap)
95. .width(260)
96. .height(260)
97. .align(Alignment.Center)
98. .margin({ bottom: 260 })
99. Circle()
100. .width(300)
101. .height(300)
102. .fillOpacity(0)
103. .strokeWidth(60)
104. .stroke(Color.White)
105. .margin({ bottom: 250, left: 0 })
106. }
108. Text(this.resultInfo.mPixelMap ?
109. "检测成功" :
110. this.failResult.code != 1008302000 ?
111. "检测失败" :
112. "")
113. .width("100%")
114. .height(26)
115. .fontSize(20)
116. .fontColor("#000000")
117. .fontFamily("HarmonyHeiTi")
118. .margin({ top: 50 })
119. .textAlign(TextAlign.Center)
120. .fontWeight("Medium")
121. .margin({ bottom: 240 })
123. if(this.failResult.code != 1008302000) {
124. Text(this.failResult.message as string)
125. .width("100%")
126. .height(26)
127. .fontSize(16)
128. .fontColor(Color.Gray)
129. .textAlign(TextAlign.Center)
130. .fontFamily("HarmonyHeiTi")
131. .fontWeight("Medium")
132. .margin({ bottom: 200 })
133. }
135. Button("开始检测", { type: ButtonType.Normal, stateEffect: true })
136. .width(192)
137. .height(40)
138. .fontSize(16)
139. .backgroundColor(0x317aff)
140. .borderRadius(20)
141. .margin({
142. bottom: 56
143. })
144. .onClick(() => {
145. this.privateStartDetection();
146. })
147. }
148. .height("100%")
149. }
150. }
152. onPageShow() {
153. this.resultRelease();
154. this.getDetectionResultInfo();
155. }
157. // 跳转到人脸活体检测控件
158. private privateRouterLibrary() {
159. let routerOptions: interactiveLiveness.InteractiveLivenessConfig = {
160. isSilentMode: this.isSilentMode as interactiveLiveness.DetectionMode,
161. routeMode: this.routeMode as interactiveLiveness.RouteRedirectionMode,
162. actionsNum: this.actionsNum
163. }
165. if (canIUse("SystemCapability.AI.Component.LivenessDetect")) {
166. interactiveLiveness.startLivenessDetection(routerOptions).then((DetectState: boolean) => {
167. hilog.info(0x0001, "LivenessCollectionIndex", `Succeeded in jumping.`);
168. }).catch((err: BusinessError) => {
169. hilog.error(0x0001, "LivenessCollectionIndex", `Failed to jump. Code：${err.code}，message：${err.message}`);
170. })
171. } else {
172. hilog.error(0x0001, "LivenessCollectionIndex", 'this api is not supported on this device');
173. }
174. }
176. // 校验CAMERA权限
177. private privateStartDetection() {
178. abilityAccessCtrl.createAtManager().requestPermissionsFromUser(this.context, this.array).then((res) => {
179. for (let i = 0; i < res.permissions.length; i++) {
180. if (res.permissions[i] === "ohos.permission.CAMERA" && res.authResults[i] === 0) {
181. this.privateRouterLibrary();
182. }
183. }
184. }).catch((err: BusinessError) => {
185. hilog.error(0x0001, "LivenessCollectionIndex", `Failed to request permissions from user. Code is ${err.code}, message is ${err.message}`);
186. })
187. }
189. // 获取验证结果
190. private getDetectionResultInfo() {
191. // getInteractiveLivenessResult接口调用完会释放资源
192. if (canIUse("SystemCapability.AI.Component.LivenessDetect")) {
193. let resultInfo = interactiveLiveness.getInteractiveLivenessResult();
194. resultInfo.then(data => {
195. this.resultInfo = data;
196. }).catch((err: BusinessError) => {
197. this.failResult = {
198. "code": err.code,
199. "message": err.message
200. }
201. })
202. } else {
203. hilog.error(0x0001, "LivenessCollectionIndex", 'this api is not supported on this device');
204. }
205. }
207. // result release
208. private resultRelease() {
209. this.resultInfo = {
210. livenessType: 0
211. }
212. this.failResult = {
213. "code": 1008302000,
214. "message": ""
215. }
216. }
217. }