使用Environment 实例

实验性功能

环境 API 处于实验阶段。在 Vite 6 期间，我们将保持 API 稳定，以便生态系统进行实验并在其基础上构建。我们计划在 Vite 7 中稳定这些新的 API，可能会带来一些重大变更。

资源

• 反馈讨论，我们正在这里收集有关新 API 的反馈。
• 环境 API PR，新 API 在这里实现并经过审查。

请与我们分享您的反馈。

访问环境

在开发期间，可以使用server.environments访问开发服务器中可用的环境。

// create the server, or get it from the configureServer hook
const server = await createServer(/* options */)

const environment = server.environments.client
environment.transformRequest(url)
console.log(server.environments.ssr.moduleGraph)

您还可以从插件中访问当前环境。有关更多详细信息，请参阅插件的环境 API。

DevEnvironment 类

在开发期间，每个环境都是DevEnvironment类的实例。

class DevEnvironment {
  /**
   * Unique identifier for the environment in a Vite server.
   * By default Vite exposes 'client' and 'ssr' environments.
   */
  name: string
  /**
   * Communication channel to send and receive messages from the
   * associated module runner in the target runtime.
   */
  hot: NormalizedHotChannel
  /**
   * Graph of module nodes, with the imported relationship between
   * processed modules and the cached result of the processed code.
   */
  moduleGraph: EnvironmentModuleGraph
  /**
   * Resolved plugins for this environment, including the ones
   * created using the per-environment `create` hook
   */
  plugins: Plugin[]
  /**
   * Allows to resolve, load, and transform code through the
   * environment plugins pipeline
   */
  pluginContainer: EnvironmentPluginContainer
  /**
   * Resolved config options for this environment. Options at the server
   * global scope are taken as defaults for all environments, and can
   * be overridden (resolve conditions, external, optimizedDeps)
   */
  config: ResolvedConfig & ResolvedDevEnvironmentOptions

  constructor(
    name: string,
    config: ResolvedConfig,
    context: DevEnvironmentContext,
  )

  /**
   * Resolve the URL to an id, load it, and process the code using the
   * plugins pipeline. The module graph is also updated.
   */
  async transformRequest(url: string): Promise<TransformResult | null>

  /**
   * Register a request to be processed with low priority. This is useful
   * to avoid waterfalls. The Vite server has information about the
   * imported modules by other requests, so it can warmup the module graph
   * so the modules are already processed when they are requested.
   */
  async warmupRequest(url: string): Promise<void>
}

其中DevEnvironmentContext为

interface DevEnvironmentContext {
  hot: boolean
  transport?: HotChannel | WebSocketServer
  options?: EnvironmentOptions
  remoteRunner?: {
    inlineSourceMap?: boolean
  }
  depsOptimizer?: DepsOptimizer
}

并且TransformResult为

interface TransformResult {
  code: string
  map: SourceMap | { mappings: '' } | null
  etag?: string
  deps?: string[]
  dynamicDeps?: string[]
}

Vite 服务器中的环境实例允许您使用environment.transformRequest(url)方法处理 URL。此函数将使用插件管道将url解析为模块id，加载它（从文件系统或通过实现虚拟模块的插件读取文件），然后转换代码。在转换模块时，导入和其他元数据将通过创建或更新相应的模块节点记录在环境模块图中。处理完成后，转换结果也会存储在模块中。

transformRequest 的命名

在当前版本的提案中，我们使用了transformRequest(url)和warmupRequest(url)，这样对于习惯了 Vite 当前 API 的用户来说更容易讨论和理解。在发布之前，我们也可以借此机会审查这些名称。例如，它可以命名为environment.processModule(url)或environment.loadModule(url)，参考 Rollup 插件钩子中的context.load(id)。目前，我们认为保留当前名称并延迟此讨论更好。

独立的模块图

每个环境都有一个隔离的模块图。所有模块图都具有相同的签名，因此可以实现通用算法来遍历或查询图，而无需依赖环境。hotUpdate就是一个很好的例子。当文件被修改时，每个环境的模块图都将用于发现受影响的模块并独立地为每个环境执行 HMR。

信息

Vite v5 混合了客户端和 SSR 模块图。对于未处理或无效的节点，无法知道它对应于客户端、SSR 或两种环境。模块节点有一些前缀属性，例如clientImportedModules和ssrImportedModules（以及返回两者并集的importedModules）。importers包含每个模块节点来自客户端和 SSR 环境的所有导入者。模块节点还具有transformResult和ssrTransformResult。一个向后兼容层允许生态系统从已弃用的server.moduleGraph迁移。

每个模块都由一个EnvironmentModuleNode实例表示。模块可以在图中注册，而无需进行处理（在这种情况下，transformResult将为null）。在处理模块后，importers和importedModules也会更新。

class EnvironmentModuleNode {
  environment: string

  url: string
  id: string | null = null
  file: string | null = null

  type: 'js' | 'css'

  importers = new Set<EnvironmentModuleNode>()
  importedModules = new Set<EnvironmentModuleNode>()
  importedBindings: Map<string, Set<string>> | null = null

  info?: ModuleInfo
  meta?: Record<string, any>
  transformResult: TransformResult | null = null

  acceptedHmrDeps = new Set<EnvironmentModuleNode>()
  acceptedHmrExports: Set<string> | null = null
  isSelfAccepting?: boolean
  lastHMRTimestamp = 0
  lastInvalidationTimestamp = 0
}

environment.moduleGraph是EnvironmentModuleGraph的一个实例。

export class EnvironmentModuleGraph {
  environment: string

  urlToModuleMap = new Map<string, EnvironmentModuleNode>()
  idToModuleMap = new Map<string, EnvironmentModuleNode>()
  etagToModuleMap = new Map<string, EnvironmentModuleNode>()
  fileToModulesMap = new Map<string, Set<EnvironmentModuleNode>>()

  constructor(
    environment: string,
    resolveId: (url: string) => Promise<PartialResolvedId | null>,
  )

  async getModuleByUrl(
    rawUrl: string,
  ): Promise<EnvironmentModuleNode | undefined>

  getModuleById(id: string): EnvironmentModuleNode | undefined

  getModulesByFile(file: string): Set<EnvironmentModuleNode> | undefined

  onFileChange(file: string): void

  onFileDelete(file: string): void

  invalidateModule(
    mod: EnvironmentModuleNode,
    seen: Set<EnvironmentModuleNode> = new Set(),
    timestamp: number = Date.now(),
    isHmr: boolean = false,
  ): void

  invalidateAll(): void

  async ensureEntryFromUrl(
    rawUrl: string,
    setIsSelfAccepting = true,
  ): Promise<EnvironmentModuleNode>

  createFileOnlyEntry(file: string): EnvironmentModuleNode

  async resolveUrl(url: string): Promise<ResolvedUrl>

  updateModuleTransformResult(
    mod: EnvironmentModuleNode,
    result: TransformResult | null,
  ): void

  getModuleByEtag(etag: string): EnvironmentModuleNode | undefined
}