源码补丁神器—patch-package
一、背景
vue 项目中使用 vue-pdf 第三方插件预览 pdf,书写业务代码完美运行,pdf 文件内容正常预览无问题。后期需求有变,业务需求增加电子签章功能。这个时候 pdf 文件的内容可以显示出来,但是公司的电子签章无法显示。这令人沮丧,因为已经编写了许多特定于此依赖项的代码,如果替换依赖库,这些代码很可能会被浪费。更重要的是其已经在生产环境运行。
在不更改依赖库进行大改动的前提下,先查找问题所在。经查发现此为官方 bug 无法显示签章。进一步查询发现根源是其依赖包 pdf.js 的 电子签章不显示。
问题已定位到,要修改显示电子签章的代码是在 node_modules 的依赖包中。
如何解决此问题?
二、常用方法
1. 给依赖包提 issue 等待他人修复并发布
2. 给依赖包提 pr 自行修复并等待发布
3. 整体 copy 项目法
直接引用法
直接 copy 依赖包的源码,本地引用,不再通过 npm 包方式引用
发布私库法
适合多项目中使用同一个依赖包的场景,可以把修改后的源码发布到私有的仓库上
4. 修改引用法
配置一个 webpack alias 别名,如'原始文件的引用路径': '修改后文件的引用路径',使得最终修改后的文件被引用,如:
以上方法均有弊端:
前两种修复周期很长且依赖第三方,修复时间不定,不适合解决当前问题。
后几种方法都比较复杂,并且会导致项目臃肿,更容易忘记自己修改了源码的哪个部分,而且更新麻烦,每次都需要手动去更新代码,无法与插件同步更新。
有没有一种方法,可以优雅修改 node_modules 的源码?
三、patch-package
patch-package 让程序开发者立即修复并保留 npm 依赖项。是一个给依赖项打补丁的完美方案。
使用方法:
1.安装
如果你不需要在生产中运行
yarn、pnpm、docker 安装命令可查看其 git官网。
2. 修改 npm 包
更改 node_modules 文件夹中要修改依赖包的文件
3. 生成补丁
npx patch-package package-name
4. 添加自动执行命令
In package.json
在本文示例中,在 node_modules 找到要修改的依赖包 pdfjs-dist,修改代码如下:
执行 npx patch-package pdfjs-dist,生成补丁,会在文件目录中生成一个 patches 文件夹,如下:
至此项目中的 bug 已修复,如何让更改内容在团队其他同事拉取代码后执行?
添加自执行命令如下,会在 npm install 后知执行。
patch 文件是什么?
其实就是一些 git diff 记录描述。
原理: patch-package 会将当前 node_modules 下的源码与原始源码进行 git diff,并在项目根目录下生成一个 patch 补丁文件。
如何自测补丁是否生效?
手动删除项目中的 node_modules,并重新执行 npm install 命令安装依赖包。安装成功后查看之前修改的 node_modules 依赖包中的文件,查看修改的代码是否依然存在,如果之前修改代码依然存在即表明补丁文件已经生效,如果你之前修改的代码不存在即表明补丁文件没有生效。
四、patch-package 好处
版本预检
当依赖项发生更改时,会以红色大写字母通知,需要检查所做修复是否仍然有效。npx patch-package 会直接报错**ERROR** Failed to apply patch for package xxxx at path,通过提示可以更方便定位问题。
节省空间
无需拷贝一份源码,使用 git diff 来记录补丁更节省空间,安全又便捷。
可审查
补丁可以作为正常审查过程的一部分进行审查。
五、注意事项
◦直接修改 node_modules 下的代码不是被推荐的做法,应该仅在应急情况下考虑
◦长期还是需要彻底修复第三方包缺陷并逐步移除项目中的 .patch 文件
作者:京东保险 张洁
来源:京东云开发者社区 转载请注明来源
评论