vue cli 3.0中的vue.config.js主要配置及解析

在我们创建一个vue项目的时候，vue cli3 不会为我们创建 vue.config.js 文件。

vue.config.js 是一个可选的配置文件，如果项目的根目录中存在这个文件，那么它会在vue项目启动时自动加载。

// 包含选项的对象
module.exports = {
    // 包含的选项
}

 module.exports 是一个包含了各种选项的对象。

// 包含选项的对象
module.exports = {
    // 默认静态资源路径 (可添加相对路径)
    publicPath: "./",
    // publicPath: "/",
}

 在 publicPath 中它可用的值为 Srting 类型，其中 "./" 表示静态资源可以在当前文件夹中找到（相对路径），"/" 表示静态资源在根路径当中可以找到（绝对路径）。

但一般情况是以以下的形式写的：

// 包含选项的对象
module.exports = {
    // 默认静态资源路径 (可添加相对路径) 需要区分 生产环境 和 开发环境
    publicPath: process.env.NODE_ENV === "production" ? "/dist/" : "/",
    // publicPath: process.env.NODE_ENV === "production" ? "./" : "/",
    // build的输出目录 默认为'dist'
    outputDir: "dist"
    // 用于放置生成的静态资源 (js、css、img、fonts);(项目打包之后，静态资源会放在这个文件夹下)
    assetsDir: 'static',
}

这时有人肯定会说用 "/" 或者 "./" 不就行了吗？但为什么要写 process.env.NODE_ENV === "production" ? "/dist/" : "/" 或 process.env.NODE_ENV === "production" ? "./" : "/" 呢？

因为当vue项目被打包后会被放到 dist 目录之中，在运行时，路径会变成 **/dist/** 导致静态资源不能展现。

ps：outputDir 默认为 dist 目录。

 用 lintOnSave 来设置是否每次保存进行代码检测，一般会使用 process.env.NODE_ENV === 'development' 来进行判断，开发环境使用，生产环境不使用。

 如果你不需要生产环境的 source map，可以将 productionSourceMap 设置为 false 以加速生产环境构建用。

// 包含选项的对象
module.exports = {
    // 是否每次保存进行代码检测
    lintOnSave: process.env.NODE_ENV === 'development',
    // 如果你不需要生产环境的 source map，可以将其设置为 false 以加速生产环境构建。
    productionSourceMap: false,
}

 到目前为止一些比较常用的就介绍完了，现在需要对最重要的 devServer 进行了解了。

 devServer 最简单的理解，就是前端需要进行请求后端所提供的接口时，对请求进行拦截和处理的一个中间组件。

在 devServer 中最常用的参数为以下几种：

// 包含选项的对象
module.exports = {
    devServer: {
        open: true,                 // 启动后自动打开默认浏览器
        host: '0.0.0.0',            // 启动时使用的域名
        port: 8080,                 // 指定端口号
        https: false,               // 是否使用https协议
        hotOnly: false,             // 是否打开热更新
        disableHostCheck: true,     // 是否关闭HOST检查, 关闭后可以接受来自任何HOST的请求
        proxy: ""                   // 跨域配置
        }
    }
}

最简单的一种跨域是直接使用 proxy ，如下所示：

module.exports = {
    devServer: {
        proxy: 'http://123.123.12.1:8080'
    }
}

 意思就是将所有请求代理到 'http://123.123.12.1:8080' 之中去。比如：

之前的响应地址为 http://192.234.14.7:8848/login

                                                ↓↓↓↓↓

代码运行后结果就为 http://123.123.12.1:8080/login

 但一般情况下都是以以下的方式来请求代理的：

// 包含选项的对象
module.exports = {
    devServer: {
        open: true,                 // 启动后自动打开默认浏览器
        host: '0.0.0.0',            // 启动时使用的域名
        port: 8080,                 // 指定端口号
        https: false,               // 是否使用https协议
        hotOnly: false,             // 是否打开热更新
        disableHostCheck: true,     // 是否关闭HOST检查, 关闭后可以接受来自任何HOST的请求
        proxy: {
            '/api': {
            // '/api' 的意义在于，声明axios中url已/api开头的请求都适用于该规则，
            // 注意是以/api开头，即：axios.post({url: '/api/xxx/xxx'})
                // 目标服务器地址
                target: '',
                // 代理websockets
                ws: true,
                // 开启代理 (允许跨域)
                changeOrigin: true,
                pathRewrite: {
                    //重写路径 比如'/api/aaa/ccc'重写为'/aaa/ccc'
                    '^/api': '',
                }
            },
        }
    }
}

其中 host 默认为 'localhost' 当声明为 '0.0.0.0' 时，就说明可以通过 内网地址 或 外网地址 都可以访问该应用。

以上是我个人的理解，vue.config.js文件代码以附到下方，如有不对的地方还请大佬斧正。

参考 配置参考 | Vue CLI️ Vue.js 开发的标准工具https://cli.vuejs.org/zh/config/#vue-config-js

vue.config.js文件：

// 包含选项的对象
module.exports = {
    // 默认静态资源路径 (可添加相对路径) 需要区分 生产环境 和 开发环境
    publicPath: process.env.NODE_ENV === "production" ? "/dist/" : "/",
    // build的输出目录 默认为'dist'
    outputDir: "dist",
    // 放置静态资源的目录
    assetsDir: "static",
    // 是否每次保存进行代码检测
    lintOnSave: process.env.NODE_ENV === 'development',
    // 如果你不需要生产环境的 source map，可以将其设置为 false 以加速生产环境构建。
    productionSourceMap: false,
    devServer: {
        open: true,                 // 启动后自动打开默认浏览器
        host: '0.0.0.0',            // 启动时使用的域名
        port: 8080,                 // 指定端口号
        https: false,               // 是否使用https协议
        hotOnly: false,             // 是否打开热更新
        disableHostCheck: true,     // 是否关闭HOST检查, 关闭后可以接受来自任何HOST的请求
        proxy: {
            '/api': {
            // '/api' 的意义在于，声明axios中url已/api开头的请求都适用于该规则，
            // 注意是以/api开头，即：axios.post({url: '/api/xxx/xxx'})
                // 目标服务器地址
                target: '',
                // 代理websockets
                ws: true,
                // 开启代理 (允许跨域)
                changeOrigin: true,
                pathRewrite: {
                    //重写路径 比如'/api/aaa/ccc'重写为'/aaa/ccc'
                    '^/api': '',
                }
            },
        }
    }
}