Flutter Azure静默认证插件 azure_silent_auth 的使用

azure_silent_auth 是一个用于无缝集成 Azure 认证和静默登录的 Flutter 插件。它提供了多种功能，包括认证、安全存储、自动令牌管理等。

主要功能

• Azure Authentication: 包括登录、登出和静默登录。
• Secure Storage: 安全地存储和管理令牌及用户数据。
• Silent Login: 提供静默登录功能，节省开发者时间。
• 适用于离线应用: 静默登录特别适合那些需要在没有网络连接的情况下进行用户认证的应用。
• Token Management: 自动处理令牌过期和刷新。

使用方法

初始化 AzureAuth 实例

首先，导入必要的包并初始化 AzureAuth 实例：

import 'package:azure_silent_auth/authenticator/default_authenticator.dart';
import 'package:azure_silent_auth/azure_silent_auth.dart';

AzureAuth _azureAuth = AzureAuth(
  authenticatorProvider: DefaultAuthenticator(
    'https://login.microsoftonline.com/{tenant-id}/', // 替换为你的租户ID
    ["openId", "offline_access"], // 范围
    '{client-id}', // 替换为你的客户端ID
    '&prompt=select_account', // 登录提示
    {nnnn}, // 重定向URI端口 (例如：http://localhost:nnnn/)
  ),
);

第一次登录

当用户首次打开应用程序时，调用 await _azureAuth.login(); 打开认证页面。成功登录后，令牌将被安全存储。

获取访问令牌

当应用程序需要访问令牌时，调用 await _azureAuth.getAccessToken();。如果令牌已过期，它将自动刷新。

获取用户信息

当应用程序需要获取当前登录用户的信息时，调用 _azureAuth.getUserInfo();。

静默登录

当应用程序重新打开时，使用 await _azureAuth.silentLogin(); 进行静默登录。后台验证存储的令牌是否有效，无需重定向到认证页面。如果令牌无效或过期，则会抛出错误，允许开发者将用户重定向到登录屏幕。

注销

调用 _azureAuth.logout(); 清除所有本地存储的令牌和用户数据，并向 OpenID 提供者发送注销请求。

示例代码

以下是一个完整的示例应用程序，展示了如何在不同场景下使用 azure_silent_auth：

import 'package:azure_silent_auth/authenticator/default_authenticator.dart';
import 'package:azure_silent_auth/model.dart';
import 'package:azure_silent_auth/azure_silent_auth.dart';
import 'package:flutter/material.dart';
import 'package:azure_silent_auth/storage/default_storage.dart';

class AuthenticationHandler {
  static final AuthenticationHandler _instance =
      AuthenticationHandler._internal();

  factory AuthenticationHandler() {
    return _instance;
  }

  AuthenticationHandler._internal();

  final AzureAuth _azureAuth = AzureAuth(
    authenticatorProvider: DefaultAuthenticator(
      'https://login.microsoftonline.com/90440eb1-5d83-4e46-82b7-430409c54b9e/', // 替换为你的租户ID
      ["openId", "offline_access"],
      'd4e38243-f46f-44b8-9916-b00299661b71', // 替换为你的客户端ID
      '&prompt=select_account',
      3000, // 重定向URI端口
    ),
  );

  Future<void> login() async {
    await _azureAuth.login();
  }

  Future<void> silentLogin() async {
    await _azureAuth.silentLogin();
  }

  Future<void> logout() async {
    await _azureAuth.logout();
  }

  Future<String?> getUserName() async {
    return await _azureAuth.getUserInfo().then((value) => value?.name);
  }

  Future<User?> getAllInfo() async {
    return await _azureAuth.getUserInfo();
  }
}

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  DefaultStorage storage = DefaultStorage();
  final value = await storage.isTokenSavedLocally();

  runApp(MyApp(isTokenAvailable: value));
}

class MyApp extends StatelessWidget {
  final bool isTokenAvailable;

  const MyApp({Key? key, required this.isTokenAvailable}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: isTokenAvailable
          ? const HomeScreen(silentLogin: true)
          : const LoginScreen(),
    );
  }
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: ElevatedButton(
          onPressed: () async {
            await AuthenticationHandler().login();

            if (context.mounted) {
              Navigator.pushReplacement(
                context,
                MaterialPageRoute(
                    builder: (context) => const HomeScreen(silentLogin: false)),
              );
            }
          },
          child: const Text('Login'),
        ),
      ),
    );
  }
}