maven插件开发----HelloWorld

maven插件开发

最近在工作中遇到一个问题是在打包的过程中要对一些文件做替换签名，原来都是找到编译过后的文件，进行签名，
然后导出jar包，这样每次都是重复的劳动，后来想能不能在每次打包发布的时候自动来做这件事，后来找了maven插件发现
没有符合需求的插件，只能动手去写插件，下面介绍的是简单的一个插件的编写

创建一个maven工程(也可以用命令直接生成)

• 工程创建（我选择的是最笨的办法，直接创建一个maven工程）
• packing修改
• 依赖的引入
• 插件的编写
• 测试
• 与maven的声明周期绑定

packing的修改

在pom中添加packing

<packaging>maven-plugin</packaging>

将打包方式修改成maven的插件方式

依赖的引入

在pom添加如下的依赖

        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-plugin-api</artifactId>
            <version>3.5.4</version>
        </dependency>

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

引入这两个依赖就够用了，也可能引多了，不对的对方请指出

插件的编写

新建插件类 HelloMojo.java 主要是输出Helloworld

package cn.com.immortals.maven.plugin;

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

/**
 * Create by panzhuowen on 2018/8/25 22:28
 */
@Mojo(name = "hellworld")
public class HelloMojo extends AbstractMojo {
    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("Hello World From Maven Plugin");
    }
}

在上面主要重写了 execute 方法，该方法只要是你在maven过程中需要做的事情，在编写完成之后将插件install到本地，然后创建测试工程进行测试。

测试

创建maven工程，在pom中引入刚才编写的插件

    <build>
        <plugins>
            <plugin>
                <groupId>cn.com.immorrtals.maven.plugin</groupId>
                <artifactId>demo-maven-plugin</artifactId>
                <version>1.0.0</version>
            </plugin>
        </plugins>
    </build>

然后执行 demo:helloworld 会看到如下的输出

与maven的生命周期的绑定

在配置插件的时候添加如下配置，可以绑定到maven的任意周期上

            <plugin>
                <groupId>cn.com.immorrtals.maven.plugin</groupId>
                <artifactId>demo-maven-plugin</artifactId>
                <version>1.0.0</version>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>hellworld</goal>
                        </goals>
                    </execution>
                </executions>

            </plugin>

通过 phase 来指定maven的周期， goal 指定执行的 mojo 到这里与生命周期的绑定就结束了

自定义参数的添加

使用注解 @Parameter 来标记属性，该属性就是外部可以配置的属性名称，修改后如下

package cn.com.immortals.maven.plugin;

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

/**
 * Create by panzhuowen on 2018/8/25 22:28
 */
@Mojo(name = "hellworld")
public class HelloMojo extends AbstractMojo {

    @Parameter
    private String username;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("Hello World From Maven Plugin, Plugin Say : Hello " + username);
    }
}

在插件中配置如下

    <build>
        <plugins>
            <plugin>
                <groupId>cn.com.immorrtals.maven.plugin</groupId>
                <artifactId>demo-maven-plugin</artifactId>
                <version>1.0.0</version>
                <configuration>
                    <username>Peter Pan</username>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>hellworld</goal>
                        </goals>
                    </execution>
                </executions>

            </plugin>
        </plugins>
    </build>

执行效果如下：

最后，相关工程放在maven插件的demo，这个是需要积分的，防伸手党的，见谅