Flutter OAuth认证插件oauth_chopper的使用

Flutter OAuth认证插件oauth_chopper的使用

功能

oauth_chopper 插件为你的 Chopper 客户端提供了 OAuth2 认证管理功能。它结合了 Dart 团队的 oauth2 包和 Chopper，提供了一个 Chopper Authenticator 和 HeaderInterceptor 来管理 OAuth2 授权。

• 默认情况下，它不会持久化任何凭据信息，而是使用内存存储。你可以通过提供自定义的存储实现来覆盖这一行为。
• 目前支持以下授权类型：
  • ResourceOwnerPasswordGrant（资源所有者密码授权）
  • ClientCredentialsGrant（客户端凭证授权）
  • AuthorizationCodeGrant（授权码授权）

使用方法

1. 创建 OAuthChopper 实例

首先，你需要创建一个 OAuthChopper 实例，并传入必要的参数，如 authorizationEndpoint、identifier 和 secret。

import 'package:chopper/chopper.dart';
import 'package:oauth_chopper/oauth_chopper.dart';

void main() {
  // 定义授权端点、标识符和密钥
  final authorizationEndpoint = Uri.parse('https://example.com/oauth');
  final identifier = 'your_client_id';
  final secret = 'your_client_secret';

  /// 创建 OAuthChopper 实例
  final oauthChopper = OAuthChopper(
    authorizationEndpoint: authorizationEndpoint,
    identifier: identifier,
    secret: secret,
  );
}

2. 添加 OAuthChopper 拦截器到 Chopper 客户端

接下来，将 oauthChopper.interceptor() 添加到你的 Chopper 客户端中，以便在每次请求时自动处理 OAuth2 认证。

/// 创建 Chopper 客户端并添加拦截器
final chopperClient = ChopperClient(
  baseUrl: Uri.parse('https://example.com'),
  interceptors: [
    oauthChopper.interceptor(),
  ],
);

3. 请求 OAuth 授权

根据你使用的授权类型，调用 oauthChopper.requestGrant() 方法来请求授权。以下是几种常见的授权类型的示例：

3.1 ResourceOwnerPasswordGrant（资源所有者密码授权）

适用于用户通过用户名和密码进行授权的情况。

/// 请求 ResourceOwnerPasswordGrant 授权
oauthChopper.requestGrant(
  ResourceOwnerPasswordGrant(
    username: 'your_username',
    password: 'your_password',
  ),
);

3.2 ClientCredentialsGrant（客户端凭证授权）

适用于服务器到服务器的授权，通常用于机器与机器之间的通信。

/// 请求 ClientCredentialsGrant 授权
oauthChopper.requestGrant(
  ClientCredentialsGrant(),
);

3.3 AuthorizationCodeGrant（授权码授权）

适用于用户通过浏览器重定向进行授权的情况。

/// 请求 AuthorizationCodeGrant 授权
oauthChopper.requestGrant(
  AuthorizationCodeGrant(
    tokenEndpoint: Uri.parse("https://example.com/token"),
    scopes: ["scope1", "scope2"],
    redirectUrl: Uri.parse("https://example.com/callback"),
    redirect: (url) {
      // 处理重定向 URL
      print("Redirect to: $url");
    },
    listen: (code) {
      // 处理授权码
      print("Authorization code: $code");
    },
  ),
);

持久化 OAuth2 凭据

如果你希望持久化 OAuth2 凭据信息，可以使用 flutter_secure_storage 提供的自定义存储实现。以下是一个简单的 OAuthCredentialsStorage 实现示例：

import 'package:flutter_secure_storage/flutter_secure_storage.dart';
import 'package:oauth_chopper/oauth_chopper.dart';

const _storageKey = 'oauth_credentials';

class OAuthCredentialsStorage implements OAuthStorage {
  final FlutterSecureStorage _storage;

  const OAuthCredentialsStorage(this._storage);

  @override
  FutureOr<void> clear() async {
    await _storage.delete(key: _storageKey);
  }

  @override
  FutureOr<String?> fetchCredentials() async {
    return await _storage.read(key: _storageKey);
  }

  @override
  FutureOr<void> saveCredentials(String? credentialsJson) async {
    await _storage.write(key: _storageKey, value: credentialsJson);
  }
}

// 使用自定义存储
final oauthChopper = OAuthChopper(
  authorizationEndpoint: authorizationEndpoint,
  identifier: identifier,
  secret: secret,
  storage: OAuthCredentialsStorage(FlutterSecureStorage()),
);

完整示例代码

以下是一个完整的示例代码，展示了如何使用 oauth_chopper 插件进行 OAuth2 认证：

import 'package:chopper/chopper.dart';
import 'package:oauth_chopper/oauth_chopper.dart';
import 'package:flutter_secure_storage/flutter_secure_storage.dart';

void main() {
  // 定义授权端点、标识符和密钥
  final authorizationEndpoint = Uri.parse('https://example.com/oauth');
  final identifier = 'your_client_id';
  final secret = 'your_client_secret';

  // 创建自定义存储
  final storage = OAuthCredentialsStorage(FlutterSecureStorage());

  // 创建 OAuthChopper 实例
  final oauthChopper = OAuthChopper(
    authorizationEndpoint: authorizationEndpoint,
    identifier: identifier,
    secret: secret,
    storage: storage,
  );

  // 创建 Chopper 客户端并添加拦截器
  final chopperClient = ChopperClient(
    baseUrl: Uri.parse('https://example.com'),
    interceptors: [
      oauthChopper.interceptor(),
    ],
  );

  // 请求 ResourceOwnerPasswordGrant 授权
  oauthChopper.requestGrant(
    ResourceOwnerPasswordGrant(
      username: 'your_username',
      password: 'your_password',
    ),
  );

  // 请求 ClientCredentialsGrant 授权
  oauthChopper.requestGrant(
    ClientCredentialsGrant(),
  );

  // 请求 AuthorizationCodeGrant 授权
  oauthChopper.requestGrant(
    AuthorizationCodeGrant(
      tokenEndpoint: Uri.parse("https://example.com/token"),
      scopes: ["scope1", "scope2"],
      redirectUrl: Uri.parse("https://example.com/callback"),
      redirect: (url) {
        // 处理重定向 URL
        print("Redirect to: $url");
      },
      listen: (code) {
        // 处理授权码
        print("Authorization code: $code");
      },
    ),
  );
}