vue3中的多模式和环境变量

本文介绍了VueCLI项目中的环境模式,包括development、test和production,以及如何通过--mode选项自定义模式。重点讲解了环境变量的设置,如通过.env文件指定不同模式下的变量,并强调了不要在应用中存储敏感信息。还提到了在Webpack和Vite中使用环境变量的方法,以及.env.local文件用于本地开发而不提交到版本库。最后,指出了修改环境变量后需要重启项目以使变更生效。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

多模式:

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

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

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

//用webpack做打包的方式
"scripts": {
    "dev": "vue-cli-service serve --mode=development",
    "build": "vue-cli-service build --mode=production",
  },
//用vite做打包,cross-env是做跨操作系统用的
"scripts": {
    "dev": "cross-env vite --mode=development",
    "build": "cross-env vite build --mode=production",
    "release": "cross-env vite build --mode=release",
    "serve": "vite preview"
  },

当运行 vue-cli-service 命令时,所有的环境变量都从对应的环境文件中载入。如果文件内部不包含 NODE_ENV变量,它的值将取决于模式,例如,在 production 模式下被设置为 “production”,在 test 模式下被设置为"test",默认则是 "development"。

NODE_ENV

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

环境变量

  • 你可以在你的项目根目录中放置下列文件来指定环境变量:
.env                # 在所有的环境中被载入
.env.local          # 在所有的环境中被载入,但会被 git 忽略
.env.[mode]         # 只在指定的模式中被载入
.env.[mode].local   # 只在指定的模式中被载入,但会被 git 忽略

在这里插入图片描述

项目中常用的几种,带local的文件优先级高于不带的,遇到相同变量名会覆盖掉不带local文件中相同的变量。

  • 一个环境文件只包含环境变量的“键=值”对:
# 开发环境
NODE_ENV = development
# publicPath
VUE_PUBLIC_PATH = ./

警告

不要在你的应用程序中存储任何机密信息(例如私有 API 密钥)!

环境变量会随着构建打包嵌入到输出代码,意味着任何人都有机会能够看到它。

请注意,只有 NODE_ENVBASE_URL 和以 VUE_APP_ 开头的变量将通过 webpack.DefinePlugin
静态地嵌入到客户端侧的代码中。这是为了避免意外公开机器上可能具有相同名称的私钥。

请注意,使用vite的时候要使用NODE_ENVBASE_URL 和以 VITE_开头

  • 使用环境变量方式

webpack中直接使用process.env.xxx
process.env.NODE_ENV直接拿到当前的环境

  • 常用的场景
//根据不同的环境来设置对应的变量
let BASE_URL = ''
let BASE_NAME = ''
switch (process.env.NODE_ENV) {
  case 'development':
    BASE_URL = 'http://coderwhy.org/dev'
    BASE_NAME = 'dev'
    break
  case 'production':
    BASE_URL = 'http://coderwhy.org/prod'
    BASE_NAME = 'prod'
    break
  default:
    BASE_URL = 'http://coderwhy.org/test'
    BASE_NAME = 'test'
    break
}

在vite中使用import.meta.env.xxx
const baseUrl = import.meta.env.VITE_APP_SOURCE_URL;

//我们可以看下浏览器中打印的结果
const env = import.meta.env;
console.log(env);

在这里插入图片描述

环境文件加载优先级

  • 为一个特定模式准备的环境文件 (例如 .env.production) 将会比一般的环境文件 (例如 .env) 拥有更高的优先级。
  • 此外,Vue CLI 启动时已经存在的环境变量拥有最高优先级,并不会被 .env 文件覆写。
  • .env 环境文件是通过运行 vue-cli-service 命令载入的,因此环境文件发生变化,你需要重启服务。

只在本地有效的变量

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

**

改了环境变量不要忘记重启项目

**
详细配置

<think>好的,我现在需要帮助用户了解Vue3中如何配置使用环境变量。首先,我得回忆一下Vue3环境变量机制,尤其是Vue2有什么不同。根据用户提供的引用内容,Vue项目一般通过.env文件环境变量来管理不同环境的配置。但用户特别问到Vue3,所以可能需要对比Vue CLIVite的区别,因为Vue3项目可能使用Vite作为构建工具。 首先,用户提供的引用中提到,在Vue项目中,环境变量通过process.env来访问,比如process.env.VUE_APP_URL。但Vue3如果使用Vite的话,环境变量的前缀应该是VITE_,而不是VUE_APP_,这点需要注意。比如,Vite环境变量会以import.meta.env.VITE_XXX的形式出现,而不是process.env。所以可能需要指出Vue3的不同情况,取决于使用的构建工具。 然后,用户的问题是关于配置使用。根据引用中的信息,配置环境变量需要创建.env文件,比如.env.development、.env.production等,并且通过package.json的scripts指定模式。例如,npm run build --mode production会对应.env.production文件。在Vue3中,如果使用Vite的话,可能模式的概念类似,但环境变量的加载方式可能不同。需要确认Vite的文档。 接下来,环境变量的使用方式。在JS中,Vue2使用的是process.env,而Vue3使用Vite的话,是import.meta.env。例如,引用[3]中提到在JS中使用process.env.VUE_APP_URL,但在Vite中应该是import.meta.env.VITE_APP_URL。同时,在HTML模板中的使用,可能需要通过Vite的占位符,比如使用%syntax%,但具体需要查看Vite的文档。引用[3]中的例子是使用<%= process.env.VUE_APP_URL %>,这可能适用于某些模板引擎,但在Vite中可能不同。 另外,环境变量的命名规则。在Vue CLI中,只有以VUE_APP_开头的变量才会被嵌入到客户端代码中,而Vite中则是以VITE_为前缀。所以需要强调变量命名的前缀,否则变量不会被暴露给客户端代码。 然后,配置步骤。用户需要知道如何在Vue3项目中创建.env文件,如何指定模式,如何访问变量。可能需要分步骤说明,比如创建.env文件,配置package.json脚本,如何在代码中使用环境变量,以及注意事项,如变量命名前缀、文件加载优先级等。 还需要考虑不同模式下的文件加载,比如.env.[mode].env.[mode].local的区别,本地文件通常会被git忽略,适合存储敏感信息。同时,优先级问题,比如.env.local会覆盖.env文件中的相同变量。 最后,生成相关问题,可能需要包括如何区分不同环境、如何保护敏感变量、如何自定义环境变量前缀等。 现在需要整合这些思考,按照用户提供的系统级指令来组织回答。确保使用正确的中文表达,行内公式用$...$,独立公式不需要,这里可能用不到数学公式。同时,按照用户示例中的结构,先回答问题,再生成相关问题。引用部分需要正确标注,比如引用[1]、[2]等,并在回答末尾添加引用标识。</think>### Vue3环境变量配置及用法 #### 1. **环境变量文件配置** Vue3通过`.env`文件管理环境变量,文件命名规则与模式绑定: - `.env`:全局默认变量(所有环境生效) - `.env.development`:开发环境变量(`npm run dev`时生效) - `.env.production`:生产环境变量(`npm run build`时生效) - `.env.[mode].local`:本地覆盖文件(优先级更高,且不会被Git跟踪)[^2][^4] #### 2. **变量命名规则** - **Vite项目(推荐)**:仅以`VITE_`开头的变量会暴露给客户端代码,例如: ```plaintext VITE_API_URL=https://api.example.com ``` - **Vue CLI项目**:需使用`VUE_APP_`前缀,例如: ```plaintext VUE_APP_API_KEY=123abc ``` #### 3. **访问环境变量** - **Vite项目中**:通过`import.meta.env`对象访问: ```javascript const apiUrl = import.meta.env.VITE_API_URL; ``` - **Vue CLI项目中**:通过`process.env`对象访问: ```javascript const apiKey = process.env.VUE_APP_API_KEY; ``` #### 4. **模式指定与脚本配置** 在`package.json`中通过`--mode`指定模式: ```json "scripts": { "dev": "vite --mode development", "test": "vite build --mode testing", "build": "vite build --mode production" } ``` 运行`npm run dev`时,自动加载`.env.development`文件。 #### 5. **HTML模板中使用** 通过`%ENV_VAR%`语法插入变量(Vite项目): ```html <script src="%VITE_CDN_URL%/main.js"></script> ``` #### 6. **优先级与安全** - 文件优先级:`.env.[mode].local > .env.[mode] > .env` - 敏感变量(如API密钥)应存储在`.env.local`中并加入`.gitignore`[^3] --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值