Gradle搭建Spring源码阅读环境
目目沐沐 人气:8# 基于Gradle
搭建Spring 5.5.13-release
源码阅读环境
Spring
版本:5.3.13-release
# 1、安装JDK
首先需要保证本地已经安装JDK1.8
及以上版本。这里不做过多赘述,自行安装即可。
# 2、安装Gradle
Spring 5.x
开始全部都采用Gradle
进行编译,构建源码前需要提前安装Gradle
。Gradle
官网下载地址为:Gradle官网地址。- 我这里使用的版本是最新的
gradle-7.3.1
。下载链接为:Gradle-7.3.1下载地址。 - 下载完成之后解压到文件夹。
- 配置
Gradle
环境变量,在环境变量的系统变量中添加如下:
$ GRADLE_HOME $ D:\develop\IDE-Gradle\gradle-7.3.1
在系统环境变量的path
中添加环境变量:
$ %GRADLE_HOME%\bin
检测环境,使用gradle -v
命令在Terminal
中查看:
$ gradle -v
显示如下图则代表gradle
安装成功。
在gradle
安装目录下的init.d
文件夹下新建一个init.gradle
文件,加入如下配置:
repositories
中配置获取依赖jar
包的顺序:- 先是从本地
maven
仓库中获取 - 然后
mavenLocal()
是获取maven本地仓库的路径,和第一条一样,但是不冲突 - 第三条第四条分别为国内
alibaba
镜像仓库和国外bstek
镜像仓库 - 最后
mavenCentral()
是从apache提供的中央仓库中获取依赖jar
包
allprojects { repositories { maven { url 'file:///D:/develop/IDE-Repository'} mavenLocal() maven { name "Alibaba" ; url "https://maven.aliyun.com/repository/public" } maven { name "Bstek" ; url "https://nexus.bsdn.org/content/groups/public/" } mavenCentral() } buildscript { repositories { maven { url 'https://maven.aliyun.com/repository/google'} maven { url 'https://maven.aliyun.com/repository/jcenter'} maven { url 'https://maven.aliyun.com/nexus/content/groups/public'} } }
# 3、Spring版本命名规则
版本名称 | 版本 | 版本意思 |
---|---|---|
snapshot | 快照版 | 尚不稳定,处于开发中的版本 |
release | 稳定版 | 功能相对稳定的版本,可以对外发行,但是有时间限制 |
GA(General Availability) | 正式版 | 可广泛使用的稳定版本 |
M(Milestone) | 里程碑版 | 具有一些全新的功能货时具有里程碑意义的版本 |
RC(Release Candidate) | 最终测试 | 即将作为正式版本发布的版本 |
# 4、下载Spring 5.3.13-release源码
自Spring 3.x
开始,Spring
官方不在提供源码下载,所有源代码全部托管在github
。Spring Github托管代码首页地址。
spring framework 5.3.13-release
:
- 源码访问地址:
https://github.com/spring-projects/spring-framework/releases/tag/v5.3.13
- 源码
zip
压缩包下载地址:https://github.com/spring-projects/spring-framework/archive/refs/tags/v5.3.13.zip
- 源码
tar.gz
压缩包下载地址:https://github.com/spring-projects/spring-framework/archive/refs/tags/v5.3.13.tar.gz
- 国内
gitee
托管源码访问地址:https://gitee.com/mirrors/Spring-Framework?_from=gitee_search
- 国内
getee
源码zip
压缩包下载地址:https://gitee.com/mirrors/Spring-Framework/repository/archive/v5.3.13
下载完成之后解压即可。
# 5、修改Spring源码中Gradle配置
修改Spring
源码的Gradle
构建配置,在Spring
源码下修改gradle/wrapper/gradle-wrapper.properties
文件如下:
修改distributionUrl
为本地的gradle
安装包路径,从本地拉去,加快源码构建编译的速度。
distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists ## distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip ## 配置本地gradle, 配置之后需要配置gradle的中央仓库(阿里云maven中央仓库) distributionUrl=file:///D:/develop/IDE-Gradle/gradle-7.3.1-all.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists
设置阿里云镜像:
修改根目录下build.gradle
文件中的repositories
:
repositories { // 配置本地maven仓库 mavenLocal() // 配置阿里云maven仓库 maven { url "https://maven.aliyun.com/nexus/content/groups/public/" } maven { url "https://maven.aliyun.com/nexus/content/repositories/jcenter/" } // maven中央仓库 mavenCentral() maven { url "https://repo.spring.io/libs-spring-framework-build" } }
修改根目录下settings.gradle
文件中pluginManagement
下的repositories
:
pluginManagement { repositories { // 配置阿里云 maven 中央仓库 maven { url 'https://maven.aliyun.com/repository/public/' } gradlePluginPortal() maven { url 'https://repo.spring.io/plugins-release/' } } }
修改根目录下gradle.properties
文件,将jvmargs
根据自己本机内存重新分配内存大小,我这里分配了10G
的内存:
version=5.3.13 org.gradle.jvmargs=-Xmx10240m org.gradle.caching=true org.gradle.parallel=true kotlin.stdlib.default.dependency=false
# 6、构建Spring源码
使用Terminal
进入解压后Spring
源码所在的文件目录下,预编译spring-oxm
模块:
$ ./gradlew :spring-oxm:compileTestJava
如某个jar
包没下载成功等,只需要重新执行./gradlew :spring-oxm:compileTestJava
再次进行预编译就行了。
构建完成之后修改根目录下setting.gradle
文件,注释掉spring-aspects
:
.... include "spring-aop" // 移除aspects // include "spring-aspects" include "spring-beans" include "spring-context" ....
# 7、导入IDEA 点击File --> New --> Project from Existing Sources...
然后选择Spring
源码所在的目录
点击ok
后选择使用gradle
导入然后点击Finish
导入之后IDEA
会自动进行构建,终止自动构建,此时还需要进行一些设置,Ctrl+Alt+S
快捷键打开IDEA
设置。
点击File | Settings | Build, Execution, Deployment | Compiler
,修改构建时堆内存大小(根据自己的电脑内存自行分配即可,我这里里是分配了5G
):
点击File | Settings | Build, Execution, Deployment | Build Tools | Gradle
,配置IDEA
的Gradle
配置:
Ctrl+Alt+Shift+S
快捷键打开Project Structure
。修改工程的SDK
,分别将Project
、Modules
、SDKs
中的JDK
设置为本地安装的JDK
(版本为1.8及以上)。
Ctrl+Alt+Shift+S
快捷键打开Project Structure
。在Modules
中排除spring-aspects
:
Alt+F12
快捷键打开Terminal
,使用gradlew.bat
命令进行编译
$ gradlew.bat
编译成功后会出现BUILD SUCCESSFUL
的提示。如果有报错根据报错信息进行处理,多编译几次即可。
编译成功后整个工程如下图所示:
使用shift+shift
快捷键输入ApplicationContext
类,使用Ctrl+Shift+Alt+U
如果能够成功打开类图,也证明Spring
源码构建成功:
# 8、创建Spring源码debug调试模块
使用gradle
创建一新的debug
模块。
创建完成之后将新建模块的build.gradle
修改为:新建的模块名称。如我新建的模块叫spring-context-debug
,则将其修改为:spring-context-debug.gradle
并在其中配置:
plugins { id 'java' } group 'org.springframework' version '5.3.13' repositories { // 配置本地 maven 仓库 mavenLocal() // 配置阿里云 maven 仓库 maven { url 'https://maven.aliyun.com/nexus/content/groups/public/' } maven { url 'https://maven.aliyun.com/nexus/content/repositories/jcenter' } // 配置 maven 中央仓库 mavenCentral() dependencies { // 测试需要依赖 testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0' // 导入 spring-context模块, 包含bean工厂 implementation(project(':spring-context')) // 导入 spring-instrument 模块, 此模块为 spring-context 模块编译所必须的 implementation(project('::spring-instrument')) // compile已经被gradle 7.x 弃用, 爷也是醉了 // compile(project(":spring-context")) test { useJUnitPlatform()
为新建模块添加spring-context
和spring-instrument
依赖。配置完成之后刷新gradle
。如下图所示,gradle
中新建模块的runtimeClasspath
中已经新增project spring-conetxt
和project spring-instrument
代表以来成功。
创建一个TestBean
实现DebugBean
DebugBean.java
:
package com.kapcb.ccc.model; /** * <a>Title: Bean </a> * <a>Author: Kapcb <a> * <a>Description: Bean <a> * * @author Kapcb * @version 1.0 * @date 2021/12/11 23:21 * @since 1.0 */ public interface DebugBean { /** * say method */ void say(); }
TestBean.java
:
package com.kapcb.ccc.model; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; /** * <a>Title: TestBean </a> * <a>Author: Kapcb <a> * <a>Description: TestBean <a> * * @author Kapcb * @version 1.0 * @date 2021/12/11 23:21 * @since 1.0 */ public class TestBean implements DebugBean { protected final Log log = LogFactory.getLog(getClass()); private String username; public TestBean() { log.info("调用TestBean无参构造器"); } @Override public void say() { log.info("Hi, I'm " + this.username); public void setUsername(String username) { log.info("调用TestBean中的setUsername方法注入属性"); this.username = username; }
添加测试代码,使用注解模式声明一个Bean
:
package com.kapcb.ccc.configuration; import com.kapcb.ccc.model.DebugBean; import com.kapcb.ccc.model.TestBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Scope; /** * <a>Title: AnnotationTestConfiguration </a> * <a>Author: Kapcb <a> * <a>Description: AnnotationTestConfiguration <a> * * @author Kapcb * @date 2021/12/15 16:06 */ @Configuration public class AnnotationTestConfiguration { @Bean("testBean") @Scope("singleton") public DebugBean debugBean() { TestBean testBean = new TestBean(); testBean.setUsername("Kapcb(Annotation)"); return testBean; } }
添加测试代码:
package com.kapcb.ccc; import com.kapcb.ccc.configuration.AnnotationTestConfiguration; import com.kapcb.ccc.model.DebugBean; import org.springframework.beans.factory.BeanFactory; import org.springframework.context.annotation.AnnotationConfigApplicationContext; /** * <a>Title: AnnotationApplication </a> * <a>Author: Kapcb <a> * <a>Description: AnnotationApplication <a> * * @author Kapcb * @date 2021/12/15 16:05 */ public class AnnotationApplication { public static void main(String[] args) { BeanFactory beanFactory = new AnnotationConfigApplicationContext(AnnotationTestConfiguration.class); DebugBean testBean = beanFactory.getBean("testBean", DebugBean.class); testBean.say(); } }
使用debug
模式运行,如果debug
模式启动main
方法报错,尝试修改:File | Settings | Build, Execution, Deployment | Debugger | Data Views | Kotlin
在Disable coroutine agent前勾选后保存。
启动成功后控制台会输出如下日志:
Connected to the target VM, address: '127.0.0.1:55594', transport: 'socket'
一月 06, 2022 2:56:42 下午 com.kapcb.ccc.model.TestBean <init>
信息: 调用TestBean无参构造器
一月 06, 2022 2:56:42 下午 com.kapcb.ccc.model.TestBean setUsername
信息: 调用TestBean中的setUsername方法注入属性
一月 06, 2022 2:56:42 下午 com.kapcb.ccc.model.TestBean say
信息: Hi, I'm Kapcb(Annotation)
Disconnected from the target VM, address: '127.0.0.1:55594', transport: 'socket'
GitHub源码地址:https://github.com/kapbc/kapcb-spring-source/tree/master/Spring-Framework-v5.3.13
加载全部内容