一文帶你了解什么是源代碼映射？

作者：前端小智 2023-04-11 08:01:32

今天，我們要談論源代碼映射，這是現代 Web 開發中非常重要的工具，可以顯著地簡化調試過程。在本文中，我們將探討源代碼映射的基礎知識，它們是如何生成的，以及它們如何提高調試體驗。

先看下本篇主要內容：

本篇主要介紹源代碼映射，源代碼映射（Source maps）是以??.map???結尾的文件，例如??example.min.js.map???和??styles.css.map??。大多數構建工具都可以生成源代碼映射文件，例如Vite、webpack、Rollup、Parcel、esbuild等，一些工具默認包含源代碼映射，而其他工具則需要額外的配置才能生成它們。

使用源代碼映射可以方便地在開發過程中進行調試，因為它們提供了一種將壓縮、混淆和優化的代碼還原為原始源代碼的方法。這對于診斷和修復錯誤非常有幫助，特別是在生產環境中。源代碼映射還可以幫助你確定哪些代碼行負責執行特定的功能，以及從哪里調用了特定的函數。

盡管源代碼映射非常有用，但是它們會增加文件大小并增加服務器的負載。因此，在生產環境中通常會禁用它們，而在開發過程中啟用它們以便進行調試。如果你使用的構建工具不支持源代碼映射，則有可能需要手動編寫它們。

下面是正文~~~~

需要源代碼映射

回到過去的美好時光，我們使用純HTML、CSS和JavaScript構建Web應用程序，并將相同的文件部署到Web上。

然而，隨著我們現在構建更復雜的Web應用程序，開發工作流可能涉及使用各種工具。例如：

模板語言和HTML預處理器：Pug，Nunjucks，Markdown
CSS 預處理器：SCSS、LESS、PostCSS
JavaScript 框架：Angular、React、Vue、Svelte
JavaScript元框架：Next.js，Nuxt，Astro
高級編程語言：TypeScript、Dart、CoffeeScript

這些工具需要構建過程將我們的代碼轉換為標準的 HTML、JavaScript 和 CSS，以便瀏覽器能夠理解。此外，為了優化性能，通常會壓縮（例如使用 Terser 來縮小和混淆 JavaScript）和合并這些文件，減小它們的大小并使它們更適合于Web。

例如，使用構建工具，我們可以將以下TypeScript文件轉換并壓縮為一行JavaScript代碼。

/* A TypeScript demo: 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);
});

一個壓縮版本將是：

/* 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"
}