下面是之前写的一篇文章:《如何快速阅读源码》
本文探讨在需要了解一个开源项目时,如何快速的理清开源项目的代码逻辑!
以下是个人认为行之有效的方法:
- 先「跑起来」
- 自顶向下拆解
- 深入细节
- 延伸改进
本文以Mybatis为例来进行演示!
先“跑起来”
程序界有个老传统,学习新技术时都是从「Hello World」开始的!无论是学习新语言时,打印「Hello World」;还是学习新框架时编写个demo!那为什么这里的「跑起来」要打个引号呢?
实际上,当你想要阅读一个开源项目的源码时,绝大部分情况下,你已经能够使用这个开源项目了!所以这里的“跑起来”就不是写个「Hello World」,也不是能跑起来的程序了!而是能__在你的脑子里「跑起来」__!什么意思?
Mybatis你会用了吧?那么请问Mybatis是如何执行的呢?仔细想想,你能否用完整的语句把它描述出来?
这里是Mybatis的官方入门文章!你是如何看这篇文章的?读一遍就行了吗?还是跟着文章跑一遍就够了吗?从这篇文章里你能获得多少信息?
我们来理一下:
- 安装
- 如何在项目中引入Mybatis?
- Mybatis的groupId是什么?artifactId又是什么?目前最新版本是多少?
- 从 XML 中构建 SqlSessionFactory
- SqlSessionFactoryBuilder可以通过xml或者Configuration来构建SqlSessionFactory,那是如何构建的呢?
- xml配置了哪些信息?既然使用了xml,那肯定有xml解析,用什么方式解析的?
- xml里的标签都是什么意思:configuration,environments,transactionManager,dataSource,mappers。以及这些标签的属性分别是什么意思?
- SqlSessionFactory的作用是什么?
- 不使用 XML 构建 SqlSessionFactory
- BlogDataSourceFactory,DataSource,TransactionFactory,Environment,Configuration这些类的作用是什么?
- *Mapper的作用是什么?
- 为什么提供基于XML和Java的两种配置方式?这两种配置方式的优缺点是什么?
- 从 SqlSessionFactory 中获取 SqlSession
- SqlSession的作用是什么?
- selectOne和getMapper的执行方式有什么区别?
- 探究已映射的 SQL 语句
- *Mapper.xml的配置是什么?
- 命名空间,id的作用是什么?
- *Mapper.xml是如何和*Mapper.java进行匹配的?
- 匹配规则是什么?
- 基于注解的映射配置如何使用?
- 为什么提供基于XML和基于注解的两种映射配置?有什么优劣?
- 作用域(Scope)和生命周期
- SqlSessionFactoryBuilder应该在哪个作用域使用?为什么?
- SqlSessionFactory应该在哪个作用域使用?为什么?
- SqlSession应该在哪个作用域使用?为什么?
- Mapper实例应该在哪个作用域使用?为什么?
回答出了上面这些问题!你也就基本能在脑子里把Mybatis「跑起来」了!之后,你才能正真的开始阅读源码!
当你能把一个开源项目「跑起来」后,实际上你就有了对开源项目最初步的了解了!就像「书的索引」一样!基于这个索引,我们一步步的进行拆解,来细化出下一层的结构和流程,期间可能需要深入技术细节,考量实现,考虑是否有更好的实现方案!也就是说后面的三步并不是线性的,而是__不断交替执行__的一个过程!最终就形成一个完整的源码执行流程!
自顶向下拆解
继续通过Mybatis来演示(限于篇幅,我只演示一个大概流程)!我们现在已经有了一个大概的流程了:
- SqlSessionFactoryBuilder通过xml或者Configuration构建出SqlSessionFactory
- 可以从SqlSessionFactory中获取SqlSession
- SqlSession则是真正执行sql的类
虽说每个点都可以往下细化,但是也分个轻重缓急!
- 我们是先了解怎么构建SqlSessionFactory呢?
- 还是了解如何获取SqlSession呢?
- 还是了解SqlSession如何执行sql的呢?
很明显,SqlSession去执行 sql才是Mybatis的核心!我们先从这个点入手!
首先,你当然得先下载Mybatis的源码了(请自行下载)!
我们直接去看SqlSession!它是个接口,里面有一堆执行sql的方法!
这里只列出了一部分方法:
SqlSession就是通过这些方法来执行sql的!我们直接看我们常用的,也是Mybatis推荐的用法,就是基于Mapper的执行!也就是说「SqlSession通过Mapper来执行具体的sql」!上面的流程也就细化成了:
- SqlSessionFactoryBuilder通过xml或者Configuration构建出SqlSessionFactory
- 可以从SqlSessionFactory中获取SqlSession
- SqlSession则是真正执行sql的类
- SqlSession获取对应的Mapper实例
- Mapper实例来执行相应的sql
那SqlSession是如何获取Mapper的呢?Mapper又是如何执行sql的呢?
深入细节
我们来看SqlSession的实现!SqlSession有两个实现类SqlSessionManager和DefaultSqlSession!通过IDE的引用功能可以查看两个类的使用情况。你会发现SqlSessionManager实际并没有使用!而DefaultSqlSession是通过DefaultSqlSessionFactory构建的!所以我们来看DefaultSqlSession是如何构建Mapper的!
它直接委托给了Configuration的getMapper方法!
Configuration又委托给了MapperRegistry类的getMapper方法!
在MapperRegistry类的getMapper中:
- 通过type从knownMappers中获取对应的MapperProxyFactory实例
- 如果不存在则抛出异常
- 如果存在则调用mapperProxyFactory.newInstance(sqlSession)创建对应的Mapper
在这里knowMappers是什么?MapperProxyFactory又是什么?mapperProxyFactory.newInstance(sqlSession)具体做了什么?
其实很简单,knowMappers是个Map,里面包含了class与对应的MapperProxyFactory的对应关系!MapperProxyFactory通过newInstance来构建对应的Mapper(实际上是Mapper的代理)!
快接近真相了,看mapperProxyFactory.newInstance(sqlSession)里的代码:
这里干了什么?
- 通过sqlSession,mapperInterface和methodCache构建了一个MapperProxy对象
- 然后通过Java的动态代理,来生成了Mapper的代理类
- 将Mapper方法的执行都委托给了MapperProxy去执行
- 如果是Object里的方法则直接执行
- 否则执行MapperMethod的execute方法
最终实际还是委托给了sqlSession去执行具体的sql!后面具体怎么实现的就自行查看吧!
延伸改进
现在我们的流程大概是这样的一个过程:
- SqlSessionFactoryBuilder通过xml或者Configuration构建出SqlSessionFactory
- 可以从SqlSessionFactory中获取SqlSession
- SqlSession则是真正执行sql的类
- SqlSession获取对应的Mapper实例
- DefaultSqlSession.getMapper
- Configuration.getMapper
- MapperRegistry.getMapper
- mapperProxyFactory.newInstance(sqlSession)
- 通过sqlSession,mapperInterface和methodCache构建了一个MapperProxy对象
- 然后通过Java的动态代理,来生成了Mapper的代理类
- Mapper实例来执行相应的sql
- 将Mapper方法的执行都委托给了MapperProxy去执行
- 如果是Object里的方法则直接执行
- 否则执行MapperMethod的execute方法
- 最终还是委托给sqlSession去执行sql
- SqlSession获取对应的Mapper实例
现在我们大概知道了:
- 为什么Mapper是个接口了
- Mybatis基于这个接口做了什么
那么,
- 什么是动态代理(基础哦)?
- 为什么使用动态代理来处理?
- 基于动态代理有什么优点?又有什么缺点?
- 除了动态代理,还有其它什么实现方式吗?比如说cglib?
- 如果是其它语言的话,有没有什么好的实现方式呢?
- ......
这个问题列表可以很长,可以按个人需要去思考并尝试回答!可能最终这些问题已经和开源项目本身没有什么关系了!但是你思考后的收获要比看源码本身要多得多!
再循环
一轮结束后,可以再次进行:
- 自顶向下拆解
- 深入细节
- 延伸改进
不断的拆解->深入->改进,最终你能__通过一个开源项目,学习到远比开源项目本身多得多的知识__!
最重要的是,你的流程是完整的。无论是最初的大致流程:
- SqlSessionFactoryBuilder通过xml或者Configuration构建出SqlSessionFactory
- 可以从SqlSessionFactory中获取SqlSession
- SqlSession则是真正执行sql的类
还是到最终深入的细枝末节,都是个完整的流程!
这样的好处是,你的时间能自由控制:
- 你是要花个半天时间,了解大致流程
- 还是花个几天理解细节流程
- 还是花个几周,几个月来深入思考,不断延伸你都可以从之前的流程中快速进行下去!
而不像debug那样的方式,需要一下子花费很长的时间去一步步的理流程,费时费力、收效很小,而且如果中断了就很难继续了!
总结
本文通过梳理Mybatis源码的一个简单流程,来讲述一个个人认为比较好的阅读源码的方式,并阐述此方法与传统debug方式相比的优势。
阅读源码是每个优秀开发工程师的必经之路,那么这篇文章就来讲解下为什么要阅读源码以及如何阅读源码。
首先来说下为什么要读源码,有学习源码的必要吗?
为什么要阅读源码?
关于为什么阅读和学习源码,我个人认为可能有以下几点:
(一)吊打面试官,应对面试
为了找到更好的工作,应对面试,因为在面试中肯定会问到源码级别的问题,比如:为什么 HashMap 是线程不安全的?
如果你没有阅读过源码,面试官可能会对回答的结果不满意,进而导致面试结果不太理想,但如果你对源码有所研究,并能够很好地问答面试官的问题,这可能就是你的加分点,可以形成自己独特的竞争力,吊打面试官,升职加薪不是梦。
(二)解决问题(bug)
在开发过程中,我们或多或少会遇到 bug,比如:在 foreach 循环里进行元素的 remove/add 操作,为啥有可能会报 ConcurrentModificationException 异常?
我们可以先在 Google、Stack Overflow 以及对应项目的 Issues 里看有没有类似问题以及解决办法,如果没有的话,我们只能通过阅读源码的方式去解决了。如果我们对相关源码有所涉猎,就可以快速定位到问题所在。
(三)提升编程能力
读一本好书,就是和许多高尚的人谈话。 -歌德
和阅读一本好书一样,阅读源码就是和编程大牛面对面交流的机会,在许多优秀的开源项目中,它们的编码规范和架构设计都是很棒的,另外在设计上也使用了大量的设计模式,通过阅读和学习源码,能够快速提升我们的编码水平,以及对设计模式有更深的理解。
同时,在我们阅读完一个源码后,可以触类旁通,能够快速地对其他框架的源码进行阅读和学习,减少时间成本。
除了上述提到的原因之外,可能还有许多,在这里就不一一赘述了,那么在确定了要阅读源码之后,就让我们看下如何阅读源码吧!
如何阅读源码?
如何阅读源码取决于你为什么要读源码,比如:
- 如果为了应对面试,那就可以围绕常考的基础类、集合类、队列、线程、锁等内容进行阅读和学习;
- 如果是为了解决 bug,那么就可以只围绕出现问题的相关类进行阅读分析,随着解决 bug 的增多,我相信阅读的源码也会越多,从而更容易去阅读和学习源码;
下面大概说下阅读源码的几点建议:
在阅读之前,可以先从开源项目的官网上看它的架构设计和功能文档,了解这个项目的整体架构、模块组成以及各个模块之间的联系。
如果没有对应的项目文档,可以根据代码的模块进行梳理,以形成对项目的初步了解,或者查看已有的源码解析文章或者书籍,在阅读源码之前,了解项目的架构和思路会使阅读源码事半功倍。
在了解一个类的时候,可以使用 ctrl+F12 来查看类中的成员变量和方法。
可以通过 IDEA 的 Diagrams 功能去了解一个类的继承关系。
多打断点调试,断点追踪源码是很好的阅读源码的方式,可以先通过 debug 了解下调用逻辑,都和哪些类有关联,有大致了解后再通过 debug 了解整体代码的功能实现,各个类都起到了什么作用,有没有涉及到设计模式等。
另外,优秀的开源项目中肯定会有许多地方应用到了设计模式,建议在阅读源码之前,需要对常用的设计模式有大致的了解,不然阅读源码的效率会大大降低。
如果遇到读不懂某部分源码的时候,可以先跳过,之后再回来看,如果属于搞不懂这部分就茶不思饭不想的人,可以在网上找是否有该部分源码的解析或者文档,也可以自己通过源码注释和测试用例去阅读学习。
一般优秀的开源项目都会有单元测试,可以通过对应类的单元测试去了解方法的含义和用法,加深对源码逻辑的理解。
在阅读源码的时候,可以在代码上加上注释和总结,同时还可以画出时序图和类图,这样对阅读源码有很大的帮助,可以很清楚地知道类之间的调用关系和依赖关系,也方便以后回顾,重新阅读。
在这里推荐大家一个 IDEA 插件 SequenceDiagram,可以根据源码生成调用时序图,便于阅读源码。
刚开始阅读源码,不建议直接看框架源码,可以先从 jdk 源码看起:
jdk 源码也是非常庞大的,可以分模块来阅读,下面是建议的阅读顺序:
- java.lang 包下的基本包装类(Integer、Long、Double、Float 等),还有字符串相关类(String、StringBuffer、StringBuilder 等)、常用类(Object、Exception、Thread、ThreadLocal 等)。
- java.lang.ref 包下的引用类(WeakReference、SoftReference 等)
- java.lang.annotation 包下的注解的相关类
- java.lang.reflect 包下的反射的相关类
- java.util 包下为一些工具类,主要由各种容器和集合类(Map、Set、List 等)
- java.util.concurrent 为并发包,主要是原子类、锁以及并发工具类
- java.io 和 java.nio 可以结合着看
- java.time 主要包含时间相关的类,可以学习下 Java 8 新增的几个
- java.net 包下为网络通信相关的类,可以阅读下 Socket 和 HTTPClient 相关代码
其他包下的代码也可以做下了解,JDK源码阅读笔记:https://github.com/wupeixuan/JDKSourceCode1.8
再有了一定的源码阅读经验后,可以再去学习 Spring、Spring Boot、Dubbo、Spring Cloud 等框架的源码。
总结
主要介绍了为什么读源码以及如何读源码,供大家参考,每个人都有适合自己的阅读源码的方式,希望可以在学习中去摸索出一套属于自己的方式。
阅读源码不是一蹴而就的,这是持久战,只要你能够坚持下来,肯定受益匪浅。阅读源码的过程比较枯燥,可以在社群里一起讨论学习,这样可能效率更高些。
写得不好的或者大家有什么更好的建议,也欢迎留言讨论。
我最近恰好找摸索出一个梳理遗留系统架构的技巧:自底向上 找到一个典型的切面 沿着调用和回调的路径 在代码中添加结构化注释(比如eclipse中加//TAG 流程A1.1 甲->>乙),这样便得到了一个code地图,并且在tasks视图中看起来很直观(看起来跟书的目录一样)可快速跳转。将目录copy到有道云笔记的markdown序列图中 就自动生成了一个序列图。
我觉得这基本上就是可缩放的可视化架构地图了,对维护一个比较乱和庞大的遗留系统非常有帮助,定位代码 修改维护都方便多了。
1、需要过硬的基础知识,这个前提。不然基本语法、常用的模式都不晓得怎么读。
2、多参考历史版本和更新变化,好的源码都是反复迭代出来的精华,开始就读精华是很不明智的,所以看看版本更新说明,版本的历史演变。就想人一样是怎样进化过来的。
3、参考别人阅读注释,想必在你读源码之前也有人读过了源码,并且总结,注释。和分享原理,可供你参考,毕竟每个人读一篇文章,理解的东西是有差异化的。
4、直接买书,有些作品直接出书就是源码精解
5、找个大神给你慢慢分析,这个最快。娓娓道来,直接面授比啥都强。缺点是,你容易跟着他的思维走下去。
没看过源代码,都不好意思出来说了,最近刚好在看一些,来说一个。
先看使用 https://element.eleme.cn/#/zh-CN/component/installation
先看一下这个库是做什么用的,然后提供了哪些功能。
看GitHub https://github.com/elemefe
一般会看下项目最新的情况,然后没有关闭的issue,看下wiki,大家在讨论什么。
再看代码
clone 一份到本地,然后先看下目录结构,然后根据文档看几个简单的组件的时候,一边看掘金上的分析,一边自己看下实现。
e le
饿了么这个框架代码结构还是很清楚的,基本上每个组件都是分开的,所以你只要看其他的一个文件夹就行。然后一些工具的都在src文件夹。
要学会看issue,一般开源的项目都有人会来提建议,有些是bug,有些是功能,你可以看看自己是否有能力去解决,如果可以的话,你可以去fork代码,然后自己修改,再提pr。
关注我,一起学前端。