是深入浅出Webpack的学习笔记

Webpack本质是一个 Node.js 应用。对其的使用者来说，它是一个简单强大的工具； 对其的开发者来说，它是一个扩展性的高系统。

Webpack 之所以能成功，在于它把复杂的实现隐藏了起来，给用户暴露出的只是一个简单的工具，让用户能快速达成目的。 同时整体架构设计合理，扩展性高，开发扩展难度不高，通过社区补足了大量缺失的功能，让 Webpack 几乎能胜任任何场景。

Webpack整理流程简述

Webpack 的运行流程是一个串行的过程，从启动到结束会依次执行以下流程：

  1. 初始化参数：从配置文件和 Shell 语句中读取与合并参数，得出最终的配置对象和参数；
  2. 开始编译：用上一步得到的参数初始化 Compiler 对象，加载所有配置的插件，执行对象的 run 方法开始执行编译；
  3. 确定入口：根据配置中的 entry 找出所有的入口文件；
  4. 编译模块：从入口文件出发，调用所有配置的 Loader 对模块进行翻译，再找出该模块依赖的模块，再递归本步骤直到所有入口依赖的文件都经过了本步骤的处理；
  5. 完成模块编译：在经过第4步使用 Loader 翻译完所有模块后，得到了每个模块被翻译后的最终内容以及它们之间的依赖关系；
  6. 输出资源：根据入口和模块之间的依赖关系，组装成一个个包含多个模块的 Chunk，再把每个 Chunk 转换成一个单独的文件加入到输出列表，这步是可以修改输出内容的最后机会；
  7. 输出完成：在确定好输出内容后，根据配置确定输出的路径和文件名，把文件内容写入到文件系统；

在以上过程中，Webpack 会在特定的时间点广播出特定的事件，插件在监听到感兴趣的事件后会执行特定的逻辑，并且插件可以调用 Webpack 提供的 API 改变 Webpack 的运行结果。

所以插件的执行时机是什么？是当特定的事件发生的时候；

Webpack 的构建流程可以分为以下三大阶段：

  • 初始化：启动构建，读取与合并配置参数，加载 Plugin，实例化 Compiler。
  • 编译：从 Entry 发出，针对每个 Module 串行调用对应的 Loader 去翻译文件内容，再找到该 Module 依赖的 Module，递归地进行编译处理。
  • 输出：对编译后的 Module 组合成 Chunk，把 Chunk 转换成文件，输出到文件系统。
    如果只执行一次构建，以上阶段将会按照顺序各执行一次。
    但在开启监听模式下，当有文件产生变化后，后续构建中，将不会再走初始化阶段。

各个阶段的事件

初始化阶段事件

  • 初始化参数：从配置文件和 Shell 语句中读取与合并参数，得出最终的参数。 这个过程中还会执行配置文件中的插件实例化语句 new Plugin()；
  • 实例化 Compiler：用上一步得到的参数初始化 Compiler 实例。（Compiler 负责文件监听和启动编译，Compiler 实例中包含了完整的 Webpack 配置，全局只有一个 Compiler 实例）；
  • 加载插件：依次调用插件的 apply 方法，让插件可以监听后续的所有事件节点。同时给插件传入 compiler 实例的引用，以方便插件通过 compiler 调用 Webpack 提供的 API；
  • environment：应用 Node.js 风格的文件系统到 compiler 对象，以方便后续的文件寻找和读取；
  • entry-option：读取配置的 Entrys，为每个 Entry 实例化一个对应的 EntryPlugin，为后面该 Entry 的递归解析工作做准备；
  • after-plugins：调用完所有插件（内置的和配置）的 apply 方法；
  • after-resolvers：根据配置初始化完 resolver（resolver 负责在文件系统中寻找指定路径的文件）；

编译阶段事件

  • run：启动一次新的编译；
  • watch-run： 和 run 类似，区别在于它是在监听模式下启动的编译，在这个事件中可以获取到是哪些文件发生了变化导致重新启动一次新的编译；
  • compile：该事件是为了告诉插件一次新的编译将要启动，同时会给插件带上 compiler 对象；
  • compilation：当 Webpack 以开发模式运行时，每当检测到文件变化，一次新的 Compilation 将被创建。一个 Compilation 对象包含了当前的模块资源、编译生成资源、变化的文件等，也提供了很多事件回调供插件做扩展；
  • make：一个新的 Compilation 创建完毕，即将从 Entry 开始读取文件，根据文件类型和配置的 Loader 对文件进行编译，编译完后再找出该文件依赖的文件，递归的编译和解析；
  • after-compile： 一次 Compilation 执行完成；
  • invalid：当遇到文件不存在、文件编译错误等异常时会触发该事件，该事件不会导致 Webpack 退出；

编译阶段包括了一些粒度更小的事件：

  • build-module：使用对应的 Loader 去转换一个模块；
  • normal-module-loader：在用 Loader 对一个模块转换完后，使用 acorn 解析转换后的内容，输出对应的抽象语法树（AST），以方便 Webpack 后面对代码的分析；
  • program： 从配置的入口模块开始，分析其 AST，当遇到 require 等导入其它模块语句时，便将其加入到依赖的模块列表，同时对新找出的依赖模块递归分析，最终搞清所有模块的依赖关系；
  • seal（密封）：所有模块及其依赖的模块都通过 Loader 转换完成后，根据依赖关系开始生成 Chunk；

输出阶段

  • should-emit：所有需要输出的文件已经生成好，询问插件哪些文件需要输出，哪些不需要；
  • emit：确定好要输出哪些文件后，执行文件输出，可以在这里获取和修改输出内容。
  • after-emit：文件输出完毕。
  • done：成功完成一次完成的编译和输出流程。
  • failed：如果在编译和输出流程中遇到异常导致 Webpack 退出时，就会直接跳转到本步骤，插件可以在本事件中获取到具体的错误原因。

在输出阶段已经得到了各个模块经过转换后的结果和其依赖关系，并且把相关模块组合在一起形成一个个 Chunk。