如何在Vue.js应用构建前强制校验.env.example中所有环境变量是否已配置
Vue.js项目构建前强制校验环境变量实现方案
该方案可以在构建执行前自动校验所有.env.example中声明的环境变量是否已赋值,缺失时直接终止构建,避免线上故障。
实现步骤
第一步:安装依赖
我们需要dotenv来解析env文件,执行以下命令安装开发依赖:npm install dotenv --save-dev第二步:编写校验脚本
在项目根目录新建env-validate.js文件,内容如下:const fs = require('fs') const path = require('path') const dotenv = require('dotenv') // 读取.env.example中声明的所有必填环境变量 const exampleEnvContent = fs.readFileSync(path.resolve(__dirname, '.env.example'), 'utf-8') const requiredEnvKeys = Object.keys(dotenv.parse(exampleEnvContent)) // 加载当前项目的env配置,需要多环境配置修改此处path参数即可 dotenv.config({ path: path.resolve(__dirname, '.env') }) const missingKeys = [] requiredEnvKeys.forEach(key => { // 校验变量是否存在且非空 if (!process.env[key] || process.env[key].trim() === '') { missingKeys.push(key) } }) if (missingKeys.length > 0) { console.error('\n❌ 环境变量校验不通过,缺失以下必填变量:') missingKeys.forEach(item => console.error(` - ${item}`)) console.error('\n请在.env文件中补充完整后再执行构建操作\n') // 退出进程,终止后续构建流程 process.exit(1) } console.log('✅ 环境变量校验通过,开始执行构建\n')第三步:修改构建命令
打开package.json,修改scripts中的构建命令,在校验通过后再执行原有构建逻辑:Vite项目示例:
{ "scripts": { "build": "node env-validate.js && vite build" } }Vue CLI项目示例:
{ "scripts": { "build": "node env-validate.js && vue-cli-service build" } }
可选优化
- 区分环境校验规则:开发环境可以将缺失变量的逻辑改为警告不终止,生产环境必须终止构建,只需判断
process.env.NODE_ENV的值调整逻辑即可 - 增加格式校验:除了非空校验外,还可以增加规则校验,比如接口地址必须以http开头、端口号必须是数字等
- 多环境适配:如果有
.env.development、.env.production等多环境配置,可以在校验脚本中根据当前环境读取对应的env文件校验
注意事项
.env.example文件只需声明变量名即可,不需要填写真实值,格式为VITE_API_BASE=- Vite项目默认仅将
VITE_前缀的环境变量注入到进程中,自定义前缀需要额外修改Vite配置的envPrefix参数 - CI/CD流程中配置的环境变量也会被自动纳入校验范围,不需要额外调整脚本
内容的提问来源于stack exchange,提问作者Paras
相关产品推荐
相关产品推荐

