work

Description:

work

work #


封装http业务接口协议，基于dio 实现。
提供标准且一致的接口编写与执行流程，与公司http规范紧密结合，规范团队成员接口编写和使用方式。
核心设计理念为封装http接口的请求数据和响应数据的序列化和反序列化，接口调用处不能出现任何解析http数据的代码。
装配和解析代码应该全部由Work类完成，接口调用处使用一致的调用方式，无需关心http的实现方式和接口参数拼装细节，
此设计隐藏了一些不常用的dio 功能，如需使用需要单独实现装配器
此设计的优点是规范团队接口编写方式，统一项目http接口代码风格。

Install #
work: ^6.0.2
copied to clipboard
实现公司http规范基类 #
模仿simple_work.dart中的样板来实现一个Work基类，用于关联自己公司的固定接口规范。
SimpleWork类为一个样例实现。
假设公司的所有接口响应数据格式如下：
{
"state":true, // 业务的成功失败标志
"errorCode":0, // 错误码
"message":null, // 业务消息字符串，可以是成功时用于显示的信息，也可以是失败时的提示信息
"result": {} // 真正响应的有效业务数据，任意类型
}
copied to clipboard
首先实现一个带有errorCode的WorkData子类以匹配上述协议（WorkData中已包含另外三个）。

class SimpleWorkData<T> extends WorkData<T> {
/// 协议错误码
int get errorCode => response?.data['errorCode'] ?? 0;

/// 原始响应结果数据
dynamic get resultData => response?.data['result'];
}

copied to clipboard
最后实现一个解析此协议的Work基类，可以更具自身需要添加如onExtractResult和onDefaultResult的扩展生命周期。

abstract class SimpleWork<D> extends Work<D, SimpleWorkData<D>> {
@override
SimpleWorkData<D> onCreateWorkData() => SimpleWorkData<D>();

@override
FutureOr<D?> onRequestSuccessful(SimpleWorkData<D> data) {
if (data.resultData == null) {
return onDefaultResult(data);
} else {
return onExtractResult(data, data.resultData);
}
}

@override
bool onRequestResult(SimpleWorkData<D> data) => data.response!.data['state'];

@override
String? onRequestSuccessfulMessage(SimpleWorkData<D> data) =>
data.response!.data['message'];

@override
String? onRequestFailedMessage(SimpleWorkData<D> data) =>
data.response!.data['message'];

/// 生成响应成功的结果数据
///
/// * [resultData]为协议中的[result]标签下的数据
/// * 当请求成功且返回结果中存在[result]标签且不为null时被调用
/// * 返回装配后的本地数据对象
/// * [data]为将要返回的数据包装类
@protected
FutureOr<D?> onExtractResult(SimpleWorkData<D> data, dynamic resultData);

/// 生成响应成功的默认结果数据
///
/// * 当请求成功且返回结果不存在[result]标签或值为null时被调用，默认实现为null
/// * [data]为将要返回的数据包装类
@protected
FutureOr<D?> onDefaultResult(SimpleWorkData<D> data) => null;
}

copied to clipboard
增加接口 #
继承公司http规范基类，比如SimpleWork<T>。
<T>为真正需要返回的数据模型类
子类可以方便的与json_serializable 库结合使用
示例

@JsonSerializable()
class LoginWork extends SimpleWork<User> {
LoginWork({this.username, this.password});

final String username;

final String password;

String get device => Platform.isIOS ? "Ios" : "Android";

/// 解析响应数据
@override
FutureOr<User> onExtractResult(SimpleWorkData<User> data, dynamic resultData) => User.fromJson(resultData);

/// 装配请求参数
///
/// 返回发送的参数集合，可以和[json_serializable]库配合使用，也可以简单的直接拼装
@override
FutureOr<dynamic> onFillParams(SimpleWorkData<User> data) => _$LoginWorkToJson(this);

// 不使用序列化库，直接拼接
// @override
// FutureOr<dynamic> onFillParams(SimpleWorkData<User> data) => {
// 'username': username,
// 'password': password,
// 'device': device,
// };
//

/// 可以是完整地址，也可以是相对地址（需要在[BaseOptions]中设置，关联性请查看[WorkConfig.dio]）
@override
String onUrl() => "https://xxx/user/login";

/// 使用post请求
@override
HttpMethod onHttpMethod() => HttpMethod.post;
}

copied to clipboard
调用接口 #

// 创建work实例并执行start发起请求，多次调用start会发起多次请求，
LoginWork(username: 'user1', password: '123456').start().then((data){
// start方法返回WorkFuture<T> ，T为[SimpleWorkData]类，此WorkFuture可以取消本次work请求

if (data.success){
// 登录成功
final user = data.result;
}else{
// 登录失败
}
});

copied to clipboard
支持请求类型 #

HttpMethod中的类型，get、post、put、delete、head、patch。
上传文件时请实现Work.onContentType并设置为multipart/form-data，参数中的文件需要用File或UploadFileInfo类型包装，支持文件列表
下载文件时可以自己处理字节流，需要实现Work.onResponseType并指定自己需要的响应格式，也可以参考SimpleDownloadWork实现一个快捷下载类，此方式使用dio.download下载。

其他Work生命周期函数 #

Work中还有很多生命周期方法，用于做有限的接口扩展和定制，请参考work_life_cycle.dart
原则是接口数据处理由接口自己(即Work)处理
Work设计的流程能满足绝大多数使用场景，如需深度定制Http请求，可以查看WorkConfig用于全局配置，Work.onWorkRequest用于定制单一任务