分享一个我看源码时的小技巧。


你好呀,我是歪歪。

我在之前的文章里面不是经常叫大家拉源码,然后看代码提交记录吗。

也就是看类似于这个界面:

分享一个我看源码时的小技巧。

比如上面这个界面中,就可以看到 RedissonBaseLock.java 这个文件,由谁在什么时候进行过变更,以及变更对应的 commit 信息是什么。

这样就能很直观的看到文件的演变过程。

那么问题就来了,有好几个同学都问过我这个问题:怎么在 idea 里面查看 git 提交记录呢?这个界面是藏在哪里的呢,我的 idea 里面怎么没有呢?

好的,是我疏忽了,我先入为主的认为这个大家应该都知道是怎么来的。

但是确实是有一些同学是不太清楚的,那我这篇文章就给大家分享一下我通过这个东西看源码的一点点小技巧,希望能帮助到你。

分享一个我看源码时的小技巧。

怎么搞出来?

那么怎么把这个视图搞出来呢?

首先,你本地得有一个 git.exe。

这个玩意怎么来的,就不用我说了吧,如果连这个都没有,说明你之前还没有接触过 git,那就是另外一回事儿了,不在本文讨论范围内。赶紧去安装一个 git,然后学学 git 的用法啥的。

我个人的习惯是先用 gitbash,也就是这个玩意,从 github 上 clone 一个项目下来:

分享一个我看源码时的小技巧。

比如我就用之前写文章的 Redssion 做演示吧,你也可以随便找一个自己感兴趣的开源项目。

执行下面命令把项目下载下来:

git clone https://github.com/redisson/redisson.git

分享一个我看源码时的小技巧。

下载完成之后,打开你的 idea,导入我们刚刚下载的项目。

然后随便打开一个文件,点击右键,看看有没有 Git 这个选项:

分享一个我看源码时的小技巧。

如果顺利的话,你点击 ShowHistory 之后,就能看到这个窗口了:

分享一个我看源码时的小技巧。

如果不顺利,说明你的 git 配置有问题。

在 idea 的 Settings 里面进行对应的设置:

分享一个我看源码时的小技巧。

设置完成之后,可以点击旁边的 test 按钮,如果有弹窗告诉你对应的版本号,那就说明配置成功了:

分享一个我看源码时的小技巧。

总之,只要能调出 Version Control 标签页或者有的高版本里面就叫做 git,就代表配置成功了。

怎么看?

不管是在工作中还是写文章的时候,我一般在 idea 里面只是看提交记录,我不会用 idea 里面的 git 去做提交代码的动作。

其实 idea 里面拉取代码,提交代码什么的可视化页面做的很好,但是我还是比较喜欢直接在 gitbash 里面敲命令,也没有什么特别的原因,只是这样显得逼格高而已。

那么,到底怎么去看呢?

以我之前写的 Redisson 文章为例。

主要是围绕着 RedissonLock.java 这个类在写,我是怎么知道这个类的呢?

其实自己带着问题去 debug 也肯定能定位到这个类,但是需要一点时间。

我以前就是搭完环境之后,就开始疯狂的写案例 debug 了。

现在我学聪明了,环境搞定之后,先去 github 的 issues 里面拿着关键词去搜一下。

比如我的关键词就是死锁:

分享一个我看源码时的小技巧。

但是我强烈建议你别用中文搜索,用英文,deadLock:

分享一个我看源码时的小技巧。

这样能搜出来的信息就很多,剩下的就是你一个个点开,看看是不是和自己遇到的问题一样,或者相似。

这个过程会花一点点时间,但是绝对比你一头扎进源码里面找答案快的多。

比如,上面的截图中,最后一个叫 Deadlock after Redis timeout 的 issue,就是我想要找的东西:

分享一个我看源码时的小技巧。

在这个里面给出了复现的代码,涉及的版本,以及预期的结果和实际的表现。

比如说我找到这个链接之后,对我而言就是找到了一个测试用例,同时他告诉了我一个命令:

CLIENT PAUSE 5000

在这之前,我是不知道这个命令的。我还一直在想,我做 Demo 复现的时候,应该怎么去模拟 Redis 执行命令超时的现象呢?

我当时能想到的一些方案就是 bigkey,或者灌很多数据进去,然后我执行 keys * 命令,再或者搞个 save 命令,这样来模拟 Redis 阻塞。

但是,这都是有工作量且阻塞时间不可控的。而这个命令直接解决了我这个问题,至少让我少走了几步弯路吧。

同样,这个 issues 里面还关联了几个其他的 issues ,这些都是官方认为是同一个原因造成的问题:

分享一个我看源码时的小技巧。

然后怎么解决的呢?

常规来说,他们应该关联一个 pr,通过这个 pr 我就能直接关联到对应的修复的内容。

但是这次他们搞了一个骚操作,直接先弄了一个 SNAPSHOT 版本,并没有关联 pr:

分享一个我看源码时的小技巧。

怎么办?

这个时候我想去看他是怎么修复这个问题的,怎么办?

分享一个我看源码时的小技巧。

前面提到的 idea 里面的 git 插件就派上用场了。

首先,从他的评论时间我知道是 2019 年 3 月 13 号,那么我可以直接在工具里面定位到那一天提交的内容。

点击 Version Control 视图里面的 Log 标签,就可以看到整个项目历史上的所有的提交,它会按照时间的顺序给你排好序,所有很容易就找到了当天的相关的提交:

分享一个我看源码时的小技巧。

你要是觉得难得找,也可以直接通过日期进行过滤:

分享一个我看源码时的小技巧。

从当天提交的这个 commit 信息来看,就知道我找对地方了。

而这里就只是修改了 RedissonLock.java 这个类,所以我就找到了这个关键的类:

分享一个我看源码时的小技巧。

然后点进去再分析一下这个类具体的修改,这样算是找到了 debug 的时候我应该重点关注的地方。

又比如看门狗失效的那个 bug:

https://github.com/redisson/redisson/issues/3714

分享一个我看源码时的小技巧。

在这里面,就是直接关联了一个 pr,然后我们可以通过这个链接,找到提交的代码,也可以找到其对应的 issues。

分享一个我看源码时的小技巧。

这玩意属于双向奔赴了。

而且我也能知道这次提交对应的类叫做 RedissonBaseLock.java:

分享一个我看源码时的小技巧。

那我又可以回到 idea 的视图里面,直接看看这个类的提交记录了:

分享一个我看源码时的小技巧。

一看才发现,这个哥们一共提交了三次。而且还发现这个类还挺年轻的, 2021 年 1 月 21 日才首次提交。

我之前在《踩到一个关于分布式锁的非比寻常的BUG!》这篇文章里面留了个思考题:

分享一个我看源码时的小技巧。

就是由这三次提交引起的。

我带你看一下这三次提交分别是什么。

首先第一次提交,加入了 else 分支,里面执行了一次 cancelExpirationRenewal 方法,入参是 threadId。

分享一个我看源码时的小技巧。

含有是把当前线程的重入次数减一。

但是能走到 else 分支里面来有个大前提是给锁续命的 lua 脚本返回 false,也就是说这个锁都没了。

锁都没了,还维护重入次数干啥呢?

直接从 MAP 里面把这个对象拿掉就行了。

怎么拿掉呢?

传入 null 就可以了:

分享一个我看源码时的小技巧。

所以,才有了第二次提交,把入参从 threadId 修改为 null:

分享一个我看源码时的小技巧。

那么第三次提交又是干啥呢?

分享一个我看源码时的小技巧。

是不是完全看不出来是干啥?

别急,我这样给你上个截图你就懂了:

分享一个我看源码时的小技巧。

之前是用的 tab 制表符,后来修改为四个空格。这是编码风格的问题。

提到用 tab 还是用空格,这又是另外一个在编程领域里面争论不止的话题了。

我记得之前我看过一个美剧,叫做《硅谷》。里面的主人公就因为到底应该用 tab 还是用空格和女朋友吵了一架。

然后...

分享一个我看源码时的小技巧。

我写文章的时候还想起了一个无聊的问题,并且去寻找到了答案。

我想知道 Redisson 是在什么时候引进看门狗机制的,我想看看这个狗子最开始的模样。

我怎么找的呢?

首先我知道启动看门狗的代码是位于 RedissonLock.java 中的 renewExpiration 这个方法:

分享一个我看源码时的小技巧。

那我就在 RedissonLock.java 的历史提交记录里面用找一下 renewExpiration 这个方法什么时候是第一次提交的就行了。

于是我很快就找到了 2019 年 3 月 13 日的这次:

分享一个我看源码时的小技巧。

我才发现原来看门狗还换过名字,它之前叫做 scheduleExpirationRenewal,后来才改名叫 renewExpiration。

很显然,我觉得新名字更好。

然后我就继续找 scheduleExpirationRenewal 是什么时候第一次出现的,我找啊找啊,找到了 2015 年 12 月 14 日的这次提交:

分享一个我看源码时的小技巧。

好家伙,这个狗子还有个叫做 newRefreshTask 的曾用名啊。

最终,找到了 newRefreshTask 第一次出现的地方,就是 2015 年 7 月 4 日:

分享一个我看源码时的小技巧。

这就是看门狗的生日,距离今天不到两个月了,我提前祝它生日快乐。

分享一个我看源码时的小技巧。

但是,我不得不吐槽一句。

关于看门狗的这一次提交,提交了非常多的东西。可以在这次提交上右键,然后点击下面框起来的选项:

分享一个我看源码时的小技巧。

就能看到这次提交的所有东西:

分享一个我看源码时的小技巧。

提交了 31 个文件,其中包含了看门狗机制。

但是提交的 commit 信息非常简陋,只体现了因为涉及到事务操作,所以使用了 LUA 脚本的这一个特性。

这就是一个非常不好的 commit 提交示例。

但是你转念一想,你每次提交的时候示例是怎么写的,是不是也经常偷懒。

别问我是怎么知道。

分享一个我看源码时的小技巧。

所以,每次提交的 commit 信息还是要认真写的,因为你要知道,总是有我这样无聊的人,会去翻一些没啥卵用的知识点出来。

比如我问你,我找看门狗机制的这段描述,除了让你知道它的生日和几个曾用名之外还有什么卵用吗?

是的,没有。

恭喜你又学到了一个没啥卵用的知识点。

再来一个

我再带你看一个项目,Dubbo。

还是按照我前面说的,把项目拉下来,然后点击这里的 log,就可以看到整个项目历史上的所有提交:

分享一个我看源码时的小技巧。

拉到最下面,可以找到历史上第一次提交的情况:

分享一个我看源码时的小技巧。

第一次提交是梁飞在 2011 年 10 月 20 日 23 点 04 分提交的。

但是从提交的 commit 信息来看,我们也知道这是一次空提交。

真正的第一次提交是 2 分钟之后的 23 点 06 分:

分享一个我看源码时的小技巧。

9 个模块,共计 669 个文件,就是日后这个一路坎坎坷坷、几近夭折、友商续命,最终成为 Apache 顶级开源项目的雏形。

11 年前的 10 月 20 日,梁飞从晚上 23 点干到了凌晨 5 点 25 分,终于给 Dubbo 打上了第一个里程碑 tag:2.0.7。

分享一个我看源码时的小技巧。

期间,还发布了一个微博:

分享一个我看源码时的小技巧。

而他自己,第二天的中午,也在自己的博客上公布了这件事情:

https://www.iteye.com/blog/javatar-1206888

分享一个我看源码时的小技巧。

为什么 Dubbo 会选在这一天进行开源呢?

我想应该是为了赶上两天之后的 Qcon 全球软件开发者大会:

分享一个我看源码时的小技巧。

那一天,才是 Dubbo 真正意义上,站在大众视野里,接受赞扬与嘲讽的开始。

在 idea 的视图里面,还可以过滤指定的人提交的记录。

比如梁飞就用过下面这几个账号提交代码:

分享一个我看源码时的小技巧。

我过滤了一下,发现多达 1294 次,最后一次提交在 2015 年 4 月 1 日:

分享一个我看源码时的小技巧。

而且我还发现他特别能肝,类似这样时间点的提交记录有好几处:

分享一个我看源码时的小技巧。
分享一个我看源码时的小技巧。
分享一个我看源码时的小技巧。

然后我还找了几个类,想看看经过 10 多年的发展,这些类中还留下多少他的代码。

首先我给你看看这个负载均衡策略相关的类 AbstractLoadBalance.java。

在这个类上右键,然后选择 git->Annotate 就可以调出左边的(时间-用户)的视图:

分享一个我看源码时的小技巧。

这就表示的是当前这个类,每一行代码是谁在什么时候提交的。

还是可以看到梁飞的身影。

而且我给你看看这个:

分享一个我看源码时的小技巧。

这个方法是 Dubbo 启动的时候,给新机器预热,一点点的给权重。第一分钟给 10% 的流量,第二分钟给 20% 的流量...第十分钟这个时候机器基本上已经经过充分的预热,所以可以给到 100% 的流量。

至于为什么要预热呢,这个就和 JVM 相关了,你如果感兴趣的话,可以去研究一下。

就是这个功能,这一个核心方法,经过 10 多年时间,除了一点微调,其核心算法、核心逻辑没有发生一点变化。

再比如,我给你看看最少活跃数负载均衡策略的实现 LeastActiveLoadBalance.java:

分享一个我看源码时的小技巧。

从初始化提交之后,一共就没修改过几次。

但是你要知道每次提交都是有它的意义的,比如这两次:

分享一个我看源码时的小技巧。

一次提交是把变量 leastIndexs 修改为 leastIndexes,因为 index 是 x 结尾的,以 s、x、sh、ch 结尾的名词,它的复数形式应该是加 es。这是一个英语小知识。

分享一个我看源码时的小技巧。

一次提交是把 Random 替换为 ThreadLocalRandom,因为后者性能更好,这是编程小知识,背后的原因是值得深挖的。就看有没有有心人了。

你也可以对比一下,初始版本和当前最新的版本,核心算法、核心逻辑基本没有发生变化:

分享一个我看源码时的小技巧。

这两个类告诉我一个什么道理?

比起业务代码的增删改查,只有算法,稳定的算法才是更容易再岁月的长河中留下来的,而且历久弥新。

然后,再回到 log 的标签中,你会发现一个很奇怪的现象。

整个 2014 年到 2015 年,都没有提交过几次代码:

分享一个我看源码时的小技巧。

其实从 2013 年开始到 2017 年基本上就没多少提交了。

这是为什么呢?

这就不得不说一下 Dubbo 坎坷的一生了。

前面说了,2011 年它是属于出生豪门,从阿里开源走了出来。

但是在 2012 年 10 月 23 日,Dubbo 2.5.3 发布后,阿里就基本上停止了对于 Dubbo 的维护升级。

然后一直到 2017 年 9 月 7 日,Dubbo 悄悄在 GitHub 发布了 2.5.4 版本。随后,又迅速发布了 2.5.5、2.5.6、2.5.7 等版本。在 10 月举行的云栖大会上,阿里宣布 Dubbo 被列入集团重点维护开源项目,这也就意味着 Dubbo 起死回生,开始重新进入快车道。

在 2012 年到 2017 年这五年间,当当网自己拉了一个 Dubbox 的分支开搞,相当于帮 Dubbo 把命给续住了。

2018 年 1 月 8 日,Dubbo 2.6.0 版本发布,新版本将之前当当网开源的 Dubbox 进行了合并,实现了 Dubbo 版本的统一整合。

然后 2018 年 2 月,阿里巴巴宣布将 Dubbo 捐献给 apache,进入 apache 孵化器。

2019 年 5 月 21 号,经过了漫长的孵化期,Dubbo 迎来了毕业。成为Apache基金会顶级项目。

之后的故事你应该也就知道了,Dubbo 现在都搞到 3.0 了,准备在云原生的赛道上发力。

所以你看,这妥妥的就是一个爽文的套路啊。

这就是一个富家子弟不慎流落街头,被人收养,悉心照料,最后在一片惊呼中,又重回巅峰的故事啊。

那么这个故事告诉了我们一个什么道理呢?

它告诉我们,有个好爸爸真的是太好了。要是 Dubbo 不是阿里开源出来的,起死回生是很难了,对半已经是消失在历史的长河中了。

话说回来,前面提到的这些东西,都是可以由我这篇文章给你提到的这个 idea 的视图衍生出来的。

而且我只是给你介绍了一些非常常规的用法,你可以自己去挖掘出更适合你自己的关注点。

这玩意,平时自己没事,拉个自己感兴趣的项目下来,看看提交记录,看看新特性。

就像我前面说的,每次提交都是有它的意义的,有的提交背后是值得深挖的,就看有没有有心人了。

你说,这玩意难道不比小说好看吗?

分享一个我看源码时的小技巧。

欢迎关注公众号why技术,第一时间接收最新文章。

发表评论

相关文章