(1)清洗moment
语言环境文件
默认情况下,当您编写var moment = require('moment')
代码并使用 webpack
打包时,捆绑文件的大小会变得很重,因为webpack
会捆绑所有Moment.js
所有语言环境文件(在 Moment.js 2.18.1
中,压缩后的 KB
为 160
)。
要去除不必要的语言环境并仅捆绑使用的语言环境,请添加moment-locales-webpack-plugin
:
// webpack.config.js
const MomentLocalesPlugin = require('moment-locales-webpack-plugin');
module.exports = {
plugins: [
// To strip all locales except “en”
new MomentLocalesPlugin(),
// Or: To strip all locales except “en”, “es-us” and “ru”
// (“en” is built into Moment and can’t be removed)
new MomentLocalesPlugin({
localesToKeep: ['es-us', 'ru'],
}),
],
};
为了优化大小,还可以使用两个 webpack
插件传送门:
IgnorePlugin
ContextReplacementPlugin
IgnorePlugin
您可以使用IgnorePlugin
.
const webpack = require('webpack');
module.exports = {
//...
plugins: [
// Ignore all locale files of moment.js
new webpack.IgnorePlugin(/^\.\/locale$/, /moment$/),
],
};
而且您仍然可以在代码中加载一些语言环境。
const moment = require('moment');
require('moment/locale/ja');
moment.locale('ja');
...
Create React App和Next.js使用这个解决方案。
ContextReplacementPlugin
如果要在 webpack
配置文件中指定包含语言环境文件,可以使用ContextReplacementPlugin
.
const webpack = require('webpack');
module.exports = {
//...
plugins: [
// load `moment/locale/ja.js` and `moment/locale/it.js`
new webpack.ContextReplacementPlugin(/moment[/\\]locale$/, /ja|it/),
],
};
在这种情况下,您不需要在代码中加载语言环境文件。
const moment = require('moment');
moment.locale('ja');
...
测量
webpack: v3.10.0
moment.js: v2.20.1
File size |
Gzipped |
|
---|---|---|
Default |
266 kB |
69 kB |
w/ IgnorePlugin |
68.1 kB |
22.6 kB |
w/ ContextReplacementPlugin |
68.3 kB |
22.6 kB |
How to optimize moment.js with webpack
(2)unused code
在我们的实际项目中,moment
被集成在bricks
基础组件库中,bricks
组件库在构建时已经对语言环境文件做了清洗处理,但是在业务代码编写过程中实际使用moment
的场景特别少,只用到了几个零碎的api
,却要承担引入整个moment.js
构建到产物中的代价。这时你可能要问到我们不是有tree shaking
吗?它可以帮我们自动清除无效代码,但事与愿违,moment
高度基于OOP API
(面向原型链编程),所有api
都挂载到原型链上,导致无法使用Webpack
新引入的Tree-shaking
代码优化技术,无法识别哪些代码是dead code
。
Moment还存在如下一些问题
- 它高度基于
OOP API
,这使得它无法使用tree-shaking
,从而导致巨大的包大小和性能问题; - 它的可变性将导致一些时刻计算问题;
- 复杂的
OOP API
使得Moment
可变性问题更加严重,这儿有个例子https://github.com/moment/mom...; Moment
性能一般,由于复杂的API
使得Moment
与原生Date
相比有着巨大的性能开销;
Moment可变性
当我开始使用 moment
时,我假设它遵循 FP
原则,并且每次调用函数时都会返回相同的值:
var now = moment();
var yesterday = now.subtract(1, 'days');
var dayBeforeYesterday = now.subtract(2, 'days');
当然,我没有得到我期望的结果,这让我措手不及。
考虑这个伪代码,我期望如下代码行为方式:
var now = now;
var yesterday = now - 1day;
var dayBeforeYesterday = now - 2days;
但事与愿违,它最终像这样工作,这让我感觉很奇怪:
var now = now;
var yesterday = now = now - 1day;
var dayBeforeYesterday = now = now - 2days;
Moment
对象的可变性使得我只能小心翼翼使用.clone()
。
var now = moment();
var yesterday = now.clone().subtract(1, 'days');
var dayBeforeYesterday = now.clone().subtract(2, 'days');
Moment
使用过程很容易出现这些细微的错误,我认为 FP
原则有助于最大限度地减少类似错误。
参考:
怎么使moment对象不可变
moment对象可变性造成的问题
如何解决 moment.js 中的可变性?
替换方案
如果您没有使用时区,而只使用了moment.js
中的一些简单函数,这会导致你的应用程序被引入了很多没使用的方法,这是极其浪费性能和内存的。 在这里推荐使用dayjs
, dayjs
体积非常小,超小的压缩体积,仅仅有2kb
左右,所有更改Day.js
对象的API
操作都将返回一个新的实例(不可变性),和Moment.js
有着相同的API
和模式,因此很容易从moment
平滑过渡到day.js
。date-fns
支持Tree-shaking
代码优化技术,提供友好的 functional programming (FP
) 函数(都是纯函数),支持函数柯里化,支持typescript
,它的不可变性能很好的弥补moment
带来的问题,因此它很适合与React,Sinon.js
和webpack
等好基友一起使用。
moment.js
、day.js
、date-fns
简单比较:
名字 | 大小(gzip ) |
支持Tree-shaking |
名气 | api 方法数 |
模式 | 时区支持 | 支持的语言数 |
---|---|---|---|---|---|---|---|
Moment.js | 329K(69.6K) |
No | 38k |
高 | OO |
非常好(moment-timezone ) |
123 |
date-fns | 78.4k(13.4k) without tree-shaking |
Yes | 13k |
高 | Functional |
还不支持 | 32 |
dayjs | 6.5k(2.6k) without plugins |
No | 14k |
中 | OO |
还不支持 | 23 |
项目实践
首先排查应用程序依赖Moment
情况,发现Moment
集成在bricks
基础组件库中,只有日期组件使用了moment
,当前应用程序没有使用日期组件,而且也没有其他依赖Moment
的模块被安装,业务代码使用Moment
的场景也很少,仅使用calendar
和format
两个api
,程序对moment
依赖程度极低,因此完全可以将Moment
从业务代码中移出,引入更加零轻量级day.js
,或者支持Tree-Shaking
的date-fns
,在或者原生实现format
方法。
综合考虑,鉴于date-fns
支持FP
、Tree-Shaking
,具有不可变性,跟React
状态不可变性、FP
原则的思想完美吻合,选择使用date-fns
替换掉bricks
集成的moment
模块,替换moment
的format
、calendar
方法
(1)因为bricks
集成了moment
,需要先排除其被打包到最终产物中
// config-overrides.js
/** 清除bricks组件集成的moment,不让其参与打包 */
const eliminateMomentOfBrs = (config) => {
config.plugins.push(new webpack.IgnorePlugin({ resourceRegExp: /moment/ }));
}
module.exports = function override(config, env) {
eliminateMomentOfBrs(config);
}
(2)替换业务代码中moment
的format
、calendar
方法
// moment.js
moment(time).format('MM月DD日'); // 09月02日
// date-fns
import { format } from 'date-fns';
format(time, 'MM月dd日'); // 09月02日
// moment.js
moment(time).calendar(null, {
sameDay: '[今日]HH:mm',
nextDay: '[明日]HH:mm',
nextWeek: 'M月D日 HH:mm',
lastDay: 'M月D日 HH:mm',
lastWeek: 'M月D日 HH:mm',
sameElse: 'M月D日 HH:mm',
}); // // 8月27日 09:23
// date-fns
import { format, formatRelative } from "date-fns";
import { zhCN } from "date-fns/esm/locale";
const formatRelativeLocale = {
lastWeek: "M月d日 HH:mm",
yesterday: "M月d日 HH:mm",
today: "[今日]HH:mm",
tomorrow: "[明日]HH:mm",
nextWeek: "M月d日 HH:mm",
other: "M月d日 HH:mm"
};
const locale = {
...zhCN,
formatRelative: (token) => formatRelativeLocale[token]
};
formatRelative(time, new Date(), { locale }); // 8月27日 09:23
如果你正在使用 ESLint
, 你可以安装一个插件plugin
来帮助你识别代码库中你没有(可能不需要)Moment.js
的地方,防止同学不经意安装引入moment
。
安装这个插件...
npm install --save-dev eslint-plugin-you-dont-need-momentjs
...然后更新你的配置
"extends" : ["plugin:you-dont-need-momentjs/recommended"],
优化前后对比:
移出moment
使得build\static\js\2.7fde9c2a.chunk.js
体积减少17.52KB
,但添加date-fns
使得build\static\js\3.4a62a5b9.chunk.js
增加8.76KB
,整体体积减少接近10KB
,效果不是很明显
对可视化树状图进一步分析发现程序中已经引入了dayjs
,但程序并没有单独安装它,执行npm list dayjs
,发现只有封装大额业务组件库@casstime/mall-components
使用了它
基于以上观察,引入date-fns
看来是没有必要的,直接使用dayjs
即可,长久考虑,统一换成date-fns
比较好。
优化前后对比:
再次调整优化后干掉了整个moment
模块,并且没有添加其他模块,和业务组件@casstime/mall-components
共用dayjs
,产物体积整体减少17.5KB
(大于上次优化的10KB
)