怎样阅读源代码?

软件工程师磨炼技艺的方式有许多,而读优秀项目的源码,是这些方式中学习其他人的经验和方法,快速进步的很重要一种方式。古人云:

独学而无友,则必孤陋寡闻!

读优秀的源码,就如同和高手交谈,无形中有胜过若干书的感觉。在代码中,我们能看到高手对于软件的设计,代码的组织,变量和方法的方法的命名,甚至通过多个版本能观察到作者对于项目不同时期的思考,对问题的修订方式,或者注释中流露出的幽默!

调试环境搭好之后,一切就绪,剩下的就是深入源码了。我们今天来谈关于源代码的阅读。

以下是我个人对于源码阅读的一些体会,欢迎朋友们在文末留言交流!

首先,源码的阅读是以目的为导向的。不同的目的决定了阅读源码的方式的不同。
例如,为了解决某个使用某个框架中存在的问题,你可能会从问题的出发点,逐步深入到相关的类与方法,而在解决了问题之后,可能就不会有兴趣再把夫关的代码再读下去了。

而如果是以深入分析某个软件的原理这个点出发,则会对软件的各个部分都有兴趣,从而深入各个模块,分析实现。

还有些时候,是为了特定的目的,比如为了针对面试中可能遇到的源码问题,会看一下HashMap,ArrayList等JDK源码的实现。

就我个人而言,这几种情形也都遇到过。当时在使用Spring data jpa的时候,框架的某个特定版本,对于@Column这个注解,如果只指定了length,而没有指定对应的name,这个时候,生成的sql就会有问题。为了解决这个问题读过这部分相关的源码。

而之前由于从事应用服务器的开发,所以需要了解应用服务器的运行原理,就需要深入下去,去读开源的应用服务器实现,像GlassFish/Jetty/Tomcat这些,当然,看的最多的还是Tomcat。

还有一次,在开发一个应用服务器监控应用的时候,为了通过MBean Server来获取对应服务器的监控数据,需要attach到相应的JVM上。我们的一个老的版本并没有提供对应的MBean Server的JMXURL,这个时候,观察到JConsole可以通过某个JVM进程,直接attach到这个进程上,并不需要url,为了学习和使用这种实现方式,从OpenJDK中把JConsole的源码找了出来。一读才发了解了,原来是JVM自带的attach机制,通过VirtualMachine连接上去。这JVM的进程,是通过指定的temp.dir中的pid文件来获取的,阅读源码后,让功能的实现更快速清楚。

以上是从阅读源码的不同目的来看源码的阅读,读源码的方式,到底要怎么读下去呢?

还是接着上面的目的来说,只关心某个类或实现方式,可以找特定范围内的内容进行阅读即可。而对于想深入了解某一类的软件的运行及实现原理时,就需要按功能主线进行入手,不能眉毛胡子一把抓。

例如读Tomcat的源码时,启动流程是一条线,部署流程是一条线,请求响应是另一条线。抓住一条线后,进行阅读,但此时不需要特别深入每一个细节,先把主要的点把握住之后,再深入一条线中的某个线段。例如启动的时候其实也会涉及到应用的部署,也会涉及到应用的类加载器,甚至是配置文件的解析,多个配置文件的merge等。
而请求响应时,又会涉及到参数的解析,对于不同请求后缀的响应处理,请求资源的初始化等。

点会有很多,在有了大致思路后,再深入各个点,最终各个点会相互促进理解,多个点连成一条线。

其次,源码的阅读,也是磨炼调试技巧的过程。在阅读源码的过程中,为了从某个功能点来深入一条线的流程,就需要各种加断点,debug,增加log,画图等,各种调试手段的综合使用,更能快速流畅的读源码。

最后,源码的文档、单测都是很好的下手材料。当拿到一堆代码不知道从何入手时,可以先看看文档,或者直接从单测入手。单测中以更细粒度的功能点组织,可以快速看到某个功能相关的类。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,575评论 25 707
  • 点击查看原文 Web SDK 开发手册 SDK 概述 网易云信 SDK 为 Web 应用提供一个完善的 IM 系统...
    layjoy阅读 13,347评论 0 15
  • 从三月份找实习到现在,面了一些公司,挂了不少,但最终还是拿到小米、百度、阿里、京东、新浪、CVTE、乐视家的研发岗...
    时芥蓝阅读 42,018评论 11 349
  • 前两天给妈打电话,聊天过程中说,外公给自己和外婆买了一对金戒指。我在这一头冲着电话咯咯乐,说外公也懂了浪漫...
    阿水和绿豆阅读 202评论 2 2
  • 小倩大名叫李倩,人如其名,在灰头土脸的村子里,水灵灵俏生生,是知名的美人。 小时候在村子里走着,但凡有儿子的父...
    崔天资阅读 587评论 0 2