Flutter HTTP客户端插件craft的使用

Flutter HTTP客户端插件craft的使用

简单且直观的HTTP客户端（称为crafts），支持OAuth令牌自动刷新、请求排队和序列化、本地存储请求以支持离线操作...

维护者 #

• Marcel Čampa

示例代码

/// 这个示例展示了如何使用一个包装类[Craft]创建实际的craft变种。这是创建crafts的首选方法，因为从一种实现方式切换到另一种可以轻松完成。

import 'package:craft/craft.dart';
import 'package:http/http.dart' as http;

class LoginData implements Serializable {
  final String username;
  final String password;

  const LoginData(this.username, this.password);

  [@override](/user/override)
  Map<String, dynamic> toJson() {
    return {
      'username': username,
      'password': password,
    };
  }
}

class ApiService {
  static ApiService? _instance;
  static ApiService get instance => _instance!;

  ApiService._({
    required Craft<PersistableAutoRefreshingBearerOauthCraft> craft,
  }) : _craft = craft;

  factory ApiService({
    required Craft<PersistableAutoRefreshingBearerOauthCraft> craft,
  }) {
    if (_instance != null) throw StateError('已经创建');

    _instance = ApiService._(craft: craft);
    return instance;
  }

  late final Craft<PersistableAutoRefreshingBearerOauthCraft> _craft;

  /// 酿造craft。如果之前已持久化刷新令牌，自动提升将成功，因为访问令牌和（新）刷新令牌将使用保存的刷新令牌和refreshTokenMethod获得。这意味着此函数基本上返回用户是否已认证。
  Future<bool> init() async {
    _craft = await Craft.brew<PersistableAutoRefreshingBearerOauthCraft>(
      refreshTokenMethod: _refreshTokens,
      tokenExpiration: _tokenExpiration,
      tokenStorageKey: 'craft_example_token_storage_key',
    );

    return _craft.promoted;
  }

  Future<void> login(LoginData loginData) async {
    final http.Response response = await _craft.instance.send(
      Request<LoginData>(
        HttpMethod.post,
        Uri.parse('https://example.com/login'),
        body: loginData,
      ),
    );

    final TokenPair tokenPair = _tokensFromLoginResponse(response);

    await _craft.promote(
      accessToken: tokenPair.access,
      refreshToken: tokenPair.refresh,
      refreshTokenMethod: _refreshTokens,
      tokenExpiration: _tokenExpiration,
      tokenStorageKey: 'craft_example_token_storage_key',
    );
  }

  // 可以设为私有，因为没有必要手动调用它。如果需要，当然也可以公开。
  //
  // 我们假设这里只颁发新的访问令牌，刷新令牌保持不变。
  Future<TokenPair> _refreshTokens(String refreshToken) async {
    final http.Response response = await _craft.instance.send(
      Request<String>.fromString(
        HttpMethod.post,
        'https://example.com/login/refresh',
        body: refreshToken,
      ),
    );

    final String newAccessToken = response.body;
    return TokenPair(newAccessToken, refreshToken);
  }

  Duration _tokenExpiration(String accessToken) {
    return Duration(
      milliseconds: _parseExpirationMsFromJwtToken(accessToken) -
          DateTime.now().millisecondsSinceEpoch,
    );
  }

  // 返回用于示例目的的虚拟令牌。这通常是从响应体中解析令牌的方法。
  TokenPair _tokensFromLoginResponse(http.Response response) {
    return const TokenPair('access', 'refresh');
  }

  // 返回从JWT值中提取的毫秒数。这通常是从'iat' JWT值中提取的。
  int _parseExpirationMsFromJwtToken(String jwtToken) {
    return DateTime.now().millisecondsSinceEpoch + 60000;
  }
}

/// 这是你在启动屏幕或其他初始化逻辑中通常要做的事情。
Future<void> main() async {
  final ApiService apiService = ApiService.instance;

  final bool userLoggedIn = await apiService.init();
  if (userLoggedIn) {
    // 例如，前往主屏幕
    return;
  }

  // 前往登录屏幕并执行：
  await apiService.login(const LoginData('username', 'password'));

  // craft现在应该被提升了。
}