JavaScript Source Map 详解

jopen 7年前

上周, jQuery 1.9发布。

JavaScript Source Map 详解

        这是 2.0 版之前的最后一个新版本,有很多新功能,其中一个就是支持 Source Map。

        访问 http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js,打开压缩后的版本,滚动到底部,你可以看到最后一行是这样的:

//@ sourceMappingURL=jquery.min.map

        这就是 Source Map。它是一个独立的 map 文件,与源码在同一个目录下,你可以点击进去,看看它的样子。

        这是一个很有用的功能,本文将详细讲解这个功能。

        一、从源码转换讲起

        JavaScript 脚本正变得越来越复杂。大部分源码(尤其是各种函数库和框架)都要经过转换,才能投入生产环境。

        常见的源码转换,主要是以下三种情况:

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

(2)多个文件合并,以减少 HTTP 请求数。

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

        这三种情况,都使得实际运行的代码不同于开发代码。因此,除错(debug)变得困难重重。

        通常,JavaScript 的解释器会告诉你,第几行第几列代码出错。但是,这对于转换后的代码毫无用处。举例来说,jQuery 1.9 压缩后只有 3 行,每行 3 万个字符,所有内部变量都改了名字。你看着报错信息,感到毫无头绪,根本不知道它所对应的原始位置。

        这就是 Source map 想要解决的问题。

        二、什么是 Source map

        简单说,Source map 就是一个信息文件,里面储存着位置信息。也就是说,转换后的代码的每一个位置,所对应的转换前的位置。

        有了它,出错的时候,除错工具将直接显示原始代码,而不是转换后的代码。这无疑给开发者带来了很大方便。

JavaScript Source Map 详解

        目前,暂时只有 Chrome 浏览器支持这个功能。在 Developer Tools 的 Setting 设置中,确认选中"Enable source maps"。

JavaScript Source Map 详解

        三、如何启用 Source map

        正如前文所提到的,只要在转换后的代码尾部,加上一行就可以了。

//@ sourceMappingURL=/path/to/file.js.map

        map 文件可以放在网络上,也可以放在本地文件系统。

        四、如何生成 Source map

        最常用的方法是使用 Google 的 Closure 编译器

        生成命令的格式如下:

java -jar compiler.jar \

--js script.js \

--create_source_map ./script-min.js.map \

--source_map_format=V3 \

--js_output_file script-min.js

        各个参数的意义如下:

- js: 转换前的代码文件

- create_source_map: 生成的 source map 文件

- source_map_format:source map 的版本,目前一律采用 V3。

- js_output_file: 转换后的代码文件。

        其他的生成文件可以参考这篇文章

        五、Source map 的格式

        打开 Source map 文件,它大概是这个样子:

{

version : 3,

file: "out.js",

sourceRoot : "",

sources: ["foo.js", "bar.js"],

names: ["src", "maps", "are", "fun"],

mappings: "AAgBC,SAAQ,CAAEA"

}

        整个文件就是一个 JavaScript 对象,可以被解释器读取。它主要有以下几个属性:

- version:Source map 的版本,目前为3。

- file:转换后的文件名。

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

- sources:转换前的文件。该项是一个数组,表示可能存在多个文件合并。

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

- mappings:记录位置信息的字符串,下文详细介绍。

        六、mappings 属性

        下面才是真正有趣的部分:两个文件的各个位置是如何一一对应的。

        关键就是 map 文件的 mappings 属性。这是一个很长的字符串,它分成三层。

第一层是行对应,以分号(;)表示,每个分号对应转换后源码的一行。所以,第一个分号前的内容,就对应源码的第一行,以此类推。

第二层是位置对应,以逗号(,)表示,每个逗号对应转换后源码的一个位置。所以,第一个逗号前的内容,就对应该行源码的第一个位置,以此类推。

第三层是位置转换,以 VLQ 编码表示,代表该位置对应的转换前的源码位置。

        举例来说,假定 mappings 属性的内容如下:

mappings:"AAAAA,BBBBB;CCCCC"

        就表示,转换后的源码分成两行,第一行有两个位置,第二行有一个位置。

        七、位置对应的原理

        每个位置使用五位,表示五个字段。

        从左边算起,

- 第一位,表示这个位置在(转换后的代码的)的第几列。

- 第二位,表示这个位置属于 sources 属性中的哪一个文件。

- 第三位,表示这个位置属于转换前代码的第几行。

- 第四位,表示这个位置属于转换前代码的第几列。

- 第五位,表示这个位置属于 names 属性中的哪一个变量。

        有几点需要说明。首先,所有的值都是以 0 作为基数的。其次,第五位不是必需的,如果该位置没有对应 names 属性中的变量,可以省略第五位。再次,每一位都采用 VLQ 编码表示;由于 VLQ 编码是变长的,所以每一位可以由多个字符构成。

        举例来说,如果某个位置的值是 AAAAA,由于A在 VLQ 编码中表示0,因此这个位置的五个位实际上都是0。它的意思是,该位置在转换后代码的第 0 列,对应 sources 属性中第 0 个文件,属于转换前代码的第 0 行第 0 列,对应 names 属性中的第 0 个变量。

        八、VLQ 编码

        最后,谈谈如何用 VLQ 编码表示数值。

        这种编码最早用于 MIDI 文件,后来被多种格式采用。它的特点就是可以非常精简地表示很大的数值。

        VLQ 编码是变长的。如果(整)数值在-15 到 +15 之间(含两个端点),用一个字符表示;超出这个范围,就需要用多个字符表示。它规定,每个字符使用 6 个两进制位,正好可以借用 Base 64编码的字符表。

JavaScript Source Map 详解

        在这 6 个位中,左边的第一位(最高位)表示是否"连续"(continuation)。如果是1,代表这 6 个位后面的 6 个位也属于同一个数;如果是0,表示该数值到这 6 个位结束。

Continuation

Sign

VV

101011

        这 6 个位中的右边最后一位(最低位)的含义,取决于这 6 个位是否是某个数值的 VLQ 编码的第一个字符。如果是的,这个位代表"符号"(sign),0 为正,1 为负(Source map 的符号固定为0);如果不是,这个位没有特殊含义,被算作数值的一部分。

        九、VLQ 编码:实例

        下面看一个例子,如何对数值 16 进行 VLQ 编码。

第一步,将 16 改写成二进制形式 10000。

第二步,在最右边补充符号位。因为 16 大于0,所以符号位为0,整个数变成 100000。

第三步,从右边的最低位开始,将整个数每隔 5 位,进行分段,即变成 1 和 00000 两段。如果最高位所在的段不足 5 位,则前面补0,因此两段变成 00001 和 00000。

第四步,将两段的顺序倒过来,即 00000 和 00001。

第五步,在每一段的最前面添加一个"连续位",除了最后一段为0,其他都为1,即变成 100000 和 000001。

第六步,将每一段转成 Base 64 编码。

        查表可知,100000 为g,000001 为B。因此,数值 16 的 VLQ 编码为 gB。上面的过程,看上去好像很复杂,做起来其实很简单,具体的实现请看官方的 base64-vlq.js 文件,里面有详细的注释。

        十、参考链接

        - Introduction To JavaScript Source Maps

        - Source Map Revision 3 Proposal