目录搜索
导论前言为什么学习JavaScriptJavaScript的历史基本语法语法概述数值字符串对象数组函数运算符数据类型转换错误处理机制JavaScript 编程风格标准库Object对象包装对象和Boolean对象Number对象String对象Math对象Date对象RegExp对象JSON对象ArrayBuffer:类型化数组面向对象编程概述封装继承模块化编程DOMNode节点document节点Element对象Text节点和DocumentFragment节点Event对象CSS操作Mutation Observer浏览器对象浏览器的JavaScript引擎定时器window对象history对象Ajax同域限制和window.postMessage方法Web Storage:浏览器端数据储存机制IndexedDB:浏览器端数据库Web Notifications APIPerformance API移动设备APIHTML网页元素Canvas APISVG 图像表单文件和二进制数据的操作Web Worker服务器发送事件Page Visibility APIFullscreen API:全屏操作Web SpeechrequestAnimationFrameWebSocketWebRTCWeb ComponentsHTML网页的APIHTML网页元素Canvas APISVG 图像表单文件和二进制数据的操作Web Worker服务器发送事件Page Visibility APIFullscreen API:全屏操作Web SpeechrequestAnimationFrameWebSocketWebRTCWeb Components开发工具console对象PhantomJSBower:客户端库管理工具Grunt:任务自动管理工具Gulp:任务自动管理工具Browserify:浏览器加载Node.js模块RequireJS和AMD规范Source MapJavaScript 程序测试JavaScript高级语法Promise对象有限状态机MVC框架与Backbone.js严格模式ECMAScript 6 介绍附录JavaScript API列表
文字

    • 概述

    • 生成和启用

    • 格式

    • mappings属性

    • VLQ编码

    • 参考链接

概述

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

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

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

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

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

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

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

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

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

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

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

生成和启用

生成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的方法很简单,只要在转换后的代码头部或尾部,加上一行就可以了。

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

或者

/*# sourceMappingURL=/path/to/file.js.map */

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编码

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

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

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

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

Continuation
|     Sign|     |
V     V
101011

下面举例如何对数值16进行VLQ编码。

(1) 将16改写成二进制形式10000。

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

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

(4) 将两段的顺序倒过来,即00000和00001。

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

(6) 将每一段转成Base 64编码。查表可知,100000为g,000001为B。因此,数值16的VLQ编码为gB。

上面的过程,看上去好像很复杂,做起来其实很简单,具体的实现可以参考官方的base64-vlq.js文件,里面有详细的注释。

参考链接


上一篇:下一篇: