為什麼要閱讀原始碼?這是一個有趣的問題,類似的問題還有,為什麼要看書?為什麼要爬山?
這也是一個哲學問題,我想每個人都有不同的答案,下面我是對閱讀原始碼好處的一些思考。 (PS:也歡迎你在評論區留言補充)
閱讀原始碼的好處
1.知其然知其所以然
這是一句 IT 人都很熟悉的話,在開源軟體越來越多,並且升級越來越快的今天,如果說還有什麼是重要的,那一定是知道它(開源軟體)的核心原理和執行流程,這樣就能為我們快速定位並修復問題提供寶貴的時間。
2.讓自己變得更加優秀
學習原始碼可以讓我們站在巨人的肩膀上,你可以學習原始碼中的優秀編碼技巧和巧妙的設計思路,以及設計模式的落地應用,還有一些經典的編碼規範和命名規則等。以此來約束和改進自己的程式設計程式碼,才能寫成更好的程式碼。
3.找到更好的工作
在日益競爭激烈的面試中,尤其是在大廠的面試中,對於原始碼的考察非常看重,只有瞭解和熟悉這些原始碼,才能獲得自己想要的 offer。
那既然閱讀原始碼有這麼多的好處,我們該如何開始呢?
如何閱讀原始碼?
閱讀原始碼的實現思路是這樣的,首先我們需要下載 Spring 原始碼,然後把 Spring 的原始碼匯入到 IDE 中,然後再編譯 Spring 原始碼,再以新增 Module 的方式新增測試程式碼,再把 Spring 原始碼部分引入到 Module 中,此時我們就可以使用除錯功能進入 Spring 框架的內部,檢視方法的執行流程和原始碼的具體實現。
Spring 原始碼閱讀流程,如下圖所示:
搭建Spring原始碼閱讀環境
本文實現環境:Window 10 / JDK 8 / Spring 5.2.2 / IDEA 2019
注意:Spring 4.x 之後需要 JDK 8 以上的環境。
1.安裝Gradle
在正式開始之前我們需要先安裝 Gradle,因為 Spring 是基於 Gradle 構建的。
Gradle 是一個開源的基於 JVM 構建工具,和 Maven 工具類似。專案的構建經歷了三個時代:Apache Ant(2000 年左右)、Maven(2004年)和 Gradle(2012 年左右),Gradle 相比於 Maven 配置更加簡單、效能更高、使用者體驗更好(IDE 支援程式碼提示)。
例如,使用 maven 時,配置檔案如下:
<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 等優秀的開源專案都將自己的專案從 Maven 遷移到了 Gradle,Google 官方 Android 開發的 IDE Android Studio 也預設使用了 Gradle 進行構建。但不可否認的是,Maven 在如今仍然是 Java 專案構建的主流方式。
Gradle 和 Maven 的效能測試,如下圖所示:
IDEA 對 Gradle 的支援如下圖所示:更多關於 Gradle vs Maven 的文章,可以訪問 Gradle 官方提供文章:gradle.org/maven-vs-gr…
首先,我們需要下載 Gradle 安裝包,下載地址為:gradle.org/releases/
選擇 binary-only 安裝包,下載即可。
注意:需要安裝 Gradle 5.X 的版本,Spring 最新版不支援 Gradle 6+ 版本。如果安裝 6+ 版本會報錯,資訊如下:
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”。
解壓完成之後,我們需要配置兩個系統變數。
右鍵計算機 -> 屬性 -> 高階系統設定 -> 環境變數,在系統變數區域,先點選“新建”輸入變數名為:GRADLE_HOME,變數值為:C:\gradle\gradle-5.6.4(根據自己的路徑填寫);再找到 Path 環境變數,新增配置“%GRADLE_HOME%\bin”。
到這裡 Gradle 的安裝就已經完成了,接下來我們使用命令列執行工具,來測試一下 Gradle 安裝是否成功。
開啟一個新的 cmd 命令視窗,輸入命令 gradle -v
,如果出現版本訊息,則說明配置成功,如下所示:
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
複製程式碼
出現如上版本資訊,則說明 Gradle 已經正常安裝完成。
Gradle 加速
和 Maven 的配置相同,我們可以給 Gradle 配置一個阿里的資料來源,加速專案的構建(加上下載 Jar 包),找到配置檔案 init.gradle,我的預設目錄在 C:\Users\使用者名稱.gradle,如果沒有找到則新建一個 init.gradle 檔案,之後新增如下配置:
allprojects {
repositories {
maven {
url "http://maven.aliyun.com/nexus/content/groups/public"
}
}
}
複製程式碼
2.下載最新版的Spring原始碼
Spring 原始碼地址:github.com/spring-proj…
小貼士:最好 Fork 一個專案,因為這樣你就可以修改原始碼並新增註釋資訊到你的倉庫了,這樣就可以把自己學習 Spring 原始碼的過程記錄並管理起來。
原始碼下載加速
因為 Spring 的原始碼檔案比較多,如果使用 Spring 原地址下載的話時間會非常長,甚至會失敗嘗試很多次才能完成,此時我們可以使用國內碼雲(gitee)上的地址,下載速度會快很多,碼雲的地址為https://gitee.com/mirrors/Spring-Framework
如下圖所示,使用官方提供的 Spring 原始碼地址,每天同步一次。
3.匯入和編譯Spring
Spring 原始碼下載完成之後,我們就可以使用 IDEA 匯入原始碼專案了,為了加快原始碼編譯的速度,在匯入之後我們可以編輯 Spring 原始碼根目錄下的 settings.gradle 檔案,新增阿里的源配置資訊:
maven { url "maven.aliyun.com/nexus/conte…"}
配置如圖所示:
接下來我們就可以匯入 Spring 原始碼了,點選 Import Project,選擇 Spring 原始碼的路徑,選擇 Gradle 方法匯入,如下圖所示:
點選 Next,選擇本地的 Gradle 路徑,如下圖所示:
然後點選 Finish 就會進入專案的自動構建階段了。
Spring 構建完成(耗時比較長),如下圖所示:
到現在為止,Spring 原始碼的搭建就已經完成了。
除錯Spring原始碼
首先我們在 Spring 原始碼專案中新增一個測試專案,點選 New -> Module... 建立一個 Gradle 的 Java 專案,如下圖所示:
建立完成之後,我們在 build.gradle 中新增對 Spring 原始碼的依賴:
api(project(":spring-context"))
複製程式碼
如下圖所示:
接著,我們需要在專案中建立一個 bean 和配置檔案(application.xml)及啟動檔案(MyApplication.java)。
bean 實現程式碼如下:
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;
}
}
複製程式碼
啟動類 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>
複製程式碼
接下來我們就可以啟動並除錯 Spring 的原始碼了。
總結
Spring 原始碼的閱讀並沒有我們想的那麼難,安裝 Spring 原始碼的除錯壞境只是幫你理清楚 Spring 的執行流程。我們只需要下載 Spring 的原始碼,安裝 Gradle 的環境,再匯入到編譯器中編譯 Spring 原始碼包,最後在 Spring 原始碼專案中新建一個 Java 專案新增對 Spring 模組的引用,就可以除錯並執行 Spring 原始碼了,這樣我們就可以進入 Spring 的內部,進行相關的原始碼閱讀了。
更多精彩內容,請關注微信公眾號「Java中文社群」