Flutter API模型管理插件flutter_api_model的使用

Flutter API模型管理插件flutter_api_model的使用

特性

高阶网络请求建模，管理输入参数和输出参数，遵循"In-Out"命名规范。APIModel不直接处理网络请求；相反，它擅长于网络层抽象。

开始使用

安装

在你的pubspec.yaml文件中添加以下依赖：

dependencies:
  flutter_api_model: latest_version

导入

将包导入到Dart代码中：

import 'package:flutter_api_model/flutter_api_model.dart';

支持await和回调格式以增加灵活性

使用await

final model = await UserSearchAPIModel(inUserId: '2024').start();
if (model.hasError) {
  error = model.outError;
} else {
  user = model.outUser;
}

使用回调

UserSearchAPIModel(inUserId: '2024').onComplete((model) {
  if (!model.hasError) {
    user = model.outUser;
  } else {
    error = model.outError;
  }
}).start();

类定义

命名规则

• 输入参数前缀：in
  • (inUserId, inPassword)
• 输出结果前缀：out
  • (outUser)

定义APIModel的三种方式

1. 使用mixin 适用于没有特殊初始化需求的场景。

   class SomeAPIModel with APIModel<SomeAPIModel>
   

2. 使用继承 适合定义一个扩展APIModel的基本网络请求类。

   class BaseRequestModel extends APIModel<SomeAPIModel>
   

3. 使用mixin和继承的组合（推荐） 最适合自定义网络请求、数据处理和职责分离。例如，BaseRequest可以处理Dio操作和数据转换，而APIModel则提供请求流程和封装。

   class SomeAPIModel extends BaseRequest with APIModel<SomeAPIModel>
   

示例：定义UserSearchAPIModel

class UserSearchAPIModel extends BaseRequest<Map> 
      with  APIModel<UserSearchAPIModel>, 
            OutError<UserSearchAPIModel, FlutterError>,
            LoginNeed,
            CancelEnable {
  UserSearchAPIModel({required this.inUserId});
  /// 输入参数
  String inUserId;
  /// 输出结果
  User? outUser;

  [@override](/user/override)
  load() async {
    try {
      final response = await dio.request('/user/profile', cancelToken: cancelToken);
      outUser = User.converFrom(jsonObject);
    } on FlutterError catch (e) {
        outError = e;
    } catch (e) {
      if (CancelToken.isCancel(e) == false) { 
        // 处理错误
        throw e;
      }
    } finally {
      finalize();
    }
  }

}

/// 如果需要初始化工作，定义基础类型
/// 定义 `BaseRequest` 类
class BaseRequest<DataType> {
  final dio = Dio();

  final cancelToken = CancelToken(); 

  DataType? data;

  int? code;

  String? msg;

  BaseRequest() {
    dio.options.baseUrl = 'https://base_url.com';
    dio.options.headers = {'token': 'some_token'};
  }

  void fillData(Dio.Response response) {
    data = getData(response);
    code = response.statusCode;
    msg  = getMsg(response);
  }
}

/// 定义一个mixin来覆盖 `hasPermission` 方法，当用户未登录时阻止调用。
/// 定义 `LoginNeed` Mixin.
mixin LoginNeed<T> on APIModel<T> {

  [@override](/user/override)
  bool hasPermission() {
    return isLogin();
  }

  didBlock() {
    print('API 请求被阻塞。');
  }
}

/// 使用 `CancelEnable` Mixin 实现可取消的请求
[@optionalTypeArgs](/user/optionalTypeArgs)
mixin CancelEnable<T> on APIModel<T>, BaseRequest {

  [@override](/user/override)
  bool isCancellable() {
    return true;
  }

  [@override](/user/override)
  void cancel() {
    super.cancel();
    cancelToken.cancel();
  }
}