define是vite中注入编译期全局常量最安全方式,通过字符串替换实现零运行时开销;需用json.stringify或引号包裹值,配合ts类型声明和环境变量动态注入,避免对象、函数及直接使用process.env.node_env。

在 Vite 中,define 是最常用、最安全的注入编译期全局常量的方式,它会在构建时将变量内联替换为字面量值,不产生运行时开销,也避免了污染全局作用域。
使用 define 注入静态常量
Vite 的 define 配置项(位于 vite.config.ts)本质是 Rollup 的 define 插件,会做字符串级别的文本替换。适合注入布尔值、字符串、数字等 JSON 可序列化的常量。
- 配置示例(区分测试/生产渠道):
export default defineConfig({
define: {
__PLATFORM__: '"wechat"', // 字符串需加引号包裹
__IS_PRODUCTION__: 'true',
__VERSION__: JSON.stringify(process.env.APP_VERSION || '1.0.0'),
},
})
注意:"true" 和 true 效果不同 —— define 接收的是字符串,必须保证替换后语法合法,所以布尔值和字符串都要用引号包裹(或用 JSON.stringify 安全处理)。
在代码中安全使用 define 常量
注入后,可直接在任意模块中访问(无需 import),TypeScript 默认不认识这些变量,需补充类型声明:
- 在
env.d.ts或任意.d.ts文件中添加:
declare const __PLATFORM__: string; declare const __IS_PRODUCTION__: boolean; declare const __VERSION__: string;
之后即可在代码中用于条件判断:
if (__PLATFORM__ === 'wechat') {
initWechatSDK();
} else if (__PLATFORM__ === 'alipay') {
initAlipaySDK();
}
if (__IS_PRODUCTION__) {
console.log('生产环境,关闭调试日志');
}
构建时,Vite 会将 __PLATFORM__ === 'wechat' 直接替换为 "wechat" === 'wechat',最终被压缩工具进一步优化为 true 或 false,实现真正的“编译期分支消除”。
配合环境变量动态注入
推荐将渠道信息放在环境变量中,再通过 define 注入,便于 CI/CD 切换:
- 定义环境变量(如
.env.production.wechat):
VITE_PLATFORM=wechat VITE_API_BASE=https://api.example.com/wechat
- 在配置中读取并注入:
define: {
__PLATFORM__: JSON.stringify(process.env.VITE_PLATFORM),
__API_BASE__: JSON.stringify(process.env.VITE_API_BASE),
}
这样同一份代码,只需切换 --mode wechat 或 --mode alipay 即可生成对应渠道包,无需改源码。
避免常见错误
- 不要注入对象或函数:define 不支持复杂结构,否则会导致语法错误或未定义行为;
- 不要在 define 中直接写
process.env.NODE_ENV:Vite 已内置import.meta.env.PROD等标准方式,优先用它; - TS 类型必须手动声明:否则会报
Cannot find name '__PLATFORM__'; - 区分
import.meta.env和define:后者是纯静态替换,前者是运行时注入的对象,安全性与性能不同。











