Vue环境变量详解

一、环境变量的概念

环境变量在很多编程语言中都是一个非常重要的概念，它是一种动态的变量，与操作系统的环境有关，可以在程序运行的时候被读取和修改，常用于存储一些程序运行所需的常量、路径、配置等信息。

在Vue中，环境变量主要用来管理开发环境、测试环境和生产环境的配置信息，如API地址、版本号等，在不同的场景中采用不同的配置信息，提高开发效率和代码可移植性。

二、如何使用Vue环境变量

Vue提供了一个称为“环境变量”的机制，你可以在你的项目中使用不同的环境变量文件，来定制不同部署环境中的配置。

在VueCLI 3的项目中，我们可以使用一个特殊的文件：`.env`，来设置环境变量，如定义一个名为`VUE_APP_BASE_API`的环境变量，用于设置请求的API地址：

 # .env文件中：
VUE_APP_BASE_API=http://localhost:8080/api

我们可以在Vue的组件中使用这个环境变量：

<template>
  <div>
    <h1>{{title}}</h1>
    <p>API地址：{{api}}</p>
  </div>
</template>

<script>
export default {
  data() {
    return {
      title: 'Hello Vue',
      api: process.env.VUE_APP_BASE_API
    }
  }
}
</script>

在上面的代码中，使用了Vue提供的`process.env`对象，在Vue组件中可以访问到这些特殊的环境变量。我们可以在不同的环境中设置不同的`.env`文件，来实现对开发，测试和生产环境的不同配置。

三、自定义环境变量

除了使用`VUE_APP_`前缀定义环境变量之外，我们还可以自定义其他的环境变量。在`.env`文件中，你可以定义任意数量的环境变量，格式如下：

 # .env文件中：
API_VERSION=v1.0.0
API_HOST=http://localhost:8080/api

# 在组件中使用自定义环境变量
process.env.API_VERSION
process.env.API_HOST

这样我们就可以在Vue组件中轻松地访问自定义的环境变量。

四、不同环境使用不同的配置

通常我们会在不同的环境中使用不同的配置，例如开发环境和生产环境的API地址是不同的。VueCLI 3允许我们为不同的环境定义不同的`.env`文件，以满足这种需求。

在VueCLI 3中，一个`.env`文件只适用于一个特定的环境，如`.env.development`只适用于开发环境，`.env.production`只适用于生产环境。如果我们希望在开发和生产环境分别使用不同的API地址，我们可以这样做：

 # .env.development文件中：
API_HOST=http://localhost:8080/api

 # .env.production文件中：
API_HOST=https://api.example.com

这样，我们就可以在开发环境和生产环境中分别使用不同的API地址。

五、Vue-CLI 3.x中环境变量的优先级顺序

在Vue-CLI 3.x中，环境变量的优先级按照以下顺序：

在JS中使用`process.env`对象
`.env.local`文件
`.env.[mode]`文件，如`.env.production`
`.env`文件
在命令行中传递的环境变量

这种优先级顺序允许我们在不同情况下方便地覆盖和扩展特定的环境变量。

六、Webpack的环境变量

VueCLI 3底层包含一个Webpack编译器，我们也可以使用Webpack的DefinePlugin插件来设置环境变量。在`vue.config.js`文件中的`configureWebpack`配置项中添加以下代码：

 // vue.config.js文件
module.exports = {
  configureWebpack: {
    plugins: [
      new webpack.DefinePlugin({
        'process.env': {
          NODE_ENV: JSON.stringify(process.env.NODE_ENV),
          API_HOST: JSON.stringify(process.env.API_HOST)
        }
      })
    ]
  }
}

上面的代码中，我们通过Webpack的DefinePlugin将环境变量绑定到了全局的`process.env`对象上，使得我们可以在任意的组件中使用这些环境变量。

七、封装环境变量

为了在应用中方便地使用各种环境变量，我们可以把它们封装到一个配置文件中。一种常见的做法是创建一个`.env.js`文件，定义不同环境的配置信息：

 // .env.js文件
const dev = {
  API_HOST: 'http://localhost:8080/api'
}

const prod = {
  API_HOST: 'https://api.example.com'
}

export default process.env.NODE_ENV === 'production' ? prod : dev

在上面的代码中，我们根据环境变量中的`NODE_ENV`来判断当前是开发环境还是生产环境，然后返回相应的配置信息。然后我们就可以在代码中引入这个`.env.js`文件，并使用其中的环境变量：

 // main.js文件中
import env from './.env.js'

Vue.prototype.$env = env

 // 组件中使用封装好的环境变量
this.$env.API_HOST

通过封装环境变量，我们可以方便地在应用中使用和管理环境变量，代码也更加清晰。

八、总结

Vue环境变量使得我们可以在开发、测试、生产等不同环境下进行定制化的配置，减少了代码的重复和可移植性的问题。在VueCLI 3中，我们可以使用`.env`文件来定义环境变量，同时还可以通过自定义环境变量、不同`.env`文件和Webpack的DefinePlugin来进行配置。为了方便使用和管理环境变量，我们还可以将它们封装到一个`.env.js`文件中。

原创文章，作者：TYXJQ，如若转载，请注明出处：https://www.506064.com/n/369590.html