Gradle Goodness:在 IDE 中下载依赖项的 Javadoc 文件

一则或许对你有用的小广告

欢迎加入小哈的星球 ,你将获得:专属的项目实战 / Java 学习路线 / 一对一提问 / 学习打卡/ 赠书活动

目前,正在 星球 内带小伙伴们做第一个项目:全栈前后端分离博客项目,采用技术栈 Spring Boot + Mybatis Plus + Vue 3.x + Vite 4手把手,前端 + 后端全栈开发,从 0 到 1 讲解每个功能点开发步骤,1v1 答疑,陪伴式直到项目上线,目前已更新了 204 小节,累计 32w+ 字,讲解图:1416 张,还在持续爆肝中,后续还会上新更多项目,目标是将 Java 领域典型的项目都整上,如秒杀系统、在线商城、IM 即时通讯、权限管理等等,已有 870+ 小伙伴加入,欢迎点击围观

Gradle 有一个 idea eclipse 插件,我们可以使用它来配置 IntelliJ IDEA 和 Eclipse 项目文件。当我们将这些插件应用到我们的项目时,我们需要额外的任务来生成和更改项目文件。在我们的 Gradle 构建文件中,我们获得了新的配置块来指定属性或调用将更改配置文件的方法。添加的一件好事是让 IDE 下载 Java/Groovy 项目中的依赖项的 Javadoc 文件。默认情况下,依赖项的源代码已经下载并添加到项目中,但不会下载 Javadoc 文件。

在示例构建文件中,我们使用了 idea eclipse 插件。我们还添加了一个 idea eclipse 配置块。我们需要设置属性 downloadJavadoc 的地方有点不同,但最终结果是一样的。


 // File: build.gradle
apply {
    plugin 'java'
    plugin 'idea'
    plugin 'eclipse'
}

idea { module { downloadJavadoc = true } }

eclipse { classpath { downloadJavadoc = true } }

repositories { jcenter() }

dependencies { compile 'org.springframework:spring-context:4.2.1.RELEASE' }

例如,要为 IntelliJ IDEA 创建正确的文件,我们运行以下任务:


 // File: build.gradle
apply {
    plugin 'java'
    plugin 'idea'
    plugin 'eclipse'
}

idea { module { downloadJavadoc = true } }

eclipse { classpath { downloadJavadoc = true } }

repositories { jcenter() }

dependencies { compile 'org.springframework:spring-context:4.2.1.RELEASE' }


当我们运行 eclipse 任务时,将生成所有 Eclipse 项目文件。如果我们查看生成的 .classpath 文件,我们会看到例如添加了 Javadoc 文件的位置:


 // File: build.gradle
apply {
    plugin 'java'
    plugin 'idea'
    plugin 'eclipse'
}

idea { module { downloadJavadoc = true } }

eclipse { classpath { downloadJavadoc = true } }

repositories { jcenter() }

dependencies { compile 'org.springframework:spring-context:4.2.1.RELEASE' }