想讀Spring源碼?先從這篇「 極簡教程」開始
來自:Java中文社群
這也是一個(gè)哲學(xué)問題,我想每個(gè)人都有不同的答案,下面我是對(duì)閱讀源碼好處的一些思考。(PS:也歡迎你在評(píng)論區(qū)留言補(bǔ)充)
閱讀源碼的好處
1.知其然知其所以然
這是一句 IT 人都很熟悉的話,在開源軟件越來越多,并且升級(jí)越來越快的今天,如果說還有什么是重要的,那一定是知道它(開源軟件)的核心原理和執(zhí)行流程,這樣就能為我們快速定位并修復(fù)問題提供寶貴的時(shí)間。
2.讓自己變得更加優(yōu)秀
學(xué)習(xí)源碼可以讓我們站在巨人的肩膀上,你可以學(xué)習(xí)源碼中的優(yōu)秀編碼技巧和巧妙的設(shè)計(jì)思路,以及設(shè)計(jì)模式的落地應(yīng)用,還有一些經(jīng)典的編碼規(guī)范和命名規(guī)則等。以此來約束和改進(jìn)自己的編程代碼,才能寫成更好的代碼。
3.找到更好的工作
在日益競(jìng)爭激烈的面試中,尤其是在大廠的面試中,對(duì)于源碼的考察非??粗?,只有了解和熟悉這些源碼,才能獲得自己想要的 offer。
那既然閱讀源碼有這么多的好處,我們?cè)撊绾伍_始呢?
如何閱讀源碼?
閱讀源碼的實(shí)現(xiàn)思路是這樣的,首先我們需要下載 Spring 源碼,然后把 Spring 的源碼導(dǎo)入到 IDE 中,然后再編譯 Spring 源碼,再以添加 Module 的方式添加測(cè)試代碼,再把 Spring 源碼部分引入到 Module 中,此時(shí)我們就可以使用調(diào)試功能進(jìn)入 Spring 框架的內(nèi)部,查看方法的執(zhí)行流程和源碼的具體實(shí)現(xiàn)。
Spring 源碼閱讀流程,如下圖所示:
搭建Spring源碼閱讀環(huán)境
本文實(shí)現(xiàn)環(huán)境:Window 10 / JDK 8 / Spring 5.2.2 / IDEA 2019
注意:Spring 5.1 之后需要 JDK 8 以上的環(huán)境。
1.安裝Gradle
在正式開始之前我們需要先安裝 Gradle,因?yàn)?nbsp;Spring 是基于 Gradle 構(gòu)建的。
Gradle 是一個(gè)開源的基于 JVM 構(gòu)建工具,和 Maven 工具類似。項(xiàng)目的構(gòu)建經(jīng)歷了三個(gè)時(shí)代:Apache Ant(2000 年左右)、Maven(2004年)和 Gradle(2012 年左右),Gradle 相比于 Maven 配置更加簡單、性能更高、用戶體驗(yàn)更好(IDE 支持代碼提示)。
例如,使用 maven 時(shí),配置文件如下:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Maven Quick Start Archetype</name>
<url>http://maven.apache.org</url>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
換成 Gradle,配置如下:
apply plugin:'java'
group='com.mycompany.app'
archivesBaseName='my-app'
version='1.0-SNAPSHOT'
repositories{
mavenCentral()
}
dependencies{
testCompile 'junit:4.13'
}
Hibernate、Spring 等優(yōu)秀的開源項(xiàng)目都將自己的項(xiàng)目從 Maven 遷移到了 Gradle,Google 官方 Android 開發(fā)的 IDE Android Studio 也默認(rèn)使用了 Gradle 進(jìn)行構(gòu)建。但不可否認(rèn)的是,Maven 在如今仍然是 Java 項(xiàng)目構(gòu)建的主流方式。
Gradle 和 Maven 的性能測(cè)試,如下圖所示:IDEA 對(duì) Gradle 的支持如下圖所示:
更多關(guān)于 Gradle vs Maven 的文章,可以訪問 Gradle 官方提供文章:https://gradle.org/maven-vs-gradle/
首先,我們需要下載 Gradle 安裝包,下載地址為:https://gradle.org/releases/
選擇 binary-only 安裝包,下載即可。
注意:需要安裝 Gradle 5.X 的版本,Spring 最新版不支持 Gradle 6+ 版本。如果安裝 6+ 版本會(huì)報(bào)錯(cuò),信息如下:
The build scan plugin is not compatible with Gradle 6.0 and later. Please use the Gradle Enterprise plugin instead. Open File
下載完成之后,我們需要解壓 Gradle 到指定的目錄,例如“C:\Gradle\gradle”。
解壓完成之后,我們需要配置兩個(gè)系統(tǒng)變量。
右鍵計(jì)算機(jī) -> 屬性 -> 高級(jí)系統(tǒng)設(shè)置 -> 環(huán)境變量,在系統(tǒng)變量區(qū)域,先點(diǎn)擊“新建”輸入變量名為:GRADLE_HOME,變量值為:C:\gradle\gradle-5.6.4(根據(jù)自己的路徑填寫);再找到 Path 環(huán)境變量,新增配置“%GRADLE_HOME%\bin”。
到這里 Gradle 的安裝就已經(jīng)完成了,接下來我們使用命令行執(zhí)行工具,來測(cè)試一下 Gradle 安裝是否成功。
打開一個(gè)新的 cmd 命令窗口,輸入命令 gradle -v
,如果出現(xiàn)版本消息,則說明配置成功,如下所示:
C:\Users\stone>gradle -v
------------------------------------------------------------
Gradle 5.6.4
------------------------------------------------------------
Build time: 2019-11-01 20:42:00 UTC
Revision: dd870424f9bd8e195d614dc14bb140f43c22da98
Kotlin: 1.3.41
Groovy: 2.5.4
Ant: Apache Ant(TM) version 1.9.14 compiled on March 12 2019
JVM: 1.8.0_211 (Oracle Corporation 25.211-b12)
OS: Windows 10 10.0 amd64
出現(xiàn)如上版本信息,則說明 Gradle 已經(jīng)正常安裝完成。
Gradle 加速
和 Maven 的配置相同,我們可以給 Gradle 配置一個(gè)阿里的數(shù)據(jù)源,加速項(xiàng)目的構(gòu)建(加上下載 Jar 包),找到配置文件 init.gradle,我的默認(rèn)目錄在 C:\Users\用戶名.gradle,如果沒有找到則新建一個(gè) init.gradle 文件,之后添加如下配置:
allprojects {
repositories {
maven {
url "http://maven.aliyun.com/nexus/content/groups/public"
}
}
}
2.下載最新版的Spring源碼
Spring 源碼地址:https://github.com/spring-projects/spring-framework
小貼士:最好 Fork 一個(gè)項(xiàng)目,因?yàn)檫@樣你就可以修改源碼并添加注釋信息到你的倉庫了,這樣就可以把自己學(xué)習(xí) Spring 源碼的過程記錄并管理起來。
源碼下載加速
因?yàn)?nbsp;Spring 的源碼文件比較多,如果使用 Spring 原地址下載的話時(shí)間會(huì)非常長,甚至?xí)L試很多次才能完成,此時(shí)我們可以使用國內(nèi)碼云(gitee)上的地址,下載速度會(huì)快很多,碼云的地址為https://gitee.com/mirrors/Spring-Framework
如下圖所示,使用官方提供的 Spring 源碼地址,每天同步一次。
3.導(dǎo)入和編譯Spring
Spring 源碼下載完成之后,我們就可以使用 IDEA 導(dǎo)入源碼項(xiàng)目了,為了加快源碼編譯的速度,在導(dǎo)入之后我們可以編輯 Spring 源碼根目錄下的 settings.gradle 文件,添加阿里的源配置信息:
maven { url "http://maven.aliyun.com/nexus/content/groups/public/"}
配置如圖所示:
接下來我們就可以導(dǎo)入 Spring 源碼了,點(diǎn)擊 Import Project,選擇 Spring 源碼的路徑,選擇 Gradle 方法導(dǎo)入,如下圖所示:
點(diǎn)擊 Next,選擇本地的 Gradle 路徑,如下圖所示:
然后點(diǎn)擊 Finish 就會(huì)進(jìn)入項(xiàng)目的自動(dòng)構(gòu)建階段了。
Spring 構(gòu)建完成(耗時(shí)比較長),如下圖所示:
到現(xiàn)在為止,Spring 源碼的搭建就已經(jīng)完成了。
調(diào)試Spring源碼
首先我們?cè)?Spring 源碼項(xiàng)目中新增一個(gè)測(cè)試項(xiàng)目,點(diǎn)擊 New -> Module... 創(chuàng)建一個(gè) Gradle 的 Java 項(xiàng)目,如下圖所示:
創(chuàng)建完成之后,我們?cè)?build.gradle 中添加對(duì) Spring 源碼的依賴:
api(project(":spring-context"))
如下圖所示:
接著,我們需要在項(xiàng)目中創(chuàng)建一個(gè) bean 和配置文件(application.xml)及啟動(dòng)文件(MyApplication.java)。
bean 實(shí)現(xiàn)代碼如下:
public class Person {
private Integer id;
private String name;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
啟動(dòng)類 MyApplication 代碼如下:
import org.springframework.beans.Person;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class MyApplication {
public static void main(String[] args) {
ApplicationContext context =
new ClassPathXmlApplicationContext("classpath*:application.xml");
Person person = context.getBean("person", Person.class);
System.out.println(person.getName());
}
}
配置文件 application.xml(在 resources 中)配置如下:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="person" class="org.springframework.beans.Person">
<property name="id" value="1"/>
<property name="name" value="Java"/>
</bean>
</beans>
接下來我們就可以啟動(dòng)并調(diào)試 Spring 的源碼了。
總結(jié)
Spring 源碼的閱讀并沒有我們想的那么難,安裝 Spring 源碼的調(diào)試壞境只是幫你理清楚 Spring 的執(zhí)行流程。我們只需要下載 Spring 的源碼,安裝 Gradle 的環(huán)境,再導(dǎo)入到編譯器中編譯 Spring 源碼包,最后在 Spring 源碼項(xiàng)目中新建一個(gè) Java 項(xiàng)目添加對(duì) Spring 模塊的引用,就可以調(diào)試并執(zhí)行 Spring 源碼了,這樣我們就可以進(jìn)入 Spring 的內(nèi)部,進(jìn)行相關(guān)的源碼閱讀了。
特別推薦一個(gè)分享架構(gòu)+算法的優(yōu)質(zhì)內(nèi)容,還沒關(guān)注的小伙伴,可以長按關(guān)注一下:
長按訂閱更多精彩▼
如有收獲,點(diǎn)個(gè)在看,誠摯感謝
免責(zé)聲明:本文內(nèi)容由21ic獲得授權(quán)后發(fā)布,版權(quán)歸原作者所有,本平臺(tái)僅提供信息存儲(chǔ)服務(wù)。文章僅代表作者個(gè)人觀點(diǎn),不代表本平臺(tái)立場(chǎng),如有問題,請(qǐng)聯(lián)系我們,謝謝!