Flutter身份验证插件uaepass_api的使用

uaepass_api 是一个非官方的Flutter包，用于支持UAE PASS的身份验证功能。它易于使用，并且支持应用已安装和未安装场景，具有全屏窗口模式、空安全等特性。

为什么选择 uaepass_api?

• 🚀 简单易用
• ⚡ 全屏窗口
• ❤ 支持应用已安装场景
• ❤ 支持应用未安装场景
• 🛡️ 空安全

开始使用

添加依赖

首先，在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  flutter:
    sdk: flutter
  uaepass_api: ^1.0.3

然后运行以下命令来获取包：

flutter pub get

导入包

在你的Dart文件中导入 uaepass_api 包：

import 'package:uaepass_api/uaepass_api.dart';

初始化 UaePassAPI 实例：

UaePassAPI uaePassAPI = UaePassAPI(
    clientId: "<clientId>",
    redirectUri: "<redirectUri>",
    clientSecrete: "<clientSecrete>",
    appScheme: "<Your App Scheme>",
    language: "en",
    isProduction: false);

获取用户代码

调用 signIn 方法来获取用户的授权码：

String? code = await uaePassAPI.signIn(context);

获取访问令牌

使用授权码换取访问令牌：

String? token = await uaePassAPI.getAccessToken(code);

获取用户信息

通过访问令牌获取用户信息：

UAEPASSUserProfile? userProfile = await uaePassAPI.getUserProfile(token);

登出

调用 logout 方法进行登出操作：

await uaePassAPI.logout(context);

iOS 设置

在 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>Your App URL Scheme here</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>Your App URL Scheme here</string>
    </array>
  </dict>
</array>

Android 设置

在 AndroidManifest.xml 文件中更新以下内容：

<activity
    android:name=".MainActivity"
    android:exported="true"
    android:launchMode="singleTask"
    android:theme="@style/LaunchTheme"
    android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
    android:hardwareAccelerated="true"
    android:windowSoftInputMode="adjustResize">
    ...
    <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="<Your App Scheme>" />
        <data
            android:host="failure"
            android:scheme="<Your App Scheme>" />
    </intent-filter>
</activity>

如果遇到Kotlin错误，请在 build.gradle 文件中添加以下内容：

buildscript {
    ext.kotlin_version = '1.7.10'
}

示例代码

以下是完整的示例代码，展示了如何在Flutter应用中集成 uaepass_api：

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

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'UAE PASS Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'UAE PASS Demo'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String? _token;
  UAEPASSUserProfile? _user;

  void _loginOrLogout() async {
    UaePassAPI uaePassAPI = UaePassAPI(
        clientId: "sandbox_stage",
        redirectUri: "https://oauthtest.com/authorization/return",
        clientSecrete: "sandbox_stage",
        appScheme: "exampleScheme",
        isProduction: false);

    try {
      if (_token != null) {
        await uaePassAPI.logout(context);
        _token = null;
        _user = null;
        setState(() {});
        return;
      }

      String? code = await uaePassAPI.signIn(context);

      if (code != null) {
        _token = await uaePassAPI.getAccessToken(code);

        if (_token != null) {
          _user = await uaePassAPI.getUserProfile(_token!);
        }
      }
      setState(() {});
    } catch (e, s) {
      // print(e);
      // print(s);
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              _token == null
                  ? 'Press button to get token:'
                  : 'Press button to logout:',
            ),
            const SizedBox(height: 10),
            if (_token != null)
              ListTile(
                title: const Text("Token:"),
                subtitle: Text("$_token"),
              ),
            if (_user != null)
              Column(
                children: [
                  ListTile(
                    title: const Text("Full name:"),
                    subtitle: Text("${_user?.firstnameEN} ${_user?.lastnameEN}"),
                  ),
                ],
              )
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _loginOrLogout,
        tooltip: 'login',
        child: const Icon(Icons.login),
      ),
    );
  }
}