讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 中怎么在 Maven 中配置 source 插件打包源码和 javadoc 文档

云浩同学_7244

云浩同学_7244

发布时间:2026-08-16 14:37:06

|

585人浏览过

|

来源于php中文网

原创

Maven中配置source和javadoc插件的核心是通过maven-source-plugin生成-sources.jar、maven-javadoc-plugin生成-javadoc.jar,并绑定到verify阶段自动附加;需设置UTF-8编码、关闭-Xdoclint校验,版本推荐3.3.0和3.6.3,执行mvn clean verify可验证生成效果。

java 中怎么在 maven 中配置 source 插件打包源码和 javadoc 文档

在 Maven 中配置 source 和 javadoc 插件,核心是让 maven-source-plugin 打包源码(生成 -sources.jar),让 maven-javadoc-plugin 生成文档包(生成 -javadoc.jar),并确保它们在构建或部署阶段被自动附加到主构件中。

配置 source 插件打包源码

添加 maven-source-plugin 到 pom.xml 的 <build><plugins> 中,启用 jar-no-fork 目标,并绑定到 verify 或 package 阶段:

  • 推荐使用 jar-no-fork,避免重复 fork JVM,提升稳定性
  • 绑定到 verify 阶段更稳妥,确保在 deploy 前完成源码包生成
  • 插件版本建议用较新稳定版,如 3.3.0(2025 年主流)

示例配置:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-source-plugin</artifactId>
  <version>3.3.0</version>
  <executions>
    <execution>
      <id>attach-sources</id>
      <phase>verify</phase>
      <goals>
        <goal>jar-no-fork</goal>
      </goals>
    </execution>
  </executions>
</plugin>

配置 javadoc 插件生成文档包

maven-javadoc-plugin 要生成可被 IDE 识别的 -javadoc.jar,需注意编码与校验兼容性:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载

立即学习“Java免费学习笔记(深入)”;

  • 必须显式设置 <encoding>UTF-8</encoding>、<charset>UTF-8</charset>、<docencoding>UTF-8</docencoding>
  • 添加 -Xdoclint:none 关闭严格校验(尤其对未标注 @param 或 @return 的方法,避免构建失败)
  • 同样绑定到 verify 阶段,与 source 插件保持同步

示例配置:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>3.6.3</version>
  <configuration>
    <encoding>UTF-8</encoding>
    <charset>UTF-8</charset>
    <docencoding>UTF-8</docencoding>
    <additionalOptions>-Xdoclint:none</additionalOptions>
  </configuration>
  <executions>
    <execution>
      <id>attach-javadocs</id>
      <phase>verify</phase>
      <goals>
        <goal>jar</goal>
      </goals>
    </execution>
  </executions>
</plugin>

验证是否生效

执行命令后检查输出和本地仓库:

  • 运行 mvn clean verify,控制台应出现类似 [INFO] Building jar: .../xxx-1.0.0-sources.jar 和 ...-javadoc.jar
  • 查看 target/ 目录,确认两个 jar 文件存在
  • 若执行 mvn deploy,这两个 jar 会随主 artifact 一同上传到远程仓库(如 Nexus、Maven Central)
  • 其他项目引入该依赖后,在 IDEA 或 Eclipse 中按住 Ctrl 点击类名,即可直接跳转源码或查看 Javadoc

常见问题处理

遇到中文乱码或构建失败时,优先排查:

  • IDEA 用户:在 Settings → Build Tools → Maven → Runner 的 VM Options 中添加 -Dfile.encoding=UTF-8(不是 GBK,除非你明确用 GBK 编码保存源文件)
  • 如果项目含模块化(module-info.java),Javadoc 可能报错,可在 <additionalOptions> 中追加 --no-module-directories
  • 中央仓库要求必须签名,发布前还需配置 maven-gpg-plugin,否则 -sources.jar 和 -javadoc.jar 不会被接受

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

9837

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

6982

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6172

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1064

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

888

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1296

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2569

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

19911

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn