Vue 项目打包后环境变量丢失问题(清除缓存),区分.env和.env.*文件

news2024/11/16 5:17:13

Vue 项目打包后环境变量丢失问题(清除缓存),区分.env和.env.*文件

问题背景

今天在导报项目的时候遇到一个问题问题:在开发环境中一切正常,但在打包后的生产环境中,某些环境变量(如 VUE_APP_BASE_API)无法正确读取,导致出现 VUE_APP_BASE_API 不存在 的错误。

请添加图片描述

下面就解决这个问题,让环境变量在打包后的生产环境中能够正常使用,进行了进一步的思考衍生

知识储备

要解决上面的问题需要,了解一下下面的内容

在开发 Vue 项目的过程中,使用环境变量来管理不同环境下的配置(例如 API 地址、密钥等)。

文件.env

开发环境生产环境公用的一些配置

//.env
VUE_APP_NAME=red润
VUE_APP_BASE_API=/api2
VUE_APP_API_BASE_URL=https://本地开发地址.com

文件.env.productioin

生产环境单独使用的配置,如果和.env内容相同,.env.production将会覆盖.env里面的内容

VUE_APP_API_BASE_URL=https://线上域名.com
VUE_APP_BASE_API=/api

在 Vue CLI 中,环境变量的加载是有优先级的。当你运行构建命令时(如 npm run build),Vue CLI 会按以下顺序加载环境变量:

  1. .env:基础的环境变量文件,通常包含开发、生产和测试等环境共享的变量。
  2. .env.local:如果存在,它会覆盖 .env 中的变量,适用于本地开发环境(注意:此文件通常不会提交到版本控制中)。
  3. .env.development.env.production:这些文件用于特定环境(开发环境、生产环境等),会覆盖 .env.env.local 中的相同变量。
  4. .env.development.local.env.production.local:这些是针对特定环境的本地配置文件,会覆盖上述所有文件中的变量。

所以,在你的情况下,如果 .env.production.env 中有相同的环境变量,process.env.VUE_APP_BASE_API 的值会使用 .env.production 中的值,而 .env 中的配置会被覆盖。

问题描述

在本地开发时,使用以下代码来引用环境变量:

const version = `${process.env.VUE_APP_BASE_API}`;

在开发环境下,process.env.VUE_APP_BASE_API 正常返回预期的值。

但是,当进行打包构建时,线上环境却出现了 VUE_APP_BASE_API 不存在 的错误,导致 API 请求无法正常发起。

请添加图片描述

问题原因

这个问题通常发生在 Vue CLI 构建项目时,它会自动根据不同环境加载不同的 .env 文件。如果 .env.production.env 中没有正确配置环境变量,或者构建过程没有正确读取到这些变量,线上就无法获取到相应的环境变量。

解决方案

以下是几种常见的解决方法,我们可以逐一排查。

1. 确保 .env 文件配置正确

首先,确保你已经在项目根目录下创建了 .env.env.production 文件,并且在文件中定义了所需要的环境变量。例如:

VUE_APP_BASE_API=https://your-api-endpoint.com

注意:Vue CLI 会自动加载以 VUE_APP_ 为前缀的环境变量。如果你的环境变量没有以 VUE_APP_ 开头,它将不会被嵌入到最终的构建中。

2. 清除缓存并重新打包(这是我的解决方案ok)

有时候旧的构建缓存可能导致环境变量没有被更新。为了确保环境变量被正确加载,可以尝试在打包时加上 --no-cache 标志:

enpm run build --no-cache

这将确保构建过程从头开始,而不会使用任何缓存文件。

3. 打包时检查环境变量

你可以在构建过程中使用 console.log(process.env) 来检查环境变量是否正确加载。可以在 src/main.jssrc/App.vue 中添加以下代码来调试:

console.log(process.env);  // 打印所有环境变量

这将帮助你确认构建后的代码中是否包含了你设置的 VUE_APP_BASE_API 变量。

4. 使用 webpack 的 DefinePlugin 明确注入环境变量(究极方案)

如果以上方法都没有解决问题,可以尝试通过 webpack 的 DefinePlugin 来显式地将环境变量注入到构建代码中:

// vue.config.js
const webpack = require('webpack');

module.exports = {
  configureWebpack: {
    plugins: [
      new webpack.DefinePlugin({
        'process.env.VUE_APP_BASE_API': JSON.stringify(process.env.VUE_APP_BASE_API)
      })
    ]
  }
}

这样,VUE_APP_BASE_API 将被直接注入到打包后的代码中,确保在生产环境中能够正常使用。

  • webpack.DefinePlugin 的作用

webpack.DefinePlugin 用于在打包时,静态地将代码中的指定字符串替换为给定的值。它会查找代码中的匹配项,并将其替换为我们提供的值。这是一种预处理机制,允许你在构建时动态替换代码中的常量值。

  • process.env 与环境变量

在 Node.js 中,process.env 是一个包含所有环境变量的对象。在 Vue CLI 中,process.env 主要用于访问不同的环境变量。像 VUE_APP_BASE_API 这样的变量通常在 .env 文件中定义,并通过 process.env.VUE_APP_BASE_API 来访问。

然而,process.env 只是 Node.js 的一个对象,Webpack 在构建过程中并不会自动注入这些环境变量。因此,使用 DefinePlugin 插件,可以手动将这些环境变量注入到构建代码中。

  • JSON.stringify() 的作用

webpack.DefinePlugin 中,值需要以字符串的形式提供,因为 Webpack 会在构建时进行替换。直接传递 JavaScript 的对象或变量是无效的,因此必须使用 JSON.stringify()process.env.VUE_APP_BASE_API 的值转换为一个字符串,这样 Webpack 才能正确地将它嵌入到构建后的代码中。

例如,如果 .env 中的 VUE_APP_BASE_APIhttps://api.example.comJSON.stringify() 会将其转换为字符串 'https://api.example.com',然后 Webpack 会将代码中所有 process.env.VUE_APP_BASE_API 的引用替换为这个字符串。

  • 如何工作

通过这种方式,Webpack 会在构建时查找代码中所有的 process.env.VUE_APP_BASE_API,并将其替换为 https://api.example.com(或其他 .env 文件中定义的值)。

举个例子,假设你在 Vue 组件中使用以下代码:

const apiUrl = process.env.VUE_APP_BASE_API;

在构建时,Webpack 会将 process.env.VUE_APP_BASE_API 替换为你在 webpack.DefinePlugin 中定义的值,即:

const apiUrl = 'https://api.example.com';
5. 检查部署环境的环境变量配置

如果你使用 CI/CD 进行自动化构建,确保部署环境(例如 Docker、云平台等)中也已经配置了正确的环境变量。在一些部署平台中,你可能需要手动设置环境变量,以便构建过程能正确读取。

总结

通过上述方法,我们可以有效地解决 Vue 项目在打包后,环境变量丢失的问题。我们解决思路如下:

  1. 确保 .env 文件正确配置。
  2. 清除缓存并重新打包。
  3. 使用 console.log(process.env) 检查环境变量是否正常加载。
  4. 使用 webpack DefinePlugin 明确注入环境变量。
  5. 确保部署环境配置了正确的环境变量。

Happy coding!

😄

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2241282.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

群控系统服务端开发模式-应用开发-前端菜单功能开发

今天优先开发菜单及角色,明天将开发岗位配置、级别配置等功能。具体看下图 而前端的路由不需要手动添加,是依据数据库里面存储的路径。 一、添加视图 在根目录下src文件夹下views文件夹下permission文件夹下menu文件夹下,新建index.vue&…

数据结构Python版

2.3.3 双链表 双链表和链表一样,只不过每个节点有两个链接——一个指向后一个节点,一个指向前一个节点。此外,除了第一个节点,双链表还需要记录最后一个节点。 每个结点为DLinkNode类对象,包括存储元素的列表data、…

【HarmonyOS学习日志(8)】UIAbility,HAP,AbilityStage组件及其生命周期

基本概念 UIAbility组件是一种包含UI的应用组件,主要用于和用户交互。 在项目创建时,系统默认生成的EntryAbility类继承了UIAbility类。 ExtensionAbility组件:是基于特定场景(例如服务卡片、输入法等)提供的应用组件…

【Linux】多线程(中)

目录 一、线程互斥 1.1 互斥概念 1.2 互斥量mutex 1.3 互斥量相关API (1)初始化互斥量 (2)销毁互斥量 (3)互斥量加锁和解锁 1.4 互斥量原理 1.5 重入和线程安全 二、死锁 2.1 概念 2.2 造成死锁…

【数字图像处理+MATLAB】基于 Sobel 算子计算图像梯度并进行边缘增强:使用 imgradientxy 函数

引言 在图像处理中,边缘通常是图像中像素强度变化最大的地方,这种变化可以通过计算图像的梯度来量化。梯度是一个向量,它的方向指向像素强度增加最快的方向,它的大小(或者说幅度)表示像素强度增加的速度。…

Nuxt.js 应用中的 schema:beforeWrite 事件钩子详解

title: Nuxt.js 应用中的 schema:beforeWrite 事件钩子详解 date: 2024/11/14 updated: 2024/11/14 author: cmdragon excerpt: schema:beforeWrite 钩子是 Vite 提供的一个功能强大的生命周期钩子,允许开发者在 JSON Schema 被写入之前执行自定义操作。利用这个钩子,您可以…

k8s服务内容滚动升级以及常用命令介绍

查看K8S集群所有的节点信息 kubectl get nodes 删除K8S集群中某个特定节点 kubectl delete nodes/10.0.0.123 获取K8S集群命名空间 kubectl get namespace 获取K8S所有命名空间的那些部署 kubectl get deployment --all-namespaces 创建命名空间 web界面上看到的效果,但是…

MinIo在Ubantu和Java中的整合

1.MinIo在Ubantu中的部署 首先准备好一台已经安装好Ubantu系统的服务器 MinIO是一个开源的对象存储服务器,兼容Amazon S3,性能卓越,适合存储非结构化数据,例如照片、视频、日志文件、备份和容器镜像等。 1:更新系统…

设计模式-参考的雷丰阳老师直播课

一般开发中使用的模式为模版模式策略模式组合,模版用来定义骨架,策略用来实现细节。 模版模式 策略模式 与模版模式特别像,模版模式会定义好步骤定义好框架,策略模式定义小细节 入口类 使用模版模式策略模式开发支付 以上使用…

【LeetCode】【算法】53. 最大子数组和

LeetCode 53. 最大子数组和 题目描述 给你一个整数数组 nums ,请你找出一个具有最大和的连续子数组(子数组最少包含一个元素),返回其最大和。子数组是数组中的一个连续部分。 思路 思路:动态规划秒了 具体递推式如…

供应SW6301V单C口多协议升降压移动电源IC

1. 概述 SW6301V 是一款高集成度的单 C 口多协议升降压移动电源 SOC。集成双向升降压控制器,支持 2~6 节 电池串联,提供 100W 功 率 输 入 输 出 ; 支 持 C 口 快 充 输入输出 ; 支 持UFCS/PPS/PD/SVOOC/VOOC/SCP/FCP/QC/AFC/BC…

C++常用的新特性-->day06

时间间隔duration duration表示一段时间间隔&#xff0c;用来记录时间长度&#xff0c;可以表示几秒、几分钟、几个小时的时间间隔。duration的原型如下 // 定义于头文件 <chrono> template<class Rep,class Period std::ratio<1> > class duration;Rep&…

Cyberchef配合Wireshark提取并解析TCP/FTP流量数据包中的文件

前一篇文章中讲述了如何使用cyberchef提取HTTP/TLS数据包中的文件,详见《Cyberchef配合Wireshark提取并解析HTTP/TLS流量数据包中的文件》,链接这里,本文讲述下如何使用cyberchef提取FTP/TCP数据包中的文件。 FTP 是最为常见的文件传输协议,和HTTP协议不同的是FTP协议传输…

性能面向下一代PCIe Gen 5,G991B322HR、G99L12312HR 安费诺ExtremePort™ Swift连接器支持内部I/O应用

前言 为了在网络设备和服务器上提供更高速度和更小尺寸的解决方案&#xff0c;Amphenol开发了ExtremePort™ Swift连接器&#xff0c;适用于PCIe Gen5 NRZ 32GT/s、UPI 2.0 24GT/s、24Gb/s SAS信号。 G991B322HR G9912312HR G9912322HR G9914312HR G991B312HR G991C312HR G99…

IDEA调整警告级别【IntelliJ IDEA 2024.2.0.1】

文章目录 目前现状鼠标悬停&#xff0c;选择配置筛选 > 取消选择OK效果 目前现状 需要把提示改成只要显示error的5个 鼠标悬停&#xff0c;选择配置 筛选 > 取消选择 OK 效果

【二叉搜素树】——LeetCode二叉树问题集锦:6个实用题目和解题思路

文章目录 计算布尔二叉树的值求根节点到叶节点的数字之和二叉树剪枝验证二叉搜索树二叉搜索树中第K小的元素二叉树的所有路径 计算布尔二叉树的值 解题思路&#xff1a; 这是一个二叉树的布尔评估问题。树的每个节点包含一个值&#xff0c;其中叶子节点值为 0 或 1&#xff0…

windows下QT5.12.11使用MSVC编译器编译mysql驱动并使用详解

1、下载mysql开发库,后面驱动编译的时候需要引用到,下载地址:mysql开发库下载 2、使用everything搜索:msvc-version.conf,用记事本打开,添加:QMAKE_MSC_VER=1909。不然msvc下的mysql源码加载不上。

Isaac Sim+SKRL机器人并行强化学习

目录 Isaac Sim介绍 OmniIssacGymEnvs安装 SKRL安装与测试 基于UR5的机械臂Reach强化学习测评 机器人控制 OMNI GYM环境编写 SKRL运行文件 训练结果与速度对比 结果分析 运行体验与建议 Isaac Sim介绍 Isaac Sim是英伟达出的一款机器人仿真平台&#xff0c;适用于做机…

删库跑路,启动!

起因&#xff1a;这是一个悲伤的故事&#xff0c;在抓logcat时 device待机自动回根目录了&#xff0c;而题主对当前路径的印象还停留在文件夹下&#xff0c;不小心在根目录执行了rm -rf * … 所以&#xff0c;这是个悲伤的故事&#xff0c;东西全没了…device也黑屏了&#xff…

CSS的综合应用例子(网页制作)

这是html的一些最基本内容的代码&#xff1a; <!DOCTYPE html> <html lang"zh"> <head> <meta charset"UTF-8"> <meta name"viewport" content"widthdevice-width, initial-scale1.0"> <t…