前情提要:调试前的基础知识梳理
速览
- “Spring”包含哪些东西
- 源码下载
- 源码编译
- 1、编译工具选择:gradle
- 2、使用gradle编译spring并导入idea
- 预编译spring-oxm
- 导入IDEA
- 确认合适的jdk版本
- 排除spring-aspects模块
- 开始调试
“Spring”包含哪些东西
可以明确的是,“spring”不是一个东西,而是一系列东西。最原始的“spring”即“Spring Framework”,凝聚了spring的核心和精华:依赖注入、事物管理、面向切面等等。如今的“spring”可以理解成一个生态,例如在spring framework的基础上发展出了spring cloud用于分布式管理、“一刀99级傻瓜版”的springboot等等。学习spring的源码,其实就是学习spring framework,常常耳闻的一些东西例如“spring-context”、“spring-webmvc”、“spring-aspects”等都是spring framework的组件。所以spring能做的东西是很多的,“依赖注入”、“控制反转”、“事务控制”这些内容,只不过是日常工作接触最多的概念和功能。
源码下载
源码地址
我的项目多用4.3.4.RELEASE版本,其实已经是非常老的版本了,不过对源码学习来说其实没什么影响(不久的将来直接被打脸,所以建议用5.x以上较新版本)。所以我就下载这个版本了:
git clone --branch v4.3.4.RELEASE https://github.com/spring-projects/spring-framework.git
下载之后看到一个spring-framework的目录,里面就是spring的java源码了。
源码编译
1、编译工具选择:gradle
平时可能用maven比较多,但是spring的官方使用gradle进行编译,所以我入乡随俗了。这里顺便让老软介绍下gradle:
接下来先下载和配置一下gradle(其实不一定要手动下载,后文会提到)。gradle下载地址,这里有很多版本,仍然入乡随俗,我选择了和spring v4.3.4.RELEASE官方编译时使用的那个版本:在/spring-framework/gradle/wrapper/gradle-wrapper.properties文件中,用记事本打开能看到官方用的是2.14.1版本:
下载后是个*.zip的压缩包,直接解压即可。为了可以在任何地方都运行gradle,最好再设置下gradle的环境变量(这里不再赘述,百度谷哥一大把)。配置完后验证下,任意地方打开cmd输入gradle -v
即可。
2、使用gradle编译spring并导入idea
关于这一步,spring官方已经提供了说明,源码目录中有个md文件叫“import-into-idea.md”,里面就是完整步骤:
翻译下就是:
(在下载好的spring-framework目录中)
1、预编译spring-oxm模块
2、导入IDEA
3、确认合适的jdk版本
4、排除spring-aspects模块
预编译spring-oxm
首先这是个什么东西,问下老软:
原来是个用于XML和beans互相转换的工具。使用git bash执行命令./gradlew cleanIdea :spring-oxm:complieTestJava
(这个命令执行完后源码路径下会生成一些配置文件便于导入idea)。从输出log中可以看到,这个命令会下载gradle并自动解压(所以上一步手动下载gradle非必须),执行很多buildSrc的编译脚本,下载各种依赖和插件等等。不过很遗憾但意料之中地报错了:
作为一个服务端老鸟,面对这种报错不仅云蛋风轻,甚至注意到了最后一句(上图红框),看起来是通过http get资源时异常了,按照我的经验很可能就是访问外网导致的。于是按照这篇文章中的方法,把build.gradle文件中的maven源改成国内源:
然后重新执行./gradlew cleanIdea :spring-oxm:compileTestJava
,但是依然报错。。。于是命令里加上"-info"参数看看详细日志,结果发现两个资源没找到(下图中可见):org.springframework.build.gradle:propdeps-plugin:0.0.7和io.spring.gradle:docbook-reference-plugin:0.3.1。
此时,最直观的解决办法就是去找这俩文件,我也是这么做的,一通搜索和操作后还是没解决,很郁闷:国内的源到底行不行啊!在我正摇头晃脑的时候突然灵光一闪,有没有可能因为我下载的spring和gradle版本都太老了,才出现这种插件或者依赖找不到的问题。要不先直接换个spring的v5.3.37试试(相应的gradle也换成7.5.1版本)? 按照我一介老鸟的经验,坑是躲不掉的,类似这种躲坑的行为,最终的结局那必然是。。。一切顺利,BUILD SUCCESSFUL。。。
导入IDEA
上一步编译完后可以在spring-framework目录下看到一个.gradle目录,这个就是导入IDEA需要用的。打开IDEA:File》New》Project from Existing Source》选择spring-framework路径中的“.gradle”,然后就是漫长的等待(我这里足足耗时30min19s),最终看到BUILD SUCCESSFUL就是成功了。成功后大概下图这个样子,可以看到左边项目结构中熟悉的spring-beans、spring-context等。
确认合适的jdk版本
这个其实没啥好说的,安官方的说法,最好jdk1.8+就行
排除spring-aspects模块
至于为什么排除这个模块,在官方的导入说明中写的很清楚(前文有图),因为spring-aspects会依赖外部模块Aspects,从而可能引起IDEA的编译异常。排除一个模块很简单:File》Project Structure》Project settings》Modules,右侧把spring-aspects删掉就行:
开始调试
万事俱备,如何开始调试呢?回想下平时在公司面向cv编程时,都是引入spring的pom依赖后就开始写业务代码的。所以这次的调试也是一样的,得有段业务代码。这段业务代码该怎么写合适呢?我没想出来,但是那些讲spring的培训机构肯定有最佳实践,所以借鉴一下就行。且听后话。