前端ENV环境配置

环境变量配置

前端项目使用 Vite 的环境变量配置系统,通过 .env 文件管理不同环境的配置项。

配置文件位置

环境变量配置文件位于项目根目录,包括 .env.env.development.env.development.local.env.local 等文件。

自 V5.12.1 起,站点相关配置优先通过网站配置的图形化界面维护,包括网站 Logo、网站标题、备案/版权信息、隐私提示、Clarity ID、验证码模式、前端注册、国际化切换、亮暗模式、反调试保护、钉钉导入和企业微信导入等。

配置项说明

配置项描述
VITE_IS_MICROtrue是否是微服务架构(重要),因为单体和微服务版本共用一套前端
VITE_GLOBAL_TITLE'PIGX ADMIN'旧版网站主标题配置,新版请在网站配置中维护
VITE_FOOTER_TITLE'©2024 pig4cloud.com'旧版页脚信息配置,新版请在网站配置中维护
VITE_PUBLIC_PATH/前端访问前缀
VITE_API_URL/api后端请求前缀
VITE_ADMIN_PROXY_PATHhttp://localhost:9999ADMIN 服务地址
VITE_PWD_ENC_KEY'pigxpigxpigxpigx'前端加密密钥(16位,具体参考文档前端报文加密)
VITE_OAUTH2_PASSWORD_CLIENT'pig:pig'OAUTH2 密码模式客户端信息
VITE_OAUTH2_MOBILE_CLIENT'app:app'OAUTH2 短信客户端信息
VITE_OAUTH2_SOCIAL_CLIENT'social:social'OAUTH2 社交登录客户端信息
VITE_VERIFY_ENABLEtrue旧版前端验证码开关,新版请在网站配置中选择验证码模式
VITE_VERIFY_IMAGE_ENABLEfalse旧版前端图形验证码开关,新版请在网站配置中选择验证码模式
VITE_WEBSOCKET_ENABLEfalse是否开启 WebSocket 消息接收
VITE_REGISTER_ENABLEtrue旧版注册开关,新版请在网站配置中维护前端注册
VITE_AUTO_TENANTfalse是否开启租户自动选择(根据租户域名)
VITE_I18N_ENABLEtrue旧版登录页多语言切换开关,新版请在网站配置中维护国际化切换
VITE_DARK_MODE_ENABLEtrue旧版登录页暗黑模式切换开关,新版请在网站配置中维护亮暗模式
VITE_ENABLE_ANTI_DEBUGfalse旧版反调试开关,新版请在网站配置中维护反调试保护
VITE_ANTI_DEBUG_KEYpig旧版反调试绕过参数值,新版请在网站配置中维护绕过密钥(URL中 ?ddtk=参数值
VITE_GRAY_VERSION对应灰度路由的 header Version
VITE_API_ENC_ENABLEDfalse是否开启请求加解密
VITE_SYNC_DINGTALK_ENABLEDfalse旧版钉钉同步功能开关,新版请在网站配置中维护钉钉导入
VITE_SYNC_WECHAT_ENABLEDfalse旧版企微同步功能开关,新版请在网站配置中维护企业微信导入
VITE_CUSTOM_HOMEPAGE_ENABLEfalse是否开启自定义首页功能(v5.11)
网站配置覆盖范围

Logo、网站标题、备案/版权信息、隐私提示和 Clarity ID 等站点信息也已经迁移到网站配置的图形化界面中维护。

旧版配置修改后生效

修改 VITE_GLOBAL_TITLEVITE_FOOTER_TITLE 等配置项后,需要清空浏览器 localStorage 缓存才能生效。

环境文件说明

  • .env - 所有环境的基础配置
  • .env.development - 开发环境配置
  • .env.development.local - 本地开发环境配置(优先级最高,不纳入版本控制)
  • .env.local - 本地环境配置(不纳入版本控制)
环境变量加载优先级

Vite 会按照优先级加载环境变量,.env.development.local > .env.development > .env.local > .env

常见配置示例

微服务模式配置

VITE_IS_MICRO=true
VITE_ADMIN_PROXY_PATH=http://localhost:9999

单体模式配置

VITE_IS_MICRO=false
VITE_ADMIN_PROXY_PATH=http://localhost:8080

开启验证码

VITE_VERIFY_ENABLE=true
VITE_VERIFY_IMAGE_ENABLE=true
密钥安全

VITE_PWD_ENC_KEY 为前端加密密钥,生产环境请务必修改为自定义值,并确保长度为16位。