借助 webpack 对项目进行分析优化

Posted SegmentFault

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了借助 webpack 对项目进行分析优化相关的知识，希望对你有一定的参考价值。

进入公司之后，接手的便是前人留下来的一个大项目。庆幸的是整个项目拥有完善的产品功能文档，但是由于项目过于庞大，老旧。包含了打包过慢，冗余文件过多等诸多问题。想要快速的解决这些问题，想要完全把功能重构一遍的话，成本太高了。一个一个文件来过，时间成本也比较大。因此在此篇文章中，我们介绍一下我是如何配合webpack一步步进行分析，将项目进行优化的。

同时我针对思路封装了一个webpack-unused-files，用于查找项目中的冗余文件，欢迎试用并star。

原文链接：http://callmedadaxin.github.io/2018/04/13/analyse-project-with-webpack/#more

问题

首先，我们先大致看下我们都有什么问题，然后一步步进行解决

  • 项目频繁进行修改，冗余文件过多

  • 部分第三方依赖滥用，想去除但是不知道在哪个文件中。或没用，但是遗留在package.json里

  • 项目庞大，打包的结果过大，时间过长

删除冗余文件

由于项目的频繁改动，有很多文件已经不被使用并且没有被删除。由于项目的不断扩大，只会影响我们定位功能和问题的速度，因此对冗余文件进行清理，是很重要的。但是我们单凭肉眼很难识别哪个文件是否被依赖的，因此还要通过webpack来解决。

1.获取项目依赖的所有文件

我们来看一下webpack的输出文件格式：

 
   
   
 
    
  
    
    
  
  1. {
    2. 
  
    
    
  
  2.   ...
    3. 
  
    
    
  
  3.   chunks: [{
    4. 
  
    
    
  
  4.     name: 'chunk-name',
    5. 
  
    
    
  
  5.     modules: [
    6. 
  
    
    
  
  6.       // 每个chunk中所有的依赖文件
    7. 
  
    
    
  
  7.     ]
    8. 
  
    
    
  
  8.   }]
    9. 
  
    
    
  
  9.   ...
    10. 
  
    
    
  
  10. }
    11.

所以说，根据这个stats.json，我们可以拿到在整个项目中拿到的所有项目文件：

 
   
   
 
    
  
    
    
  
  1. /**
    2. 
  
    
    
  
  2.  * 查询依赖的模块
    3. 
  
    
    
  
  3.  */
    4. 
  
    
    
  
  4. function findSrcModules () {
    5. 
  
    
    
  
  5.   return new Promise((resolve, reject) => {
    6. 
  
    
    
  
  6.     fs.readFile(statPath, (err, data) => {
    7. 
  
    
    
  
  7.       if (err) return
    8. 
  
    
    
  
  8.       const json = JSON.parse(data)
    9. 
  
    
    
  
  9.       const assetsList = json.chunks
    10. 
  
    
    
  
  10.       let ret = []
    11. 
  
    
    
  
  11.       // 拿到所有chunk的所有依赖文件
    12. 
  
    
    
  
  12.       assetsList.forEach(chunk => {
    13. 
  
    
    
  
  13.         const modules = chunk.modules.map(item => item.name)
    14. 
  
    
    
  
  14.         ret = ret.concat(modules)
    15. 
  
    
    
  
  15.       })
    16. 
  
    
    
  
  16.       // 去除node_modules中的文件
    17. 
  
    
    
  
  17.       ret = ret.filter(item => item.indexOf('node_modules') < 0)
    18. 
  
    
    
  
  18.       resolve(ret)
    19. 
  
    
    
  
  19.     })
    20. 
  
    
    
  
  20.   })
    21. 
  
    
    
  
  21. }
    22.

通过这一步，我们可以拿到项目中，所有打包依赖的文件。

2.获取项目中所有的文件

通过glob,我们可以获取所有的文件：

 
   
   
 
    
  
    
    
  
  1. function getAllFilesInSrc () {
    2. 
  
    
    
  
  2.   const pattern = './src/**'
    3. 
  
    
    
  
    4. 
  
    
    
  
  4.   return new Promise((resolve, reject) => {
    5. 
  
    
    
  
  5.     glob(pattern, {
    6. 
  
    
    
  
  6.       nodir: true
    7. 
  
    
    
  
  7.     }, (err, files) => {
    8. 
  
    
    
  
  8.       const ret = files.map(item => {
    9. 
  
    
    
  
  9.         return item.replace('./src', '.')
    10. 
  
    
    
  
  10.       })
    11. 
  
    
    
  
  11.       resolve(ret)
    12. 
  
    
    
  
  12.     })
    13. 
  
    
    
  
  13.   })
    14. 
  
    
    
  
  14. }
    15.
3.将两个文件数组进行对比，然后进行删除等操作

将两个数组进行对比，没有出现在依赖中的文件，就是冗余文件。我们可以一键删除。

 
   
   
 
    
  
    
    
  
  1. findSrcModules().then(ret => {
    2. 
  
    
    
  
  2.   getAllFilesInSrc().then(allFiles => {
    3. 
  
    
    
  
  3.     const unUsed = allFiles.filter(item => {
    4. 
  
    
    
  
  4.       return ret.indexOf(item) < 0
    5. 
  
    
    
  
  5.     })
    6. 
  
    
    
  
  6.     const join = p => path.join('./src', p)
    7. 
  
    
    
  
    8. 
  
    
    
  
  8.     unUsed.forEach(file => {
    9. 
  
    
    
  
  9.       shelljs.rm(join(file))
    10. 
  
    
    
  
  10.     })
    11. 
  
    
    
  
  11.   })
    12. 
  
    
    
  
  12. })
    13.

分析第三方依赖

根据上述冗余文件的思路，我们同样可以对第三方依赖进行处理，大致思路如下：

  1. 获取所有包含node_modules的依赖

  2. 将文件名进行截取、去重。获取到所有的依赖

  3. 与package.json进行对比，拿到没有使用的依赖

  4. 将对比结果进行分析，将不想使用的依赖保存下来

  5. 再次查找stat.json，查找该依赖的reson字段，获取再哪里引用了该依赖，进行输出

  6. 将依赖进行手动替换、删除等操作

可以说，拿到了所有依赖及依赖关系，我们可以很灵活的对其进行处理，拿到我们想要的结果。

该功能后续也会更新到webpack-unused-files中去。

优化打包大小

让人震惊的是，整个项目由于种种原因，打包后的大小有近20M的大小！虽然并不是TO C项目，并且针对页面进行了代码拆分和懒加载，但是作为一个“合格的前端”，这种现象是一定要修改的（没错！）。该如何下手呢？一个个的翻代码，看看我们都引用了什么大依赖，看哪些项目过大未免太复杂了。我们看看webpack给我吗提供了什么方案：

1.展示打包结果

我们知道，在webpack打包结束后，会自动在控制台显示打包结果。同时，他也提供了输出依赖及大小的功能，我们执行以下参数, 便可将所有的依赖进行展示，并且看到他们的大小了。

 
   
   
 
    
  
    
    
  
  1. webpack --display-modules --sort-modules-by size
    2.

结果类似这样：

我们可以很快的定位到排名前几的js文件或者第三方依赖，决定该如何对其进行处置。

2.可视化分析依赖

webpack提供了一个功能，将打包的所有依赖文件以及关系，以json格式进行输出：

 
   
   
 
    
  
    
    
  
  1. webpack --profile --json > stats.json
    2.

这是我们整篇文章的一个基础，很多人基于此封装了不少可视化分析的工具,可以直观的看到各个文件、chunk之间的依赖关系以及大小等，快速定位到大文件、大模块。

webpack analyse：http://webpack.github.io/analyse

借助 webpack 对项目进行分析优化

webpack chart：http://alexkuz.github.io/webpack-chart/

3.优化方案

通过以上两种方法，我们可以很好的对内容文件和依赖进行定位和分析，针对打包大小的优化方案网上已经有很多了，在此不再进行赘述，提供几个思路及参考：

  • CommonsChunkPlugin提取公共代码

  • dll-plugin进行大文件单独打包，缓存

  • 删除无用的依赖（后面会提到

  • 选择性的弃用一些依赖

  • 代码压缩

  • babel-polyfill

  • Scope Hoisting

优化打包时间

针对打包时间的优化的文章其实也很多了，我们在此仅提供一些思路。我们主要提一点，通过构建会发现，项目中引用了大量的svg图标以及国旗图标，每次在静态资源处理中，打包时间就会变的特别慢。

我们在项目中使用的svg-sprite-loader，自动将各个svg图标进行svg-spirte。但是我们知道，这些图标一旦引用，我们很少进行修改。尤其是像国旗图标这种，但是每次构建我们都需要进行重复打包。因此，我们可以提前把这些图标进行svg-sprite。推荐一个网站，将各种svg图标提前进行sprite并自动进行引用：iconmoon(https://icomoon.io/)

日常打包时间优化点

  • externals 避免打包大的第三方依赖

  • dll-plugin 预打包第三方依赖

  • happypack 多进程处理，缓存

  • 缓存与增量构建

    • babel-loader?cacheDirectory

    • webpack cache:true

  • 减少构建搜索或编译路径 alias resolve

  • 具象打包的范围 include exclude

总结

通过对webpack输出依赖关系的json的分析，我们可以直观的拿到以下数据：

  • 所有依赖文件及其大小

  • 每个依赖文件是被哪些文件引用的

  • 项目依赖的第三方依赖

通过这些数据，我们可以很方便的对现有项目进行优化。

生命不息，倒腾不止。让我们对所有的恶心代码说再见！

以上是关于借助 webpack 对项目进行分析优化的主要内容，如果未能解决你的问题，请参考以下文章

使用可视化图表对 Webpack 2 的编译与打包进行统计分析

借助 mperf 进行矩阵乘法极致优化

webpack性能优化

使用 webpack 优化资源

使用 webpack 对项目进行打包发布

Webpack 性能优化