maven-source-plugin插件使用

290 阅读2分钟

如何安装插件?

Maven项目中,如果你想在构建过程中包含源代码Javadoc,可以使用maven-source-pluginmaven-javadoc-plugin

这里主要介绍如何使用maven-source-plugin来添加源代码到最终的构建产物中。

要在POM文件中添加maven-source-plugin,你需要在<build> 标签内添加一个<plugins>标签,然后在其中添加 maven-source-plugin 的配置。以下是一个示例配置:

<project>
  ...
  <build>
    ...
    <plugins>
      <!-- 其他插件配置 -->
      
      <!-- 添加 maven-source-plugin -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-source-plugin</artifactId>
        <version>3.2.1</version> <!-- 请根据实际情况选择版本 -->
        <executions>
          <execution>
            <id>attach-sources</id>
            <goals>
              <goal>jar-no-fork</goal>
            </goals>
          </execution>
        </executions>
      </plugin>

      <!-- 如果需要,也可以在这里添加其他插件 -->
    </plugins>
    ...
  </build>
  ...
</project>

在这个配置中:

1.groupId 和 artifactId 指定了插件的坐标。

2.version 应该设置为你想要使用的maven-source-plugin的版本号。

3.<executions> 标签内的配置指定了插件执行的目标,attach-sources 是一个标识符,jar-no-fork 目标会创建一个源代码的JAR文件,并将其附加到主JAR文件上。

当你运行 mvn installmvn package 命令时,源代码将会被打包到一个名为your-artifact-name-sources.jar的文件中,并且这个文件会被包含在构建的输出目录中。

your-artifact-name: 表示你当前的模块名称

插件的版本号如何适配?

第一个问题,maven-source-plugin有哪些版本,我们需要使用哪种版本。

maven-source-plugin是Maven的一个常用插件,用于在构建过程中生成并打包源代码。这个插件有多个版本,但是具体哪些版本可用,通常需要查询 Maven Central Repository 或插件的官方文档来获取最新和最准确的信息。

方式一:访问 Maven Central Repository 搜索maven-source-plugin,它会列出所有可下载的版本。

方式二:查看maven-source-plugin的官方文档或GitHub仓库,通常这些地方会提供详细的版本历史和变更日志。

为了帮助你快速找到版本信息,我可以指导你如何在Maven Central Repository中查找:

  1. 打开Maven Central Repository

image.png

  1. 在搜索框中输入maven-source-plugin,搜索结果页面中,选择groupId为org.apache.maven.plugins,artifactId为maven-source-plugin的结果

image.png

  1. 在版本列表中,你会看到所有可用的版本号,如果你需要直接在POM文件中指定一个稳定的版本,通常建议使用最新的稳定版,但也要考虑到与项目中其他插件和工具的兼容性。

image.png

maven 打包验证

安装插件之前,进行 maven 打包:

image.png

安装插件之后,进行 maven 打包:

image.png

这样打包之后,其他项目进行引用时,点击下载源码就可以了!