AICODER大前端培训

AICODER-IT培训专家,前端培训基地,前端培训,全栈培训,大学生IT培训基地,线上IT课程免费自学,线下培训项目实战,实习,html5培训实习-AICODE程序员

在线咨询

Vue-cli3与webpack设置自定义环境变量以区分打包后不同环境不同输出

AICODER官方 发布于: 2019年7月13日 11时15分50秒 阅读3797次

你有没有遇到过这样的情况!比如你们有四种(或更多)环境:开发环境(本地调式代码环境)、测试环境(脏数据环境)、预生产环境(无限接近生产环境)、生产环境(正式环境或线上环境)等等环境。而对于不同环境你的静态资源host地址或者你的微信appid等等可能是不一样的。关于这个问题我之前大概经历了三个阶段。

第一阶段:

每次发布,都去注释修改。比如:

第二阶段:

通过window.location.host来判断。比如:

第三阶段:

通过process.env.NODE_ENV来判断。比如:

目前进入第四阶段,就是用webpack的DefinePlugin,其实这个早就有了,只是自己没去仔细看,感觉自己好渣渣


(其实本来就很渣渣


,也会一直渣渣下去


,在渣渣的路上越走越远


)。

第四阶段:

废话说了很多,进入正题:

比如上面的第三阶段通过process.env.NODE_ENV来判断,只能区分开发环境和发布环境,这个发布环境可能有 测试环境、预生产环境、生产环境,那怎么办?我们可以设置process.env.NODE_ENV,这里我们使用 cross-env 来设置,它是跨平台的。

npm i -D cross-env

比如我们这么设置:

    "test": "cross-env NODE_ENV=test webpack",
    "per": "cross-env NODE_ENV=preproduction webpack",
    "pro": "cross-env NODE_ENV=production webpack"

然后代码这么写:

console.log(process.env.NODE_ENV);

我们执行下命令:

npm run test
npm run per
npm run pro

发现打包后都是:

这是因为webpack 配置文件里定义了,如下:

这个时候我们就需要用到 webpack的DefinePlugin了,如下设置:

new webpack.DefinePlugin({
      "process.env": {
        NODE_ENV: JSON.stringify(process.env.NODE_ENV)
      }
    })

我们再执行下命令:

npm run test

npm run per

npm run pro

完美实现!

我们还可以自定义!

比如这样:

"test": "cross-env NODE_ENV_QDRR=test webpack","per": "cross-env NODE_ENV_QDRR=preproduction webpack","pro": "cross-env NODE_ENV_QDRR=production webpack"

执行上面的三条命令,也会等到相同的结果:



那么在Vue-cli3中如何配置环境变量呢?

环境变量和模式

你可以替换你的项目根目录中的下列文件来指定环境变量:

.env                # 在所有的环境中被载入.env.local          # 在所有的环境中被载入,但会被 git 忽略.env.[mode]         # 只在指定的模式中被载入.env.[mode].local   # 只在指定的模式中被载入,但会被 git 忽略

一个环境文件只包含环境变量的“键=值”对:

FOO=bar
VUE_APP_SECRET=secret

被载入的变量将会对 vue-cli-service 的所有命令、插件和依赖可用。

环境加载属性

为一个特定模式准备的环境文件的 (例如 .env.production) 将会比一般的环境文件 (例如 .env) 拥有更高的优先级。

此外,Vue CLI 启动时已经存在的环境变量拥有最高优先级,并不会被 .env 文件覆写。

NODE_ENV

如果在环境中有默认的 NODE_ENV,你应该移除它或在运行 vue-cli-service 命令的时候明确地设置 NODE_ENV

#模式

模式是 Vue CLI 项目中一个重要的概念。默认情况下,一个 Vue CLI 项目有三个模式:

  • development 模式用于 vue-cli-service serve

  • production 模式用于 vue-cli-service build 和 vue-cli-service test:e2e

  • test 模式用于 vue-cli-service test:unit

注意模式不同于 NODE_ENV,一个模式可以包含多个环境变量。也就是说,每个模式都会将 NODE_ENV的值设置为模式的名称——比如在 development 模式下 NODE_ENV 的值会被设置为 "development"

你可以通过为 .env 文件增加后缀来设置某个模式下特有的环境变量。比如,如果你在项目根目录创建一个名为 .env.development 的文件,那么在这个文件里声明过的变量就只会在 development 模式下被载入。

你可以通过传递 --mode 选项参数为命令行覆写默认的模式。例如,如果你想要在构建命令中使用开发环境变量,请在你的 package.json 脚本中加入:

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

#示例:Staging 模式

假设我们有一个应用包含以下 .env 文件:

VUE_APP_TITLE=My App

和 .env.staging 文件:

NODE_ENV=production
VUE_APP_TITLE=My App (staging)
  • vue-cli-service build 会加载可能存在的 .env.env.production 和 .env.production.local 文件然后构建出生产环境应用;

  • vue-cli-service build --mode staging 会在 staging 模式下加载可能存在的 .env.env.staging 和 .env.staging.local 文件然后构建出生产环境应用。

这两种情况下,根据 NODE_ENV,构建出的应用都是生产环境应用,但是在 staging 版本中,process.env.VUE_APP_TITLE 被覆写成了另一个值。

#在客户端侧代码中使用环境变量

只有以 VUE_APP_ 开头的变量会被 webpack.DefinePlugin 静态嵌入到客户端侧的包中。你可以在应用的代码中这样访问它们:

console.log(process.env.VUE_APP_SECRET)

在构建过程中,process.env.VUE_APP_SECRET 将会被相应的值所取代。在 VUE_APP_SECRET=secret的情况下,它会被替换为 "secret"

除了 VUE_APP_* 变量之外,在你的应用代码中始终可用的还有两个特殊的变量:

  • NODE_ENV - 会是 "development""production" 或 "test" 中的一个。具体的值取决于应用运行的模式

  • BASE_URL - 会和 vue.config.js 中的 publicPath 选项相符,即你的应用会部署到的基础路径。

所有解析出来的环境变量都可以在 public/index.html 中以 HTML 插值中介绍的方式使用。

提示

你可以在 vue.config.js 文件中计算环境变量。它们仍然需要以 VUE_APP_ 前缀开头。这可以用于版本信息 process.env.VUE_APP_VERSION = require('./package.json').version

#只在本地有效的变量

有的时候你可能有一些不应该提交到代码仓库中的变量,尤其是当你的项目托管在公共仓库时。这种情况下你应该使用一个 .env.local 文件取而代之。本地环境文件默认会被忽略,且出现在 .gitignore中。

.local 也可以加在指定模式的环境文件上,比如 .env.development.local 将会在 development 模式下被载入,且被 git 忽略。


AICODER编辑推荐:



报名就业班送基础班

最近分享