Flutter插件truora_sdk的介绍与使用方法详解

Truora SDK for Flutter

一个为Flutter应用程序集成Truora数字身份（DI）的功能插件。此包包含类和协议以启动身份验证流程并处理其结果。

设置

创建Flutter项目并添加Truora SDK依赖项。

创建Flutter项目

flutter create MyApp

添加依赖

cd MyApp
flutter pub add truora_sdk

iOS配置

通过根据您的流程所需验证类型添加相应的权限来适配Info.plist文件：

• 如果需要使用相机，则添加NSCameraUsageDesscription。
• 如果需要地理定位验证，则添加NSLocationWhenInUseUsageDescription。
• 如果在文档验证中允许上传相册文件，则添加NSPhotoLibraryUsageDescription。

同时，在Podfile文件中添加以下内容：

post_install do |installer|
  installer.pods_project.targets.each do |target|
    flutter_additional_ios_build_settings(target)

    target.build_configurations.each do |config|
      config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
        '$(inherited)',

        ## dart: PermissionGroup.camera
        'PERMISSION_CAMERA=1',

        ## dart: PermissionGroup.photos
        'PERMISSION_PHOTOS=1',

        ## dart: [PermissionGroup.location, PermissionGroup.locationAlways, PermissionGroup.locationWhenInUse]
        'PERMISSION_LOCATION=1',
      ]
    end
  end
end

注意：仅添加实际使用的权限。

然后运行以下命令更新Pods：

cd ios && pod install

Android配置

通过根据您的流程所需验证类型添加相应的权限来适配AndroidManifest.xml文件：

• 如果需要使用相机，添加以下内容：

<uses-feature android:name="android.hardware.camera" android:required="true" />

<uses-permission android:name="android.permission.CAMERA" />

• 如果需要地理定位验证，添加以下内容：

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

• 如果在文档验证中允许上传相册文件，添加以下内容：

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

如何使用

在build()方法中，TruoraSDK小部件配置了多个属性：

• token:
  这是用于授权和启动身份验证过程的API令牌。

• requiredPermissions:
  该列表包含SDK所需的权限。可能的权限包括：

  • TruoraPermission.camera: 用于身份验证时访问相机。
  • TruoraPermission.location: 用于地理位置验证时访问位置。
  • TruoraPermission.photos: 用于文档验证时访问相册上传照片。

• 回调函数:
  TruoraSDK允许您处理错误、步骤完成、成功和失败等事件。

  • onError: 如果过程中发生错误，将触发此回调。
  • onStepsCompleted: 当身份验证步骤完成时，将调用此回调。
  • onProcessSucceeded: 如果身份验证成功，将触发此回调。
  • onProcessFailed: 如果身份验证失败，将调用此回调。

例如：

[@override](/user/override)
Widget build(BuildContext context) {
  return Scaffold(
    body: TruoraSDK(
        token: 'replace_me',

        // 添加需要的权限
        requiredPermissions: const [
          TruoraPermission.camera,
          TruoraPermission.location
        ],

        onError: (errorMessage) {
          _showErrorDialog(context, errorMessage);
        },

        onStepsCompleted: (processID) {
          _navigateToResultsPage('completed', processID, context);
        },

        onProcessSucceeded: (processID) {
          _navigateToResultsPage('success', processID, context);
        },

        onProcessFailed: (processID) {
          _navigateToResultsPage('failure', processID, context);
        }),
  );
}

示例代码

以下是一个完整的示例代码，展示了如何在Flutter应用中使用Truora SDK。

示例代码

import 'package:flutter/material.dart';
import 'package:truora_sdk/truora_sdk.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Truora SDK Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const TruoraWebViewPage(),
    );
  }
}

class TruoraWebViewPage extends StatefulWidget {
  const TruoraWebViewPage({super.key});

  [@override](/user/override)
  _TruoraWebViewPageState createState() => _TruoraWebViewPageState();
}

class _TruoraWebViewPageState extends State<TruoraWebViewPage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('身份验证'),
      ),
      body: TruoraSDK(
        token: 'replace_me',
        requiredPermissions: const [
          TruoraPermission.camera,
          TruoraPermission.location
        ],
        onError: (errorMessage) {
          _showAlertDialog(context, '错误', errorMessage);
        },
        onStepsCompleted: (processID) {
          _showAlertDialog(
              context, '步骤完成', '进程ID: $processID');
        },
        onProcessSucceeded: (processID) {
          _showAlertDialog(
              context, '验证成功', '进程ID: $processID');
        },
        onProcessFailed: (processID) {
          _showAlertDialog(context, '验证失败', '进程ID: $processID');
        },
      ),
    );
  }

  void _showAlertDialog(BuildContext context, String title, String message) {
    showDialog(
      context: context,
      builder: (BuildContext context) {
        return AlertDialog(
          title: Text(title),
          content: Text(message),
          actions: [
            TextButton(
              child: const Text('确定'),
              onPressed: () {
                Navigator.of(context).pop();
              },
            ),
          ],
        );
      },
    );
  }
}