spring 编译spring5源码 2020-08-22

场景

近日回顾了下自己写的spring相关的博客，感觉深度不够，而且自己理解的部分比较少，所以打算重拾spring，希望能输出些有价值的东西吧。
工作日沉浸在CRUD的海洋中，肯定是没时间，那只好牺牲自己的休息时间了。。
之前编译过好几次，都没遇到什么大问题，这次有点坑，所以以此博客为输出，希望大家能少走弯路，不喜勿喷。

正常流程

笔者环境：jdk1.8 + gradle-6.6 + IntelliJ IDEA2018.3.6
流程大致分为四个步骤：clone --> import --> download --> build，那我们就开始吧。

clone

如果不翻墙，直接clone github上的代码速度是非常慢的，所以用gitee转一下。

1. 准备一个github账号和一个gitee账号
2. github搜spring-projects/spring-framework，Fork到自己github账号仓库
3. gitee账号新建仓库，选择"导入已有仓库"，这样就把spring-framework导过来了，两三分钟就能完成
4. git clone拉gitee代码，速度很OK

import

打开IDEA，选择"import"，双击build.gradle

gradle配置如下，最好使用spring指定的gradle版本进行编译，事半功倍。
spring使用gradle的版本配置在这个文件：.\spring-framework\gradle\wrapper\gradle-wrapper.properties

download

如果是第一次编译spring源码，这个过程会很长，可以配置maven仓库地址指向国内镜像来提升效率，原理和clone代码类似。
笔者头比较铁，硬是让他下载了六个多小时。。虽然这个过程出问题几率不大，但最好不要在单位下载，因为有各种墙，会导致各种问题。

build

之前编译spring源码，只要gradle配置无误，能够进入download过程，之后都能成功编译。但这次编译过程有些坎坷，大致遇到了如下三个问题：

1. cglib和objenesis包重命名问题
2. gradle javadoc命令编码格式问题
3. gradle optional和compile问题

异常处理

cglib和objenesis包重命名问题

事情大致是这样的：cglib动态代理库能为目标对象生成代理对象；objenesis库能动态生成特定对象。这两个库的功能有些类似，所以spring作者为了避免未来可能出现的冲突问题，把他们各自的类做了整理，cglib相关的类放在org.springframework.cglib包，objenesis相关的类放在org.springframework.objenesis包。
看似没啥问题，但spring是类库使用方，使用方已经指向了新的包，而提供方的jar包还是老版本的，当然会找不到这些类，这种情况就是平时经常听到的不兼容。我在标题特意备注了日期，因为不兼容问题可能存在时效性，只要提供方上传新的jar包，这个问题也就迎刃而解了。
知道了问题根源那就好办了，在编译spring源码之前，需要事先打cglib和objenesis最新的jar包。spring作者提供了两个gradle命令去做这件事，一个是cglibRepackJar，另一个是objenesisRepackJar，我们只需要手动设置一下。

找到cglibRepackJar和objenesisRepackJar命令所在，右击该命令，勾选"Excute Before Build"，勾选完命令右边会有"(Before Build)"提示。然后build spring-core模块，该问题解决。

gradle javadoc命令编码格式问题

build spring-core过程中还出现了一个问题：Javadoc generation failed.这个是没有设置编码格式导致的，所以先统一IDEA的编码格式，如下图配置：

配置完成后找到javadoc命令，加一句"options.encoding = “UTF-8”，问题就解决了。

build.gradle optional和compile问题

build spring-context的时候报了一个异常，找不到spring-instrument包下面的类。
因为spring-instrument模块在spring源码内，所以查看spring-context.gradle的依赖关系，把optional改为compile就可以了。再次执行build命令，可以成功完成。

随着spring-context的构建成功，spring容器启动的主流程也可以跑起来了。之前笔者主要围绕spring-context进行研究，其实spring-context只是spring-framework的冰山一角，希望这次能够全面拥抱spring。
java开源框架千千万，其中mybatis集成spring的方式是最优雅的，对平时有机会开发spring组件的同学很有帮助；tomcat号称使用了所有24种设计模式，值得花时间去研究下，对提升内功很有帮助。
以下是结果图，源码地址：https://gitee.com/TBryant/spring-framework