我们在开发一个项目的时候,总会遇到这样的问题,就是比如我们写了一个utils工具类,我们在某一个组件内要用到utils这个类里的其中一个或者某几个方法,但是当我们引入utils的时候,实际是将utils里的方法全都引入了,这样就会导致将没有必要的东西也引入,包提就会越来越大。那么我们如何解决这个问题呢?是的,tree-shaking.看名字就知道是将哪些没有用的东西都shaking掉。Tree-shaking是一种通过清楚多余代码的方式来优化项目打包体积的技术。
tree-shaking原理
利用es6模块的特点:
其实tree-shaking的概念很早就提出了,但是直到es6的ES6-style模块出现后才被真正的利用起来,这是因为tree-shaking只能在静态modules下工作,Es6模块的加载是静态的。因此整个依赖树可以被静态的推导出解析语法树,所以在es6模块中使用tree-shaking是非常容易的。而且也支持statement(声明级别)。
之前,我们可以使用commonjs引入模块。require(),这种引入是动态的,也就是意味着我们可以给予条件来导入需要的代码:
let mynamicModule
if (condition) {
mynamicModule = require('aaa')
} else {
mynamicModule = require('bbb')
}
commonjs的动态特性模块意味着tree-shaking不适用,因为它是不可能确定哪些模块实际运行之前是需要或者是不需要的。在ES6中,进入来完全静态的导入语法:import,这也就是意味着下面的导入是不可行的:
if (condition) {
mynamicModule = require('aaa')
} else {
mynamicModule = require('bbb')
}
只能是通过导入所有的包后再进行有条件的获取:
import aaa from './aaa'
import bbb from './bbb'
if (condition) {
} else {
}
es6的import语法完美可以使用tree-shaking,因为可以在代码不运行的情况下就能分析出不需要的代码。
接下来看看如何使用tree-shaking?
其实从webpack2开始就已经开始支持tree-shaking的特性了,webpack2正式内置支持2015模块,和未引用模块的检测能力。新的webpack4正式版扩展了这个检测能力。通过package.json的sideEffects属性标记。向complier提供提示,表面项目中的哪些文件是pure(纯es2015模块)由此,可以安全的删除文件中未使用的部分。如果使用的webpack4只需要将webpack4设置为production,即可开启tree-shaking.如果使用的是webpack2可能你会发现tree-shaking并不起作用,因为bable会将代码编译成Commonjs模块。而tree-shaking不支持commonjs,所以需要配置不转意:
options: {
presets: [
['es2015', {modules: false}]
]
}
sideEffect的一些说明:
sideEffect是指哪些当import的时候会执行的一些动作。但是不一定会有任何export,比如ployfill,polyfill不对外暴露方法给主程序使用。tree-shaking不能自动识别哪些代码属于side effect.因此手动指定这些代码显的非常重要。如果不指定可能会出现一些意想不到的问题。
在webpack中是通过package.json的sideEffect属性来实现。
{
"name": "tree-shaking",
"sideEffect": false
}
如果所有的代码都不包括副作用,我们就可以简单的将该属性标记为false来告诉webpack,它可以安全的删除用不到的export导出。
如果代码确实有一些副作用:那么可以提供一个数组:
{
"name": "tree-shaking",
"sideEffect": ["./src/common/polyfill.js"]
}
总的来说:
tree-shaking不支持动态导入,只支持纯静态导入;
webpack中可以在项目package.json文件中,添加一个sideEffect属性,用于手动指定副作用的脚本。