JavaScript 中怎么用 Vite 配置全局常量替换编译选项

夜宇姑娘_1293

夜宇姑娘_1293

2026-10-03

684人浏览

原创

vite 中全局常量替换主要通过 define 选项实现,它在构建和开发时静态替换变量为 json 序列化值,适用于版本号、api 地址等编译期常量,非运行时读取,不替代 import.meta.env。

javascript 中怎么用 vite 配置全局常量替换编译选项

在 Vite 中配置全局常量替换,主要通过 define 选项实现。它会在构建和开发服务器启动时,将指定的变量名静态替换为对应值(字符串字面量或 JSON 序列化后的结果),适用于注入环境标识、API 地址、版本号等编译期确定的常量。

使用 define 配置静态常量

Vite 的 define 选项接受一个对象,键为要替换的全局变量名(支持点号嵌套),值为替换后的 JavaScript 字面量(如字符串、布尔值、数字、对象等)。Vite 会将其直接内联到代码中,**不是运行时读取**,也不是环境变量代理。

  • 配置写在 vite.config.ts 或 vite.config.js 的 define 字段中
  • 值必须是可被 JSON 序列化的类型;若需字符串,要手动加引号(如 '"prod"')或用 JSON.stringify()
  • 推荐用 JSON.stringify() 避免引号错误,尤其对字符串和对象

示例:

vite.config.ts
export default defineConfig({
  define: {
    __APP_VERSION__: JSON.stringify('1.2.0'),
    __API_BASE__: JSON.stringify('https://api.example.com'),
    __IS_DEV__: JSON.stringify(import.meta.env.DEV),
    __FEATURE_FLAGS__: JSON.stringify({ enableNewUI: true, debugMode: false })
  }
})

之后在任意模块中可直接使用:

console.log(__APP_VERSION__) // "1.2.0"
console.log(__API_BASE__)     // "https://api.example.com"
console.log(__FEATURE_FLAGS__.enableNewUI) // true

注意:define ≠ 环境变量(import.meta.env)

define 是纯文本替换,不经过任何运行时解析;而 import.meta.env 是 Vite 注入的只读对象,其字段受 .env 文件和 envPrefix 控制,且仅限 VITE_ 开头的变量暴露给客户端。

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 不要用 define 替代 import.meta.env.VITE_API_URL —— 后者更安全、支持热更新、与 .env 集成更好
  • 适合用 define 的场景:需要在压缩阶段被完全消除的条件分支(如 if (__IS_PROD__) { ... })、无法用 import.meta.env 表达的复杂常量(如预计算的对象结构)
  • Terser(生产构建默认压缩器)能自动移除死代码,例如:if (false) { ... } 或 if (__DEBUG__ === false) { ... } 整块会被删掉

在 TypeScript 中避免类型报错

直接使用未声明的全局变量(如 __APP_VERSION__)会导致 TS 报错。需在 env.d.ts 中补充类型声明:

// src/env.d.ts
declare const __APP_VERSION__: string
declare const __API_BASE__: string
declare const __IS_DEV__: boolean
declare const __FEATURE_FLAGS__: { enableNewUI: boolean; debugMode: boolean }

或者统一声明为 const 类型(推荐):

declare global {
  const __APP_VERSION__: string
  const __API_BASE__: string
  const __IS_DEV__: boolean
  const __FEATURE_FLAGS__: Record<string any>
}
export {}</string>

结合环境区分定义(可选进阶)

可通过 mode 参数动态设置 define 内容,例如区分 development / production:

export default defineConfig(({ mode }) => ({
  define: {
    __BUILD_TIME__: JSON.stringify(new Date().toISOString()),
    __MODE__: JSON.stringify(mode),
    ...(mode === 'production' ? {
      __ANALYTICS_ID__: JSON.stringify('prod-abc123')
    } : {
      __ANALYTICS_ID__: JSON.stringify('dev-test999')
    })
  }
}))

⚠️ 注意:new Date() 在配置阶段执行,每次启动 Vite 服务时生成一次,不是每次请求。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

javascript java vite

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.06.20

4526

5

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

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

2023.07.04

1129

3

js四舍五入
js四舍五入

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

2023.07.04

4444

6

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

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

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1796

5

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

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

2023.09.04

3245

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4233

6

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

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

2023.09.20

2740

5

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

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

2023.09.20

888

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习