Nest.js 这么大的项目是怎么优化 ts 编译性能的?

网站建设4年前发布
50 0 0

20230306151658c95861b44c4a8884dfe385683df57c14a2c23d529,Nest.js 是流行的 node 服务端框架,最近我注意到它有一个大的 PR。,这个 PR 涉及到 50 多个文件,800 多行代码的改动:,202303061516597628c5f8671276dfaf36953b352efcec1aa1ef631,同学们肯定会觉得这么多代码改动肯定是大版本升级无疑了。,然而,它并没有更新版本号:,20230306151809e554272349ff3d9c55082226af406c3477951596820230306151817668eb3168198c3312206548be7f2404e04523e404,可以看到 Nest 从 gulp 切换到了 tsc 编译,但是版本号依然是 9.1.2。,为什么这么大的 PR 没有改版本号呢?,看下 PR 的内容就知道了:,202303070148514737c1c682c53c3baf6869f02e6328218730a8248,这个 PR 是从 gulp 切换到了 tsc 的 Project Reference,优化了编译性能,并且启动也更简单了。,只是构建相关的优化,不更新版本号也正常。,有的同学可能会问了,Project Reference 是什么东西?为什么它能提升 tsc 编译性能呢?,我们先看下之前 Nest 是怎么编译 nest 源码的:,20230306151811e75b57883a7ba5ad2b8911efc231c7de25095d416,通过 gulp 的 build 命令,产物输出到 node_modules/@nestjs 下。,gulp 记录了项目中每一个包的 tsconfig.json:,然后用 tsc 读取每一个 tsconfig.json 来编译 ts 代码:,这个流程很容易理解,就是通过 tsc 根据一个个的 tsconfig.json 来编译 ts 代码,输出到不同目录,gulp 只是组织这个流程的。,那现在 tsc 又是怎么编译的呢?,首先,现在不用 gulp 组织流程了,直接执行 tsc,只是加上了 -b,这个就是开启 project reference 用的:,2023030615170277b0c4819aacca5e5bd3903050f8f6ec828307958,所谓的 project reference 就是这个东西:,20230306151703d9784a626c2a81b3a532130c0989becd240694519image.png,也就是 tsconfig 里通过 references 引用其他 project。,如果其他 project 也依赖别的 project 可以再次引用:,编译的时候就会一起编译。,这样和单独跑 tsc 不是一样么?有区别么?,区别大了去了。,现在执行 tsc -b 之后会在每个 project 下生成这样一个 tsconfig.build.tsbuildinfo 的文件:,每个 project 都有:,20230307014458e6867d66302b67c52a9332ee629775502d4772163,那这个文件有啥用呢?,看下内容就知道了:,它记录了这个 project 所有编译的文件名:,202303061517041385fcb32c1c9862d8a212561fc44cac64ce78723,还有 hash 的版本号,是否访问了全局作用域:,20230306151704285d6de56e836863db5287ca09c353ceaa4120725,这样再次编译的时候有啥不一样么?,那肯定是编译过后的就不用编译了呀,相当于做了一层缓存,每次对比下改动的文件的 hash,如果有变化才去编译。,不同的 project 是分开缓存的,一个 project 变了只要单独编译那个 project 即可,其余的就可以跳过了。,这样自然就可以提升编译性能。,不过它提升的只是第二次编译的性能,首次编译还是要全量编译的。,这也是为什么 PR 里提到的是更快的 rebuild:,20230306151811937b64e32fe86f6e344070c0acdbb8fe943f8a728,为什么从 gulp 切换到 tsc project reference 我们知道了。那新版的 nest 如何调试呢?,我们直接用 nest 项目自带的案例调试就行。,nest 提供了 sample 目录,下面有很多案例项目:,20230306151706a2f428a72897653aeda9049e36e8ac578ff336986,我们新建一个 .vscode/launch.josn 的调试配置文件:,20230306151812b38eb279923a8a22e0a597f517bec9e26d8255743,image.png,新增这样的调试配置:,这个配置很容易看明白,就是在 01-cats-app 这个目录下执行 npm run start。,那 console 指定为 integratedTerminal 是什么意思呢?,跑一下就知道了:,跑起服务来,打个断点,访问 localhost:3000/cats,你会发现日志是打印在 debug console 的:,没有颜色,这自然用的不习惯。,指定 console 为 integratedTerminal,再重新调试:,20230306151708e672272829b6342f4bc23562cc37314b59cbea232,现在日志就打印在 terminal 了,是不是顺眼多了?,这是调试 nest 项目的方式。,那怎么调试 nest 源码呢?,现在调用栈里的 nest 代码都是编译过后的:,20230306151812936e5e39548f7a4a7266985281919f317fa064744,想调试源码就要有 sourcemap。,默认 nest 编译不产生 sourcemap,我们要改下编译配置:,2023030615170956c9db0019f99c9612f7932e010546bb55b291405,改下 packages/tsconfig.build.json,加上这两个配置就可以了。,sourceMap 为 true 就是生成 sourcemap 的意思,inlineSources 是在 sources 里保存源码,默认生成的 sorucemap 是不包含源码的。,执行 npm run build。,你就会发现生成了 sorucemap:,但是 node_modules/@nestjs 下还是没有 sourcemap,这是因为还少了一步:,nest 的 build 命令有个后置命令:,20230306151710c4700e29735dfb8c3bc335a389c97fbb27628a632,每次 build 完就会自动把这些文件复制到 node_modules/@nestjs 下:,20230306151710d26e2c037e23886a83e228b1cdb261c7d35626188,默认没有编译出 sourcemap,自然也就没有 move 这部分文件。,补上这块,再次执行 npm run build:,20230306151709c60446994930916b06a116d488c2d54819b2f4936,然后去 node_modules 下看一眼:,2023030615181469afb5a99865b067578662256bfcc32e76cff1882,现在就有 sourcemap 了,完美!,然后再跑下 nest 项目的调试:,20230306151814d557db774dc9c33a0be032b151fd3da9bf78fe510,咋还不是源码呢?,这确实比较坑,因为有个默认配置,禁掉了 node_modules 下的 sourcemap 查找:,20230306151815b3426f3700db993765d3734dad238ffd5adc5e937,去掉即可:,20230306151818985f58f82a2c0881b1c903764828a60ea3ab87390,然后重新跑调试:,20230306151816b376e3e603f07e1ebf50288cb5313ccf3e78c9731,这时候你就会发现调试的是 nest 的 ts 源码了!,nest 最近通过一个大 PR 把构建方式从 gulp + tsc 切换到了 tsc -b 也就是 project reference 的方式,这样能极大的提升 tsc 编译性能。,原理就是 project reference 的模式会生成一个缓存文件记录着每个 project 编译了哪些文件,hash 是啥,这样再次编译就可以跳过没有更新的文件。,新版 nest 源码的调试也同样需要生成 sourcemap,修改下编译配置,生成 sourcemap 的代码即可(只不过要注意 VSCode Node Debugger 的一个坑,默认不查找 node_modules下的 sourcemap)。,然后就可以愉快的调试 nest 的 ts 源码了!,nest 这么大的项目都用了 tsc project reference 来优化编译性能,那平时我们的项目自然也可以用 project reference 来优化,ts 编译性能优化的时候不妨往这方面考虑一下。

© 版权声明

相关文章