跨平台开发 / 系统课时
按业务模块拆分 API 文件
按业务模块拆分 API 文件
当 Flutter 项目的接口数量增长后,把所有请求方法堆放在一个 API 文件中会导致维护困难。本篇将通过按业务模块拆分 API 文件,让用户、文章、订单等接口拥有清晰边界,并建立后续扩展更容易维护的目录结构。
学习目标
- 理解为什么需要按业务职责拆分 API 文件。
- 掌握 Flutter 项目中 API 模块的常见组织方式。
- 能够创建独立业务 API 类并在业务代码中调用。
为什么需要拆分 API 文件
在小型项目中,一个 api.dart 文件包含所有接口并不会立即产生问题。但随着功能增加,文件会同时承担用户认证、内容查询、订单提交等不同职责,最终出现接口定位困难、修改风险增加的问题。
按业务模块拆分的核心思想是让每个 API 文件只关注一种业务领域,例如用户相关请求放入 user_api.dart,文章相关请求放入 article_api.dart。这样修改某个业务接口时,不需要在巨大文件中搜索和判断影响范围。
常见目录组织方式
一个简单的网络层可以按照业务领域划分:
CODE
lib/
├── data/
│ ├── api/
│ │ ├── user_api.dart
│ │ ├── article_api.dart
│ │ └── order_api.dart
│ └── models/
└── services/这种结构中,API 文件负责描述接口入口和请求参数,模型文件负责数据结构,业务服务层负责组合多个接口完成业务流程。
创建业务 API 类
下面以文章模块为例,一个 API 类只管理文章相关请求。
dart
import 'package:dio/dio.dart';
class ArticleApi {
final Dio client;
ArticleApi(this.client);
Future<Response<dynamic>> getArticles() {
// 这里只负责文章接口,不处理页面业务逻辑
return client.get('/articles');
}
Future<Response<dynamic>> getArticleDetail(String id) {
return client.get('/articles/$id');
}
}预期结果
text
调用 ArticleApi 后,可以通过 getArticles 获取文章列表,通过 getArticleDetail 获取指定文章详情。实际项目中,UserApi、OrderApi 可以采用相同方式创建,但每个类只保留自己的接口集合。
API 模块拆分边界
拆分 API 文件时,不应该简单按照接口数量平均分配,而应该按照业务职责划分。
| 拆分方式 | 适用情况 |
|---|---|
| 按业务模块拆分 | 用户、商品、订单等独立领域 |
| 按功能拆分 | 项目较小,接口分类较少 |
| 单文件集中管理 | 原型阶段或接口极少的项目 |
当一个 API 类开始包含多个完全不同的业务对象时,通常说明它需要继续拆分。
什么时候不应该拆分过细
拆分不是为了制造更多文件。如果一个接口只会被某个简单页面使用,单独创建一个文件可能增加维护成本。
合理的粒度应该满足两个条件:业务职责明确,并且未来修改时能够快速定位。对于中大型 Flutter 项目,按领域拆分 API 文件通常比按页面拆分更稳定。
按自己的节奏,确认真正理解。