查看: 186|回复: 0

[JavaScript/JQuery] Source Map入门教程

发表于 6 天前

部署前端之前,开发者通常会对代码进行打包压缩,这样可以减少代码大小,从而有效提高访问速度。然而,压缩代码的报错信息是很难Debug的,因为它的行号和列号已经失真。这时就需要Source Map来还原真实的出错位置了。

为啥变换代码?

前端代码越来越复杂的情况下,开发者通常会使用webpack、UglifyJS2等工具对代码进行打包变换,这样可以减少代码大小,有效提高访问速度。关于变换代码的原因,这里不妨引用一下大神阮一峰的JavaScript Source Map 详解:

压缩,减小体积。比如jQuery 1.9的源码,压缩前是252KB,压缩后是32KB。

多个文件合并,减少HTTP请求数。

其他语言编译成JavaScript。最常见的例子就是CoffeeScript。

如何变换代码?

下面是一个简单的“hello World”程序hello.js

  1. function sayHello()
  2. {
  3. var name = "Fundebug";
  4. var greeting = "Hello, " + Name;
  5. console.log(greeting);
  6. }
  7. sayHello();
复制代码

使用UglifyJS2对源代码进行压缩变换:

  1. uglifyjs hello.js \
  2. -m toplevel=true \
  3. -c unused=true,collapse_vars=true \
  4. -o hello.min.js
复制代码

压缩后的代码hello.min.js

  1. function o(){var o="Hello, "+Name;console.log(o)}o();
复制代码
为啥需要Source Map?

使用Firefox执行hello.js的报错信息是这样:

  1. ReferenceError: Name is not defined
  2. sayHello file:///Users/fundebug/sourcemap-tutorial/hello.js:4:9
  3. <匿名> file:///Users/fundebug/sourcemap-tutorial/hello.js:8:1
复制代码

hello.min.js的报错信息是这样:

  1. ReferenceError: Name is not defined
  2. o file:///Users/fundebug/sourcemap-tutorial/hello.min.js:1:18
  3. <匿名> file:///Users/fundebug/sourcemap-tutorial/hello.min.js:1:59
复制代码

对比压缩前后的出错信息,我们会发现,错误行号和列号已经失真,且函数名也经过了变换。而对于真实的前端项目,开发者会将数十个源文件压缩为一个文件,这时,错误的列号可能多达数千,且出错的真实文件名也是很难确定的,这样的话,压缩代码的报错信息是很难Debug的。

而Source Map则可以用于还原真实的出错位置,帮助开发者更快的Debug。

什么是Source Map?

使用UglifyJS2时指定source-map选项即可生成Source Map:

  1. uglifyjs hello.js \
  2. -m toplevel=true \
  3. -c unused=true,collapse_vars=true \
  4. --source-map hello.min.js.map \
  5. --source-map-include-sources \
  6. --source-map-root \
  7. -o hello.min.js
复制代码

各种主流前端任务管理工具,打包工具都支持生成Source Map,具体可以查看生成Source Map - Fundebug文档。

生成的hello.min.js多了sourceMappingURL,表示Source Map文件的位置。

  1. function o(){var o="Hello, "+Name;console.log(o)}o();
  2. //# sourceMappingURL=hello.min.js.map
复制代码

生成的Source Map为hello.min.js.map:

  1. {
  2. "version": 3,
  3. "sources": ["hello.js"],
  4. "names": ["sayHello", "greeting", "Name", "console", "log"],
  5. "mappings": "AAAA,QAASA,KAEL,GACIC,GAAW,UAAYC,IAC3BC,SAAQC,IAAIH,GAGhBD",
  6. "file": "hello.min.js",
  7. "sourceRoot": "",
  8. "sourcesContent": ["function sayHello()\n{\n var name = \"Fundebug\";\n var greeting = \"Hello, \" + Name;\n console.log(greeting);\n}\n\nsayHello();\n"]
  9. }
复制代码

hello.min.js.map可知,Source Map是一个JSON文件,而它包含了代码转换前后的位置信息。也就是说,给定一个转换之后的压缩代码的位置,就可以通过Source Map获取转换之前的代码位置,反过来也一样。Source Map各个属性的含义如下:

version:Source Map的版本号。

sources:转换前的文件列表。

names:转换前的所有变量名和属性名。

mappings:记录位置信息的字符串,经过编码。

file:(可选)转换后的文件名。

sourceRoot:(可选)转换前的文件所在的目录。如果与转换前的文件在同一目录,该项为空。

sourcesContent:(可选)转换前的文件内容列表,与sources列表依次对应。

Source Map真正神奇之处在于mappings属性,它记录了位置是如何对应的。JavaScript Source Map 详解已经有很好的解释,这里不再赘述。

怎样使用Source Map?

主流浏览器均支持Source Map功能,不过Chrome与Firefox需要一些简单的配置,具体步骤请参考How to enable source maps。下面以MacBook上的Chrome浏览器为例,介绍一下配置方法:

1. 开启开发者工具

使用快捷键option + command + i;或者在菜单栏选择视图->开发者->开发者工具

2. 打开设置

使用快捷键fn + F1;或者点击右上角的三个点的图标,选择Settings

3. 开启Source Map

在Sources中,选中Enable JavaScript source maps

为了测试,我写了一个简单的HTML文件hello.min.html

  1. <head>
  2. <script type="text/javascript" src="hello.min.js"></script>
  3. </head>
复制代码

使用Chrome打开hello.min.html,在控制台看到的错误如下:

  1. Uncaught ReferenceError: Name is not defined
  2. at o (hello.min.js:1)
  3. at hello.min.js:1
复制代码

报错的文件仍然为hello.min.js,需要刷新一下Source Map才有作用:

  1. Uncaught ReferenceError: Name is not defined
  2. at o (hello.js:4)
  3. at hello.js:8
复制代码

注意,Chrome的报错信息没有列号,因此4为错误的行号。Chrome不仅可以通过Source Map还原真实的出错位置,还可以根据Source Map的sourcesContent还原出错的源代码。点击出错位置,即可跳转到源码,这样Debug将非常方便。

参考链接

JavaScript Source Map 详解

Source Map Revision 3 Proposal

How to enable source maps



回复

使用道具 举报