spring源码01: spring源码编译 环境搭建

下文介绍spring源码在idea环境下的搭建,目的是为了更好的阅读和调试代码,已搭建完的小火伴可跳过本节,直接开启被锤之路…

备选方案

为什么把备选方案写在前面呢,因为单纯的看源码调试,直接用IDEA新建Spring项目后就可以进行调试,并且IDEA还会贴心的在右上方提示Download sources,阅读调试源码是基本上没有问题的,作者自己也经常这么干。但是毕竟这种游击队做法的java文件(切确的说是class文件)还是在jar包里的,只能read only。在阅读源码过程中注释、修改是有利于代码理解滴,因此下面介绍一下正规军做法。

教程

请注意作者使用的是JDK1.8 + Gradel5.6.8 + spring 5.x

1.获取spring

源码地址:https://github.com/spring-projects/spring-framework.git

2.项目指南

接下去是最重要也是最容易忽视的。阅读文档和注解是了解一个项目最快的方式,Spring也不例外。在项目的根目录可以看到import-into-idea,Spring 作者已经为我们写好了导入指南。以下是文档的翻译,暂时看不懂不要紧,之后我们会进行一步一步的导入。

// 使用gradle对oxm模块进行编译。
1. Precompile `spring-oxm` with `./gradlew :spring-oxm:compileTestJava`
// 使用idea,对build.gradle进行导入。
2. Import into IntelliJ (File -> New -> Project from Existing Sources -> Navigate to directory -> Select build.gradle)
// 排除spring-aspects模块
3. When prompted exclude the `spring-aspects` module (or after the import via File-> Project Structure -> Modules)

3.Gradle安装(装好的可以跳过)

maven跟gradle都是项目构建工具,spring是gradle构建的,因此gradle是必不可少必须安装的一个工具。安装过程跟java类似,大致就是下载压缩包、配置环境变量。
gradle:https://gradle.org/install/
一般下载4.0版本就够用,不同spring可能需要不同版本的gradle,编译时如果版本不适应会出现提示。
环境变量.png
环境变量1.png
使用命令行gradle -v,当看到以下画面说明已经配置成功了。
配置成功.png

4.编译oxm模块

切换到spring源码的对应目录下,使用命令进行编译。由于大部分依赖的包都在境外,跟你过程会有点漫长,大概30分钟左右,并且经常出现失败的情况。多尝试几遍,有条件的可以搭个梯子再试试看。
mac下使用:./gradlew :spring-oxm:compileTestJava
windows使用:gradlew :spring-oxm:compileTestJava
编译.png

5.IDEA导入项目,时间还是有点漫长…

导入.png

没出现的可以忽略.png

6.排除非必要模块spring-aspects

导入成功后需要排除spring-aspects模块,因为其依赖于aspects包,如果不排除,将会报缺少包的错误。具体方式如下,详细可参考open module settings (神器)
排除.png

7.新建测试模块

为了验证项目是否已经导入成功,我们新建一个Module测试一下,项目右键 -> new -> module
newModule.png
新建成功的Module.png

新建成功后,我们需要在项目gradle文件中添加上依赖,我们需要用到核心模块core跟beans

dependencies {
    compile(project(":spring-context"))
    compile(project(":spring-beans"))
    compile(project(":spring-core"))
    testCompile group: 'junit', name: 'junit', version: '4.12'
}

添加依赖.png

8.添加测试代码

在新建的模块中myTest -> src -> main -> java上新建一个类

public class MyBean {
	private String testStr = "hello world!";

	public String getTestStr() {
		return testStr;
	}

	public void setTestStr(String testStr) {
		this.testStr = testStr;
	}
}

myTest -> main -> resources中新建spring-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
	<bean id="myBean" class="MyBean"/>
</beans>

myTest -> test -> java -> 新建测试类

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.xml.XmlBeanFactory;
import org.springframework.core.io.ClassPathResource;
import org.junit.jupiter.api.Test;
public class MyBeanTest {
	@Test
	public void test1() {
		BeanFactory bf = new XmlBeanFactory( new ClassPathResource("spring-config.xml"));
		MyBean myTestBean = (MyBean) bf.getBean("myBean");
		System.out.println(myTestBean.getTestStr());
	}
}

可能会出现的问题

出现CoroutinesUtils 找不到时可参考
https://blog.csdn.net/weixin_41452576/article/details/95319278#commentsedit

当出现以下问题时,这个主要是Kotlin版本问题,解决方案是更新Kotlin插件。可参考:IntelliJ IDEA手动更新Kotlin.

Error:Kotlin: [Internal Error] java.lang.IllegalStateException: The provided plugin org.jetbrains.kotlin.scripting.compiler.plugin.ScriptingCompilerConfigurationComponentRegistrar is not compatible with this version of compiler
	at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment.<init>(KotlinCoreEnvironment.kt:181)
	at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment.<init>(KotlinCoreEnvironment.kt:117)
	at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment$Companion.createForProduction(KotlinCoreEnvironment.kt:413)
	at org.jetbrains.kotlin.cli.jvm.K2JVMCompiler.createCoreEnvironment(K2JVMCompiler.kt:276)
	at org.jetbrains.kotlin.cli.jvm.K2JVMCompiler.doExecute(K2JVMCompiler.kt:154)

结尾

Spring Yes!至此终于可以开始愉快的调试代码了,开启spring源码探索之路,路上可能会被代码锤的爹都不认识了…
但是不管怎么样,第一步总算是走出去了…

发布了30 篇原创文章 · 获赞 9 · 访问量 1万+

猜你喜欢

转载自blog.csdn.net/chaitoudaren/article/details/104833447
今日推荐