项目包含:
- 基础库:
vue.js
、vue-router
、vuex
、whatwg-fetch
- 编译/打包工具:
webpack
、babel
、node-sass
- 单元测试工具:
karma
、mocha
、sinon-chai
- 本地服务器:
express
build:最终发布的代码的存放位置。
config:配置路径、端口号等一些信息,我们刚开始学习的时候选择默认配置。
node_modules:npm 加载的项目依赖模块。
src:这里是我们开发的主要目录,基本上要做的事情都在这个目录里面,里面包含了几个目录及文件:
assets:放置一些图片,如logo等
components:目录里放的是一个组件文件,可以不用。
App.vue:项目入口文件,我们也可以将组件写这里,而不使用components目录。
main.js :项目的核心文件
static:静态资源目录,如图片、字体等。
test:初始测试目录,可删除
.XXXX文件:配置文件。
index.html:首页入口文件,可以添加一些meta信息或者同统计代码啥的。
package.json:项目配置文件。
README.md:项目的说明文件。
目录结构
-
├── 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 方式实现前后端分离,服务器通过 nginx 区分前端页面和后端接口请求,分发到不同服务。前端物理上只有一个入口页面, 路由由前端控制(基于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 参数指定的机器:
-
# 192.168.36.90:8088 为后端机器的环境地址
-
npm run dev -- --proxy=192.168.36.90:8088
-
这样,如果 mock 目录下有定义了接口 /api/hello ,将会转发到 http://192.168.36.90/:8088/api/hello
运行项目:
-
1.cd project-name
-
2.npm install
-
3.npm run dev
-
4.在浏览器输入localhost:8080
-
- main.js 是我们的入口文件,主要作用是初始化vue实例并使用需要的插件
-
import Vue from 'vue'
-
import App from './App'
-
/* eslint-disable no-new */
-
new Vue({
-
el: '#app',
-
template: '<App/>',
-
components: { App }
-
})
- App.vue是我们的主组件,所有页面都是在App.vue下进行切换的。其实你也可以理解为所有的路由也是App.vue的子组件。所以我将router标示为App.vue的子组件。
<template> <div id="app"> <img src="./assets/logo.png"> <hello></hello> </div> </template> <script> import Hello from './components/Hello' export default { name: 'app', components: { Hello } } </script> <style> #app { font-family: 'Avenir', Helvetica, Arial, sans-serif; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; text-align: center; color: #2c3e50; margin-top: 60px; } </style> --------------------- 来源:CSDN 原文:https://blog.csdn.net/lhy2199/article/details/81710673 版权声明:本文为博主原创文章,转载请附上博文链接!