IDEA阅读spring源码并调试

不念不忘少年蓝@ 2022-05-21 21:08 309阅读 0赞

## **[阿里云服务器优惠券领取][Link 1] [优惠券][Link 1]** ##

目标：搭建起Spring源码阅读和代码调试跟踪的环境，顺便建立一个简单的Demo，能够调试Spring的源代码

# 1. 资源准备 #

jdk版本: 1.8.0\_202

IDEA版本: 2020.2.1

aspectj版本: aspectj-1.9.2

sourcetree版本: 3.3.8

# 2. 源码下载 #

用sourcetree拉取5.2.x分支

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70][]

# 3. 编译源码 #

## 3.1 在spring-framework所在目录执行gradlew build命令 ##

eg: D:\\Dev\\source\\java\\spring-framework>gradlew build

## 3.2 在spring-framework所在目录执行gradlew :spring-oxm:compileTestJava命令 ##

eg: D:\\Dev\\source\\java\\spring-framework>gradlew :spring-oxm:compileTestJava

# 4. 设置IDEA编码 #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 2][]

# 5. 导入IDEA #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 3][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 4][]

# 6. 设置Project Structure #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 5][]

# 7. 设置gradle任意改动自动编译 #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 6][]

# 8. 对spring-test模块做junit测试 #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 7][]

如果选择了test或testNg可能会报错,编辑一下Edit Configurations

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 8][]

清除Tasks

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 9][]

然后重新执行单元测试,选择junit即可

# 9.编码规范 #

1. 为了能使自己的新建的module与spring的其他module一起编译,需要遵循google的编码规范

2. Code Style

[https://github.com/spring-projects/spring-framework/wiki/Code-Style][https_github.com_spring-projects_spring-framework_wiki_Code-Style]

[https://github.com/spring-projects/spring-framework/wiki/IntelliJ-IDEA-Editor-Settings][https_github.com_spring-projects_spring-framework_wiki_IntelliJ-IDEA-Editor-Settings]

# 10.搭建调试module #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 10][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 11][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 12][]

拷贝spring-test的gradle配置到sping-debug中进行覆盖,并修改描述为Spring Debug

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 13][]

在spring-debug中创建测试类

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 14][]

/*
     * Copyright 2002-2020 the original author or authors.
     *
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     *
     *      https://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */
    package com.lazy.bean.test;
    
    /**
     * test bean.
     *
     * @author Lazy Hu
     */
    public class MyTestBean {
    
    	private String testStr = "testStr";
    
    	public String getTestStr() {
    		return this.testStr;
    	}
    
    	public void setTestStr(String testStr) {
    		this.testStr = testStr;
    	}
    }

创建bean配置文件

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 15][]

<?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 https://www.springframework.org/schema/beans/spring-beans.xsd">
    
    	<bean id="myTestBean" class="com.lazy.bean.test.MyTestBean"/>
    
    </beans>

创建测试类

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 16][]

在测试类中写入测试信息

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 17][]

/*
     * Copyright 2002-2019 the original author or authors.
     *
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     *
     *      https://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */
    
    package com.lazy.bean.test;
    
    import org.junit.jupiter.api.Test;
    
    import org.springframework.beans.factory.BeanFactory;
    import org.springframework.beans.factory.xml.XmlBeanFactory;
    import org.springframework.core.io.ClassPathResource;
    
    import static org.assertj.core.api.Assertions.assertThat;
    
    /**
     * Unit tests for {@link MyTestBean}.
     *
     * @author Lazy Hu
     */
    class MyTestBeanTests {
    
    	@Test
    	void testSimpleLoad() {
    		BeanFactory bf = new XmlBeanFactory(new ClassPathResource("beanFactoryTest.xml"));
    		MyTestBean bean = (MyTestBean) bf.getBean("myTestBean");
    		assertThat(bean.getTestStr()).isEqualTo("testStr");
    	}
    }

进行debug

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 18][]

测试结果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 19][]

# 11. 全部模块进行编译 #

## 11.1编译 ##

d:
    cd Dev\source\java\spring-framework
    gradlew build

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 20][]

## 11.2编译遇到的问题 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 21][]

非法导入  org.junit.jupiter.api.Test;

## 11.3解决办法 ##

路径(源码所放目录): D:\\Dev\\source\\java\\spring-framework\\src\\checkstyle\\checkstyle.xml

修改<property name="regexp" value="true" />为<property name="regexp" value="false" />

## 11.4重新执行编译 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 22][]

# **[阿里云服务器优惠券领取][Link 1] [优惠券][Link 1]** #

# [Spring编码规范][Spring] #

[Link 1]: https://www.aliyun.com/activity/daily/bestoffer?userCode=n2hxqpjv
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70]: /images/20220522/8d56e2b0b4f34e64ae3bca7f4b82fb84.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 1]: /images/20220522/170b74b3570546528c7b7ae8769fb3c4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 2]: /images/20220522/628fc21884da4587bd4672cc2ee3e678.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 3]: /images/20220522/5d341eea2d344672aa194e0a5f081489.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 4]: /images/20220522/3fd827dc144e48948d96a39b8f60d99d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 5]: /images/20220522/4be1986dda584536994f1f2bb45fda7c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 6]: /images/20220522/3cbc9b7b4c024606ba71d64fe0e8bacf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 7]: /images/20220522/05ca8309bc4d4eb9a8c03b8095c129c0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 8]: /images/20220522/7b76c446c78c4110a417d10bd90f398b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 9]: /images/20220522/4d08718274c34429899379c7a49bf9c9.png
[https_github.com_spring-projects_spring-framework_wiki_Code-Style]: https://github.com/spring-projects/spring-framework/wiki/Code-Style
[https_github.com_spring-projects_spring-framework_wiki_IntelliJ-IDEA-Editor-Settings]: https://github.com/spring-projects/spring-framework/wiki/IntelliJ-IDEA-Editor-Settings
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 10]: /images/20220522/18f693c72a7a46e5a297bd383f7638ca.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 11]: /images/20220522/50bbad10b5ce4a0ba3781c02ecb63d6a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 12]: /images/20220522/1c198efd65d74ffc8ff441b0120534a4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 13]: /images/20220522/b21ee82eaf6149c99980c8dc54c28e7e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 14]: /images/20220522/59440d690dbc4593bac9634a9f091ca5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 15]: /images/20220522/d1d3181f935c43f0ac35f68b28e33c6e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 16]: /images/20220522/d6982f9ce409437b8fa8d9fd61613dfa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 17]: /images/20220522/db8085739c714456ab63037b3355ab18.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 18]: /images/20220522/b35ec1ed5ac8438e9b1955beb1f9c83a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 19]: /images/20220522/bf35f1be6d4c4af6af3a89160d118852.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 20]: /images/20220522/30da843b94284fb49e6859c02202cbe7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 21]: /images/20220522/feeee55511994179822d8fff9fd23205.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMzMTAwNzU_size_16_color_FFFFFF_t_70 22]: /images/20220522/4a9749b34f8e40719cfb0e736d5c2977.png
[Spring]: https://blog.csdn.net/u013310075/article/details/108812735