不同打包工具下的环境变量配置方式对比

本文作者为 360 奇舞团前端开发工程师 天明

前言

在现代的JavaScript应用程序开发中,环境变量的配置是至关重要的。不同的应用场景和部署环境可能需要不同的配置,例如开发、测试和生产环境。最常见的需求是根据不同的环境,配置如是否开启sourceMapAPI请求地址的切换、是否压缩代码等逻辑。本文主要介绍利用不同的工具:WebpackViteRollup打包项目的环境变量的配置方式。

process.env.NODE_ENV

process.env.NODE_ENV应该是我们最熟悉的环境变量了,我们知道在Node环境中process是一个全局变量,无需require引入。process.env属性返回一个包含用户环境信息的对象,当我们打印process.env时,发现它并没有NODE_ENV这一个属性。实际上process.env.NODE_ENV是在package.jsonscripts命令中注入的,可以通过以下方式进行设置:

{"scripts": {"dev": "NODE_ENV=development webpack --config webpack.dev.config.js","prod": "NODE_ENV=production webpack --config webpack.prod.config.js"}
}

当运行npm run devnpm run prod命令时,设置了NODE_ENV的不同值,项目中访问到的process.env.NODE_ENV值也会根据执行脚本的不同而分别取值:developmentproduction. 我们可以根据这个值的不同而分别进行不同的配置,这就是配置环境变量的基本逻辑.

Webpack项目环境变量配置方式
使用DefinePlugin插件

前面提到,在scripts命令中注入的NODE_ENV只能被Webpack的构建脚本访问,而被Webpack打包的源码中是无法访问到的,此时可以借助WebpackDefinePlugin插件,创建全局变量。

const webpack = require('webpack');module.exports = {//.....其他配置plugins: [new webpack.DefinePlugin({'process.env.API_URL': JSON.stringify('https://api.example.com'),'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),}),],
};

在上面的示例中,我们定义了两个环境变量:API_URLNODE_ENV,并且使用JSON.stringify将值转换为字符串。这样就可以在代码中使用process.env.API_URLprocess.env.NODE_ENV来访问这两个环境变量的值了。

Windows平台配置的注意点

Windows平台下直接设置NODE_ENV =XXX是会报错的, 解决办法也很简单,可以使用cross-env这个npm包来进行配置,cross-env能够提供一个设置环境变量的scripts,这样我们就能够以unix方式设置环境变量,然后在windows上也能够兼容

  • 安装

npm install cross-env --save
  • 使用

"scripts": {"dev": "cross-env NODE_ENV=development webpack","prod": "cross-env NODE_ENV=production webpack"
}

可以看到直接在NODE_ENV=XXX前面添加cross-env就可以了。

使用dotenv插件

假如我们项目的环境变量有很多,全部设置plugins中既不美观也不容易维护,此时将环境变量配置在.env文件中,然后使用dotenv插件来加载.env配置文件。

  • 安装

npm install dotenv-webpack --save-dev
  • 创建环境变量文件 在项目根目录下创建一个.env文件,如果有多种不同的环境,可以针对不同的环境创建不同的配置文件,例如可以使用.env.development.env.test.env.production在文件来分别表示:开发、测试、生产环境的环境变量。在文件中配置每个环境对应的变量:

// .env.development
API_URL=http://development.example.com
DEBUG=true
// .env.test
API_URL=http://test.example.com
DEBUG=true
// .env.production
API_URL=http://production.example.com
DEBUG=false
  • 加载.env配置 在webpack.config.js加载.env配置:

require('dotenv').config({ path: path.resolve(__dirname, '.env.' + process.env.NODE_ENV) })
  • 设置scriptsscripts命令中设置NODE_ENV

"scripts": {"dev": "cross-env NODE_ENV=development webpack","dev": "cross-env NODE_ENV=test webpack","prod": "cross-env NODE_ENV=production webpack"
}
Rollup项目环境变量配置方式

Rollup是一个现代化的JavaScript模块打包工具,专注于构建JavaScript库和组件。下面是Rollup中配置环境变量的几种常见方式:

使用rollup-plugin-replace

Rolluprollup-plugin-replace插件允许我们在打包过程中替换代码中的字符串。我们常用该插件来定义环境变量。

  • 安装:

npm install rollup-plugin-replace --save-dev
  • rollup.config.js中配置

const isProduction = process.env.NODE_ENV === 'production';
export default [{//.....其他配置plugins: [replace({'process.env.API_URL': JSON.stringify(isProduction ? 'https://prod.example.cn' : 'https://dev.example.cn')'process.env.NODE_ENV': JSON.stringify(isProduction? 'production' : 'development')})]}
]

在上面的例子中,我们首先获取到当前组件库的环境变量,并根据它的值设置不同的API_URLNODE_ENV.

之所以在组件库中使用rollup-plugin-replace 替换 process.env.NODE_ENV 的原因是为了在打包时,将代码中的环境变量替换为实际的值,以便在不同的环境中正确地运行组件库。这样就避免了宿主工程中的环境变量process.env.NODE_ENV,对组件库环境变量的影响。

Rollup使用dotenv插件

Webpack类似,在Rollup中使用dotenv插件进行环境变量的配置,可以按照以下步骤进行:

  • 安装dotenvrollup-plugin-replace

npm install dotenv rollup-plugin-replace --save-dev
  • 创建环境变量文件 与上面的Webpack创建环境变量文件类似,这里也可以创建多个环境配置文件.env.development.env.test.env.production

  • rollup.config.js加载.env配置

import { config } from 'dotenv'
config({ path: ".env."+ process.env.NODE_ENV }).parsed
export default {// ...plugins: [replace({process.env.API_URL: JSON.stringify(process.env.API_URL),process.env.DEBUG: JSON.stringify(process.env.DEBUG),}),// ...],
};

在上例中,我们首先通过dotenv.config()方法来加载.env文件中的环境变量。然后,使用@rollup/plugin-replace插件的replace方法,将环境变量注入到代码中。

  • package.json中设置scripts

"scripts": {"build:dev": "cross-env NODE_ENV=development rollup -c","build:prod": "cross-env NODE_ENV=production rollup -c","build:test": "cross-env NODE_ENV=test rollup -c","dev": "cross-env NODE_ENV=development rollup -c -w",}

执行对应的脚本命令后,在你的代码中,你可以通过process.env.XXX来访问已配置的环境变量.

Vite项目环境变量配置方式

与使用Webpack或是Rollup项目配置环境变量相比,Vite项目配置环境变量较为简单。

内建变量

Vite在一个特殊的import.meta.env对象上暴露环境变量

  • import.meta.env.MODE: 应用运行的模式。

  • import.meta.env.BASE_URL:部署应用时的基本 URL。他由base 配置项决定。

  • import.meta.env.PROD:应用是否运行在生产环境。

  • import.meta.env.DEV:应用是否运行在开发环境 (永远与 import.meta.env.PROD相反)。

  • import.meta.env.SSR:应用是否运行在 server 上。 这些变量可以直接在代码中访问

.env文件

同样在项目的根目录下,根据环境的不同创建不同的配置文件,不过文件的命名有些特殊性:

.env                # 所有情况下都会加载
.env.local          # 所有情况下都会加载,但会被 git 忽略
.env.[mode]         # 只在指定模式下加载
.env.[mode].local   # 只在指定模式下加载,但会被 git 忽略

加载的环境变量也会通过 import.meta.env 以字符串形式暴露给客户端源码。

注意:为了防止意外地将一些环境变量泄漏到客户端,只有以VITE_为前缀的变量才会暴露给经过vite处理的代码。

模式

默认情况下,开发服务器 dev命令 运行在 development模式,而build命令则运行在production模式。这意味着当执行vite build 时,它会自动加载.env.production中可能存在的环境变量.在某些情况下,若想在vite build时运行不同的模式,你可以通过传递 --mode 选项标志来覆盖命令使用的默认模式。

vite build --mode development

此时vite会使用.env.development文件下环境变量进行构建。

总结

通过对比发现虽然打包工具不同,但是配置环境变量的方式都大同小异,合理的使用环境变量,能够提高我们代码的灵活性、安全性、可维护性,并且将配置信息与代码分离是一种良好的开发实践,可以使应用程序更易于维护和管理。

参考:

https://cn.vitejs.dev/guide/env-and-mode.html

https://webpack.docschina.org/plugins/define-plugin/

https://cn.rollupjs.org/faqs/

- END -

关于奇舞团

奇舞团是 360 集团最大的大前端团队,代表集团参与 W3C 和 ECMA 会员(TC39)工作。奇舞团非常重视人才培养,有工程师、讲师、翻译官、业务接口人、团队 Leader 等多种发展方向供员工选择,并辅以提供相应的技术力、专业力、通用力、领导力等培训课程。奇舞团以开放和求贤的心态欢迎各种优秀人才关注和加入奇舞团。

0ce2e5fbfdeec724791bfedc63f98e92.png

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

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

相关文章

基于stm32的智慧家庭健康医疗系统设计

标题:基于STM32的智慧家庭健康医疗系统设计 摘要: 随着人们生活水平的提高和健康意识的增强,智慧家庭健康医疗系统成为了当前研究的热点之一。本论文旨在设计并实现一种基于STM32的智慧家庭健康医疗系统,该系统能够监测和管理家庭…

企业微信上传临时素材errcode:44001,errmsg:empty media data

企业微信,上传临时素材,报错: {“errcode”:44001,“errmsg”:“empty media data [logid:]”}, 开发语言C# 重点代码: formData.Headers.ContentType new MediaTypeHeaderValue(“application/octet-stream”); 解…

数据分析中常用的指标或方法

一、方差与标准差二、协方差三、皮尔逊系数四、斯皮尔曼系数 一、方差与标准差 总体方差 V a r ( x ) σ 2 ∑ i 1 n ( x i − x ˉ ) 2 n ∑ i 1 n x i 2 − n x ˉ 2 n E ( x 2 ) − [ E ( x ) ] 2 Var(x)\sigma^2\frac {\sum\limits_{i1}^{n} (x_i - \bar{x})^2} {n…

使用 Elasticsearch 和 LlamaIndex 进行高级文本检索:句子窗口检索

2023 年是检索增强生成 (RAG) 的一年,人们探索了许多用例,并使用该技术开发了数百种产品。 从 Q/A 聊天机器人到基于上下文的代理,RAG 的使用一直是 LLM 申请快速增长的主要因素。 支持不断发展的社区以及 Langchain 和 LlamaIndex 等强大框架…

【Java SE】类和对象详解

文章目录 1.什么是面向对象2. 类的定义和使用2.1 简单认识类2.2 类的定义格式 3. 类的实例化3.1 什么是实例化3.1.1 练习(定义一学生类) 3.2 类和对象的说明 4. this 引用5. 构造方法6. 对象的初始化6.1 默认初始化6.2 就地初始化 7. 封装7.1 封装的概念…

spingboot 集成identityserver4身份验证

一、新建项目&#xff1a;com.saas.swaggerdemo 详情见&#xff1a;spring-boot2.7.8添加swagger-CSDN博客 在之前项目基础上添加如下依赖 <dependency><groupId>com.nimbusds</groupId><artifactId>nimbus-jose-jwt</artifactId><version&…

uni-app 如何返回到指定的页面

实际开发中&#xff0c;发现了一个问题&#xff0c;即使签署合同的时候&#xff0c;发现调用法大大的页面&#xff0c;出现了一个问题&#xff0c;就是签署后&#xff0c;点回退&#xff0c;回退到了重新签署的页面。所以需要对回退进行自定义处理。 处理的话&#xff0c;就要到…

MATLAB - 为机械臂路径选择轨迹

系列文章目录 前言 本示例概述了机器人系统工具箱™中可用的轨迹类型。在机械手运动、规划和控制应用中&#xff0c;必须为机器人选择轨迹。本示例有三个主要部分。第一部分展示了机械手使用的轨迹类型&#xff0c;第二部分演示了生成轨迹的功能&#xff0c;最后一部分则展示了…

hadoop-common: CMake failed with error code 1

问题 在编译hadoop源码时遇到如下错误 hadoop-common: CMake failed with error code 1 看了这个错误表示一脸懵逼 排查 在mvn 的命令中增加 -X 和 -e mvn clean package -e -X -Pdist,native -DskipTests -Dmaven.javadoc.skip -Dopenssl.prefix/usr/local/bin/openssl 在…

CentOs7.8安装原生Jenkins2.38教程

CentOs7.8安装Jenkins教程 前提&#xff1a;1、下载安装包2、安装&#xff1a;3、检验是否安装成功&#xff1a;4、查询java路径5、修改配置文件6、创建jenkins用户7、给jenkins用户授权8、开放防火墙端口9、运行和其他jenkins相关命令10、异常情况10.1 提示超时&#xff0c;查…

计算机网络安全教程(第三版)课后简答题答案大全[1-5章]

目录 第 1 章 网络安全概述与环境配置 第 2 章 网络安全协议基础 第 3 章 网络安全编程基础 第 4 章 网络扫描与网络监听 第 5 章 网络入侵 第 1 章 网络安全概述与环境配置 1、网络攻击和防御分别包括哪些内容&#xff1f; 答&#xff1a; 攻击技术主要包括以下几个方面。…

Linux之kernel(20)kdump支持

Linux之kernel(21)kdump介绍 Author&#xff1a;OnceDay Date&#xff1a;2024年1月14日 漫漫长路&#xff0c;有人对你微笑过嘛… 参考文档&#xff1a; 3.3.2 内核态调测工具&#xff1a;kdump&crash——kdump - 知乎 (zhihu.com)Kernel crash dump | Ubuntu[Linux]K…

工业企业能源管理平台,可以帮助企业解决哪些方面的能源问题?

随着全球工业化进程的加快&#xff0c;工业企业在生产经营过程中消耗的能源也越来越庞大。能源成本的上升和环境保护的压力使得工业企业对能源管理的重要性有了深刻的认识。为了提高能源利用效率、降低能源消耗、减少环境污染&#xff0c;工业企业在能源管理方面迫切需要一套规…

SpringMVC 参数传递见解5

5.参数传递 5.1.ModelAndView传递 编写controller Controller RequestMapping("/account") public class AccountController {//也可以不创建ModelAndView&#xff0c;直接在参数中指定RequestMapping(value "/findAccount9")public ModelAndView findAc…

计算机毕业设计 基于SSM的历史/博物馆藏系统的设计与实现 Java实战项目 附源码+文档+视频讲解

博主介绍&#xff1a;✌从事软件开发10年之余&#xff0c;专注于Java技术领域、Python人工智能及数据挖掘、小程序项目开发和Android项目开发等。CSDN、掘金、华为云、InfoQ、阿里云等平台优质作者✌ &#x1f345;文末获取源码联系&#x1f345; &#x1f447;&#x1f3fb; 精…

【Leetcode】2719. 统计整数数目

文章目录 题目思路代码 题目 2719. 统计整数数目 给你两个数字字符串 num1 和 num2 &#xff0c;以及两个整数 max_sum 和 min_sum 。如果一个整数 x 满足以下条件&#xff0c;我们称它是一个好整数&#xff1a; num1 < x < num2 min_sum < digit_sum(x) < max_su…

浅谈SQL优化

避免使用子查询 例&#xff1a; select * from t1 where id in (select id from t2 where name lolly1023);其子查询在MySQL5.5版本里&#xff0c;内部执行计划是&#xff1a;先查询外表再匹配内表&#xff0c;而不是先查内表t2&#xff0c;当外表的数据很大时&#xff0c;查…

10.9.2 std::function 代替函数指针 Page182~183

std::function是一个模板类&#xff0c;基本可作为函数指针的代替品&#xff0c;具备更多功能&#xff0c;特别是与函数对象及bind配合使用。使用std::function时&#xff0c;需要添加头文件 #include <functional> 1.定义函数指针 18行&#xff0c;定义了一个函数指针类…

SpringBoot的yml多环境配置3种方法

文章目录 SpringBoot的yml多环境配置3种方法1、多个yml文件1.1、创建多个配置文件applicaiton.yml中指定配置 2、单个yml文件3、在pom.xml中指定环境配置3.1、创建多个配置文件3.2、在application.yml中添加多环境配置属性3.3、在pom.xml中指定使用的配置3.4、问题&#xff1a;…

MYSQL高性能索引

正确的选择和创建索引是实现高性能查询的基础&#xff0c;以下是高效使用索引的方法 演示的sql 独立的列 独立的列指的是索引既不是表达式的一部分也不是函数的参数。 mysql> select actor_id from actor where actor_id 1 5;mysql> SELECT actor_id FROM actor WHER…