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

所有文章已迁移至csdn,csdn个人主页https://blog.csdn.net/chaitoudaren
下文介绍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源码探索之路,路上可能会被代码锤的爹都不认识了...
但是不管怎么样,第一步总算是走出去了...

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,294评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,780评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,001评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,593评论 1 289
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,687评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,679评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,667评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,426评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,872评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,180评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,346评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,019评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,658评论 3 323
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,268评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,495评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,275评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,207评论 2 352

推荐阅读更多精彩内容