关于maven插件的一点事（二）插件

最新推荐文章于 2022-04-21 08:37:04 发布

既看方向也看行动

最新推荐文章于 2022-04-21 08:37:04 发布

阅读量285

点赞数

分类专栏：笔记 Java 工具文章标签： Maven Maven插件插件配置自定义插件

本文链接：https://blog.csdn.net/dansam/article/details/104729718

版权

Java 同时被 3 个专栏收录

17 篇文章 0 订阅

订阅专栏

笔记

14 篇文章 0 订阅

订阅专栏

工具

12 篇文章 1 订阅

订阅专栏

关联阅读：

配置

除了一些执行参数，完成插件目标和生命周期绑定之外，插件还有一些自己的参数需要配置。可以通过命令行或者在pom中配置进来。

命令行配置

命令行配置是通过Java自带的-D参数来进行配置的，-D 传递参数也比较常见，如 springboot运行时传递端口参数 java -Dserver.servlet.port=8800 -jar springbootdemo.jar 等。
Maven常见通过命令行来传递有：mvn clean package -Dmaven.test.skip=true -Dmaven.javadoc.skip=true

maven.test.skip 是否跳过测试。maven-surefire-plugin 插件使用
maven.javadoc.skip 是否跳过javadoc测试。maven-javadoc-plugin插件使用

pom配置

-D在调整某个需要动态参数配置的比较合适，有一些较少改变的参数则使用pom配置比较合适，有些插件没有提供-D传递配置的参数也只能用pom来配置。如下：对运行任务进行限制

<plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-dependency-plugin</artifactId>
     <executions>
         <execution>
             <id>copy-dependencies</id>
             <phase>prepare-package</phase>
             <goals>
                <goal>copy-dependencies</goal>
             </goals>
             <configuration>
                <outputDirectory>
                    ${project.build.directory}/dependencylibs
                </outputDirectory>
                <stripVersion>true</stripVersion> 
             </configuration>
        </execution>
     </executions>
</plugin>

全局配置，我们还可以配置插件的全局配置，即对某个插件传递参数，不管这个插件执行了什么目标。如，我们要对编译的class版本进行指定（不管是编译主代码还是测试代码阶段）。如下指定maven-compiler-plugin插件：

			<plugin>
				<!-- 默认的groudId可以省略-->
				<artifactId>maven-compiler-plugin</artifactId>
				<!-- 指定插件版本,内置绑定版本是和Maven的版本有关的（meta和超级pom）-->
				<version>3.3</version>
				<!-- 不管哪里，使用到了这个插件，就会运用这个配置-->
				<configuration>
					<source>1.7</source>
					<target>1.7</target>
					<encoding>UTF-8</encoding>
				</configuration>
			</plugin>

插件前缀

插件前缀的目的是简化插件的调用，即执行时可以通过前缀来代替插件坐标，在Maven的meta xml中，定义了一些插件前缀。如下：

<metadata>
	<plugins>
		<plugin>
			<name>Maven Clean Plugin</name>
			<prefix>clean></prefix>
			<!-- 默认的groudId可以省略-->
			<artifactId>maven-clean-plugin</artifactId>
		</plugin>
		....以及compile，package等
	</plugins>
</metadata>

因此， mvn clean 和 mvn clean:clean ，mvn compile 和 mvn compiler:comile等虽然作用类似，但是含义是不一样的，前者是执行生命周期，后者是执行插件的目标。

插件信息帮助

在线插件信息，大部分插件都可以在这里都可以找到，直接点进入就可以找到插件的相关信息，如clean插件 clean插件
使用help插件了解。mvn help:describe -Dplugin=org.apache.maven.plugins.:maven-compiler-plugin -Dgoal=compile -Ddetail , help是 maven-help-pugin的前缀
- 即 mvn help:describe -Dplugin=插件坐标或前缀 [-Dgoal=compile目标] [-Ddetail详细信息]

编写插件

绝大部分需求都可以通过已有的插件解决，所以需要自己写插件的情况是极少的，因此，当你想写插件时，应该先考虑清楚自己的需求，先找已有的插件解决。

编写插件的一般步骤

创建 maven项目，package是 maven-plugin，引入依赖，如下
为插件编写目标，继承AbstractMojo 类，指明目标名和默认生命阶段
提供配置点以及编写代码
错误处理和日志
测试

此处编写一个输出Hello+msg的插件。

项目pom

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>top.shenshaoqin</groupId>
  <artifactId>maven-hello-plugin</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>maven-plugin</packaging>

  <name>maven-hello-plugin Maven Plugin</name>

  <!-- FIXME change it to the project's website -->
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.apache.maven</groupId>
      <artifactId>maven-plugin-api</artifactId>
      <version>2.0</version>
    </dependency>
    <dependency>
      <groupId>org.apache.maven.plugin-tools</groupId>
      <artifactId>maven-plugin-annotations</artifactId>
      <version>3.2</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>
 
</project>

一个HelloMojo

package top.shenshaoqin;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

import java.io.File;

@Mojo(name = "hello",defaultPhase = LifecyclePhase.PROCESS_SOURCES)
public class HelloMojo extends AbstractMojo {
    @Parameter( defaultValue = "${project.build.directory}", property = "outputDir", required = false )
    private File outputDirectory;


    @Parameter
    private String includes[];

    private final String DEFAULT_INCLUDES[]={"World!"};
    public void execute() throws MojoExecutionException, MojoFailureException {
        if(includes==null || includes.length==0){
            includes = DEFAULT_INCLUDES;
        }
        for (String include:includes){
            System.out.println("Hello, " + include);
        }
    }
}

执行mvn install 安装到本地。新建另一个工程，引入该插件。工程pom如下，之后直接执行即可：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>top.shenshaoqin</groupId>
    <artifactId>maven-hello-plugin-test</artifactId>
    <version>1.0-SNAPSHOT</version>
    <build>
        <plugins>
            <plugin>
                <!-- 默认的groudId可以省略-->
                <artifactId>maven-compiler-plugin</artifactId>
                <!-- 指定插件版本,内置绑定版本是和Maven的版本有关的（meta和超级pom）-->
                <version>3.3</version>
                <!-- 不管哪里，使用到了这个插件，就会运用这个配置-->
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>top.shenshaoqin</groupId>
                <artifactId>maven-hello-plugin</artifactId>
                <version>0.0.1-SNAPSHOT</version>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>hello</goal>
                        </goals>
                        <configuration>
                            <includes>
                                <include>世界</include>
                                <include>shenshao</include>
                            </includes>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

直接 mvn compile 即可看到效果。如图：

既看方向也看行动

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
关于maven插件的一点事（二）插件

配置除了一些执行参数，完成插件目标和生命周期绑定之外，插件还有一些自己的参数需要配置。可以通过命令行或者在pom中配置进来。命令行配置命令行配置是通过Java自带的-D参数来进行配置的，-D 传递参数也比较常见，如 springboot运行时传递端口参数 java -Dserver.servlet.port=8800 -jar springbootdemo.jar 等。Maven常见通过命...
复制链接

扫一扫