Flutter阿联酋身份验证插件flutter_uae_pass的使用

Flutter阿联酋身份验证插件flutter_uae_pass的使用

概述

flutter_uae_pass 是一个非官方的Flutter插件，用于在Android和iOS平台上集成阿联酋身份验证（UAE Pass）。以下是该插件的使用指南。

开始使用

1. 添加插件到 pubspec.yaml 文件

   flutter_uae_pass: ^0.0.1
   

2. 运行 flutter pub get

   flutter pub get
   

3. 导入包

   import 'package:flutter_uae_pass/uae_pass.dart';
   final _uaePassPlugin = UaePass();
   

4. 初始化插件 - 沙盒环境

   await _uaePassPlugin.setUpSandbox(); // 使用沙盒环境
   

5. 初始化插件 - 生产环境

   await _uaePassPlugin.setUpEnvironment(
     clientId: "<clientId>", // 替换为实际的客户端ID
     clientSecret: "<clientSecret>", // 替换为实际的客户端密钥
     urlScheme: "myappscheme", // 替换为应用的URL Scheme
     redirectUri: "<redirectUri>", // 替换为实际的重定向URI
     isProduction: true, // 设置为生产环境
   );
   

作用域说明

• urn:uae:digitalid:profile:general
• urn:uae:digitalid:profile

主要功能

• signIn()：用户登录
• getAccessToken(String authCode)：获取访问令牌
• getProfile(String token)：获取用户信息
• signOut()：退出登录

调用认证方法

String? authCode = await _uaePassPlugin.signIn(); // 调用登录方法

获取访问令牌

String? accessToken = await _uaePassPlugin.getAccessToken(authCode); // 使用授权码获取访问令牌

获取公共资料数据

你可以从资料中获取以下信息：

• idn
• email
• firstnameAR
• firstnameEN
• fullnameEN
• gender
• lastnameAR
• lastnameEN
• mobile
• nationalityAR
• nationalityEN
• sub
• userType
• uuid

ProfileData? profileData = await _uaePassPlugin.getProfile(accessToken); // 使用访问令牌获取用户信息

iOS设置

1. 在 Info.plist 文件中添加以下内容：

   <key>LSApplicationQueriesSchemes</key>
   <array>
       <string>uaepass</string>
       <string>uaepassqa</string>
       <string>uaepassdev</string>
       <string>uaepassstg</string>
   </array>
   <key>CFBundleURLTypes</key>
   <array>
       <dict>
           <key>CFBundleTypeRole</key>
           <string>Editor</string>
           <key>CFBundleURLName</key>
           <string>myappscheme</string>
           <key>CFBundleURLSchemes</key>
           <array>
               <string>myappscheme</string>
           </array>
       </dict>
   </array>
   

Android设置

1. 更新 android:launchMode="singleTask" 在 AndroidManifest.xml 文件中：

   <activity
       android:name=".MainActivity"
       android:exported="true"
       android:launchMode="singleTask"
       .....
   </activity>
   

2. 在 AndroidManifest.xml 文件中设置查询：

   <queries>
       <package android:name="ae.uaepass.mainapp" />
       <package android:name="ae.uaepass.mainapp.qa" />
       <package android:name="ae.uaepass.mainapp.stg" />
   </queries>
   

3. 在 AndroidManifest.xml 文件中设置意图过滤器：

   <intent-filter >
       <action android:name="android.intent.action.VIEW" />
   
       <category android:name="android.intent.category.DEFAULT" />
       <category android:name="android.intent.category.BROWSABLE" />
   
       <data
           android:host="success"
           android:scheme="myappscheme" />
   
       <data
           android:host="failure"
           android:scheme="myappscheme" />
   </intent-filter>
   

示例代码

以下是一个完整的示例应用程序：

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_uae_pass/uae_pass.dart';

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

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String? authCode;
  String? accessToken;
  ProfileData? profileData;

  final _uaePass = UaePass();

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

    // 初始化生产环境
    _uaePass.setUpEnvironment(
      clientId: "<clientId>",
      clientSecret: "<clientSecret>",
      urlScheme: "myappscheme",
      redirectUri: "<redirectUri>",
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('UAE Pass'),
          centerTitle: true,
        ),
        body: Center(
          child: Column(
            mainAxisSize: MainAxisSize.min,
            crossAxisAlignment: CrossAxisAlignment.center,
            children: [
              MaterialButton(
                onPressed: () => login(),
                child: const Text('Sign in with UAE Pass'),
              ),
              const SizedBox(height: 100),
              if (authCode != null)
                ListTile(
                  title: const Text('Auth Code'),
                  subtitle: Text('${authCode?.substring(0, 6)}............'),
                ),
              if (accessToken != null)
                ListTile(
                  title: const Text('Access Token'),
                  subtitle: Text('${accessToken?.substring(0, 6)}............'),
                ),
              if (profileData != null)
                Column(
                  children: [
                    ListTile(
                      title: const Text('Emirates Id'),
                      subtitle: Text(profileData?.idn ?? ""),
                    ),
                    ListTile(
                      title: const Text('Full Name EN'),
                      subtitle: Text(profileData?.fullnameEN ?? ""),
                    ),
                    ListTile(
                      title: const Text('Full Name AR'),
                      subtitle: Text(profileData?.fullnameAR ?? ""),
                    ),
                    ListTile(
                      title: const Text('Mobile'),
                      subtitle: Text(profileData?.mobile ?? ""),
                    ),
                    ListTile(
                      title: const Text('Nationality EN'),
                      subtitle: Text(profileData?.nationalityEN ?? ""),
                    ),
                  ],
                ),
            ],
          ),
        ),
      ),
    );
  }

  Future<void> login() async {
    authCode = null;
    accessToken = null;
    profileData = null;
    setState(() {});
    try {
      authCode = await _uaePass.signIn(); // 登录并获取授权码
      accessToken = await _uaePass.getAccessToken(authCode ?? ""); // 使用授权码获取访问令牌
      profileData = await _uaePass.getProfile(accessToken ?? ""); // 使用访问令牌获取用户信息

      setState(() {});
    } catch (e) {
      if (kDebugMode) {
        print(e.toString()); // 打印错误信息
      }
    }
    setState(() {});
  }
}