令人生畏的源码,到底该怎样看?

简介:

一个软件开发人员,工作到了一定的年限(一般是3、4年左右),如果他还没学会阅读源码,那么他就会遇到瓶颈。因为到了这个时候的开发,他应该不仅仅只会做那些 CURD 的业务逻辑,而应该会根据公司的实际情况去写框架。

而基本上没有谁能像天才一样从零写出一个框架,很多人写框架其实都是从模仿开始的。而你要模仿,那么你首先得看得懂框架源码才行。所以说阅读源码才显得那么重要。

我在工作一两年的时候有尝试去看过 JDK 的源码,那时候感觉就跟看天书一样,看一点都觉得痛苦。一直到工作三年左右,因为同事都在看源码,我也开始看一些源码。

我看的第一个框架的源码是 dubbo,虽然说没有完全搞懂它。但是通过阅读 dubbo 源码,我弄懂了 JDK 的 SPI 机制,知道 SPI 在框架开发中的作用。一直到最近阅读公司的一个网关框架,我才慢慢有一点阅读源码的经验和套路。正好趁热打铁,把这些经验写下来,希望你们也能早日踏上源码阅读之路。

一、搜索网上资料

阅读一个框架的源码,最基础的操作肯定是扫一遍网上的各种分析文章。通过这个操作,你可以对这个框架有个大致的了解。站在巨人的肩膀上,少走许多弯路。但如果你看的项目是公司内部的框架,那么你只能找公司内部的文档了,更甚者,有些连文档都没有。那么你可以略过这一步。

二、扫一遍源码

当你拿到框架的源码的时候,你可以大致把源码的每个包,以及每个包下面的文件扫读一遍。扫读并不需要你弄清楚每一行代码的意思,只需要让你知道源码每一部分的作用。

如果一个开源框架足够标准,那么他的命名是非常语义化的。所以我们扫读的时候,通过包名、文件名就可以判断出这个包是用来干嘛的。

例如 util 包是工具类,那我们可以直接跳过。vo 包是存放实体模型的,同样可以跳过。protocol 包是存放协议相关的等等。通过这么一个步骤,你会对整个项目有一个基本的印象,知道这个项目大概有哪些东西,哪些相对比较重要。

三、找到入口

阅读任何一个框架的源码,首先就是要找到框架的入口。通过上面扫读源码,你应该能够发现一些入口的迹象,例如对于 Dubbo 来说,你会发现它有一个名为 dubbo-demo 的子模块,那么我们肯定重点看它。

进一步发掘需求你会发现它的入口就是 dubbo-demo 中的 Provider 类、Consumer 类。我们可以直接接运行这两个类的 main 方法,并一步步跟踪代码的执行情况。

四、通读源码

找到入口之后,下一步就是通读所有源码了,就是把源码的每个文件每一行都看一遍。在这个阶段不求完全弄懂细致的业务逻辑,但是要形成一个大概的框架,知道这个框架是如何设计的,有哪些大致的模块,这些模块是如何设计的。

在通读源码这个阶段是最枯燥无味的,也是最容易放弃的。一方面因为源码实在过于多,另一方面因为没有一个目标,所以看着看着心里没有底,所以容易放弃。我一开始也是如此,但之后我想出了一个比较好的办法,通过数字化的方式让自己知道阅读进度。这样自己就不会觉得心里没底,不知道要多久才能看完了。

我的方法是给我的 IDE 装一个代码统计插件:Statistics。这个插件能够统计项目中的源码行数。例如下面是我统计 dubbo 项目源码的截图,它会列出每个 java 文件的源码行数,以及总共的行数。

6db0914c87e56cfcdc2bba0002fd360c4f074f78

从上面的截图我们可以看到 dubbo 项目里,源码的行数有 11 万行。这样一来,自己心理也有个大致的预期了。接下来,我会把这些数据拷贝出来,放在一个 Excel 表格里,就像下面这样子:

d33a7dfc17036e54c74f47e04fc483e1854108bd

在 Excel 表格中,我只会存放每个源码文件的名字、其源码行数、源码行数占比。接下来我会按着入口,一个个去看源文件,把每个方法看过一遍,看过的方法我会写一个注释,例如:csy mark,并写上我的注释。

当我把一个文件都看过之后,我会把 Excel 表格中对应的文件最右边一列,写上其百分比。最后我会在下边有一行,统计我所看完文件的百分比。

7b7e28b52ef6598a46b43da2d739bfe198ef76f5

我每看完一个方法,我就写一个 csy done 来鼓励下自己。每看完一个文件,我就在 Excel 中把它标记为完成,最下边的已读百分比也会跟着不断升高。通过这种方式,我让枯燥无味的源码阅读,有些一点趣味,有了一些目标。

通读源码是最枯燥的,最容易没有方向和目标的。有了数字化的记录,你可以知道自己现在的进度是怎么样,看了多少的源码。很多时候我们看了很久,发觉没什么进度的样子,又不想看了。

这时候你可以给自己定一个目标,例如:一天看完 5% 的源码就可以休息。那当你想偷懒的时候,看看 Excel 下方的已读百分比,还没到 5%,继续看吧。

这种方式对于我来说,还是有一定作用的。但对于你们不知道有没有作用,你们可以尝试一下。如果有用的话,就来评论告诉我吧。

五、梳理框架

在通读源码的过程中,你就会对框架有许多新的认识,会知道这个框架大致分为哪几个部分,每个部分的作用是什么,这个模块用了什么设计理念等等。

如果说上个阶段是通读源码,那么这个阶段就是要把你在通读源码过程中的收获整理出来。在整理的过程中,你肯定会有更多的疑问,你会不断地细化,不断地精读。

六、批判性思考

通过了上面几个阶段,你会发现你对这个框架有了整体的认识,并且对每个模块的实现细节都有了比较深刻的认识。这个时候,你可以想一想为什么它要这么做,这么做有什么好处,那能用另一种方式做得更好吗?

七、总结

上面几个阶段是我阅读几个框架源码之后的一些体会,相信会是一个不错的源码阅读指南。如果你有更好的源码阅读经验或方法,欢迎留言与我交流。


原文发布时间为:2018-09-4

本文作者:陈树义

本文来自云栖社区合作伙伴“Java后端技术”,了解相关信息可以关注“Java后端技术”。

相关文章
|
6月前
|
算法 NoSQL 安全
30万的源码和300的源码有什么区别?
价格差异巨大的源码(30万对300)主要区别在于质量、完整性和技术支持。高质量源码通常有清晰结构、高效算法、良好文档,提供全面的技术支持,安全稳定且来自信誉良好的开发者。而低价源码可能存在问题、缺乏文档和支持。选择时需结合实际需求,注意测试和评估。示例中的AI导诊系统和云HIS系统源码,提供完整文档、数据库和二次开发支持,适用于不同场景,能有效提升开发效率和项目质量。
30万的源码和300的源码有什么区别?
|
6月前
看源码的方法
看源码的方法
94 1
|
JavaScript
源码
源码
|
程序员 开发工具 C++
|
消息中间件 网络协议 Java
eventMesh源码学习
eventMesh源码学习
204 0
|
安全 Java
ReentranLock源码学习
线程的三大特性:原子性、可见性、有序性。也就是说满足这个三个特性的操作都是可以保证安全的,如Atomic包、volatile、通过happensBefore原则可以进行线程的安全的判断,这个依据通常是为了避免jvm指令重排。比如通常我们知道的配置信息,如果有多个线程去进行配置信息的修改,则需要进行上锁。或者多个线程修改一个变量时,此时就需要进行上锁了,或者读写分离时,可以考虑ReentrantReadWriteLock等。其本质是解决并行中的问题,将并行转成串行问题进行解决。那怎么上锁才有用呢?锁的状态大部分情况下是互斥的。当然也有特例:ReentrantReadWriteLock的读读是不会
95 0
ReentranLock源码学习
|
存储 人工智能 安全
C++学习必备——文章中含有源码
C++学习必备——文章中含有源码
120 0
C++学习必备——文章中含有源码
openFrameworks下的肤色检测源码
openFrameworks下的肤色检测源码
168 0
|
存储 Android开发 C++
看Ogrekit源码的小结
看Ogrekit源码的小结
111 0
|
算法 NoSQL 前端开发
为什么要看源码、如何看源码,高手进阶必看
为什么要看源码、如何看源码,高手进阶必看
273 0