新手也能看懂的源码阅读技巧

最新推荐文章于 2023-05-03 16:15:26 发布

MarkerHub

最新推荐文章于 2023-05-03 16:15:26 发布

阅读量215

点赞数

原文链接：https://github.com/MarkerHub/JavaIndex/blob/master/README.md

版权

小Hub领读：

不管学什么框架、技术栈，没读过源码就不算精通！

作者：青石路

https://www.cnblogs.com/youzhibing/p/9553752.html

读源码的经历

刚参加工作那会，没想过去读源码，更没想过去改框架的源码；总想着别人的框架应该是完美的、万能的，应该不需要改；另外即使我改了源码，怎么样让我的改动生效了？项目中引用的不还是没改的 jar 包吗。回想起来觉得那时候的想法确实挺……

工作了一年多之后准备跳槽了，开始了一轮的面试，其中有几个面试官就问到了相关的源码问题：ArrayList、HashMap 的底层实现，spring、mybatis 的相关源码。问源码的面试一般就是回去等消息，然后就没然后了。

那时候开始意识到，源码这东西在之前的工作的中感受不到，但是在面试中好像面的还挺频繁的，从此有意识的开始了 jdk 部分源码的阅读（主要是集合）。一开始看源码，看的特别糙，知道个大概，知道 ArrayList 的底层实现是数组，HashMap 的底层是散列表（数组 + 链表）；更深入一点的扩容、hash 碰撞等等就不知道了。

读 spring 源码起于工作中遇到了一个问题（spring jdbcTemplate 事务，各种诡异，包你醍醐灌顶！），排查一段时间最终是解决了，但过程让我非常难受，各种上网查资料、各种尝试，感觉就像大海捞针一样，遥遥无期。我下定决心，我要看一看 spring 的源码，于是我买了一本《spring 源码深度解析》，结合着这本书、打开着 eclipse，开始了 spring 的源码阅读之旅。至此，读源码成了习惯，源码已经进入了我的心里。

后来，springboot 的火热，让我也想蹭上一蹭，于是有了 springboot 的启动源码系列，虽然还在进行中，但是我相信我能将其完成；工作中用到了 shiro，我又结合着《跟我学 shiro》将 shiro 的源码看了个大概，有了 shiro 源码系列博文，还差一篇认证与授权（应该很快就能面世），shiro 源码系列就封笔了。最近在搭建自己的后台管理系统，用到了 quartz，集成的过程也遇到了一些问题，因此有了 quartz 的两篇文章。

慢慢的，从一味的网上找资料变成了很多时候会从源码中找答案。不求能读太多的源码，但愿自己接触的技术都能读上一读，路漫漫其修远兮，吾将上下而求索！

我为什么读源码

很多人一定和我一样的感受：源码在工作中有用吗？用处大吗？很长一段时间内我也有这样的疑问，认为哪些有事没事扯源码的人就是在装，只是为了提高他们的逼格而已。

那为什么我还要读源码呢？一刚开始为了面试，后来为了解决工作中的问题，再后来就是个人喜好了。说的好听点是有匠人精神；说的委婉点是好奇（底层是怎么实现的）；说的不自信点是对黑盒的东西我用的没底，怕用错；说的简单直白点是提升自我价值，为了更高的薪资待遇（这里对真正的技术迷说声抱歉）。

源码中我们可以学到很多东西，学习别人高效的代码书写、学习别人对设计模式的熟练使用、学习别人对整个架构的布局，等等。如果你还能找出其中的不足，那么恭喜你，你要飞升了！会使用固然重要，但知道为什么这么使用同样重要。从模仿中学习，从模仿中创新。搜索公纵号：MarkerHub，关注回复[ vue ]获取前后端入门教程！

读源码不像围城（外面的人想进来，里面的人想出去），它是外面的人不想进来，里面的人不想出去；当我们跨进城内，你会发现（还是城外好，皮！）城内风光无限，源码的海洋任我们遨游！

我是怎么样读源码的

内容了解

首先我们要对我们的目标有所了解，知道她有什么特点，有些什么功能。对对方都还不了解，就想着进入别人的内心世界，那不是臭不要脸嘛，我们要做一个有着流氓心的绅士；对她有个大致的了解了，就可以发起攻势，一举拿下。

那么怎么样了解了，方式有很多，我这里提供几种，仅供参考

最好的方式就是官方参考指南，亲生父母往往对孩子是最了解的，对孩子的描述也是最详细的；比如 Spring Boot Reference Guide 就是对 springboot 最详细的描述，怎么样使用 springboot、springboot 特性等等，通过此指南，springboot 在你面前一览无遗；

但是，springboot 毕竟是外国人的孩子，如果英语不好，估计读起来有点头疼了，不过我们有 google 翻译呀，咬咬牙也是能看的。源码世界的丈母娘、老岳丈是非常慷慨的！

其次是书籍，国外优秀的有很多，国内也不乏好书，比较推荐此方式，自成体系，让我们掌握的知识点不至于太散。这就是好比是源码的闺蜜，对源码非常了解，重点是挺大方，会尽全力帮助我们了解源码。

再次就是博客，虽然可能觉得知识点比较散，但是针对某个知识点却特别的细，对彻底掌握非常有帮助，园子内就有很多技术大牛，写的博客自然也是非常棒，非常具有学习价值。当然还有社区、论坛、github、码云等等。这就是源码的朋友圈，我们从中也能获取到非常多关于源码的信息。

设计模式的了解

优秀的框架、技术从不乏设计模式；jdk 源码中就应用了很多设计模式，比如 IO 流中的适配器模式与装饰模式、GUI 的观察者模式、集合中的迭代器模式等等；搜索公纵号：MarkerHub，关注回复[ vue ]获取前后端入门教程！spring 源码中也是用到了大量的设计模式。设计模式有什么优点、各适用于什么场景，不是本文的内容，需要我们大家自行去了解。

我们只需要对一些常用的设计模式有个大致了解，再去读源码是比较好的；不需要将 23 种设计模式都通读，也不需要将常用设计模式完全理解透；对于全部通读，我们时间有限，另外有些模式确实不太好理解、用的少，性价比不高，没必要全部都读。

推荐书籍：《Head First Design Patterns》（中文版：《Head First 设计模式》）、《Java 与模式》；

另外我比较推荐的一种学习设计模式的方式是读别人博客：java_my_life，刘伟技术博客，chenssy 的设计模式；

设计模式之于源码，就好比逛街购物之于女人，想顺利勾搭源码，我们需要好好掌握设计模式这个套路。

配合 ide 进行断点追踪

我们通过源码的圈子对源码的了解终究只是停在表面，终究还是没有走进她的内心，接下来我就和大家分享下，我是如何走进她的内心的！

相信看过我的源码博客的小伙伴都知道，我非常喜欢通过 idea 断点来进行源码追踪，断点追踪源码是我非常推荐的一种方式。断点不仅可以用来调试我们的代码，也可以用来调试我们用到的框架源码。

面对未知的、茫茫多的源码，我们往往没有足够的时间、经历和耐心去通读所有源码，我们只需要去读我们关注的部分即可（有人可能会说我都不关心，这…）。那为什么要用断掉调试的方式来跟源码，而不是直接从源代码入手去跟我们关注的部分呢？

尝试过的小伙伴应该知道，如果我们对源码不熟悉，直接通过源码的方式去跟，一方面很容易迷路（多态，会有很多子类实现），不知道接下来跟哪一个，另一方面也很容易跟丢，当我们跟入的很深的时候，很有可能就忘记上一步跟到哪了。

下面我会举例来说明我是如何进行断点追踪的，以 spring-boot-2.0.3 之 quartz 集成，不是你想的那样哦！和 spring-boot-2.0.3 之 quartz 集成，数据源问题，源码探究为背景来讲，需要搞清楚两个点：springboot 是如何向 quartz 注入数据源的，quartz 是如何操作数据库的

springboot 向 quartz 注入数据源

QuartzAutoConfiguration 是 springboot 自动配置 quartz 的入口

将 quartz 的配置属性设置给 SchedulerFactoryBean；将数据源设置给 SchedulerFactoryBean：如果有 @QuartzDataSource 修饰的数据源，则将 @QuartzDataSource 修饰的数据源设置给 SchedulerFactoryBean，否则将应用的数据源（druid 数据源）设置给 SchedulerFactoryBean，显然我们的应用中没有 @QuartzDataSource 修饰的数据源，那么 SchedulerFactoryBean 中的数据源就是应用的数据源；将事务管理器设置给 SchedulerFactoryBean。SchedulerFactoryBean，负责创建和配置 quartz Scheduler，并将其注册到 spring 容器中。SchedulerFactoryBean 实现 InitializingBean 的 afterPropertiesSet 方法，里面有可以设置数据源的过程

可以看到通过 org.quartz.jobStore.dataSource 设置的 dsName（值为 quartzDs）最后会被替换成 springTxDataSource. 加 scheduler 实例名（我们的应用中是：springTxDataSource.quartzScheduler）。springboot 会注册两个 ConnectionProvider 给 quartz：一个 dsName 叫 springTxDataSource.quartzScheduler，有事务；一个 dsName 叫 springNonTxDataSource.quartzScheduler，没事务。

quartz 如何操作数据库

我们通过停止定时任务来跟下 quartz 对数据库的操作

发现 quartz 用如下方式获取 connection

conn = DBConnectionManager.getInstance().getConnection(getDataSource());

那么我们的 job 中就可以按如下方式操作数据库了

public class FetchDataJob extends QuartzJobBean {

    // private String dataSourceName = "quartzDs"; // 用此会找不到
    // private String dataSourceName = "springNonTxDataSource.quartzScheduler"; // 不支持事务
    // private String dataSourceName = "springTxDataSource.quartzScheduler"; // 支持事务
    private final String insertSql = "INSERT INTO tbl_sys_user(name, age) VALUES(?,?) ";

    private String schedulerInstanceName = "quartzScheduler"; // 可通过jobDataMap注入进来

    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        String dsName = LocalDataSourceJobStore.NON_TX_DATA_SOURCE_PREFIX
                + schedulerInstanceName; // 不支持事务
        //String dsName = LocalDataSourceJobStore.TX_DATA_SOURCE_PREFIX + schedulerInstanceName; // 支持事务
        try {
            Connection connection = DBConnectionManager.getInstance().getConnection(dsName);
            PreparedStatement ps = connection.prepareStatement(insertSql);
            ps.setString(1, "张三");
            ps.setInt(2, 25);
            ps.executeUpdate();

            ps.close();
            connection.close(); // 将连接归还给连接池
            System.out.println("插入成功");
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }

    public void setSchedulerInstanceName(String schedulerInstanceName) {
        this.schedulerInstanceName = schedulerInstanceName;
    }
}

明确我们的目的，找到合适的切入点，进入断点调试追踪也就容易了。

任我说的天花乱坠，你仍无动于衷，那也只是我一厢情愿，只有局中人才能体会到其中的奥妙！

总结与感悟

从上至下全部通读的方式，个人不太推荐，这是建立在很熟悉的基础上的，当我们对某个框架已经比较熟悉了，再从上至下进行通读，彻底了解，这是我认为正确的方式；但是从不熟悉到熟悉这个过程，个人不推荐全部通读，而是推荐上面我推荐的方式 - 断点局部追踪。

很多时候，我们的博文都只是授之以鱼，而我们也只是从中得到鱼；而这篇的目的则是授之以渔，我希望大家从中学到捕鱼的方法，而不是一味的等待别人的鱼；希望大家能够自给自足，也能把鱼和渔都授予其他人。

只要我们开始去读源码，慢慢的就会形成自己的一套读源码的方式；每个人的方式都不一样，合适自己的才是最好的。行动起来，用合适的方式去俘获你的的她吧！

(完)

MarkerHub文章索引：（点击阅读原文直达）

https://github.com/MarkerHub/JavaIndex
【推荐阅读】
Shell脚本结合Git实现增量项目部署

面试官：为什么 HashMap 的加载因子是0.75？

Spring / Spring boot 异步任务编程 WebAsyncTask

Spring Boot 应用监控，早发现早～～

浅析 VO、DTO、DO、PO 的概念、区别和用处！

好文章！点个在看！