【实用】面对枯燥的源码,如何才能看得下去?

简介:

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

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

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

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

搜索网上资料

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

扫一遍源码

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

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

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

找到入口

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

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

通读源码

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

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

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

fc258b990dbfb71186bf6e24bb6cdeec557b89f3

从上面的截图我们可以看到 dubbo 项目里,源码的行数有 11 万行。这样一来,自己心理也有个大致的预期了。

接下来,我会把这些数据拷贝出来,放在一个 Excel 表格里,就像下面这样子:

22a0fe023b3c5d07a204bf88919742bcc9a2059a

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

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

e6db83dfcf83f693e7cb2cb32729fe6afed3ce58

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

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

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

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

梳理框架

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

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

批判性思考

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

总结

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


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

本文作者:陈树义

本文来自云栖社区合作伙伴“程序猿DD”,了解相关信息可以关注“程序猿DD”。

相关文章
|
5天前
|
机器学习/深度学习 人工智能
技术人的四大「造神」学习法,为啥就没人好好用呢?
技术人的四大「造神」学习法,为啥就没人好好用呢?
12 2
|
9月前
|
设计模式 存储 JSON
如何写出一手好代码(上篇 - 理论储备)?
技术能力是研发同学的立身之本,而写代码的能力又是技术能力的重要体现。但可惜的是理想很丰满,现实很骨感。结合慕枫自己的经验来看,我们在工作中其实没那么容易可以看到写得很好的代码。
|
9月前
|
SQL 存储 缓存
系统设计不知怎么入手?一文帮到你
系统设计不知怎么入手?一文帮到你
78 2
|
11月前
|
NoSQL Java 程序员
要学的东西太多,自己能力不足,很焦虑怎么办
总有人问我,兔哥,现在java要学的知识点这么多,记不住,怕学不精很焦虑怎么办? 这是很多初学者都有的痛点。 其实吧,你可以试试贪多而不必嚼烂。
137 0
|
测试技术
初级软件测试面试题怎么找?提供的这两个地方你肯定用得上
最近几年,随着电子产品和互联网的蓬勃发展,各类科技公司如雨后春笋般出现,而软件公司作为科技类公司中的重要组成部分,在这支互联网大军中也占据了重要一席。因而,负责软件问题质检的软件测试岗位也逐渐成了这几年炙手可热的就业岗位之一。
106 0
|
SQL Web App开发 缓存
吊打面试官系列之:我这样回答 “如何更高效的进行接口测试“,面试官果然跪了。
吊打面试官系列之:我这样回答 “如何更高效的进行接口测试“,面试官果然跪了。
30890 0
谈谈讲清楚这件事的重要性
如何讲清楚一件事我相信很多人都很困惑也很无助,尤其是在晋升场合,在向上汇报或者是做大范围分享的时候,恨不得找个地缝钻进去。很多时候我们常常是这样安慰自己,我是实干派技术人,不需要那些花里胡哨的东西,我技术过硬比什么都重要。曾经一度我也是这样认为,最后改变我这个想法的是一句话:如果你讲不清楚多半是想不清楚,如果你都想不清楚如何能够带领更多人拿到结果?
1561 1
|
测试技术
软件测试怎么学 两种学习方式总有一个适合你
近几年随着国内互联网的快速崛起,IT行业也兴起了一个新的行业,叫做软件测试,因为各大企业越来越重视软件的测试了没,所以越来越多的人开始加入了测试大军中,但由于软件测试在我国的发展时间并不长,所以大家都想要知道如果要从事软件测试行业,该怎么学习呢?
136 0
软件测试怎么学 两种学习方式总有一个适合你
|
消息中间件 运维 Dubbo
源码阅读的方法、误区以及三种境界
源码阅读的方法、误区以及三种境界
|
数据采集 小程序 搜索推荐
吐血整理!程序员常见的几种变现方式!
吐血整理!程序员常见的几种变现方式!

热门文章

最新文章