FaceAuthenticator - Flutter 插件

FaceAuthenticator 使用指南

FaceAuthenticator 是一个用于调用 Android 和 iOS 原生 SDK 的 Flutter 插件。如果您有任何疑问，请发送邮件至我们的移动开发负责人邮箱：daniel.seitenfus@combateafraude.com。

隐私政策与使用条款

在使用本插件时，请确保您已同意我们的隐私政策和使用条款。

系统要求

以下是使用 FaceAuthenticator 所需的最低配置：

如果您的 Dart 版本低于 2.12，请检查兼容版本。

配置步骤

Android 配置

在文件 ROOT_PROJECT/android/app/build.gradle 中添加以下内容：

android {
    ...
    dataBinding.enabled = true
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
}

iOS 配置

在文件 ROOT_PROJECT/ios/Podfile 中添加以下内容：

source 'https://github.com/combateafraude/iOS.git'
source 'https://cdn.cocoapods.org/' # 或者 'https://github.com/CocoaPods/Specs' 如果 CDN 不可用

最后，在文件 ROOT_PROJECT/ios/Runner/Info.plist 中添加相机权限：

<key>NSCameraUsageDescription</key>
<string>为了拍摄自拍</string>

Flutter 配置

在 ROOT_PROJECT/pubspec.yaml 文件中添加插件依赖：

dependencies:  
  face_authenticator:
    git:
      url: https://github.com/combateafraude/Flutter.git
      ref: face-authenticator-v3.9.0

使用示例

以下是一个完整的使用示例，展示如何通过 FaceAuthenticator 进行面部认证。

import 'package:face_authenticator/face_authenticator.dart';
import 'package:face_authenticator/result/face_authenticator_failure.dart';
import 'package:face_authenticator/result/face_authenticator_result.dart';
import 'package:face_authenticator/result/face_authenticator_success.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:permission_handler/permission_handler.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _result = ""; // 结果存储
  String _description = ""; // 描述信息存储

  String mobileToken = ""; // 移动端令牌
  String peopleId = ""; // 用户唯一标识（如身份证号）

  [@override](/user/override)
  void initState() {
    super.initState();

    // 请求权限
    requestPermissions();
  }

  void requestPermissions() async {
    await [
      Permission.camera,
    ].request();
  }

  void startFaceAuthenticator() async {
    String result = "";
    String description = "";

    // 初始化 FaceAuthenticator
    FaceAuthenticator faceAuthenticator =
        new FaceAuthenticator(mobileToken: mobileToken);
    faceAuthenticator.setPeopleId(peopleId);

    try {
      // 启动面部认证
      FaceAuthenticatorResult faceAuthenticatorResult =
          await faceAuthenticator.start();

      // 处理结果
      if (faceAuthenticatorResult is FaceAuthenticatorSuccess) {
        result = "Success!";
        description += "\n\tauthenticated: " +
            (faceAuthenticatorResult.authenticated ? "true" : "false") +
            "\n\tsignedResponse: " +
            (faceAuthenticatorResult.signedResponse != null
                ? faceAuthenticatorResult.signedResponse
                : "null");
      } else if (faceAuthenticatorResult is FaceAuthenticatorFailure) {
        result = "Falha!";
        description = "\tType: " +
            faceAuthenticatorResult.type +
            "\n\tMessage: " +
            faceAuthenticatorResult.message;
      } else {
        result = "Closed!";
      }
    } on PlatformException catch (err) {
      result = "Exception!";
      description = err.message;
    }

    // 更新 UI
    if (!mounted) return;

    setState(() {
      _result = result;
      _description = description;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('FaceAuthenticator 插件示例'),
        ),
        body: Container(
          margin: const EdgeInsets.all(20.0),
          child: Column(
            children: [
              // 开始面部认证按钮
              Row(
                children: [
                  ElevatedButton(
                    child: Text('开始面部认证'),
                    onPressed: () async {
                      startFaceAuthenticator();
                    },
                  )
                ],
              ),
              // 显示结果
              Row(
                children: [
                  Container(
                    margin: EdgeInsets.only(top: 10.0),
                    child: Text("结果: $_result"),
                  )
                ],
              ),
              // 显示描述信息
              Row(
                mainAxisAlignment: MainAxisAlignment.spaceBetween,
                children: [
                  Expanded(
                    child: Text(
                      "描述:\n$_description",
                      overflow: TextOverflow.clip,
                    ),
                  )
                ],
              ),
            ],
          ),
        ),
      ),
    );
  }
}