开发一个Maven插件的过程详解
2017-08-21 15:34
531 查看
很多工具软件都希望能够以Maven插件的形式提供,这里给出一个开发Maven插件的详细过程,供参考。
1. 在Eclipse中创建新的Maven Project
2. 可以看到,创建Maven Project的过程,默认就是执行maven-archetype-quickstart的过程
3.在创建Maven Project的过程最后,为Maven插件设置Group Id, Artifact Id, Version和Package
4. 创建Maven Project成功后,得到的项目代码结构
5. 修改项目的pom.xml文件
1) 添加依赖
2) 设置packaging
6. 为插件的一个Goal创建Java类,并实现execute()方法
7. 使用Maven工具构建该插件,即执行mvn clean install
构建成功,将在本地Maven库.m2中得到该Maven插件的类库,如下所示:
至此,Maven插件开发完毕。
8. 在其他Maven Project中使用刚刚开发好的Maven插件
1) 修改其他Maven Project的pom.xml文件
2) 构建Maven Project时执行指定Maven插件的Goal
即执行mvn myfullpackage:myfullpluginname:version:mygoalname
注意:这里省略了版本,即表示使用该插件的最新版本。
执行结果如下:
本文只是一个最简单的Maven插件开发过程,不能为Maven插件设置参数,详情可参考相关文件。
参考链接:
http://maven.apache.org/plugin-developers/index.html http://maven.apache.org/guides/plugin/guide-java-plugin-development.html http://maven.apache.org/plugin-tools/maven-plugin-plugin/ http://maven.apache.org/plugin-tools/
1. 在Eclipse中创建新的Maven Project
2. 可以看到,创建Maven Project的过程,默认就是执行maven-archetype-quickstart的过程
3.在创建Maven Project的过程最后,为Maven插件设置Group Id, Artifact Id, Version和Package
4. 创建Maven Project成功后,得到的项目代码结构
5. 修改项目的pom.xml文件
1) 添加依赖
<dependency> <groupId>org.apache.maven</groupId> <artifactId>maven-plugin-api</artifactId> <version>3.5.0</version> </dependency> <!-- dependencies to Java 5 annotations --> <dependency> <groupId>org.apache.maven.plugin-tools</groupId> <artifactId>maven-plugin-annotations</artifactId> <version>3.5</version> <scope>provided</scope> </dependency>注意,被依赖类库的版本
2) 设置packaging
<packaging>maven-plugin</packaging>注意,将默认的jar修改为maven-plugin。如果不设置,将会在使用Maven插件的时候报错如下:
[INFO] Scanning for projects... [INFO] ------------------------------------------------------------------------ [INFO] BUILD FAILURE [INFO] ------------------------------------------------------------------------ [INFO] Total time: 0.141 s [INFO] Finished at: 2017-08-21T15:18:00+08:00 [INFO] Final Memory: 5M/123M [INFO] ------------------------------------------------------------------------ [ERROR] Failed to parse plugin descriptor for com.ericsson.tao5.raml:myraml-maven-plugin:0.0.1-SNAPSHOT (C:\Users\exihaxi\.m2\repository\com\ericsson\tao5\raml\myraml-maven-plugin\0.0.1-SNAPSHOT\myraml-maven-plugin-0.0.1-SNAPSHOT.jar): No plugin descriptor found at META-INF/maven/plugin.xml -> [Help 1] [ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch. [ERROR] Re-run Maven using the -X switch to enable full debug logging. [ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles: [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginDescriptorParsingException
6. 为插件的一个Goal创建Java类,并实现execute()方法
package com.ericsson.tao5.raml.myraml_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; /** * @author exihaxi * */ @Mojo( name = "sayhi") public class MyFirstPlugin extends AbstractMojo { public void execute() throws MojoExecutionException, MojoFailureException { getLog().info( "Hello, world. I'm Xiangbin." ); } }
7. 使用Maven工具构建该插件,即执行mvn clean install
构建成功,将在本地Maven库.m2中得到该Maven插件的类库,如下所示:
至此,Maven插件开发完毕。
8. 在其他Maven Project中使用刚刚开发好的Maven插件
1) 修改其他Maven Project的pom.xml文件
<build> <plugins> <plugin> <groupId>com.ericsson.tao5.raml</groupId> <artifactId>myraml-maven-plugin</artifactId> <version>0.0.1-SNAPSHOT</version> </plugin> </plugins> </build>将我们刚刚开发的Maven插件加入到build中。
2) 构建Maven Project时执行指定Maven插件的Goal
即执行mvn myfullpackage:myfullpluginname:version:mygoalname
注意:这里省略了版本,即表示使用该插件的最新版本。
执行结果如下:
[INFO] Scanning for projects... [INFO] [INFO] ------------------------------------------------------------------------ [INFO] Building myraml-maven-plugin 0.0.1-SNAPSHOT [INFO] ------------------------------------------------------------------------ [INFO] [INFO] --- myraml-maven-plugin:0.0.1-SNAPSHOT:sayhi (default-cli) @ myraml-maven-plugin --- [INFO] Hello, world. I'm Xiangbin. [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 0.500 s [INFO] Finished at: 2017-08-21T14:58:33+08:00 [INFO] Final Memory: 7M/123M [INFO] ------------------------------------------------------------------------注意,可以看到Maven插件的执行,和输出的结果。
本文只是一个最简单的Maven插件开发过程,不能为Maven插件设置参数,详情可参考相关文件。
参考链接:
http://maven.apache.org/plugin-developers/index.html http://maven.apache.org/guides/plugin/guide-java-plugin-development.html http://maven.apache.org/plugin-tools/maven-plugin-plugin/ http://maven.apache.org/plugin-tools/
相关文章推荐
- 开发过程使用Tomcat Maven插件持续快捷部署Web项目
- 详解eclipse插件findbugs新规则的开发过程
- 详解eclipse插件findbugs新规则的开发过程
- 使用 Eclipse 的 Maven 2 插件开发一个 JEE 项目
- Maven命令详解 模块导入 MyEclipse + Maven开发Web工程的详细配置过程
- 记一个同时支持模糊匹配和静态推导的Atom语法补全插件的开发过程: 序
- 开发过程使用Tomcat Maven插件持续快捷部署Web项目
- 使用 Eclipse 的 Maven 2 插件开发一个 JEE 项目
- 详解eclipse插件findbugs新规则的开发过程
- 开发过程使用Tomcat Maven插件持续快捷部署Web项目
- 详解eclipse插件findbugs新规则的开发过程
- 详解eclipse插件findbugs新规则的开发过程
- 记一个同时支持模糊匹配和静态推导的Atom语法补全插件的开发过程: 序
- 使用Eclipse+maven3插件开发一个Servlet3.0的简单例子
- Maven2插件开发详解
- Maven命令详解 模块导入 MyEclipse + Maven开发Web工程的详细配置过程
- 使用Eclipse+maven3插件开发一个Servlet3.0的简单例子
- 开发过程使用Tomcat Maven插件持续快捷部署Web项目
- Maven2插件开发详解
- 使用Eclipse+maven3插件开发一个Servlet3.0的简单例子