跨平台开发 / 系统课时

统一处理接口基础响应

统一处理接口基础响应

移动应用通常会面对大量结构相似的接口响应,例如都包含 code、message 和 data 字段。如果每个页面都重复判断这些字段,业务代码会快速膨胀。本篇将封装统一响应模型,让网络层集中处理公共结构。

学习目标

  • 理解接口基础响应统一封装的价值。
  • 掌握 Dart 中定义泛型响应模型的方法。
  • 能够减少业务层重复解析响应字段。

为什么需要统一响应模型

后端接口通常会返回类似结构:

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1,
    "name": "Flutter"
  }
}

如果每个页面都直接读取 code 和 message,项目中会出现大量重复判断。当接口规则变化时,需要修改很多业务代码。

统一响应模型可以把公共字段集中到网络层,业务层只关心真正需要的数据内容。

定义泛型响应对象

Dart 的泛型可以让同一个响应模型适配不同数据类型。

dart
class ApiResponse<T> {
  final int code;
  final String message;
  final T? data;

  ApiResponse({
    required this.code,
    required this.message,
    this.data,
  });

  factory ApiResponse.fromJson(
    Map<String, dynamic> json,
    T Function(dynamic value) parser,
  ) {
    return ApiResponse<T>(
      code: json['code'] as int,
      message: json['message'] as String,
      data: json['data'] == null ? null : parser(json['data']),
    );
  }
}

预期结果

text
ApiResponse<User> 可以表示用户接口响应,ApiResponse<List<Article>> 可以表示文章列表响应。

这里的关键点是 parser 参数。不同业务数据结构不同,响应模型只负责解析公共字段,不负责知道每种业务对象的细节。

在网络层集中判断状态

接口请求完成后,可以在统一位置处理错误状态。

dart
ApiResponse<T> handleResponse<T>(ApiResponse<T> response) {
  if (response.code != 0) {
    throw Exception(response.message);
  }

  return response;
}

预期结果

text
code 为 0 时返回业务数据,非 0 时抛出包含接口错误信息的异常。

实际项目中,这类逻辑通常会放入网络客户端封装中,而不是散落在页面 Widget 内。

统一响应后的调用方式

业务层只需要处理已经转换后的数据:

dart
final response = await articleRepository.getArticles();
final articles = response.data;

业务代码不再关心原始 JSON 中的公共字段,也不需要重复判断接口是否成功。

常见边界问题

统一响应模型需要提前考虑异常情况:

  • data 可能为空时,需要使用可空类型。
  • 不同接口的成功状态码规则需要提前约定。
  • 后端返回结构变化时,需要集中调整解析逻辑。

如果项目中存在多个后端服务,也可以为不同服务定义不同的响应适配层,而不是强行使用一个模型覆盖所有情况。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

统一处理接口基础响应

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通