天天看点

Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程

Spring 5源码阅读系列(1):源码阅读环境搭建

  • 学习任务
  • 前期准备
  • 搭建过程
    • 1. 下载源码
    • 2. 源代码导入
      • 2.1 导入Eclipse
        • 2.1.1 版本要求
        • 2.1.2 安装插件
        • 2.1.3 代码导入
      • 2.2 导入IDEA
    • 3. 解决项目报错
      • 3.1. API Acess Restriciton
      • 3.2. Groovy Mismatch Problem

学习任务

近期想增加部分源码阅读经验,提高自己在造轮子方面的实力,增长些在设计模式应用方面的编码能力,以及怀着向大佬们膜拜的心情,开始有计划地阅读Spring源码

前期准备

以下几项准备事项,算是基本的日常开发环境,就算没有,也是动动手很快安装好的,这里就不啰嗦详细记录了。
若安装存在困难的,可以尝试百度解决:请相信自己可以做到的!
  • JDK 1.8 安装及其环境配置(略)
  • Eclipse安装,或者 IntelliJ IDEA(略)
  • Git客户端安装(略)
  • Gradle 安装及其环境变量配置(略)

搭建过程

1. 下载源码

访问 spring-framework 项目官方源码网站,查看版本Release日志,选定比较稳定合适的版本来分析学习:

Spring源码的git地址:

https://github.com/spring-projects/spring-framework

Spring Release版本:

https://github.com/spring-projects/spring-framework/releases

本文选取最近发布的:v5.1.x分支,进行后续的源码阅读:

# 获取源码
git clone https://github.com/spring-projects/spring-framework.git
# 根据网速,上面这一步可能相当慢

# 查看远程分支
git branch -r

# 创建切换本地分支
git checkout -b 5.1.x  origin/5.1.x
git pull
           
Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程

Note:可能大家在代码checkout这里时,会卡住——因为众所周知的原因,访问github确实是很慢,所以可以通过修改hosts的映射来加速github的访问,具体方法可以问度娘;

我在这里贴出我自己根据网上的方法,增加的hosts映射内容;但可能对部分其它地区的朋友无效;所以需要自己按照网上的方法,自己来做一遍!

# hosts file
# speed up access to github
192.30.253.112	github.com
185.199.110.153	assets-cdn.github.com
185.199.110.154	github.githubassets.com
151.101.185.194	github.global.ssl.fastly.net
           

2. 源代码导入

代码下载后,先不着急,按照行业惯例,看下README.md等一些说明文档;一般都会有文档指导你如何从源码编译项目等介绍性说明。

但Spring更良心,竟然还提供了说明文档,怎么导入不同的代码IDE中:

  • import-into-eclipse.md
  • import-into-idea.md

既然如此,那就按文档说明,开始导入IDE中吧!

2.1 导入Eclipse

2.1.1 版本要求

查看

import-into-eclipse.md

文档,里面说,导入Eclipse前,需要满足一些前提条件:

  • Eclipse支持JDK8
  • Eclipse需要安装AspectJ Development Tools(AJDT);AJDT支持的Eclipse版本有:
    • 2018-09 (4.9)
    • Photon (4.8)
    • Oxygen (4.7)
    • Neon (4.6)
    • Juno (4.2, 3.8)
    • Previous to Juno (<=4.1)
  • Eclipse需要安装Groovy Compiler

2.1.2 安装插件

本机环境是Oxygen,在Eclipse Marketplace中安装了AJDT和Groovy插件(截图时插件已经安装),如图:

Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程
Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程
Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程

Note:其实还需要安装gradle插件(Buildship Gradle integration),但Oxygen已经预安装了,就帮我们省了不少事

2.1.3 代码导入

按文档所示,导入Eclipse需要5步:

  • 1、用命令

    ./gradlew :spring-oxm:compileTestJava

    预编译子项目

    spring-oxm

    ;
    Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程
  • 2、导入Eclispe(File -> Import -> Gradle ->Existing Gradle Project -> 浏览到项目路径 -> 选择”完成“);
    Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程
    Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程

NOTE:这个过程有点慢,因为和maven项目一样,gradle项目也需要下载依赖包;

  • 3、如果有相关提示,排除

    spring-aspects

    项目(或者在导入项目后,关闭或者删除这个子项目);
    Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程
  • 4、在子项目

    spring-oxm

    中,将

    build/generated-sources

    下面的

    jaxb

    子目录加入到

    build path

    中(在目录中右键选择

    Build Path -> Use as Source Folder

    );
  • 5、如果有对项目有其它额外的配置要求,可以运行

    ./gradlew eclipseBuildship

2.2 导入IDEA

导入IDEA和导入Eclipse的操作基本上完全一样,只是没有第4步,然后第3步关闭的是Module;

TODO:(细节待后续增补)

3. 解决项目报错

3.1. API Acess Restriciton

修改JRE默认的API Access Rule即可:Build Path -> Library -> edit

Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程

有两个子项目会有这个问题:

spring-context

spring-web

每个都这样设置一下,就可以解决了。

3.2. Groovy Mismatch Problem

在项目视图,发现

spring-build-src

上面有个感叹号,但代码中又没有出现错误;这种情况,一般是和项目配置,比如

Build Path

Project Facets

等等;具体信息可以展开

Markers

视图来查看下,如下图:

Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程

原来是groovy版本问题:工作空间设置的是2.5,但spring项目设置是的2.4。

spring-build-src

上右键,修改

groovy compiler level

就可以解决这个问题了:

Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程

到此,源码阅读环境搭建完成!

上最终完成的效果图:

Spring 5源码阅读系列(1):源码阅读环境搭建学习任务前期准备搭建过程

开始艰苦的源码阅读之路!少年,我们一起加油!

继续阅读