docs: SourceMap

This commit is contained in:
杭城小刘
2020-06-26 23:30:57 +08:00
parent f546284346
commit b5b74ef822
4 changed files with 211 additions and 2 deletions

View File

@@ -0,0 +1,207 @@
# sourceMap 闪亮登场
[jQuery 1.9](http://blog.jquery.com/2013/01/15/jquery-1-9-final-jquery-2-0-beta-migrate-final-released/)发布。
![jQuery](./../assets/2020-06-23-Jquery.png)
这是2.0版之前的最后一个新版本有很多新功能其中一个就是支持Source Map。
访问 http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js打开压缩后的版本滚动到底部你可以看到最后一行是这样的
```js
//@ sourceMappingURL=jquery.min.map
```
这就是 Source Map。它是一个独立的 map 文件,与源码在同一个目录下,你可以[点击进去](http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.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 就是一个信息文件,里面储存着位置信息。也就是说,转换后的代码的每一个位置,所对应的转换前的位置。
有了它,出错的时候,除错工具将直接显示原始代码,而不是转换后的代码。这无疑给开发者带来了很大方便。
![jQuery Mapping](./../assets/2020-06-23-JquerySourceMap.png)
Chrome 浏览器支持这个功能。在 Developer Tools 的 Setting 设置中,确认选中 "Enable source maps"。
![设置页](./../assets/2020-06-21-ChromeSourceMapEnableSwitch.png)
![i开启 sourceMap](./../assets/2020-06-21-ChromeSourceMapENable.png)
## 三、如何启用 Source map
正如前文所提到的,只要在转换后的代码尾部,加上一行就可以了。
```js
//@ sourceMappingURL=/path/to/file.js.map
```
map 文件可以放在网络上,也可以放在本地文件系统。
## 四、如何生成 Source map
最常用的方法是使用 Google 的 [Closure编译器](https://developers.google.com/closure/compiler/)。
生成命令的格式如下:
```shell
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_formatsource map的版本目前一律采用V3。
  - js_output_file 转换后的代码文件。
其他的生成方法可以参考[这篇文章](http://net.tutsplus.com/tutorials/tools-and-tips/source-maps-101/)。
## 五、Source map 的格式
打开 Source map 文件,它大概是这个样子:
```json
{
    version : 3,
    file: "out.js",
    sourceRoot : "",
    sources: ["foo.js", "bar.js"],
    names: ["src", "maps", "are", "fun"],
    mappings: "AAgBC,SAAQ,CAAEA"
  }
```
整个文件就是一个 JavaScript 对象,可以被解释器读取。它主要有以下几个属性:
- versionSource map的版本目前为3。
- file转换后的文件名。
- sourceRoot转换前的文件所在的目录。如果与转换前的文件在同一目录该项为空。
- sources转换前的文件。该项是一个数组表示可能存在多个文件合并。
- names转换前的所有变量名和属性名。
- mappings记录位置信息的字符串下文详细介绍。
## 六、mappings 属性
下面才是真正有趣的部分:两个文件的各个位置是如何一一对应的。
关键就是 map 文件的 mappings 属性。这是一个很长的字符串,它分成三层。
第一层是**行对应**,以分号(;)表示,每个分号对应转换后源码的一行。所以,第一个分号前的内容,就对应源码的第一行,以此类推。
第二层是**位置对应**,以逗号(,)表示,每个逗号对应转换后源码的一个位置。所以,第一个逗号前的内容,就对应该行源码的第一个位置,以此类推。
第三层是**位置转换**,以 [VLQ编码](http://en.wikipedia.org/wiki/Variable-length_quantity) 表示,代表该位置对应的转换前的源码位置。
举例来说假定mappings属性的内容如下
```json
mappings:"AAAAA,BBBBB;CCCCC"
```
就表示,转换后的源码分成两行,第一行有两个位置,第二行有一个位置。
## 七、位置对应的原理
每个位置使用五位,表示五个字段。
从左边算起,
- 第一位,表示这个位置在(转换后的代码的)的第几列。
- 第二位表示这个位置属于sources属性中的哪一个文件。
- 第三位,表示这个位置属于转换前代码的第几行。
- 第四位,表示这个位置属于转换前代码的第几列。
- 第五位表示这个位置属于names属性中的哪一个变量。
有几点需要说明。首先所有的值都是以0作为基数的。其次第五位不是必需的如果该位置没有对应 name 属性中的变量,可以省略第五位。再次,每一位都采用 VLQ 编码表示;由于 VLQ 编码是变长的,所以每一位可以由多个字符构成。
如果某个位置是 AAAAA由于 A 在 VLQ 编码中表示0因此这个位置的五个位实际上都是0。它的意思是该位置在转换后代码的第0列对应sources属性中第0个文件属于转换前代码的第0行第0列对应 names 属性中的第0个变量。
## 八、VLQ 编码
最后,谈谈如何用 [VLQ编码](http://en.wikipedia.org/wiki/Variable-length_quantity) 表示数值。
这种编码最早用于 MIDI 文件,后来被多种格式采用。它的特点就是可以非常精简地表示很大的数值。
VLQ 编码是变长的。如果(整)数值在-15到+15之间含两个端点用一个字符表示超出这个范围就需要用多个字符表示。它规定每个字符使用6个两进制位正好可以借用 [Base 64](http://en.wikipedia.org/wiki/Base_64) 编码的字符表。
![VLA](./../assets/2020-06-23-VLAMapping.png)
在这6个位中左边的第一位最高位表示是否"连续"continuation。如果是1代表这个位后面的6个位也属于同一个数如果是0表示该数值到这6个位结束。
![VLQ特殊位](./../assets/2020-06-03-VLQSymbol.png)
这6个位中的右边最后一位最低位的含义取决于这6个位是否是某个数值的VLQ编码的第一个字符。如果是的这个位代表"符号"sign0为正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 为 g000001 为 B。因此数值 16 的 VLQ 编码为 `gB`。具体可以看代码https://github.com/mozilla/source-map
## 参考资料
- [Source Map Revision 3 Proposal](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit#heading=h.ue4jskhddao6)
- [Introduction to JavaScript Source Maps](https://www.html5rocks.com/en/tutorials/developertools/sourcemaps/)
- [JavaScript Source Map 详解](http://www.ruanyifeng.com/blog/2013/01/javascript_source_map.html)

View File

@@ -42,3 +42,4 @@
* [38、npm 改进之工程化](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter2%20-%20Web%20FrontEnd/2.38.md)
* [39、前端模块化演进之路](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter2%20-%20Web%20FrontEnd/2.39.md)
* [40、ElectronPC 端多端融合方案](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter2%20-%20Web%20FrontEnd/2.40.md)
* [41、sourceMap 闪亮登场](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter2%20-%20Web%20FrontEnd/2.41.md)

View File

@@ -64,7 +64,7 @@ alias rc='create-react-app' #(create-react-app todolist)用法 rc todolist
# React Native 命令
alias rnc='react-native init' #(react-native init todolist)用法 rnc todolist
alias RNRelease='react-native bundle --entry-file index.js --platform ios --dev false --bundle-output release_ios/main.jsbundle --assets-dest release_iOS --sourcemap-output release_ios/index.ios.map;' # RN 打 Release 包
# 终端打开应用程序
## 浏览器打开

View File

@@ -129,7 +129,8 @@
* [38、npm 改进之工程化](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter2%20-%20Web%20FrontEnd/2.38.md)
* [39、前端模块化演进之路](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter2%20-%20Web%20FrontEnd/2.39.md)
* [40、ElectronPC 端多端融合方案](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter2%20-%20Web%20FrontEnd/2.40.md)
* [41、sourceMap 闪亮登场](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter2%20-%20Web%20FrontEnd/2.41.md)
* [Chapter3 - Server](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter3%20-%20Server/chapter3.md)
* [1、利用分页和模糊查询技术实现一个App接口](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter3%20-%20Server/3.1.md)
* [2、网页端扫码登录实现原理](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter3%20-%20Server/3.2.md)