人手一套！本地编译Spring源码，让你的阅读如丝般顺滑

骑猪看日落 2022-08-30 01:55 229阅读 0赞

大家好，我是七哥。

之前不是在B站出了那个离开 Spring 框架我们要如何写接口的视频，带着大家实现一个mini版的 Spring 框架嘛。

![2c8c577a8120deb52f39db150c1b0898.png][]

这个呀，就有小伙伴在评论区就提出了困惑，**自己在学习 Spring 的时候，这个源码环境有些搞不定**。 那这怎么能行，不能因为这点小困难就让小伙伴放弃呀。

### 文章目录 ###

*   *   *  1. 下载Spring源码
         *  2. 阅读Spring的官方编译文档
         *  3. 修改配置
         *   *  从本地下载gradle
             *  修改远程仓库
         *  4. 开始编译构建
         *  5. 导入IDEA
         *  6. 验证测试
         *  7. 总结

这里咱就不在赘述读Spring源码的好处了吧，想干这行的应该都懂。

这个视频就是要带那些想要学习 Spring 源码的小伙伴，手把手带大家把这个源码编译好，这活尽量呀，给大家得整的漂亮点。

这里说明下，这个操作过程不需要科学上网，但是，注意了，这里有个但是，你总得保证你的电脑能上网吧。

考虑到有的小伙伴可能因为网络原因可能访问不了 `github` 或者下载非常慢，那这种情况的小伙伴也可以选择看我那期一招搞定 `github` 访问慢的文章。

[程序员必备的GitHub加速指南][GitHub]

当然不搞也没关系，视频中涉及的源码和工具包七哥也都会打包下载好了，有需要的在公众号【七哥聊编程】直接回复：**spring源码**，就会自动发送给你了。

那来吧，直接开搞。

### 1. 下载Spring源码 ###

这里有的小伙伴可能不知道源码在哪下载，没关系！这种问题的思路一般是我们要搞某个技术，第一反应就是先上它的官网。直接在浏览器搜索栏输入 Spring，就能看到它的官网了。

![66ab8b8cb814342d0416a57dc17c4f81.png][]

打开 Spring 的官网：[https://spring.io/][https_spring.io]

Spring 全家桶包含的项目有很多，我们选择我们今天要搞得 Spring 框架：

![ef09f0eb718d0d920cc876b5691531d6.png][]

这里你就可以看到最新的正式发布版本已经是 5.3.8 的，真的是更新的好快，反正咱们是学习（实际项目千万别用最新版本），这里我就带大家来编译最新的版本，这样大家也可以学习到最新的功能特性。

**当然了这个版本不重要，你也可以选择其他版本，咱今天是授人以渔，不是授人以鱼，重要的是学习这个方法，你看完后想编译啥版本就编译啥版本。**

![0fd6899ee1cbea8b3c6799b6c3686532.png][]

我们点击右上角的 github 图标就会跳转到 github 上面的源码项目了。

![eab59db465846c6a00a34fc224deb167.png][]

下载方式可以直接通过 git clone 或者 下载 zip 包自己解压下，我这里是直接下载 zip 包了。

下载地址：[https://github.com/spring-projects/spring-framework/releases][https_github.com_spring-projects_spring-framework_releases]

![4c49207b787323a507c0b2d01ce95a32.png][]

### 2. 阅读Spring的官方编译文档 ###

其实呀，很多搞不定 Spring 源码编译的小伙伴，肯定很多都是去网上随便找个教程，结果各种踩坑，因为搜到的资料参差不齐，这点估计大家都深有体会了。

所以我们就要养成一个习惯，必须要看官方文档。这里也不是要求大家其它资料不看，毕竟也有很多优秀的博客，大家都是成年人，肯定是全都要喽。

官方文档一般都是英文，但是别害怕，我这个大学四级都考了三回的英语渣，都能勉强看，大家肯定都没问题了，况且咱可以借助翻译插件嘛。

如何编译 Spring 源码其实 Spring 官方提供了详细的文档，有离线版也有在线版，也就是开源项目都有的 `REDAME` 文件。

我这里选择离线版来演示吧。我们解压进入到下载好的 Spring 框架源码项目下，查看 `REDAME` 。

![fe76bc238be390237c9d6cab8c234f90.png][]

就会发现有一个 **build from source** 的章节。

![a5706ac5f324339250b4f6ab98fe7355.png][]

点击这个链接，就会看到详细的编译构建 Spring 框架源码的文档了：[https://github.com/spring-projects/spring-framework/wiki/Build-from-Source][https_github.com_spring-projects_spring-framework_wiki_Build-from-Source]

![94d0e165601525e2f8f9bbd134090e65.png][]

接下来，咱们就按照文档来编译 `Spring-Framework5.3.8` 版本的源码。 根据文档的说明，首先我们要有一个 `JDk8` 或者更高的版本环境，我电脑安装的是 `JDk11` 所以没啥问题。 然后要安装 Git，用来拉取源代码的，因为我们已经下载了源代码，就不管它了。

### 3. 修改配置 ###

先别着急，在编译构建之前，教大家一绝招。这也是我在编译过程中实践出来滴心得。

![5ed470737b6252e78d8e780f31e049d1.png][]

#### 从本地下载gradle ####

因为第一次运行就会去下载 `gradle` 到本地，然后通过 `gradle` 来编译 `Spring` 源码。 这个就很慢了，外网服务器下载，你懂得，有被墙的风险，并且本身也贼慢。

那为什么开始编译构建就会自动下载 `gradle` 呢？从哪里下载？下载的版本是多少？

我们打开 `Spring` 源码的根目录：

![00ab8d9616b2b485a8b5599331be8b95.png][]

配置文件的地址就是源码根目录的二级目录下的 `gradle-wrapper.properties` 文件。

打开文件包含下列内容：

distributionBase=GRADLE_USER_HOME
    distributionPath=wrapper/dists
    distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip
    zipStoreBase=GRADLE_USER_HOME
    zipStorePath=wrapper/dists

*  **distributionUrl**：表示的就是 gradle 的下载地址，默认配置的是一个远程 URL。
 *  **distributionBase**：下载后存放的目录，默认就是用户目录下的 `.gradle` 目录；
 *  **zipStoreBase**：解压后存放的目录

我在构建的过程中发现配置的下载地址下载非常慢，经常超时，甚至有时候被墙。

所以我们倒不如先下载到本地，然后修改配置文件从本地获取 `gradle`，这样一来编译构建就会快很多了。

我们只需要修改 `gradle` 的下载地址就好了，其他的配置项建议保持不变。

![0f4fc2301a53a72421fb4b5483115a90.png][]

上述配置的意思就是如果我们运行 `gradlew` 会自动去 `file\:///Users/sevenluo/IdeaProjects/spring-simple/gradle-6.8.3-bin.zip` 这个目录下载一个 gradle 到当前用户的 `.gradle\wrapper\dists`目录 ,然后解压到当前用户的 `.gradle\wrapper\dists` 目录。

但是实际目录不是这个，这个命令还会自己生成一些目录。下图是七哥电脑实际 `gradle` 的下载解压目录：

![221631822ca891e4193dc80c2cbaad35.png][]

我本地使用的是 `gradle-6.8.3-bin.zip` ,如果你本地网络没问题可以自行去官网下载，当然七哥也下载好了，放到后台了，在公众号【七哥聊编程】回复：**spring源码** 就会都发送给你了。

#### 修改远程仓库 ####

改完上面的配置也先别着急运行编译，现在解决了下载 `gradle` 慢的问题，但是编译开始会使用 gradle 从远程仓库下载大量相关依赖的包。

如果你采用默认配置，那么我可以负责任的告诉你，你绝对得等呀等呀等，**等的黄花菜都凉了**。而且还有很大可能会失败！原因也是因为默认仓库是国外的服务器，速度真的是没谁了，想屎，不烦躁都不行。

所以呀，这里我们要把远程仓库改为咱们国内的阿里云，这样就舒服多了，怎么改?

很简单，找到 `Spring` 源码根目录下的 `build.gradle`，打开编辑添加阿里云的仓库。

![8a48e534b7d81be37e4fdd7881898ce1.png][]

maven {  url 'https://maven.aliyun.com/repository/public' } // 阿里云
    maven {  url 'https://maven.aliyun.com/repository/gradle-plugin' } // 插件

那到这里，可以运行了？

**no！no！no！，hold on, hold on**

![de4f6a216dec8f3b6fb119b72d07139b.png][]

再打开 `Spring` 源码根目录下的 `settings.gradle` 文件，添加阿里云仓库。

![89c720ca782ad0e20950fd8c1f8e3454.png][]

maven {  url 'https://maven.aliyun.com/repository/public' } //阿里云
    maven {  url 'https://maven.aliyun.com/repository/gradle-plugin' } //插件

至此万事具备只欠东风了，就等我们开始编译。

当然上面这些配置优化是七哥在实践中自己总结出来的，如果你的网速够快你完全可以不用优化，直接运行下面的命令。

### 4. 开始编译构建 ###

我们编译构建 `Spring` 源码，一般都是要导入到 IDEA 里面进行测试或者阅读的。Spring 对于如何导入也提供了文档，是不是很贴心。当然也有导入 `Eclipse` 的文档，大家可以根据自己的需求来操作。我这里是用 IDEA 的，你如果导入 Eclipse 操作也都是基本上一样的。

导入 idea 的文档地址：[https://github.com/spring-projects/spring-framework/blob/main/import-into-idea.md][https_github.com_spring-projects_spring-framework_blob_main_import-into-idea.md]

![8b497f55261df5c93e928d4840ec6a22.png][]

根据文档的提示在导入 `idea` 之前需要去 Precompile `spring-oxm` ，也就是预编译 `spring-oxm` 这个项目。

./gradlew :spring-oxm:compileTestJava

执行这个命令成功后，就得到下图：

![b2c521ab41bb08b897f460dcd7194c5c.png][]

预编译起来也很快，我电脑上一共耗时 23 毫秒。

然后我们还要预编译下 `spring-core` 这个项目，因为后面我们运行测试模块的时候需要用到里面的类。

./gradlew :spring-core:compileTestJava

执行成功后如图：

![759b5adf22bb38d0123154bbd1aefece.png][]

### 5. 导入IDEA ###

1.  开始使用idea导入Spring源码，File -> New -> Project from Existing Souces…

![8ee80bbe5f73cfcf3e082988b272562a.png][]

1.  选择 Spring 源码项目的目录，进而选择根目录当中的 `build.gradle` 文件导入;

![76a0c7c4c169b4ec71dcff96cf294e65.png][]

1.  导入 `idea` 之后会开始自动构建、建立索引，这个过程也是很漫长，你只能等，我这边用了不到7分钟，看电脑性能；

![646d464a543102c143bb3cabb00727f3.png][]

1.  接下来我们对 `idea` 进行一些设置，不然每次 `idea` 运行都会通过 `gradle` 去编译运行。`gradle` 运行编译特别慢，需要改成 idea 自己编译运行.

![0352a00dec4a03ece5ee312894d19970.png][]

说明一下，这里不是一定要改，但是如果你不改用默认的则会特别慢，改成 idea 快的不止一点点。

到这，我们的 spring 框架源码就编译完了，为了检验我们的劳动成果，下面建一个 moudle 来测试一下。

### 6. 验证测试 ###

1.  在我们的 spring 源码项目下新建我们自己的测试module，如下图所示；

![645af232f6c1d44408cd55c6fba3703d.png][]

![f268da0d08540d4be0b54b652da2f8e5.png][]

输入测试的 moudle 名：

![b3302cf7cd8018645ac4043f86fd9325.png][]

1.  建好项目之后往 `gradle` 的配置文件中添加 `spring` 的依赖,相当于你建了一个 maven 项目，在 pom 文件中添加 spring 的依赖；

implementation(project(":spring-context"))

修改后的配置：

![8ccf288184ffa203caafe5cabe211c37.png][]

1.  写测试代码；

*  配置类的代码，用于指定扫描的bean；

package com.sevenluo.spring.config;
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    @ComponentScan("com.sevenluo.spring")
    public class AppConfig { 
    //扫描ccom.sevenluo.spring包下面的所有bean
    }

*  写一个sevice，被扫描的bean；

package com.sevenluo.spring.services;
    
    import org.springframework.stereotype.Service;
    
    @Service
    public class HelloService { 
    	public void hello() { 
    		System.out.println("Hello,sevenluo!");
    	}
    }

*  测试类代码；

![fe9f83aa54c77a8f55207bd19088956e.png][]

1.  右键运行——可能你会出现一些错误；比如博主这里就出现了:

java: 程序包jdk.jfr不存在` 错误；

![250e72b30c5f2a3fece7303b286c106d.png][]

这个问题是因为 `jdk.jfr` 是 java9 以后才有的模块,而 spring 源码 5.3.8 版本已经使用这个包，所以我们需要设置我们项目配置的 jdk 版本高于9。

排查后，是因为 idea 配置的 java 编译的版本是8，改为11即可。

![5c2c12843b5b37dadf5ea701d56efbae.png][]

最后再次运行，就成功了。

![860e4950242eab0792b9e5b77c82fdcd.png][]

### 7. 总结 ###

今天主要分享了如何编译构建 spring-framework 源码，以及怎么导入到 IDEA 中，方便我们测试和阅读。

其中，在编译前我结合自己的实践经验，提出了一些需要优化的配置，极大的提高了编译构建的速度以及成功率。比如本地下载 gradle，配置阿里云仓库等。

正如开头的对话，我希望可以帮助到想深入学习Spring但是却苦于基础环境配置搞不太定的小伙伴。

在实践中如果遇到解决不了的问题，也欢迎留言告诉我，我看到后会第一时间和大家一起交流。

那本文如果对你有帮助，就点个赞吧，那是对我最大的鼓励！感谢大家的阅读。

[2c8c577a8120deb52f39db150c1b0898.png]: /images/20220829/c2dbe297a182453a9f4fb6fa935e4c62.png
[GitHub]: https://mp.weixin.qq.com/s?__biz=MzkxODI2MDMzMA==&mid=2247483768&idx=1&sn=2265cda696f3e5926869a10a5034e2eb&chksm=c1b55e7df6c2d76bb40be207548da430e30c7ad52476f74ddc394ee757d757ca2f6c9066f189&token=1711842487&lang=zh_CN#rd
[66ab8b8cb814342d0416a57dc17c4f81.png]: /images/20220829/c51667c456e74dbc918e03b576d9a34c.png
[https_spring.io]: https://spring.io/
[ef09f0eb718d0d920cc876b5691531d6.png]: /images/20220829/1a059baa7f77462589c17eb8ae0c9769.png
[0fd6899ee1cbea8b3c6799b6c3686532.png]: /images/20220829/2abf0b4b0c1e4431965371b0ce228898.png
[eab59db465846c6a00a34fc224deb167.png]: /images/20220829/aea4c7a90d4343759f7687059a09115d.png
[https_github.com_spring-projects_spring-framework_releases]: https://github.com/spring-projects/spring-framework/releases
[4c49207b787323a507c0b2d01ce95a32.png]: /images/20220829/8ede31610f8c4141a4c78acb6934d75c.png
[fe76bc238be390237c9d6cab8c234f90.png]: /images/20220829/6b58ea3ba59645659178df253a2d3210.png
[a5706ac5f324339250b4f6ab98fe7355.png]: /images/20220829/4334b00302ef48ba9ad47235b1ea4460.png
[https_github.com_spring-projects_spring-framework_wiki_Build-from-Source]: https://github.com/spring-projects/spring-framework/wiki/Build-from-Source
[94d0e165601525e2f8f9bbd134090e65.png]: /images/20220829/41180661d13f4049bcc647064aa63f4c.png
[5ed470737b6252e78d8e780f31e049d1.png]: /images/20220829/fe420fde730c4cc5a1227f3f5ad590e7.png
[00ab8d9616b2b485a8b5599331be8b95.png]: /images/20220829/312e0120a8734cab872e0c3d864fec76.png
[0f4fc2301a53a72421fb4b5483115a90.png]: /images/20220829/c78682f5c10047e19cce46587b403935.png
[221631822ca891e4193dc80c2cbaad35.png]: /images/20220829/6a69a257008a4328b25aaf933f0accde.png
[8a48e534b7d81be37e4fdd7881898ce1.png]: /images/20220829/4814492930d74e4697f130abfc6b66ca.png
[de4f6a216dec8f3b6fb119b72d07139b.png]: /images/20220829/09e2559199ba4a1b9c8063d5b74c2057.png
[89c720ca782ad0e20950fd8c1f8e3454.png]: /images/20220829/09197de042c9432590c1910c0dc9520a.png
[https_github.com_spring-projects_spring-framework_blob_main_import-into-idea.md]: https://github.com/spring-projects/spring-framework/blob/main/import-into-idea.md
[8b497f55261df5c93e928d4840ec6a22.png]: /images/20220829/f97962f9480e44c2bd156c0c734ce143.png
[b2c521ab41bb08b897f460dcd7194c5c.png]: /images/20220829/2183cf2fe84f41efbb14b2bd77ea7955.png
[759b5adf22bb38d0123154bbd1aefece.png]: /images/20220829/a4e9465cf62a4370a6d63b7a66853777.png
[8ee80bbe5f73cfcf3e082988b272562a.png]: /images/20220829/96c7ddc0bc2d4c21b1ba64781abcf1d5.png
[76a0c7c4c169b4ec71dcff96cf294e65.png]: /images/20220829/ef68af77bb004d71abaaeb5c36e3ec4e.png
[646d464a543102c143bb3cabb00727f3.png]: /images/20220829/c7e2d7c0146e41329ba06a1220c959cb.png
[0352a00dec4a03ece5ee312894d19970.png]: /images/20220829/e0f553810806479e8d7c73098523c5ff.png
[645af232f6c1d44408cd55c6fba3703d.png]: /images/20220829/d8112df2ea2b4de6a0923217575fd1d7.png
[f268da0d08540d4be0b54b652da2f8e5.png]: /images/20220829/91c292fc5cee420c8ef108df9200de13.png
[b3302cf7cd8018645ac4043f86fd9325.png]: /images/20220829/2b1b9a3fe9f044738c3a1953e095132d.png
[8ccf288184ffa203caafe5cabe211c37.png]: /images/20220829/3780aa4f00314c29b06c76197177b476.png
[fe9f83aa54c77a8f55207bd19088956e.png]: /images/20220829/c7d46cf33b024806841e28032e2096b6.png
[250e72b30c5f2a3fece7303b286c106d.png]: /images/20220829/e0fc6d6223c7434b99287833b55cd433.png
[5c2c12843b5b37dadf5ea701d56efbae.png]: /images/20220829/7ede472eeca042adae5325548bfe9b41.png
[860e4950242eab0792b9e5b77c82fdcd.png]: /images/20220829/ba0a1a5cbe114d499140ae5d11960ec1.png