如何高效阅读源代码？

下面是之前写的一篇文章：《如何快速阅读源码》

本文探讨在需要了解一个开源项目时，如何快速的理清开源项目的代码逻辑！

以下是个人认为行之有效的方法：

本文以Mybatis为例来进行演示！

先“跑起来”

程序界有个老传统，学习新技术时都是从「Hello World」开始的！无论是学习新语言时，打印「Hello World」；还是学习新框架时编写个demo！那为什么这里的「跑起来」要打个引号呢？

实际上，当你想要阅读一个开源项目的源码时，绝大部分情况下，你已经能够使用这个开源项目了！所以这里的“跑起来”就不是写个「Hello World」，也不是能跑起来的程序了！而是能__在你的脑子里「跑起来」__！什么意思？

Mybatis你会用了吧？那么请问Mybatis是如何执行的呢？仔细想想，你能否用完整的语句把它描述出来？

这里是Mybatis的官方入门文章！你是如何看这篇文章的？读一遍就行了吗？还是跟着文章跑一遍就够了吗？从这篇文章里你能获得多少信息？

我们来理一拆判凳下：

回答出了上面这些问题！你也就基本能在脑子里把Mybatis「跑起来」了！之后，你才能正真的开始阅读源码！

当你能把一个开源项目「跑起来」后，实际上你就有了对开源项目最初步的了解了！就像「 书的索引 」一样！基于这个索引，我们一步步的进行拆解，来细化出下一层的结构和流程，期间可能需要深入技术细节，考量实现，考虑是否有更好的实现方案！也就冲扰是说后面的三步并不是线性的，而是__不断交替执行__的一个过程！最终就形成一个完整的源码执行流程！

自顶向下拆解

继续通过Mybatis来演示（限于篇幅，我只演示一个大概流程）！我们现在已经有了一个大概的流程了：

虽说每个点都可以往下细化，但是也分个轻重缓急！

很明显，SqlSession去执行 sql才是Mybatis的核心！我们先从这个点入手！

首先，你当然得先下载Mybatis的源码了（请自行下载）！

我们直接去看SqlSession！它是个接口，里面有一堆执行sql的方法！

这里只列出了一部分方法：

SqlSession就是通过这些方法来执行sql的！我们直接看我们常用的，也是Mybatis推荐的用法，就是基于Mapper的执行！也就是说「SqlSession通过Mapper来执行具体的sql」！上面的流程也就细化成了：

那SqlSession是如何获取Mapper的呢？Mapper又是如何执行sql的呢？

深入细节

我们来看SqlSession的实现！SqlSession有两个实现类SqlSessionManager和DefaultSqlSession！通过IDE的引用功能可以查看两个类的使用情况。你会发现SqlSessionManager实际并没有使用！而DefaultSqlSession是通过DefaultSqlSessionFactory构建的！所以我们来看DefaultSqlSession是如何构建Mapper的！

它直接委托给了Configuration的getMapper方法！

Configuration又委托给了MapperRegistry类的getMapper方法！

在MapperRegistry类的getMapper中：

在这里knowMappers是什么？MapperProxyFactory又是什么？mapperProxyFactory.newInstance(sqlSession)具体做了什么？

其实很简单，knowMappers是旅旅个Map，里面包含了class与对应的MapperProxyFactory的对应关系！MapperProxyFactory通过newInstance来构建对应的Mapper（实际上是Mapper的代理）！

快接近真相了，看mapperProxyFactory.newInstance(sqlSession)里的代码：

这里干了什么？

最终实际还是委托给了sqlSession去执行具体的sql！后面具体怎么实现的就自行查看吧！

延伸改进

现在我们的流程大概是这样的一个过程：

现在我们大概知道了：

那么，

这个问题列表可以很长，可以按个人需要去思考并尝试回答！可能最终这些问题已经和开源项目本身没有什么关系了！但是你思考后的收获要比看源码本身要多得多！

再循环

一轮结束后，可以再次进行：

不断的拆解->深入->改进，最终你能__通过一个开源项目，学习到远比开源项目本身多得多的知识__！

最重要的是，你的流程是完整的。无论是最初的大致流程：

还是到最终深入的细枝末节，都是个完整的流程！

这样的好处是，你的时间能自由控制：

而不像debug那样的方式，需要一下子花费很长的时间去一步步的理流程，费时费力、收效很小，而且如果中断了就很难继续了！

总结

本文通过梳理Mybatis源码的一个简单流程，来讲述一个个人认为比较好的阅读源码的方式，并阐述此方法与传统debug方式相比的优势。

阅读源码是每个优秀开发工程师的必经之路，那么这篇文章就来讲解下为什么要阅读源码以及如何阅读源码。

首先来说下为什么要读源码，有学习源码的必要吗？

为什么要阅读源码？

关于为什么阅读和学习源码，我个人认为可能有以下几点：

（一）吊打面试官，应对面试

为了找到更好的工作，应对面试，因为在面试中肯定会问到源码级别的问题，比如：为什么 HashMap 是线程不安全的？

如果你没有阅读过源码，面试官可能会对回答的结果不满意，进而导致面试结果不太理想，但如果你对源码有所研究，并能够很好地问答面试官的问题，这可能就是你的加分点，可以形成自己独特的竞争力，吊打面试官，升职加薪不是梦。

（二）解决问题（bug）

在开发过程中，我们或多或少会遇到 bug，比如：在 foreach 循环里进行元素的 remove/add *** 作，为啥有可能会报 ConcurrentModificationException 异常？

我们可以先在 Google、Stack Overflow 以及对应项目的 Issues 里看有没有类似问题以及解决办法，如果没有的话，我们只能通过阅读源码的方式去解决了。如果我们对相关源码有所涉猎，就可以快速定位到问题所在。

（三）提升编程能力

和阅读一本好书一样，阅读源码就是和编程大牛面对面交流的机会，在许多优秀的开源项目中，它们的编码规范和架构设计都是很棒的，另外在设计上也使用了大量的设计模式，通过阅读和学习源码，能够快速提升我们的编码水平，以及对设计模式有更深的理解。

同时，在我们阅读完一个源码后，可以触类旁通，能够快速地对其他框架的源码进行阅读和学习，减少时间成本。

除了上述提到的原因之外，可能还有许多，在这里就不一一赘述了，那么在确定了要阅读源码之后，就让我们看下如何阅读源码吧！

如何阅读源码？

如何阅读源码取决于你为什么要读源码，比如：

下面大概说下阅读源码的几点建议：

在阅读之前，可以先从开源项目的官网上看它的架构设计和功能文档，了解这个项目的 整体架构、模块组成以及各个模块之间的联系 。

如果没有对应的项目文档，可以根据代码的模块进行梳理，以形成对项目的初步了解，或者 查看已有的源码解析文章或者书籍 ，在阅读源码之前，了解项目的架构和思路会使阅读源码事半功倍。

在了解一个类的时候，可以使用 ctrl+F12 来查看类中的成员变量和方法。

可以通过 IDEA 的 Diagrams 功能去了解一个类的继承关系。

多打 断点调试 ，断点追踪源码是很好的阅读源码的方式，可以先通过 debug 了解下调用逻辑，都和哪些类有关联，有大致了解后再通过 debug 了解整体代码的功能实现，各个类都起到了什么作用，有没有涉及到设计模式等。

另外，优秀的开源项目中肯定会有许多地方应用到了 设计模式 ，建议在阅读源码之前，需要对常用的设计模式有大致的了解，不然阅读源码的效率会大大降低。

如果遇到读不懂某部分源码的时候，可以先跳过，之后再回来看，如果属于搞不懂这部分就茶不思饭不想的人，可以在网上找是否有该部分源码的解析或者文档，也可以自己通过 源码注释和测试用例 去阅读学习。

一般优秀的开源项目都会有 单元测试 ，可以通过对应类的单元测试去了解方法的含义和用法，加深对源码逻辑的理解。

在阅读源码的时候，可以在代码上加上 注释和总结 ，同时还可以画出 时序图和类图 ，这样对阅读源码有很大的帮助，可以很清楚地知道类之间的调用关系和依赖关系，也方便以后回顾，重新阅读。

在这里推荐大家一个 IDEA 插件 SequenceDiagram，可以根据源码生成调用时序图，便于阅读源码。

刚开始阅读源码，不建议直接看框架源码，可以先从 jdk 源码看起：

jdk 源码也是非常庞大的，可以分模块来阅读，下面是建议的阅读顺序：

其他包下的代码也可以做下了解，JDK源码阅读笔记：https://github.com/wupeixuan/JDKSourceCode1.8

再有了一定的源码阅读经验后，可以再去学习 Spring、Spring Boot、Dubbo、Spring Cloud 等框架的源码。

总结

主要介绍了为什么读源码以及如何读源码，供大家参考，每个人都有适合自己的阅读源码的方式，希望可以在学习中去摸索出一套属于自己的方式。

阅读源码不是一蹴而就的，这是持久战，只要你能够坚持下来，肯定受益匪浅。阅读源码的过程比较枯燥，可以在社群里一起讨论学习，这样可能效率更高些。

没看过源代码，都不好意思出来说了，最近刚好在看一些，来说一个。

先看使用 https://element.eleme.cn/#/zh-CN/component/installation

先看一下这个库是做什么用的，然后提供了哪些功能。

看GitHub https://github.com/elemefe

一般会看下项目最新的情况，然后没有关闭的issue，看下wiki，大家在讨论什么。

再看代码

clone 一份到本地，然后先看下目录结构，然后根据文档看几个简单的组件的时候，一边看掘金上的分析，一边自己看下实现。

e le

饿了么这个框架代码结构还是很清楚的，基本上每个组件都是分开的，所以你只要看其他的一个文件夹就行。然后一些工具的都在src文件夹。

要学会看issue，一般开源的项目都有人会来提建议，有些是bug，有些是功能，你可以看看自己是否有能力去解决，如果可以的话，你可以去fork代码，然后自己修改，再提pr。

我最近恰好找摸索出一个梳理遗留系统架构的技巧：自底向上 找到一个典型的切面 沿着调用和回调的路径 在代码中添加结构化注释（比如eclipse中加//TAG 流程A1.1 甲->>乙），这样便得到了一个code地图，并且在tasks视图中看起来很直观（看起来跟书的目录一样）可快速跳转。将目录copy到有道云笔记的markdown序列图中 就自动生成了一个序列图。

我觉得这基本上就是可缩放的可视化架构地图了，对维护一个比较乱和庞大的遗留系统非常有帮助，定位代码 修改维护都方便多了。

1、需要过硬的基础知识，这个前提。不然基本语法、常用的模式都不晓得怎么读。

2、多参考 历史 版本和更新变化，好的源码都是反复迭代出来的精华，开始就读精华是很不明智的，所以看看版本更新说明，版本的 历史 演变。就想人一样是怎样进化过来的。

3、参考别人阅读注释，想必在你读源码之前也有人读过了源码，并且总结，注释。和分享原理，可供你参考，毕竟每个人读一篇文章，理解的东西是有差异化的。

4、直接买书，有些作品直接出书就是源码精解

5、找个大神给你慢慢分析，这个最快。娓娓道来，直接面授比啥都强。缺点是，你容易跟着他的思维走下去。

我觉得阅读代码就不应该高效，而应该像看小说一样，看的过程就像是在和作者交流，有趣才是看代码的动力。

画图，看数据走向，逻辑走向

先弄清楚这些代码实现了哪些功能，然后从主线开始往下看，好的代码光看变量和接口名称就能明白是什么意思？扒出源码实现的整体框架逻辑，然后再对自己感兴趣的模块进行剖析，还是从整体把握，细节深入，慢慢地整个框架就被丰满了。

接下来是思考为什么要如此设计，这样设计的好处是什么？如果是你来做应该怎么设计，把你觉得源码缺点的地方进行仔细研究，了解里面是否包含自己不清楚的细节，避免遗漏。

接下来就是根据代码改造或者是调试错误，对于源码中遇到的不理解的地方一定要弄明白，有的确实是画蛇添足，有的有独特的作用。

多多学习，对每一种主流框架铭记于心，对主流设计模式了如指掌，万变不离其宗，源码看多了，跟看一个电视机遥控器的 *** 作说明一样。

1、一边阅读代码一边写注释。这是我用过的最好的方法，对代码理解得更深入，看一些重要代码或者特别难懂的代码时挺有用。更何况，注释也是一种文档嘛。

2、一边阅读代码一边绘制UML。这个方法适用于类之间的关系较复杂和调用层次较深的情况，我一般都是先绘制顺序图，然后为顺序图中的类绘制关系图。

3、通过Debug来跟踪程序的主要执行过程，这样就可以分清主次了，阅读的时候更有针对性。

4、类的快速阅读。先弄清楚它在继承链中的位置，看看它的内部状态，也就是成员变量，一般来说，类的对外接口都是对成员变量的访问、加工、代理等，然后看看它的对外接口，也就是公有成员函数，识别核心的一个或多个函数，这时候你应该可以大概了解这个类的职责或作用了。可能这个类是某个设计模式中的一个组成部分，所以，设计模式的掌握对代码的快速阅读也是很有帮助的。

5、带着问题去阅读。比如想了解android中的消息机制，那么看看Looper、Handler、MessegeQueue这几个类就可以了，其他的不要去看，要不然就跑题了。

下面列几个阅读源码时所处的情景，在特定场景下用哪些方法： 不太熟悉业务逻辑，还不是很清楚它是干啥的，可以用3、5。 代码量很大，有几十万行，甚至百万行，可以用2、3、5。 你无法看见程序的运行过程，比如没有用户界面，也有可能是无法运行的，可以用3、5。 设计复杂，用了大量的设计模式，调用链很深，可以用1、2、3、4、5。 时间有限，没有那么多时间让你看源码，可以用3、5。

画出逻辑流程图，先了解整体流程，再详解具体函数

首先要理清楚代码结构和业务结构（应该有些文档或者大的流程图），这是阅读具体代码的前提。

阅读Java web项目的代码：

你需要亩搭链找到

View层的代码：前端页面、图片、枝塌资源文件都在其中。

Controller层的代码：控制试图与模型层以及数据传递。

Service层的代码：业务逻辑。

Dao层的迅孙代码：数据库访问逻辑。

从web.xml - appcontext.xml - xxx

MSP430单片机简介

MSP430系列单片机是美国德州仪器（TI）1996年开始推向市场的一种16位超低功耗、具有精简指令集（RISC）的混合信号处理器（Mixed Signal Processor）。称之为混合信号处理器，是由于其针对实际应用需求，将多个不同功能的模拟电路、数字电路模块和微处理器集成在一个芯片上，以者戚提供“单片”解决方案。该系列单片机多应用于需要电池供电的便携式仪器仪表中。

MSP430单片机的特点：

1.处理能力强

MSP430系列单片机是一个16位的单片机，采困嫌如用了精简指令集（RISC）结构，具有丰富的寻址方式（7 种源 *** 作数寻址、4 种目的 *** 作数寻址）、简洁的 27 条内核指令以及大量的模拟指令；大量的寄存器以及片内数据存储器都可参加多种运算；还有高效的查表处理指令。这些特点保证了可编制出高效率的源程序。

2.运算速度快

MSP430 系列单片机能在25MHz晶体的驱动下，实现40ns的指令周期。16位的数据宽度、40ns的指令周期以及多功能的硬件乘法器（能实现乘加运算）相配合，能实现数字信号处理的某些算法（如 FFT 等）。

3.超低功耗

MSP430 单片机之所以有超低的功耗，是因为其在降低芯片的电源电压和灵活而可控的运行时钟方面都有其独到之处。 首先，MSP430 系列单片机的电源电压采用的是1.8-3.6V 电压。因而可使其在1MHz 的时钟条件下运行时，芯片的电流最低会在165μA左右，RAM 保持模式下的最低功耗只有0.1μA。 其次，独特的时钟系统设计。在 MSP430 系列中有两个不同的时钟系统：基本时钟系统、锁频环（FLL 和FLL+）时钟系统和DCO数字振荡器时钟系统。可以只使用一个晶体振荡器（32768Hz），也可以使用两个晶体振荡器。由系统时钟系统产生 CPU 和各功能所需的时钟。并且这些时钟可以在指令的控制下，打开和关闭，从而实现对总体功耗的控制。 由于系统运行时开启的功能模块不同，即采用不同的工作模式，芯片的功耗有着显著的不同。在系统中共有一种活动模式（AM）和五种低功耗模式（LPM0~LPM4）。在实时时钟模式下，可达2.5μA ，在RAM 保持模式下，最低可达0.1μA 。

4.片内资源丰富

MSP430 系列单片机的各系列都集成了较丰富的片内外设。它们分别是看门狗（WDT）、模拟比较器A、定时器A0（Timer_A0）、定时器A1（Timer_A1）、定时器B0（Timer_B0）、UART、SPI、I2C、硬件乘法器、液晶驱动器、10位/12位ADC、16位Σ-Δ ADC、DMA、I/O端口、基本定时器（Basic Timer）、实时时钟（RTC）和汪启USB控制器等若干外围模块的不同组合。其中，看门狗可以使程序失控时迅速复位；模拟比较器进行模拟电压的比较，配合定时器，可设计出 A/D 转换器；16 位定时器（Timer_A 和 Timer_B）具有捕获/比较功能，大量的捕获/比较寄存器，可用于事件计数、时序发生、 PWM 等；有的器件更具有可实现异步、同步及多址访问串行通信接口可方便的实现多机通信等应用；具有较多的 I/O 端口，P0、P1、P2 端口能够接收外部上升沿或下降沿的中断输入；10/12位硬件 A/D 转换器有较高的转换速率，最高可达200kbps ，能够满足大多数数据采集应用；能直接驱动液晶多达 160 段；实现两路的 12 位 D/A 转换；硬件I2C串行总线接口实现存储器串行扩展；以及为了增加数据传输速度，而采用的DMA模块。MSP430 系列单片机的这些片内外设为系统的单片解决方案提供了极大的方便。 另外，MSP430 系列单片机的中断源较多，并且可以任意嵌套，使用时灵活方便。当系统处于省电的低功耗状态时，中断唤醒只需5μs。

5.方便高效的开发环境

MSP430 系列有 OPT 型、 FLASH 型和 ROM 型三种类型的器件，这些器件的开发手段不同。对于 OPT 型和 ROM 型的器件是使用仿真器开发成功之后烧写或掩膜芯片；对于 FLASH 型则有十分方便的开发调试环境，因为器件片内有 JTAG 调试接口，还有可电擦写的 FLASH 存储器，因此采用先下载程序到 FLASH 内，再在器件内通过软件控制程序的运行，由 JTAG 接口读取片内信息供设计者调试使用的方法进行开发。这种方式只需要一台 PC 机和一个 JTAG 调试器，而不需要仿真器和编程器。开发语言有汇编语言和 C 语言。

MSP430单片机家族

MSP430x1xx系列

基于闪存或 ROM 的超低功耗 MCU，提供 8MIPS，工作电压为 1.8V - 3.6V，具有高达 60KB 的闪存和各种高性能模拟及智能数字外设。 超低功耗低至： 0.1μA RAM 保持模式 0.7μA 实时时钟模式 200μA/MIPS 工作模式 在 6μs 之内快速从待机模式唤醒 器件参数： 闪存选项：1KB – 60KB ROM 选项：1KB – 16KB RAM 选项：512B – 10KB GPIO 选项：14、22、48 引脚 ADC 选项：10 和 12 位斜率 SAR 其它集成外设：模拟比较器、DMA、硬件乘法器、SVS、12 位 DAC[5]

MSP430F2xx系列

基于闪存的超低功耗 MCU，在 1.8V - 3.6V 的工作电压范围内性能高达 16MIPS。包含极低功耗振荡器 (VLO)、内部上拉/下拉电阻和低引脚数选择。 超低功耗低至： 0.1μA RAM 保持模式 0.3μA 待机模式 (VLO) 0.7μA 实时时钟模式 220μA/MIPS 工作模式 在 1μs 之内超快速地从待机模式唤醒 器件参数： 闪存选项：1KB – 120KB RAM 选项：128B – 8KB GPIO 选项：10、16、24、32、48、64 引脚 ADC 选项：10 和 12 位斜率 SAR、16 位 Σ-Δ ADC 其它集成外设：模拟比较器、硬件乘法器、DMA、SVS、12 位 DAC、运算放大器[6]

MSP430C3xx系列

旧款的 ROM 或 OTP 器件系列，工作电压为 2.5V - 5.5V，高达 32KB ROM、4MIPS 和 FLL。 超低功耗低至： 0.1μA RAM 保持模式 0.9μA 实时时钟模式 160μA/MIPS 工作模式 在 6μs 之内快速从待机模式唤醒 器件参数： ROM 选项：2KB – 32KB RAM 选项：512B – 1KB GPIO 选项：14、40 引脚 ADC 选项：14 位斜率 SAR 其它集成外设：LCD 控制器、硬件乘法器[7]

MSP430x4xx系列

基于 LCD 闪存或 ROM 的器件系列，提供 8-16MIPS，包含集成 LCD 控制器，工作电压为 1.8V-3.6V，具有 FLL 和 SVS。低功耗测量和医疗应用的理想选择。 超低功耗低至： 0.1μA RAM 保持模式 0.7μA 实时时钟模式 200μA/MIPS 工作模式 在 6μs 之内快速从待机模式唤醒 器件参数： 闪存/ROM 选项：4kB – 120KB RAM 选项：256B – 8KB GPIO 选项：14、32、48、56、68、72、80 引脚 ADC 选项：10 和 12 位斜率 SAR、16 位 Σ-Δ ADC 其它集成外设：LCD 控制器、模拟比较器、12 位 DAC、DMA、硬件乘法器、运算放大器、USCI 模块[8]

MSP430F5xx系列

新款基于闪存的产品系列，具有最低工作功耗，在 1.8V-3.6V 的工作电压范围内性能高达 25MIPS。包含一个用于优化功耗的创新电源管理模块。 超低功耗低至： 0.1μA RAM 保持模式 2.5μA 实时时钟模式 165μA/MIPS 工作模式 在 5μs 之内快速从待机模式唤醒 器件参数： 闪存选项：高达 256KB RAM 选项：高达 16KB ADC 选项：10 和 12 位 SAR 其它集成外设：USB、模拟比较器、DMA、硬件乘法器、RTC、USCI、12 位 DAC[9]

---