项目简介
基于 vue.js 的前端开发环境,用于前后端分离后的单页应用开发,可以在开发时使用 ES Next、scss 等最新语言特性。项目包含:
- 基础库: vue.js、vue-router、vuex、whatwg-fetch
- 编译/打包工具:webpack、babel、node-sass
- 单元测试工具:karma、mocha、sinon-chai
- 本地服务器:express
目录结构
环境安装
本项目依赖 node.js, 使用前先安装 node.js 和 cnpm(显著提升依赖包的下载速度)。
自行下载并安装 node.js: https://nodejs.org/en/download/
然后安装 cnpm 命令:
快速开始
命令列表:
使用生产环境配置构建项目,构建好的文件会输出到 "dist" 目录,
npm run build
运行构建服务器,可以查看构建的页面
npm run build-server
运行单元测试
npm run unit
前后端分离
项目基于 spa 方式实现前后端分离,服务器通过 Nginx 区分前端页面和后端接口请求,分发到不同服务。前端物理上只有一个入口页面,路由由前端控制(基于vue-router),根据不同的 url 加载相应数据和组件进行渲染。
接口 mock
前后端分离后,开发前需要和后端同学定义好接口信息(请求地址,参数,返回信息等),前端通过 mock 的方式,即可开始编码,无需等待后端接口 ready。 项目的本地开发服务器是基于 express 搭建的,通过 express 的中间件机制,我们已经在 dev-server 中添加了接口 mock 功能。 开发时,接口的 mock 数据统一放在 mock 目录下,每个文件内如下:
api: '/api/hello',// 返回数据 参考http://expressjs.com/zh-cn/4x/api.html
response: function (req,res) {
res.send(`
hello vue!
`); } }模块化
开发时可以使用 ES2015 module 语法,构建时每个文件会编译成 amd 模块。
组件化
整个应用通过 vue 组件的方式搭建起来,通过 vue-router 控制相应组件的展现,组件树结构如下:
单元测试
可以为每个组件编写单元测试,放在 test/unit/specs 目录下面,单元测试用例的目录结构建议和测试的文件保持一致(相对于src),每个测试用例文件名以 .spec.js结尾。 执行 npm run unit 时会遍历所有的 spec.js 文件,产出测试报告在 test/unit/coverage 目录。
联调方式
前后端分离后,由于服务端和前端的开发环境处于2台不同的机器上,前端的异步请求需要代理到后端机器中。 联调的时候,只需通过 proxy 参数运行 dev 脚本即可,所有 mock 目录下定义的接口将会转发到 proxy 参数指定的机器:
这样,如果 mock 目录下有定义了接口 /api/hello ,将会转发到 http://172.16.36.90/:8083/api/hello