vue项目通过命令行传参实现多环境配置(基于@vue/cli)

大多数项目都有生产环境和开发环境,一般情况下应该够了,但是有时候还需要sit,uat,本地等环境,这时候假如要通过注释的方式切换环境就相当麻烦了. 如果可以像下面这样切换环境就方便了

npm run serve //默认本地开发环境

npm run serve -sit //本地开发中使用sit环境

npm run serve -uat //本地开发中使用uat环境

npm run build //默认打包后使用生产环境

npm run build -local //打包后使用本地环境

npm run build -sit //打包后使用sit环境

npm run build -uat //打包后使用uat环境

如果对@vue/cli还不熟的话，建议看看这篇文章

我们首先在根目录下面创建一个vue.config.js文件,如图

vue.config.js代码如下:

const webpack = require('webpack')
const environment = require('./build/environment')

module.exports = {
  baseUrl: '/wxperp/',
  configureWebpack: {
    plugins: [
      new webpack.DefinePlugin({
        'process.env.STAGE': JSON.stringify(environment.stage),
        'process.env.LOCAL_URL': JSON.stringify(environment.localUrl)
      })
    ]
  }
}

new webpack.DefinePlugin的作用是允许你创建一个在编译时可以配置的全局常量

然后在根目录创建一个build文件夹,里面创建一个environment.js的文件

environment.js代码如下:

const os = require('os')

// 获取命令行变量
const configArgv = JSON.parse(process.env.npm_config_argv)
const original = configArgv.original.slice(1)
const stage = original[1] ? original[1].replace(/-/g, '') : ''
// 本地ip地址
let localUrl
try {
  const network = os.networkInterfaces()
  localUrl = network[Object.keys(network)[0]][1].address
} catch (e) {
  localUrl = 'localhost'
}
localUrl = 'http://' + localUrl + '/'

module.exports = {
  stage, localUrl
}

这个stage就是你输入的变量,比如你输入npm run serve -sit那么stage的值就为sit

这个localUrl就是你本地的ip,不过很多人应该用不到,我们公司比较特殊,开发的时候,接口请求的地址都是请求的自己本地服务器, 如果不自动获取本地ip,那么每个同事都得在配置文件中保留一份自己得ip地址,很麻烦，所以就自动获取了.

接下来再src目录下面创建一个config.js,记得在main.js中引用这个config.js

config.js代码如下:

(() => {
  const urlMap = {
    local: process.env.LOCAL_URL + 'api',
    sit: 'http://xxx.xxx.xxx:xxxx/sit/api',
    uat: 'http://xxx.xxx.xxx:xxxx/uat/api',
    prod: 'http://xxx.xxx.xxx:xxxx/prod/api'
  }
  //sit,uat,prod
  let stage = process.env.STAGE
  //development,production
  const nodeEnv = process.env.NODE_ENV
  //nodeEnv为production并且stage不存在默认为生产环境
  if (nodeEnv === 'production' && !stage) {
    stage = 'prod'
  } else {
    //stage不存在默认为本地开发环境
    stage = stage || 'local'
  }

  console.log('ip:' + urlMap[stage])
})()

我们输入npm run serve -sit,页面打印如下:

再啰嗦下,process.env.NODE_ENV是@vue/cli提供的,貌似有三个值(development,production,test),

你运行npm run serve得到的就是development

你运行npm run build得到的就是production

你运行npm run test得到的就是test (我没试过)

我默认打包是打包生产环境,当然你也可以输入参数打包其他环境

demo地址