项目实战

在真实项目开发中，你可能会需要 Redux 或者 MobX 这样的数据流方案，Ant Design React 作为一个 UI 库，可以和任何 React 生态圈内的数据流方案以及应用框架搭配使用。我们基于 Redux 推出了自己的最佳实践 dva，以及可插拔的企业级应用框架 umi，推荐你在项目中使用。

dva 是一个基于 Redux 的 轻量级数据流方案，概念来自 elm，支持 side effects、热替换、动态加载、react-native、SSR 等，已在生产环境广泛应用。

umi 则是一个可插拔的企业级 react 应用框架。umi 以路由为基础的，支持类 next.js 的约定式路由，以及各种进阶的路由功能，并以此进行功能扩展，比如支持路由级的按需加载。然后配以完善的插件体系，覆盖从源码到构建产物的每个生命周期，支持各种功能扩展和业务需求。

你可能也会对 Ant Design Pro 感兴趣，这是一个基于 umi、dva 和 ant design 的开箱即用的中台前端/设计解决方案。

本文会引导你使用 umi、dva 和 antd 从 0 开始创建一个简单应用。

创建新应用

先创建一个空目录，

  1. $ mkdir myapp
  2. $ cd myapp

推荐使用 yarn 创建应用，执行以下命令，

如果你使用 npm，可执行 npm create umi，效果一致。

  1. $ yarn create umi
  3. yarn create v1.12.0
  4. [1/4] 🔍  Resolving packages...
  5. [2/4] 🚚  Fetching packages...
  6. [3/4] 🔗  Linking dependencies...
  7. [4/4] 📃  Building fresh packages...
  9. success Installed "create-umi@0.9.5" with binaries:
  10.       - create-umi

yarn 会先安装最新版的 create-umi，然后提供交互式的提示来创建应用。

选择 app, 然后回车确认。

  1. ? Select the boilerplate type
  2.   ant-design-pro  - Create project with an layout-only ant-design-pro boilerplate, use together with umi block.
  3. ❯ app             - Create project with a simple boilerplate, support typescript.
  4.   block           - Create a umi block.
  5.   library         - Create a library with umi.
  6.   plugin          - Create a umi plugin.

选上 antd 和 dva，然后回车确认。

  1.    create package.json
  2.    create mock/.gitkeep
  3.    create src/assets/yay.jpg
  4.    create src/layouts/index.css
  5.    create src/layouts/index.js
  6.    create src/pages/index.css
  7.    create src/pages/index.js
  8.    create src/global.css
  9.    create .gitignore
  10.    create .editorconfig
  11.    create .env
  12.    create .umirc.js
  13.    create .eslintrc
  14.    create .prettierrc
  15.    create .prettierignore
  16.    create src/models/.gitkeep
  17.    create src/dva.js
  18. ✨  File Generate Done
  19. ✨  Done in 966.73s.

然后安装依赖，

  1. $ yarn

然后启动应用，

  1. $ yarn start

几秒钟后，你会看到以下输出，

  1.  DONE  Compiled successfully in 212ms
  3.   App running at:
  4.   - Local:   http://localhost:8000/
  5.   - Network: http://{{ YourIP }}:8000/

在浏览器里打开 http://localhost:8000，你会看到 umi 的欢迎界面。

项目实战 - 图1

使用 antd

前面选择 antd 之后，会自动处理 antd 的依赖以及按需加载。你可以检查 .umirc.js 里的配置，确保 antd 已开启。

  1. // ref: https://umijs.org/config/
  2. export default {
  3.   plugins: [
  4.     // ref: https://umijs.org/plugin/umi-plugin-react.html
  5.     [
  6.       'umi-plugin-react',
  7.       {
  8.         antd: true,
  9.         dva: true,
  10.       },
  11.     ],
  12.   ],
  13. };

而如果要使用固定版本的 antd，你可以在项目里安装额外的 antd 依赖，package.json 里声明的 antd 依赖会被优先使用。

新建路由

我们要写个应用来先显示产品列表。首先第一步是创建路由，路由可以想象成是组成应用的不同页面。

如果你没有 npx，需要先安装他，用于执行 node_modules 下的命令，

  1. $ yarn global add npx

然后通过命令创建 /products 路由，

  1. $ npx umi g page products
  3.    create src/pages/products.js
  4.    create src/pages/products.css
  5. ✔  success

然后在浏览器里打开 http://localhost:8000/products，你应该能看到对应的页面。

编写 UI Component

随着应用的发展，你会需要在多个页面分享 UI 元素 (或在一个页面使用多次)，在 umi 里你可以把这部分抽成 component 。

我们来编写一个 ProductList component，这样就能在不同的地方显示产品列表了。

新建 src/components/ProductList.js 文件：

  1. import { Table, Popconfirm, Button } from 'antd';
  3. const ProductList = ({ onDelete, products }) => {
  4.   const columns = [
  5.     {
  6.       title: 'Name',
  7.       dataIndex: 'name',
  8.     },
  9.     {
  10.       title: 'Actions',
  11.       render: (text, record) => {
  12.         return (
  13.           <Popconfirm title="Delete?" onConfirm={() => onDelete(record.id)}>
  14.             <Button>Delete</Button>
  15.           </Popconfirm>
  16.         );
  17.       },
  18.     },
  19.   ];
  20.   return <Table dataSource={products} columns={columns} />;
  21. };
  23. export default ProductList;

定义 dva Model

完成 UI 后，现在开始处理数据和逻辑。

dva 通过 model 的概念把一个领域的模型管理起来，包含同步更新 state 的 reducers，处理异步逻辑的 effects，订阅数据源的 subscriptions 。

新建 model src/models/products.js，

  1. export default {
  2.   namespace: 'products',
  3.   state: [],
  4.   reducers: {
  5.     delete(state, { payload: id }) {
  6.       return state.filter(item => item.id !== id);
  7.     },
  8.   },
  9. };

这个 model 里：

  • namespace 表示在全局 state 上的 key

  • state 是初始值，在这里是空数组

  • reducers 等同于 redux 里的 reducer，接收 action，同步更新 state

umi 里约定 src/models 下的 model 会被自动注入，你无需手动注入。

connect 起来

到这里，我们已经单独完成了 model 和 component，那么他们如何串联起来呢?

dva 提供了 connect 方法。如果你熟悉 redux，这个 connect 来自 react-redux。

编辑 src/pages/products.js，替换为以下内容：

  1. import { connect } from 'dva';
  2. import ProductList from '../components/ProductList';
  4. const Products = ({ dispatch, products }) => {
  5.   function handleDelete(id) {
  6.     dispatch({
  7.       type: 'products/delete',
  8.       payload: id,
  9.     });
  10.   }
  11.   return (
  12.     <div>
  13.       <h2>List of Products</h2>
  14.       <ProductList onDelete={handleDelete} products={products} />
  15.     </div>
  16.   );
  17. };
  19. export default connect(({ products }) => ({
  20.   products,
  21. }))(Products);

最后，我们还需要一些初始数据让这个应用 run 起来。编辑 src/app.js：

  1. export const dva = {
  2.   config: {
  3.     onError(err) {
  4.       err.preventDefault();
  5.       console.error(err.message);
  6.     },
  7.     initialState: {
  8.       products: [{ name: 'dva', id: 1 }, { name: 'antd', id: 2 }],
  9.     },
  10.   },
  11. };

刷新浏览器，应该能看到以下效果：

项目实战 - 图2

构建应用

完成开发并且在开发环境验证之后，就需要部署给我们的用户了。先执行下面的命令，

  1. $ npm run build

几秒后，输出应该如下：

  1. > @ build /private/tmp/sorrycc-V0lLrF
  2. > umi build
  4. [5:01:58 PM] webpack compiled in 11s 615ms
  7.  DONE  Compiled successfully in 11622ms                                           5:01:58 PM
  9. File sizes after gzip:
  11.   340.44 KB  dist/umi.js
  12.   17.82 KB   dist/umi.css

build 命令会打包所有的资源，包含 JavaScript, CSS, web fonts, images, html 等。你可以在 dist/ 目录下找到这些文件。

下一步

我们已经完成了一个简单应用，你可能还有很多疑问，比如：

  • 如何统一处理出错？

  • 如何处理更多路由，比如动态路由，嵌套路由，权限路由等？

  • 如何 mock 数据？

  • 如何部署？

  • 等等

你可以：