【vue】---- 新版脚手架搭建项目流程详解

一、概述

本文将介绍vue项目完整的搭建流程，在使用新版本的脚手架基础上，进行了一系列的完善和配置。主要内容如下：

1、项目初始化

• 安装脚手架
• 创建项目
• 项目结构

2、项目搭建配置

• 引入第三方插件
• 路由管理模块vue-router的配置
• 状态管理模块vuex的配置
• 请求模块axios的配置
• 环境变量的配置
• 配置文件config的配置

二、项目搭建

1、项目初始化

（1）安装脚手架

• 全局安装过旧版本的 vue-cli(1.x 或 2.x)要先卸载它，否则跳过此步：npm uninstall vue-cli -g

• Vue CLI 3 需要 nodeJs ≥ 8.9 (官方推荐 8.11.0+，可以使用 nvm 或 nvm-windows 在同一台电脑中管理多个 Node 版本）下载安装nodeJs，中文官方下载地址：http://nodejs.cn/download/ 
• 安装 @vue/cli（Vue CLI 3 的包名称由 vue-cli 改成了 @vue/cli）：cnpm install -g @vue/cli
• vue -V   检查版本号

 

（2）创建项目

• vue create <Project Name>

① 选择一个预设 preset

若此前有保存过的预设配置可直接使用，若没有则只有 Default 和 Manually select features。

Default：默认配置，不带任何辅助功能；

Manually select features：自定义配置（按方向键 ↓ 和空格），提供可选功能的 npm 包。

② 是否使用history router

Vue-Router 利用了浏览器自身的hash 模式和 history 模式的特性来实现前端路由。

③ CSS 预处理器

为css解决浏览器兼容问题、简化css代码。

④ ESlint

提供一个插件化的javascript代码检测工具，ESLint + Prettier //使用较多

⑤ 何时检测

⑥ 如何存放配置

⑦ 是否保存本次配置（y:记录本次配置，然后需要你起个名; n：不记录本次配置）

⑧ 搭建完成

⑨ 启动初始项目

⑩ 初始效果

（3）项目结构

① 初始项目目录

 

② 完善项目目录　　

　　|— node_modules
　　|— public　　　　　　　　　　   //  不做编译处理的静态资源
　　|— src　　　　　　　　　　　    //  源代码
　　|　 |— api　　　　　　　　　      //  所有请求
　　|　 |— asssts　　　　　　　  　  //  主题、字体等静态资源
　　|　 |— components　　　　  　   //  全局公用组件
　　|　 |— directive　　　　　　    　//  全局指令
　　|　 |— filtres　　　　　　　　     //  全局 filter
　　|　 |— router　　　　　　  　 　  //  路由
　　|　 |— store　　　　　　　   　   //  vuex
　　|　 |— styles　　　　　　　    　 //  全局样式
　　|　 |— utils　　　　　　　　    　//  全局公用方法
　　|　 |— views　　　　　　　 　    //  页面
　　|　 |— APP.vue　　　  　　　 　 //  入口页面
　　|　 |— main.js　　　　  　　 　   //  入口 加载组件 初始化
　　|　 |— permission.js　　  　　     //  权限管理
　　|— .env.development　　 　　    //  开发环境
　　|— .env.production　　　 　　    //  生产环境
　　|— .env.test　　　　　　             //  测试环境
　　|— vue.config.js　　　　　　      //  配置文件
　　|— .browerslistrc　　　　　    　 //  设置浏览器的兼容
　　|— .eslintrc.js　　　　　　  　    //  eslint 代码检测配置项
　　|— .gitignore 　　　　　　  　    //  git 忽略项
　　|— babel.config.js　　　　  　    //  babel 语法编译
　　|— package-lock.json　　　       //  记录版本号
　　|— package.json　　　　  　 　 //  项目基本信息
　　|— README.md　　　　  　 　 //  项入门手册

注：
> api 中的文件名称最好与 views 中的模块名称一致对应，方便查看和管理。
> 要根据业务场景判断是否需要 vuex 统一管理数据，耦合度较低的直接在模块中存放 data 即可。
> 统一一套 ESLint，方便检测代码格式。
> 在新版脚手架中去掉了 config 和 build 两个配置文件，换成了可选的 vue.config,js 文件。
> 在新版脚手架中去掉了 static，换成了 public。

 2、项目搭建配置

（1）引入第三方插件

① 在项目中根据实际需求引入第三方插件，比如常用的 less/sass、axios、elementUI(或其他UI框架)...若在新版脚手架创建项目过程中没有自定义配置选择vuex、router，则也需要进行安装。

　下载依赖包：

　 less：npm install less less-loader --save

　  element-ui：npm install element-ui --save

　  axios：npm install axios --save

　  ......

② 安装完成后见 package.json 如下：

 

 ③ 在 main.js 中引入相关插件：

 

（2）路由管理模块vue-router的配置（router/index.js）

使用路由懒加载，防止首屏加载慢或白屏的问题。

(3) 状态管理模块vuex的配置

① store 文件夹目录

 

 ② index.js 文件

 ③ getters.js 文件

 ④ modules/user.js 文件

（4）请求模块axios的配置

// src/utils/request.js

import axios from 'axios'
import { Message } from 'element-ui'
import store from '../store'
import { getToken } from '@/utils/auth'


// 创建axios实例
const service = axios.create({
  baseURL: process.env.BASE_API, // api的base_url
  timeout: 20 * 1000 // 请求超时时间
})


// 不需要token的路径
const urlWithoutToken = [
    '/main/login',
    '/main/password/reset'
  ]


// request拦截器
service.interceptors.request.use(config => {
  if (store.getters.token && !urlWithoutToken.includes(config.url)) {
    config.headers['Authorization'] = 'Bearer ' + getToken() // 让每个请求携带自定义token 请根据实际情况自行修改
  }
    return config
  }, error => {
    Promise.reject(error)
})


// 特殊的错误码
const specialCodes = [
  '00302' // 刷新token过期
]
const commonCodes = ['00000']


// respone拦截器
service.interceptors.response.use(response => {
  const res = response.data
  // 对除了特殊错误码以外的进行统一处理
  if (res.code && !specialCodes.includes(res.code) && !commonCodes.includes(res.code) && !(res instanceof Blob)) {
    Message({
      message: res.message ? res.message : res.info || res.desc || res.status.desc,
      type: 'error',
      duration: 5 * 1000,
      customClass: 'max-index'
    })
    return res
  } else {
    return res
  }
}, async error => {
  // 这里可以对401、403、400、500等不同情况进行处理
  if (error.response.status === 500) {
    if (error.response.config.url.indexOf('main/login/refresh/') !== -1) {
      return Promise.reject(error)
    } else {
      Message({
        message: error.response.data.message || '请求失败',
        type: 'error',
        duration: 5 * 1000,
        customClass: 'max-index'
      })
      return Promise.reject(error)
    }
  } else {
    Message({
      message: error.response.data.message || '请求失败',
      type: 'error',
      duration: 5 * 1000,
      customClass: 'max-index'
    })
    return Promise.reject(error)
  }
})


export default service

（5）环境变量的配置

① 在项目根目录创建配置环境变量所需文件

.env.development 文件：开发环境

NODE_ENV = "development"
VUE_APP_BASE_API = "https://localhost:8080/api"
VUE_APP_DOWNLOAD_URL="http://web-txzs-test.ctsiyun.cn:30080"

.env.production 文件：生产环境

NODE_ENV = "production"
VUE_APP_BASE_API = "/api"
VUE_APP_DOWNLOAD_URL="http://txzs.ctsiyun.cn"

.env.test：测试环境 

NODE_ENV = "testing"
VUE_APP_BASE_API = "/api"
VUE_APP_DOWNLOAD_URL="http://web-txzs-test.ctsiyun.cn:30080"

② 在 package.json 进行修改

"scripts": {

    "dev": "vue-cli-service serve --mode development",

    "build--test": "vue-cli-service build --mode test",

    "build--prod": "vue-cli-service build --mode production",

    "build": "vue-cli-service build",

    "lint": "vue-cli-service lint"

  }

 ③ 使用

npm run dev          // 本地运行

npm run build:test   // 测试环境打包

npm run bnuild:prod  // 生产环境打包

（6）配置文件config的配置

 在项目根目录下创建 vue.config.js 文件，它是一个可选的配置文件，如果项目的根目录存在这个文件，那么它就会被 @vue/cli-service 自动加载。

const webpack = require('webpack')
module.exports = {
    //部署应用包时的基本 URL, 在vue-cli.3.3版本后baseUrl被废除了,因此要写成 publicPath
    publicPath: process.env.NODE_ENV === 'production' ? '/online/' : './',
    //当运行 vue-cli-service build 时生成的生产环境构建文件的目录
    outputDir: 'dist',
    //放置生成的静态资源 (js、css、img、fonts) 的 (相对于 outputDir 的) 目录
    assetsDir: 'assets',
    // eslint-loader 是否在保存的时候检查 安装@vue/cli-plugin-eslint有效
    lintOnSave: true,
    //是否使用包含运行时编译器的 Vue 构建版本。设置true后你就可以在使用template
    runtimeCompiler: true,
    // 生产环境是否生成 sourceMap 文件 sourceMap的详解请看末尾
    productionSourceMap: true,
    configureWebpack: config => {
        if (process.env.NODE_ENV === 'production') {
            // 为生产环境修改配置...
        } else {
            // 为开发环境修改配置...
        }
    },
    // css相关配置
    css: {
        // 是否使用css分离插件 ExtractTextPlugin 生产环境下是true,开发环境下是false
        // extract: true,
        // 开启 CSS source maps?
        sourceMap: false,
        // css预设器配置项
        loaderOptions: {},
        // 启用 CSS modules for all css / pre-processor files.
        modules: false
    },
    // webpack-dev-server 相关配置
    devServer: { // 设置代理
        hot: true, //热加载
        host: '0.0.0.0', //ip地址
        port: 8092, //端口
        https: false, //false关闭https，true为开启
        open: true, //自动打开浏览器
        proxy: {
            '/api': { //本地
                target: 'xxx',
                // 如果要代理 websockets
                ws: true,
                changeOrigin: true
            },
            '/test': { //测试
                target: 'xxx'
            },
            '/pre': { //预发布
                target: 'xxx'
            },
            '/pro': { //正式
                target: 'xxx'
            }
        }
    },
    pluginOptions: { // 第三方插件配置
        // ...
    },
    // 热更新配置 修改css部分热更新还需要注释掉 extract: true
    chainWebpack: config => {
       // 修复HMR
        config.resolve.symlinks(true);
    }
}