你为什么要看源码?如何看源码?

6,037 阅读7分钟

前言

本文主要内容摘自加多大神的《Java并发编程之美》的前言内容,讲了为什么要看源码和如何看源码,讲的很精炼。这部分是属于源码学习方面的方法论,所以单独摘录下来并且总结。

为什么要看源码?

我们在做项目的时候一般会遇到下面的问题:

  1. 不知道如何去设计。比如刚入职场时,来一个需求需做概要设计,不知如何下手,不得不去看当前系统类似需求是如何设计的,然后仿照去设计。
  2. 设计的时候,考虑问题不周全。相比职场新手,这类人对一个需求依靠自己的经验已经能够拿出一个概要设计,但是设计中经常会遗漏一些异常细节,比如使用多线程有界队列执行任务,遇到机器宕机了,如果队列里面的任务不存盘的话,那么机器下次启动的时候这些任务就丢失了。

对于这些问题,说到底主要还是因为经验不够,而经验主要从项目实践中积累,所以招聘单位一般都会限定工作时间大于3年,因为这些人的项目经验相对较丰富,在项目中遇到的场景相对较多。工作经验的积累来自于年限与实践,然而看源码可以扩展我们的思路,这是变相增加我们经验的不错方法。虽然不能在短时间内通过时间积累经验,但是可以通过学习开源框架、开源项目来获取经验

另外,进职场后一般都要先熟悉现有系统,如果有文档还好,没文档的话就得自己去翻代码研究。如果之前对阅读源码有经验,那么在研究新系统的代码逻辑时就不会那么费劲了。

还有一点就是,当你使用框架或者工具做开发时,如果你对它的实现有所了解,就能最大化地减少出故障的可能。比如并发队列ArrayBlockingQueue里面关于元素入队有个offer方法和put方法,虽然某个时间点你知道使用offer方法时,当队列满了就会丢弃要入队的元素,之后offer方法会返回false,而不会阻塞当前线程;而使用put方法时,当队列满了,则会挂起当前线程,直到队列有空闲,元素入队成功后才返回。但是人是善忘的,一段时间不使用,就会忘记它们的区别,当你再去使用时,需进入offer和put方法的内部,看它们的源码实现。进入offer方法一看,哦,原来队列满后直接返回了false;进入put方法一看,哦,原来队列满后,直接使用条件变量的await方法挂起了当前线程。知道了它们的区别,你就可以根据自己的需求来选择了。

看源码最大的好处是可以开阔思维,提升架构设计能力。有些东西仅靠书本和自己思考是很难学到的,必须通过看源码,看别人如何设计,然后思考为何这样设计才能领悟到。

能力的提高不在于你写了多少代码,做了多少项目,而在于给你一个业务场景时,你是否能拿出几种靠谱的解决方案,并且说出各自的优缺点。而如何才能拿出来,一来靠经验,二来靠归纳总结,而看源码可以快速增加你的经验

总结一

为什么看源码呢:

  1. 通过学习开源框架、开源项目的源码,我们可以学习到多种场景多种技术的解决方案,快速增加经验
  2. 在使用某个框架或工具进行开发时,如果你对其源码有所了解,可以最大化地减少出故障的可能;
  3. 有利于你研究一个新系统的代码逻辑,快速接手一个新系统;
  4. 最大的好处是可以开阔思维,提升架构设计能力,通过看源码,看别人如何设计,然后思考为何这样设计才能领悟到

怎么看源码

那么如何阅读源码呢?

在你看某一个框架的源码前,先去Google查找这个开源框架的官方介绍,通过资料了解该框架有几个模块,各个模块是做什么的,之间有什么联系,每个模块都有哪些核心类,在阅读源码时可以着重看这些类。

然后对哪个模块感兴趣就去写个小demo,先了解一下这个模块的具体作用,然后再debug进入看具体实现。

在debug的过程中,第一遍是走马观花,简略看一下调用逻辑,都用了哪些类;第二遍需有重点地debug,看看这些类担任了架构图里的哪些功能,使用了哪些设计模式。

如果第二遍有感觉了,便大致知道了整体代码的功能实现,但是对整体代码结构还不是很清晰,毕竟代码里面多个类来回调用,很容易遗忘当前断点的来处;

那么你可以进行第三遍debug,这时候你最好把主要类的调用时序图以及类图结构画出来,等画好后,再对着时序图分析调用流程,就可以清楚地知道类之间的调用关系,而通过类图可以知道类的功能以及它们相互之间的依赖关系。 另外,开源框架里面每个功能类或者方法一般都有注释,这些注释是一手资料,比如JUC包里的一些并发组件的注释,就已经说明了它们的设计原理和使用场景。

阅读源码时,最好画出时序图和类图,因为人总是善忘的。如果隔一段时间你再去看之前看过的源码,虽然有些印象,但当你想去看某个模块的逻辑时,又需根据demo再从头debug了。而如果有了这俩图,就可以从这俩图里面直接找,并且看一眼时序图就知道整个模块的脉络了。

此外,查框架使用说明最好去官网查(这些信息是源头,是没有经过别人翻译的),虽然是英文,但是看久了就好了,毕竟还有Google翻译呐!

当然研究代码时不一定非要debug三遍,其实这里说的是三种掌握程度,如果你debug一遍就能掌握,那自然更好啦。

总结二

如何阅读源码:

  1. Google查找这个开源框架的官方介绍,了解以下信息
    • 框架有几个模块
    • 模块的作用
    • 模块之间的联系
    • 每个模块的核心类(在阅读源码的过程中,着重看核心类
  2. 对哪个模块感兴趣就去写个小demo,先了解一下这个模块的具体作用。
  3. debug进入看具体实现。(这里面可以充分使用IDEA的调试功能)
    • 第一遍是走马观花,简略看一下调用逻辑,都用了哪些类;
    • 第二遍需有重点地debug,看看这些类担任了架构图里的哪些功能使用了哪些设计模式
    • 第三遍debug,把主要类的调用时序图以及类图结构画出来,对着时序图分析调用流程

注意的点:

  • 阅读源码时,最好画出时序图和类图
  • 注释是一手资料,好的注释往往已经说明了它们的设计原理和使用场景

参考

  • 《Java 并发编程之美》