谈谈加速源码理解的几种方法

尝试总结一下本人在看Spring,SpringMVC,Tomcat,Mybatis,Druid,Log4j2等源码过程中的一些基本核心理念。知晓它们能加速你对源码的理解。

1. 拦截性接口和事件通知

  • 在重要的过程上设置拦截接口
  • 重要的状态的变更发送事件并留出监听接口

梁飞大神在发表于2010/7/5的博客一些设计上的基本常识 里完整详尽地阐述了这两个观点(虽然2010年这篇博客就发表了,但本人直到2016年才看到这篇博客,真是相见恨晚)。这也是当时本人入行四年来极其少有的看到有人愿意如此透彻明了地讲述一些根本性的理念,一点都不藏着掖着(上一次能给予本人以类似重塑三观的观点的是在SICP一书中)。 强烈建议各位去拜读下这篇大作。虽然时隔快八年了,但其中阐述的“道”是历久弥新的;在现在层出不穷的”新“框架里新瓶装着这些老酒。

在阅读源码中,你会发现这两个原则或原模原样,或多穿件衣服一而再再而三地出现在你面前

其它的诸如“平等对待第三方”,“微核+扩展”等我就不越疱代俎了。总而言之,这篇文章能直接带你进入快车道。

2. 带着问题去看

老生常谈;但是我还是得强调一下。因为读源码不是我们的目的。拿Spring举例,我在阅读完Spring的核心实现之后, 就很少主动去看Spring相关的源代码了,只有在碰到相关问题时,才会刻意去读下相关的实现。

绝对不要漫无目的地去阅读源码。关于这一点就不展开了。

3. 忽略细节

本人一再强调知道自己不该自己什么同等重要。要学会容忍混沌,这是一种普世的哲学。

软件由无数的抽象层叠加而成,不论你当前处在哪一层,往下看你都将看到黑盒。所以知道自己该在哪里停下显得尤其重要,甚至相比较知道自己该知道什么而言更重要

4. 考虑从低版本入手

可以故意读一些低版本的来降低难度。当然前提是Spring这种平滑过渡的。那种暴力升级的框架还是老实跟着最新版本跑吧。

5. 学会看堆栈

这里就不废话了,直接上图,这是本人最近在写SpringMVC源码相关博客时的截图,通过跟踪相应的栈帧,我们可以快速地定位到我们所关心问题的可能出处。


DispatcherServlet堆栈

6. 画时序图

2017/12/18 补充

把非常重要的一个方法给忘记了!本人看的第一个源码就是Spring。而在看Spring源码时本人连Spring的Hello World都写不出来,而是直接抄起一本《Spring源码深度解析》就开干了。

刚开始为了“节省时间”,直接一页页地翻,到100多页时就彻底跟不上了。无奈之下,从头开始,跟着作者的步伐走,学着去画时序图。

两年后的现在,如果让我重新选择的话,我会第一时间打开PowerDesigner新建一个时序图的画布。

7. 关注命名

2018/4/26 补充

关于代码编写规范的书籍和文章有很多,它们中彼此之间的有些观点不尽相同,极端点的时候甚至向左。而对于命名方面,这些书籍或文章却都无一例外地将其摆在极其重要的地位。

一个优秀的,经过时间考验的框架,其命名必然是被反复检验过的(所以个人认为,阅读源码除了理解它们蕴含的理念外,它们的命名也是非常值得学习的,鄙人就专门有一份笔记记录着从各个源码收集来的命名),是非常值得我们投入精力去关注的。例如上面第三条里的“忽略细节”,当我们忽略细节之后,必须得有些事物来协助我们,帮助我们理解这堆代码是在做什么。而命名此时正是我们的得力助手,好的命名能分担绝大多数的注释,Bob大叔甚至认为代码里的注释应该尽最大可能用命名代替。他提出“不要双语种编程”——英语也是一种语言。当时阅读完《Clean Code》,鄙人整整半年没写过注释。

说了这么多,其实就是为了强调,利用好源码里的命名,可以让你对于源码的理解将更上一个台阶。

8. 善用grep命令

2018/12/01 补充

有时候即使使用IDE来进行源码阅读,有些类的引用情况或者Constant字符串(例如一些框架打印出来的日志,我们尝试进行反向追踪时)的引用我们也未必能百分之百地进行定位,我们一般只能大致确定其所在的package, 甚至只能确定到jar,这会让我们感到很被动,此时如果能借助Linux命令行工具的话,这些问题就能引刃而解了。

# 在spring-rabbit源码路径下执行命令,我们就能准确定位Rabbit关闭Channel的逻辑和时机了: 
grep -irn --color 'Closing cached Channel' org --include *.java

9. 掌握一些IDE调试技巧

2019/10/08 补充

参见博客: 【效率】- Eclipse调试技巧

10. 留意程序运行时候的输出日志

2020/05/31 补充

程序运行时候的输出日志被誉为发生线上故障的救命法宝。不论在调试源码还是理解既有项目结构时候,通读程序完整的输出日志都有助于你从一个全局的视野快速把控程序的一些关键要素。毕竟日志输出也是程序员一行行代码敲出来的,作者没有必要给自己增加非必要工作量。

11. 善用chatgpt

2023/04/07 补充

作为人类迄今为止所有知识的集合体,能够解答万物的存在,chatgpt的表现惊艳了全世界。作为排头兵的程序员,没有道理不用好这把快刀。

12. 选择一款好的IDE (强烈推荐IDEA)

2023/07/02 补充

自入行Java研发以来,我一直都是将Eclipse作为自己的主力IDE,并且在其中投入了不少精力来掌握其技巧,再加上”年纪大了容易念旧,不愿接受新鲜事物“,这个习惯一直保持了现在。

但是,这里我必须承认,IDEA在阅读源码时的优秀表现,作为一款商业级IDE,它确实在用户体验方面要做得好很多。举几个我实际遇到的例子:

  1. 针对配置项的智能提示。这一功能可以大大降低我们猜测和设置第三方框架配置项时的难度,增加用户学习和理解相关配置项的积极性。


    image.png
  2. 查找配置项实际定义,以及生效的位置。关于这一点我在eclipse中尝试是没有成功的。


    image.png
  3. Maven依赖关系分析。 针对这一点eclipse中采用的是树形列表结构,而人类作为视觉动物,IDEA的图表效果展示更加吸引人。

  4. 等等。

而且,以上功能都是开箱可用的,对于新手而言,你应该将精力尽量放在主要矛盾上,而非所谓"牛逼的程序员都是用记事本做开发的"。

网上对于IDEA一边倒地推荐是有其道理的。哪怕你因为种种原因选择了Eclipse,那么至少在阅读源码或者遇到问题的时候,想起来在IDEA中试试。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,560评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,104评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,297评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,869评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,275评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,563评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,833评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,543评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,245评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,359评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,006评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2 273
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2 268