Gradle 中怎么配置 maven-publish 插件上传源码与文档

酷辰小哥_5657

酷辰小哥_5657

2026-08-09

163人浏览

原创

Gradle 中配置 maven-publish 上传 sources 和 javadoc JAR,需启用 Java/Android 插件、调用 withSourcesJar()/withJavadocJar() 声明工件,并通过 from components.java 或 components.release 挂载到出版物;Kotlin 项目若用 Dokka,需显式指定 javadocJar 输出路径。

gradle 中怎么配置 maven-publish 插件上传源码与文档

Gradle 中配置 maven-publish 插件上传源码(sources JAR)和文档(Javadoc JAR),核心是声明对应工件并将其附加到出版物中。Java 和 Android 项目略有差异,但逻辑一致:生成 JAR、指定 classifier、挂载到 publication。

确保 Java 插件已启用

源码与文档打包依赖 java 插件提供的标准任务(sourcesJar 和 javadocJar)。大多数 Java/Kotlin 项目默认已启用,可确认 build.gradle 中存在:

  • plugins { id 'java' }(Groovy)或 plugins { kotlin("jvm") } // + java 插件通常隐含
  • 若使用 Android Gradle Plugin(AGP),则需确保 android 插件已应用,它会自动提供 androidSourcesJar 等变体任务

声明 sources 和 javadoc 工件

Gradle 7.4+ 推荐使用内置 DSL 方式,简洁且兼容性好:

  • Java 项目(Groovy):
    java { withSourcesJar(); withJavadocJar() }
  • Android 项目(Groovy):
    android { publishing { singleVariant("release") { withSourcesJar(); withJavadocJar() } } }
  • Kotlin 项目(Kotlin DSL):
    java { withSourcesJar(); withJavadocJar() }

该写法会自动创建 sourcesJar 和 javadocJar 任务,并为它们设置正确 classifier("sources" / "javadoc"),无需手动定义 Jar task。

Java Api Extractor
Java Api Extractor

从 Java 项目中提取 Controller 层接口定义为 JSON 数据。

下载

将工件挂载到 MavenPublication

在 publishing { publications { ... } } 块中,确保出版物基于 components.java(Java)或 components.release(Android),它已包含上述工件:

  • Java 示例:
    mavenJava(MavenPublication) { from components.java }
  • Android 示例:
    release(MavenPublication) { from components.release }

只要 components.java 或 components.release 已启用 withSourcesJar() 和 withJavadocJar(),这些 JAR 就会自动作为附属 artifact 发布,无需额外 artifact 调用。

处理 Dokka(Kotlin 文档替代方案)

若项目使用 Dokka 生成 Kotlin 友好文档,需显式替换 javadocJar:

  • 添加 Dokka 插件:id "org.jetbrains.dokka" version "1.9.20" apply false
  • 在 publishing 块中指定:
    javadocJar { archiveClassifier.set("javadoc"); from dokkaHtml.get().outputDirectory }
  • 或使用插件自动集成(如 com.vanniktech.maven.publish),它默认优先使用 Dokka 输出

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java maven

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Java Maven专题
Java Maven专题

本专题聚焦 Java 主流构建工具 Maven 的学习与应用,系统讲解项目结构、依赖管理、插件使用、生命周期与多模块项目配置。通过企业管理系统、Web 应用与微服务项目实战,帮助学员全面掌握 Maven 在 Java 项目构建与团队协作中的核心技能。

2025.09.15

4380

19

Java Maven/Gradle 构建与依赖管理合集
Java Maven/Gradle 构建与依赖管理合集

系统讲解 Java 项目构建工具的使用与进阶配置,涵盖 Maven 的 POM 文件结构、生命周期(clean/compile/package/install/deploy)与插件机制、依赖范围(compile/provided/test/runtime)与传递依赖管理、多模块聚合与继承、私有 Nexus 仓库发布,以及 Gradle 的 Groovy / Kotlin DSL 语法、Task 自定义与增量构建、依赖版本目录(Versi

2026.05.09

389

25

Java Maven/Gradle 构建与依赖管理合集
Java Maven/Gradle 构建与依赖管理合集

系统讲解 Java 项目构建工具的使用与进阶配置,涵盖 Maven 的 POM 文件结构、生命周期(clean/compile/package/install/deploy)与插件机制、依赖范围(compile/provided/test/runtime)与传递依赖管理、多模块聚合与继承、私有 Nexus 仓库发布,以及 Gradle 的 Groovy / Kotlin DSL 语法、Task 自定义与增量构建、依赖版本目录(Versi

2026.05.09

389

25

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

2026.11.03

0

18

Docker Desktop镜像构建教程
Docker Desktop镜像构建教程

想使用Docker Desktop将本地项目构建成Docker镜像?本专题围绕镜像构建的实际操作展开,介绍Dockerfile编写、构建命令使用、镜像标签设置和构建日志查看等内容,同时整理镜像无法生成、依赖安装失败及构建缓存异常等问题的排查思路。

2026.11.03

0

11

Docker Desktop容器创建指南
Docker Desktop容器创建指南

本专题聚焦Docker Desktop容器创建与运行配置,介绍通过本地镜像或远程镜像创建容器的方法,以及容器启动、终端访问、日志查看和基础管理等操作。针对端口冲突、参数配置不当、容器无法启动等情况,也整理了相应的排查方向。

2026.11.03

0

11

Tailwind CSS 如何制作导航栏和卡片
Tailwind CSS 如何制作导航栏和卡片

用 Tailwind CSS 制作导航栏和卡片,可先搭建语义化结构,再组合 Flex、Grid、间距、圆角与阴影类。这里整理横向导航、移动端菜单、卡片网格及悬停效果的相关文章,帮助你把常见页面组件做得清晰且适配不同屏幕。

2026.11.03

20

17

Tailwind CSS 响应式布局怎么写
Tailwind CSS 响应式布局怎么写

Tailwind CSS 响应式布局通常从移动端样式写起,再用 sm、md、lg 等前缀调整不同屏幕宽度下的网格、间距和导航。本专题整理断点配置、Grid 与 Flex 自适应布局及常见溢出问题,帮助你逐步完成多设备适配。

2026.11.03

0

19

Tailwind CSS 常用类名怎么记
Tailwind CSS 常用类名怎么记

Tailwind CSS 类名很多,先按布局、间距、文字、颜色和状态分组记忆,再通过官方文档检索具体写法。本专题结合类名排序、动态拼接失效、自定义实用类等问题,帮助你建立常用类名的速查方法。

2026.11.03

0

12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习