Flutter OAuth2认证插件oauth2_dio的使用

在本示例中，我们将展示如何使用 oauth2_dio 插件进行 OAuth2 认证。oauth2_dio 插件可以帮助我们更方便地管理 OAuth2 的认证流程，包括获取访问令牌（access token）和刷新令牌（refresh token）。

实现

1. 创建 OAuthInfoMixin

OAuthInfoMixin 是一个用于保存令牌信息（如 access token 和 refresh token）的对象。

// 这里假设有一个类实现了 OAuthInfoMixin 混入
class SignInResponse with OAuthInfoMixin {
  // 其他字段和方法
}

2. 创建 Oauth2Interceptor

我们需要创建一个 Oauth2Interceptor 来处理 OAuth2 相关的请求拦截和响应解析。

import 'package:dio/dio.dart';
import 'package:oauth2_dio/oauth2_dio.dart';

// 假设我们已经有一个 dio 实例
Dio _dio = Dio();

// 创建一个 Oauth2Manager 实例来管理令牌
_oauth2manager = Oauth2Manager<SignInResponse>(
  currentValue: token, // 初始的令牌值
  onSave: (value) {
    // TODO: 将令牌保存到 SharedPreferences 或其他持久化存储
  },
);

// 添加 Oauth2Interceptor 到 dio 实例
_dio.interceptors.add(
  Oauth2Interceptor(
    dio: _dio,
    oauth2Dio: Dio(BaseOptions(baseUrl: 'http://abc.xyz/api/')), // 设置基础 URL
    pathRefreshToken: 'auth/refreshToken', // 刷新令牌的路径
    parserJson: (json) {
      // TODO: 解析 JSON 数据到 SignInResponse 对象
      return SignInResponse.fromJson(json);
    },
    tokenProvider: _oauth2manager,
  ),
);

完整示例 Demo

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

import 'package:dio/dio.dart';
import 'package:oauth2_dio/oauth2_dio.dart';

void main() async {
  // 初始化 dio 实例
  Dio _dio = Dio();

  // 创建 Oauth2Manager 实例
  final _oauth2manager = Oauth2Manager<SignInResponse>(
    currentValue: null, // 初始时令牌为空
    onSave: (value) async {
      // 将令牌保存到 SharedPreferences 或其他持久化存储
      // 这里只是示例，实际应用中需要实现具体逻辑
      print('Saving token: $value');
    },
  );

  // 添加 Oauth2Interceptor 到 dio 实例
  _dio.interceptors.add(
    Oauth2Interceptor(
      dio: _dio,
      oauth2Dio: Dio(BaseOptions(baseUrl: 'http://abc.xyz/api/')), // 设置基础 URL
      pathRefreshToken: 'auth/refreshToken', // 刷新令牌的路径
      parserJson: (json) {
        // 解析 JSON 数据到 SignInResponse 对象
        return SignInResponse.fromJson(json);
      },
      tokenProvider: _oauth2manager,
    ),
  );

  // 示例请求
  try {
    Response response = await _dio.get('/protected/resource');
    print('Request successful: ${response.data}');
  } catch (e) {
    if (e is DioError && e.response?.statusCode == 401) {
      // 处理未授权的情况，可能是令牌过期了
      print('Unauthorized, refreshing token...');
      // 这里可以添加刷新令牌的逻辑
    } else {
      print('Request failed: $e');
    }
  }
}

// SignInResponse 类实现 OAuthInfoMixin 混入
class SignInResponse with OAuthInfoMixin {
  String accessToken;
  String refreshToken;

  SignInResponse({this.accessToken, this.refreshToken});

  factory SignInResponse.fromJson(Map<String, dynamic> json) {
    return SignInResponse(
      accessToken: json['access_token'],
      refreshToken: json['refresh_token'],
    );
  }

  [@override](/user/override)
  void save() {
    // 实现保存逻辑
  }

  [@override](/user/override)
  void load() {
    // 实现加载逻辑
  }
}