TypeScript 中 Webpack 怎么使用 DefinePlugin 注入全局环境变量

冷漠man

冷漠man

2026-08-02

978人浏览

原创

typescript 项目中用 webpack defineplugin 注入环境变量需三步:webpack 配置用 json.stringify 确保替换合法;补充 env.d.ts 声明 processenv 类型;代码中使用已声明变量并避免未定义分支,配合 mode 实现死代码消除。

typescript 中 webpack 怎么使用 defineplugin 注入全局环境变量

在 TypeScript 项目中用 Webpack 的 DefinePlugin 注入全局环境变量,关键不是“让 TypeScript 知道变量存在”,而是确保 Webpack 替换后代码语法合法、TS 编译不报错。这需要三步配合:Webpack 配置注入、类型声明补充、使用方式规范。

Webpack 配置要加 JSON.stringify

DefinePlugin 是编译时静态替换,值必须是字符串字面量形式,否则会生成非法 JS 代码。TypeScript 文件里写的 process.env.API_URL,最终会被替换成字符串,所以配置时一定要用 JSON.stringify 包裹:

  • 'process.env.API_URL': JSON.stringify('https://api.example.com') ✅ 替换后是 "https://api.example.com"
  • 'process.env.API_URL': '"https://api.example.com"' ⚠️ 虽然也能运行,但属于硬编码字符串,不够健壮
  • 'process.env.API_URL': 'https://api.example.com' ❌ 会变成 const url = https://api.example.com;,语法错误

TypeScript 需要补全类型声明

TS 默认不认识 process.env.XXX,直接访问会报 Property 'XXX' does not exist on type 'NodeJS.ProcessEnv'。解决方法是在项目中添加类型声明文件(如 src/env.d.ts):

php版微信js-sdk支付接口类
php版微信js-sdk支付接口类

php版微信js-sdk支付接口类

下载
  • 声明扩展 NodeJS.ProcessEnv 接口:declare namespace NodeJS { interface ProcessEnv { API_URL: string; NODE_ENV: 'development' | 'production'; } }
  • 如果定义了自定义变量(如 APP_VERSION),也需一并声明:interface ProcessEnv { APP_VERSION: string; }
  • 确保该文件被 TS 加载:放在 src 下,或在 tsconfig.jsoninclude 中显式包含

代码中使用要避免未定义分支

DefinePlugin 替换发生在 Webpack 编译阶段,TS 类型检查在前,构建在后。因此写法必须保证:无论变量是否被 DefinePlugin 注入,TS 都能通过,且运行时不会访问未定义属性:

  • 推荐写法:if (process.env.NODE_ENV === 'development') { ... } —— TS 已声明 NODE_ENV,且值是字面量联合类型,支持类型收窄
  • 避免写法:if (process.env.DEBUG) { ... } —— 若未在 DefinePlugin 中配置 DEBUG,构建后该分支仍存在,但值为 undefined,可能引发逻辑错误
  • 安全取值:const apiUrl = process.env.API_URL || ''; 或用非空断言(仅当你 100% 确保它一定被注入):process.env.API_URL!

配合 mode 实现自动死代码消除

Webpack 的 mode: 'production' 会启用 Terser 插件,默认识别 process.env.NODE_ENV === 'development' 这类常量判断并移除整个 if 块。前提是:

  • DefinePlugin 明确注入了 'process.env.NODE_ENV': JSON.stringify('production')
  • TypeScript 声明中 NODE_ENV 是字面量类型(如 'development' | 'production'),而非 string
  • 不要在条件中拼错字符串,比如写成 'dev' —— 构建后无法匹配,分支不会被删除

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2389

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

718

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

2205

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

638

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1167

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

2111

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

2392

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

1499

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

500

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.1万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.5万人学习