基于 vue 全家桶的 spa 项目脚手架
2017-05-04 18:12
429 查看
项目简介
Github: https://github.com/hanan198501/vue-spa-template我们基于 vue-cli 脚手架生成项目模板做了一些改造,
加入了 vue-router ,vuex 等配套设施,本地 dev server 中加入了接口 mock 功能,还增加一个 build server 来预览 build 结果页面,前后端通过 spa 的方式实现分离,并相应做了分离后的联调,部署方案。
通过这个项目模板,可以快速搭建起用于前后端分离后的单页应用开发环境,项目主要包含:
基础库:
vue.js、
vue-router、
vuex、
whatwg-fetch
编译/打包工具:
webpack、
babel、
node-sass
单元测试工具:
karma、
mocha、
sinon-chai
本地服务器:
express
目录结构
├── README.md 项目介绍 ├── index.html 入口页面 ├── build 构建脚本目录 │ ├── build-server.js 运行本地构建服务器,可以访问构建后的页面 │ ├── build.js 生产环境构建脚本 │ ├── dev-client.js 开发服务器热重载脚本,主要用来实现开发阶段的页面自动刷新 │ ├── dev-server.js 运行本地开发服务器 │ ├── utils.js 构建相关工具方法 │ ├── webpack.base.conf.js wabpack基础配置 │ ├── webpack.dev.conf.js wabpack开发环境配置 │ └── webpack.prod.conf.js wabpack生产环境配置 ├── config 项目配置 │ ├── dev.env.js 开发环境变量 │ ├── index.js 项目配置文件 │ ├── prod.env.js 生产环境变量 │ └── test.env.js 测试环境变量 ├── mock mock数据目录 │ └── hello.js ├── package.json npm包配置文件,里面定义了项目的npm脚本,依赖包等信息 ├── src 源码目录 │ ├── main.js 入口js文件 │ ├── app.vue 根组件 │ ├── components 公共组件目录 │ │ └── title.vue │ ├── assets 资源目录,这里的资源会被wabpack构建 │ │ └── images │ │ └── logo.png │ ├── routes 前端路由 │ │ └── index.js │ ├── store 应用级数据(state) │ │ └── index.js │ └── views 页面目录 │ ├── hello.vue │ └── notfound.vue ├── static 纯静态资源,不会被wabpack构建。 └── test 测试文件目录(unit&e2e) └── unit 单元测试 ├── index.js 入口脚本 ├── karma.conf.js karma配置文件 └── specs 单测case目录 └── Hello.spec.js
环境安装
本项目依赖 node.js, 使用前先安装 node.js 和 cnpm(显著提升依赖包的下载速度)。自行下载并安装 node.js: https://nodejs.org/en/download/
然后安装 cnpm 命令:
npm install -g cnpm --registry=https://registry.npm.taobao.org
快速开始
git clone https://github.com/hanan198501/vue-spa-template.git cd vue-spa-template cnpm install npm run dev
命令列表:
#开启本地开发服务器,监控项目文件的变化,实时构建并自动刷新浏览器,浏览器访问 http://localhost:8081 npm run dev #使用生产环境配置构建项目,构建好的文件会输出到 "dist" 目录, npm run build #运行构建服务器,可以查看构建的页面 npm run build-server #运行单元测试 npm run unit
前后端分离
项目基于 spa 方式实现前后端分离,后端将所有 url 都返回到同一个 jsp 页面(由前端提供),此 jsp 页面也是前端的入口页面。然后路由由前端控制(基于vue-router),根据不同的 url 加载相应数据和组件进行渲染。接口 mock
前后端分离后,开发前需要和后端同学定义好接口信息(请求地址,参数,返回信息等),前端通过 mock 的方式,即可开始编码,无需等待后端接口 ready。项目的本地开发服务器是基于 express 搭建的,通过 express 的中间件机制,我们已经在 dev-server 中添加了接口 mock 功能。
开发时,接口的 mock 数据统一放在 mock 目录下,每个文件内如下:
module.exports = { // 接口地址 api: '/api/hello', // 返回数据 参考http://expressjs.com/zh-cn/4x/api.html response: function (req, res) { res.send(` <p>hello vue!</p> `); } }
模块化
开发时可以使用 ES2015 module 语法,构建时每个文件会编译成 amd 模块。组件化
整个应用通过 vue 组件的方式搭建起来,通过 vue-router 控制相应组件的展现,组件树结构如下:app.vue 根组件(整个应用只有一个) ├──view1.vue 页面级组件,放在 views 目录里面,有子组件时,可以建立子目录 │ ├──component1.vue 功能组件,公用的放在 components 目录,否则放在 views 子目录 │ ├──component2.vue │ └──component3.vue ├──view2.vue │ ├──component1.vue │ └──component4.vue └──view3.vue ├──component5.vue ……
单元测试
可以为每个组件编写单元测试,放在test/unit/specs目录下面, 单元测试用例的目录结构建议和测试的文件保持一致(相对于src),每个测试用例文件名以
.spec.js结尾。
执行
npm run unit时会遍历所有的
spec.js文件,产出测试报告在
test/unit/coverage目录。
联调方式
前后端分离后,由于服务端和前端的开发环境处于2台不同的机器上,前端的异步请求需要代理到后端机器中。联调的时候,只需通过 proxy 参数运行 dev 脚本即可,所有 mock 目录下定义的接口将会转发到 proxy 参数指定的机器:
# 172.16.36.90:8083 为后端机器的环境地址 npm run dev -- --proxy=172.16.36.90/:8083
这样,如果 mock 目录下有定义了接口 /api/hello ,将会转发到 http://172.16.36.90/:8083/api/hello
部署方案
分离后前后端代码会存放在2个单独的 git 仓库中,构建过程也是分开的。后端构建时,需要依赖前端的构建结果。具体流程如下:pull 前端项目代码
构建前端(构建结果放在dist目录)
pull 后端代码
将前端的构建结果(dist目录里的文件)复制到后端工程中
构建后端
提测时,此过程可以借助 jenkins 配置。上线时,需要运维同学配合修改上线脚本。
相关文章推荐
- 基于 vue 全家桶的 spa 项目模板
- 安装基于Vue-cli脚手架的Vue项目
- 基于vue构建的spa项目总结(一)
- 基于vue-cli网上商城项目实战开发——搭建一个完整的SPA项目开发框架(一)
- vue 基于webpack 的项目文件解析,在哪个文件该做什么事情
- vue2.0全家桶项目实用代码片段
- 我是如何基于angular+requirejs+node做SPA项目架构的
- 使用vue脚手架工具搭建vue-webpack项目
- 重构基于Yeoman脚手架生成的Express项目
- 【Vue2.0】 项目实战案例及Demo,基于vue2.0+vuex+vue-router2+axios实现
- 基于vue.js的直播项目设计
- 基于 vue-cli 的 Vue js 单页应用项目模板
- 基于 Webpack & Vue & Vue-Router 的 SPA 初体验
- 【腾讯Bugly干货分享】基于 Webpack & Vue & Vue-Router 的 SPA 初体验
- 在基于vue的webpack脚手架开发中使用了代理转发,结果浏览器发出的请求中不带cookie导致登录时总是session失效怎么办?
- vue2.0基于vue-cli,element-ui饿了么vue前端开源项目制作vue的树形table,treeTable
- 【腾讯Bugly干货分享】基于 Webpack & Vue & Vue-Router 的 SPA 初体验
- 【腾讯Bugly干货分享】基于 Webpack & Vue & Vue-Router 的 SPA 初体验
- 脚手架搭建的vue项目里引入jquery和bootstrap
- 基于Vue2.js全家桶的移动端AppDEMO实现