前端工程化 / 系统课时

编写条件插件配置

编写条件插件配置

同一插件同时进入开发、生产构建和特殊模式,常会产生重复日志、额外网络请求或不必要的构建开销。本课通过配置函数、loadEnv 与 apply 三层条件,把插件限制在明确的命令、模式和运行环境中。

学习目标

  • 根据 command 与 mode 决定是否注册插件
  • 使用 loadEnv 读取影响 Vite 配置本身的环境变量
  • 用 apply 为插件增加开发、构建或 SSR 边界

选择条件放置位置

配置函数适合在创建插件前做全局判断。Vite 在开发命令下传入 command: 'serve',在生产构建下传入 command: 'build';mode 则由默认值或 --mode 决定,两者是独立维度。:contentReference[oaicite:2]{index=2}

apply 适合把限制封装进插件自身,可直接写成 'serve'、'build',也可以写函数处理 SSR 等更细条件。插件数组中的 false、null 和 undefined 会被忽略,因此可以用短路表达式保持配置紧凑。:contentReference[oaicite:3]{index=3}

Vite 条件插件启用决策流程

编写可验证的条件配置

新建 .env.staging,让分析插件只在 staging 模式显式开启:

text
ENABLE_ANALYZE=true

然后在 vite.config.ts 中配置三个用途不同的插件:

ts
import {
  defineConfig,
  loadEnv,
  type Plugin,
} from 'vite'

function announcePlugin(
  name: string,
  apply: 'serve' | 'build',
): Plugin {
  return {
    name,
    apply,
    configResolved(config) {
      console.log(
        `[plugin] ${name}: command=${config.command}, mode=${config.mode}`,
      )
    },
  }
}

export default defineConfig(({ command, mode }) => {
  // 第三个参数传空字符串,允许读取不带 VITE_ 前缀的配置变量。
  const env = loadEnv(mode, process.cwd(), '')
  const analyzeEnabled = env.ENABLE_ANALYZE === 'true'

  const analyzePlugin: Plugin = {
    ...announcePlugin('bundle-analysis', 'build'),
    apply(config, current) {
      // 分析插件只参与非 SSR 的构建。
      return current.command === 'build' && !config.build.ssr
    },
  }

  return {
    plugins: [
      command === 'serve' &&
        announcePlugin('dev-diagnostics', 'serve'),

      command === 'build' &&
        mode === 'production' &&
        announcePlugin('release-metadata', 'build'),

      analyzeEnabled && analyzePlugin,
    ],
  }
})

分别执行开发和 staging 构建:

bash
npm run dev -- --mode development
npm run build -- --mode staging

预期输出

text
开发命令:
[plugin] dev-diagnostics: command=serve, mode=development

staging 构建:
[plugin] bundle-analysis: command=build, mode=staging

构建过程还会输出 Vite 自身日志,具体文件数量、体积和耗时属于动态值,不作为本示例的验证依据。判断条件是否正确,只需核对带 [plugin] 前缀的两行。

理解三层条件的职责

第一层是“是否创建插件”。例如只有 mode === 'production' 才调用发布元数据插件工厂,可以避免插件初始化阶段就产生副作用。

第二层是“插件是否参与当前命令”。apply: 'serve' 与 apply: 'build' 能把约束保留在插件定义中,即使插件后来被移动到其他配置文件,也不容易误用。

第三层是“插件钩子内部是否处理当前对象”。即使插件已启用,transform 仍应使用 id、环境或文件类型过滤目标模块。条件插件配置不能代替钩子级过滤。

环境变量边界

Vite 解析配置时不会自动把 .env.* 文件全部写入 process.env;当环境变量需要影响插件注册时,应在配置函数中调用 loadEnv。第三个参数设为 '' 会读取所有前缀,因此只应取明确需要的键。:contentReference[oaicite:4]{index=4}

不要把密钥改成 VITE_ 前缀来方便读取。带 VITE_ 前缀的变量可能暴露给客户端代码,适合公开配置,不适合令牌、密码或私钥。:contentReference[oaicite:5]{index=5}

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

编写条件插件配置

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通