天天看點

新手也能看懂的源碼閱讀技巧

新手也能看懂的源碼閱讀技巧

作者 :youzhibing

連結 :https://urlify.cn/ueQ7fy

讀源碼的經曆

剛參加工作那會,沒想過去讀源碼,更沒想過去改架構的源碼;總想着别人的架構應該是完美的、萬能的,應該不需要改;另外即使我改了源碼,怎麼樣讓我的改動生效了?項目中引用的不還是沒改的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的兩篇文章。

慢慢的,從一味的網上找資料變成了很多時候會從源碼中找答案。不求能讀太多的源碼,但願自己接觸的技術都能讀上一讀,路漫漫其修遠兮,吾将上下而求索!

我為什麼讀源碼

很多人一定和我一樣的感受:源碼在工作中有用嗎?用處大嗎?很長一段時間内我也有這樣的疑問,認為哪些有事沒事扯源碼的人就是在裝,隻是為了提高他們的逼格而已。

那為什麼我還要讀源碼呢?一剛開始為了面試,後來為了解決工作中的問題,再後來就是個人喜好了。說的好聽點是有匠人精神;說的委婉點是好奇(底層是怎麼實作的);說的不自信點是對黑盒的東西我用的沒底,怕用錯;說的簡單直白點是提升自我價值,為了更高的薪資待遇(這裡對真正的技術迷說聲抱歉)。

源碼中我們可以學到很多東西,學習别人高效的代碼書寫、學習别人對設計模式的熟練使用、學習别人對整個架構的布局,等等。如果你還能找出其中的不足,那麼恭喜你,你要飛升了!會使用固然重要,但知道為什麼這麼使用同樣重要。從模仿中學習,從模仿中創新。

讀源碼不像圍城(外面的人想進來,裡面的人想出去),它是外面的人不想進來,裡面的人不想出去;當我們跨進城内,你會發現(還是城外好,皮!)城内風光無限,源碼的海洋任我們遨遊!

我是怎麼樣讀源碼的

内容了解

首先我們要對我們的目标有所了解,知道她有什麼特點,有些什麼功能。對對方都還不了解,就想着進入别人的内心世界,那不是臭不要臉嘛,我們要做一個有着流氓心的紳士;對她有個大緻的了解了,就可以發起攻勢,一舉拿下。

那麼怎麼樣了解了,方式有很多,我這裡提供幾種,僅供參考

最好的方式就是官方參考指南,親生父母往往對孩子是最了解的,對孩子的描述也是最詳細的;比如Spring Boot Reference Guide就是對springboot最詳細的描述,怎麼樣使用springboot、springboot特性等等,通過此指南,springboot在你面前一覽無遺;

但是,springboot畢竟是外國人的孩子,如果英語不好,估計讀起來有點頭疼了,不過我們有google翻譯呀,咬咬牙也是能看的。源碼世界的丈母娘、老嶽丈是非常慷慨的!

其次是書籍,國外優秀的有很多,國内也不乏好書,比較推薦此方式,自成體系,讓我們掌握的知識點不至于太散。這就是好比是源碼的閨蜜,對源碼非常了解,重點是挺大方,會盡全力幫助我們了解源碼。

再次就是部落格,雖然可能覺得知識點比較散,但是針對某個知識點卻特别的細,對徹底掌握非常有幫助,園子内就有很多技術大牛,寫的部落格自然也是非常棒,非常具有學習價值。當然還有社群、論壇、github、碼雲等等。這就是源碼的朋友圈,我們從中也能擷取到非常多關于源碼的資訊。

新手也能看懂的源碼閱讀技巧

設計模式的了解

優秀的架構、技術從不乏設計模式;jdk源碼中就應用了很多設計模式,比如IO流中的擴充卡模式與裝飾模式、GUI的觀察者模式、集合中的疊代器模式等等;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;
    }
}           

明确我們的目的,找到合适的切入點,進入斷點調試追蹤也就容易了。

任我說的天花亂墜,你仍無動于衷,那也隻是我一廂情願,隻有局中人才能體會到其中的奧妙!

總結與感悟

從上至下全部通讀的方式,個人不太推薦,這是建立在很熟悉的基礎上的,當我們對某個架構已經比較熟悉了,再從上至下進行通讀,徹底了解,這是我認為正确的方式;但是從不熟悉到熟悉這個過程,個人不推薦全部通讀,而是推薦上面我推薦的方式 - 斷點局部追蹤。

很多時候,我們的博文都隻是授之以魚,而我們也隻是從中得到魚;而這篇的目的則是授之以漁,我希望大家從中學到捕魚的方法,而不是一味的等待别人的魚;希望大家能夠自給自足,也能把魚和漁都授予其他人。

隻要我們開始去讀源碼,慢慢的就會形成自己的一套讀源碼的方式;每個人的方式都不一樣,合适自己的才是最好的。行動起來,用合适的方式去俘獲你的的她吧!