Spring源码——IDEA读Spring源码环境搭建

小鱼儿 2022-05-19 08:58 286阅读 0赞

## 前言 ##

> 最新在B站发现一个视频教学如何搭建Spring5源码阅读环境，特意添加在此：[https://www.bilibili.com/video/av61188907][https_www.bilibili.com_video_av61188907]  
> 视频中的笔记链接：[http://note.youdao.com/ynoteshare1/index.html?id=c3f11aab5e0a0083709cc64984a3c41a&type=note][http_note.youdao.com_ynoteshare1_index.html_id_c3f11aab5e0a0083709cc64984a3c41a_type_note]

## I. Spring介绍 ##

还有什么好介绍的，做 Java 的都知道。至于为什么读源码，还有什么好说的，还不是被逼的！

![20180723174317894][]

## II. Gradle安装 ##

下载：[https://gradle.org/install/][https_gradle.org_install]

Windows平台下，需要配置gradle的环境变量。

*  新增 `GRADLE_HOME` 环境变量，指向Gradle解压目录
 *  配置Path环境变量:新增 `%GRADLE_HOME%\bin`

![Gradle环境搭建][Gradle]

## III. 下载Spring源码 ##

可以利用git下载源码或者下载源码包。

*  github: [https://github.com/spring-projects/spring-framework][https_github.com_spring-projects_spring-framework]
 *  找了一个4.2的注释版: [https://github.com/wanwanpp/spring-framework-4.2.0][https_github.com_wanwanpp_spring-framework-4.2.0]
 *  源码包：[https://github.com/spring-projects/spring-framework/releases][https_github.com_spring-projects_spring-framework_releases]

## IV. Spring源码编译 ##

进入 `spring-framework` 文件夹下，打开cmd，输入 `gradlew :spring-oxm:compileTestJava` 进行编译。

![编译源码][20180723174403117]

中间可能会各种报错，可能都是网络原因，多重试几次就好了。至于需不需要科学上网，反正我是校园网没有翻墙报错多试几次直接最后就成功了。

![编译成功][20180723174419747]

## V. IDEA导入源码 ##

打开IDEA，File->New->Project From Existing Sources…，选中spring-framework源码文件夹，点击OK，选择Import project from external model，选中Gradle，点击Next。

![idea导入源码][idea]

点击Finish之前，可以修改一些默认的配置。

![修改设置][20180723174452227]

等待IDEA构建项目完成即可。ps：等的有点久….

![IDEA导入成功][IDEA]

## VI. 新建测试Module ##

对于IDEA的project和module概念，在此就不赘述了。在此贴个链接：[戳戳戳][Link 1]

在Project Structure中需要将spring-aspectj这个module除去，因为build报错。我在build的时候还有context下的money啥的也报错，同样exclude掉了。

> spring-aspects does not compile due to references to aspect types unknown to IntelliJ IDEA. See http://youtrack.jetbrains.com/issue/IDEA-64446 for details. In the meantime, the ‘spring-aspects’ can be excluded from the project to avoid compilation errors.

为了方便测试spring源码，这里我们也在spring-framework下单独再创建一个module，专门用于编写我们自己的代码。已有的工程结构是名为spring的project下包含各种module，如图所示。所以我们新建的module也选在spring的project下，如图中的 `:mytest` 的module。

![spring源码工程结构][spring]

File–>New–>Module…–>Gradle–>Java–>Next会出现如下界面，填写module名后点击next后点击Finish即可。

![新建module][module]

创建完成后，在 `mytest` 的gradle配置文件中添加 `compile(project(":spring-beans"))` 依赖，便于下面进行容器 `BeanFactory` 的使用。

![添加依赖][20180723200224117]

点击build project可能会遇到的错误：

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)
    	at org.jetbrains.kotlin.cli.jvm.K2JVMCompiler.doExecute(K2JVMCompiler.kt:63)
    	at org.jetbrains.kotlin.cli.common.CLICompiler.execImpl(CLICompiler.java:108)
    	at org.jetbrains.kotlin.cli.common.CLICompiler.execImpl(CLICompiler.java:52)
    	at org.jetbrains.kotlin.cli.common.CLITool.exec(CLITool.kt:92)
    	at org.jetbrains.kotlin.daemon.CompileServiceImpl$compile$$inlined$ifAlive$lambda$1.invoke(CompileServiceImpl.kt:389)
    	at org.jetbrains.kotlin.daemon.CompileServiceImpl$compile$$inlined$ifAlive$lambda$1.invoke(CompileServiceImpl.kt:97)
    	at org.jetbrains.kotlin.daemon.CompileServiceImpl$doCompile$$inlined$ifAlive$lambda$2.invoke(CompileServiceImpl.kt:909)
    	at org.jetbrains.kotlin.daemon.CompileServiceImpl$doCompile$$inlined$ifAlive$lambda$2.invoke(CompileServiceImpl.kt:97)
    	at org.jetbrains.kotlin.daemon.common.DummyProfiler.withMeasure(PerfUtils.kt:137)
    	at org.jetbrains.kotlin.daemon.CompileServiceImpl.checkedCompile(CompileServiceImpl.kt:939)
    	at org.jetbrains.kotlin.daemon.CompileServiceImpl.doCompile(CompileServiceImpl.kt:908)
    	at org.jetbrains.kotlin.daemon.CompileServiceImpl.compile(CompileServiceImpl.kt:387)
    	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    	at java.lang.reflect.Method.invoke(Method.java:498)
    	at sun.rmi.server.UnicastServerRef.dispatch(UnicastServerRef.java:324)
    	at sun.rmi.transport.Transport$1.run(Transport.java:200)
    	at sun.rmi.transport.Transport$1.run(Transport.java:197)
    	at java.security.AccessController.doPrivileged(Native Method)
    	at sun.rmi.transport.Transport.serviceCall(Transport.java:196)
    	at sun.rmi.transport.tcp.TCPTransport.handleMessages(TCPTransport.java:568)
    	at sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.run0(TCPTransport.java:826)
    	at sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.lambda$run$0(TCPTransport.java:683)
    	at java.security.AccessController.doPrivileged(Native Method)
    	at sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.run(TCPTransport.java:682)
    	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
    	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
    	at java.lang.Thread.run(Thread.java:745)
    Caused by: java.lang.AbstractMethodError: org.jetbrains.kotlin.scripting.compiler.plugin.ScriptingCompilerConfigurationComponentRegistrar.registerProjectComponents(Lcom/intellij/mock/MockProject;Lorg/jetbrains/kotlin/config/CompilerConfiguration;)V
    	at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment.<init>(KotlinCoreEnvironment.kt:179)
    	... 33 more

这个主要是Kotlin插件的版本问题，解决方案是更新新版本的Kotlin插件。贴个链接：[IntelliJ IDEA手动更新Kotlin][IntelliJ IDEA_Kotlin].

## VII. 添加日志输出 ##

Spring5使用了log4j2，想要输出日志信息，我们需要在自己定义的模块下配置配置文件。在 *src/main/resources* 文件夹下新建 *log4j2.xml* 文件，在 *src/test/resources* 目录下创建 *log4j2-test.xml* 文件。文件配置内容为：

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="DEBUG">
    	<Appenders>
    		<Console name="Console" target="SYSTEM_OUT">
    			<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
    		</Console>
    	</Appenders>
    	<Loggers>
    		<Logger name="org.springframework" level="DEBUG" />
    		<Root level="DEBUG">
    			<AppenderRef ref="Console" />
    		</Root>
    	</Loggers>
    </Configuration>

[https_www.bilibili.com_video_av61188907]: https://www.bilibili.com/video/av61188907
[http_note.youdao.com_ynoteshare1_index.html_id_c3f11aab5e0a0083709cc64984a3c41a_type_note]: http://note.youdao.com/ynoteshare1/index.html?id=c3f11aab5e0a0083709cc64984a3c41a&type=note
[20180723174317894]: /images/20220519/762930eb27404345b3224848b8e5151a.png
[https_gradle.org_install]: https://gradle.org/install/
[Gradle]: /images/20220519/7381afab9f9643ffbdc4ca6fdf33a58e.png
[https_github.com_spring-projects_spring-framework]: https://github.com/spring-projects/spring-framework
[https_github.com_wanwanpp_spring-framework-4.2.0]: https://github.com/wanwanpp/spring-framework-4.2.0
[https_github.com_spring-projects_spring-framework_releases]: https://github.com/spring-projects/spring-framework/releases
[20180723174403117]: /images/20220519/17b7ccb7eb9648388f8cc04bb2de3aee.png
[20180723174419747]: /images/20220519/7fb7dbef4b9440908c1b3730175043e5.png
[idea]: /images/20220519/0553ab4dfa794d658999d2f1cb62a646.png
[20180723174452227]: /images/20220519/89d4bc331d34450a952d31ebdca33309.png
[IDEA]: /images/20220519/50cd69d918f346c182bf93a01d82087f.png
[Link 1]: https://blog.csdn.net/qq_35246620/article/details/65448689
[spring]: /images/20220519/60f6a24003a2483db4f363337b6a641b.png
[module]: /images/20220519/144dba03801742ca8bc6d646b93c7f04.png
[20180723200224117]: /images/20220519/6a17949ca41b4d8b9ca8113c450b3357.png
[IntelliJ IDEA_Kotlin]: https://www.jianshu.com/p/7c625599c1c9