美文网首页
五、webpack之souce-map

五、webpack之souce-map

作者: AShuiCoder | 来源:发表于2021-04-25 22:04 被阅读0次

    1. 认识source-map

    我们的代码通常运行在浏览器上时,是通过打包压缩的,但是,当代码报错需要调试时(debug),调试转换后的代码是很困难的,我们不能保证代码不出错,source-map出现了!source-map是从已转换的代码,映射到原始的源文件,使浏览器可以重构原始源并在调试器中显示重建的原始源。

    1.1 如何使用source-map

    第一步:根据源文件,生成source-map文件,webpack在打包时,可以通过配置生成source-map。
    webpack.config.js

    module.exports = {
      mode: "development",
      devtool: "source-map",
    }
    

    第二步:在转换后的代码,最后添加一个注释,它指向sourcemap。
    bundle.js

    //# sourceMappingURL=bundle.js.map
    

    1.2 分析source-map文件

    目前的source-map长什么样子呢?

    • version:当前使用的版本,也就是最新的第三版;
    • sources:从哪些文件转换过来的source-map和打包的代码(最初始的文件);
    • names:转换前的变量和属性名称(因为我目前使用的是development模式,所以不需要保留转换前的名
      称);
    • mappings:source-map用来和源文件映射的信息(比如位置信息等),一串base64 VLQ(veriablelength quantity可变长度值)编码;
    • file:打包后的文件(浏览器加载的文件);
    • sourceContent:转换前的具体代码信息(和sources是对应的关系);
    • sourceRoot:所有的sources相对的根目录;

    2 生成source-map

    如何在使用webpack打包的时候,生成对应的source-map呢?webpack为我们提供了非常多的选项(目前是26个),来处理source-map。官网查询地址https://webpack.docschina.org/configuration/devtool/
    选择不同的值,生成的source-map会稍微有差异,打包的过程也会有性能的差异,可以根据不同的情况进行选择。
    下面几个值不会生成source-map:

    • false:不使用source-map,也就是没有任何和source-map相关的内容
    • (none):production模式下的默认值(什么都不写),不生成source-map
    • eval:development模式下的默认值,不生成source-map,但是它会在eval执行的代码中,添加 //# sourceURL=,它会被浏览器在执行时解析,并且在调试面板中生成对应的一些文件目录,方便我们调试代码。
      webpack.config.js
    module.exports = {
      mode: 'development',  // development模式devtool的默认值是eval
      devtool: "eval", 
    }
    

    bundle.js

    eval("const sum = (a, b) => a + b\r\nconst mul = (a, b) => a * b\r\n\r\nmodule.exports = {\r\n  sum,\r\n  mul\r\n}\n\n//# sourceURL=webpack://webpack5/./src/js/content.js?");
    

    我们会发现eval函数最后面有/# sourceURL=webpack://webpack5/./src/js/content.js?,浏览器能通过它生成对应的一些文件目录,方便我们调试代码。

    2.1 source-map值

    生成一个独立的source-map文件,并且在bundle文件中有一个注释,指向source-map文件。
    bundle.js文件中有如下的注释:

    //# sourceMappingURL=bundle.js.map
    

    开发工具会根据这个注释找到source-map文件,并且解析。

    2.2 eval-source-map值

    eval-source-map会生成sourcemap,但是source-map是以DataUrl添加到eval函数的后面。

    2.3 inline-source-map值`

    inline-source-map会生成sourcemap,但是source-map是以DataUrl添加到bundle文件的后面。

    2.4 cheap-source-map

    cheap-source-map会生成sourcemap,但是会更加高效一些(cheap低开销),因为它没有生成列映射(Column Mapping),在开发中,我们只需要行信息通常就可以定位到错误了。

    image.png
    image.png

    2.5 cheap-module-source-map值

    cheap-module-source-map会生成sourcemap,类似于cheap-source-map,但是对源自loader的sourcemap处理会更好。
    这里有一个很模糊的概念:对源自loader的sourcemap处理会更好,官方也没有给出很好的解释,其实是如果loader对我们的源码进行了特殊的处理,比如babel。当代码被loader处理后,使用cheap-module-source-map处理效果更好。

    2.6 hidden-source-map值

    hidden-source-map会生成sourcemap,但是不会对source-map文件进行引用,相当于删除了打包文件中对sourcemap的引用注释

    // 被删除掉的
    //# sourceMappingURL=bundle.js.map
    

    如果我们手动添加进来,那么sourcemap就会生效了。

    2.7 nosources-source-map值

    nosources-source-map会生成sourcemap,但是生成的sourcemap只有错误信息的提示,不会生成源代码文件。点击错误提示,无法查看源码。

    多个值的组合

    事实上,webpack提供给我们的26个值,是可以进行多组合的。
    组合的规则如下:

    • inline-|hidden-|eval:三个值时三选一
    • nosources:可选值
    • cheap可选值,并且可以跟随module的值
    [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map
    

    那么在开发中,最佳的实践是什么呢?

    • 开发阶段:推荐使用 source-map或者cheap-module-source-map,这分别是vue和react使用的值,可以获取调试信息,方便快速开发
    • 测试阶段:推荐使用 source-map或者cheap-module-source-map,测试阶段我们也希望在浏览器下看到正确的错误提示
    • 发布阶段:false、缺省值(不写)

    相关文章

      网友评论

          本文标题:五、webpack之souce-map

          本文链接:https://www.haomeiwen.com/subject/itlyrltx.html