Maven插件【（构建）资源拷贝】：maven-resources-plugin

accttodo 12/31/2025 后端开发构建工具Maven

参考

# Maven插件【（构建）资源拷贝】：maven-resources-plugin

以下插件配置的作用是什么？配置中的插件是什么插件？通常如何使用该插件？

<plugin>
    <artifactId>maven-source-plugin</artifactId>
    <version>${maven-source-plugin.version}</version>
    <executions>
        <execution>
            <id>attach-sources</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

1
2
3
4
5
6
7
8
9
10
11
12

# Maven Source Plugin 配置解析

这个配置是 Apache Maven Source Plugin 的标准配置，主要用于在 Maven 构建过程中将项目源代码打包成单独的 JAR 文件。以下是对该配置的详细解析：

# 一、插件基本信息

插件名称：Apache Maven Source Plugin
插件作用：将项目源代码打包成单独的 JAR 文件，便于调试、文档生成和代码共享
当前配置版本：通过 ${maven-source-plugin.version} 属性指定版本号（推荐使用最新稳定版如3.3.1）

# 二、配置详解

该配置包含以下关键部分：

执行定义：

<executions>
    <execution>
        <id>attach-sources</id>
        <goals>
            <goal>jar</goal>
        </goals>
    </execution>
</executions>

1
2
3
4
5
6
7
8

定义了一个名为"attach-sources"的执行
指定了jar目标（goal），该目标会将源代码打包成JAR文件

版本管理：
```
<version>${maven-source-plugin.version}</version>
```
1
使用Maven属性管理插件版本，便于统一维护

# 三、典型使用场景

调试依赖：当调试依赖库时，可以通过源代码JAR查看具体实现细节
文档生成：在生成项目文档时包含源代码注释和说明
代码共享：将源代码JAR上传至远程仓库（如Nexus），供其他开发者参考
版本控制：确保发布的构件包含对应的源代码

# 四、使用方法

基本命令：
- mvn package：打包项目时会自动执行源代码打包
- mvn install：将源代码JAR安装到本地仓库
- mvn deploy：将源代码JAR部署到远程仓库
- mvn source:jar：单独执行源代码打包
多模块项目注意事项：
- 该配置必须放在具体模块的pom.xml中，放在父POM中不会生效
- 对于多模块项目，需要在每个需要打包源代码的子模块中单独配置
与其他插件配合：
- 常与maven-javadoc-plugin配合使用，同时生成API文档和源代码
- 与maven-install-plugin和maven-deploy-plugin协同完成构件发布

# 五、生成的文件

执行后会生成以下文件：

target/[artifactId]-[version]-sources.jar：包含项目主代码的JAR文件
如果配置了test-jar目标，还会生成target/[artifactId]-[version]-test-sources.jar测试源代码JAR

# 六、最佳实践建议

版本控制：建议在项目根目录的settings.xml或父POM中统一管理插件版本
CI/CD集成：在持续集成流程中确保源代码JAR与主构件同步发布
命名规范：使用attach-sources作为执行ID保持一致性
文件过滤：可通过额外配置排除特定文件或目录

这个配置是Maven项目中管理源代码分发的标准方式，特别适合需要共享或发布源代码的开源项目和企业级项目。

Maven Source Plugin与Maven Javadoc Plugin如何配合使用？

# Maven Source Plugin与Maven Javadoc Plugin协同使用指南

Maven Source Plugin和Maven Javadoc Plugin是Java项目开发中常用的两个插件，它们分别用于管理源代码和API文档的生成与发布。以下是这两个插件如何协同工作的详细解析。

# 一、基础协同配置

在Maven项目的pom.xml文件中，可以同时配置这两个插件以实现完整的代码和文档管理：

<build>
    <plugins>
        <!-- Maven Source Plugin配置 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <version>3.3.1</version>
            <executions>
                <execution>
                    <id>attach-sources</id>
                    <goals>
                        <goal>jar-no-fork</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        
        <!-- Maven Javadoc Plugin配置 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.3.1</version>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

这种配置方式会在执行mvn package或mvn install时自动生成源代码JAR和Javadoc JAR文件。

# 二、典型工作流程

代码开发阶段
- 开发人员在代码中添加符合规范的Javadoc注释
- 使用mvn compile编译代码时，Javadoc注释会被保留但不会生成文档
构建阶段
- 执行mvn package时：
  - Maven Source Plugin生成[artifactId]-[version]-sources.jar
  - Maven Javadoc Plugin生成[artifactId]-[version]-javadoc.jar
- 生成的文件默认位于target/目录下
发布阶段
- 执行mvn install将构件安装到本地仓库
- 执行mvn deploy将构件部署到远程仓库
- 两个插件生成的JAR文件会与主构件一起发布

# 三、高级配置选项

# 1. 统一编码配置

<!-- Javadoc插件中配置编码 -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <charset>UTF-8</charset>
        <encoding>UTF-8</encoding>
        <docencoding>UTF-8</docencoding>
    </configuration>
</plugin>

1
2
3
4
5
6
7
8
9
10

这样可以避免文档生成过程中的乱码问题。

# 2. 多模块项目聚合配置

对于多模块项目，可以在父POM中使用pluginManagement统一管理插件配置：

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>3.3.1</version>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.3.1</version>
                <configuration>
                    <aggregate>true</aggregate>
                </configuration>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

子模块只需引用插件而无需重复配置版本。

# 3. 依赖项中的使用

其他项目可以依赖这些生成的源代码和文档：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>example-library</artifactId>
    <version>1.0.0</version>
    <classifier>sources</classifier> <!-- 源代码依赖 -->
</dependency>
<dependency>
    <groupId>com.example</groupId>
    <artifactId>example-library</artifactId>
    <version>1.0.0</version>
    <classifier>javadoc</classifier> <!-- 文档依赖 -->
</dependency>

1
2
3
4
5
6
7
8
9
10
11
12

这种配置方式便于开发时查看第三方库的实现和文档。

# 四、IDE集成与开发体验

IntelliJ IDEA自动下载

在settings.xml中配置自动下载源码和文档：

<profiles>
    <profile>
        <id>downloadSources</id>
        <properties>
            <downloadSources>true</downloadSources>
            <downloadJavadocs>true</downloadJavadocs>
        </properties>
    </profile>
</profiles>
<activeProfiles>
    <activeProfile>downloadSources</activeProfile>
</activeProfiles>

1
2
3
4
5
6
7
8
9
10
11
12

这样IDEA会自动下载依赖项的源码和Javadoc

Eclipse支持
- 通过M2Eclipse插件可以实现类似功能
- 右键项目 → Maven → Download Sources/Javadoc

# 五、最佳实践建议

版本一致性
- 保持两个插件的版本同步更新
- 推荐使用最新稳定版(当前为3.3.1)

CI/CD集成

在持续集成流程中加入这两个插件的执行

示例Jenkins配置：

stages {
    stage('Build') {
        steps {
            sh 'mvn clean package source:jar javadoc:javadoc'
        }
    }
}

1
2
3
4
5
6
7

文档质量控制
- 配置Javadoc插件在文档错误时使构建失败：
```
<configuration>
    <failOnError>true</failOnError>
</configuration>
```
  1
  2
  3
- 这可以确保API文档的完整性
发布验证
- 发布前检查是否包含:
  - 主构件(.jar)
  - 源代码(.jar)
  - Javadoc(.jar)
  - POM文件

通过以上配置和实践，Maven Source Plugin和Maven Javadoc Plugin可以完美协同工作，为Java项目提供完整的源代码和文档管理解决方案。这种组合特别适合需要严格文档管理和代码共享的开源项目和企业级应用。

Maven插件【（构建）源码编译】：maven-compiler-plugin Maven插件：license-maven-plugin

知识库

Choose mode