vue开发项目完全指南

转载自: https://segmentfault.com/a/1190000018619576

这篇文章总结了vue项目的所遇到的问题,包括跨域、用户认证、接口统一管理、路由配置、兼容性处理,性能优化等内容。

项目github地址 :

  • 前端 https://github.com/huangyangt…
  • 后端: https://github.com/huangyangt…

一、环境依赖安装

1. node环境

1.1 node和npm环境的安装

根据以下教程安装,然后设置好环境变量

http://www.runoob.com/nodejs/…

视频教程 http://github.liaoxuefeng.com….

centos如果装不上看这里:https://www.rosehosting.com/b…

1.2 为npm更改源

npm默认使用的源的服务器在国外下载速度慢,所以需要更换源

以下两种方法任选一种

1.2.1 使用cnpm代替npm

参考链接:https://npm.taobao.org/

1
2
3
4
5
# 安装
npm install -g cnpm --registry=https://registry.npm.taobao.org

#安装完cnpm,之后再按照依赖就要使用cnpm
cnpm install [包名]

1.2.2 为npm更换源

参考链接 https://segmentfault.com/a/11…

修改源为淘宝的源

1
npm config set registry http://registry.npm.taobao.org/

我们在发布自己包的时候需要将官方的源改回来

1
npm config set registry https://registry.npmjs.org/

1.3 管理(更新)nodejs的版本

切换nodejs版本有两种方式,分别是nvmn,n更简单推荐使用

使用n管理nodejs版本

参考链接 https://www.jianshu.com/p/c64...

官网 https://github.com/tj/n

1
2
3
4
5
6
7
8
9
10
11
12
#安装
npm install -g n

#使用n下载所需node版本
n 版本号
#下载最新版本
n latest
# 切换版本
输入 n,
然后选中所需版本
#以指定的版本来执行版本
n use 7.4.0 index.js

linux使用n安装新版本nodejs之后,如果node -v还是原来的版本,那么就需要改变一下环境变量

1
2
3
4
vim .bash_profile
export NODE_HOME=/usr/local #NODE_HOME改成新版本nodejs安装的目录,如果找不到,find / -name node
export PATH=$NODE_HOME/bin:$PATH
export NODE_PATH=$NODE_HOME/lib/node_modules:$PATH

修改环境变量参考:https://blog.csdn.net/yi412/a…

1.4 package.json文件详解

参考文档 http://javascript.ruanyifeng….

2. vue脚手架

vue-cli目前已经更新到3版本,vue-cli3把webpack相关的配置隐藏起来了,所有的配置都在vue.config.js文件夹中,所以使用vue-cli3需要的webpack水平较高,建议使用vue-cli2

2.1 vue-cli2.x安装

参考链接:https://github.com/vuejs/vue-…

安装:

1
npm install -g vue-cli

用法:

1
$ vue init < template-name > < project-name >

例:

1
$ vue init webpack my-project

目前可用的模块包括:

  • webpack - 一个功能齐全的Webpack + vue-loader设置,具有热重载,linting,测试和css提取功能。
  • webpack-simple - 一个简单的Webpack + vue-loader设置,用于快速原型设计。
  • browserify -全功能Browserify + vueify设置用热重装载,linting&单元测试。
  • browserify -simple - 一个简单的Browserify + vueify设置,用于快速原型设计。
  • pwa - 基于webpack模板的vue-cli的PWA模板
  • simple - 单个HTML文件中最简单的Vue设置

2.2 vue-cli3.x安装及配置(仅供参考)

vue-cli3x的官方文档:https://cli.vuejs.org/

Vue-cli3 中vue.config.js文件配置参考文档:https://cli.vuejs.org/zh/conf…

Vue CLI 的包名称由 vue-cli 改成了 @vue/cli。 如果你已经全局安装了旧版本的 vue-cli(1.x 或 2.x),你需要先通过 npm uninstall vue-cli -gyarn global remove vue-cli 卸载它。

安装

1
npm install -g @vue/cli

安装了vue-cli3如果还想使用vue-cli2的init功能,需要安装一个桥接功能

1
npm install -g @vue/cli-init
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
// vue.config.js 配置说明
//官方vue.config.js 参考文档 https://cli.vuejs.org/zh/config/#css-loaderoptions
// 这里只列一部分,具体配置参考文档
module.exports = {
// 部署生产环境和开发环境下的URL。
// 默认情况下,Vue CLI 会假设你的应用是被部署在一个域名的根路径上
//例如 https://www.my-app.com/。如果应用被部署在一个子路径上,你就需要用这个选项指定这个子路径。例如,如果你的应用被部署在 https://www.my-app.com/my-app/,则设置 baseUrl 为 /my-app/。
baseUrl: process.env.NODE_ENV === "production" ? "./" : "/",

// outputDir: 在npm run build 或 yarn build 时 ,生成文件的目录名称(要和baseUrl的生产环境路径一致)
outputDir: "dist",
//用于放置生成的静态资源 (js、css、img、fonts) 的;(项目打包之后,静态资源会放在这个文件夹下)
assetsDir: "assets",
//指定生成的 index.html 的输出路径 (打包之后,改变系统默认的index.html的文件名)
// indexPath: "myIndex.html",
//默认情况下,生成的静态资源在它们的文件名中包含了 hash 以便更好的控制缓存。你可以通过将这个选项设为 false 来关闭文件名哈希。(false的时候就是让原来的文件名不改变)
filenameHashing: false,

// lintOnSave:{ type:Boolean default:true } 问你是否使用eslint
`lintOnSave`: true,
//如果你想要在生产构建时禁用 eslint-loader,你可以用如下配置
// lintOnSave: process.env.NODE_ENV !== 'production',

//是否使用包含运行时编译器的 Vue 构建版本。设置为 true 后你就可以在 Vue 组件中使用 template 选项了,但是这会让你的应用额外增加 10kb 左右。(默认false)
// runtimeCompiler: false,

/**
* 如果你不需要生产环境的 source map,可以将其设置为 false 以加速生产环境构建。
* 打包之后发现map文件过大,项目文件体积很大,设置为false就可以不输出map文件
* map文件的作用在于:项目打包后,代码都是经过压缩加密的,如果运行时报错,输出的错误信息无法准确得知是哪里的代码报错。
* 有了map就可以像未加密的代码一样,准确的输出是哪一行哪一列有错。
* */
productionSourceMap: false,

// 它支持webPack-dev-server的所有选项
devServer: {
host: "localhost",
port: 1111, // 端口号
https: false, // https:{type:Boolean}
open: true, //配置自动启动浏览器
// proxy: 'http://localhost:4000' // 配置跨域处理,只有一个代理

// 配置多个代理
proxy: {
"/api": {
target: "<url>",
ws: true,
changeOrigin: true
},
"/foo": {
target: "<other_url>"
}
}
}
};

二、开发

以下内容依赖环境为 : vue-cli 版本2.9.x

项目github地址 :

  • 前端 https://github.com/huangyangt…
  • 后端: https://github.com/huangyangt…

安装完以上依赖后,就可以开始一个项目了,我们先看下后端api的定义

前后端交互报文定义以及数据api接口

前后端交互报文定义

请求

1
2
3
4
5
6
http request header{ //除登录注册以外的请求,发起请求时要在请求头中加入token
authorization:jwt
}
http request body{

}

返回

1
2
3
4
5
6
7
8
9
http response header{

}
http response body{
code:业务处理状态码
msg:业务处理描述
token:jwt token
data:业务数据
}

项目中使用的后台api定义如下

1
注:服务器端的host为118.24.85.97,端口为22222

1.测试api是否可用

  1. uri: http://118.24.85.97:22222/api
  2. 描述:测试接口是否能用,能用的话返回 ‘API WORDS’字符串
  3. 请求类型 GET
  4. 请求参数 无
  5. 返回值 {‘Api Works’}

2.注册

  1. uri: http://118.24.85.97:22222/api/users/reg
  2. 描述:注册
  3. 请求类型 POST
  4. 请求参数
序号 参数名 是否必填 描述
1 name y 用户名
2 pass y 密码
  1. 返回参数 不重要

3.登录

  1. uri: http://118.24.85.97:22222/api/users/login
  2. 描述:登录
  3. 请求类型 POST
  4. 请求参数
序号 参数名 是否必填 描述
1 name y 用户名
2 pass y 密码
  1. 返回参数
序号 参数名 描述
1 msg ok
2 token 用于验证用户身份的token

4.获取当前用户信息

  1. uri: http://118.24.85.97:22222/api/users/current
  2. 描述:获取用户信息
  3. 请求类型 GET
  4. 请求参数 无
  5. 返回参数
序号 参数名 描述
1 id 用户id
2 token 用于验证用户身份的token

0.初始化项目

在终端中输入

1
vue init webpack vue2_template

然后会有一些选项让你选,按照项目需求选择,例如我不需要eslint,unit test,就可以选No,现在选no将来如果需要的话也可以自己安装

安装完成之后,按照提示切换到相应目录,执行相应指令,然后在浏览器打开网址,这样一个简单的vue项目就启动起来了

1. 项目文件介绍

整个文件介绍:

注意:

  1. 开发主要使用src文件夹
  2. webpack的配置文件配置文件详解看这里:https://segmentfault.com/a/11…
  3. package.json配置详解 http://javascript.ruanyifeng….

src目录介绍

首先在src目录下新建一个文件夹views,用来放我们的主要页面,然后在assets文件夹中建立fonts styles imgs,用来存放相应的资源,建完之后,文件夹如下

2. 跨域、axios配置与api管理

在这个项目中,我们使用axios进行数据请求

axios中文文档: https://www.kancloud.cn/yunye…

1
2
# 安装axios
npm/cnpm i axios -S # -S 指安装到package.json中的dependencies中

安装完成后,我们要在main.js中引入,然后测试一下是否成功引入

1
2
3
4
5
6
//main.js文件
import axios from 'axios'

axios.get('https://api.github.com/users?since=10') //使用github接口做一下测试
.then(res=>console.log(res))
.catch(err=>console.log(err))

浏览器显示以下信息,说明引入成功

github提供的接口配置了cors,所以我们能够能够在浏览器正常访问到,但cors兼容性最低到ie10,而且后台不一定会配置cors,所以在开发时我们需要配置一下跨域

参考链接:

  1. cors详解 http://www.ruanyifeng.com/blo…

2.1 配置跨域

参考文档:https://segmentfault.com/a/11…

先找个没有设置cors的api使用axios访问一下

1
2
3
axios.get('http://118.24.85.97:22222/api')
.then(res=>console.log(res))
.catch(err=>console.log(err))

浏览器会因为同源策略报错

下面进行跨域的配置

配置目录 config/index.js 13行

1
2
3
4
5
6
7
8
9
proxyTable: {
'/apis':{
target:'http://118.24.85.97:22222',//后台地址 proxyTable 把/apis映射成target 即 /apis=http://118.24.85.97:22222
changeOrigin:true,//是否跨域
pathRewrite:{
'^/apis':''
}
}
}

再进行访问数据时就要在接口前面加上/apis(/apis就相当于http://118.24.85.97:22222)

1
2
3
axios.get('/apis/api')
.then(res=>console.log(res))
.catch(err=>console.log(err))

然后就发现浏览器访问成功了

proxyTable原理:跨域是浏览器禁止的,服务端并不禁止跨域 ,所以浏览器可以发给自己的服务端然后,由自己的服务端再转发给要跨域的服务端,做一层代理。proxyTable使用的是http-proxy-middleware中间件,内部用的是http-proxy

以上配置的跨域是开发环境下的,在生产环境就自动失效了,而且这样配置我们开发时访问接口时,都要写成/apis/xxx/xxx格式,在部署到服务器中时,我们要把/apis拿掉,才能访问到正确的url。有两种方法,一种是在开发环境中设置(通过axios的baseURL),另一种是在服务器上修改nginx的配置设置。

2.2 生产环境去除/apis前缀

在这里详细说下第一种方式,原理是这样的:

通过检测是开发环境和生产环境,设置不同的baseURL,使生产环境和开发环境都能正确访问url

在src目录下新建一个apis目录,然后在apis目录下新建一个api.config.js文件

1
2
3
4
5
6
7
//判断是否是生产环境
//webpack在开发环境和生产环境分别执行不同的js文件,process.env.NODE_ENV设置了不同的值,process.env.NODE_ENV在生产环境中值为'production'(这个值是在build/build.js中第4行设置的)
var isPro = process.env.NODE_ENV=== 'production'
// 如果是生产环境 我们就使用服务器的uri,如果是开发环境,我们就添加/apis前缀
module.exports = {
baseUrl: isPro ? 'http://118.24.85.97:22222' : '/apis'
}

在main.js中引入这个文件,然后设置axios的baseURL

1
2
3
//引入api.config.js文件,然后设置axios的baseURL
import apiConfig from './apis/api.config'
axios.defaults.baseURL=apiConfig.baseUrl

再来测试一下不加/apis的接口

1
2
3
axios.get('/api')
.then(res=>console.log(res))
.catch(err=>console.log(err))

浏览器显示是ok的。这样我们以后使用axios访问接口就可以不加/apis了,打包后访问也不用手动去除/apis

2.3 api统一管理

在vue项目开发过程中,会涉及到很多接口的处理,当项目足够大时,就需要统一管理接口。

具体方法应该挺多的,这里只介绍一种:使用axios+async/await进行接口的统一管理

一般来说,后台的接口是分模块的,例如我们后台的测试接口

  • 身份认证 /api/login /api/reg
  • 用户信息 /v1/api/user

我们首先在src目录下新建一个apis文件夹,后台提供的所有接口都在这里定义

第二步,按照后台提供的模块新建js文件,我们新建user.js auth.js

第三步,引入axios,做相应的配置

在apis目录下新建一个http.js,在里面做axios相应的配置

  1. 我们上文中是在main.js文件引入的axios,设置的baseURL,以上代码可以去除,改为在http.js中引入
  2. 我们做的主要是:引入axios,创建一个axios的实例(实例的功能和axios一样)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
import axios from 'axios'
import apiConfig from './api.config'
//创建axios的一个实例
var instance = axios.create({
baseURL:apiConfig.baseUrl,
timeout: 6000
})


//------------------- 一、请求拦截器 后面介绍
instance.interceptors.request.use(function (config) {

return config;
}, function (error) {
// 对请求错误做些什么

return Promise.reject(error);
});

//----------------- 二、响应拦截器 后面介绍
instance.interceptors.response.use(function (response) {

return response.data;
}, function (error) {
// 对响应错误做点什么
return Promise.reject(error);
});

/**
* 使用es6的export default导出了一个函数,导出的函数代替axios去帮我们请求数据,
* 函数的参数及返回值如下:
* @param {String} method 请求的方法:get、post、delete、put
* @param {String} url 请求的url:
* @param {Object} data 请求的参数
* @returns {Promise} 返回一个promise对象,其实就相当于axios请求数据的返回值
*/
export default function (method, url, data = null) {
method = method.toLowerCase();
if (method == 'post') {
return instance.post(url, data)
} else if (method == 'get') {
return instance.get(url, { params: data })
} else if (method == 'delete') {
return instance.delete(url, { params: data })
}else if(method == 'put'){
return instance.put(url,data)
}else{
console.error('未知的method'+method)
return false
}
}

第四步,在apis/xxx.js文件中引入http.js导出的函数,拿其中一个文件auth.js说明

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
//auth.js 用于定义用户的登录、注册、注销等

import req from './http.js'

//定义接口

//在这里定义了一个登陆的接口,把登陆的接口暴露出去给组件使用
export const LOGIN =params=>req('post','/api/users/login',params)
//这里使用了箭头函数,转换一下写法:
// export const LOGIN=function(params){
// return req('post','/api/login',params)
// }

//定义注册接口
export const REG =params=>req('post','/api/users/reg',params)

最后一步,在需要用的该api的组件中引入并调用,我们在App.vue文件中测试下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<template>
<div>
<h2>登录</h2>
用户名<input type="text" v-model="user">
密码<input type="password" v-model="pass">
<input type="button" @click="reg" value="注册">
<input type="button" @click="login" value="登录">
</div>
</template>
<script>
import {LOGIN,REG} from '../../apis/auth.js'
export default {
data() {
return {
user:'',
pass:'',
err:[]
}
},
methods: {
async reg(){
try {
const data = await REG({ name: this.user,pass: this.pass })
console.log(data)
alert(JSON.stringify(data))
this.cleanForm()


} catch (error) {
console.log(error)
}

},
async login(){
try {
const data = await LOGIN({ name: this.user,pass: this.pass })
alert(JSON.stringify(data))
this.cleanForm()
} catch (error) {
console.log(error)
}
},
cleanForm(){
this.user=''
this.pass=''
}
},

}
</script>

注:如果要打开Login.vue,需要配置对应的路由

上面的代码引入了auth.js定义的api,并在对应的方法中使用。代码中用到了async/await,其实很简单,可以假设async是个标识,说明这个函数中有异步请求,await翻译为’等’,后面接一个异步请求,等后面的异步请求执行完成之后,会把结果赋给=左边的值

参考链接 http://www.runoob.com/w3cnote…

总结一下,像上面那样定义接口虽然麻烦点,但有两个好处:

  1. 代码看起来规范,所有的接口都在一个文件夹定义,不用分散的各个组件,维护起来简单,例如后台的一些url变了,改起来也方便
  2. 可以做到接口一次定义,到处使用

3. 路由配置

Vue Router官方文档 https://router.vuejs.org/zh/

前端路由原理:https://segmentfault.com/a/11…

3.1 最简配置

路由的配置文件在router/index.js文件中

先引入文件,再进行配置

首先在views目录中新建以下页面,主页(Home/Home.vue),登录页(Login/Login.vue),测试页(Test/Test.vue)

然后配置下路由

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
import Vue from 'vue'
import Router from 'vue-router'
//@表示 src目录 webpack的配置在webpack.base.conf.js第29行 alias{'@':resolve('src')}
import Home from '@/views/Home/Home.vue'
import Login from '@/views/Login/Login.vue'
import Test from '@/views/Test/Test.vue'

Vue.use(Router)

export default new Router({
routes: [//路由规则
{
path: '/',
name: 'Home',
component: Home
},
{
path:'/login',
name:'Login',
component:Login
},
{
path:'/test',
name:'Test',
component:Test
}
]
})

路由规则在routes中进行配置,routes是一个数组,接受一系列路由规则,每个路由规则是一个对象,包括路径、路由名字,和路径匹配的组件,建议给每个路由加个名字,在后面可能会用到。

打开浏览器,输入相应的url查看配置的路由是否正确,不正确的话检查下自己的配置

3.2 配置路由懒加载

参考文档:

路由懒加载官方文档:https://router.vuejs.org/zh/g…

webpack之mainfest解读:https://github.com/younth/blo…

当打包构建应用时,Javascript 包会变得非常大,影响页面加载。如果我们能把不同路由对应的组件分割成不同的代码块,然后当路由被访问的时候才加载对应组件,这样就更加高效了。所以,懒加载的含义是当路由被访问时再去加载对应的js代码。

首先,不做路由懒加载的情况下,我们打包一下(切换到项目目录,执行npm run build),然后会发现项目下生产了3个js文件

简单介绍一下作用:

  1. vendor.js 第三方库,一般是 node_modules里面的依赖进行打包 体积最大
  2. app.js 入口js打包的结果,即我们编写的所有代码都会打包进去
  3. manifest.js 主要是一些异步加载的实现方法(通过建立script方式动态引入js),内容上包含异步js的文件名和路径。

然后我们实现一下路由懒加载 @/router/router.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
import Vue from 'vue'
import Router from 'vue-router'
// import Home from '@/views/Home/Home.vue'
// import Login from '@/views/Login/Login.vue'
// import Test from '@/views/Test/Test.vue'
// 懒加载方式
const Home=()=>import('@/views/Home/Home.vue')
const Login=()=>import('@/views/Login/Login.vue')
const Test=()=>import('@/views/Test/Test.vue')
Vue.use(Router)

export default new Router({
routes: [
{
path: '/',
name: 'Home',
component: Home
},
{
path:'/login',
name:'Login',
component:Login
},
{
path:'/test',
name:'Test',
component:Test
}
]
})

懒加载只是改变了一下组件的引用方式,由原来的直接引入变成异步引入,当我们访问对应的路由path时,才会加载相应的路由组件。

配置完成后再执行一次打包,结果如下:

我们会发现目录中多出来3个js文件,并且app.js文件变小了。这说明配置了懒加载之后,app.js中其他组件的内容被抽离出来,分配到各自的js文件中。配置懒加载之后,刚开始打开页面只会加载app.js文件,只有在用户点击相应路由时,才会加载对应的js代码。当我们的业务代码非常多时,懒加载是个很好的选择。

3.3 配置history模式

官方文档:https://router.vuejs.org/zh/g…

配置history模式有两个原因,一是因为hash模式看很丑,二是因为预加载要用到History模式,配置非常简单,只需要配置属性mode的值为’history’

1
2
3
4
const router = new VueRouter({
mode: 'history',
routes: [...]
})

不过这种方式需要后台的支持,当匹配不到url时,返回url/index.html页面

nginx配置如下

1
2
3
location / {
try_files $uri /index.html;
}

4. 权限管理

参考链接:

json web token入门教程 http://www.ruanyifeng.com/blo…

jwt官网 https://jwt.io/

4.1 token验证

我们通过jwt进行用户认证,jwt的原理是:服务器认证以后,生成一个json对象,发回给用户.

1
2
3
4
5
6
{
"id":"001",
"姓名":"小明",
"角色":"管理员",
"到期时间":"2019年3月3日12时30分"
}

以后用户与服务端通信的时候,都要发回这个json对象。服务器完全靠这个对象认定用户身份(一般是通过这个对象的中id去数据库请求数据)。为了防止用户篡改数据,服务器会在生成这个对象的时候,加上签名。就像这种形式:

1
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

关于JWT保存更新的业务流程如下:

  1. 保存:登录后保存token
  2. 添加:每次发送请求之前检查token是否存在,存在,添加到请求头中,发送请求
  3. 更新:每次发送请求服务器返回数据之后更新token

主要逻辑包括:

  1. 登录之后,在localStorage中保存token
  2. 每次发送请求之前,使用axios请求拦截器将token放到请求头中
  3. 每次发送请求服务器返回数据之后在axios的响应拦截器中更新token
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
//1.登录之后保存token login.vue
async login(){
const data = await LOGIN({ name: this.user,pass: this.pass })
//保存token
localStorage.setItem('token',data.token)
//查看是否保存成功
console.log(localStorage.getItem('token'))
}
//每次发送请求之前,讲token放到请求头中 api/http.js
//---使用axios的请求拦截器,每次发送请求之前拦截一下
instance.interceptors.request.use(function (config) {
// 给头添加token
if (localStorage.getItem('token')){//存在token,加入头
config.headers.authorization=localStorage.getItem('token')
}
return config;
}, function (error) {
// 对请求错误做些什么

return Promise.reject(error);
});
//完成之后,记得发送一个请求,看看是否正确添加token

//---响应拦截器,服务器响应后先到达这里
instance.interceptors.response.use(function (response) {
if(response.data.code=='2000'){//成功响应,更新token
if(response.data.token){
localStorage.setItem('token',response.data.token)
}
}else{
//错误处理 根据不同的状态码,进行错误处理
}
return response.data;
}, function (error) {
// 对响应错误做点什么
return Promise.reject(error);
});

4.2 对页面的访问权限

除了对token的操作,我们还要判断用户有没有权限访问这个页面(有些页面是用户必须登录才能访问的),具体配置要使用Vue Router的导航守卫

参考链接:https://router.vuejs.org/zh/g…

在全局前置守卫中进行验证

1
2
3
4
5
6
7
8
9
10
11
//在router/index.js进行配置
//在每次进行路由跳转之前进行
router.beforeEach((to,from,next)=>{//增加登录验证
const isLogin=localStorage.getItem('token')?true:false;
if(to.path=='/login'){//如果是登录页面,不需要token
next();
}else{//如果不是登录页面就要判断是否登录
isLogin?next():next('/login');
}

})

5. 将界面交给第三方UI库

iview官网:https://www.iviewui.com/

为节省开发时间,我们往往会使用一些第三方ui库,比如iview elementui等

我们在这里只介绍iview,其他ui库大同小异

iview的安装与引入

安装

1
cnpm i iview --save

按需引入组件

官网说,需要下载插件才能按需引入,官网说明,但是不下好像也可以正常引入

1
2
3
4
5
6
//在main.js文件中引入项目需要的组件
import {Button,Table,Message} from 'iview'
//然后注册组件
Vue.component('Button',Button)
Vue.component('Table',Table)
Vue.component('Message',Message)

这样注册的话太繁琐,所以需要优化一下

1
2
3
4
//main.js
import {Button,Table,Message} from 'iview'
const iviewComs={Button,Table,Message}
Object.keys(iviewComs).forEach(key=>{Vue.component(key,component[key])})

代码都写在main.js中显得太拥挤,我们可以把代码拿出去,写成一个插件

我们在components文件夹中新建一个文件iview-coms,用来放iview中引入的组件

1
2
3
4
5
6
7
8
9
10
11
//components/iview-coms.js  

import {Button,Table,Message} from 'iview'
const components={Button,Table,Message}
const install = function(Vue, opts = {}){
Object.keys(components).forEach(key=>{
Vue.component(key,components[key])
})
}

export default install

然后在main.js中引入,use这个插件

1
2
import iviewComs from './components/iview-coms'
Vue.use(iviewComs)

ok了,接下来看自定义主题

自定义主题

官网链接:https://www.iviewui.com/docs/…

原理很简单,就是把ivew的less文件引入,并且覆盖掉,然后在main.js文件中引入自己的less文件

首先,我们需要下载解析less文件的loader ,lessless-loader,这里有个坑,下载less的时候要下载3版本以下的,不然会报一堆错误

1
cnpm i less@2.7.2 less-loader -D

下载完就ok了,不需要在webpack中进行配置,因为已经配置好了

然后,在assets/styles/base.less(没有需要自己新建)中,引入iview的样式文件,并且覆盖掉

默认变量列表:https://github.com/iview/ivie…

1
2
3
4
5
6
//assets/styles/base.less
//------ 引入iview样式
@import '~iview/src/styles/index.less';
//------ 覆盖iview的样式
@primary-color: #E91E63;
@error-color : #FF3300;

最后在main.js引入该less文件

1
2
//main.js
import './assets/styles/base.less'

此时,引入的组件就可以在.vue文件中使用了,看一下效果:

ok了。最后还要补充一下,在项目开发过程中,不可避免的要覆盖iview默认的样式,我们分为两种情况,一种是全局覆盖,一种是局部覆盖。

全局覆盖的话我们要新建一个less文件,比如叫cover-iview.less所有覆盖iview样式的代码都放在这里,然后在base.less中引入这个文件。

局部覆盖的话要注意不要影响到别的样式,所以要充分利用less的作用域,例如我们只需要改home页面下的iview按钮样式,我们可以这样:

1
2
3
4
5
.home{
.ivu-btn{

}
}

6.开发中注意问题

6.1编写自己的工具库插件

参考文档:

vue插件说明:https://cn.vuejs.org/v2/guide…

项目中往往会使用一些通用的函数,比如获取当前时间、时间格式转化,防抖,节流等,我们可以把这个公用的部分封装成插件,在main.js中引入。

首先,在src目录下新建utils文件夹,在里面新建index.js,utils.js文件

我们在utils.js中编写自己的工具库,然后导出

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class Utils{
constructor(){
this.d=new Date();//date对象
this.instance=null;
}
static getInstance(){//单例模式
if(!this.instance){
this.instance = new Utils();
}
return this.instance;
}

pick(obj,arr){//pick({ a: 1, b: '2', 'c': 3 }, ['a', 'c']) =>{a:1,c:3}
return arr.reduce((acc,curr)=>{
return (curr in obj && (acc[curr] = obj[curr]), acc)
},{})
}

dateFormat(datetime,pattern=""){
let vWeek = ["星期天","星期一","星期二","星期三","星期四","星期五","星期六"];
let dt=new Date(datetime);
let y=dt.getFullYear();
let m=(dt.getMonth()+1).toString().padStart(2,'0');
let d=dt.getDate().toString().padStart(2,'0');
let hh=dt.getHours().toString().padStart(2,'0');
let mm=dt.getMinutes().toString().padStart(2,'0');
let ss=dt.getSeconds().toString().padStart(2,'0');
let vWeek_s = dt.getDay();//星期
if(pattern.toLowerCase() === 'yyyy-mm-dd'){
return `${y}-${m}-${d}`
}else if(pattern.toLowerCase() === 'mm-dd'){
return `${m}-${d}`
}else if(pattern.toLowerCase() === 'yyyymmddhhmmss'){
return `${y}${m}${d}${hh}${mm}${ss}`
}else {
return `${y}-${m}-${d} ${hh}:${mm}:${ss} ${vWeek[vWeek_s]}`
}

}

}

const UTIL = Utils.getInstance();

// console.log(UTIL.dateFormat(new Date(),'yyyymmddhhmmss')) //=>20190312110722
// console.log(UTIL.dateFormat(new Date()))//=>2019-03-12 11:07:22 星期二
// console.log(UTIL.pick({ a: 1, b: '2', 'c': 3 }, ['a', 'c']))//=>{a:1,c:3}

export default UTIL;

然后在index.js中编写插件,导出

1
2
3
4
5
6
7
8
9
10
//utils/index.js

import UTIL from './utils.js'

const UtilPlugin={}

UtilPlugin.install=function(Vue,options){//插件必须有install方法,接受两个参数,一个是Vue构造器,一个是参数
Vue.prototype.$utils=UTIL//在vue prototype上添加实例方法
}
export default UtilPlugin

最后在main.js中引入并use插件

1
2
3
4
// utils
import Util from './utils/index'
Vue.use(Util)
console.log(Vue.prototype.$util)//打印下是否引入成功

之后就可以在组件中通过使用this.$utils调用方法了

7. 兼容性处理

我们的目标是兼容到ie9,对ie8及以下的浏览器做相应的跳转处理(跳转到浏览器下载界面)

兼容性对一个程序来说是非常重要的,兼容性测试越早越好

7.1 对ie8及以下浏览器的跳转处理

在项目根目录下中的html中head中加入下面代码

1
<!--[if lte IE 8]><script>window.location.href="https://support.dmeng.net/upgrade-your-browser.html?referrer="+encodeURIComponent(window.location.href);</script><![endif]-->

目的是检测ie浏览器的版本,如果低于<=ie8,就跳转到下面这个页面

7.2 兼容ie9

参考链接:https://juejin.im/post/5b2868…

7.2.1 ES6兼容

我们把浏览器调到ie9,然后看控制台报错信息

报这个错的原因是es6的新对象,新表达式,ie9不支持,为解决这个问题,我们需要引入babel-polyfill

1
cnpm i babel-polyfill -D

安装完成之后,在main.js文件中引入

1
import 'babel-polyfill'

在项目使用 vue-cli 生成的代码中,根目录有一个 .babelrc 文件,这是项目使用 babel 的配置文件。在默认生成的模板内容中,增加 "useBuiltIns": "entry" 的设置内容,这是一个指定哪些内容需要被 polyfill(兼容) 的设置

useBuiltIns 有三个设置选项

  • false - 不做任何操作
  • entry - 根据浏览器版本的支持,将 polyfill 需求拆分引入,仅引入有浏览器不支持的polyfill
  • usage - 检测代码中 ES6/7/8 等的使用情况,仅仅加载代码中用到的 polyfill

7.2.2建立自己的polyfill

加入这些代码后,工程中大部分代码已可以兼容到ie9版本,但还是会有少部分不兼容的特性,例如requestAnimationFrameclassList等。对于这些内容,我们需要自己定义polyfill来解决,在src目录下新建一个文件夹polyfill,然后在polyfill文件夹下面建一个polyfill.js,我们在polyfill.js中加入我们的兼容代码

然后在main.js中引入这个文件

1
import './polyfill/polyfill'

解决兼容方式的正确姿势是:拿到ie9浏览器下的报错信息,去goole或者baidu搜索,得到polyfill,然后加入到自己的polyfill.js文件中

三、优化

1. webpack3.x优化打包速度

我们执行一下npm run build,结果如下:

整个打包过程花了32s左右,现在我们的项目只是引入了相关的依赖,一些业务逻辑还没有写,打包速度就那么慢了,等到我们写完整个项目,打包速度还会继续变长,所以我们需要优化一下。

优化打包速度,我们修改的主要是webpack.prod.conf.js文件

替换代码压缩工具

Webpack 默认提供的 UglifyJS 插件,由于采用单线程压缩,速度慢 ;

webpack-parallel-uglify-plugin 插件可以并行运行 UglifyJS 插件,更加充分而合理的使用 CPU 资源,这可以大大减少的构建时间;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
//安装
cnpm i webpack-parallel-uglify-plugin -D
//配置 webpack.prod.conf.js

//首先删除项目中的 UglifyJsPlugin插件及配置,第二次打包时提高速度,要把.cache文件加入到gitignore中
// new webpack.optimize.UglifyJsPlugin({
// compress: {
// warnings: false,
// drop_console: true
// },
// sourceMap: true
// }),

//然后引入并使用我们刚才装的插件

==注意:版本控制工具提交时,要忽略.cache文件==

配置完后我们执行npm run build,发现打包速度降到了23s

再执行一次npm run build,发现打包速度降到了12s

时间降低那么多是因为文件没有改动,直接利用了缓存中的js文件

happypack开启多核构建项目

一般node.js是单线程执行编译,而happypack则是启动node的多线程进行构建,大大提高了构建速度。

首先安装,

修改webpack.base.conf.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
const HappyPack = require('happypack');
const os = require('os');
const happyThreadPool = HappyPack.ThreadPool({ size: os.cpus().length });
...
...
// 增加plugins
plugins: [
new HappyPack({
id: 'happy-babel-js',
loaders: ['babel-loader?cacheDirectory=true'],
threadPool: happyThreadPool,
})
]
...
...
// 修改对应loader
{
test: /\.js$/,
loader: 'happypack/loader?id=happy-babel-js',
include: [resolve('src'), resolve('test')],
}

配置完成,执行npm run build

what??并没有提高速度 不要用这个鬼东西了

hardSourceWebpackPlugin节省70%的时间

https://github.com/mzgoddard/…

1
2
#安装
cnpm install --save-dev hard-source-webpack-plugin

使用,在webpack.prod.conf.js中引入并使用

1
2
3
4
5
6
7
8
9
10
const HardSourceWebpackPlugin = require('hard-source-webpack-plugin');

module.exports = {
context: // ...
entry: // ...
output: // ...
plugins: [
new HardSourceWebpackPlugin()
]
}

结果:

注:要第二次打包才生效

总结下,使用了三个插件,我们的打包速度从30s降低到4s,awesome!

2. webpack3.x优化首屏加载速度

首先要说明一下,首屏加载速度优化针对的是打包后dist文件。我们如果要在本地进行测试的话,需要本地有个服务器,我们在这里使用nginx。

2.1本地安装nginx

下载地址: http://nginx.org/en/download….

在官网上找到自己系统适合的nginx版本,下载到本地

2.1.1window安装

  1. 解压文件
  2. 双击运行nginx.exe,在任务管理器中出现nginx的进程,则表示安装成功

2.1.2 mac/linux安装

1
2
3
4
5
6
7
8
9
10
11
#1.解压文件
tar -xzf nginx-1.14.0.tar.gz #mac可以使用解压缩工具解压,不必用命令行

#2. 配置安装路径 --prefix指定安装路径 假设我要装到/usr/local/nginx文件夹中
./configure --prefix=/Users/best9/local/nginx

#编译
make

##安装
make install

安装完成后进入到—prefix指定的文件夹中,执行ll,会发现文件夹下有以下目录

我们要关心就是我上面标出来的三个目录

进到sbin目录中,启动nginx程序

1
2
3
cd sbin
#需要使用root权限,否则会报错 报错信息可以在日志中查看到,错误日志目录 /logs/error.log
sudo ./nginx

正常的话,nginx会默认在localhost:80端口启动,在浏览器访问localhost,就会显示默认界面

如果电脑的80端口被占用的话,在conf/nginx.conf文件中修改端口

2.2 nginx常用命令

nginx使用-s发送信号操作运行中的进程,常用命令如下:

注意:使用命令需要在sbin目录下

1
2
3
4
5
6
7
8
#启动nginx
./nginx
#立即停止服务 -s stop
./nginx -s stop
#优雅地停止服务 -s quit
./nginx -s quit
#重启服务 -s reload
./nginx -s reload

2.3 nginx配置静态文件服务器

我们在这里使用nginx配置一个最简单的静态文件服务器,更复杂的配置稍后再讲

nginx的配置文件地址:conf/nginx.conf

使用vim或者其他编辑器打开该文件,修改配置文件第43-45行:

1
vim conf/nginx.conf

1
2
3
location / {
alias /Users/best9/github/vue2_template/dist; #访问/相当于访问alias配置的目录
}

配置完成后保存,然后重启服务

sudo ./sbin/nginx -s reload 要使用root权限重启

打开浏览器访问localhost

因为没有登录,会自动跳转到登录界面

到这里静态文件服务器就配置好了,但我们刷新下页面,会报错404

这是因为我们使用了vue router的history模式,我们需要在nginx中加入以下配置

1
2
3
location / {
try_files $uri $uri/ /index.html;
}

然后重启nginx,再刷新页面就没问题了

2.4 优化首屏加载速度

以上步骤就绪后,我们就可以来优化加载速度了

打开chrome的devTools面板,切换到Network,禁用浏览器缓存,刷新测试下加载速度,发现整个应用加载大约需要1.97s,如下图:

把网络环境切换到Fast 3G,再测试一次,发现加载用了7.56s,白屏时间6.89s

我们使用预渲染插件进行优化

2.4.1 预渲染

使用插件:prerender-spa-plugin

参考链接:https://juejin.im/post/59d49d…

首先,安装 prerender-spa-plugin,安装时件略长,因为其依赖了 phantomjs

1
cnpm install prerender-spa-plugin --save-dev

我们只在生产环境中进行预渲染,修改build/webpack.prod.conf.js,在配置插件的地方加入如下代码。

1
2
3
4
5
6
7
8
9
10
//引入 预渲染插件
const PrerenderSpaP=require('prerender-spa-plugin')

//在plugins中配置
new PrerenderSpaP(
// 输出目录的绝对路径
path.join(__dirname,'../dist'),
//预渲染路由
['/home','/login']
)

再次执行打包,然后再进行测试:

发现白屏时间为4.10s,在弱网环境下,使用预渲染,大约能缩减2.5秒的白屏时间

预渲染注意事项
  • 预渲染的路由不能是动态加载的,否则会报webpackJsonp is not define的错误,要想解决这个错误,可以看这里 https://juejin.im/entry/5911a…
  • 预渲染的路由不能是需要权限才能访问的页面。预渲染的机制是在本地跑一个chromium浏览器,然后去爬取你预渲染页面的Html,如果你的页面需要权限(登录)才能进入,就爬不到,也不会报错,最终只会渲染不需要权限的页面

举个例子:

插件配置如下:

1
2
3
4
new PrerenderPlugin({
staticDir:path.join(__dirname,'../dist')
routes:['/','/about','/login']
})

路由配置如下:

2.4.2 配置gzip压缩

gzip官方文档 http://nginx.org/en/docs/http…

nginx默认是关闭gzip的,我们需要自己打开,并进行一些配置:

1
2
3
4
gzip:on;  #打开gzip,关闭为off
gzip_min_length 1; #小于gzip_min_length,不进行压缩(默认单位为byte)
gzip_comp_level 2; #压缩级别
gzip_types text/plain text/css application/javascript text/javascript image/jpeg image/gif image/png;#指定类型进行gzip压缩

配置完成后,我们再测试一下加载速度:

发现白屏时间为1.95s,加载文件的体积也变小了

四、部署

1. nginx配置反向代理

我们要在本地部署测试,所以后台的地址是127.0.0.1:22222

项目开发完成后需要部署到服务器,因为是前后端分离,所以前端的应用部署到nginx,后端的应用部署到自己对应的服务器,所以我们需要配置一下,把后端的服务器变成上游服务,nginx做反向代理服务器

反向代理:服务器根据客户端的请求,从其关系的一组或多组后端服务器上获取资源,然后将这些资源返回给客户端。

由于上游服务器(后台服务器)要处理非常复杂的逻辑,所以性能不怎么样,我们使用nginx作为反向代理服务器后,可以将请求按照负载均衡算法代理给多台上游服务器。配置如下:

以上配置是将所有的请求转发给上游服务器,但如果我们只想将动态请求转发给上游服务器,静态资源由nginx自己处理,就可以这样做:

判断是否是后台api(根据location的匹配规则),如果是的话,就进行转发

匹配规则看这里:https://stackoverflow.com/que…

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
upstream local{
server 127.0.0.1:22222; #假设在本地部署
}
server{
listen:80;
server_name localhost;
location ~ /api/ { #以`/api/`开头的uri就行转发,否则不转发 ~代表正则表达式匹配
proxy_set_header: Host $host;
proxy_set_header: X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_pass http://local;
}
location / {
#... alias index等配置

}
}

这里需要注意一个问题:proxy_pass是转发请求的模块,当你访问localhost:80/api/users/login时,会被转发到local的地址,即127.0.0.1:22222/api/users/login,所以开发环境下访问后台接口的URI要写你部署到nginx的URI,而不是真正的后台地址(因为被转发了)

前端配置

1
2
3
4
5
6
//apis/api.config.js
//判断是否是生产环境
var isPro = process.env.NODE_ENV=== 'production'
module.exports = {
baseUrl: isPro ? 'http://localhost:80' : '/apis'//生产环境下的baseURl是nginx的hoost:port
}

2. 持续部署

项目做完需要发布到服务器,但每次手动打包,然后ftp传上去的话就太麻烦了,所以我们的需求是:git或者svn提交后,自动打包发布到服务器。使用的工具是jenkins.

参考文档:

https://juejin.im/post/5ad198...

官网:https://jenkins.io/

jenkins安装与启动

jenkins一般情况下会装在服务器,但如果是同一个局域网的话,装在本机也可以

linux:

  1. https://blog.csdn.net/fenglai…)
  2. https://www.jianshu.com/p/8a7… (centos)
  3. 配置文件地址 /etc/sysconfig/jenkins
  4. 工作空间 /var/lib/jenkins

windows下:

  1. 从Jenkins官网下载最新war文件。
  2. 运行java -jar jenkins.war即可。

mac:

  1. 从官网下载pkg文件
  2. 双击安装,安装之后自己就会启动

jenkins初始化

  1. jenkins的默认端口是8080,启动成功后在浏览器打开。
  2. 进入后会让我们输管理员密码,打开网页上提示路径下的文件,复制密码粘贴输入即可。
  3. 然后会让安装需要的插件,此处选默认即可,等待安装完成。
  4. 创建一个管理员账户。
  5. 上面都完成后会看到这个界面。

创建任务

在主页上点击创建

直接点保存,然后去安装插件

安装插件

首先返回主页,然后点击左侧菜单 系统管理->插件管理

需要安装的插件有:

  • Generic Webhook Trigger 实现git提交触发更新功能
  • Publish Over SSH 实现服务器部署功能
  • nvm wrapper 引入node

安装插件的方式:

安装完插件之后重启一下jenkins(安装完插件后,有个重启的选项,勾选即可)

实现git钩子功能

当我们向github/码云等远程仓库push我们的代码时,jenkins能知道我们提交了代码,这是自动构建自动部署的前提,钩子的实现原理是在远端仓库上配置一个Jenkins服务器的接口地址,当本地向远端仓库发起push时,远端仓库会向配置的Jenkins服务器的接口地址发起一个带参数的请求,jenkins收到后开始工作

打开创建的项目(进入工程->点击配置)

构建触发器

勾选 Generic Webhook Trigger

github仓库配置钩子:

进入github项目中该项目页面,点击setting->webhooks,添加payload URL,

URL格式为 http://<User ID>:<API Token>@<Jenkins IP地址>:端口/generic-webhook-trigger/invoke userid和api token在jenkins的系统管理-管理用户-选择你的用户点进去-左侧设置

实现自动化构建

自动化构建:jenkins实现安装依赖,打包(npm install && npm run build),此外还可以执行一些测试行为

点击构建环境,勾选nvm,输入node版本

点击构建,选择执行shell,输入执行命令,多个命令使用&&分开

1
2
3
npm config set registry http://registry.npm.taobao.org/ &&
npm install &&
npm run build
坚持原创技术分享,您的支持将鼓励我继续创作!
  • 本文作者: Leo
  • 本文链接: https://xuebin.me/posts/65e66eaf.html
  • 版权声明: 本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!