maven插件开发

最新推荐文章于 2024-07-05 23:44:11 发布
最新推荐文章于 2024-07-05 23:44:11 发布
阅读量7k 收藏
点赞数
分类专栏： maven 文章标签： maven properties encoding string null eclipse
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liulin_good/article/details/6069818
版权

大多数计算机语言的学习都是从Hello World开始，我们通过创建一个在控制台打印Hello World字符串的maven插件来学习如何开发一个自定义maven插件。

 

快速开发第一个插件

1，创建一个maven-plugin目录，并进入此目录。

 

2，运行命令：

 

mvn archetype:create -DgroupId=com.ailbaba.maven -DartifactId=maven-hello-plugin -DarchetypeArtifactId=maven-archetype-mojo

可以看到新建一个工程，其pom.xml：

 

<project xmlns="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/maven-v4_0_0.xsd">

  <modelVersion>4.0.0</modelVersion>

  <groupId>com.alibaba.maven</groupId>

  <artifactId>maven-hello-plugin</artifactId>

  <packaging>maven-plugin</packaging>

  <version>1.0-SNAPSHOT</version>

  <name>maven-hello-plugin Maven Mojo</name>

  <url>http://maven.apache.org</url>

  <dependencies>

    <dependency>

      <groupId>org.apache.maven</groupId>

      <artifactId>maven-plugin-api</artifactId>

      <version>2.0</version>

    </dependency>

    <dependency>

      <groupId>junit</groupId>

      <artifactId>junit</artifactId>

      <version>3.8.1</version>

      <scope>test</scope>

    </dependency>

  </dependencies>

</project>

3，进入maven-hello-plugin目录，运行命令：mvn eclipse:eclipse构建eclipse工程。

 

4，通过eclipse import工程，删除包下面自动生成的java文件，新建HelloWorldMojo.java,HelloWorldMojo.java的内容如下：

 

package com.alibaba.maven;

 

import org.apache.maven.plugin.AbstractMojo;

import org.apache.maven.plugin.MojoExecutionException;

 

/**

 * @goal helloworld

 */

 

public class HelloWorldMojo extends AbstractMojo {

 

    /**

     * @parameter expression="${helloworld.words}" default-value="Hello World!"

     */

 

    private String words;

 

    public void execute() throws MojoExecutionException {

 

        getLog().info(words);

 

    }

 

}

5， 文件编写完成后回到cmd命令行，在项目的pom文件目录处运行install命令将插件安装到本地repository：mvn clean install

6， 安装成功后继续运行如下命令查看插件的运行情况：

 

运行：

 

mvn com.alibaba.maven:maven-hello-plugin:1.0-SNAPSHOT:helloworld

，可以看到控制台看到输出："Hello World!"；这个输出是插件的默认参数：

 

default-value="Hello World!"

运行

 

mvn com.alibaba.maven:maven-hello-plugin:1.0-SNAPSHOT:helloworld -Dhelloworld.words="welcome!"

可以在控制台看到输出："welcome!"；这个在命令中明确指定插件的参数，因此输出的是指定的参数"welcome!"。

 

关键点

1.maven的参数注入

maven默认使用的自行开发的Plexus，Plexus使用javadoc来管理依赖注入，可以看到上面的@goal，@parameter都是通过这种方式注入，现在看起来非常原始，不过maven3将迁移到guice.

 

2.MOJO

maven是由生命周期和goal完成任务的，比如maven install实际上包换了多种goal.插件中的每个任务goal称作一个 Mojo（Maven plain Old Java Object）。项目中每一个Mojo都要实现org.apache.maven.plugin.Mojo接口，上面的插件示例的Mojo通过扩展org.apache.maven.plugin.AbstractMojo类实现了该接口。Mojo提供如下的方法：

 

void setLog( org.apache.maven.monitor.logging.Log log)

当Maven加载并运行Mojo的时候，它会调用setLog()方法，为Mojo实例提供正确的日志目标。

 

Mojo接口只关心两件事情：目标运行结果的日志记录，以及运行一个目标。当编写自定义插件的时候，需要扩展AbstractMojo。 AbstractMojo处理setLog()和getLog()的实现，并包含一个抽象的execute()方法。在扩展AbstractMojo的时候，你所需要做的只是实现execute()方法。

 

公司maven-autoconfig-plugin探究

在你的本地仓库会有maven autoconfig插件的代码，svn地址：http://svn.alibaba-inc.com/repos/ali_platform/maven/plugins/maven-autoconf-plugin/trunk，可以看一下核心类AutoconfMojo，其实里面非常简单：

 

/**

 * Autoconf Mojo, eg: mvn autoconf:autoconf

 * 

 * @goal autoconf

 * @requiresProject false

 * 

 * @author shawn.qianx

 * @author hongyuan.zhouhy

 * @author william.liangf

 */

public class AutoconfMojo extends AbstractMojo {

 

    /**

     * directory or jar/war/zip archive path, separate by comma, default is current directory.

     * 

     * @parameter expression="${path}"

     */

    private String path;

 

 

    public void execute() throws MojoExecutionException, MojoFailureException {

        getLog().info("Execute autoconf:autoconf.");

        WarConfigRuntimeImpl runtime = new WarConfigRuntimeImpl(System.in, System.out, System.err, charset);

        if(path != null && path.trim().length() > 0){

            runtime.setDests(path.split(","));

        } else {

            runtime.setDests(new String[] {"."});

        }

        if (charset == null) {

            charset = ConfigConstant.DEFAULT_CHARSET;

        }

        if (encoding == null) {

            encoding = ConfigConstant.DEFAULT_CHARSET;

        }

        if (interactive) {

            getLog().info("Turn on interactive mode.");

            runtime.setInteractiveMode(ConfigConstant.INTERACTIVE_ON);

        }

        if (gui) {

            runtime.setGuiMode();

        }

        if (verbose) {

            runtime.setVerbose();

        }

        if(properties != null && properties.trim().length() > 0){

            getLog().info("Customized user properties:" + properties + " using encoding:" + charset);

            runtime.setUserPropertiesFile(properties, charset);

        }

        if (userProp != null && userProp.trim().length() > 0) {

            getLog().info("Customized user properties:" + userProp + " using encoding:" + encoding);

            runtime.setUserPropertiesFile(userProp, encoding);

        }

        if (sharedProperties != null && sharedProperties.length() > 0) {

            getLog().info("Customized shared properties: " + descriptors);

            runtime.setSharedPropertiesFiles(sharedProperties.split(","), sharedPropertiesName, charset);

        }

        if ((descriptors != null && descriptors.length() > 0) 

                || (excludeDescriptors != null && excludeDescriptors.length() > 0)) {

            String[] includes;

            String[] excludes;

            PatternSet patterns = runtime.getDescriptorPatterns();

            if (descriptors == null || descriptors.length() == 0) {

                try {

                    includes = patterns.getIncludes();

                } catch (NullPointerException npe) {

                    includes = new String[0];

                }

            } else {

                getLog().info("Customized include descriptors: " + descriptors);

                includes = descriptors.split(",");

            }

            if (excludeDescriptors == null || excludeDescriptors.length() == 0) {

                try {

                    excludes = patterns.getExcludes();

                } catch (NullPointerException npe) {

                    excludes = new String[0];

                }

            } else {

                getLog().info("Customized exclude descriptors: " + excludeDescriptors);

                excludes = excludeDescriptors.split(",");

            }

            runtime.setDescriptorPatterns(includes, excludes);

        }

        if ((packages != null && packages.length() > 0) 

                || (excludePackages != null && excludePackages.length() > 0)) {

            String[] includes;

            String[] excludes;

            PatternSet patterns = runtime.getPackagePatterns();

            if (packages == null || packages.length() == 0) {

                try {

                    includes = patterns.getIncludes();

                } catch (NullPointerException npe) {

                    includes = new String[0];

                }

            } else {

                getLog().info("Customized include packages: " + descriptors);

                includes = packages.split(",");

            }

            if (excludePackages == null || excludePackages.length() == 0) {

                try {

                    excludes = patterns.getExcludes();

                } catch (NullPointerException npe) {

                    excludes = new String[0];

                }

            } else {

                getLog().info("Customized exclude packages: " + excludeDescriptors);

                excludes = excludePackages.split(",");

            }

            runtime.setPackagePatterns(includes, excludes);

        }

        try {

            runtime.start();

        } catch (Exception e) {

            runtime.error(e);

            throw new MojoExecutionException("autoconf execution error", e);

        }

    }

 

}

小结

开发一个maven插件就是开发一个mojo,然后这样使用它们：maven xx:xx 。

liulin_good
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Maven插件开发教程
小明的博客
01-10 5588
Maven是一个一个优秀的项目管理开源框架，其插件机制为其功能扩展提供了非常大的便捷性。大多数情况下，我们不需要自己开发Maven插件，因为Maven本身提供了很多便捷的官方插件。但是对于某些特殊场景和特殊需求，开发一个自定义的Maven插件能大大提高开发效率。本文以一个简单的例子，展示如何创建一个自定义的Maven插件。 Maven插件开发 本文会以一个自制的Maven插件为例，展示如何使用Idea从0开始构建自制的Maven插件。 Maven插件目标 Maven本质是一个插件执行框架，所有的工作都是通过
Maven 插件列表详解
栗筝i的博客
06-19 1168
Maven 是一个强大的项目管理和构建工具，广泛应用于 Java 项目中。作为一款优秀的构建管理工具，Maven 不仅提供了标准化的项目结构和依赖管理，还通过其丰富的插件系统，极大地扩展了其功能和灵活性。无论是代码编译、测试、打包，还是部署、报告生成，Maven 插件都扮演着不可或缺的角色。 本文将深入探讨 Maven 的插件体系，详细介绍各类插件的用途、主要目标和适用的生命周期阶段。内容涵盖了 Maven 官方插件、被淘汰的插件、社区驱动的 MojoHaus 插件、国内外企业开发的非官方插件以及如何自定
Maven插件开发
飞鸟Blog
12-07 2268
Maven插件开发
自定义maven插件 开发步骤手册
张紫娃的博客
01-03 2370
Maven只是一套框架，它的功能基于全部依赖于插件来实现。因此可以通过插件开发来定制Maven。
Maven系列第10篇：设计你自己的maven插件【高手必备】
2401_84411249的博客
04-19 658
maven中的插件是有很多目标（goal）组成的，开发插件，实际上就是去编写插件中目标的具体代码。每个目标对应一个java类，这个类在maven中叫做MOJO，maven提供了一个Mojo的接口，我们开发插件也就是去实现这个接口的方法，这个接口是：接口有3个方法：execute：这个方法比较重要，目标的主要代码就在这个方法中实现，当使用mvn命令调用插件的目标的时候，最后具体调用的就是这个方法。setLog：注入一个标准的Maven日志记录器，允许这个Mojo向用户传递事件和反馈getLog。
Maven插件开发及Demo演示
weixin_38277138的博客
06-20 1743
Maven插件开发及Demo演示
Maven插件开发——MOJO简单使用
m0_67403076的博客
08-20 1620
Maven包含一个提供基本项目处理功能和构建过程管理的核心引擎，以及一系列用于执行实际构建任务的插件。Mojo实际上是一个Maven的目标，插件包含任意数量的目标（Mojos）。Mojos可以定义为带注释的java类或Beanshell脚本。Mojo指定有关目标的元数据：目标名称，它适合生命周期的哪个阶段，以及它期望的参数。Mojo术语是在maven2中引入，它是对如何编写插件的完整重写。Mojo是对Pojo（plain-old-java-object）的一种改进，它将maven替换为plain。
maven插件开发及调试方法
以爱护甲,爱满枫林。
03-25 1321
一、maven插件的开发： 1、首先随便创建一个maven工程。 2、然后在pom.xml文件中添加依赖： <dependency> <groupId>org.apache.maven</groupId> <artifactId>maven-plugin-api</artifactId> <version>3.5.0</version&
Idea开发maven插件
超人不会飞
04-08 7100
文章目录场景描述插件功能插件开发第一步：创建插件项目第二步：插件实现2.1 声明mojo类（插件）2.2 添加参数2.3 execut方法实现自定义插件功能2.4插件使用 场景描述 最近博主开发了一个用于接收数据的接口服务器，一开始数据是外部购买的，数据源只有一个地方，但是随着业务的拓展，公司不打算全部数据都从外部购买，而是将其中一部分数据交给公司爬虫部门来爬取，这样数据源变成了两处。但是博主的接...
【Maven教程】（十五）：编写 Maven 插件—— 编写 Maven 插件的一般步骤及案例、Mojo 标注与参数、错误处理和日志 ~
Technology changes the world of life
01-26 1848
Maven 社区提供了成百上千的插件供用户使用，这些插件能够满足绝大部分用户的需求。然而，在极少数的情况下，用户还是需要编写 Maven 插件来满足自己非常特殊的需求。编写 Maven 插件的一般步骤包括创建一个插件项目、编写Mojo 、为 Mojo提供配置点、实现 Mojo 行为、处理错误、记录日志和测试插件等。本章实现了一个简单的代码行统计插件， 并逐步展示了上述步骤。用户在编写自己插件的时候，还可以参考本章描述的各种 Mojo标注 、Mojo 参数、异常类型和日志接口。
maven插件开发和调试
qq_30062125的博客
10-09 1902
maven插件开发 官方文档 http://maven.apache.org/plugin-developers/index.html 1.新建maven工程 pom.xml参考： &amp;lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&amp;gt; &amp;lt;project xmlns=&quot;http://maven.apache
maven 插件开发
08-02
Maven 插件开发是 Maven 生态系统中的一个重要组成部分，它允许开发者根据自己的特定需求定制和扩展 Maven 的功能。以下是一些关于 Maven 插件开发的关键知识点： 1. **Maven 插件架构**： Maven 插件基于 Maven ...
Maven 插件.pdf
06-22
附件以Maven插件为核心，详细的讲述了如何获取插件的信息和插件配置的两种方式。熟练的掌握这些
Maven Build压缩打包(一)-maven插件开发
04-27
本文是研究Maven压缩打包技术中的第一部分，主要介绍了如何开发Maven插件，参与maven build的打包过程。 并附上了学习过程中应注意的细节，以及遇到的问题及解决方法。
（快嘉代码生成Maven插件） 基于maven插件实现
06-03
【快嘉代码生成Maven插件】是一种专为提高研发效率而设计的开发工具，它基于流行的Maven构建系统，并且特别关注接口测试自动化。这个插件的核心功能是能够根据用户提供的自定义接口文档，自动地生成基于TestNG测试...
maven插件压缩包
01-03
** Maven 插件详解及其在...了解和熟练使用Maven插件能够极大地提高开发效率，同时确保项目的一致性和可维护性。对于给定的压缩包，如果包含的是Maven插件的文档资源，那么它们对于理解和配置相关插件会非常有帮助。
Maven 分模块设计与开发 继承
生产队的驴
07-05 254
在 Maven 中进行分模块设计（multi-module project），可以帮助将一个大型项目分解为更小、更易管理的模块。这种设计方式有助于提高项目的可维护性、复用性和团队协作效率。
maven-依赖管理
weixin_63680330的博客
07-05 461
依赖具有传递性projectA不止依赖自己目录下的jar包还会依赖projectB，projectC下的jar包，以此类推直接依赖的资源称为直接依赖间接依赖的资源称为间接依赖在4.1中依赖了4.04.0又依赖了1.2.62由此可见实现了依赖传递可以在pom.xml文件中右键打开查看其依赖关系。
使用maven搭建一个SpingBoot项目
最新发布
m0_73381672的博客
07-05 330
依赖，目的是引入Tomcat，以及SpringMVC等，使项目具有web功能。2.在pom.xml中至少添加依赖。
idea maven 插件
08-19
Maven是一个用于构建和管理Java项目的工具。Maven插件是一种扩展，它可以在Maven构建过程中添加额外的功能或任务。下面是一些有关Maven插件...记得在开发插件时参考Maven插件开发文档和示例，以获得更好的指导和帮助。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值