环境变量和模式

提示

建议先阅读 Vite 的环境变量和模式文档，然后再阅读以下部分。

全局环境变量

electron-vite 会像 Vite 一样从项目根目录加载环境变量，并使用不同的前缀来限制可用范围。

默认情况下，以 MAIN_VITE_ 为前缀的变量暴露给主进程，PRELOAD_VITE_ 用于预加载脚本，RENDERER_VITE_ 则用于渲染器，VITE_ 则所有进程共用。

// .env
KEY=123                # 无效变量
MAIN_VITE_KEY=123      # 仅主进程可用
PRELOAD_VITE_KEY=123   # 仅预加载脚本可用
RENDERER_VITE_KEY=123  # 仅渲染器可用
VITE_KEY=123           # 所有进程共用

// .env
KEY=123                # 无效变量
MAIN_VITE_KEY=123      # 仅主进程可用
PRELOAD_VITE_KEY=123   # 仅预加载脚本可用
RENDERER_VITE_KEY=123  # 仅渲染器可用
VITE_KEY=123           # 所有进程共用

如果你想自定义 env 变量的前缀，可以使用 envPrefix 选项。

// electron.vite.config.js
export default defineConfig({
  main: {
    envPrefix: 'M_VITE_'
  }
  // ...
})

// electron.vite.config.js
export default defineConfig({
  main: {
    envPrefix: 'M_VITE_'
  }
  // ...
})

如果你是 TypeScript 用户，请确保在 env.d.ts 中添加 import.meta.env 的类型定义，以获取用户自定义环境变量的类型检查和智能感知。

/// <reference types="vite/client" />

interface ImportMetaEnv {
  readonly MAIN_VITE_SOME_KEY: string
  // more env variables...
}

interface ImportMeta {
  readonly env: ImportMetaEnv
}

/// <reference types="vite/client" />

interface ImportMetaEnv {
  readonly MAIN_VITE_SOME_KEY: string
  // more env variables...
}

interface ImportMeta {
  readonly env: ImportMetaEnv
}

模式

默认情况下，dev 命令运行在 development (开发) 模式，而 build 和 preview 命令则运行在 production (生产) 模式。

你可以通过传递 --mode 选项标志来覆盖命令使用的默认模式。请参阅 Vite 模式

环境变量和模式 ​

全局环境变量 ​

模式 ​

环境变量和模式

全局环境变量

模式