Flutter网络请求自动刷新Token插件dio_refresh_token的使用

dio_refresh_token 是一个用于管理并刷新Dio网络请求中的Token的Flutter插件。它支持安全地管理访问和刷新令牌，自动添加授权头到请求中，并提供了可定制的刷新策略。

特性

• 安全地管理访问令牌和刷新令牌。
• 自动为请求添加授权头。
• 可自定义的令牌刷新策略。
• 与Dio拦截器轻松集成。

安装

在你的 pubspec.yaml 文件中添加 dio_refresh_token：

dependencies:
  dio_refresh_token: ^0.0.1

然后运行以下命令来安装包：

flutter pub get

使用方法

添加拦截器

要使用 TokenInterceptor，你需要将其添加到你的Dio实例中。以下是具体步骤：

1. 导入必要的包：

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

2. 创建并配置你的Dio实例：

   final dio = Dio();
   

3. 创建 TokenManager 实例：

   final tokenManager = TokenManagerImpl();
   

4. 定义你的令牌刷新逻辑，通过创建 TokenRefreshStrategyImpl 实例：

   final tokenRefreshStrategy = TokenRefreshStrategyImpl(
     refreshHandler: (dio, refreshToken) async {
       // 实现你的刷新令牌逻辑
       return Response(
         requestOptions: RequestOptions(path: '/refresh'),
         statusCode: 200,
         data: {'access_token': 'newAccessToken', 'refresh_token': 'newRefreshToken'},
       );
     },
     accessTokenExtractor: (response) => response.data['access_token'],
     refreshTokenExtractor: (response) => response.data['refresh_token'],
   );
   

5. 将 TokenInterceptor 添加到你的Dio实例：

   dio.interceptors.add(TokenInterceptor(
     tokenManager: tokenManager,
     tokenRefreshStrategy: tokenRefreshStrategy,
   ));
   

6. 现在你可以像平常一样使用Dio了：

   final response = await dio.get('https://api.example.com/data');
   print(response.data);
   

使用TokenManager

TokenManager 类提供了管理令牌的方法。这里是使用它的示例：

import 'package:dio_refresh_token/dio_refresh_token.dart';

void main() async {
  final tokenManager = TokenManagerImpl();

  // 保存令牌
  await tokenManager.saveAccessToken('your_access_token');
  await tokenManager.saveRefreshToken('your_refresh_token');

  // 获取令牌
  final accessToken = await tokenManager.getAccessToken();
  final refreshToken = await tokenManager.getRefreshToken();

  // 清除令牌
  await tokenManager.clearAccessToken();
  await tokenManager.clearRefreshToken();
}

示例Demo

下面是一个完整的示例代码，展示了如何使用 dio_refresh_token 插件：

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

void main() async {
  // 创建并配置Dio实例
  final dio = Dio();

  // 创建TokenManager实例
  final tokenManager = TokenManagerImpl();

  // 定义TokenRefreshStrategy实现
  final tokenRefreshStrategy = TokenRefreshStrategyImpl(
    refreshHandler: (dio, refreshToken) async {
      // 模拟网络请求以刷新令牌
      return Response(
        requestOptions: RequestOptions(path: '/refresh'),
        statusCode: 200,
        data: {'access_token': 'newAccessToken', 'refresh_token': 'newRefreshToken'},
      );
    },
    accessTokenExtractor: (response) => response.data['access_token'],
    refreshTokenExtractor: (response) => response.data['refresh_token'],
  );

  // 将TokenInterceptor添加到Dio实例
  dio.interceptors.add(TokenInterceptor(
    tokenManager: tokenManager,
    tokenRefreshStrategy: tokenRefreshStrategy,
  ));

  // 保存初始令牌（演示用途）
  await tokenManager.saveAccessToken('initial_access_token');
  await tokenManager.saveRefreshToken('initial_refresh_token');

  // 执行网络请求
  try {
    final response = await dio.get('https://api.example.com/data');
    print('Response data: ${response.data}');
  } catch (e) {
    print('Request failed: $e');
  }

  // 访问和刷新令牌
  final accessToken = await tokenManager.getAccessToken();
  final refreshToken = await tokenManager.getRefreshToken();
  print('Access Token: $accessToken');
  print('Refresh Token: $refreshToken');

  // 清除令牌
  await tokenManager.clearTokens();
}

这个示例展示了如何设置 dio_refresh_token 插件，并执行一次网络请求。如果访问令牌过期，插件会自动使用刷新令牌获取新的访问令牌。