将Maven项目作为模块导入Gradle Spring Boot API项目时Javadoc注释丢失的解决方案咨询

第一步：让Maven项目打包时生成Javadoc和源码Jar #

默认情况下，Maven的package命令只会输出包含编译类的主Jar，Javadoc和源码都不会被打包进去。你需要在Maven项目的pom.xml中添加两个插件，专门生成Javadoc Jar和源码Jar：

<build>
    <plugins>
        <!-- 生成源码Jar -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <version>3.3.0</version>
            <executions>
                <execution>
                    <id>attach-sources</id>
                    <phase>package</phase>
                    <goals>
                        <goal>jar-no-fork</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <!-- 生成Javadoc Jar -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.6.0</version>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <phase>package</phase>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

配置完成后，执行mvn clean package，你会在target目录下看到三个文件：

• your-module-xxx.jar（主类文件）
• your-module-xxx-sources.jar（源码文件）
• your-module-xxx-javadoc.jar（Javadoc文件）

第二步：在Gradle项目中正确引入这些Jar #

分两种场景处理：

场景1：本地直接导入Jar文件

如果是手动把Maven生成的Jar复制到Gradle项目的libs目录下，需要在build.gradle中同时引入主Jar、源码Jar和Javadoc Jar：

dependencies {
    // 主类依赖
    implementation files('libs/your-module-xxx.jar')
    // 关联源码Jar（IDE会自动关联Javadoc）
    implementation files('libs/your-module-xxx-sources.jar')
    // 或者直接关联Javadoc Jar
    javadoc files('libs/your-module-xxx-javadoc.jar')
}

添加后，刷新Gradle依赖，IDE（比如IntelliJ IDEA）就会自动加载这些注释了。

场景2：将Maven项目安装到本地Maven仓库

更优雅的方式是执行mvn clean install，把Maven模块安装到本地Maven仓库（默认路径是~/.m2/repository）。然后在Gradle项目的build.gradle中直接依赖这个模块，Gradle会自动识别并关联源码和Javadoc：

repositories {
    mavenLocal() // 启用本地Maven仓库
    mavenCentral()
}

dependencies {
    implementation 'com.yourgroup:your-module:xxx-version'
}

如果IDE没有自动加载Javadoc，可以右键Gradle依赖 → Download Sources and Documentation，手动触发下载。

额外提示 #

• 如果你用的是IntelliJ IDEA，记得检查File → Settings → Build, Execution, Deployment → Build Tools → Gradle，确保Download sources and documentation选项是勾选状态，这样Gradle会自动下载关联的注释文件。
• 如果Maven项目的Javadoc生成有警告（比如缺少某些注释），可以在maven-javadoc-plugin中添加failOnError=false参数，避免打包失败：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.6.0</version>
    <configuration>
        <failOnError>false</failOnError>
    </configuration>
    <executions>...</executions>
</plugin>

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