五、webpack之souce-map

1. 认识source-map

我们的代码通常运行在浏览器上时,是通过打包压缩的,但是,当代码报错需要调试时(debug),调试转换后的代码是很困难的,我们不能保证代码不出错,source-map出现了!source-map是从已转换的代码,映射到原始的源文件,使浏览器可以重构原始源并在调试器中显示重建的原始源。

1.1 如何使用source-map

第一步:根据源文件,生成source-map文件,webpack在打包时,可以通过配置生成source-map。
webpack.config.js

module.exports = {
  mode: "development",
  devtool: "source-map",
}

第二步:在转换后的代码,最后添加一个注释,它指向sourcemap。
bundle.js

//# sourceMappingURL=bundle.js.map

1.2 分析source-map文件

目前的source-map长什么样子呢?

  • version:当前使用的版本,也就是最新的第三版;
  • sources:从哪些文件转换过来的source-map和打包的代码(最初始的文件);
  • names:转换前的变量和属性名称(因为我目前使用的是development模式,所以不需要保留转换前的名
    称);
  • mappings:source-map用来和源文件映射的信息(比如位置信息等),一串base64 VLQ(veriablelength quantity可变长度值)编码;
  • file:打包后的文件(浏览器加载的文件);
  • sourceContent:转换前的具体代码信息(和sources是对应的关系);
  • sourceRoot:所有的sources相对的根目录;

2 生成source-map

如何在使用webpack打包的时候,生成对应的source-map呢?webpack为我们提供了非常多的选项(目前是26个),来处理source-map。官网查询地址https://webpack.docschina.org/configuration/devtool/
选择不同的值,生成的source-map会稍微有差异,打包的过程也会有性能的差异,可以根据不同的情况进行选择。
下面几个值不会生成source-map:

  • false:不使用source-map,也就是没有任何和source-map相关的内容
  • (none):production模式下的默认值(什么都不写),不生成source-map
  • eval:development模式下的默认值,不生成source-map,但是它会在eval执行的代码中,添加 //# sourceURL=,它会被浏览器在执行时解析,并且在调试面板中生成对应的一些文件目录,方便我们调试代码。
    webpack.config.js
module.exports = {
  mode: 'development',  // development模式devtool的默认值是eval
  devtool: "eval", 
}

bundle.js

eval("const sum = (a, b) => a + b\r\nconst mul = (a, b) => a * b\r\n\r\nmodule.exports = {\r\n  sum,\r\n  mul\r\n}\n\n//# sourceURL=webpack://webpack5/./src/js/content.js?");

我们会发现eval函数最后面有/# sourceURL=webpack://webpack5/./src/js/content.js?,浏览器能通过它生成对应的一些文件目录,方便我们调试代码。

2.1 source-map值

生成一个独立的source-map文件,并且在bundle文件中有一个注释,指向source-map文件。
bundle.js文件中有如下的注释:

//# sourceMappingURL=bundle.js.map

开发工具会根据这个注释找到source-map文件,并且解析。

2.2 eval-source-map值

eval-source-map会生成sourcemap,但是source-map是以DataUrl添加到eval函数的后面。

2.3 inline-source-map值`

inline-source-map会生成sourcemap,但是source-map是以DataUrl添加到bundle文件的后面。

2.4 cheap-source-map

cheap-source-map会生成sourcemap,但是会更加高效一些(cheap低开销),因为它没有生成列映射(Column Mapping),在开发中,我们只需要行信息通常就可以定位到错误了。

image.png

image.png

2.5 cheap-module-source-map值

cheap-module-source-map会生成sourcemap,类似于cheap-source-map,但是对源自loader的sourcemap处理会更好。
这里有一个很模糊的概念:对源自loader的sourcemap处理会更好,官方也没有给出很好的解释,其实是如果loader对我们的源码进行了特殊的处理,比如babel。当代码被loader处理后,使用cheap-module-source-map处理效果更好。

2.6 hidden-source-map值

hidden-source-map会生成sourcemap,但是不会对source-map文件进行引用,相当于删除了打包文件中对sourcemap的引用注释

// 被删除掉的
//# sourceMappingURL=bundle.js.map

如果我们手动添加进来,那么sourcemap就会生效了。

2.7 nosources-source-map值

nosources-source-map会生成sourcemap,但是生成的sourcemap只有错误信息的提示,不会生成源代码文件。点击错误提示,无法查看源码。

多个值的组合

事实上,webpack提供给我们的26个值,是可以进行多组合的。
组合的规则如下:

  • inline-|hidden-|eval:三个值时三选一
  • nosources:可选值
  • cheap可选值,并且可以跟随module的值
[inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map

那么在开发中,最佳的实践是什么呢?

  • 开发阶段:推荐使用 source-map或者cheap-module-source-map,这分别是vue和react使用的值,可以获取调试信息,方便快速开发
  • 测试阶段:推荐使用 source-map或者cheap-module-source-map,测试阶段我们也希望在浏览器下看到正确的错误提示
  • 发布阶段:false、缺省值(不写)
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容

  • 一、webpack 配置 1. 资源入口 Webpack 通过 context 和 entry 这两个配置项来共同...
    了凡和纤风阅读 957评论 0 7
  • ESM存在环境兼容问题模块文件过多网络请求频繁所有的前端资源都需要模块化 综上所述,模块化是必要的 新特性代码编译...
    amanohina阅读 2,808评论 0 1
  • 配置 Webpack 的方式有两种: 通过一个 JavaScript 文件描述配置,例如使用 webpack.co...
    oWSQo阅读 6,376评论 0 1
  • Webpack 1.准备工作 安装:npm install --save-dev webpack 创建pa...
    钱罗罗阅读 168评论 0 1
  • 今天感恩节哎,感谢一直在我身边的亲朋好友。感恩相遇!感恩不离不弃。 中午开了第一次的党会,身份的转变要...
    迷月闪星情阅读 10,559评论 0 11