Ant Design Pro 是一套基于 React 技术栈的单页面应用,我们提供的是前端代码和本地模拟数据的开发模式,
通过 Restful API 的形式和任何技术栈的服务端应用一起工作。下面将简单介绍和服务端交互的基本写法。

前端请求流程

在 Ant Design Pro 中,一个完整的前端 UI 交互到服务端处理流程是这样的:

  1. UI 组件交互操作;
  2. 调用 model 的 effect;
  3. 调用统一管理的 service 请求函数;
  4. 使用封装的 request.js 发送请求;
  5. 获取服务端返回;
  6. 然后调用 reducer 改变 state;
  7. 更新 model。

从上面的流程可以看出,为了方便管理维护,统一的请求处理都放在 services 文件夹中,并且一般按照 model 维度进行拆分文件,如:

  1. services/
  2. user.js
  3. api.js
  4. ...

其中,utils/request.js 是基于 fetch 的封装,便于统一处理 POST,GET 等请求参数,请求头,以及错误提示信息等。具体可以参看 request.js

例如在 services 中的一个请求用户信息的例子:

  1. // services/user.js
  2. import request from '../utils/request';
  3. export async function query() {
  4. return request('/api/users');
  5. }
  6. export async function queryCurrent() {
  7. return request('/api/currentUser');
  8. }
  9. // models/user.js
  10. import { queryCurrent } from '../services/user';
  11. ...
  12. effects: {
  13. *fetch({ payload }, { call, put }) {
  14. ...
  15. const response = yield call(queryUsers);
  16. ...
  17. },
  18. }

Effect 处理异步请求

在处理复杂的异步请求的时候,很容易让逻辑混乱,陷入嵌套陷阱,所以 Ant Design Pro 的底层基础框架 dva 使用 effect 的方式来管理同步化异步请求:

  1. effects: {
  2. *fetch({ payload }, { call, put }) {
  3. yield put({
  4. type: 'changeLoading',
  5. payload: true,
  6. });
  7. // 异步请求 1
  8. const response = yield call(queryFakeList, payload);
  9. yield put({
  10. type: 'save',
  11. payload: response,
  12. });
  13. // 异步请求 2
  14. const response2 = yield call(queryFakeList2, payload);
  15. yield put({
  16. type: 'save2',
  17. payload: response2,
  18. });
  19. yield put({
  20. type: 'changeLoading',
  21. payload: false,
  22. });
  23. },
  24. },

通过 generatoryield 使得异步调用的逻辑处理跟同步一样,更多可参看 dva async logic

从 mock 直接切换到服务端请求

通常来讲只要 mock 的接口和真实的服务端接口保持一致,那么只需要重定向 mock 到对应的服务端接口即可。

  1. // .roadhogrc.mock.js
  2. export default {
  3. 'GET /api/(.*)': 'https://your.server.com/api/',
  4. };

这样你浏览器里这样的接口 http://localhost:8001/api/applications 会被反向代理到 https://your.server.com/api/applications 下。

关闭 mock

关闭 mock 的方法我们推荐采用环境变量,你可以在 package.json 中设置:

  1. "script" : {
  2. "start": "roadhog server",
  3. "start:no-proxy": "cross-env NO_PROXY=true roadhog server"
  4. }

然后在 .roadhogrc.mock.js 中做个判断即可:

  1. const noProxy = process.env.NO_PROXY === 'true';
  2. ...
  3. export default noProxy ? {} : delay(proxy, 1000);