最近打算閱讀spring-framework的源碼，按照GitHub中在spring-framework項目中給出的編譯和導(dǎo)入IntelliJ IDEA的方式進行操作，其中還是遇到了各種各樣的問題。主要是環(huán)境，最好都用新的，JDK17、Idea 2021、Gradle7.2、Tomcat10等，然后就是多次重試。最終還是成功了，文章末尾也列了幾個遇到的問題及最終存在我的GitHub中的地址。

1. 獲取spring-framework源碼

地址：spring-projects/spring-framework: Spring Framework (github.com)

目前看到最新的Tag是v5.3.10。

可以直接將最新代碼clone到本地，如果想在代碼做一些注釋，也可以Fork到自己的倉庫。本文采用Fork的方式，并添加了測試module。

2. 導(dǎo)入到IDEA

項目的wiki中給出了導(dǎo)入到 Eclipse 和 IntelliJ IDEA的方式：Ensure JDK 17 is configured properly in the IDE. Follow instructions forEclipse and IntelliJ IDEA.

要求安裝 JDK17，根據(jù)自己的需求選擇導(dǎo)入到 Eclipse 或 IntelliJ IDEA。對應(yīng)的文檔在下載的代碼根目錄也有，分別為import-into-eclipse.md和import-into-idea.md。本文為IDEA方式。

2.1 預(yù)編譯spring-oxm

在代碼目錄打開cmd，輸入命令gradlew :spring-oxm:compileTestJava（windows系統(tǒng)無需輸入“./”），開始編譯。

若出現(xiàn)如下錯誤，需檢查JAVA_HOME是否已正確配置了JDK17：

若未安裝配置gradle，會自動下載安裝。默認情況下，下載的包會存放在C:\Users\用戶名\.gradle文件夾下。若C盤空間比較緊張想放到別的目錄，可以配置一下名為GRADLE_USER_HOME的環(huán)境變量，將其值設(shè)置為新的目錄。gradle的安裝配置和maven類似，如果自己安裝最好按照源碼中的版本。

可以查看spring-framework\gradle\wrapper文件夾下的gradle-wrapper.properties文件中的distributionUrl的配置，例如目前代碼采用的Gradle版本為7.2.

distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

等待編譯完成即可，最終結(jié)果類似如下情況。

連接Github經(jīng)常出現(xiàn)網(wǎng)絡(luò)問題，若出現(xiàn)錯誤重新執(zhí)行這個命令幾次。

2.2 導(dǎo)入到Idea

依次點擊菜單File->New->Project From Existing sources,出現(xiàn)如下對話框

選擇Gradle，提示信任此項目，選擇Trust Project

點擊下圖箭頭所示的Reload All Gradle Projects

可以在Idea的Build日志中看到如下輸出

第一次會下載很多依賴包，比較慢，慢慢等待。網(wǎng)上有說用阿里云Maven服務(wù)的，會快一些。但有時候個別包下載失敗，不著急就慢慢等吧。直至Build完成，如果中途失敗可以多試幾次。

3 添加用于測試的SpringMVC項目Module

想調(diào)試不同的子項目，可以根據(jù)需要新建不同類型的測試Module?，F(xiàn)在新建一個SpringMVC的Module用于調(diào)試spring-webmvc子項目及其依賴的子項目。

3.1 創(chuàng)建Module

依次點擊菜單File->New->Module, 在彈出的對話框中選擇Gradle，如下圖勾選Java和Web兩個選項，點擊Next按鈕進行下一步

設(shè)置項目的名字，本例名為flylolo-readcode

點擊Finish完成設(shè)置，項目開始創(chuàng)建，等待項目創(chuàng)建完成。

查看根目錄的settings.gradle文件，可以看到其中添加了如下一行。

include 'flylolo-readcode'

3.2 添加對spring-webmvc的依賴

編輯build.gradle,在dependencies內(nèi)添加spring-webmvc的依賴：

implementation(project(":spring-webmvc"))

保存并點擊Gradle面板中的Reload按鈕，重新加載依賴，最終可以看到flylolo-readcode項目的依賴中出現(xiàn)了。

3.3 添加MVC相關(guān)文件

添加mvc相關(guān)文件，文件結(jié)構(gòu)如下：

①首先添加一個Controller：

package cn.flylolo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author FlyLolo
 * @date 2021/10/9 16:42
 */
@RestController
@RequestMapping("user")
public class UserController {
    @GetMapping("")
    public String helloWorld(){
        return "Hello World!";
    }
}

②在resources目錄下新建springmvc.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"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd 
        http://www.springframework.org/schema/mvc 
        http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <context:component-scan base-package="cn.flylolo"/>
    <mvc:annotation-driven />
    <mvc:default-servlet-handler />
</beans>

③webapp目錄下新建WEB-INF文件夾，其中新建web.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://java.sun.com/xml/ns/javaee"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
         id="WebApp_ID" version="3.0">
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:springmvc.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <!--配置springmvc核心servlet-->
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

3.4 設(shè)置Artifacts

打開File->Project Struture設(shè)置，左側(cè)切換到Artifacts，可以看到已經(jīng)自動生成的兩個Artifact，選擇帶"exploded"后綴的，做如下修改：

Name比較長，可以自行修改，不改也可以，本例改為flylolo-readcode

Output directory自動生成的路徑有問題，去掉"exploded", 例如本例改為：F:\spring-framework\flylolo-readcode\build\libs\flylolo-readcode-6.0.0-SNAPSHOT.war。

最終結(jié)果如下圖：

3.5 配置Tomcat服務(wù)

打開Run/Debug Configuration, 點擊左上角的加號，選擇Tomcat Server->Local。

HTTP prot默認為8080，若已被使用則改為其他的端口。

選擇artifacts，點擊右下角的Fix按鈕，跳轉(zhuǎn)到Deployment標簽，選擇剛剛配置的flylolo-readcode。

保存并啟動項目，訪問UserController，地址：http://localhost:8099/flylolo_readcode/user

3.6 添加json解析：

如果只是返回String類型是沒問題了，但大多數(shù)需要返回的時候Json類型。

新建一個User類：

package cn.flylolo.model;

import lombok.Data;

/**
 * @author FlyLolo
 * @date 2021/10/11 11:18
 */
@Data
public class User {
    private String userId;
    private String userName;
}

這里用到了lombok，需要在build.gradle中添加引用。

implementation 'org.projectlombok:lombok:1.18.20'
annotationProcessor 'org.projectlombok:lombok:1.18.20'

注意需要添加第二行，否則在調(diào)用對應(yīng)的get和set方法的時候會出現(xiàn) “錯誤: 找不到符號”的錯誤。

在UserController中添加新的方法：

@GetMapping("/{userId}")
public User getName(@PathVariable String userId){
    User user = new User();
    user.setUserId(userId);
    user.setUserName(userId + "的名字");
    return user;
}

將返回一個User對象。

訪問http://localhost:8099/flylolo_readcode/user/testid，返回了406，不可接收錯誤。

因為返回Json類型，需要添加對應(yīng)的message-converters,本例采用FastJson。用下面代碼替換springmvc.xml中的<mvc:annotation-driven />

<mvc:annotation-driven>
    <mvc:message-converters register-defaults="true">
        <!-- 配置Fastjson支持 -->
        <bean class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">
            <property name="supportedMediaTypes">
                <list>
                    <value>application/json</value>
                    <value>text/html;charset=UTF-8</value>
                </list>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

這需要在build.gradle中添加FastJson的引用：

implementation 'com.alibaba:fastjson:1.2.78'

再次訪問http://localhost:8099/flylolo_readcode/user/testid，得到了期望的結(jié)果。

至此，源碼閱讀環(huán)境準備完畢。

4. 遇到的問題

 4.1 gradle進行build的時候，中文出現(xiàn)亂碼：

Help->Edit Custom VM Options, 添加如下代碼：

-Dfile.encoding=UTF-8

4.2 gradle項目，用了lombok

調(diào)用setXXX提示“找不到符號"的錯誤，需在build.gradle中做如下方式引用

//添加annotationProcessor，否則會出現(xiàn)找不到符號的錯誤
annotationProcessor 'org.projectlombok:lombok:1.18.20'
implementation 'org.projectlombok:lombok:1.18.20'

4.3 服務(wù)啟動報錯問題

服務(wù)無法正常啟動，報錯“org.apache.tomcat.util.modeler.BaseModelMBean.invoke 調(diào)用方法[manageApp]時發(fā)生異常 java.lang.IllegalStateException: 啟動子級時出錯”，詳細錯誤如下：

Connected to server
[2021-10-11 03:30:50,531] Artifact flylolo-readcode: Artifact is being deployed, please wait...
11-Oct-2021 15:30:50.793 嚴重 [RMI TCP Connection(3)-127.0.0.1] org.apache.tomcat.util.modeler.BaseModelMBean.invoke 調(diào)用方法[manageApp]時發(fā)生異常
 java.lang.IllegalStateException: 啟動子級時出錯
  at org.apache.catalina.core.ContainerBase.addChildInternal(ContainerBase.java:729)
  at org.apache.catalina.core.ContainerBase.addChild(ContainerBase.java:698)
  at org.apache.catalina.core.StandardHost.addChild(StandardHost.java:696)
  at org.apache.catalina.startup.HostConfig.manageApp(HostConfig.java:1783)
  at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
  at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
  at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
  at java.base/java.lang.reflect.Method.invoke(Method.java:568)
  at org.apache.tomcat.util.modeler.BaseModelMBean.invoke(BaseModelMBean.java:293)
  at java.management/com.sun.jmx.interceptor.DefaultMBeanServerInterceptor.invoke(DefaultMBeanServerInterceptor.java:814)
  at java.management/com.sun.jmx.mbeanserver.JmxMBeanServer.invoke(JmxMBeanServer.java:802)
  at org.apache.catalina.mbeans.MBeanFactory.createStandardContext(MBeanFactory.java:460)
  at org.apache.catalina.mbeans.MBeanFactory.createStandardContext(MBeanFactory.java:408)
  at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
  at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
  at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
  at java.base/java.lang.reflect.Method.invoke(Method.java:568)
  at org.apache.tomcat.util.modeler.BaseModelMBean.invoke(BaseModelMBean.java:293)
  at java.management/com.sun.jmx.interceptor.DefaultMBeanServerInterceptor.invoke(DefaultMBeanServerInterceptor.java:814)
  at java.management/com.sun.jmx.mbeanserver.JmxMBeanServer.invoke(JmxMBeanServer.java:802)
  at java.management/com.sun.jmx.remote.security.MBeanServerAccessController.invoke(MBeanServerAccessController.java:472)
  at java.management.rmi/javax.management.remote.rmi.RMIConnectionImpl.doOperation(RMIConnectionImpl.java:1472)
  at java.management.rmi/javax.management.remote.rmi.RMIConnectionImpl$PrivilegedOperation.run(RMIConnectionImpl.java:1310)
  at java.base/java.security.AccessController.doPrivileged(AccessController.java:712)
  at java.management.rmi/javax.management.remote.rmi.RMIConnectionImpl.doPrivilegedOperation(RMIConnectionImpl.java:1412)
  at java.management.rmi/javax.management.remote.rmi.RMIConnectionImpl.invoke(RMIConnectionImpl.java:829)
  at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
  at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
  at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
  at java.base/java.lang.reflect.Method.invoke(Method.java:568)
  at java.rmi/sun.rmi.server.UnicastServerRef.dispatch(UnicastServerRef.java:360)
  at java.rmi/sun.rmi.transport.Transport$1.run(Transport.java:200)
  at java.rmi/sun.rmi.transport.Transport$1.run(Transport.java:197)
  at java.base/java.security.AccessController.doPrivileged(AccessController.java:712)
  at java.rmi/sun.rmi.transport.Transport.serviceCall(Transport.java:196)
  at java.rmi/sun.rmi.transport.tcp.TCPTransport.handleMessages(TCPTransport.java:587)
  at java.rmi/sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.run0(TCPTransport.java:828)
  at java.rmi/sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.lambda$run$0(TCPTransport.java:705)
  at java.base/java.security.AccessController.doPrivileged(AccessController.java:399)
  at java.rmi/sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.run(TCPTransport.java:704)
  at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
  at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
  at java.base/java.lang.Thread.run(Thread.java:833)
 Caused by: org.apache.catalina.LifecycleException: 無法啟動組件[StandardEngine[Catalina].StandardHost[localhost].StandardContext[/flylolo_readcode]]
  at org.apache.catalina.util.LifecycleBase.handleSubClassException(LifecycleBase.java:440)
  at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:198)
  at org.apache.catalina.core.ContainerBase.addChildInternal(ContainerBase.java:726)
  ... 42 more
 Caused by: java.lang.NoClassDefFoundError: jakarta/servlet/ServletContainerInitializer
  at java.base/java.lang.ClassLoader.defineClass1(Native Method)
  at java.base/java.lang.ClassLoader.defineClass(ClassLoader.java:1012)
  at java.base/java.security.SecureClassLoader.defineClass(SecureClassLoader.java:150)
  at org.apache.catalina.loader.WebappClassLoaderBase.findClassInternal(WebappClassLoaderBase.java:2478)
  at org.apache.catalina.loader.WebappClassLoaderBase.findClass(WebappClassLoaderBase.java:870)
  at org.apache.catalina.loader.WebappClassLoaderBase.loadClass(WebappClassLoaderBase.java:1371)
  at org.apache.catalina.loader.WebappClassLoaderBase.loadClass(WebappClassLoaderBase.java:1215)
  at java.base/java.lang.Class.forName0(Native Method)
  at java.base/java.lang.Class.forName(Class.java:467)
  at org.apache.catalina.startup.WebappServiceLoader.loadServices(WebappServiceLoader.java:226)
  at org.apache.catalina.startup.WebappServiceLoader.load(WebappServiceLoader.java:197)
  at org.apache.catalina.startup.ContextConfig.processServletContainerInitializers(ContextConfig.java:1840)
  at org.apache.catalina.startup.ContextConfig.webConfig(ContextConfig.java:1298)
  at org.apache.catalina.startup.ContextConfig.configureStart(ContextConfig.java:986)
  at org.apache.catalina.startup.ContextConfig.lifecycleEvent(ContextConfig.java:303)
  at org.apache.catalina.util.LifecycleBase.fireLifecycleEvent(LifecycleBase.java:123)
  at org.apache.catalina.core.StandardContext.startInternal(StandardContext.java:5135)
  at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:183)
  ... 43 more
 Caused by: java.lang.ClassNotFoundException: jakarta.servlet.ServletContainerInitializer
  at org.apache.catalina.loader.WebappClassLoaderBase.loadClass(WebappClassLoaderBase.java:1407)
  at org.apache.catalina.loader.WebappClassLoaderBase.loadClass(WebappClassLoaderBase.java:1215)
  ... 61 more

通過錯誤信息中的“Caused by: java.lang.ClassNotFoundException: jakarta.servlet.ServletContainerInitializer”可以看出是缺少對應(yīng)的包，網(wǎng)上搜了有類似的錯誤，少的卻不是這個包，后來嘗試把Tomcat改為10.0.12（出錯時為Tomcat 9），此問題解決，應(yīng)該是最新的Tomcat中存在此包。

5 GitHub地址

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

到此這篇關(guān)于spring-framework源碼調(diào)試的文章就介紹到這了,更多相關(guān)spring-framework源碼內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！