1. 背景
在移动应用开发中，与后端服务器进行接口通讯是常见的需求。客户端需求向服务器发送恳求并获取呼应数据，以便展示、更新或同步数据。但是，处理接口恳求时或许会面对一些挑战和痛点。
痛点：
- 恳求建议繁琐：传统的接口恳求代码一般涉及到创立恳求目标、设置恳求参数、处理恳求回调等繁琐的步骤，使得恳求建议变得冗长和杂乱。
- 参数办理困难：在进行接口恳求时，常常需求传递一系列参数，包含URL、恳求参数、查询参数等。关于很多的参数办理和传递，缺少一种简练和高雅的办法。
- 回来值转化繁琐：接口恳求回来的是原始的JSON数据，一般需求手动将其转化为对应的数据模型，这一过程或许比较繁琐和重复。
- 反常处理不一致：在网络恳求过程中或许会遇到各种反常情况，如网络连接问题、超时、服务器过错等。关于这些反常情况的处理或许存在不一致性，导致过错音讯不明确或处理不及时。
针对以上痛点，咱们能够经过优化客户端接口恳求的最佳实践来改善开发体会和代码质量。经过简化恳求建议、优化参数办理、主动转化回来值、一致反常处理等手法，能够添加开发功率、进步代码可读性，并供给更好的用户体会。
2. 简化恳求建议
下面是示例代码，其间 Http 类是依据 Dio 的一个封装，包含设置默许恳求头、拦截器、超时时间等装备。
import '../net/http.dart';
class HttpRequestJson {
static Future<HttpResponse<T>> fetch<T>(
String url, {
Map<String, dynamic>? params,
FromJsonMethod<T>? fromJsonMethod,
}) async {
try {
final response = await Http().get(url, queryParams: params);
final resJson = response.data as Map<String, dynamic>?;
if (resJson == null) {
return HttpResponse.error(code: 400, message: 'Failed');
}
return HttpResponse.fromJson(
resJson: resJson,
fromJsonMethod: fromJsonMethod,
);
} catch (e) {
return errorResponse(e);
}
}
static Future<HttpResponse<T>> post<T>(
String url, {
Map<String, dynamic>? params,
Map<String, dynamic>? queryParameters,
FromJsonMethod<T>? fromJsonMethod,
CancelToken? cancelToken,
}) async {
try {
final response = await Http().post(
url,
data: params,
params: queryParameters,
cancelToken: cancelToken,
);
final resJson = response.data as Map<String, dynamic>?;
if (resJson == null) {
return HttpResponse.error(code: 400, message: 'Failed');
}
return HttpResponse.fromJson(
resJson: resJson,
fromJsonMethod: fromJsonMethod,
);
} catch (e) {
return errorResponse<T>(e);
}
}
}
HttpResponse 是一个用于表明网络恳求呼应的类。它用于封装从服务器回来的数据，包含呼应的状况码、音讯和数据。
属性：
-
code：表明呼应的状况码，用于表明恳求的执行成果。常见的状况码包含 200 表明成功，400 表明恳求过错，500 表明服务器过错等。 -
message：表明呼应的音讯，用于供给对呼应成果的简要描述。它能够包含一些有关呼应的额外信息或过错信息。 -
data：表明呼应的数据，它能够是任何类型的数据，如字符串、数字、目标等。详细的数据类型取决于服务器回来的内容。
办法：
-
fromJson：用于从回来的 JSON 数据中解析并创立一个HttpResponse目标。它承受一个包含呼应数据的 JSON 目标以及一个可选的自定义数据解析办法。 -
error：用于创立一个表明过错呼应的HttpResponse目标。它承受一个过错码、过错音讯和可选的过错数据。
HttpResponse<T> 是一个具有描述性泛型 T 的类，用于表明网络恳求呼应的数据模型。经过运用泛型，咱们能够指定呼应数据的详细类型，从而供给更详细和类型安全的数据拜访。
在 HttpResponse<T> 中，T 表明呼应数据的类型。它能够是任何有效的 Dart 类型，包含内置类型（如 int、String）和自定义类型（如自定义类或模型）。经过将 T 作为泛型参数传递给 HttpResponse，咱们能够在实例化时确定呼应数据的类型。
例如，如果咱们期望将呼应数据解析为一个名为 User 的自定义类目标，咱们能够运用 HttpResponse<User>。这样，咱们就能够在 HttpResponse<User> 目标中拜访和操作 User 类型的数据。
运用描述性泛型 T 能够进步代码的可读性和可保护性。它使咱们能够在编译时捕获类型过错，并供给更详细和精确的数据类型操作。经过运用泛型，咱们能够编写更通用和灵活的代码，以习惯不同类型的呼应数据，并防止进行手动的类型转化和验证。
总而言之，HttpResponse<T> 中的描述性泛型 T 允许咱们指定网络恳求呼应数据的详细类型，供给类型安全和精确的数据拜访和操作，从而进步代码质量和开发功率。
3. 示例
这是运用 HttpRequestJson 的示例代码，以 User 接口为例：
class UserApis {
static Future<HttpResponse<User>> getUser(int userId) async {
final params = {'userId': userId};
final res = await HttpRequestJson.get<User>(
'api/user',
params: params,
fromJsonMethod: User.fromJson,
);
return res;
}
static Future<HttpResponse<User>> createUser(User user) async {
final res = await HttpRequestJson.post<User>(
'api/user',
params: user.toJson(),
fromJsonMethod: User.fromJson,
);
return res;
}
static Future<HttpResponse<User>> updateUser(User user) async {
final res = await HttpRequestJson.put<User>(
'api/user/${user.id}',
params: user.toJson(),
fromJsonMethod: User.fromJson,
);
return res;
}
static Future<HttpResponse<void>> deleteUser(int userId) async {
final res = await HttpRequestJson.delete<void>(
'api/user/$userId',
);
return res;
}
}
4. 接口文档转 Dart 模型类
要将接口文档转化为 Dart 模型类，您能够运用 quicktype 东西。quicktype 供给了在线运用和命令行东西两种办法。
主流的接口文档办理东西（例如 Apifox、yapi 等）都支撑从接口文档导出 json-schema 数据。运用 quicktype，咱们能够将 json-schema 转化为 Dart 类，而且能够保存接口注释。
以下是转化后的 Dart 模型类示例，它包含了 fromJson() 和 toJson() 办法，咱们强烈建议将杂乱的恳求参数也以目标的办法暴露给事务方。
您能够实现主动化地将接口文档转化为各端的模型类。为此，您需求运用 quicktype 命令行东西，而且能够从接口文档办理东西中获取指定接口的 json-schema 数据。
经过这种办法，您能够愈加高效地生成和更新模型类，减少手动编写和保护的工作量，进步开发功率。
5. 定论
经过上述优化，咱们成功简化了客户端接口恳求的建议过程，并供给了更好的参数办理、回来值转化和反常处理机制。这些优化能够明显进步开发功率、进步代码质量，并供给更好的用户体会。
咱们建议在实际开发中选用这些最佳实践，依据详细的事务需求和开发结构，适配和调整相关代码。这样能够保证代码的可读性、可保护性和可扩展性，一起进步开发功率和用户满意度。
期望本文对您有所协助，如果您还有任何问题，请随时提问。
