浅析 webpack 打包流程(原理) 六 - 生成文件

接上文:浅析 webpack 打包流程(原理) 五 - 构建资源

八、生成(写入)文件

本阶段概述:
1.根据配置确定输出路径和文件名,创建目标文件夹及文件,将资源写入目标路径;
2.写入时,会循环处理sourceReplaceSource 实例的replacements,将其替换为真实字符串;
3.设置 stats 并打印构建信息。

回到 seal,执行this.summarizeDependencies(),得到this.fileDependenciesthis.contextDependenciesthis.missingDependencies后,触发了一系列处理/优化资源的钩子,然后回到Compiler.js的 compile 里的 compilation.seal 回调。

// /lib/Compiler.js
compilation.seal(err => {
  // seal 结束,执行回调  
  if (err) return callback(err);
  this.hooks.afterCompile.callAsync(compilation, err => {
    if (err) return callback(err);
    // callback 是调用 this.compile 时传入的 onCompiled 函数
    return callback(null, compilation);
  });
});

afterCompile钩子会触发插件 CachePlugin.js 订阅的相关事件,给 compiler 的属性_lastCompilationFileDependencies_lastCompilationContextDependencies分别赋值fileDependenciescontextDependencies

创建目标文件夹

执行 callback,即调用 this.compile 时传入的 onCompiled 函数:

// /lib/Compiler.js
const onCompiled = (err, compilation) => {
  // ...
  this.emitAssets(compilation, (err) => {
  //...
  });
}

emitAssets 方法负责的是构建资源输出的过程。它触发了 Compiler.hooks: emit,尔后在回调里执行:

// /lib/Compiler.js
emitAssets(compilation, callback) {
  let outputPath;
  const emitFiles = err => {
    asyncLib.forEachLimit()
  }

  this.hooks.emit.callAsync(compilation, err => {
    if (err) return callback(err);
    outputPath = compilation.getPath(this.outputPath); // 获取资源输出的路径
    this.outputFileSystem.mkdirp(outputPath, emitFiles); // 递归创建输出目录并输出资源
  });
}

outputPath 为配置里的 output.path,然后调用this.outputFileSystem.mkdirp创建文件夹。

创建目标文件并写入

成功创建目标文件夹后,执行回调emitFiles,方法里通过asyncLib.forEachLimit并行执行,对每个 file 资源文件进行路径拼接,将每个 source 源码转换为 buffer (为了性能提升),最后将文件写入真实目标路径:

// /lib/Compiler.js
asyncLib.forEachLimit(
  compilation.getAssets(),
  15,
  ({ name: file, source }, callback) => {
    //...
    const writeOut = (err) => {
      //...
      const targetPath = this.outputFileSystem.join(outputPath, targetFile); // 路径拼接,得到真实路径
      if (this.options.output.futureEmitAssets) {
        //... 判断重写入 及 gc释放内存(this.assets 相关重写 SizeOnlySource)
      } else {
        //... source 为 CachedSource 实例,content 为得到的资源
        let content = source.source();

        if (!Buffer.isBuffer(content)) {
          // buffer转换,在 node 中提升性能
          content = Buffer.from(content, 'utf8'); 
        }
        //... 写入文件
        this.outputFileSystem.writeFile(targetPath, content, (err) => {
          //...
          this.hooks.assetEmitted.callAsync(file, content, callback);
        });
      }
    };
    // 若目标文件路径包含/或\,先创建文件夹再写入
    if (targetFile.match(/\/|\\/)) {
      const dir = path.dirname(targetFile);
      this.outputFileSystem.mkdirp(this.outputFileSystem.join(outputPath, dir), writeOut);
    } else {
      writeOut();
    }
  },
  // 遍历完成的回调函数
  (err) => {
  }
);

上面let content = source.source() 中的 source 为 CachedSource 实例,它的 source 方法,进行了缓存判断,若无缓存通过this._source.source()获取资源。_source 为 ConcatSource 实例,它的 source 方法会遍历_source.children,如果不是字符串,则再执行 source 方法,是字符串就直接作为资源返回。源码如下:

// /node_modules/webpack-sources/lib/CachedSource.js
source() {
  if(typeof this._cachedSource !== "undefined") return this._cachedSource;
  return this._cachedSource = this._source.source();
}

// /node_modules/webpack-sources/lib/ConcatSource.js
source() {
  let source = "";
  const children = this.children;
  for(let i = 0; i < children.length; i++) {
    const child = children[i];
    source += typeof child === "string" ? child : child.source();
  }
  return source;
}

对于 ReplaceSource 实例,会执行其_replaceString方法,循环处理替换在之前【构建资源 -> 生成 chunk 资源 -> chunkTemplate -> 生成主体 chunk 代码 -> 生成每个 module 代码】 push 进去的replacements,得到替换后的字符串,合并返回resultStr

设置 stats 并打印构建信息

所有文件都创建写入完成后,执行回调:

// /lib/Compiler.js
this.hooks.afterEmit.callAsync(compilation, (err) => {
  if (err) return callback(err);
  return callback();
});

在触发Compiler.afterEmit: hooks的回调里执行 callback 即 onCompiled 里的this.emitAssets的回调:

// /lib/Compiler.js:298
this.emitRecords((err) => {
  const stats = new Stats(compilation);
  stats.startTime = startTime;
  stats.endTime = Date.now();
  this.hooks.done.callAsync(stats, (err) => {
    if (err) return finalCallback(err);
    return finalCallback(null, stats);
  });
});

this.emitRecords的回调里设置相关 stats,然后在Compiler.done: hooks 的回调里执行 finalCallback,即 webpack-cli/bin/cli.js 里的compiler.run的回调,即compilerCallback。清除缓存之后,执行:

// /node_modules/webpack-cli/bin/cli.js
const statsString = stats.toString(outputOptions);
const delimiter = outputOptions.buildDelimiter ? `${outputOptions.buildDelimiter}\n` : '';
if (statsString) stdout.write(`${statsString}\n${delimiter}`);

在 cli 里打印输出资源等相关信息。至此本次打包构建全部结束 ✅。

webpack 打包流程系列(未完):
浅析 webpack 打包流程(原理) - 案例 demo
浅析 webpack 打包流程(原理) 一 - 准备工作
浅析 webpack 打包流程(原理) 二 - 递归构建 module
浅析 webpack 打包流程(原理) 三 - 生成 chunk
浅析 webpack 打包流程(原理) 四 - chunk 优化
浅析 webpack 打包流程(原理) 五 - 构建资源
浅析 webpack 打包流程(原理) 六 - 生成文件

参考鸣谢:
webpack打包原理 ? 看完这篇你就懂了 !
webpack 透视——提高工程化(原理篇)
webpack 透视——提高工程化(实践篇)
webpack 4 源码主流程分析
[万字总结] 一文吃透 Webpack 核心原理
关于Webpack详述系列文章 (第三篇)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343