Flutter身份验证插件jumio_mobile_sdk_flutter的使用

插件概述

jumio_mobile_sdk_flutter 是Jumio官方为Flutter提供的移动SDK插件，用于实现身份验证功能。此插件与Jumio SDK iOS 4.12.0和Jumio SDK Android 4.12.1兼容。如果您有任何问题，请联系您的客户经理或Jumio支持。

目录

• 兼容性
• 设置
• 集成
  • iOS
  • Android
  • Proguard
• 使用
  • 获取信息
• 自定义
• 配置
• 回调
• 结果对象
• 本地模型
• 常见问题
• 支持

兼容性

该插件已在Flutter版本3.27.1和Dart 3.6.0上进行了测试。

设置

创建Flutter项目并添加Jumio Mobile SDK模块

flutter create MyProject

添加依赖项

在pubspec.yaml文件中添加Jumio Mobile SDK依赖项：

dependencies:
  flutter:
    sdk: flutter

  jumio_mobile_sdk_flutter: ^4.12.0

安装依赖项：

cd MyProject
flutter pub get
cd ios && pod install

集成

iOS

Info.plist配置

1. 在Info.plist文件中添加NSCameraUsageDescription键。
2. 确保应用的部署目标至少为iOS 11.0。

NFC、Digital Identity 和 Device Risk

• 参考NFC setup guide。
• 参考Digital Identity setup guide。
• 若要包含Device Risk功能，在Podfile中添加pod Jumio/DeviceRisk。

Android

AndroidManifest.xml配置

打开AndroidManifest.xml文件并将allowBackup设置为false：

<application>
...
android:allowBackup="false">
</application>
...

确保compileSdkVersion、minSdkVersion和buildToolsVersion足够高：

android {
  minSdkVersion 21
  compileSdkVersion 33
  buildToolsVersion "32.0.0"
  ...
}

启用MultiDex

参考Android开发者指南启用MultiDex：

android {
  ...
  defaultConfig {
    ...
    multiDexEnabled true
  }
}

升级Gradle构建工具

插件要求至少使用8.0.0版本的Android构建工具，这需要升级Gradle包装器到版本8并更新到Java 11。

在android/build.gradle中升级构建工具版本：

buildscript {
  ...
  dependencies {
    ...
    classpath 'com.android.tools.build:gradle:8.2.2'
  }
}

在android/gradle.wrapper/gradle-wrapper.properties中修改Gradle Wrapper版本：

...
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip

Proguard规则

参考Android guides了解有关Jumio SDK的Android Proguard规则信息。

为了启用分析反馈和内部诊断，请确保在Proguard规则中包含以下行：

-keep class io.flutter.embedding.android.FlutterActivity

使用

导入库

import 'package:jumio_mobile_sdk_flutter/jumio_mobile_sdk_flutter.dart';

初始化SDK

Jumio.init("AUTHORIZATION_TOKEN", "DATACENTER");

DATACENTER可以是US、EU或SG。有关如何获取AUTHORIZATION_TOKEN的信息，请参考API Guide。

启动SDK

Jumio.start();

获取信息

扫描结果将异步返回。可以通过await获取结果。如果发生问题（如无效凭据、缺少API密钥、权限错误等），会抛出异常。

自定义

Android

通过覆盖自定义主题AppThemeCustomJumio来自定义JumioSDK Android外观。可以在styles.xml中找到所有可自定义值的例子。

iOS

可以基于设备的外观设置（深色模式或浅色模式）自定义每个颜色，也可以为两种外观设置一个单一颜色。可以在启动时传递自定义选项。

例如，设置基于深色或浅色模式的颜色：

Jumio.start({
    "primaryColor": { light:"ffffff", dark:"000000" },
    "primaryButtonBackground": { light:"ffffff", dark:"000000" }
});

设置相同颜色用于深色和浅色模式：

Jumio.start({
    "primaryColor": "ffffff",
    "primaryButtonBackground": "ffffff"
});

所有颜色都以HEX字符串提供，格式为#ff00ff或#66ff00ff（如果要设置透明度级别）。

配置

有关如何设置特定的SDK参数（如callbackUrl、userReference、country等），请参考API Guide。

回调

有关结果字段、检索API、删除API、全局设置等信息，请阅读服务器相关信息页面。

结果对象

JumioSDK将在工作流成功完成后返回EventResult，在出现错误时返回EventError。EventError包括错误代码和错误消息。

EventResult

MRZ-Data

本地模型

我们的SDK需要几个机器学习模型来最佳工作。我们建议下载这些文件并将其添加到项目中而不更改其名称（类似于添加本地化文件）。这将在运行时节省两个网络请求以下载这些文件。

预加载模型

可以在初始化Jumio SDK之前预加载ML模型。为此，设置完成块JumioMobileSDK.setPreloaderFinishedBlock并使用JumioMobileSDK.preloadIfNeeded开始预加载。

iOS

可以在Bundling models in the app部分找到模型，并将其复制到ios/Assets文件夹中。

Android

可以在Bundling models in the app部分找到模型，并将其复制到app/src/main/assets/文件夹中。

常见问题

Android面帮助动画在发布版本中损坏

如果面帮助动画在调试版本中看起来正常但在发布版本中损坏，请确保在Proguard文件中包含以下规则：

-keep class androidx.constraintlayout.motion.widget.** { *; }

iOS模拟器显示白屏

Jumio SDK不支持iOS模拟器。请仅在物理设备上运行Jumio SDK。

iOS调试版本运行正常但发布版本崩溃

这是由于Xcode 13引入了新的选项“管理版本和构建号”。请确保禁用此选项。或者，可以在exportOptions.plist中设置manageAppVersionAndBuildNumber为false。

iOS应用启动时崩溃

如果iOS应用程序在启动时立即崩溃且没有其他信息，但Android正常工作，请确保在Podfile中添加以下行：

post_install do |installer|
    installer.pods_project.targets.each do |target|
      if ['iProov', 'DatadogRUM', 'DatadogCore', 'DatadogInternal'].include? target.name
        target.build_configurations.each do |config|
          config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
        end
      end
    end
end

对于Xcode 15及以上版本，请确保在Podfile中添加以下行：

post_install do |installer|
    installer.pods_project.targets.each do |target|
      if ['iProov', 'DatadogRUM', 'DatadogCore', 'DatadogInternal'].include? target.name
        target.build_configurations.each do |config|
          config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '12.0'
        end
      end
    end
end

Android发布版本国家列表为空

如果Android发布版本中的国家列表为空，请确保应用程序具有适当的互联网权限。如果没有有效的网络连接，国家不会加载，列表将保持为空。如果需要，请在AndroidManifest.xml文件中添加android.permission.INTERNET权限。

支持

如果您有任何问题，请联系Jumio客户服务：support@jumio.com或访问支持页面。

示例代码

以下是一个完整的示例demo，展示了如何在Flutter应用中使用jumio_mobile_sdk_flutter插件进行身份验证。

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

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

class DemoApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: HomePage(title: "Mobile SDK Demo App"),
    );
  }
}

class HomePage extends StatefulWidget {
  final String? title;

  HomePage({Key? key, this.title}) : super(key: key);

  @override
  State<StatefulWidget> createState() => _HomePageState(title);
}

class _HomePageState extends State<HomePage> {
  final String? title;
  final tokenInputController = TextEditingController();
  bool pressedUS = false;
  bool pressedEU = false;
  bool pressedSGP = false;

  _HomePageState(this.title);

  @override
  void initState() {
    super.initState();
    initModelPreloading();
  }

  void initModelPreloading() {
    Jumio.setPreloaderFinishedBlock(() {
      print('All models are preloaded. You may start the SDK now!');
    });
    Jumio.preloadIfNeeded();
  }

  @override
  void dispose() {
    tokenInputController.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(title!),
      ),
      body: Center(
        child: IntrinsicWidth(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            crossAxisAlignment: CrossAxisAlignment.stretch,
            children: <Widget>[
              Container(
                width: 250.0,
                child: TextFormField(
                  controller: tokenInputController,
                  decoration: InputDecoration(
                    border: UnderlineInputBorder(),
                    labelText: 'Authorization token',
                  ),
                ),
              ),
              ElevatedButton(
                child: Text("Start"),
                onPressed: () {
                  _start(tokenInputController.text);
                },
              ),
              ElevatedButton(
                child: Text("US"),
                style: ElevatedButton.styleFrom(
                  backgroundColor: pressedUS ? Colors.yellow : Colors.blue,
                  foregroundColor: Colors.white,
                ),
                onPressed: () => {
                  setState(() {
                    pressedUS = !pressedUS;
                    pressedEU = false;
                    pressedSGP = false;
                  }),
                  DATACENTER = 'US',
                },
              ),
              ElevatedButton(
                child: Text("EU"),
                style: ElevatedButton.styleFrom(
                  backgroundColor: pressedEU ? Colors.yellow : Colors.blue,
                  foregroundColor: Colors.white,
                ),
                onPressed: () => {
                  setState(() {
                    pressedEU = !pressedEU;
                    pressedUS = false;
                    pressedSGP = false;
                  }),
                  DATACENTER = 'EU',
                },
              ),
              ElevatedButton(
                child: Text("SG"),
                style: ElevatedButton.styleFrom(
                  backgroundColor: pressedSGP ? Colors.yellow : Colors.blue,
                  foregroundColor: Colors.white,
                ),
                onPressed: () => {
                  setState(() {
                    pressedSGP = !pressedSGP;
                    pressedUS = false;
                    pressedEU = false;
                  }),
                  DATACENTER = 'SG',
                },
              ),
            ],
          ),
        ),
      ),
    );
  }

  Future<void> _start(String authorizationToken) async {
    await _logErrors(() async {
      await Jumio.init(authorizationToken, DATACENTER);
      final result = await Jumio.start(
        {
          // "background": "#AC3D9A",
          // "primaryColor": "#FF5722",
          // "loadingCircleIcon": "#F2F233",
          // "loadingCirclePlain": "#57ffc7",
          // "loadingCircleGradientStart": "#EC407A",
          // "loadingCircleGradientEnd": "#bc2e41",
          // "loadingErrorCircleGradientStart": "#AC3D9A",
          // "loadingErrorCircleGradientEnd": "#C31322",
          // "primaryButtonBackground": {"light": "#D900ff00", "dark": "#9Edd9E"}
        }
      );
      await _showDialogWithMessage("Jumio has completed. Result: $result");
    });
  }

  Future<void> _logErrors(Future<void> Function() block) async {
    try {
      await block();
    } catch (error) {
      await _showDialogWithMessage(error.toString(), "Error");
    }
  }

  Future<void> _showDialogWithMessage(String message, [String title = "Result"]) async {
    return showDialog<void>(
      context: context,
      barrierDismissible: false,
      builder: (BuildContext context) {
        return AlertDialog(
          title: Text(title),
          content: SingleChildScrollView(child: Text(message)),
          actions: <Widget>[
            TextButton(
              child: Text('OK'),
              onPressed: () {
                Navigator.of(context).pop();
              },
            ),
          ],
        );
      },
    );
  }
}

希望这个详细的指南能帮助您顺利集成和使用jumio_mobile_sdk_flutter插件。如果有任何问题，请随时联系Jumio支持团队。