JavaScript Source Map 详解

页面导航:首页 > 网络编程 > JavaScript > JavaScript Source Map 详解

JavaScript Source Map 详解

来源: 作者: 时间:2016-02-20 09:49 【

Source Map。它是一个独立的map文件,与源码在同一个目录下,你可以点击进去,看看它的样子。这是一个很有用的功能,本文将详细讲解这个功能。一、从源码转换讲起JavaScript脚本正变得

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

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

一、从源码转换讲起

JavaScript脚本正变得越来越复杂。大部分源码(尤其是各种函数库和框架)都要经过转换,才能投入生产环境。可以500%提高开发效率的前端UI框架!

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

(1)压缩,减小体积。比如jQuery 1.9的源码,压缩前是252KB,压缩后是32KB。
  
(2)多个文件合并,减少HTTP请求数。
  
(3)其他语言编译成JavaScript。最常见的例子就是CoffeeScript。

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

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

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

二、什么是Source map

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

有了它,出错的时候,除错工具将直接显示原始代码,而不是转换后的代码。这无疑给开发者带来了很大方便。可以500%提高开发效率的前端UI框架!

\

目前,暂时只有Chrome浏览器支持这个功能。在DevelZ喎"http://www.2cto.com/kf/ware/vc/" target="_blank" class="keylink">vcGVyIFRvb2xztcRTZXR0aW5nyejWw9bQo6zIt8jP0aHW0A=="Enable source maps"。

\

三、如何启用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

各个参数的意义如下: 可以500%提高开发效率的前端UI框架!

- 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"
 }

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

- version:Source map的版本,目前为3。
  
- file:转换后的文件名。
  
- sourceRoot:转换前的文件所在的目录。如果与转换前的文件在同一目录,该项为空。
  
- sources:转换前的文件。该项是一个数组,表示可能存在多个文件合并。
  
- names:转换前的所有变量名和属性名。
  
- mappings:记录位置信息的字符串,下文详细介绍。

六、mappings属性

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

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

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

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

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

举例来说,假定mappings属性的内容如下: 可以500%提高开发效率的前端UI框架!

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编码的字符表。可以500%提高开发效率的前端UI框架!

\

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

  Continuation
  |     Sign
  |     |
  V     V
  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。

可以500%提高开发效率的前端UI框架!

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

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

Tags:

文章评论

最 近 更 新
热 点 排 行
Js与CSS工具
代码转换工具

<