分享我在阅读源代码时学到的一个小窍门。
你好呀,我是歪歪。
我在之前的文章里面不是经常叫大家拉源码,然后看代码提交记录吗。
也就是看类似于这个界面:
比如上面这个界面中,就可以看到 RedissonBaseLock.java 这个文件,由谁在什么时候进行过变更,以及变更对应的 commit 信息是什么。
这样就能很直观的看到文件的演变过程。
那么问题就来了,有好几个同学都问过我这个问题:怎么在 idea 里面查看 git 提交记录呢?这个界面是藏在哪里的呢,我的 idea 里面怎么没有呢?
好的,是我疏忽了,我先入为主的认为这个大家应该都知道是怎么来的。
但是确实是有一些同学是不太清楚的,那我这篇文章就给大家分享一下我通过这个东西看源码的一点点小技巧,希望能帮助到你。
怎么搞出来?
那么怎么把这个视图搞出来呢?
首先,你本地得有一个 git.exe。
这个玩意怎么来的,就不用我说了吧,如果连这个都没有,说明你之前还没有接触过 git,那就是另外一回事儿了,不在本文讨论范围内。赶紧去安装一个 git,然后学学 git 的用法啥的。
我个人的习惯是先用 gitbash,也就是这个玩意,从 github 上 clone 一个项目下来:
比如我就用之前写文章的 Redssion 做演示吧,你也可以随便找一个自己感兴趣的开源项目。
执行下面命令把项目下载下来:
git clone github.com/redisson/re…
下载完成之后,打开你的 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:
github.com/redisson/re…
在这里面,就是直接关联了一个 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。
期间,还发布了一个微博:
而他自己,第二天的中午,也在自己的博客上公布了这件事情:
www.iteye.com/blog/javata…
为什么 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技术,第一时间接收最新文章。
推荐阅读
-
分享我在阅读源代码时学到的一个小窍门。
-
今天,我要与大家分享我在 Chatgpt 和 Ai 绘画与航海中学到的一个小技巧!
-
F#探险之旅(二):函数式编程(上)-函数式编程范式简介 F#主要支持三种编程范式:函数式编程(Functional Programming,FP)、命令式编程(Imperative Programming)和面向对象(Object-Oriented,OO)的编程。回顾它们的历史,FP是最早的一种范式,第一种FP语言是IPL,产生于1955年,大约在Fortran一年之前。第二种FP语言是Lisp,产生于1958,早于Cobol一年。Fortan和Cobol都是命令式编程语言,它们在科学和商业领域的迅速成功使得命令式编程在30多年的时间里独领风骚。而产生于1970年代的面向对象编程则不断成熟,至今已是最流行的编程范式。有道是“*代有语言出,各领风骚数十年”。 尽管强大的FP语言(SML,Ocaml,Haskell及Clean等)和类FP语言(APL和Lisp是现实世界中最成功的两个)在1950年代就不断发展,FP仍停留在学院派的“象牙塔”里;而命令式编程和面向对象编程则分别凭着在商业领域和企业级应用的需要占据领先。今天,FP的潜力终被认识——它是用来解决更复杂的问题的(当然更简单的问题也不在话下)。 纯粹的FP将程序看作是接受参数并返回值的函数的集合,它不允许有副作用(side effect,即改变了状态),使用递归而不是循环进行迭代。FP中的函数很像数学中的函数,它们都不改变程序的状态。举个简单的例子,一旦将一个值赋给一个标识符,它就不会改变了,函数不改变参数的值,返回值是全新的值。 FP的数学基础使得它很是优雅,FP的程序看起来往往简洁、漂亮。但它无状态和递归的天性使得它在处理很多通用的编程任务时没有其它的编程范式来得方便。但对F#来说这不是问题,它的优势之一就是融合了多种编程范式,允许开发人员按照需要采用最好的范式。 关于FP的更多内容建议阅读一下这篇文章:Why Functional Programming Matters(中文版)。F#中的函数式编程 从现在开始,我将对F#中FP相关的主要语言结构逐一进行介绍。标识符(Identifier) 在F#中,我们通过标识符给值(value)取名字,这样就可以在后面的程序中引用它。通过关键字let定义标识符,如: let x = 42 这看起来像命令式编程语言中的赋值语句,两者有着关键的不同。在纯粹的FP中,一旦值赋给了标识符就不能改变了,这也是把它称为标识符而非变量(variable)的原因。另外,在某些条件下,我们可以重定义标识符;在F#的命令式编程范式下,在某些条件下标识符的值是可以修改的。 标识符也可用于引用函数,在F#中函数本质上也是值。也就是说,F#中没有真正的函数名和参数名的概念,它们都是标识符。定义函数的方式与定义值是类似的,只是会有额外的标识符表示参数: let add x y = x + y 这里共有三个标识符,add表示函数名,x和y表示它的参数。关键字和保留字关键字是指语言中一些标记,它们被编译器保留作特殊之用。在F#中,不能用作标识符或类型的名称(后面会讨论“定义类型”)。它们是: abstract and as asr assert begin class default delegate do donedowncast downto elif else end exception extern false finally forfun function if in inherit inline interface internal land lazy letlor lsr lxor match member mod module mutable namespace new nullof open or override private public rec return sig static structthen to true try type upcast use val void when while with yield 保留字是指当前还不是关键字,但被F#保留做将来之用。可以用它们来定义标识符或类型名称,但编译器会报告一个警告。如果你在意程序与未来版本编译器的兼容性,最好不要使用。它们是: atomic break checked component const constraint constructor continue eager event external fixed functor global include method mixinobject parallel process protected pure sealed trait virtual volatile 文字值(Literals) 文字值表示常数值,在构建计算代码块时很有用,F#提供了丰富的文字值集。与C#类似,这些文字值包括了常见的字符串、字符、布尔值、整型数、浮点数等,在此不再赘述,详细信息请查看F#手册。 与C#一样,F#中的字符串常量表示也有两种方式。一是常规字符串(regular string),其中可包含转义字符;二是逐字字符串(verbatim string),其中的(")被看作是常规的字符,而两个双引号作为双引号的转义表示。下面这个简单的例子演示了常见的文字常量表示: let message = "Hello World"r"n!" // 常规字符串let dir = @"C:"FS"FP" // 逐字字符串let bytes = "bytes"B // byte 数组let xA = 0xFFy // sbyte, 16进制表示let xB = 0o777un // unsigned native-sized integer,8进制表示let print x = printfn "%A" xlet main = print message; print dir; print bytes; print xA; print xB; main Printf函数通过F#的反射机制和.NET的ToString方法来解析“%A”模式,适用于任何类型的值,也可以通过F#中的print_any和print_to_string函数来完成类似的功能。值和函数(Values and Functions) 在F#中函数也是值,F#处理它们的语法也是类似的。 let n = 10let add a b = a + blet addFour = add 4let result = addFour n printfn "result = %i" result 可以看到定义值n和函数add的语法很类似,只不过add还有两个参数。对于add来说a + b的值自动作为其返回值,也就是说在F#中我们不需要显式地为函数定义返回值。对于函数addFour来说,它定义在add的基础上,它只向add传递了一个参数,这样对于不同的参数addFour将返回不同的值。考虑数学中的函数概念,F(x, y) = x + y,G(y) = F(4, y),实际上G(y) = 4 + y,G也是一个函数,它接收一个参数,这个地方是不是很类似?这种只向函数传递部分参数的特性称为函数的柯里化(curried function)。 当然对某些函数来说,传递部分参数是无意义的,此时需要强制提供所有参数,可是将参数括起来,将它们转换为元组(tuple)。下面的例子将不能编译通过: let sub(a, b) = a - blet subFour = sub 4 必须为sub提供两个参数,如sub(4, 5),这样就很像C#中的方法调用了。 对于这两种方式来说,前者具有更高的灵活性,一般可优先考虑。 如果函数的计算过程中需要定义一些中间值,我们应当将这些行进行缩进: let halfWay a b = let dif = b - a let mid = dif / 2 mid + a 需要注意的是,缩进时要用空格而不是Tab,如果你不想每次都按几次空格键,可以在VS中设置,将Tab字符自动转换为空格;虽然缩进的字符数没有限制,但一般建议用4个空格。而且此时一定要用在文件开头添加#light指令。作用域(Scope)作用域是编程语言中的一个重要的概念,它表示在何处可以访问(使用)一个标识符或类型。所有标识符,不管是函数还是值,其作用域都从其声明处开始,结束自其所处的代码块。对于一个处于最顶层的标识符而言,一旦为其赋值,它的值就不能修改或重定义了。标识符在定义之后才能使用,这意味着在定义过程中不能使用自身的值。 let defineMessage = let message = "Help me" print_endline message // error 对于在函数内部定义的标识符,一般而言,它们的作用域会到函数的结束处。 但可使用let关键字重定义它们,有时这会很有用,对于某些函数来说,计算过程涉及多个中间值,因为值是不可修改的,所以我们就需要定义多个标识符,这就要求我们去维护这些标识符的名称,其实是没必要的,这时可以使用重定义标识符。但这并不同于可以修改标识符的值。你甚至可以修改标识符的类型,但F#仍能确保类型安全。所谓类型安全,其基本意义是F#会避免对值的错误操作,比如我们不能像对待字符串那样对待整数。这个跟C#也是类似的。 let changeType = let x = 1 let x = "change me" let x = x + 1 print_string x 在本例的函数中,第一行和第二行都没问题,第三行就有问题了,在重定义x的时候,赋给它的值是x + 1,而x是字符串,与1相加在F#中是非法的。 另外,如果在嵌套函数中重定义标识符就更有趣了。 let printMessages = let message = "fun value" printfn "%s" message; let innerFun = let message = "inner fun value" printfn "%s" message innerFun printfn "%s" message printMessages 打印结果: fun value inner fun valuefun value 最后一次不是inner fun value,因为在innerFun仅仅将值重新绑定而不是赋值,其有效范围仅仅在innerFun内部。递归(Recursion)递归是编程中的一个极为重要的概念,它表示函数通过自身进行定义,亦即在定义处调用自身。在FP中常用于表达命令式编程的循环。很多人认为使用递归表示的算法要比循环更易理解。 使用rec关键字进行递归函数的定义。看下面的计算阶乘的函数: let rec factorial x = match x with | x when x < 0 -> failwith "value must be greater than or equal to 0" | 0 -> 1 | x -> x * factorial(x - 1) 这里使用了模式匹配(F#的一个很棒的特性),其C#版本为: public static long Factorial(int n) { if (n < 0) { throw new ArgumentOutOfRangeException("value must be greater than or equal to 0"); } if (n == 0) { return 1; } return n * Factorial (n - 1); } 递归在解决阶乘、Fibonacci数列这样的问题时尤为适合。但使用的时候要当心,可能会写出不能终止的递归。匿名函数(Anonymous Function) 定义函数的时候F#提供了第二种方式:使用关键字fun。有时我们没必要给函数起名,这种函数就是所谓的匿名函数,有时称为lambda函数,这也是C#3.0的一个新特性。比如有的函数仅仅作为一个参数传给另一个函数,通常就不需要起名。在后面的“列表”一节中你会看到这样的例子。除了fun,我们还可以使用function关键字定义匿名函数,它们的区别在于后者可以使用模式匹配(本文后面将做介绍)特性。看下面的例子: let x = (fun x y -> x + y) 1 2let x1 = (function x -> function y -> x + y) 1 2let x2 = (function (x, y) -> x + y) (1, 2) 我们可优先考虑fun,因为它更为紧凑,在F#类库中你能看到很多这样的例子。 注意:本文中的代码均在F# 1.9.4.17版本下编写,在F# CTP 1.9.6.0版本下可能不能通过编译。 F#系列随笔索引页面