上周，jQuery 1.9发布。
这是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就是一个信息文件，里面储存着位置信息。也就是说，转换后的代码的每一个位置，所对应的转换前的位置。
有了它，出错的时候，除错工具将直接显示原始代码，而不是转换后的代码。这无疑给开发者带来了很大方便。
目前，暂时只有Chrome浏览器支持这个功能。在Developer Tools的Setting设置中，确认选中"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
各个参数的意义如下：
- 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编码的字符表。
在这6个位中，左边的第一位（最高位）表示是否"连续"（continuation）。如果是1，代表这６个位后面的6个位也属于同一个数；如果是0，表示该数值到这6个位结束。
Continuation
| Sign
| |
V V
１０１０１１
这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
（完）
ijse 说：
我是沙发~:)
这个东西挺实用的，尤其可以帮助调试coffee script 。。
2013年1月23日 15:06 | # | 引用
ijse 说：
Nodejs 下也有个工具 source-map
https://github.com/mozilla/source-map
2013年1月23日 15:09 | # | 引用
戴面罩的怪杰 说：
jQuery 1.9压缩后只有3行，每行3万个字符，所有内部变量都改了名字。你看着报错信息，感到毫无头绪，根本不知道它所对应的原始位置。
这种情况下，使用Firebug工具可以清楚的定位到错误所在位置。
2013年1月23日 18:31 | # | 引用
回复 说：
@戴面罩的怪杰 问题是内部变量都改名字了，面对一大堆毫无意义的名字，看着头痛。
2013年1月25日 10:08 | # | 引用
junxy 说：
不错, 有点像像 .net 下的 dll 对应的 pdb 文件
2013年1月25日 14:05 | # | 引用
D瓜哥 说：
确实很好玩！不过，在Chrome中没有找到Enable source maps设置的地方！！我的Chrome是v24版。
2013年1月30日 10:15 | # | 引用
D瓜哥 说：
找到了，没想到Chrome开发人员工具的设置在右下侧的“小齿轮”！第一次使用！哈哈
2013年1月30日 10:18 | # | 引用
Yu 说：
大赞
话说，以前看很多商用js都用.min.js作为发行版本，那一团乱麻，还以为是防止别人偷窥来着
2013年1月30日 17:37 | # | 引用
Jack 说：
这么做搞下去，建议js新增一种字节码吧
2013年2月 6日 20:28 | # | 引用
程序员老A 说：
好东西，js压缩后的调试一直都是问题，有了它就不是问题了！
2013年2月16日 21:24 | # | 引用
crocodile 说：
chrome 24中为何调试跟踪没有成功过。。
2013年2月17日 21:19 | # | 引用
程序猿小卡 说：
//@ sourceMappingURL=/path/to/file.js.map
这行注释会自动添加？
2013年4月10日 00:55 | # | 引用
斯人 说：
我就纳闷 map 文件放在哪, 如果按相对路径扔线上可能有安全问题
2013年4月23日 01:57 | # | 引用
lyndo 说：
加了这个map，还要加载原来未压缩的文件吗？会不会导致冲突？
2013年7月22日 17:00 | # | 引用
张衡Henry 说：
今天次看到这个文件，学习了，转载收藏
2013年8月14日 23:33 | # | 引用
Laughing 说：
刚碰到这个问题就有大神的说明，非常有用！
2013年9月24日 14:00 | # | 引用
牛b的犀牛 说：
刚刚才在jquery官网上看到这个map文件，不知道个什么东西，官方介绍也一团雾水。长知识了！
2013年11月16日 10:21 | # | 引用
易安 说：
取决于这6个位是否是某个数值的VLQ编码的第一个字符。
这句话不懂啊
2014年3月30日 11:56 | # | 引用
微风好飞行 说：
CSS 貌似也有 source map，在 chrome 里有设置，也可以介绍介绍，：）
2014年3月31日 13:51 | # | 引用
morgan 说：
source map里的mappings是不是会特别大——将所有的代码都进行一次映射。
2014年4月30日 10:15 | # | 引用
MegaSu 说：
Css的Source map很好用，用来调试Less。
http://oklai.name/compass-sourcemap/#more-406
2014年7月25日 15:58 | # | 引用
袁源 说：
我的 chrome 好像坏掉了，虽然开着这个功能但是依然显示压缩后的代码。
2014年8月21日 12:37 | # | 引用
半城烟沙 说：
太好了， 很有用啊，谢谢大神分享！！
2014年10月15日 17:44 | # | 引用
李狗蛋 说：
阮师父的博客字体里，字母o和数字0太像了
(╯'□')╯(┴—┴
2015年2月15日 08:17 | # | 引用
怠惰之熊 说：
这个map文件就相当于一个解压缩的词典，支持souce-map功能的浏览器会根据这个map文件按照约定好的算法“解压”之前“压缩”的.min.js文件
2015年6月 8日 15:28 | # | 引用
袁源 说：
虽然只是很浅显的科普，但我就是喜欢专门写浅显文章的博客
2015年11月25日 12:34 | # | 引用
丁晓庆 说：
很详细，对这个出错问题终于有了大致的了解
2015年11月27日 23:18 | # | 引用
赵永 说：
您好，不太理解每个位置使用5位是什么意思？我看有的位置使用六位，甚至更多. eg:EAAUgc
2016年1月 7日 11:06 | # | 引用
赵克立 说：
这个文件原来是这么个作用。谢过啦。
2016年1月25日 15:29 | # | 引用
Viky 说：
map文件的最主要作用还是debug用吧？
2016年3月22日 16:49 | # | 引用
刘xin 说：
chrome中勾选了enable javascript source maps，
在压缩后的jquery开头中也增加了//# sourceMappingURL=jquery-1.12.4.min.map
（map和js同目录）
可是页面请求还是没有请求map文件，请问我漏了哪里？
2016年6月 7日 16:09 | # | 引用
布丁布丁吃布丁 说：
長知識了，非常感謝。
2016年6月11日 20:09 | # | 引用
hodor-cn 说：
mappings不是最少5位吧，为什么jquery的mappings第一位是4位
2016年6月20日 03:46 | # | 引用
hodor-cn 说：
看漏了，第5位可以省略
2016年6月20日 03:48 | # | 引用
xgqfrms 说：
内容可能需要更新！
jquery-3.0.0.min .map 格式分析:
{
"version":3,
"sources":["jquery.js"],
"names":["global","factory","module",...,"_jQuery","_$","$","noConflict"],
"mappings":";
CAaE,SAAUA,EAAQC,GAEnB,...,OAAS9B,EAAO6pC,EAAI/nC,GAIrBA",
"file":"jquery.min.js"
}
2016年7月11日 22:23 | # | 引用
xgqfrms 说：
{ "version":3, JavaScript Source Maps版本 "sources":["jquery.js"], 源文件 "names":["global","factory","module",...,"_jQuery","_$","$","noConflict"], 变量名列表 "mappings":"; 映射 CAaE,SAAUA,EAAQC,GAEnB,...,OAAS9B,EAAO6pC,EAAI/nC,GAIrBA", 映射后的Base64值列表 "file":"jquery.min.js" 目标文件 }2016年7月11日 22:29 | # | 引用
web4 说：
谢谢，我这边配合使用了 gulp-sourcemaps，无论是console.log 还是出错信息，会直接显示出来，棒棒的
2016年7月15日 14:24 | # | 引用
高尔础础 说：
谢谢，我这边配合使用了 gulp-sourcemaps，无论是console.log 还是出错信息，会直接显示出来，棒棒的
2016年7月15日 14:25 | # | 引用
張旭 说：
太實用了！
2016年11月 8日 14:18 | # | 引用
tolerious 说：
学到了、
2016年11月29日 09:58 | # | 引用
李力 说：
七、位置对应的原理
这一部分好像讲的跟规范不一样。
英语不太好，规范里是一个相对值，而不是绝对值？
希望老师能帮忙解答一下，最近刚好在看这个。
2017年2月 7日 11:31 | # | 引用
ahdung 说：
请教：
- 是否只需发布x.min.js和x.min.map，不需发布x.js？
- 是不是可以说如果js写的没毛病，即不会出错，map就不需要？
2017年5月 8日 13:40 | # | 引用
Cathy 说：
看完之后有两点疑惑：1）-15~+15之间的数用一个字符表示，超出范围的用多个字符表示。然后老师举例时用举了超出范围的16，所以不明白-15~+15之间的是如何转为一个字符的。2）第四步，将两段的顺序倒过来，即00000和00001。为什么要倒过来？
后来在网上看到这篇文章，才算完全明白了。推荐大家也看下：
http://blog.allenm.me/2012/12/base64-vlq-encoding/
2017年9月20日 15:01 | # | 引用
骏 说：
我编译出来的有一个是KAAOH，H用vlq解码等于-3，怎么对于names中的值，还有就是转码后的列和转码钱的列都对不上，找不到对于的names中的值，这个是不是大概的位置，不是百分百对的上位置？
2017年10月18日 20:05 | # | 引用
Joki 说：
”这6个位中的右边最后一位（最低位）的含义，取决于这6个位是否是某个数值的VLQ编码的第一个字符。如果是的，这个位代表"符号"（sign），0为正，1为负（Source map的符号固定为0）；如果不是，这个位没有特殊含义，被算作数值的一部分。“
这句话啥意思，看例子也没看明白。。
2017年11月 6日 22:10 | # | 引用
ViYaYaYa 说：
在讲值转VLQ这部分写的比HTML5 Rocks好很多！谢了
2018年3月23日 16:02 | # | 引用
hongboss 说：
如何解析souremap ？
2018年5月 3日 10:34 | # | 引用
黄大仙 说：
我加了gulp-sourcemap，浏览器也开了，还是显示压缩后的代码
2018年10月23日 11:26 | # | 引用
Messi Li 说：
"首先，所有的值都是以0作为基数的"
文章字体中的“0”看起来像"o"，能不能调整下字体呢？
2018年12月 4日 10:21 | # | 引用
朱天琦 说：
最近在模仿ugifyjs写一个scala版本的，sourcemap对于debug是真的必要
2019年3月 6日 17:12 | # | 引用
qhxing825 说：
五、Source map的格式
- sourceRoot：转换前的文件所在的目录。如果与转换前的文件在同一目录，该项为空。
这段表述是否存在歧义
如果(转换前（后）的文件)与转换前（后？）的文件在同一个目录
2020年9月29日 16:23 | # | 引用
CPPAlien 说：
位置对应的原理那边的例子容易让人误解
mappings:"AAAAA,BBBBB;CCCCC" 并不是按这个字母每一位的作用，而是需要先把内容变成二进制再根据 VLQ 规则解码出来后的第一位第二位才是作者所写的每一位作用。实际的 mappings 中每一小段可能存在超过 5 个字符。
2023年1月29日 11:48 | # | 引用
peakj 说：
这块确实表述有问题，第一位不是编译后的列位置，是和前一个位置的相对列数量，这块疑惑了很久，后来发现是相对的
2023年5月 9日 17:00 | # | 引用
big dick 说：
看到2013年的前辈的留言 有一种时空上的错觉
2024年3月10日 07:50 | # | 引用