Maven插件介绍二

最新推荐文章于 2024-04-14 16:01:14 发布
最新推荐文章于 2024-04-14 16:01:14 发布
阅读量226 收藏
点赞数
文章标签： maven java 插件
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/dreamsofa/article/details/134318670
版权

Maven插件介绍二

Maven常用插件

Maven – Available Plugins 了解更多maven插件。。

maven-compiler-plugin

编译插件，主要参数为：

Source: 源文件JDK版本

Target：目标类文件JDK版本

Encoding: 编译字符， 默认是${project.build.sourceEncoding}

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-compiler-plugin</artifactId>

    <configuration>

        <source>1.8</source>

        <target>1.8</target>

        <encoding>${project.build.sourceEncoding}</encoding>

        <compilerArgs>

            <compilerArg>-parameters</compilerArg>

        </compilerArgs>

    </configuration>

</plugin>

maven-assembly-plugin

工具插件， 用于将项目打包为一个可对外分发的文件， 如zip等压缩文件。 通常用于持续集成和持续部署中在项目package成jar后再和其他运行文件， 如执行脚本等一起打包分发到服务器中进行自动化部署。

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-assembly-plugin</artifactId>

    <configuration>

        <appendAssemblyId>false</appendAssemblyId>

        <descriptors>

            <descriptor>assembly.xml</descriptor>

        </descriptors>

    </configuration>

    <executions>

        <execution>

            <id>make-assembly</id>

            <phase>package</phase>

            <goals>

                <goal>single</goal>

            </goals>

        </execution>

    </executions>

</plugin>

<assembly

        xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"

        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

        xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">

    <id>package</id>

    <formats>

        <format>zip</format>

    </formats>

    <includeBaseDirectory>true</includeBaseDirectory>

    <fileSets>

        <fileSet>

            <directory>${project.build.directory}/</directory>

            <outputDirectory></outputDirectory>

            <includes>

                <include>app.jar</include>

            </includes>

        </fileSet>

        <fileSet>

            <directory>bin</directory>

            <outputDirectory>/bin</outputDirectory>

            <fileMode>777</fileMode>

        </fileSet>

    <fileSet>

            <directory>tmp</directory>

            <outputDirectory>/tmp</outputDirectory>

            <fileMode>777</fileMode>

        </fileSet>

    </fileSets>

</assembly>

maven-resources-plugin

负责将项目的资源文件拷贝到目标目录， 为后续打包阶段做好准备。

nonFilteredFileExtension： 指定额外不被过滤的文件后缀

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-resources-plugin</artifactId>

    <configuration>

        <nonFilteredFileExtensions>

            <nonFilteredFileExtension>xlsx</nonFilteredFileExtension>

            <nonFilteredFileExtension>xls</nonFilteredFileExtension>

            <nonFilteredFileExtension>ttf</nonFilteredFileExtension>

            <nonFilteredFileExtension>ttc</nonFilteredFileExtension>

        </nonFilteredFileExtensions>

    </configuration>

</plugin>

maven-javadoc-plugin

javadoc插件

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-javadoc-plugin</artifactId>

    <configuration>

        <skip>${maven.javadoc.skip}</skip>

    </configuration>

    <executions>

        <execution>

            <id>attach-javadocs</id>

            <phase>package</phase>

            <goals>

                <goal>jar</goal>

            </goals>

        </execution>

    </executions>

</plugin>

maven-surefire-plugin

用于在test阶段执行应用的单元测试

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-surefire-plugin</artifactId>

    <configuration>

        <includes>

            <include>**/*Test.java</include>

            <include>**/*Spec.java</include>

        </includes>

    </configuration>

</plugin>

spring-boot-maven-plugin

Springboot 提供的导报插件，插件的核心goal是repackage, 生成可执行的jar包或war包。项目引入该插件后， mvn package将执行改插件的repackage目标。

<plugin>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-maven-plugin</artifactId>

    <version>2.1.2.RELEASE</version>

    <configuration>

        <skip>${maven.springboot.skip}</skip>

    </configuration>

    <executions>

        <execution>

            <goals>

                <goal>repackage</goal>

            </goals>

        </execution>

    </executions>

</plugin>

maven-dependency-plugin

dependency插件提供操作项目依赖工件的能力， 拷贝或解压本地或远程仓库的工件到指定目录。

<project>

  [...]

  <build>

    <plugins>

      <plugin>

        <groupId>org.apache.maven.plugins</groupId>

        <artifactId>maven-dependency-plugin</artifactId>

        <version>3.5.0</version>

        <configuration>

          <artifactItems>

            <artifactItem>

              <groupId>[ groupId ]</groupId>

              <artifactId>[ artifactId ]</artifactId>

              <version>[ version ]</version>

              <type>[ packaging ]</type>

              <classifier> [classifier - optional] </classifier>

              <overWrite>[ true or false ]</overWrite>

              <outputDirectory>[ output directory ]</outputDirectory>

              <destFileName>[ filename ]</destFileName>

            </artifactItem>

          </artifactItems>

          <!-- other configurations here -->

        </configuration>

      </plugin>

    </plugins>

  </build>

  [...]

</project>

maven-enforcer-plugin

enforce 产检用于对环境进行检查。如maven版本， JDK版本等。保证项目保持统一规范。

<project>

  [...]

  <build>

    <plugins>

      <plugin>

        <groupId>org.apache.maven.plugins</groupId>

        <artifactId>maven-enforcer-plugin</artifactId>

        <version>3.3.0</version>

        <executions>

          <execution>

            <id>enforce-versions</id>

            <goals>

              <goal>enforce</goal>

            </goals>

            <configuration>

              <rules>

                <bannedPlugins>

                  <!-- will only display a warning but does not fail the build. -->

                  <level>WARN</level>

                  <excludes>

                    <exclude>org.apache.maven.plugins:maven-verifier-plugin</exclude>

                  </excludes>

                  <message>Please consider using the maven-invoker-plugin (http://maven.apache.org/plugins/maven-invoker-plugin/)!</message>

                </bannedPlugins>

                <requireMavenVersion>

                  <version>2.0.6</version>

                </requireMavenVersion>

                <requireJavaVersion>

                  <version>1.5</version>

                </requireJavaVersion>

                <requireOS>

                  <family>unix</family>

                </requireOS>

              </rules>

            </configuration>

          </execution>

        </executions>

      </plugin>

    </plugins>

  </build>

  [...]

</project>

插件开发

插件开发从IDEA创建项目或Module时选择Maven工程， archetype选择mave-archetype-mojo，可以帮助快速建议一个插件工程雏形。

Maven插件介绍二

Maven常用插件

Maven – Available Plugins 了解更多maven插件。。

maven-compiler-plugin

编译插件，主要参数为：

Source: 源文件JDK版本

Target：目标类文件JDK版本

Encoding: 编译字符， 默认是${project.build.sourceEncoding}

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-compiler-plugin</artifactId>

    <configuration>

        <source>1.8</source>

        <target>1.8</target>

        <encoding>${project.build.sourceEncoding}</encoding>

        <compilerArgs>

            <compilerArg>-parameters</compilerArg>

        </compilerArgs>

    </configuration>

</plugin>

maven-assembly-plugin

工具插件， 用于将项目打包为一个可对外分发的文件， 如zip等压缩文件。 通常用于持续集成和持续部署中在项目package成jar后再和其他运行文件， 如执行脚本等一起打包分发到服务器中进行自动化部署。

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-assembly-plugin</artifactId>

    <configuration>

        <appendAssemblyId>false</appendAssemblyId>

        <descriptors>

            <descriptor>assembly.xml</descriptor>

        </descriptors>

    </configuration>

    <executions>

        <execution>

            <id>make-assembly</id>

            <phase>package</phase>

            <goals>

                <goal>single</goal>

            </goals>

        </execution>

    </executions>

</plugin>

<assembly

        xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"

        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

        xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">

    <id>package</id>

    <formats>

        <format>zip</format>

    </formats>

    <includeBaseDirectory>true</includeBaseDirectory>

    <fileSets>

        <fileSet>

            <directory>${project.build.directory}/</directory>

            <outputDirectory></outputDirectory>

            <includes>

                <include>app.jar</include>

            </includes>

        </fileSet>

        <fileSet>

            <directory>bin</directory>

            <outputDirectory>/bin</outputDirectory>

            <fileMode>777</fileMode>

        </fileSet>

    <fileSet>

            <directory>tmp</directory>

            <outputDirectory>/tmp</outputDirectory>

            <fileMode>777</fileMode>

        </fileSet>

    </fileSets>

</assembly>

maven-resources-plugin

负责将项目的资源文件拷贝到目标目录， 为后续打包阶段做好准备。

nonFilteredFileExtension： 指定额外不被过滤的文件后缀

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-resources-plugin</artifactId>

    <configuration>

        <nonFilteredFileExtensions>

            <nonFilteredFileExtension>xlsx</nonFilteredFileExtension>

            <nonFilteredFileExtension>xls</nonFilteredFileExtension>

            <nonFilteredFileExtension>ttf</nonFilteredFileExtension>

            <nonFilteredFileExtension>ttc</nonFilteredFileExtension>

        </nonFilteredFileExtensions>

    </configuration>

</plugin>

maven-javadoc-plugin

javadoc插件

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-javadoc-plugin</artifactId>

    <configuration>

        <skip>${maven.javadoc.skip}</skip>

    </configuration>

    <executions>

        <execution>

            <id>attach-javadocs</id>

            <phase>package</phase>

            <goals>

                <goal>jar</goal>

            </goals>

        </execution>

    </executions>

</plugin>

maven-surefire-plugin

用于在test阶段执行应用的单元测试

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-surefire-plugin</artifactId>

    <configuration>

        <includes>

            <include>**/*Test.java</include>

            <include>**/*Spec.java</include>

        </includes>

    </configuration>

</plugin>

spring-boot-maven-plugin

Springboot 提供的导报插件，插件的核心goal是repackage, 生成可执行的jar包或war包。项目引入该插件后， mvn package将执行改插件的repackage目标。

<plugin>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-maven-plugin</artifactId>

    <version>2.1.2.RELEASE</version>

    <configuration>

        <skip>${maven.springboot.skip}</skip>

    </configuration>

    <executions>

        <execution>

            <goals>

                <goal>repackage</goal>

            </goals>

        </execution>

    </executions>

</plugin>

maven-dependency-plugin

dependency插件提供操作项目依赖工件的能力， 拷贝或解压本地或远程仓库的工件到指定目录。

<project>

  [...]

  <build>

    <plugins>

      <plugin>

        <groupId>org.apache.maven.plugins</groupId>

        <artifactId>maven-dependency-plugin</artifactId>

        <version>3.5.0</version>

        <configuration>

          <artifactItems>

            <artifactItem>

              <groupId>[ groupId ]</groupId>

              <artifactId>[ artifactId ]</artifactId>

              <version>[ version ]</version>

              <type>[ packaging ]</type>

              <classifier> [classifier - optional] </classifier>

              <overWrite>[ true or false ]</overWrite>

              <outputDirectory>[ output directory ]</outputDirectory>

              <destFileName>[ filename ]</destFileName>

            </artifactItem>

          </artifactItems>

          <!-- other configurations here -->

        </configuration>

      </plugin>

    </plugins>

  </build>

  [...]

</project>

maven-enforcer-plugin

enforce 产检用于对环境进行检查。如maven版本， JDK版本等。保证项目保持统一规范。

<project>

  [...]

  <build>

    <plugins>

      <plugin>

        <groupId>org.apache.maven.plugins</groupId>

        <artifactId>maven-enforcer-plugin</artifactId>

        <version>3.3.0</version>

        <executions>

          <execution>

            <id>enforce-versions</id>

            <goals>

              <goal>enforce</goal>

            </goals>

            <configuration>

              <rules>

                <bannedPlugins>

                  <!-- will only display a warning but does not fail the build. -->

                  <level>WARN</level>

                  <excludes>

                    <exclude>org.apache.maven.plugins:maven-verifier-plugin</exclude>

                  </excludes>

                  <message>Please consider using the maven-invoker-plugin (http://maven.apache.org/plugins/maven-invoker-plugin/)!</message>

                </bannedPlugins>

                <requireMavenVersion>

                  <version>2.0.6</version>

                </requireMavenVersion>

                <requireJavaVersion>

                  <version>1.5</version>

                </requireJavaVersion>

                <requireOS>

                  <family>unix</family>

                </requireOS>

              </rules>

            </configuration>

          </execution>

        </executions>

      </plugin>

    </plugins>

  </build>

  [...]

</project>

插件开发

插件开发从IDEA创建项目或Module时选择Maven工程， archetype选择mave-archetype-mojo，可以帮助快速建议一个插件工程雏形。

POM文件

默认生成项目的POM文件版本较低， 需要做以下修改：

  1. 升级maven-plugin-api包版本到3.8.3。自动生成POM的版本是低版本的2.0；
  2. 添加maven-plugin-annotations依赖，这个包内包含了Maven相关的注解，可以取代Tag；
  3. 添加maven-plugin-plugin插件依赖，这个包可以使插件支持JDK1.8以上的版本；

核心入口类

@Mojo(name = "sayHi")

public class MyMojo

    extends AbstractMojo

{

    @Parameter(name = "name", defaultValue = "test")

    private String name;

    public void execute() {

        getLog().info("This is sayHi to " + name);

    }

}

@Mojo定义一个插件目标，name对应目标名字， 通过mvn 插件名:目标名，可以执行目标。

@Parameter配置<Parameter>标签内容

AbstractMojo： 继承AbstractMojo，实现execute方法就完成了插件的开发。

编译、打包和部署

Maven mojo插件提供生命周期过程中相应阶段的试下， 同普通maven项目一样进行编译、打包和部署。

使用

       独立开发的插件使用同官方一样，应用项目POM文件中引入插件， 根据需要绑定生命周期中的特定阶段或独立运行。

mybatis-generator-maven-plugin

mybatis generator是开发中常用的maven插件，项目源码地址：

https://github.com/mybatis/generator/tree/master/core/mybatis-generator-maven-plugin

@Mojo(name = "generate", defaultPhase = LifecyclePhase.GENERATE_SOURCES,

        requiresDependencyResolution = ResolutionScope.TEST)

public class MyBatisGeneratorMojo extends AbstractMojo {

增强工具 mybatis plus 也提供相应的代码生成插件。

<dependency>

    <groupId>com.baomidou</groupId>

    <artifactId>mybatis-plus-generator</artifactId>

    <version>${mybatis-plus-generator.version}</version>

</dependency>

在此衍生出各类定制的代码规范生成工具， 项目中除了Controller-Service-Dao的代码规范外还有很多类似的场景可以参考这两个工具实现合适的代码生成工具，如通用的对外接口代码规范。

dreamsofa
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Maven插件详解
Rainnnbow
11-02 2276
（声明：本文是学习了大牛徐晓斌的Maven3 in Action之后的总结，仅用于学习交流。）插件与插件目标Maven定义了三套相互独立的生命周期，每套生命周期都有多个生命周期阶段，而这些阶段都是抽象的，不做任何工作。真正完成工作的是绑定在生命周期阶段的插件目标。插件以独立的构件形式存在，一个插件可能有一个或多个插件目标。生命周期的某个阶段可以绑定一个或多个插件目标；一个插件目标也可以绑定到一个或多
Maven插件总结
qq_24395625的博客
05-29 686
核心插件（Core Plugins） 1 compiler <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.1</version> <configuration> <source>1.8</sourc
Maven插件-maven-javadoc-plugin
笃行淡言
11-25 5888
简介 配置 <!--生成doc jar包--> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <executions> ...
JDK8下maven使用maven-javadoc-plugin问题
热门推荐
zcl111的博客
09-25 2万+
1.背景：平时在jdk7环境使用时，一些注解不是很严格，在升级到8时，使用Maven-javadoc-plugin插件打包报错，Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.10.4:jar (attach-javadocs) on project p-jiazhuang-api: MavenReport
maven-compiler-plugin插件中的compilerArgs标签
最新发布
m0_57133702的博客
04-14 463
【代码】maven-compiler-plugin插件中的compilerArgs标签。
maven常用插件
DCHAO的博客
08-22 825
maven常用插件
javadoc注解及maven-javadoc-plugin插件
OceanSky的专栏
07-27 1817
将failOnError参数设置为false，即在生成文档时出现错误时不会停止构建过程。@since: 标识此更改或功能子指定的版本、时间开始存在。@see：用于指定参考的内容，一般会带有链接或文本条目。@throws：抛出的异常，和exception同义。@deprecated：不推荐使用的方法。@version：版本-类、接口级别。@author：作者-类、接口级别。@param：方法、构造函数的参数。@exception：抛出的异常。@return：方法的返回类型。
maven:多源文件夹生成javadoc
10km的专栏
12-02 746
当项目有多个源文件夹时,在没有特别指定的情况下，执行javadoc的生成javadoc文件只包含默认源文件夹(src/main/java)下的代码，所以当项目有多个源文件夹时，需要用sourcepath参数来指定要生成javadoc的源文件夹(用';'分隔),示例如下：
maven插件压缩包
01-03
在给定的“maven插件压缩包”中，虽然没有具体的插件代码，但我们可以根据通常的Maven插件应用场景进行讨论。 ** Maven插件系统** Maven插件是Maven生态系统的核心组成部分，它们定义了一系列可执行的目标（Goals...
eclipse离线安装maven插件（m2e）,maven插件离线安装包
05-13
现在eclipse的社区版都不内置maven插件了，站点在线安装实在是太痛苦了（我装了6个小时），于是急于寻找一种离线安装的办法，可是在网上又找不到对应的m2e包（我用的eclipse4.7），于是我决定将站点下的文件（很多）...
Apache Maven插件
04-03
二、Maven插件工作原理 Maven插件是Maven生命周期的一部分，生命周期包括多个阶段（如compile、test、install、deploy等）。每个阶段由一组目标（Goal）组成，插件就是实现这些目标的具体组件。当用户执行一个Maven...
maven-javadoc-plugin：Apache Maven Javadoc插件
02-04
贡献给 您已发现错误或对超酷的新功能有任何想法？ 贡献代码是将某些东西还给开源社区的好方法。 在深入研究代码之前，我们需要一些准则供贡献者遵循，以便我们有机会掌握最新知识。 入门 确保您拥有。 确保您具有。 如果您打算实施一项新功能，则有必要先在上讨论您的更改。 这样，您可以确保您不会浪费时间在Apache Maven范围之外的东西上。 假设您的问题不存在，请提交该问题的票证。 清楚地描述问题，包括在出现错误时重现的步骤。 确保填写您知道存在问题的最早版本。 在GitHub上分叉存储库。 进行和提交更改 我们通过GitHub接受拉取请求。 是贡献者交流的主要渠道。 有一些准则可使
Maven-javadoc-plugin
03-30
Maven-javadoc-plugin
eclipse-maven插件
01-15
本篇文章将详细介绍如何在Eclipse中离线安装Maven插件，并配置自定义的本地仓库路径。 首先，我们需要了解Eclipse Maven插件的重要性。M2Eclipse（Maven Integration for Eclipse）是Eclipse中的一个插件，它允许...
自定义maven插件的实现
06-13
然而，有时候Maven的内置插件无法满足特定的需求，这时就需要自定义Maven插件来扩展其功能。本篇文章将深入探讨如何实现自定义的Maven插件。 首先，了解Maven插件的基本结构至关重要。一个Maven插件通常由一组Mojo...
使用javadoc生成maven项目的文档
m0_63251896的博客
01-25 736
使用javadoc生成maven项目的文档
多模块Maven项目怎样使用javadoc插件生成文档
aofan9566的博客
01-28 164
需求 近期要对一个项目结构例如以下的Maven项目生成JavaDoc文档。 Project |-- pom.xml |-- Module1 | `-- pom....
Maven javaDoc plugin插件使用说明&maven编译乱码解决方案
程序男的专栏
11-24 7360
昨天在工作中遇到一个编译方面的错误，跟javadoc有关，跟同事讨论后才知道有这个好东西。 首先如果在pom中加入了javadoc的maven插件，那么在子模块中使用clean compile install就会报错一大堆，关于代码注释的错误，而且控制台还可能是乱码，遇到这个问题不用慌，如果仅仅需要编译maven项目的其中一个子模块只要在maven命令后面加入一个命令即可，如：clean
Maven项目自动更新/修复Javadoc
the Blog of 等不到天亮丶等时光
08-30 775
有时候修改了函数签名（比如参数）之后经常忘记同步修改javadoc，导致在用maven生成javadoc（调用javadoc plugin）的时候，会报各种错误，如：`@param name not found`。一个一个手动修改的话不知道要何年何月，因此本文探索一下如何自动更新javadoc。...
idea maven 插件
08-19
Maven是一个用于构建和管理Java项目的工具。Maven插件是一种扩展，它可以在Maven构建过程中添加额外的功能或任务。下面是一些有关Maven插件的创意： 1. 自定义插件：您可以创建自己的Maven插件来执行特定的任务，例如自动化代码生成、静态代码分析、测试覆盖率等。 2. 打包插件：您可以开发一个Maven插件，用于创建自定义的项目打包格式，例如将项目打包成一个可执行的JAR文件、WAR文件或者Docker镜像等。 3. 发布插件：您可以开发一个Maven插件，用于将项目发布到远程仓库或者私有仓库，以便其他开发人员可以方便地使用您的项目。 4. 版本管理插件：您可以开发一个Maven插件，用于自动化处理项目的版本管理，包括自动更新依赖版本、生成版本号、发布新版本等。 5. 资源管理插件：您可以开发一个Maven插件，用于管理项目中的资源文件，例如复制、压缩、合并、过滤等操作。 这些只是一些关于Maven插件的创意，您可以根据自己的需求和想法来开发适合您项目的插件。记得在开发插件时参考Maven插件开发文档和示例，以获得更好的指导和帮助。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值