同時講解了如何啟動服務並查看前端頁面功能。
在本文中,我們將簡單講解如何在Ant Design Pro框架下實現自己的業務功能。
目錄結構淺談
首先,我們來簡單了解一下整個項目的目錄結構及其中每個文件的功能。
一個完整的目錄結構如下:
其中,關於業務功能的代碼都在src文件夾下。
而src中本身又包含着很多的子文件夾。
其中,我們最常用的應該了routes,services,models以及components。
下面,我們來依次了解一下這四個文件夾的作用。
- routes:每個路由對應的頁面組件文件。主要定義具體頁面的基本結構和內容。
- services:用於與后台交互、發送請求等。
- models:用於組件的數據存儲,接收請求返回的數據等。
- components:組件文件夾。每個頁面可能是由一些組件組成的,對於一些相對通用的組件,建議將該組件寫入components文件夾中,並在routes文件夾中的文件引入來使用。
其余的文件夾和文件功能和含義我們不再此處展開說明,但是會在后續使用過程中隨時進行補充說明。
配置新的路由和菜單
在Ant Design Pro中,前端路由是通過react-router4.0進行路由管理的。
下面,我們將會講解如下添加一個新的路由,並在前端頁面中增加一個菜單來對應該路由。
在Ant Design Pro中,路由的配置文件統一由src/common/router.js文件進行管理。
示例內容如下:
const routerConfig = {'/': {component: dynamicWrapper(app, [], () => import('../layouts/BasicLayout')),},'/dashboard/monitor': {component: dynamicWrapper(app, ['monitor'], () => import('../routes/Dashboard/NgMonitor')),},'/dashboard/workplace': {component: dynamicWrapper(app, ['monitor'], () => import('../routes/Dashboard/NgWorkSpace')),}}
其中,包含了三個路由:/,/dashboard/monitor,/dashboard/workplace。
同時,指定了這三個路由分別對應的頁面文件為layouts/BasicLayout.js,routes/Dashboard/NgMonitor.js以及Dashboard/NgWorkSpace.js文件。
下面,我們可以在側邊欄中填寫一項來對應到我們添加的路由中:
示例如下:
const menuData = [{name: 'dashboard',icon: 'dashboard', // https://demo.com/icon.png or <icon type="dashboard">path: 'dashboard',children: [{name: '分析頁',path: 'analysis',}, {name: '監控頁',path: 'monitor',}, {name: '工作台',path: 'workplace',}, {name: '測試頁',path: 'test',}],}, {// 更多配置}];
創建一個頁面
下面,我們繼續來創建一個頁面,對應到我們添加的路由中。
在src/routes下創建對應的js文件即可。 newPage.js:
示例如下:
import React, { PureComponent } from 'react';export default class Workplace extends PureComponent {render() {return (<h1>Hello World!</h1>);}}
新增一個組件
假設該頁面相對復雜,我們需要引入一個組件呢?
我們可以在components文件夾下創建一個組件,並在newPage.js引入並使用。
示例如下: components/ImageWrapper/index.js:
import React from 'react';import styles from './index.less'; // 按照 CSS Modules 的方式引入樣式文件。export default ({ src, desc, style }) => (<div style="{style}" classname="{styles.imageWrapper}"><img classname="{styles.img}" src="{src}" alt="{desc}">{desc && <div classname="{styles.desc}">{desc}</div>}</div>);
修改newPage.js:
import React from 'react';import ImageWrapper from '../../components/ImageWrapper'; // 注意保證引用路徑的正確export default () => (<imagewrapper src="https://os.alipayobjects.com/rmsportal/mgesTPFxodmIwpi.png" desc="示意圖">;)
增加service和module
假設我們的newPage.js頁面需要發送請求,接收數據並在頁面渲染時使用接收到的數據呢?
例如,我們可以在組件加載時發送一個請求來獲取數據。
componentDidMount() {const { dispatch } = this.props;dispatch({type: 'project/fetchNotice',});dispatch({type: 'activities/fetchList',});dispatch({type: 'chart/fetch',});}
此時,它將會找到對應的models中的函數來發送請求:
export default {namespace: 'monitor',state: {currentServices: [],waitingServices: [],},effects: {*get_current_service_list(_, { call, put }) {const response = yield call(getCurrentServiceList);yield put({type: 'currentServiceList',currentServices: response.result,});},*get_waiting_service_list(_, { call, put }) {const response = yield call(getWaitingServiceList);yield put({type: 'waitingServiceList',waitingServices: response.result,});},},reducers: {currentServiceList(state, action) {return {...state,currentServices: action.currentServices,};},waitingServiceList(state, action) {return {...state,waitingServices: action.waitingServices,};},},};
而真正發送請求的實際是service文件夾下的文件進行的。
export async function getWaitingServiceList() {return request('/api/get_service_list', {method: 'POST',body: {"type": "waiting"},});}export async function getCurrentServiceList() {return request('/api/get_service_list', {method: 'POST',body: {"type": "current"},});}
在routes文件夾中,我們可以直接在render部分使用應該得到的返回值進行渲染顯示:
const { monitor, loading } = this.props;// monitor指的是相當於數據流const { currentServices, waitingServices } = monitor;// 從數據流中取出了具體的變量
mock數據
在我們開發的過程中,通常不可避免的就是mock數據。
那具體應該如下進行mock數據呢?主要依賴的是.roadhogrc.mock.js文件。
打開指定文件,我們可以看到如下的類似內容:
const proxy = {'GET /api/fake_list': [{key: '1',name: 'John Brown',age: 32,address: 'New York No. 1 Lake Park',}, {key: '2',name: 'Jim Green',age: 42,address: 'London No. 1 Lake Park',}, {key: '3',name: 'Joe Black',age: 32,address: 'Sidney No. 1 Lake Park',}],'POST /api/login/account': (req, res) => {const { password, userName, type } = req.body;if(password === '888888' && userName === 'admin'){res.send({status: 'ok',type,currentAuthority: 'admin'});return ;}if(password === '123456' && userName === 'user'){res.send({status: 'ok',type,currentAuthority: 'user'});return ;}res.send({status: 'error',type,currentAuthority: 'guest'});}}
在上面的例子中,我們分別描述了針對GET和POST請求應該如下進行數據Mock。
打包
當我們將完整的前端項目開發完成后,我們需要打包成為靜態文件並准備上線。
此時,我們應該如何打包項目呢?
非常簡單,只需要執行如下命令即可:
npm run build
此外,有時我們希望分析依賴模塊的文件大小來優化我們的項目:
npm run analyze

運行完成后,我們可以打開dist/stats.html文件來查詢具體內容:

至此為止,我們就講解完成了Ant Design Pro的快速入門。
在后續文章中,我們會對一些具體的使用來進行分析和剖析。
大家在使用的過程中如果發現一些問題也歡迎大家留言討論。
</imagewrapper></icon>
