前端工程化 / 系统课时

按命令和模式返回配置

按命令和模式返回配置

本课解决一个常见配置膨胀问题:同一项目需要开发、预览、客户端构建、SSR 构建和不同模式时,不再复制多份配置文件,而是让 vite.config.ts 根据运行上下文返回最小差异配置。

学习目标

  • 区分 command、mode、isSsrBuild 与 isPreview 的职责
  • 按稳定优先级组织配置分支,避免条件互相覆盖
  • 通过命令和日志验证实际命中的配置

判断维度与分支顺序

Vite 配置可以导出函数。函数参数不是环境变量,而是本次运行的上下文:开发服务器的 command 为 serve,生产构建为 build;mode 默认分别是 development 和 production,也可以被 --mode 改写。

条件 典型命令 适合控制的配置
isPreview === true vite preview preview.port、预览专用检查
command === 'build' && isSsrBuild === true vite build --ssr SSR 构建选项
command === 'build' vite build 客户端产物、压缩、Source Map
command === 'serve' vite 开发端口、代理、热更新

分支应先判断更具体的 preview 和 SSR,再判断普通 serve 或 build。部分外部工具加载配置时可能不给 isSsrBuild、isPreview 赋值,因此应使用 === true,不要依赖真假值推断。

Vite 条件配置分支顺序

编写可验证配置

下面的 vite.config.ts 用一个函数返回四类配置,并打印确定性的分支名称。base 由模式决定,开发、预览和构建选项则由命令上下文决定。

ts
import { defineConfig } from 'vite'

export default defineConfig(({ command, mode, isSsrBuild, isPreview }) => {
  const ssrBuild = isSsrBuild === true
  const preview = isPreview === true

  const profile = preview
    ? 'preview'
    : command === 'build'
      ? ssrBuild
        ? 'ssr-build'
        : 'client-build'
      : 'dev'

  console.log(`[config] ${profile} mode=${mode}`)

  const base = mode === 'staging' ? '/staging/' : '/'

  if (preview) {
    return {
      base,
      preview: { port: 4173, strictPort: true },
    }
  }

  if (command === 'serve') {
    return {
      base,
      server: { port: 5173, strictPort: true },
    }
  }

  if (ssrBuild) {
    return {
      base,
      build: { sourcemap: true },
    }
  }

  return {
    base,
    build: { sourcemap: mode !== 'production' },
  }
})

为了验证 SSR 分支,在项目中准备一个最小入口文件 src/entry-server.js:

js
export function render() {
  return '<h1>SSR entry</h1>'
}

该入口只负责让 vite build --ssr 有可构建模块;真实项目再替换为框架对应的服务端入口。

运行与验证

分别执行以下命令。开发服务器和预览服务器会持续占用终端,应先按 Ctrl+C 结束,再执行下一条。

bash
npm run dev -- --mode staging
npm run build -- --mode staging
npx vite build --ssr src/entry-server.js --mode staging
npm run preview -- --mode staging

预期输出中的构建耗时、文件大小和本机地址可能不同,关键是四条分支日志依次匹配运行目的。

text
[config] dev mode=staging
[config] client-build mode=staging
[config] ssr-build mode=staging
[config] preview mode=staging

vite build --mode staging 仍然是 command === 'build',只是模式变成 staging。因此不要把 mode === 'production' 当成“正在执行构建”的唯一判断。

边界与排错

当配置未按预期生效时,先打印四个上下文字段,再检查分支顺序。preview 本质上读取已有产物,不会替你重新构建;修改构建配置后,应先重新执行 vite build,再启动 vite preview。

避免在每个分支复制整份配置。先计算公共值,再只返回差异项;当差异较多时,可拆成 createDevConfig、createBuildConfig 等纯函数,但仍保留一个配置入口。

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

目录与阅读设置

阅读设置

17

记录一个想法

按命令和模式返回配置

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

登录哪都通