Flutter文档扫描插件authenteq_flow_docscanner的使用

Flutter文档扫描插件authenteq_flow_docscanner的使用

介绍

authenteq_flow_docscanner 是一个用于在 Flutter 应用中集成文档扫描功能的插件。它允许用户通过简单的操作完成文档的识别和验证。

示例代码

import 'package:flutter/material.dart';
import 'dart:async';
import 'package:authenteq_flow/authenteq_flow.dart';
import 'package:authenteq_flow/models/IdentificationParameters.dart';
import 'package:authenteq_flow/models/IdentificationResult.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _version = '未知'; // SDK版本
  dynamic _identificationResult;
  Exception? _exception;

  @override
  void initState() {
    super.initState();
    loadSdkVersion(); // 加载SDK版本
  }

  Future<void> loadSdkVersion() async {
    String version;
    try {
      version = await AuthenteqFlow.getVersion;
    } on Exception {
      version = '获取SDK版本失败。';
    }

    if (!mounted) return;

    setState(() {
      _version = version;
    });
  }

  Future<void> startIdentification() async {
    IdentificationResult? result;
    Exception? exception;
    try {
      IdentificationParameters parameters = IdentificationParameters();
      parameters.clientId = '<我的客户端ID>'; // 客户端ID
      parameters.clientSecret = '<我的密钥>'; // 密钥
      parameters.theme = {
        'primaryColor': '#00a2ff', // 主颜色
        'AndroidStyle': 'AuthenteqCustom', // Android样式
        'identificationInstructionImageForDriverLicense': 'graphics/driver.png' // 驾驶证识别说明图
      };
      result = await AuthenteqFlow.identification(parameters);
    } on Exception catch(e) {
      exception = e;
    }

    setState(() {
      _identificationResult = result;
      _exception = exception;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Authenteq Flow 插件示例'),
        ),
        body: Center(
          child: Column(
            crossAxisAlignment: CrossAxisAlignment.center,
            children: [
              const Spacer(),
              ElevatedButton(
                onPressed: () {
                  startIdentification(); // 开始识别
                },
                child: const Text('开始识别'),
              ),
              Text('正在运行的 Authenteq SDK 版本: $_version\n'), // 当前SDK版本
              const Spacer(),
              exceptionWidget(), // 异常处理
              resultWidget(), // 识别结果
            ],
          ),
        ),
      ),
    );
  }

  Widget exceptionWidget() {
    return _exception == null ? Container() : Text(_exception.toString(), style: const TextStyle(color: Colors.red)); // 显示异常信息
  }

  Widget resultWidget() {
    return _identificationResult == null ? Container() : Text(
        "验证ID: ${_identificationResult.verificationId}" // 显示识别结果
    );
  }
}

使用步骤

1. 初始化项目: 创建一个新的 Flutter 项目，并在 pubspec.yaml 文件中添加依赖：

   dependencies:
     flutter:
       sdk: flutter
     authenteq_flow: ^1.0.0 # 根据实际版本号进行替换
   

2. 导入库: 在 main.dart 文件中导入必要的库：

   import 'package:flutter/material.dart';
   import 'dart:async';
   import 'package:authenteq_flow/authenteq_flow.dart';
   import 'package:authenteq_flow/models/IdentificationParameters.dart';
   import 'package:authenteq_flow/models/IdentificationResult.dart';
   

3. 配置参数: 设置 IdentificationParameters 对象，包括客户端ID、密钥和其他自定义主题设置。

   IdentificationParameters parameters = IdentificationParameters();
   parameters.clientId = '<我的客户端ID>';
   parameters.clientSecret = '<我的密钥>';
   parameters.theme = {
     'primaryColor': '#00a2ff',
     'AndroidStyle': 'AuthenteqCustom',
     'identificationInstructionImageForDriverLicense': 'graphics/driver.png'
   };
   

4. 启动识别: 调用 startIdentification() 方法来启动文档识别流程。

   Future<void> startIdentification() async {
     IdentificationResult? result;
     Exception? exception;
     try {
       result = await AuthenteqFlow.identification(parameters);
     } on Exception catch(e) {
       exception = e;
     }
   
     setState(() {
       _identificationResult = result;
       _exception = exception;
     });
   }
   

5. 展示结果: 在界面上展示识别结果或异常信息。

   Widget exceptionWidget() {
     return _exception == null ? Container() : Text(_exception.toString(), style: const TextStyle(color: Colors.red));
   }
   
   Widget resultWidget() {
     return _identificationResult == null ? Container() : Text(
         "验证ID: ${_identificationResult.verificationId}"
     );
   }