什么是source map?

什么是source map?它是现代网页开发中至关重要的工具,能够显著简化调试过程。在本文中,我们将探讨源映射的基础知识,它们是如何生成的,以及它们如何改善调试体验。

source map的需求

回顾过去,我们用纯HTMLCSSJavaScript构建网页应用,并将相同的文件部署到网络上。

然而,如今我们构建的网页应用更加复杂,你的开发流程可能涉及使用各种工具。例如:

  • 模板语言和HTML预处理器:PugNunjucksMarkdown
  • CSS预处理器:SCSSLESSPostCSS
  • JavaScript框架:AngularReactVueSvelte
  • JavaScript元框架:Next.jsNuxtAstro
  • 高级编程语言:TypeScriptDartCoffeeScript

等等。这个列表可以继续下去!


这些工具需要一个构建过程,将你的代码转译为浏览器可以理解的标准HTMLJavaScriptCSS。此外,为了优化性能,压缩(例如使用Terser来缩小和混淆JavaScript)和合并这些文件,减小它们的大小,使它们在网络上更有效率是常见的做法。

例如,使用构建工具,我们可以将以下TypeScript文件转译和压缩为一行JavaScript代码。

/* 一个TypeScript演示:example.ts */

document.querySelector('button')?.addEventListener('click', () => {
  const num: number = Math.floor(Math.random() * 101);
  const greet: string = 'Hello';
  (document.querySelector('p') as HTMLParagraphElement).innerText = `${greet}, you are no. ${num}!`;
  console.log(num);
});

压缩版本如下:

/* TypeScript演示的压缩JavaScript版本:example.min.js */

document.querySelector("button")?.addEventListener("click",(()=>{const e=Math.floor(101*Math.random());document.querySelector("p").innerText=`Hello, you are no. ${e}!`,console.log(e)}));

然而,这种优化可能会增加调试的难度。压缩的代码,一切都在一行中,变量名较短,这可能会使问题的源头难以找到。这就是source maps的作用所在——它们将编译后的代码映射回原始代码。

生成source maps

source maps是以.map结尾的文件(例如,example.min.js.mapstyles.css.map)。它们可以被大多数构建工具生成,例如VitewebpackRollupParcelesbuild等等。

一些工具默认包含source maps,而其他一些可能需要额外的配置才能生成。

/* Example configuration: vite.config.js */
/* https://vitejs.dev/config/ */

export default defineConfig({
  build: {
    sourcemap: true, // enable production source maps
  },
  css: {
    devSourcemap: true // enable CSS source maps during development
  }
})

理解source maps

这些source maps文件包含了关于编译后的代码如何映射到原始代码的重要信息,使开发人员能够轻松进行调试。以下是一个源映射的示例。

{
  "mappings": "AAAAA,SAASC,cAAc,WAAWC, ...",
  "sources": ["src/script.ts"],
  "sourcesContent": ["document.querySelector('button')..."],
  "names": ["document","querySelector", ...],
  "version": 3,
  "file": "example.min.js.map"
}

要理解这些字段的含义,你可以阅读source maps规范或者关于source maps解析文章。


source maps最关键的方面是 mappings 字段。它使用 VLQ base 64 编码的字符串将编译文件中的行和位置映射到相应的原始文件。这种映射可以使用source maps可视化工具进行可视化,例如 source-map-visualizationSource Map Visualization

左侧的生成列显示了压缩内容,而右侧的原始列显示了原始源代码。

可视化工具以不同颜色编码了原始列中的每一行及其在生成列中的对应代码。

映射部分显示了代码的解码映射。例如,条目 65-> 2:2 表示:

  • 生成代码:const这个词在压缩内容中的位置是65。
  • 原始代码:const 这个词在原始内容中的第2行第2列。

这样,开发人员可以快速确定缩小后的代码与原始代码之间的关系,使调试过程更加顺畅。

浏览器开发者工具会应用这些源映射,帮助您更快地定位调试问题,直接在浏览器中解决。


该图片显示了浏览器开发人员工具如何应用source maps并显示文件之间的映射。

它并不完美

在我们的示例中,变量greet在构建过程中被优化掉了。该值直接嵌入到最终的字符串输出中。

在这种情况下,当您调试代码时,开发者工具可能无法推断和显示实际值。这不仅是浏览器开发者工具面临的挑战,也使代码监视和分析变得更加困难。


当然,这是一个可以解决的问题。其中一种方法是在source maps中包含作用域信息,就像其他编程语言在调试信息中所做的那样。

然而,这需要整个生态系统共同努力改进源映射规范和实现。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,504评论 4 365
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,898评论 1 300
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,218评论 0 248
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,322评论 0 214
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,693评论 3 290
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,812评论 1 223
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,010评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,747评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,476评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,700评论 2 251
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,190评论 1 262
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,541评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,206评论 3 240
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,129评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,903评论 0 199
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,894评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,748评论 2 274

推荐阅读更多精彩内容