读Spring源码记录(二)--- 迈出艰难的第一步,搭建spring源码阅读环境

我使用mac电脑,编译器是idea,jdk1.8, gradle 4.9

一、下载源码

源码的GitHub地址:https://github.com/spring-projects/spring-framework
可以使用git下载,也可以直接下载zip包,只不过多了一个解压的过程,我git下载不下来,我直接下载的zip包,放在我的idea工作文件目录下:~/IdeaProjects,使用命令unzip spring-framework-master.zip,我想这步都还是比较简单没什么问题。

二、下载gradle

如果使用 brew install gradle 下载gradle,会下载最新的gradle,目前已经是5.5.1的版本,但是spring源码是需要的4开头的版本,我在使用5.5.1版本编译的时候就遇到了报错This version of Gradle requires version 2.0.2 of the build scan plugin or later.这表示当前版本太高了,下图可以检查,提示对应的版本。

gradle版本.png

三、根据源码的提示预编译源码

spring.png

可以从截图中看到,源码里面有相应的导入源码说明,我是导入到idea中,所以根据import-into-idea.md提示进行,可以看到,分为4步,但是实际操作,我发现第一步还需要增加一点。

首先按照文档,到spring-framework-5.0.x目录下,执行./gradlew :spring-oxm:compileTestJava,当然第一次一般都是失败的,我多试了几次就成功了(多是几次==我花了两天下班时间),希望大家有耐心,然后在spring-framework-5.0.x目录下还要执行./gradlew build -x test,这个是因为我后面测试的时候,明明写好了xml文件,可是就是报错org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'teacher' available,虽然不知道有什么联系,但是没它不行,这个命令的执行也是多试几次,一定要有耐心。
这步完成后,按照文档提示,导入文件File -> New -> Project from Existing Sources,选中你的spring源码目录,选中build.gradle文件。
接下来,重点来了

图中1,2,3,4大家都这么做,图中5的地方大家看其他教程可能发现跟这个有所不同,这个是因为我使用的自己下载安装的gradle,所以是这个路径,如果使用的brew安装的gradle,那么路径应该是/usr/local/Cellar/gradle-5.5.1/libexe
漫长的等待,long long long time。
中间你可能遇到报错:
No such property: values for class: org.gradle.api.internal.tasks.DefaultTas,你点击open file
注释掉最后三行,

接下来就是官方文档常说的spring-aspects模块的问题,可能遇到,可能遇不到,不过最好都执行一下,选中idea中的spring-framework-5.0.x右键 -> Load/Unload modules,将spring-aspects模块移走,然后rebuild一下。
Load/Unload modules.png

最后检查你的源码项目,是否在有点文件中,有的类或者包为红色(无法引入)
这个时候你可以先到无法引入的类的所在模块,执行命令gradle build

如果失败类,那么使用plan B:
就是点它.png

四、添加一个测试模块

我一开始想跟spring统一,使用gradle建立测试模块,我发现我好像不怎么擅长gradle,而且遇到各种问题,为了解决这些问题,我最后使用擅长的maven。
首先选中idea中的spring-framework-5.0.x右键 -> module -> maven,然后就是取名字,next到最后。这是我的测试项目的结构截图。



还要引入相关的spring的模块:file -> project structure



为什么引入这么多模块,得往下看。
然后是代码:
pom.xml:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.laoye.spring</groupId>
    <artifactId>my-test</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

Student:

package com.laoye.spring.beans;

public class Student {

    private String name;

    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

Main是空文件,然后测试类
BeansTest:

package com.laoye.test;

import com.laoye.spring.beans.Student;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class BeansTest {

    @Test
    public void testStudent(){

        ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:application.xml");
        Student student = context.getBean("student",Student.class);
        System.out.println(student.getName());
    }
}

最后是application.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="student" class="com.laoye.spring.beans.Student">
        <property name="name" value="laoye"/>
        <property name="age" value="1"/>
    </bean>
</beans>

一开始我只引入了spring-context,spring-beans,spring-core模块, 然后执行测试代码,会发现我一个问题(解决了好久)

Error:(26, 38) java: 找不到符号
  符号:   类 InstrumentationSavingAgent
  位置: 程序包 org.springframework.instrument

当时没找到什么有效的解决办法,网上都是让重新导入项目,实际解决办法是:
找个这个类所在模块,然后添加到测试模块的依赖中,类InstrumentationSavingAgent在模块spring-instrument中,所以就添加这个模块。


然后在此debug测试用例,会遇到类似的问题,然后就是添加模块,我最后添加的模块很多,如上图所示。

五、总结

路漫漫其修远兮,吾将上下而求索!
遇到问题,查找问题,最后解决问题,这是我们干这一行最基本的方式,希望更多的人能在程序员的道路上坚持下去,也希望有人能一起讨论学习。
终于迈出了艰难第一步。


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

推荐阅读更多精彩内容