Maven 中怎么配置源码和文档打包插件生成 Source Jar

千磊姑娘_6015

千磊姑娘_6015

2026-08-11

522人浏览

原创

要在maven项目中生成-sources.jar,核心是正确配置maven-source-plugin插件:在pom.xml的中声明该插件,设置version为3.3.1+、true、绑定phase为verify,并执行mvn clean install或mvn source:jar命令。

maven 中怎么配置源码和文档打包插件生成 source jar

要在 Maven 项目中生成 -sources.jar,核心是正确配置 maven-source-plugin,让它在构建过程中自动打包源码并附加到主构件上。不配插件或配错阶段,mvn install 就不会产出源码包。

1. 在 pom.xml 中声明 source 插件

把以下配置加到项目的 <build><plugins></plugins></build> 节点内(注意不是父 POM 或聚合模块,必须是具体要发布源码的子模块):

  • 使用 3.3.1 或更高稳定版(兼容 JDK 17+ 和较新 Maven 版本)
  • <attach>true</attach> 必须显式设为 true,否则只生成 jar 不附加
  • <phase>verify</phase> 比 package 更稳妥——它确保源码包在部署前已就位,且不影响跳过测试等常见流程

示例配置:

<plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-source-plugin</artifactid><version>3.3.1</version><configuration><attach>true</attach></configuration><executions><execution><id>attach-sources</id><phase>verify</phase><goals><goal>jar-no-fork</goal></goals></execution></executions></plugin>

2. 执行构建命令触发生成

仅改配置不运行命令,-sources.jar 不会出现。常用方式:

java-enterprise
java-enterprise

Java企业开发专家,专注于Spring Boot、微服务架构和JVM优化。适用于:Java语言掌握、

下载
  • mvn clean install:源码包会安装到本地仓库(~/.m2/repository/xxx/xxx-version/xxx-version-sources.jar)
  • mvn clean deploy:若配置了远程仓库,源码包会一并上传,供团队共享
  • 单独生成(不编译、不安装):mvn source:jar,结果在 target/ 下,适合快速验证

执行后,检查 target/ 目录是否有 xxx-1.0.0-sources.jar;再检查本地仓库对应路径是否存在同名文件——这是最直接的判断依据。

3. 配合 IDE 实现源码关联(以 IntelliJ IDEA 为例)

IDE 不会自动下载 sources,需手动触发:

  • 右键项目 → Maven → Download Sources and Documentation
  • 若菜单灰掉,说明项目未被识别为 Maven 项目,检查 pom.xml 是否有语法错误或缺失 <packaging>jar</packaging>
  • 成功后,在 Project 视图的 External Libraries 中展开依赖 jar,应能看到带 src 图标的节点;按住 Ctrl 点击类名即可跳转真实源码,而非反编译内容

4. 可选:同时生成 javadoc jar

如果还需文档包,可并行配置 maven-javadoc-plugin:

  • 同样设 <attach>true</attach>,绑定到 verify 阶段
  • 目标用 javadoc-no-fork(避免 fork 进程,提升稳定性)
  • 生成后 IDE 同样可通过 “Download Sources and Documentation” 一并拉取

源码包不是“额外功能”,而是 Java 生态协作的基础支撑。配对正确、构建到位、IDE 主动拉取,三步缺一不可。

相关文章

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

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

下载

相关标签:

java maven

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

相关专题

更多
Java Maven专题
Java Maven专题

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

2025.09.15

3480

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

349

25

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

2026.10.10

20

15

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

2026.10.10

20

15

Kratos框架Protobuf接口定义与代码生成合集
Kratos框架Protobuf接口定义与代码生成合集

本专题讲解Kratos框架接口定义体系,涵盖proto编写规范、proto add/client/server生成命令、http注解路由、validate校验、OpenAPI文档生成、跨服务proto复用与兼容性设计。

2026.10.10

0

15

C++虚函数怎么定义和调用
C++虚函数怎么定义和调用

C++虚函数是实现运行时多态的重要机制。本专题从virtual关键字的基本用法入手,介绍基类与派生类之间的函数重写、基类指针调用派生类方法,以及动态绑定的执行过程,帮助初学者掌握虚函数的核心语法。

2026.10.10

20

26

C++类与对象的封装方法教程
C++类与对象的封装方法教程

C++封装是面向对象编程的核心特性之一,通过类将数据与操作数据的函数组织在一起,并利用访问权限控制外部访问。本专题介绍类的定义、成员变量、成员函数以及public、private和protected的使用方法,帮助初学者掌握封装的基本原理。

2026.10.10

0

32

C++构造函数定义与调用方法
C++构造函数定义与调用方法

C++构造函数用于初始化类对象,是面向对象编程的重要基础。本专题从构造函数的定义、声明和调用入手,介绍默认构造函数、带参数构造函数、拷贝构造函数及成员初始化列表,帮助初学者掌握对象创建与初始化的基本方法。

2026.10.10

20

16

Kratos框架零基础入门教程
Kratos框架零基础入门教程

本专题整理Kratos框架入门内容,涵盖Go环境准备、kratos CLI安装升级、new命令创建项目、目录结构分层说明、服务启动与双协议端口、依赖下载报错排查,帮助开发者快速跑通第一个Kratos框架微服务应用。

2026.10.10

20

15

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习