最近接到了一个开发maven插件的需求，就学习了一下，做一下总结，也分享给大家，让大家少百度一点资料，多学习一点知识。
-
选中maven插件模板
- 为你的maven插件起个名字
这里建议起名规则为 你的插件
功能+maven-plugin
- pom依赖升级
这里可以注意一下，maven插件的打包方式不是我们常见的
jar,pom,war而是maven-plugin,这里看一眼就行了......
删掉原来的依赖，原来的依赖版本太低了，并且整个项目是以java6为基础的，不支持java8的一些新特性，我们需要替换一下配置。
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.5.2</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
<version>3.5.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>8</source>
<target>8</target>
</configuration>
</plugin>
</plugins>
</build>
- 编辑启动类
maven提供了一个抽象类供我们继承，然后我们将插件的功能编写到方法体中就可以了。idea替我们生成的部分代码如下：
注释中的@goal表示插件指令的名称，就像clean,install那些指令一样。
为什么会在注释中写这个指令，而不是注解中？
这是因为maven早于jdk 1.5 出现的，注解是jdk 1.5之后才出现的，所以，maven没有办法只能在注释中写，并通过扫描源码实现类似注解一样的功能。刚刚我们已经将依赖的版本升级成3.5.2了，这个版本是支持使用注解的，所以我们可以删掉原来的注释，用注解取代。
调整后，我们的代码是这样的
@Mojo(name = "hello-world")
public class HelloWorldMojo extends AbstractMojo {
@Override
public void execute() throws MojoExecutionException {
// todo 自定义功能
}
}
我们将我们的插件功能编写到execute方法中就可以了
- 日志打印
maven将日志对象封装在了我们继承的那个抽象类中，我们通过getLog()即可或者这个对象。
但是我们在实际开发中，从工程学的角度讲，不会将所有的逻辑都放在一个方法里面，需要对功能进行细分，每个类负责一些功能，所以我们想在任何类都可以打日志，所以，我这里写了一个全局的日志类，然后通过静态方法获取日志打印对象。
public abstract class Logger {
private static Log log;
public static void setLog(Log log){
Logger.log = log;
}
public static void info(String msg){
log.info(msg);
}
public static void debug(String msg){
log.debug(msg);
}
public static void warn(String msg){
log.warn(msg);
}
public static void error(String msg){
log.error(msg);
}
}
在execute方法的第一行对日志对象进行赋值，这样我们就可以在任何地方通过调用自定义的Logger方法获取日志对象，打印日志了。
public void execute() throws MojoExecutionException {
Logger.setLog(getLog());
}
- 配置信息
3.1 在maven启动类的属性中标注@Parameter注解，我们的属性可以是String，可以是对象，也可以是List。
@Mojo(name = "hello-world")
public class HelloWorldMojo extends AbstractMojo {
@Parameter(readonly = true)
private String helloStr;
@Parameter(required = true)
private List<String> scanPackages;
@Override
public void execute() throws MojoExecutionException {
Logger.setLog(getLog());
Logger.info(helloStr);
}
}
3.2 使用maven的变量
通过在@Paramter中的defaultValue使用${maven变量名称}使用maven变量。
@Mojo(name = "hello-world")
public class GlossaryCheckerMojo extends AbstractMojo {
@Parameter(defaultValue = "${project.basedir}", readonly = true)
private File basedir;
}
对应的maven配置
<plugin>
<groupId>org.ywb</groupId>
<artifactId>hello-world-maven-plugin</artifactId>
<version>1.0.0</version>
<configuration>
<helloStr>hello-plugin</helloStr>
<scanPackages>
<scanPackage>org.ywb.hello</scanPackage>
<scanPackage>org.ywb.hello1</scanPackage>
</scanPackages>
</configuration>
</plugin>
3.3 maven插件发布
-
源码安装
直接通过idea的install指令即可安装到本地
- 通过maven 指令安装
先通过package将插件打包，然后手动执行maven-install指令
mvn install:install-file
-Dfile="xxxxx/hello-world-maven-plugin-1.0.0.jar"
-DgroupId="org.ywb"
-DartifactId="hello-world-maven-plugin"
-Dversion="1.0.0"
-Dpackaging=jar
附录
maven 插件开发常用的工具
- java SPI
java的SPI机制类似于Spring框架，可以对对象进行管理，可以看下面这个博客学习使用
https://www.cnblogs.com/jy107600/p/11464985.html - 源码解析工具，qdox
如果我们开发插件的时候，需要获取类的一些信息，qdox真的非常好用！大家可以看这个链接
https://zhuanlan.zhihu.com/p/115606527
网友评论