本文主要是介绍Spring5.x源码编译及导入IDEA全过程及踩坑记录,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
文章目录
- 1.写在前面
- 2.编译前需要准备的环境和工具。
- 3.具体步骤
- 4.总结
1.写在前面
Spring作为风靡世界的优秀框架,很早就想研究研究Spring源码了。最近亲手搭建了Spring环境,从下载源码到编译到改动源码测试demo跑通,有些踩坑和心得需要记录一下,也与大家分享一下。
注:笔者在2台不同电脑上均告成功,但是也不敢保证各位看官一定能成功,如果失败请轻拍砖。不过相信对各位编译Spring还是有一定帮助的,废话不多说,Let’s Go Go Go!
2.编译前需要准备的环境和工具。
- 操作系统:俺是在Win10上编译的
- Java环境:1.8.0_151
注意:有网友说JDK版本不能过高,比如jdk1.8_20和jdk1.8_191,因此当遇到一堆 0x000000: xxxxxxxx 之类的错误时,请留意你的JDK版本。 - 源码下载:讲真,想在GitHub上下载,太难了,笔者试了若干次没有成功。逼不得已,去码云上下载的。如果看官也被逼上"码云",请注意,在搜索框输入:Spring-Framework,然后请选择这个库:
码云极速下载 / Spring-Framework
,然后挑选需要的源码。笔者选择的是:v5.0.0.RELEASE,然后通过zip方式下载的。
- Gradle:Spring是通过Gradle构建的,因此需要下载安装一个Gradle。很简单,下载解压,配置环境变量即可。
- idea:笔者使用的2019 1.1版本
3.具体步骤
-
相信你已经安装好了JDK,idea,让我们往下。
-
将下载好的源码包放到一个单独目录,解压之。根目录下留心下面几个文件。
- build.gradle :这是和Spring构建有关的文件,后面会有所修改。
- import-into-idea.md :这是关于导入idea的一个说明文件。里面有关于导入idea的信息,这是我们需要的,里面有个命令马上就会用到。
-
在 import-into-idea.md文件中,有这么一句话
Precompile spring-oxm with ./gradlew :spring-oxm:compileTestJava
说得很清楚,需要预先编译spring-oxm模块,使用gradlew :spring-oxm:compileTestJava这个命令。好照着做。但是等等,1号坑出现,如果不想编译后出现类似这样的错误
Could not open/create prefs root node Software\JavaSoft\Prefs at root 0x80000002
那么一定要在 管理员窗口 中执行gradlew :spring-oxm:compileTestJava命令。如下:
-
执行命令后,从上面图片中可以得到4个信息:
- 其一:会自动下载gradle-4.1-bin.zip,笔者曾试过,就算本机安装有一个gradle,配置好环境变量,这里spring也会去下载一个。不知道是正常还是不正常。但是你还是应该去gradle官网下载一个gradle,因为待会儿导入idea要用,不建议用idea自带的。
- 其二:注意2号坑出现,你下载安装的gradle版本不能太高,过高的话,导入idea后,会出现各种头疼的问题导致你心态炸裂。那么下载什么版本呢?其实spring已经告诉你了,去下载一个和他自动安装的那个版本就好了。而且v5.0.0.RELEASE对应的gradle版本是gradle-4.1,其他的可不一定,以spring自己打印出来的版本为准。
- 其三:spring会自己去下载一些包来支撑构建,而从上面图片来看,下载地址是https://repo.spring.io/plugins-release。一般说来速度不会很慢,但是如果速度慢怎么办?拿鞭子抽它,让它加速。下面第5步,是可选步骤,如果很慢的话,可以按照第5步操作,如果不慢,就跳过。一般说来,这一步预编译步骤,不应该超过10分钟。
- 其四:编译的时候,有个进度条,和打印一些信息的东西,有时候界面会看似卡死不动,其实是在正常进行的,敲一下回车,就可以看到了,不会打断编译过程的,放心敲。
-
【可选步骤】加速编译spring-oxm模块。原理就是添加一个阿里云镜像。如果你发现下载速度很慢,Ctrl + C退出编译,然后在spring源码包下,打开build.gradle文件,像下图一样,将红框中的部分添加到文件中。
注意点:
- 绿色框中的是文件本来就有的,不要删掉它,因为有些插件包,阿里云并没有同步完全,如果删掉,很可能下载不下来而导致失败。另外它的顺序应该如图一样,排在最后。
2.allprojects那个框,也保持如图中的位置,不要移动到plugins上面。
再一次执行gradlew :spring-oxm:compileTestJava命令。注意在管理员窗口执行。
- 绿色框中的是文件本来就有的,不要删掉它,因为有些插件包,阿里云并没有同步完全,如果删掉,很可能下载不下来而导致失败。另外它的顺序应该如图一样,排在最后。
-
稍等一会儿,不管有没有执行第5步,你应该都可以得到一个编译成功的结果。如下:
只不过进了第5步的话,应该还是会快点,在笔者的后面几次实验中,只用了2分半钟。
另外,预编译成功后,可以打开源码包看看,其实有些核心模块,比如core,context,已经编译出jar包了,但是像jdbc等模块,是没有的,因此可以导入idea来继续编译,不过应该是可以继续在管理员窗口编译的,有兴趣的可以自行尝试。 -
导入idea之前,核实一下是否按照第4步中,安装好了gradle,如果是,需要配置一下继续go go go
-
打开idea,在WelCome页面,点击open,选择编译好的Spring源码根目录,自动弹出如下gradle项目向导,按下图配置即可。ps:如果没有,请核实自己的idea是否安装了gradle插件。
-
点击OK,idea会自动构建环境,下载包等,此时等待。如果按照上面的步骤来,此处应该是能成功的。不然很多坑就会在这里应验 ^ _ ^。
-
等到IDEA构建好之后,出现如上图的几个绿条。那么就可以打开右侧Gradle面板,进行编译了。如图:
- 可以选择点击1号框,手动输入命令编译
- 也可以双击2号框,直接编译。
-
但是注意,3号坑出现。此坑说来话长,但是不得不说。Spring源码有当前master分支,和历史各个分支,还有RELEASE版本。如果你是选择clone master分支来编译,那么是不会编译生成文档包和源码包的。如果是历史分支,Release版本,则会做这些事情,比如笔者目前选择的v5.0.0.RELEASE版本。但是,在Win10系统上,编译生成文档包,会遇到一些非常棘手的事情,如果你尝试这样编译了,会发现控制台打印出一些???和乱码,并且最后编译失败(其实也不算失败,文档失败了而已)得到类似这样的错
Execution failed for task ‘:asciidoctor’.
…
(SystemCallError) Unknown error 123 - FindFirstFile这个错是因为Win10路径的一些兼容问题,很难解决,如果只是为了阅读源码,没有必要在这个问题纠结。如果是正式的用途,那可以到Linux环境进行编译。
那么我们的解决方式就是:跳过文档源码包编译
找到如下2个地方,注释掉(另外看官们可以去GitHub上瞧瞧,master分支上没有下面2个东西,所以编译master分支时不会遇到3号坑,但编译Release版本,则会遇到):
-
现在又可以双击build进行编译了,不会出现刚刚一堆红色???了,但是世界似乎仍不安静,控制台在打印一些白色FAILED。这是因为编译测试程序出了问题。这里笔者曾经尝试解决,但是当解决了一个模块后,另一个模块的测试又会出问题,时间有限,这里只给出解决思路和1个例子。
在测试程序失败后,会出具一份Report,在控制台可以看到连接,可以复制出来在浏览器打开,可以看到报错信息,哪些类失败等。
比如这个问题:Execution failed for spring ':spring-webflux:test'
解决办法是:将
compile"com.fasterxml.jackson.module:jackson-module-kotlin:2.9.0"
放入spring-webflux的gradle dependencies 节点中。
由于笔者只是研究一下Spring源码,于是选择跳过测试程序,有兴趣的可继续自行解决。进行下一步
-
跳过测试。点击第10步1号框,手动输入下面命令来跳过测试执行编译。
build -x test
这样只编译源码,就很快了,快的几十秒,慢点几分钟就打完收工。
-
编译完毕,下一步就是新建一个模块来测试一下啦。
- new -> module -> gradle -> next -> 输入artifactID -> 确定
- 向自动生成的gradle文件的dependencies中添加一行:compile(project(’:spring-context’))
- 新建测试类
public class HelloSpring {public void say(){System.out.println("hello spring");} }
public class TestClient {public static void main(String[] args) {AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();context.refresh();context.register(HelloSpring.class);HelloSpring helloSpring = (HelloSpring)context.getBean("helloSpring");helloSpring.say();} }
-
点击运行。nice,4号坑出现。应该会得到下面一个错误
Error:(26, 38) java: 找不到符号符号: 类 InstrumentationSavingAgent位置: 程序包 org.springframework.instrument
解决办法是:将下图本来为optional的,改为compile
-
再次点击运行,运行成功。v5.0.0.RELEASE版本编译到此结束。
-
都运行成功了,为什么还有下一点呢?因为还有5号坑,但是此坑在编译v5.0.0.RELEASE版本的时候,并没有出现。而出现在了编译master分支上,目前master版本是5.2.2,当运行测试程序的时候,很可能得到这个错误:
Error:(347, 51) java: 找不到符号符号: 变量 CoroutinesUtils位置: 类 org.springframework.core.ReactiveAdapterRegistry.CoroutinesRegistrar
这是因为有个包,spring没有帮你打进去,需要自己添加,如下操作:
- 找到Spring-core模块,右键新建一个lib文件夹
- 按照如下图所示,将包复制过去
- 打开spring-core.gradle文件,将
compile fileTree(dir:'lib',includes:['*jar'])
添加到dependencies,如下图
然后idea触发自动编译。编译好后,运行测试程序,问题解决。
4.总结
以上都是
这篇关于Spring5.x源码编译及导入IDEA全过程及踩坑记录的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!