如果你想要了解某个事物，你必须要成为其中的一员。想要理解maven插件，我们就尝试来开发一个maven插件
官方文档位置：http://maven.apache.org/guides/introduction/introduction-to-plugins.html
什么是mavne插件
Maven 实际上是一个依赖插件执行的框架，每个任务实际上是由插件完成。换句话说，插件是执行大部分实际操作的地方，插件用来：创建jar文件，创建war文件，编译代码，单元测试代码，创建项目文档等等操作。您可以想到在项目上执行的几乎所有操作均作为Maven插件实现。
插件是Maven的核心功能，它允许在多个项目中重用通用的构建逻辑。他们通过在项目pom文件的上下文中执行“操作”（即创建WAR文件或编译单元测试）来实现操作，插件同时也是可以定义参数等等。
插件的命名规范
- 一般插件是使用 ** <你的插件名称>+ -maven-plugin** 来命名
- 千万不要使用 ** maven-<你的插件名称>-plugin** ，这样是对Apache Maven商标的侵犯😓
开发
1. 创建一个Maven工程
- pom配置：增加打包方式 <packaging>maven-plugin</packaging>
- 需要引入3个依赖
<!--plugin插件api-->
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>2.0</version>
</dependency>
<!--加入此包就可以使用@Mojo注解-->
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.1</version>
</dependency>
<!--用户获取运行插件的Maven工程信息-->
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-project</artifactId>
<version>3.0-alpha-2</version>
</dependency>
2. HelloWord插件（Mojo）编写
- 处理类需要继承 AbstractMojo ，实现 execute() 方法，execute() 就是我们实际执行的操作
- 还需要增加@Mojo注解 ，来标示其为一个Mojo类
- @Paramete 注解用来直接从pom文件中获取值，其本质就是我们插件的参数，也可以使用表达式来获取参数，像下面的${project} 就是调用MavenSession.getCurrentProject()来获取当前工程
- @Paramete的表达式类型 http://maven.apache.org/ref/3.6.3/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html
- MavenProject当前工程的信息，这里就是通过MavenProject获得当前工程的所有文件，然后将java文件和依赖 输出
@Mojo(name = "hello",requiresDependencyResolution = ResolutionScope.COMPILE)
public class HelloMojo extends AbstractMojo {
/**
* The greeting to display.
*/
@Parameter( property = "greeting", defaultValue = "Hello World!" )
private String greeting;
@Parameter( defaultValue = "${project}")
private MavenProject mavenProject;
public void execute() throws MojoExecutionException, MojoFailureException {
Class<? extends HelloMojo> aClass = getClass();
System.out.println(aClass);
getLog().info("<==============河神说: Hello Mojo start==============>"+greeting);
List dependencies = mavenProject.getDependencies();
getLog().info("[dependencies]");
for (Object dependency : dependencies) {
getLog().info(dependency.toString());
}
getLog().info("[basedir]");
File basedir = mavenProject.getBasedir();
List<File> files = searchFiles(basedir, "java");
for (File file : files) {
long l = file.lastModified();
Date date = new Date(l);
DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String format = dateFormat.format(date);
getLog().info(file.getName()+"[lastModified]"+format);
}
getLog().info("<==============河神说: Hello Mojo end==============>"+greeting);
}
public static List<File> searchFiles(File folder, final String keyword) {
List<File> result = new ArrayList<File>();
if (folder.isFile()){
result.add(folder);
}
File[] subFolders = folder.listFiles(new FileFilter() {
public boolean accept(File file) {
if (file.isDirectory()) {
return true;
}
return file.getName().toLowerCase().endsWith(keyword);
}
});
if (subFolders != null) {
for (File file : subFolders) {
if (file.isFile()) {
// 如果是文件则将文件添加到结果列表中
result.add(file);
} else {
// 如果是文件夹，则递归调用本方法，然后把所有的文件加到结果列表中
result.addAll(searchFiles(file, keyword));
}
}
}
return result;
}
}
- 使用：
<build>
<plugins>
<plugin>
<groupId>com.heshen</groupId>
<artifactId>api-check-plugin</artifactId>
<version>1.0-SNAPSHOT</version>
<configuration>
<greeting>设置的参数</greeting>
</configuration>
<executions>
<execution>
<phase>install</phase>
<goals>
<goal>hello</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
- 首先需要在<build>/ <plugins>下面增加一个新的 plugin
- 然后之后就是我们自己定义的groupId/artifactId/version
- 然后< configuration>就是配置我们之前设置的参数
- executions标示我们的插件是在什么时候执行，phase代表声明周期，goal为插件的名称，也就是@Mojo的name,像我们图中配置的，就是在我们install的时候执行的
3. 直接运行
- mvnDebug groupID:artifactID:version:goal
- 或者在settings.xml配置
<pluginGroups>
<pluginGroup> groupID </ pluginGroup>
</ pluginGroups>
就可以直接使用 mvnDebug goal 来执行
桃花坞里桃花庵，桃花庵下桃花仙;
桃花仙人种桃树，又摘桃花卖酒钱。
