超详细图解!基于IDEA+Gradle+jdk11搭建Spring框架源码阅读环境

简介: 超详细图解!基于IDEA+Gradle+jdk11搭建Spring框架源码阅读环境

image.png

Spring框架的重要程度不言而喻!

在尝试阅读Spring源码时,在第一步搭建环境上被劝退很多次(确实比较复杂),而且网上搜了很多博客、文章后发现,不是Spring版本老,就是Gradle或者Idea版本老。于是昨天肝到深夜,参考了很多资料,终于搭建成功了Spring5.3.x版本的源码环境!

在分析Spring框架源码之前,首先要搭建起来Spring的源码环境,由于Spring源码并不是托管于maven的,而是托管于Gradle,因此我们需要先下载版Gradle,此外还额外需要本机电脑配置JDK11环境(必须是11,否则Spring源码环境编译过不去)。下面我们就从安装环境开始:

先统一下环境版本要求:


Spring源码版本5.x


Gradle6.4.x及其以上版本


Jdk11(最好是11,jdk8也可以,但是不敢保证一遍成功)


一、JDK11 安装

下载与安装

Oracle官方下载地址:https://www.oracle.com/java/technologies/javase-jdk11-downloads.html

我的电脑是Win10,所以下载下面这个安装包:

image.png

  • 如果官网下载速度慢,这里提供一个百度云链接:https://pan.baidu.com/s/1LOUVsO2orCUtKRdjOKqGCA提取码:qqo5
  • 下载完成后执行exe安装包,自己选一个安装路径(我的是默认路径),点击下一步:
  • image.png
  • 等待安装完成:
  • image.png

配置环境变量

  • 右键 -> 我的电脑 -> 属性:
  • image.png
  • 选择 -> 高级系统设置 -> 环境变量:
  • image.png
  • 选择新建系统环境变量JAVA_HOME:

变量名:JAVA_HOME

变量值:jdk安装的地址(我使用的是默认地址:C:\Program Files\Java\jdk-11.0.6)

注意:如果本机安装由jdk8 的环境,这里只需要找到JAVA_HOME并将变量值修改为jdk11的安装路径即可~


image.png

image.png

image.png

在系统环境变量CLASSPATH中新增如下内容:

  • 变量名: CLASSPATH
  • 变量值: .;%JAVA_HOME%\lib;%JAVA_HOME%\lib\tools.jar
  • 注意,一定不要忽略了前面的英文句号.啊!
  • image.png
  • 最后一步,找到系统变量中的Path,加入如下内容:
  • %JAVA_HOME%\bin;%JAVA_HOME%\jre\bin;

image.png

点击确定,并通过cmd 查看环境变量配置是否生效:java -version

image.png

JDK8更换JDK11遇到的问题:

更换JDK版本后,修改环境变量,cmd查看版本时仍为jdk8的解决办法:https://blog.csdn.net/qq_26369317/article/details/80922425


二、Gradle5.6.3 的安装

下载与安装

下载地址:https://services.gradle.org/distributions/

gradle-x.x-bin.zip是需要下载的安装发布版(使用这个就行!注意:这里建议大家下载Gradle6.4.x的版本,在写这篇文章的时候我采用的是Gradle5.6.3这个版本,后来有些粉丝私信反应Spring5.3.x,用Gradle5.x的版本好像会有一些问题,但是不是每个人都出问题,所以为了顺应新版本的Spring,建议尽量采用6.x版本的Gradle!)

gradle-x.x-src.zip是源码

gradle-x.x-all.zip则是下载全部的文件


image.png

image.png

下载完毕后,在自己指定的磁盘中新建Gradle文件夹,并将下载的压缩包解压到该文件夹中:

image.png

如下图所示:

image.png

配置环境变量

下载解压完毕后,去进行环境变量的配置,gradle的配置类似于maven和jdk的配置:

右键 -> 我的电脑 –> 属性 –> 高级系统设置 –> 环境变量 –> 系统变量:

在系统变量中新增一个GRADLE_HOME,其值为解压后的路径(我的是F:\Gradle\gradle-5.6.3-all\gradle-5.6.3)


image.png

  • 然后,修改系统Path变量,在Path变量添加 %GRADLE_HOME%\bin

image.png

点击确定,然后就通过cmd命令去测试一下是否配置成功:gradle -v

image.png

查看到gradle的版本信息,配置成功~

创建Gradle的本地jar包仓库文件夹

  • 在我们解压gradle的文件夹下执行cmd命令:mkdir .gradle
  • image.png
  • 则,我们创建的.gradle文件夹就是用来存放所下载的jar包仓库主目录!配置Gradle镜像在Gradle安装目录下的 init.d 文件夹下,新建一个 init.gradle 文件:
  • image.png
  • 在该文件里面填写以下配置:
allprojects{
    repositories {
        def REPOSITORY_URL = 'http://maven.aliyun.com/nexus/content/groups/public/'
        all { ArtifactRepository repo ->
            def url = repo.url.toString()
            if ((repo instanceof MavenArtifactRepository) && (url.startsWith('https://repo1.maven.org/maven2') || url.startsWith('https://jcenter.bintray.com'))) {
                project.logger.lifecycle 'Repository ${repo.url} replaced by $REPOSITORY_URL .'
                remove repo
            }
        }
        maven {
            url REPOSITORY_URL
        }
    }
}

三、IDEA中配置Gradle,并搭建Spring源码环境

IDEA克隆Spring代码仓库

GitHub托管的Spring项目地址:https://github.com/spring-projects/spring-framework

使用HTTPS的方式克隆:https://github.com.cnpmjs.org/spring-projects/spring-framework.git

image.png

打开IDEA:

image.png

  • 从远程GitHub仓库,将Spring项目源码克隆到本机:


image.png

  • 点击克隆等待克隆完毕,项目初始化,当初始化完成后,如果出现如下情况:

image.png

说明IDEA未配置Gradle,以及Gradle镜像!请接着往下操作:

IDEA配置Gradle

  • 打开IDEA -> setting -> Build,Execution,Deployment -> Build Tools -> Gradle,如下:
  • image.png
  • 配置修改如下:
  • image.png
  • 设置成功后,再继续往下配置:

修改Spring项目源码中Gradle相关配置

主要修改的地方如下几个文件:

image.png

  1. import-into-idea.md:这是官方提供的spring源码导入idea的步骤和注意说明,可以移步:IDEA导入Spring源码调试必看了解一下!
  • 2.修改settings.gradle文件,下载依赖的网络速度之不可描述原因,这里需要加上阿里云的maven镜像仓库:
maven { url 'https://maven.aliyun.com/repository/gradle-plugin' }
maven { url "https://maven.aliyun.com/repository/public" }

修改好之后如下图所示:

image.png

3.修改gradle.properties文件,都已经加了详细注释:

version=5.3.0-SNAPSHOT
## 设置此参数主要是编译下载包会占用大量的内存,可能会内存溢出
org.gradle.jvmargs=-Xmx2048M
## 开启 Gradle 缓存
org.gradle.caching=true
## 开启并行编译
org.gradle.parallel=true
## 启用新的孵化模式
org.gradle.configureondemand=true
## 开启守护进程 通过开启守护进程,下一次构建的时候,将会连接这个守护进程进行构建,而不是重新fork一个gradle构建进程
org.gradle.daemon=true

修改好之后如下图所示:

image.png

4.修改build.gradle文件,加上使用阿里云仓库,提高下载速度:

repositories {
  // 新增2个阿里镜像地址
  maven { url 'http://maven.aliyun.com/nexus/content/groups/public/' }
  maven { url 'http://maven.aliyun.com/nexus/content/repositories/jcenter' }
  mavenCentral()
  maven { url "https://repo.spring.io/libs-spring-framework-build" }
  // 新增spring插件库
  maven { url "https://repo.spring.io/plugins-release"}
}

修改好之后如下图所示:

image.png

  • 5.这里还需要再改一个地方,就是如下位置中的gradle-wrapper.properties文件:

image.png

这个压缩包也可以自己下载,不用6.8.3版本的,用自己下载的版本也可以。我这里用6.8.3版本的压缩包,是因为,Spring5.3.8源码默认用的是6.8.3版本的gradle!


Spring源码的构建、编译

在Spring源码的本机位置,打开cmd,执行命令:gradlew :spring-oxm:compileTestJava,去预编译spring-oxm模块!


image.png

image.png

等待命令执行结束:

image.png

同上,预编译spring-core模块,执行命令gradlew :spring-core:compileTestJava,并等待命令执行结束:

image.png

到这儿,使用IDEA + Gradle构建Spring5源码就已经全部完成。


四、源码环境验证

最后一部,就是去验证一下我们搭建的Spring源码环境是否可以正常运行:


简单测试:Spring源码给我们提供了测试环境搭建是否正常的包,测试运行spring-context模块下的test包:


image.png

执行结果如下图:

image.png

功能测试:自己建立一个模块去测试Spring源码的功能。在spring-framework项目下新建我们自己的测试module,如下图所示:

image.png

image.png

image.png

等待模块创建完毕后,向子模块的build.gradle文件指定位置加入如下代码:

compile(project(":spring-context"))
compile("org.aspectj:aspectjrt:1.9.5")
compile("org.aspectj:aspectjweaver:1.9.5")

如下图:

image.png

这里其实就相当于maven工程的pom.xml文件,加入上述代码的目的是为了在子模块my-spring-test中引入spring-context模块的依赖。

  • 为子模块新建java目录结构(IDEA可以自动生成)New -> Directory:
  • image.png
  • 自动新建如下三个模块:
  • image.png
  • 新建完成后结果如下图:
  • image.png
  • 在java包下新建com.myspring.test包,并创建相关测试类以及spring配置文件:

测试主函数类

/**
 * date: 2021/5/13
 * @author csp
 * 测试主函数类
 */
public class Main {
  public static void main(String[] args) {
    // 读取spring配置文件
    ApplicationContext context = new ClassPathXmlApplicationContext("classpath:spring-test.xml");
    // 获取service的bean对象
    UserService userService = (UserService) context.getBean("userService");
    // 执行service方法查询user对象
    User user = userService.getUserById(1);
    // 输出user结果
    System.out.println(user);
  }
}

User实体类

/**
 * date: 2021/5/13
 *
 * @author csp
 * User实体类
 */
public class User {
  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;
  }
  @Override
  public String toString() {
    return "User{" +
        "name='" + name + '\'' +
        ", age=" + age +
        '}';
  }
}

service接口

/**
 * date: 2021/5/13
 * @author csp
 * service接口
 */
public interface UserService {
  User getUserById(int id);
}

service接口实现类

/**
 * date: 2021/5/13
 * @author csp
 * service接口实现类
 */
public class UserServiceImpl implements UserService {
  @Override
  public User getUserById(int id) {
    User user = new User();
    user.setAge(22);
    user.setName("兴趣使然の草帽路飞");
    return user;
  }
}

resources下新建spring配置文件spring-text.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">
    <!--xml的方式将UserServiceImpl注入ioc容器-->
  <bean id="userService" class="com.myspring.test.UserServiceImpl"/>
</beans>

测试运行,输出如下结果,说明环境搭建没有问题了:

image.png

参考文章:https://www.cnblogs.com/mazhichu/p/13163979.html

  • 本篇是Spring源码系列第一篇,后续会陆续更新,如果对大家有帮助,请三连支持一下!
  • 如果搭建出现问题,欢迎评论区留言,及时帮大家解决!
  • image.png


相关文章
|
26天前
|
XML 安全 Java
|
29天前
|
缓存 NoSQL Java
什么是缓存?如何在 Spring Boot 中使用缓存框架
什么是缓存?如何在 Spring Boot 中使用缓存框架
46 0
|
1月前
|
数据采集 监控 前端开发
二级公立医院绩效考核系统源码,B/S架构,前后端分别基于Spring Boot和Avue框架
医院绩效管理系统通过与HIS系统的无缝对接,实现数据网络化采集、评价结果透明化管理及奖金分配自动化生成。系统涵盖科室和个人绩效考核、医疗质量考核、数据采集、绩效工资核算、收支核算、工作量统计、单项奖惩等功能,提升绩效评估的全面性、准确性和公正性。技术栈采用B/S架构,前后端分别基于Spring Boot和Avue框架。
|
4天前
|
设计模式 XML Java
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
本文详细介绍了Spring框架的核心功能,并通过手写自定义Spring框架的方式,深入理解了Spring的IOC(控制反转)和DI(依赖注入)功能,并且学会实际运用设计模式到真实开发中。
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
|
3天前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
11天前
|
IDE Java 测试技术
互联网应用主流框架整合之Spring Boot开发
通过本文的介绍,我们详细探讨了Spring Boot开发的核心概念和实践方法,包括项目结构、数据访问层、服务层、控制层、配置管理、单元测试以及部署与运行。Spring Boot通过简化配置和强大的生态系统,使得互联网应用的开发更加高效和可靠。希望本文能够帮助开发者快速掌握Spring Boot,并在实际项目中灵活应用。
28 5
|
9天前
|
前端开发 Java 开发者
这款免费 IDEA 插件让你开发 Spring 程序更简单
Feign-Helper 是一款支持 Spring 框架的 IDEA 免费插件,提供 URL 快速搜索、Spring Web Controller 路径一键复制及 Feign 与 Controller 接口互相导航等功能,极大提升了开发效率。
|
22天前
|
缓存 Java 数据库连接
Spring框架中的事件机制:深入理解与实践
Spring框架是一个广泛使用的Java企业级应用框架,提供了依赖注入、面向切面编程(AOP)、事务管理、Web应用程序开发等一系列功能。在Spring框架中,事件机制是一种重要的通信方式,它允许不同组件之间进行松耦合的通信,提高了应用程序的可维护性和可扩展性。本文将深入探讨Spring框架中的事件机制,包括不同类型的事件、底层原理、应用实践以及优缺点。
51 8
|
1月前
|
存储 Java 关系型数据库
在Spring Boot中整合Seata框架实现分布式事务
可以在 Spring Boot 中成功整合 Seata 框架,实现分布式事务的管理和处理。在实际应用中,还需要根据具体的业务需求和技术架构进行进一步的优化和调整。同时,要注意处理各种可能出现的问题,以保障分布式事务的顺利执行。
57 6
|
1月前
|
Java 数据库连接 数据库
不可不知道的Spring 框架七大模块
Spring框架是一个全面的Java企业级应用开发框架,其核心容器模块为其他模块提供基础支持,包括Beans、Core、Context和SpEL四大子模块;数据访问及集成模块支持数据库操作,涵盖JDBC、ORM、OXM、JMS和Transactions;Web模块则专注于Web应用,提供Servlet、WebSocket等功能;此外,还包括AOP、Aspects、Instrumentation、Messaging和Test等辅助模块,共同构建强大的企业级应用解决方案。
81 2