spring源码用的是gradle而非maven,第一次使用gradle导致导入idea后报很多错,很多类和方法都进不去。网上找了一堆spring源码使用gradle出问题的解决方案但是大部分都不能根治。踩了一天多的坑,这里记录下,给新来的同学规避一下坑,毕竟因为环境问题浪费时间是很没意义的。
一.去github拉取spring 5.0.x的源码。
1.1:https://github.com/spring-projects/spring-framework/tree/5.0.x#
1.2:我用的是ssh的方式,使用git命令行工具clone把源码clone下来
这里要注意一下,clone下来的源码不是5.0.x而是远端的最新代码,一定要记得切换回5.0.x,否则最新源码里面的gradle默认配置会非常新,这样不仅要下载新版的gradle,还要下载与新版gradle对应的最新版jdk。这都是能通过下载解决的,但是如果idea不支持最新的jdk呢?如果gradle与jdk配套工具太新导致兼容性出错,进一步导致源码报一些稀奇古怪的错误,那研究源码的第一步就开始自己给自己埋坑了......
1.3:切换分支或spring源码版本为5.0.x
git branch -a 查看有哪些分支或版本
git checkout 5.0.x
切换成功后就可以看到当前源码所在分支或版本(5.0.x),其他git工具应该也有查看当前分支或版本的方式
二.查看源码中的gradle版本并下载gradle进行安装(切记还不能将源码导入idea!!!因为gradle要先将spring源码编译通过才能导入idea,提前导入遇到报错很难一步步去解决,如果提前导入了请将源码删除重头再来。)
2.1进入源码目录spring-framework\gradle\wrapper,查看gradle-wrapper.properties,里面的distributionUrl说明了使用的gradle版本。
我的是gradle-4.4.1-bin.zip,前面的路径不是spring源码本身的路径了,因为我为了gradle编译需要下载依赖时速度能快点,修改为国内腾讯镜像了,建议跟我保持一致,如果访问外网很快可以忽略。distributionUrl=https\://mirrors.cloud.tencent.com/gradle/gradle-4.4.1-bin.zip
2.2下载gradle
根据上面spring源码配置的默认gradle版本下载gradle,官网下载地址:Gradle | Releases,我选择的是binary-only版本,解压即用不需要安装。下面截图是8.14.2只是举例,实际版本在官网上去挨个找。
2.3解压gradle并配置环境变量及依赖存放路径
新建环境变量,变量名为GRADLE_HOME,值为gradle的安装目录,我这里是H:\gradle-4.4.1。
新建环境变量,变量名为GRADLE_USER_HOME(固定写死,gradle会根据这个变量名改变依赖存放目录。你也不想gradle默认把下载的所有依赖包放C盘吧,默认的目录就是C:\Users\计算机用户名\依赖目录下),值为你指定的依赖存放目录,我的是H:\gradle_repository。
命令行检查gradle是否安装好
gradle -version
gradle是会检查环境变量中是否存在jdk并且检查jdk版本是否与当前gradle版本兼容的。所以如果出现版本相关错误请检查jdk与gradle版本是否配套。我的gradle版本是4.4.1,jdk版本是1.8.0_201。
如果想配置其他版本的gradle和jdk可以在这里找到版本配套关系:https://docs.gradle.org/current/userguide/compatibility.html#compatibility
三.修改gradle,spring的联网镜像为国内镜像,速度提起来。
3.1在你的C盘的当前用户的.gradle目录下新建init.gradle文件,我的文件目录是C:\Users\HarryMa\.gradle\init.gradle。
值为
allprojects {
repositories {
google()
jcenter()
// maven库
def cn = "http://maven.aliyun.com/nexus/content/groups/public/"
def abroad = "http://central.maven.org/maven2/"
// 先从url中下载jar若没有找到,则在artifactUrls中寻找
maven {
url cn
artifactUrls abroad
}
}
}
3.2跟之前的步骤一样,spring编译过程中需要下载的依赖也需要配置国内镜像。
进入源码目录spring-framework\gradle\wrapper,查看gradle-wrapper.properties,里面的distributionUrl修改为distributionUrl=https\://mirrors.cloud.tencent.com/gradle/你自己最终确定的gradle安装包.zip
3.3有些spring包设置了权限,下载不下来,这时候需要修改下载位置。
将源码目录spring-framework\build.gradle文件的buildscript方法体完全修改
修改前
buildscript {
repositories {
gradlePluginPortal()
maven { url "https://repo.spring.io/plugins-release" }
}
dependencies {
classpath("io.spring.gradle:propdeps-plugin:0.0.9.RELEASE")
classpath("io.spring.gradle:docbook-reference-plugin:0.3.1")
classpath("org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.16")
classpath("org.asciidoctor:asciidoctorj-epub3:1.5.0-alpha.7")
}
}
修改后
buildscript {
repositories {
maven { url "https://repo.spring.io/plugins-snapshot" }
}
dependencies {
classpath "io.spring.gradle:propdeps-plugin:0.0.8-SNAPSHOT"
}
}
四.使用gradle编译spring源码
1.打开命令行窗口,进入源码目录spring-framework下。我这里是自己的源码目录
2.执行gradle编译命令:gradle cleanIdea :spring-oxm:compileTestJava
最后出现success即可算编译成功
五.导入idea、设置项目对应的jdk版本、gradle版本,最后进行spring源码装载。
5.1导入idea
File->Open打开源码目录spring-framework即可
5.2设置项目对应的jdk版本
Project Structure->Project
Project Structure->Modules
Project Structure->SDKs
5.3设置gradle版本和对应的JDK
Settings->Build->Build Tools->Gradle
5.4重新加载Spring源码项目
jdk配置步骤可能有点多余,但是我也不知道哪步是没必要的,为了节省时间能看到的地方都配了。
最终,庞大的Spring源码,在idea中一个红色报错都没有!
完结~!!!!!!
(出问题的原因往往是自己不够了解她,再加上操之过急~)