?
本文檔使用 php中文網(wǎng)手冊 發(fā)布
概述
生成和啟用
格式
mappings屬性
VLQ編碼
參考鏈接
概述
隨著JavaScript腳本變得越來越復(fù)雜，大部分源碼（尤其是各種函數(shù)庫和框架）都要經(jīng)過轉(zhuǎn)換，才能投入生產(chǎn)環(huán)境。
常見的源碼轉(zhuǎn)換，主要是以下三種情況：
壓縮，減小體積。比如jQuery 1.9的源碼，壓縮前是252KB，壓縮后是32KB。
多個(gè)文件合并，減少HTTP請求數(shù)。
其他語言編譯成JavaScript。最常見的例子就是CoffeeScript。
這三種情況，都使得實(shí)際運(yùn)行的代碼不同于開發(fā)代碼，除錯（debug）變得困難重重。
通常，JavaScript的解釋器會告訴你，第幾行第幾列代碼出錯。但是，這對于轉(zhuǎn)換后的代碼毫無用處。舉例來說，jQuery 1.9壓縮后只有3行，每行3萬個(gè)字符，所有內(nèi)部變量都改了名字。你看著報(bào)錯信息，感到毫無頭緒，根本不知道它所對應(yīng)的原始位置。
這就是Source map想要解決的問題。
簡單說，Source map就是一個(gè)信息文件，里面儲存著位置信息。也就是說，轉(zhuǎn)換后的代碼的每一個(gè)位置，所對應(yīng)的轉(zhuǎn)換前的位置。
有了它，出錯的時(shí)候，除錯工具將直接顯示原始代碼，而不是轉(zhuǎn)換后的代碼。這無疑給開發(fā)者帶來了很大方便。
目前，暫時(shí)只有Chrome瀏覽器支持這個(gè)功能。在Developer Tools的Setting設(shè)置中，確認(rèn)選中"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
各個(gè)參數(shù)的意義如下：
js： 轉(zhuǎn)換前的代碼文件
create_source_map： 生成的source map文件
source_map_format：source map的版本，目前一律采用V3。
js_output_file： 轉(zhuǎn)換后的代碼文件。
其他的生成方法可以參考這篇文章。
啟用Source map的方法很簡單，只要在轉(zhuǎn)換后的代碼頭部或尾部，加上一行就可以了。
//# sourceMappingURL=/path/to/file.js.map
或者
/*# sourceMappingURL=/path/to/file.js.map */
map文件可以放在網(wǎng)絡(luò)上，也可以放在本地文件系統(tǒng)。
格式
打開Source map文件，它大概是這個(gè)樣子：
{
version : 3,
file: "out.js",
sourceRoot : "",
sources: ["foo.js", "bar.js"],
names: ["src", "maps", "are", "fun"],
mappings: "AAgBC,SAAQ,CAAEA"
}
整個(gè)文件就是一個(gè)JavaScript對象，可以被解釋器讀取。它主要有以下幾個(gè)屬性：
version：Source map的版本，目前為3。
file：轉(zhuǎn)換后的文件名。
sourceRoot：轉(zhuǎn)換前的文件所在的目錄。如果與轉(zhuǎn)換前的文件在同一目錄，該項(xiàng)為空。
sources：轉(zhuǎn)換前的文件。該項(xiàng)是一個(gè)數(shù)組，表示可能存在多個(gè)文件合并。
names：轉(zhuǎn)換前的所有變量名和屬性名。
mappings：記錄位置信息的字符串。
mappings屬性
轉(zhuǎn)換前后的代碼一一對應(yīng)的關(guān)鍵，就是map文件的mappings屬性。這是一個(gè)很長的字符串，它分成三層。
第一層是行對應(yīng)，以分號（;）表示，每個(gè)分號對應(yīng)轉(zhuǎn)換后源碼的一行。所以，第一個(gè)分號前的內(nèi)容，就對應(yīng)源碼的第一行，以此類推。
第二層是位置對應(yīng)，以逗號（,）表示，每個(gè)逗號對應(yīng)轉(zhuǎn)換后源碼的一個(gè)位置。所以，第一個(gè)逗號前的內(nèi)容，就對應(yīng)該行源碼的第一個(gè)位置，以此類推。
第三層是位置轉(zhuǎn)換，以VLQ編碼表示，代表該位置對應(yīng)的轉(zhuǎn)換前的源碼位置。
舉例來說，假定mappings屬性的內(nèi)容如下：
mappings:"AAAAA,BBBBB;CCCCC"
它表示，轉(zhuǎn)換后的源碼分成兩行，第一行有兩個(gè)位置，第二行有一個(gè)位置。
每個(gè)位置使用五位，表示五個(gè)字段。從左邊算起，
第一位，表示這個(gè)位置在（轉(zhuǎn)換后的代碼的）的第幾列。
第二位，表示這個(gè)位置屬于sources屬性中的哪一個(gè)文件。
第三位，表示這個(gè)位置屬于轉(zhuǎn)換前代碼的第幾行。
第四位，表示這個(gè)位置屬于轉(zhuǎn)換前代碼的第幾列。
第五位，表示這個(gè)位置屬于names屬性中的哪一個(gè)變量。
有幾點(diǎn)需要說明。首先，所有的值都是以0作為基數(shù)的。其次，第五位不是必需的，如果該位置沒有對應(yīng)names屬性中的變量，可以省略第五位。再次，每一位都采用VLQ編碼表示；由于VLQ編碼是變長的，所以每一位可以由多個(gè)字符構(gòu)成。
如果某個(gè)位置是AAAAA，由于A在VLQ編碼中表示0，因此這個(gè)位置的五個(gè)位實(shí)際上都是0。它的意思是，該位置在轉(zhuǎn)換后代碼的第0列，對應(yīng)sources屬性中第0個(gè)文件，屬于轉(zhuǎn)換前代碼的第0行第0列，對應(yīng)names屬性中的第0個(gè)變量。
VLQ編碼
這種編碼最早用于MIDI文件，后來被多種格式采用。它的特點(diǎn)就是可以非常精簡地表示很大的數(shù)值。
VLQ編碼是變長的。如果（整）數(shù)值在-15到+15之間（含兩個(gè)端點(diǎn)），用一個(gè)字符表示；超出這個(gè)范圍，就需要用多個(gè)字符表示。它規(guī)定，每個(gè)字符使用6個(gè)兩進(jìn)制位，正好可以借用Base 64編碼的字符表。
在這6個(gè)位中，左邊的第一位（最高位）表示是否"連續(xù)"（continuation）。如果是1，代表這６個(gè)位后面的6個(gè)位也屬于同一個(gè)數(shù)；如果是0，表示該數(shù)值到這6個(gè)位結(jié)束。
這6個(gè)位中的右邊最后一位（最低位）的含義，取決于這6個(gè)位是否是某個(gè)數(shù)值的VLQ編碼的第一個(gè)字符。如果是的，這個(gè)位代表"符號"（sign），0為正，1為負(fù)（Source map的符號固定為0）；如果不是，這個(gè)位沒有特殊含義，被算作數(shù)值的一部分。
Continuation | Sign| | V V １０１０１１
下面舉例如何對數(shù)值16進(jìn)行VLQ編碼。
(1) 將16改寫成二進(jìn)制形式10000。
(2) 在最右邊補(bǔ)充符號位。因?yàn)?6大于0，所以符號位為0，整個(gè)數(shù)變成100000。
(3) 從右邊的最低位開始，將整個(gè)數(shù)每隔5位，進(jìn)行分段，即變成1和00000兩段。如果最高位所在的段不足5位，則前面補(bǔ)0，因此兩段變成00001和00000。
(4) 將兩段的順序倒過來，即00000和00001。
(5) 在每一段的最前面添加一個(gè)"連續(xù)位"，除了最后一段為0，其他都為1，即變成100000和000001。
(6) 將每一段轉(zhuǎn)成Base 64編碼。查表可知，100000為g，000001為B。因此，數(shù)值16的VLQ編碼為gB。
上面的過程，看上去好像很復(fù)雜，做起來其實(shí)很簡單，具體的實(shí)現(xiàn)可以參考官方的base64-vlq.js文件，里面有詳細(xì)的注釋。