使用IDEA环境编译Spring源码及spring源码调试环境搭建

绝地灬酷狼 2024-04-18 08:26 77阅读 0赞

前言：

spring项目在开发中使用gradle进行项目自动化构建，所以在导入spring工程项目之前需要先安装gradle工具。

版本说明：

> spring：[spring-framework-4.3.x][]
> 
> gradle：[gradle-4.10.2][]
> 
> jdk：jdk1.8.0\_152
> 
> 开发环境：IntelliJ IDEA 2017.3.5
> 
> 操作系统：Windows 7

注：安装gradle的版本不要太高。事先选择gradle-5.6.1版本，在构建spring项目时会报错，分析原因是gradle版本兼容问题。

备注：[spring-framework-4.3.x官方文档][spring-framework-4.3.x 1]

--------------------

### 一、安装gradle ###

1. 从gradle[官网下载][gradle-4.10.2]软件包

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70][]

然后解压：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 1][]

2. 配置gradle的环境变量

1）新增 GRADLE\_HOME 环境变量，指向Gradle解压目录

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 2][]

2）配置Path环境变量:新增 %GRADLE\_HOME%\\bin

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 3][]

3）测试gradle是否安装成功

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 4][]

至此，gradle安装成功。

### 二、下载spring源码，构建spring源码工程 ###

1. 下载spring源码，进行预编译

下载[spring-framework-4.3.x源码][spring-framework-4.3.x]并解压。源码解压后根据spring工程目录下说明文件import-into-idea.md对spring-oxm进行预编译操作。

> （1）gradlew是包装器，执行gradlew会自动下载包装器里定义好的gradle版本，保证编译环境统一。
> 
> （2）gradlew clean 命令：清除工程目录下的build文件夹。
> 
> （3）[compileTestJava][]：使用JDK编译器javac编译测试源文件

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 5][]

预编译花费时间比较长，其中可能会多次出现各种报错，需要多重试几次。过程中出现警告不用管，只要预编译成功即可。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 6][]

2. IDEA导入spring源码，构建工程

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 7][]

弹出“Import Project from Gradle”对话框：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 8][]

点击”OK“后，IDEA会自动执行项目根目录下的build.gradle文件，进行自动化构建spring源码。构建期间若出现异常（如下图），通过查找[相关资料][Link 1]，分析是项目根目录下的build.gradle文件中的org.sonarqube插件版本兼容问题。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 9][]

将org.sonarqube插件版本升级至2.6.1，重新构建工程：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 10][]

### 三、构建工程报错解决思路 ###

1. 仔细阅读spring源码工程根目录下的import-into-idea.md说明文档。文档中提供了编译spring源码之前的准备工作以及编译过程中可能出现的已知问题。

2. 编译过程中若出现Error:(354, 51) java: 找不到符号 符号: 变量 XXX 位置: 类 org.springframework.core.xxx.XXXX 等问题，可能是gradle版本问题，不妨修改gradle的版本后重新构建工程。

本文首次构建spring工程使用的是gradle-5.6.1版本，构建不成功，故重新使用了gradle-4.10.2版本再次构建工程。在排除org.sonarqube插件版本兼容问题后，构建spring工程成功。\[猜测：如果使用合适的gradle版本，可能插件版本兼容问题也不存在。\]

### 四、spring源码调试环境搭建 ###

1.创建Demo模块：spring-demo

创建demo模块，并且使demo模块依赖spring工程的本地源码，这样在运行、调试demo模块代码时可以进入spring源码内，方便做笔记。

本文使用maven构建Demo模块：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 11][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 12][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 13][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 14][]

spring-demo创建完成后，向该模块中添加相关spring本地源码依赖：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 15][]

至此，完成spring-demo模块关联spring本地核心源码模块工作。

2. 编写spring-demo模块代码

本文spring-demo模块代码来自[from\_lazy\_boy博客][from_lazy_boy]。

3. 运行调试spring-demo

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 16][]

【参考文章】

\[1\] [IDEA阅读spring源码并调试][from_lazy_boy]

\[2\] [使用idea和gradle编译spring5源码][idea_gradle_spring5]

\[3\] [Spring源码——IDEA读Spring源码环境搭建][Spring_IDEA_Spring]

\[4\] I[ntelliJ下Gradle 构建Spring 5.X 源码（图文详细版）][ntelliJ_Gradle _Spring 5.X]

--------------------

2020-11-24 更新

> 编译版本：[spring-framework-5.0.x][] ，[spring-framework-5.0.x官方文档][spring-framework-5.0.x 1]
> 
> gradle版本：[gradle-4.4.1][gradle-4.10.2] 
> 
> JDK版本：jdk1.8.0\_241
> 
> idea：IntelliJ IDEA 2020.1
> 
> 操作系统：Mac Catalina (10.15.1)

备注：

1. 开始使用gradle 4.9编译spring源码，编译过程中总是不断报错（报错都不一样），然后[参考文章][Link 2]，将gradle版本降低到4.4.1，顺利编译成功（编译过程中可能由于某些原因失败，多build几次即可）。

2. 查看spring编译情况(用浏览器打开)：file:///Users/$\{用户名\}/work/Project/java/spring-framework-5.0.x/$\{spring模块名\}/build/reports/tests/test/index.html

e.g. file:///Users/eshaon/work/Project/java/spring-framework-5.0.x/spring-websocket/build/reports/tests/test/index.html  ，如图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 17][]

[spring-framework-4.3.x]: https://github.com/spring-projects/spring-framework/tree/4.3.x
[gradle-4.10.2]: https://gradle.org/releases/
[spring-framework-4.3.x 1]: https://docs.spring.io/spring/docs/4.3.x/spring-framework-reference/html/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/cd3e5582adf647dba26b0abded7f7ede.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/efe1732598b34845b17d530ebe92926f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/38dcc92dee8a482299060f2b617b28ae.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/fc170dc59e0a484281b844a368e72b9d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/6d48b7ba26a645ec8f04ea5316d24d68.png
[compileTestJava]: https://docs.gradle.org/4.10.2/userguide/java_plugin.html#sec:java_tasks
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/eb4b476bc90b4c2bbea7aca331c6c664.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/0dd797a3383746f88802ae933234b5c3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/cd25a79784914add8bf92c9057acca4c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/1330b9ae7d8a457e92a8f0d67294e70c.png
[Link 1]: https://stackoverflow.com/questions/44363124/gradle-sync-failed-cause-org-gradle-listener-actionbroadcast
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/4926ebd970ed46eb853fc7775f734f53.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/c125c3477d454232bd2c021fd0393bb1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/9787179294fc482d9b239f196a37560f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/f50f783861a24a0f9cbba86faaf91ac3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/6ed62e62a17d4019b2bc70489e55063f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 14]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/4c412862fcb949ddb0836d1c4b70a559.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 15]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/108b90aa79ee4db28f6bc8161f718eaf.png
[from_lazy_boy]: https://blog.csdn.net/u013310075/article/details/80707098#commentBox
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 16]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/b399f733906d48e88ecbf92bc091e774.png
[idea_gradle_spring5]: https://blog.csdn.net/baomw/article/details/83956300#commentBox
[Spring_IDEA_Spring]: https://blog.csdn.net/bskfnvjtlyzmv867/article/details/81171802#commentBox
[ntelliJ_Gradle _Spring 5.X]: https://blog.csdn.net/u012211419/article/details/80445276
[spring-framework-5.0.x]: https://github.com/spring-projects/spring-framework/tree/5.0.x
[spring-framework-5.0.x 1]: https://docs.spring.io/spring-framework/docs/5.0.x/javadoc-api/
[Link 2]: https://www.cnblogs.com/zxq-Study-Java/p/12597764.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyMDE0NjYz_size_16_color_FFFFFF_t_70 17]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/74e7bf54d4cb41128f0a49cfdb8a2503.png