Skip to content
/ flutter_biometric Public

这是一个 Flutter 生物识别插件，提供指纹识别和管理功能。该插件封装了原生 Android 的生物识别 API，使得 Flutter 应用可以轻松实现指纹识别和管理功能。

License

View license
0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

lizy-coding/flutter_biometric

BranchesTags

Repository files navigation

Flutter 生物识别模块

example

使用的插件

本项目使用以下插件：

插件名称 版本 用途
local_auth ^2.3.0 生物识别认证（指纹、面容）
connectivity_plus ^5.0.2 网络连接状态监测
flutter_blue_plus ^1.10.1 蓝牙状态检测

包结构（lib/）

lib/
├── flutter_biometric.dart                # 插件主入口
├── flutter_biometric_method_channel.dart # MethodChannel 实现
├── flutter_biometric_platform_interface.dart # 平台接口定义
├── connectivity_service.dart             # 网络和蓝牙连接服务
└── src/
    ├── flutter_biometric.dart            # 结构导出
    ├── biometric/
    │   ├── biometric_manager.dart        # 生物识别业务管理
    │   └── biometric_service.dart        # 生物识别服务封装
    ├── face/
    │   ├── face_manager.dart             # 人脸业务管理
    │   ├── face_service.dart             # 人脸原生通信
    │   ├── face_preview_manager.dart     # 人脸预览管理
    │   ├── face_preview_page.dart        # 人脸预览页面
    │   ├── face_mask_overlay.dart        # 人脸遮罩组件
    │   └── face_image_output.dart        # 人脸图片输出
    ├── ui/
    │   ├── face_preview_page.dart        # UI: 人脸预览页面（可选）
    │   ├── face_mask_overlay.dart        # UI: 遮罩组件（可选）
    │   ├── face_capture_page.dart        # UI: 人脸采集页面
    │   ├── face_circle_painter.dart      # UI: 圆形区域绘制
    │   └── fingerprint_management_page.dart # UI: 指纹管理页面
    └── utils/
        └── biometric_utils.dart          # 工具类

快速开始

  1. 在 pubspec.yaml 添加依赖：
flutter_biometric:
  1. 导入包：
import 'package:flutter_biometric/flutter_biometric.dart';

API 调用示例

检查生物识别支持

final status = await BiometricManager().checkBiometricStatus();
if (status == BiometricStatus.available) {
  // 支持生物识别
}

发起生物识别认证（指纹/人脸）

final result = await BiometricManager().authenticate(reason: '请验证身份');
if (result) {
  // 验证成功
}

指纹数据管理

// 获取指纹数量
final count = await BiometricManager().getFingerprintCount();
// 添加指纹
final ok = await BiometricManager().addFingerprint(fingerprintHash: 'your_hash');
// 删除指纹
await BiometricManager().deleteFingerprint(0);
// 清空所有指纹
await BiometricManager().clearAllFingerprints();

启动/停止人脸预览

final textureId = await FacePreviewManager().startFacePreview();
// 渲染预览：Texture(textureId: textureId)
await FacePreviewManager().stopFacePreview();

人脸预览页面

Navigator.push(
  context,
  MaterialPageRoute(builder: (_) => FacePreviewPage(
    onResult: (success) { /* 验证结果处理 */ },
    onCancel: () { /* 取消回调 */ },
  )),
);

架构分层说明

  • Service 层：如 face_service.dart，负责与原生通信（MethodChannel）。
  • Manager 层：如 biometric_manager.dart、face_manager.dart，负责业务流程、状态管理。
  • UI 层：如 face_preview_page.dart、face_mask_overlay.dart，负责 Flutter 页面与组件。
  • 原生实现：Android 端如 FacePreviewHandler.kt，负责 CameraX 采集、指纹/人脸原生 API 封装。

功能流程图

指纹识别流程

sequenceDiagram
    participant UI as Flutter UI
    participant BM as BiometricManager
    participant BS as BiometricService
    participant MC as MethodChannel
    participant BP as FlutterBiometricPlugin
    participant BA as BiometricAuth
    participant FM as FingerprintManager
    participant DS as FingerprintDataStore
    
    UI->>BM: authenticate(reason)
    BM->>BS: authenticate(localizedReason)
    BS->>MC: 调用local_auth库进行生物识别
    MC->>BP: 通过MethodChannel调用原生方法
    BP->>BA: authenticate(title, subtitle)
    BA->>BP: 显示生物识别对话框
    BP->>UI: 返回验证结果(success/failure)
    
    Note over UI,DS: 指纹数据管理流程
    
    UI->>BM: addFingerprint(fingerprintHash)
    BM->>BS: authenticate(reason)
    BS-->>BM: 验证成功
    BM->>MC: addFingerprint(fingerprintHash)
    MC->>BP: 通过MethodChannel调用原生方法
    BP->>FM: addFingerprint(context, hash)
    FM->>DS: 存储指纹数据
    DS-->>FM: 存储结果
    FM-->>BP: 返回添加结果
    BP-->>UI: 返回操作结果
Loading

Flutter图像渲染与Android交互流程

sequenceDiagram
    participant UI as Flutter UI
    participant FPP as FacePreviewPage
    participant FPM as FacePreviewManager
    participant MC as MethodChannel
    participant BP as FlutterBiometricPlugin
    participant FPH as FacePreviewHandler
    participant CX as CameraX
    
    UI->>FPP: 打开人脸预览页面
    FPP->>FPM: startFacePreview(quality)
    FPM->>MC: 通过face_channel调用startFacePreview
    MC->>BP: 调用原生方法
    BP->>FPH: 创建FacePreviewHandler实例
    FPH->>CX: 配置相机预览
    CX->>FPH: 返回SurfaceTexture
    FPH->>BP: 返回textureId
    BP->>MC: 返回textureId给Flutter
    MC->>FPM: 返回textureId
    FPM->>FPP: 返回textureId
    FPP->>UI: 使用Texture(textureId)渲染预览
    
    Note over UI,CX: 停止预览流程
    
    UI->>FPP: 页面关闭/退出
    FPP->>FPM: stopFacePreview()
    FPM->>MC: 通过face_channel调用stopFacePreview
    MC->>BP: 调用原生方法
    BP->>FPH: stopPreview()
    FPH->>CX: 释放相机资源
    FPH->>BP: 释放Surface和纹理
    BP->>MC: 返回结果
    MC->>FPM: 返回结果
    FPM->>FPP: 清理资源
Loading

功能特性

  • 生物识别验证（指纹/面部）
  • 指纹数据管理（添加/删除/验证）
  • 原生指纹管理界面
  • 测试功能支持
  • 指纹验证成功后自动播放烟花动画（纯 Flutter 绘制，无需外部资源）
  • 人脸预览与验证（原生采集，Flutter 渲染圆形遮罩）
  • Network connectivity status monitoring
  • Bluetooth status monitoring

人脸识别/预览功能说明

  • 启动与停止：

    • Flutter 调用 FacePreviewManager.startFacePreview() 或通过 UI 页面 FacePreviewPage 自动调用，原生 Android 启动摄像头采集并返回 TextureId。
    • Flutter 通过 Texture(textureId: ...) 组件渲染预览画面。
    • 调用 FacePreviewManager.stopFacePreview() 或页面退出时自动释放资源。

  • 验证流程：

    • 用户点击页面"开始验证"按钮时，Flutter 调用 FlutterBiometricPlugin 插件方法 verifyFace()，目前默认返回 true，可集成实际人脸检测逻辑。

  • 分层结构：

    • Service 层：lib/src/face/face_service.dart，负责与原生通信。
    • Manager 层：lib/src/face/face_manager.dart、lib/src/face/face_preview_manager.dart，管理业务流程。
    • UI 层：lib/src/face/face_preview_page.dart 页面与 lib/src/face/face_mask_overlay.dart 遮罩组件。

  • 原生实现：

    • Android 端：android/src/main/kotlin/com/example/flutter_biometric/FacePreviewHandler.kt，使用 CameraX 输出 SurfaceTexture，通过 face_channel 返回 TextureId。

示例代码

// 使用 FacePreviewPage 页面
Navigator.push(
  context,
  MaterialPageRoute(builder: (_) => FacePreviewPage(
    onResult: (success) { /* 验证结果处理 */ },
    onCancel: () { /* 取消回调 */ },
  )),
);

遮罩组件示例

FaceMaskOverlay(
  size: 280,
  borderColor: Colors.white,
  borderWidth: 3,
  maskColor: Colors.black54,
  hintText: '请将脸部放在框内',
),

Connectivity Monitoring

import 'package:flutter_biometric/connectivity_service.dart';

final connectivity = ConnectivityService();

// Check network status
bool isNetworkAvailable = await connectivity.isNetworkAvailable();

// Check Bluetooth status
bool isBluetoothAvailable = await connectivity.isBluetoothAvailable();

Example App

The example app demonstrates both biometric authentication and connectivity monitoring:

  • Shows current network status (available/unavailable)
  • Shows current Bluetooth status (available/unavailable)
  • Updates in real-time when connectivity changes
  • Manual refresh button to check current status

其他功能与架构请参考原有文档

About

这是一个 Flutter 生物识别插件，提供指纹识别和管理功能。该插件封装了原生 Android 的生物识别 API，使得 Flutter 应用可以轻松实现指纹识别和管理功能。

Resources

Readme

License

View license
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages