天天看點

Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程

Spring 5源碼閱讀系列(1):源碼閱讀環境搭建

  • 學習任務
  • 前期準備
  • 搭建過程
    • 1. 下載下傳源碼
    • 2. 源代碼導入
      • 2.1 導入Eclipse
        • 2.1.1 版本要求
        • 2.1.2 安裝插件
        • 2.1.3 代碼導入
      • 2.2 導入IDEA
    • 3. 解決項目報錯
      • 3.1. API Acess Restriciton
      • 3.2. Groovy Mismatch Problem

學習任務

近期想增加部分源碼閱讀經驗,提高自己在造輪子方面的實力,增長些在設計模式應用方面的編碼能力,以及懷着向大佬們膜拜的心情,開始有計劃地閱讀Spring源碼

前期準備

以下幾項準備事項,算是基本的日常開發環境,就算沒有,也是動動手很快安裝好的,這裡就不啰嗦詳細記錄了。
若安裝存在困難的,可以嘗試百度解決:請相信自己可以做到的!
  • JDK 1.8 安裝及其環境配置(略)
  • Eclipse安裝,或者 IntelliJ IDEA(略)
  • Git用戶端安裝(略)
  • Gradle 安裝及其環境變量配置(略)

搭建過程

1. 下載下傳源碼

通路 spring-framework 項目官方源碼網站,檢視版本Release日志,標明比較穩定合适的版本來分析學習:

Spring源碼的git位址:

https://github.com/spring-projects/spring-framework

Spring Release版本:

https://github.com/spring-projects/spring-framework/releases

本文選取最近釋出的:v5.1.x分支,進行後續的源碼閱讀:

# 擷取源碼
git clone https://github.com/spring-projects/spring-framework.git
# 根據網速,上面這一步可能相當慢

# 檢視遠端分支
git branch -r

# 建立切換本地分支
git checkout -b 5.1.x  origin/5.1.x
git pull
           
Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程

Note:可能大家在代碼checkout這裡時,會卡住——因為衆所周知的原因,通路github确實是很慢,是以可以通過修改hosts的映射來加速github的通路,具體方法可以問度娘;

我在這裡貼出我自己根據網上的方法,增加的hosts映射内容;但可能對部分其它地區的朋友無效;是以需要自己按照網上的方法,自己來做一遍!

# hosts file
# speed up access to github
192.30.253.112	github.com
185.199.110.153	assets-cdn.github.com
185.199.110.154	github.githubassets.com
151.101.185.194	github.global.ssl.fastly.net
           

2. 源代碼導入

代碼下載下傳後,先不着急,按照行業慣例,看下README.md等一些說明文檔;一般都會有文檔指導你如何從源碼編譯項目等介紹性說明。

但Spring更良心,竟然還提供了說明文檔,怎麼導入不同的代碼IDE中:

  • import-into-eclipse.md
  • import-into-idea.md

既然如此,那就按文檔說明,開始導入IDE中吧!

2.1 導入Eclipse

2.1.1 版本要求

檢視

import-into-eclipse.md

文檔,裡面說,導入Eclipse前,需要滿足一些前提條件:

  • Eclipse支援JDK8
  • Eclipse需要安裝AspectJ Development Tools(AJDT);AJDT支援的Eclipse版本有:
    • 2018-09 (4.9)
    • Photon (4.8)
    • Oxygen (4.7)
    • Neon (4.6)
    • Juno (4.2, 3.8)
    • Previous to Juno (<=4.1)
  • Eclipse需要安裝Groovy Compiler

2.1.2 安裝插件

本機環境是Oxygen,在Eclipse Marketplace中安裝了AJDT和Groovy插件(截圖時插件已經安裝),如圖:

Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程
Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程
Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程

Note:其實還需要安裝gradle插件(Buildship Gradle integration),但Oxygen已經預安裝了,就幫我們省了不少事

2.1.3 代碼導入

按文檔所示,導入Eclipse需要5步:

  • 1、用指令

    ./gradlew :spring-oxm:compileTestJava

    預編譯子項目

    spring-oxm

    ;
    Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程
  • 2、導入Eclispe(File -> Import -> Gradle ->Existing Gradle Project -> 浏覽到項目路徑 -> 選擇”完成“);
    Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程
    Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程

NOTE:這個過程有點慢,因為和maven項目一樣,gradle項目也需要下載下傳依賴包;

  • 3、如果有相關提示,排除

    spring-aspects

    項目(或者在導入項目後,關閉或者删除這個子項目);
    Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程
  • 4、在子項目

    spring-oxm

    中,将

    build/generated-sources

    下面的

    jaxb

    子目錄加入到

    build path

    中(在目錄中右鍵選擇

    Build Path -> Use as Source Folder

    );
  • 5、如果有對項目有其它額外的配置要求,可以運作

    ./gradlew eclipseBuildship

2.2 導入IDEA

導入IDEA和導入Eclipse的操作基本上完全一樣,隻是沒有第4步,然後第3步關閉的是Module;

TODO:(細節待後續增補)

3. 解決項目報錯

3.1. API Acess Restriciton

修改JRE預設的API Access Rule即可:Build Path -> Library -> edit

Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程

有兩個子項目會有這個問題:

spring-context

spring-web

每個都這樣設定一下,就可以解決了。

3.2. Groovy Mismatch Problem

在項目視圖,發現

spring-build-src

上面有個感歎号,但代碼中又沒有出現錯誤;這種情況,一般是和項目配置,比如

Build Path

Project Facets

等等;具體資訊可以展開

Markers

視圖來檢視下,如下圖:

Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程

原來是groovy版本問題:工作空間設定的是2.5,但spring項目設定是的2.4。

spring-build-src

上右鍵,修改

groovy compiler level

就可以解決這個問題了:

Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程

到此,源碼閱讀環境搭建完成!

上最終完成的效果圖:

Spring 5源碼閱讀系列(1):源碼閱讀環境搭建學習任務前期準備搭建過程

開始艱苦的源碼閱讀之路!少年,我們一起加油!

繼續閱讀