maven 3 插件开发

最新推荐文章于 2025-12-01 16:56:22 发布
转载 最新推荐文章于 2025-12-01 16:56:22 发布 · 2.8k 阅读 · 0
文章标签：

#maven #string #import #properties #dependencies #encoding

原文地址：http://my.oschina.net/caiyuan/blog/41850

参考地址：http://suhuanzheng7784877.iteye.com/category/138308

编写插件

view source
print ?
01<?xmlversion="1.0"encoding="UTF-8"?>
02<projectxmlns="http://maven.apache.org/POM/4.0.0"
03         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
04         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
05    <modelVersion>4.0.0</modelVersion>
06 
07    <groupId>org.caiyuan.maven</groupId>
08    <artifactId>test-maven-plugin</artifactId>
09    <version>1.0</version>
10    <packaging>maven-plugin</packaging>
11 
12    <dependencies>
13        <dependency>
14            <groupId>org.apache.maven</groupId>
15            <artifactId>maven-plugin-api</artifactId>
16            <version>3.0.3</version>
17        </dependency>
18    </dependencies>
19 
20</project>

view source
print ?
01package org.caiyuan.maven.plugins;
02 
03import org.apache.maven.plugin.AbstractMojo;
04import org.apache.maven.plugin.MojoExecutionException;
05import org.apache.maven.plugin.MojoFailureException;
06import org.caiyuan.maven.v.V;
07 
08import java.io.File;
09import java.net.URL;
10import java.util.Arrays;
11import java.util.List;
12import java.util.Map;
13import java.util.Properties;
14 
15/**
16* User: caiyuan
17* Date: 12-2-27 11:55
18*
19* @goal compile
20* @requiresProject false
21*/
22public class TestMojo extendsAbstractMojo {
23 
24    /**
25     * @parameter property="str"
26     */
27    privateString str;
28 
29    /**
30     * @parameter
31     */
32    privateString lable;
33 
34    /**
35     * @parameter
36     */
37    privatefloat number;
38 
39    /**
40     * @parameter
41     */
42    privateFile file;
43 
44    /**
45     * @parameter
46     */
47    privateURL url;
48 
49    /**
50     * @parameter
51     */
52    privateString[] array;
53 
54    /**
55     * @parameter
56     */
57    privateList<String> items;
58 
59    /**
60     * @parameter
61     */
62    privateMap<String, String> map;
63 
64    /**
65     * @parameter
66     */
67    privateProperties properties;
68 
69    /**
70     * @parameter
71     */
72    privateV v;
73 
74    @Override
75    publicvoid execute() throws MojoExecutionException, MojoFailureException {
76        getLog().info("String is : str = "+ str);
77        getLog().info("String is : lable = "+ lable);
78        getLog().info("String is : number = "+ number);
79        getLog().info("String is : file = "+ file);
80        getLog().info("String is : url = "+ url);
81        getLog().info("String is : array = "+ Arrays.toString(array));
82        getLog().info("String is : items = "+ items);
83        getLog().info("String is : map = "+ map);
84        getLog().info("String is : properties = "+ properties);
85        getLog().info("String is : v = "+ v);
86    }
87 
88}

view source
print ?
01package org.caiyuan.maven.v;
02 
03/**
04* User: caiyuan
05* Date: 12-2-27 17:34
06*/
07public class V {
08 
09    privateString firstName;
10    privateString lastName;
11 
12    publicString getFirstName() {
13        returnfirstName;
14    }
15 
16    publicvoid setFirstName(String firstName) {
17        this.firstName = firstName;
18    }
19 
20    publicString getLastName() {
21        returnlastName;
22    }
23 
24    publicvoid setLastName(String lastName) {
25        this.lastName = lastName;
26    }
27 
28    @Override
29    publicString toString() {
30        return"V{ firstName='" + firstName +"', lastName='" + lastName + "'}";
31    }
32}

测试插件

view source
print ?
01<?xml version="1.0"encoding="UTF-8"?>
02<project xmlns="http://maven.apache.org/POM/4.0.0"
03         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
04         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
05    <modelVersion>4.0.0</modelVersion>
06 
07    <groupId>org.caiyuan.maven</groupId>
08    <artifactId>mvn-test</artifactId>
09    <version>1.0</version>
10 
11    <build>
12        <plugins>
13            <plugin>
14                <groupId>org.caiyuan.maven</groupId>
15                <artifactId>test-maven-plugin</artifactId>
16                <version>1.0</version>
17                <configuration>
18                    <str>test</str>
19                    <lable>123</lable>
20                    <number>3.15</number>
21                    <file>D:\\</file>
22                    <url>http://www.google.com</url>
23                    <array>
24                        <item>a</item>
25                        <item>b</item>
26                        <item>c</item>
27                    </array>
28                    <items>
29                        <item>a</item>
30                        <item>b</item>
31                        <item>c</item>
32                    </items>
33                    <map>
34                        <k1>v1</k1>
35                        <k2>v2</k2>
36                        <k3>v3</k3>
37                    </map>
38                    <properties>
39                        <property>
40                            <name>name1</name>
41                            <value>value1</value>
42                        </property>
43                        <property>
44                            <name>name2</name>
45                            <value>value2</value>
46                        </property>
47                        <property>
48                            <name>name3</name>
49                            <value>value3</value>
50                        </property>
51                    </properties>
52                    <v>
53                        <firstName>Jason</firstName>
54                        <lastName>van Zyl</lastName>
55                    </v>
56                </configuration>
57            </plugin>
58        </plugins>
59    </build>
60 
61</project

 另一篇文章

1.  自定义插件介绍

在一些情况下，Maven现有的一些插件可能满足不了我们的一些“特殊服务”。这个时候有三种选择，第一，问问有经验的Maven开发者，是否有相应的。第二，从网上找找搜搜，看看有没有别的组织开发的Maven插件可以使用。第三，以上两条路都没走通，看来只能自己开发Maven的插件了，谁让咱们的需求比较“特殊”呢！“特殊服务”就得付出点代价不是~对于插件，大家可能接触最深的就是IDE插件了，像Eclipse这种IDE就开创了插件时代，后来的NetBeans、IntelliJ都是内核比较少，插件加在一起显得比较重量级。

2.  编写简单Maven插件

编写一个Maven插件其实不难，关键是编写优秀的Maven插件确实不容易。相对于Eclipse Plugin开发来说，Maven插件开发显得简单又清晰。只需要注意两点就可以开发出一个简单的插件，第一，编写插件pom.xml文件；第二，编写真正做事情的插件Java类。

咱先看pom.xml文件内容啊

Java代码 复制代码  收藏代码
  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">   
  3.     <modelVersion>4.0.0</modelVersion>   
  4.   
  5.     <groupId>com.liuyan.account</groupId>   
  6.     <artifactId>MavenAccount-Plugin</artifactId>   
  7.     <version>1.0</version>   
  8.     <packaging>maven-plugin</packaging>   
  9.     <name>MavenAccount-Plugin</name>   
  10.     <url>http://maven.apache.org</url>   
  11.   
  12.     <properties>   
  13.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>   
  14.     </properties>   
  15.   
  16.     <dependencies>   
  17.         <dependency>   
  18.             <groupId>junit</groupId>   
  19.             <artifactId>junit</artifactId>   
  20.             <version>3.8.1</version>   
  21.             <scope>test</scope>   
  22.         </dependency>   
  23.         <dependency>   
  24.             <groupId>org.apache.maven</groupId>   
  25.             <artifactId>maven-plugin-api</artifactId>   
  26.             <version>3.0.3</version>   
  27.         </dependency>   
  28.     </dependencies>   
  29. </project>  
<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.liuyan.account</groupId>
	<artifactId>MavenAccount-Plugin</artifactId>
	<version>1.0</version>
	<packaging>maven-plugin</packaging>
	<name>MavenAccount-Plugin</name>
	<url>http://maven.apache.org</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>

	<dependencies>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>3.8.1</version>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.apache.maven</groupId>
			<artifactId>maven-plugin-api</artifactId>
			<version>3.0.3</version>
		</dependency>
	</dependencies>
</project>
  这个pom.xml文件主要注意两点，一个就是<packaging>的类型，应该是maven-plugin

，还有一个就是Maven插件项目必须依赖一个插件maven-plugin-api。

之后咱们再来看真正为客户端提供“特殊”Maven“服务”的类插件类必须继承自类org.apache.maven.plugin.AbstractMojo。这里面的一些注解比较有意思，大家别当它是普通的注释信息，Maven编译的时候不会忽略这些注释信息的，这些注释信息暗含了该插件的执行信息。

Java代码 复制代码  收藏代码
  1. package com.liuyan.account.MavenAccount_Plugin;   
  2.   
  3. import org.apache.maven.plugin.AbstractMojo;   
  4. import org.apache.maven.plugin.MojoExecutionException;   
  5. import org.apache.maven.plugin.MojoFailureException;   
  6.   
  7. /**  
  8.  * @goal info  
  9.  * @phase compile  
  10.  * @requiresProject false  
  11.  */  
  12. public class HelloWorldMojo extends AbstractMojo {   
  13.   
  14.     /**  
  15.      * @parameter expression="${name}"  
  16.      * @required  
  17.      */  
  18.     String name;   
  19.   
  20.     /**  
  21.      * @parameter expression="${age}"  
  22.      * @required  
  23.      */  
  24.     int age;   
  25.   
  26.     /**  
  27.      * @parameter expression="${isOk}"  
  28.      * @required  
  29.      */  
  30.     boolean isOk;   
  31.   
  32.     public void execute() throws MojoExecutionException, MojoFailureException {   
  33.         getLog().info(this.toString());   
  34.     }   
  35.   
  36.     public String toString() {   
  37.         return "String is : \"" + name + "\"" + "int is : \"" + age + "\""  
  38.                 + "boolean is : \"" + isOk + "\"";   
  39.     }   
  40.   
  41. }  
package com.liuyan.account.MavenAccount_Plugin;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;

/**
 * @goal info
 * @phase compile
 * @requiresProject false
 */
public class HelloWorldMojo extends AbstractMojo {

	/**
	 * @parameter expression="${name}"
	 * @required
	 */
	String name;

	/**
	 * @parameter expression="${age}"
	 * @required
	 */
	int age;

	/**
	 * @parameter expression="${isOk}"
	 * @required
	 */
	boolean isOk;

	public void execute() throws MojoExecutionException, MojoFailureException {
		getLog().info(this.toString());
	}

	public String toString() {
		return "String is : \"" + name + "\"" + "int is : \"" + age + "\""
				+ "boolean is : \"" + isOk + "\"";
	}

}

 

@goal info：表示该插件的服务目标

@phase compile：表示该插件的生效周期阶段

@requiresProject false：表示是否依托于一个项目才能运行该插件

@parameter expression="${name}"：表示插件参数，使用插件的时候会用得到

@required:代表该参数不能省略

3.  使用自定义插件

使用插件之前先进行安装install。

之后在命令行输入如下命令

Java代码 复制代码  收藏代码
  1. com.liuyan.account:MavenAccount-Plugin:info -Dname=liuyan -Dage=25 -DisOk=true  
com.liuyan.account:MavenAccount-Plugin:info -Dname=liuyan -Dage=25 -DisOk=true

 输出如下效果

Java代码 复制代码  收藏代码
  1. [INFO] --- MavenAccount-Plugin:1.0:info (default-cli) @ MavenAccount-Plugin ---   
  2. [INFO] String is : "liuyan"int is : "25"boolean is : "true"  
  3. [INFO] ------------------------------------------------------------------------   
  4. [INFO] BUILD SUCCESS   
  5. [INFO] ------------------------------------------------------------------------   
  6. [INFO] Total time: 0.609s   
  7. [INFO] Finished at: Thu Jun 23 23:17:45 CST 2011  
  8. [INFO] Final Memory: 2M/15M   
  9. [INFO] ------------------------------------------------------------------------  
[INFO] --- MavenAccount-Plugin:1.0:info (default-cli) @ MavenAccount-Plugin ---
[INFO] String is : "liuyan"int is : "25"boolean is : "true"
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.609s
[INFO] Finished at: Thu Jun 23 23:17:45 CST 2011
[INFO] Final Memory: 2M/15M
[INFO] ------------------------------------------------------------------------

 插件输出了相关信息。您可以为您的服务提供更特殊的定制化“服务”。

 

IDEA配置使用Maven Helper插件的方法(详细配置)
08-26
使用Maven Helper插件可以快速执行Maven命令，提高开发效率。例如，使用Maven Helper插件可以快速地编译、打包和部署项目。 在使用Maven Helper插件时，可能会出现版本不兼容的问题，解决方法是更换插件版本。Maven...
maven helper插件
09-13
3. **排除依赖**：如果某个依赖项导致了冲突，maven helper允许用户临时或永久地排除特定版本，以测试项目是否仍能正常工作。这对于微调Maven配置非常有用。 4. **选择性引入**：对于大型项目，有时只需要特定子...
Maven3实战笔记15编写Maven插件
suhuanzheng7784877的专栏
06-24 149
1.  自定义插件介绍 在一些情况下，Maven现有的一些插件可能满足不了我们的一些“特殊服务”。这个时候有三种选择，第一，问问有经验的Maven开发者，是否有相应的。第二，从网上找找搜搜，看看有没有别的组织开发的Maven插件可以使用。第三，以上两条路都没走通，看来只能自己开发Maven的插件了，谁让咱们的需求比较“特殊”呢！“特殊服务”就得付出点代价不是~对于插件，大家可能接触最深的就是ID...
Maven常见报错原因及解决方案
热门推荐
blueboz的博客
03-19 8万+
No compiler is provided in this environment. Perhaps you are running on a JRE rather than a JDK?解决方法问题是将JRE作为JDK使用了，解决办法是安装JDK，并将JDK设置到Installed JREs中图示 错误堆栈[ERROR] Failed to execute goal org.apache.m
Maven插件开发
飞鸟Blog
12-07 2564
Maven插件开发
自定义maven插件 开发步骤手册
张紫娃的博客
01-03 3509
Maven只是一套框架，它的功能基于全部依赖于插件来实现。因此可以通过插件开发来定制Maven。
Idea开发maven插件
超人不会飞
04-08 7390
文章目录场景描述插件功能插件开发第一步：创建插件项目第二步：插件实现2.1 声明mojo类（插件）2.2 添加参数2.3 execut方法实现自定义插件功能2.4插件使用 场景描述 最近博主开发了一个用于接收数据的接口服务器，一开始数据是外部购买的，数据源只有一个地方，但是随着业务的拓展，公司不打算全部数据都从外部购买，而是将其中一部分数据交给公司爬虫部门来爬取，这样数据源变成了两处。但是博主的接...
Maven自定义插件
scorpio的博客
04-07 4013
Maven自定义插件
Maven－如何开发一个Maven插件（Mojo）
了解➔熟悉➔掌握➔精通
03-12 1432
分享一个大牛的人工智能教程。零基础！通俗易懂！风趣幽默！希望你也加入到人工智能的队伍中来！请轻击人工智能教程​​​Maven是当下最流行的项目管理工具，其丰富的插件为我们的工作带来了很大的便利。但是在一些情况下，开源的插件并不能完全满足我们的需求，我们需要自己创建插件，本文就从0开始带大家一起创建自己的插件。
使用 Maven 开发 IntelliJ IDEA 插件
pumpkin84514的博客
11-24 2072
通过 Maven 开发 IntelliJ 插件，与 Gradle 类似，只需修改。
Maven实战（六）- 开发自定义Maven插件
AHAO的博客
08-08 2843
表示该目标是否必须在一个Maven项目中运行，默认为true。这里介绍一款插件maven-invoker-plugin，该插件能够用来在一组项目上执行Maven，并检查每个项目的构建是否成功，最后，它还可以执行BeanShell或者Groovy脚本来验证项目构建的输出。任何一个Mojo都必须使用该注解声明明自己的目标名称，有了目标定义之后，我们才能在项目中配置该插件目标，或者在命令行调用之。这是唯一必须声明的属性，当用户使用命令行调用插件，或者者在POM中配置插件的时候，都需要使用该目标名称。
maven3插件
07-16
Maven3 插件是 Maven 构建工具中的一个重要组成部分，它极大地扩展了 Maven 的功能，使得开发者能够自动化处理各种特定的构建任务。...在实际项目中，开发者应根据需要选择和定制适合的Maven插件。
maven仓库插件
10-18
Maven插件是Maven生命周期中的执行单元，它们执行特定的任务，如编译源代码、打包项目、运行测试等。Maven仓库插件则是专门用于处理仓库操作的插件，包括下载依赖、上传构建的工件以及管理仓库配置。 ** Maven仓库...
Maven 插件列表详解
栗筝i的博客
06-19 3890
Maven 是一个强大的项目管理和构建工具，广泛应用于 Java 项目中。作为一款优秀的构建管理工具，Maven 不仅提供了标准化的项目结构和依赖管理，还通过其丰富的插件系统，极大地扩展了其功能和灵活性。无论是代码编译、测试、打包，还是部署、报告生成，Maven 插件都扮演着不可或缺的角色。 本文将深入探讨 Maven 的插件体系，详细介绍各类插件的用途、主要目标和适用的生命周期阶段。内容涵盖了 Maven 官方插件、被淘汰的插件、社区驱动的 MojoHaus 插件、国内外企业开发的非官方插件以及如何自定
Maven第六章：Maven的自定义插件开发
RodJohnsonDoctor的专栏
10-30 1081
maven不仅仅只是项目的依赖管理工具，其强大的核心来源自丰富的插件，可以说插件才是maven工具的灵魂。本篇文章将对如何自定义maven插件进行讲解，希望对各位读者有所帮助。
maven导入spring框架
2509_94088455的博客
11-29 156
spring-jdbc包括了一些如jdbcTemplate的工具类。4.Spring test依赖：方便做单元测试和集成测试。在eclipse导入maven项目，在pom.xml文件中加入以下内容。2.Spring dao依赖。3.Spring web依赖。1.Spring核心依赖。
Maven高级
最新发布
ScriptBIN的博客
12-01 677
摘要：分模块设计与开发通过解耦、复用、可维护性和团队协作等核心目标优化项目结构。模块可基于技术层次（三层架构）或业务功能（微服务）划分，关键实践包括依赖管理、接口隔离、独立测试和服务通信。Maven中的继承用于配置共享和版本统一，聚合则实现统一构建，两者常结合使用。版本锁定机制通过dependencyManagement集中管理依赖版本，避免冲突。私服作为代理和缓存层，提升构建速度、安全性和内部组件共享，是企业级开发的重要基础设施。
SpringBoot Maven 项目 pom 中的 plugin 插件用法整理
2509_94229239的博客
11-29 957
把 SpringBoot Maven 项目打包成 jar 文件时，我们通常用到 spring-boot-maven-plugin 插件。前面也介绍过，在 spring-boot-starter-parent POM 和 spring-boot-starter POM 中都有插件的管理，现在我们就撸一把构建元素中插件的用法。project 标签指定项目的声明。modelVersion 标签指定 POM 模型的版本。目前使用的是 4.0.0 版本。这是 Maven 项目的根元素，定义了项目模型的版本。
Eclipse手动安装Maven3插件指南
这个插件与早期版本的Maven插件有所不同，它支持Maven 3的新特性，如更好的并行构建支持、更好的仓库管理等。因此，用户在选择插件时应当注意版本的兼容性，确保其与当前使用的Maven版本相匹配。 最后，提到的压缩...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值