Source Maps简介

  • 时间:
  • 浏览:0

  提高网站性能最简单的办法之一是合并压缩JavaScript和CSS文件。倘若当你必须调试什么压缩文件中的代码时,那可能性是一场噩梦。不过却说用担心,souce maps可能性帮你出理 你这名 间题报告 。

  Source map提供了这名 生活办法,上能将压缩文件中的代码映射回源文件中对应的位置。这导致 ,你上能借助有些软件很轻易地调试应用进程中什么经过优化出理 过的资源。Chrome和Firefox提供的开发者工具都内置了对source maps的支持。

  本文将介绍source maps的工作原理,以及如保生成它们。亲戚亲戚大伙儿 将主要关注JavaScript代码的source maps,不过什么原理也同样适用于CSS。

  提示:Firefox开发者工具中的source maps默认是开启的。对于Chrome而言,你可能性必须手动启用你这名 功能(译者:目前看来,Chrome中你这名 功能默认也是开启的)。在Chrome中打开开发者工具(译者:默认的快捷键是F12),倘若找到“设置”面板(译者:开发者工具面板的右上角,点击另一一有一个 点的菜单,其中上能找到“Settings”菜单),在“General”选项卡中勾选“Enable JS source maps”和“Enable CSS source maps”(译者:我所使用的Chrome版本中,你这名 个 设置项在“Preferences”选项卡中)。

 Source Maps的工作原理

  顾名思义,source map中包含了有些上能将压缩文件中的代码映射回源代码的信息。对于每另一一有一个 压缩文件,你上能为其指定不同的source map。

  通过在经过优化的压缩文件的末尾添加一行特殊的注释,来告诉浏览器有可用的source map。

//# sourceMappingURL=/path/to/script.js.map

  该注释通常由生成source map的进程自动添加。当浏览器的开发者工具被打开时,可能性source maps功能被启用,那么该文件可能性被加载。

  你还上能通过在压缩的JavaScript文件的响应中发送X-SourceMap HTTP头来指定source map。

X-SourceMap: /path/to/script.js.map

  Source map文件包含另一一有一个 JSON对象,用来描述source map文件这名 生活以及JavaScript源文件的有些信息。下面是另一一有一个 例子:

{
    version: 3,
    file: "script.js.map",
    sources: [
        "app.js",
        "content.js",
        "widget.js"
    ],
    sourceRoot: "/",
    names: ["slideUp", "slideDown", "save"],
    mappings: "AAA0B,kBAAhBA,QAAOC,SACjBD,OAAOC,OAAO..."
}

  让亲戚亲戚大伙儿 来仔细看看什么属性。

  • version - 此属性用于说明source map文件的版本。
  • file - source map文件的名称。
  • sources - 一组包含源文件URLs的数组。
  • sourceRoot - (可选)sources属性中什么URLs相对路径的根目录。
  • names - 包含源文件中所有变量和函数名称的数组。
  • mappings - 一组包含实际代码映射的Base64 VLQs的字符串(这正是source map起作用的核心)。

使用UglifyJS生成source maps

  UglifyJS是另一一有一个 很流行的命令行工具,用来合并和压缩JavaScript文件。版本2提供了有些的命令行参数,用来帮助亲戚亲戚大伙儿 生成source maps。

  • --source-map - 生成的source map文件的名称。
  • --source-map-root - (可选)指定source map文件中sourceRoot属性的值。
  • --source-map-url - (可选)在经过优化的压缩文件底部的注释中指定source map文件的路径。如://# sourceMappingURL=/path/to/script.js.map
  • --in-source-map - (可选)输入的source map。倘若你正在压缩的JavaScript文件是从以前 源文件生成的。这类JavaScript库。
  • --prefix-p - (可选) 移除source map文件中sources属性里URLs的路径层级。这类,-p 3可能性移除路径中的前三级,以前 “one/two/three/file.js”会变成“file.js”。使用-p relative会让UglifyJS在source map和源文件之间计算出相对路径。

  下面是另一一有一个 使用什么命令行参数的例子。

uglifyjs [input files] -o script.min.js --source-map script.js.map --source-map-root http://example.com/js -c -m

  注意:可能性在Grunt中使用grunt-contrib-uglify插件,请参考这里查看如保在Gruntfile中使用什么选项。

  还有有些其它可用的工具上能生成source maps文件。下面列出了其包含些。

  • Closure
  • CoffeeScript编译器
  • Grunt任务中的grunt-jsmin-sourcemap

Chrome开发者工具中的source maps

Chrome开发者工具中的Sources选项卡

  可能性你的source maps设置正确,那么你将在Sources选项卡中看多所有的JavaScript源文件。

  查看页面的HTML代码,你上能发现仅另一一有一个 压缩的JavaScript文件被引用。而开发者工具自动加载了对应的source map文件并获取了对应的源文件。

Firefox开发者工具中的source maps

Firefox开发者工具中的调试器面板

  Firefox用户在开发者工具的调试器中上能看多source maps对应的源文件。开发者工具识别出了source map的居于并自动获取了对应的源文件。

有些感想

  使用source map使得开发人员上能在调试环境下直观地查看并维护代码,一齐网站也获得了更好的性能提升。

  本文介绍了source maps的工作原理以及如保用UglifyJS生成source maps。可能性你的网站使用了压缩过的资源(推荐以前 做),那么上能考虑花点时间将source map整合到其中。

有用的链接

  • Source Maps版本3的提案
  • UglifyJS
  • Source Mapg Demo

原文地址:https://blog.teamtreehouse.com/introduction-source-maps