如何本地启动调试含SPI的Spring Boot依赖项目及Gradle多模块配置？

一、启动依赖中的Spring Boot主类（解决IDE无法识别问题） #

不管是IntelliJ还是Eclipse，不用等IDE自动识别，手动配置启动项即可：

• IntelliJ操作：
  1. 点击顶部「Run」→「Edit Configurations」
  2. 点击「+」选择「Spring Boot」类型
  3. 在「Main class」栏直接输入核心项目中标注@SpringBootApplication的主类全路径（比如com.example.core.CoreBootApplication）
  4. 「Working directory」选择项目根目录（单项目选当前根，转多项目后选多项目根目录）
  5. 保存后直接启动调试，IDE会自动加载核心、邮件项目的类路径
• Eclipse操作：
  1. 右键项目→「Run As」→「Run Configurations」
  2. 选中「Spring Boot App」后点击「New」
  3. 在「Main class」栏输入主类全路径
  4. 切换到「Classpath」标签，确认核心、邮件项目已在类路径中，缺失则手动添加
  5. 启动调试即可

补充：因为不是Web服务，启动后Spring会完成上下文初始化，直接在业务代码（比如邮件发送逻辑、SPI实现类）打断点就能调试。

二、添加带源码的SPI项目支持调试 #

如果SPI项目是本地源码，直接导入IDE并关联主项目依赖即可：

• IntelliJ：
  1. 「File」→「New」→「Module from Existing Sources」，选择SPI项目根目录，按提示导入（选择Gradle项目类型）
  2. 打开主项目的build.gradle，把原来的SPI远程依赖（比如implementation 'com.example:spi:1.0.0'）改成项目依赖：implementation project(':spi')
  3. 同步Gradle，调试时就能直接进入SPI源码的断点
• Eclipse：
  1. 「File」→「Import」→「Existing Gradle Project」，导入SPI项目
  2. 修改主项目build.gradle中的SPI依赖为项目依赖，同步Gradle
  3. 右键主项目→「Properties」→「Java Build Path」→「Projects」，添加SPI项目到依赖列表

注意：如果SPI是通过Java SPI机制（ServiceLoader）加载的，要确保META-INF/services下的配置文件正确指向实现类，本地调试时IDE会自动将这些资源打包到类路径。

三、Gradle单项目转多项目的必要性与构建脚本示例 #

必要性 #

转多项目肯定更易解决问题。单项目依赖本地源码时，需要手动处理依赖关联、同步；多项目构建能让Gradle自动管理模块间的依赖、编译顺序，IDE也能自动识别所有模块的源码，不用手动导入关联，尤其适配Java 17的模块化特性时，多项目结构逻辑更清晰。

多项目构建脚本示例 #

1. 根目录settings.gradle

rootProject.name = 'my-main-project'
include ':core', ':mail', ':spi'
// 若模块目录名与模块名不一致，用以下方式指定路径：
// project(':spi').projectDir = file('../custom-spi-directory')

2. 根目录build.gradle（全局配置）

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.2.0' // 适配Java 17的Spring Boot版本
    id 'io.spring.dependency-management' version '1.1.4'
}

group = 'com.example'
version = '1.0.0-SNAPSHOT'

java {
    sourceCompatibility = JavaVersion.VERSION_17
    targetCompatibility = JavaVersion.VERSION_17
}

repositories {
    mavenCentral()
}

// 全局依赖版本管理，子模块可直接引用无需写版本号
dependencyManagement {
    imports {
        mavenBom org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES
    }
}

3. core模块（core/build.gradle）

plugins {
    id 'org.springframework.boot'
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    // 按需添加核心项目自身的其他依赖
}

// 打包可执行JAR（用于单独启动）
bootJar {
    enabled = true
}

// 生成供其他模块依赖的普通JAR
jar {
    enabled = true
}

4. mail模块（mail/build.gradle）

plugins {
    id 'java'
}

dependencies {
    implementation project(':core')
    implementation 'org.springframework.boot:spring-boot-starter-mail'
}

5. spi模块（spi/build.gradle）

plugins {
    id 'java'
}

dependencies {
    implementation project(':core') // 若SPI依赖核心项目的API
    // 按需添加SPI自身的其他依赖
}

// 确保SPI的配置文件被正确打包
sourceSets {
    main {
        resources {
            srcDirs = ['src/main/resources']
        }
    }
}

转多项目后的调试优势 #

• 所有模块在同一IDE窗口，断点可直接打在core、mail、spi的任意源码位置
• Gradle同步时自动处理模块依赖，无需手动调整类路径
• 适配Java 17模块化（若使用module-info.java）时，能更清晰地管理模块间的访问权限

内容的提问来源于stack exchange，提问作者Stefan