大家好，我是冰河~~
今天，冰河给大家分享一篇大部分人都不会的技能，那就是我们自己动手写一款属于自己的Maven插件。好了，直接进入今天的主题吧。
Maven插件的相关概念
插件坐标定位
插件与普通jar包一样包含坐标定位属性即：groupId、artifactId、version，当使用该插件时会从本地仓库中搜索，如果没有则从远程仓库下载，例如下面的配置所示。
- -- 唯一定位到dependency 插件 -->
org.apache.maven.plugins maven-dependency-plugin 2.10
execution配置
execution 配置包含一组指示插件如何执行的属性：
- id ：执行器命名
- phase：标识执行的阶段
- goals：标识执行的目标或功能
- configuration：标识执行目标所需的配置文件
插件的配置和使用示例
将插件依赖拷贝到指定目录。
-
org.apache.maven.plugins -
maven-dependency-plugin -
3.1.1 -
-
-
copy-dependencies -
package -
-
copy-dependencies -
-
-
${project.build.directory}/alternateLocation -
false -
true -
true -
-
-
-
常用插件的使用
通过命令执行插件语法
除了通过配置的方式使用插件以外，Maven也提供了通过命令直接调用插件目标其命令格式如下所示。
- mvn groupId:artifactId:version:goal -D{参数名}
通过命令执行插件示例
(2)展示pom的依赖关系树
- mvn org.apache.maven.plugins:maven-dependency-plugin:2.10:tree
(3)直接简化版的命令，但前提必须是maven 官方插件
- mvn dependency:tree
其它常用插件
(1)查看pom 文件的最终配置
- mvn help:effective-pom
(2)原型项目生成
- archetype:generate
(3)快速创建一个Web程序
- mvn archetype:generate -DgroupId=io.mykit.web -DartifactId=mykit-maven-web -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false
(4)快速创建一个Java项目
- mvn archetype:generate -DgroupId=io.mykit.java -DartifactId=mykit-maven-java -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
自定义Maven插件
这里，我们先来说说自定义Maven插件的步骤，这里，我将自定义Maven插件的步骤总结如下。
(1)创建maven 插件项目
(2)设定packaging 为maven-plugin
(3)添加插件依赖
(4)编写插件实现逻辑
(5)打包构建插件
接下来，我们就来实现自定义Maven插件。
配置插件项目的pom.xml
这里，我直接跳过了Maven项目的创建，相信小伙伴们都会创建Maven项目，这里，我就不再赘述了，直接给出pom.xml文件的配置，如下所示。
- "1.0" encoding="UTF-8"?>
"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">
-
4.0.0 -
io.mykit.plugin -
1.0.0-SNAPSHOT -
mykit-maven-plugin -
maven-plugin -
-
-
org.apache.maven -
maven-plugin-api -
3.5.0 -
-
-
org.apache.maven.plugin-tools -
maven-plugin-annotations -
3.5 -
-
-
-
-
-
org.apache.maven.plugins -
maven-compiler-plugin -
3.6.1 -
-
1.8 -
1.8 -
-
-
-
-
Maven插件的实现类
接下来，我们来编写Maven插件的实现类。这里，我直接给出类的源代码，如下所示。
- package io.mykit.plugin;
-
- import javafx.beans.DefaultProperty;
- 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;
-
-
- @Mojo(name = "binghe")
- public class MykitMavenPlugin extends AbstractMojo {
- private final Logger logger = LoggerFactory.getLogger(MykitMavenPlugin.class);
- @Parameter(property="sex")
- String sex;
-
- @Parameter(property="describe")
- String describe;
-
- public void execute() throws MojoExecutionException, MojoFailureException {
- logger.info(String.format("binghe sex=%s describe=%s",sex,describe));
- }
- }
打包安装插件
将自定义的Maven插件打包并安装到本地Maven仓库，如下所示。
- 打包
- mvn clean package
- 安装到本地仓库
- mvn clean install
其他项目中引用自定义插件
如果需要在其他项目中使用我们自定义的Maven插件，则只需要创建一个Maven项目，在Maven项目的pom.xml文件中引入如下配置即可。
-
-
- --引入刚刚的插件依赖-->
-
io.mykit.plugin -
1.0.0-SNAPSHOT -
mykit-maven-plugin - -- 这里加入的是相关参数，这些参数必须跟插件实现里面的属性保持一致 -->
-
-
男 -
冰河技术微信公众号作者 -
-
-
-
好了，今天就到这儿吧，我是冰河，我们下期见!!
