Skip to content

环境配置

配置

默认提供四套环境配置,分别为:

bash
# 页面标题
VITE_APP_TITLE = 'Admin'
bash
# 接口请求地址,会设置到 axios 的 baseURL 参数上
VITE_APP_API_BASEURL = /

# 是否开启代理
VITE_APP_OPEN_PROXY = false

# 是否开启开发者工具
VITE_APP_INSPECTOR = false
bash
# 接口请求地址,会设置到 axios 的 baseURL 参数上
VITE_APP_API_BASEURL = /

# 是否在打包时启用 Mock
VITE_BUILD_MOCK = true

# 在构建时生成 sourcemap
VITE_BUILD_SOURCEMAP = true

# 在构建时开启压缩,支持 gzip 和 brotli
VITE_BUILD_COMPRESS =
bash
# 接口请求地址,会设置到 axios 的 baseURL 参数上
VITE_APP_API_BASEURL = /

# 是否在打包时启用 Mock
VITE_BUILD_MOCK = false

# 在构建时生成 sourcemap
VITE_BUILD_SOURCEMAP = false

# 在构建时开启压缩,支持 gzip 和 brotli
VITE_BUILD_COMPRESS = gzip,brotli

# 是否在打包时启用传统浏览器兼容,可在 .browserslistrc 中进行具体配置
VITE_BUILD_LEGACY = false

其中 VITE_APP_TITLE VITE_APP_API_BASEURL必要配置,即不管是在开发、测试,还是生产环境都需要使用到。而其余配置则在不同环境下有不同用途,例如开发环境用于本地开发使用,测试环境和生产环境用于构建使用。

开发者可根据实际业务需求进行扩展,如果对这块不熟悉,请阅读 Vite - 环境变量和模式 章节。

配置选项

如果你想要添加自定义变量可以在对应环境的 env 文件中添加, .env 环境内的变量会和对应环境 env 文件合并。例如 .env.development 文件中添加 VITE_APP_TITLE = 'Admin',则会覆盖 .env 文件中的 VITE_APP_TITLE

安全注意事项

  • .env.*.local 文件应是本地的,可以包含敏感变量。你应该将 .local 添加到你的 .gitignore 中,以避免它们被 git 检入。

  • 由于任何暴露给 Vite 源码的变量最终都将出现在客户端包中,VITE_* 变量应该不包含任何敏感信息。

VITE_APP_TITLE

  • 类型 string
  • 默认值 技术中台管理系统

页面标题,会设置到 index.html<title> 标签上。如果开启动态标题,该配置项会 和 route 中的 meta.title 合并展示, 例如 首页 - 技术中台管理系统

VITE_APP_API_BASEURL

  • 类型 string
  • 默认值 /

接口请求地址,会设置到请求实例的 baseURL 参数上。

VITE_APP_OPEN_PROXY

  • 类型 boolean
  • 默认值 false

是否开启代理,开启后会将 /proxy 开头的请求代理到 VITE_APP_API_BASEURL

javascript
defineConfig({
  proxy: {
    '/proxy': {
      target: VITE_APP_API_BASEURL,
      changeOrigin: !isBuild && VITE_OPEN_PROXY === 'true',
      rewrite: path => path.replace(/\/proxy/, ''),
    },
  }
})

VITE_APP_INSPECTOR

  • 类型 boolean
  • 默认值 false

是否开启开发者工具,开启后会在页面右下角显示一个开发者工具按钮,点击后可以查看当前页面的路由信息、状态信息、环境信息等。

VITE_BUILD_MOCK

  • 类型 boolean
  • 默认值 false

是否在打包时启用 Mock,开启后会在打包时将 Mock 数据打包到最终的代码中。

VITE_BUILD_SOURCEMAP

  • 类型 boolean
  • 默认值 false

在构建时生成 sourcemap,开启后会在打包时生成 sourcemap 文件,方便调试。

VITE_BUILD_COMPRESS

  • 类型 gzip | brotli | gzip,brotli
  • 默认值 gzip,brotli

在构建时开启压缩,支持 gzip 和 brotli,开启后会在打包时生成对应的压缩文件。

VITE_BUILD_LEGACY

  • 类型 boolean
  • 默认值 false

在构建时开启传统浏览器支持,若开启则启用的 vite-plugin-legacy,可通过 .browserslistrc 配置需要支持的版本。