搭建spring源码阅读环境

一、背景

搭建Spring源码阅读环境。

二、步骤

下载源码

打开spring-framework仓库地址，将项目源码clone到本地。

本地编译源码

在用idea打开项目，这里我切换的分支是5.3.x，项目就会自动拉取依赖进行编译。

但问题是下载依赖的速度太慢了。最好用【三、技巧】中的方法加快一下下载速度，编译也马上就完成了。

验证编译是否有问题

1. 新建一个自定义的模块

   

   建好后模块的目录树如下

   ➜  my-test git:(5.3.x) ✗ tree . -L 2
   .
   ├── build  # 无需关注
   │   ├── classes # 无需关注
   │   ├── generated # 无需关注
   │   ├── resources # 无需关注
   │   └── tmp # 无需关注
   ├── build.gradle # 需要关注
   └── src
       ├── main # 需要关注
       ├── test # 无需关注
       └── testFixtures # 无需关注
   

三、技巧

idea设置代理，加快项目下载依赖的速度

设置路径：Settings | Appearance & Behavior | System Settings | HTTP Proxy

设置注释类型

设置路径：Settings | Editor | General | Appearance

设置之后的效果

设置书签

• F11: 设置书签
• shift + F11: 展示设置的所有书签

最好fork源码仓库并新建一个自己的debug分支

因为在阅读、调试的过程中，会在源码中做一些笔记，并且提交到自己的fork仓库上去。

最好直接对项目进行clone，不要在网页上去下载对应分支的代码

下载的zip代码包中不包含git提交信息。 编译也有可能出问题。

fatal: not a git repository

注释

最好写在代码上面一行，不要写在代码右侧。因为目光是从上到下，很容易不去看代码右边是什么。 推荐

// 声明a
int a;

不推荐

int a; // 声明a