• 聊一聊前端开发中的源代码映射
  • 发布于 2个月前
  • 326 热度
    0 评论
  • 封锁爱
  • 0 粉丝 47 篇博客
  •   
源映射的必要性
早期的 Web 应用的复杂性较低。开发者直接将 HTML、CSS 和 JavaScript 文件部署到 Web 上。
在开发工作流中,更现代、更复杂的 Web 应用可能需要使用各种工具。例如:
1.模板语言和 HTML 预处理器:Pug、Nunjucks、Markdown。
2.CSS 预处理器:SCSS、LESS、PostCSS。
3.JavaScript 框架:Angular、React、Vue、Svelte。
4.JavaScript 元框架:Next.js、Nuxt、Astro。
5.高级编程语言:TypeScript、Dart、CoffeeScript。

这些工具需要构建流程来将您的代码转译为浏览器可以理解的标准 HTML、JavaScript 和 CSS。常见做法还包括使用 Terser[1] 等工具缩减和合并这些文件,以优化性能。
例如,使用构建工具,我们可以将以下 TypeScript 文件转译并压缩为一行 JavaScript。
/* A TypeScript demo: example.ts */
/* 堆代码 duidaima.com */
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);
});
压缩后的版本将如下所示:
/* A compressed JavaScript version of the TypeScript demo: 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)}));
不过,压缩代码可能会使调试变得更加困难。源映射可以解决此问题:通过将编译后的代码映射回原始代码,源映射可以帮助您快速找到错误的来源。

生成源映射
源映射是名称以 .map 结尾的文件(例如 example.min.js.map 和 styles.css.map)。大多数构建工具(包括 Vite、webpack、Rollup、Parcel 和 esbuild)都可以生成源映射。某些工具默认包含源代码映射。其他工具可能需要进行额外的配置才能生成:
/* 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
  }
})
了解源映射
为了帮助调试,这些源映射文件包含有关编译代码如何映射到原始代码的重要信息。以下是源映射示例:
{
  "mappings": "AAAAA,SAASC,cAAc,WAAWC, ...",
  "sources": ["src/script.ts"],
  "sourcesContent": ["document.querySelector('button')..."],
  "names": ["document","querySelector", ...],
  "version": 3,
  "file": "example.min.js.map"
}
如需了解其中每个字段,您可以参阅源代码映射规范[2]。

源映射最重要的部分是 mappings 字段。它使用 VLQ base 64 编码字符串[3]将编译文件中的行和位置映射到相应的原始文件。您可以使用源代码映射可视化工具(例如 source-map-visualization[4] 或 Source Map Visualization)查看此映射。

左侧的生成列显示压缩内容,原始列显示原始来源。可视化工具会为 original 列中的每行分配颜色代码,并在 generated 列中显示相应的代码。

映射部分会显示代码的已解码映射。例如,条目 65 -> 2:2 表示:
1.生成的代码:const 一词位于压缩内容的 65 位。
2.原始代码:const 一词位于原始内容的第 2 行和第 2 列。

这样,开发者就可以快速确定经过缩减的代码与原始代码之间的关系,从而使调试过程更加顺畅。
浏览器开发者工具会应用这些源代码映射,以帮助您在浏览器中快速查明调试问题。

参考
[1] Terser: https://github.com/terser/terser
[2] 源代码映射规范: https://bit.ly/sourcemap
[3] VLQ base 64 编码字符串: https://developer.chrome.com/blog/sourcemaps?hl=zh-cn#base64-vlq-and-keeping-the-source-map-small
[4] source-map-visualization: https://sokra.github.io/source-map-visualization/

用户评论