Maven常用插件示例

最新推荐文章于 2024-11-26 19:12:37 发布
最新推荐文章于 2024-11-26 19:12:37 发布
阅读量2k 收藏 2
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/waterystone/article/details/43987789
版权

0. resources管理

<resources>
	<resource>
		<directory>src/main/java</directory>
		<includes>
			<include>**/*.java</include>
			<include>**/*.xml</include>
		</includes>
	</resource>
	<resource>
		<directory>src/main/resources</directory>
		<includes>
			<include>**/*.txt</include>
			<include>**/*.properties</include>
			<include>**/*.xml</include>
		</includes>
	</resource>
</resources>
<testResources>
	<testResource>
		<directory>src/test/java</directory>
		<includes>
			<include>**/*.java</include>
		</includes>
	</testResource>
	<testResource>
		<directory>src/test/resources</directory>
		<includes>
			<include>**/*.txt</include>
			<include>**/*.xml</include>
			<include>**/*.properties</include>
		</includes>
	</testResource>
</testResources>


一.maven-source-plugin

生成源码包，http://maven.apache.org/plugins/maven-source-plugin/。

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-source-plugin</artifactId>
	<version>2.2.1</version>
	<executions>
		<execution>
			<id>attach-source</id><!-- 名称随意指定 -->
			<phase>package</phase><!-- 要绑定到的生命周期的阶段 -->
			<goals>
				<goal>jar-no-fork</goal><!-- 要绑定的插件的目标 -->
			</goals>
		</execution>
	</executions>
</plugin>

这样在mvn package后便会在target目录下生成*-sources.jar源码包。


二. maven-javadoc-plugin

生成javadoc文档，http://maven.apache.org/plugins/maven-javadoc-plugin/。

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-javadoc-plugin</artifactId>
	<version>2.7</version>
	<executions>
		<execution>
			<id>attach-javadocs</id>
			<phase>package</phase>
			<goals>
				<goal>jar</goal>
			</goals>
		</execution>
	</executions>
</plugin>


这样在mvn package后便会在target目录下生成*-javadoc.jar文档包。


三. maven-jar-plugin

构建jar项目（ 不包含依赖），http://maven.apache.org/plugins/maven-jar-plugin/。

只用将pom文件的打包文件设置为jar：<packaging>jar</packaging>，不用再配置maven-jar-plugin，在执行mvn package时默认会在target目录下生成*.jar。

打开mvn-test-0.0.1-SNAPSHOT.jar/META-INF/MANIFEST.MF可看到：

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven
Built-By: xiaoqiang
Build-Jdk: 1.7.0_45


3.2 将资源(resources)打入jar包

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-jar-plugin</artifactId>
	<configuration>
		<excludes>
			<exclude/>
		</excludes>
	</configuration>
</plugin>



3.1 将依赖包打到lib下，并生成可执行jar包

<!-- 拷贝依赖的jar包到lib目录 -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
        <execution>
            <id>copy-dependencies</id>
            <phase>package</phase><!-- 绑定到package阶段 -->
            <goals>
                <goal>copy-dependencies</goal><!-- 指定目标 -->
            </goals>
            <configuration>
                <outputDirectory>${project.build.directory}/lib</outputDirectory><!--将依赖jar包拷贝到指定目录 -->
                <overWriteReleases>false</overWriteReleases>
                <overWriteSnapshots>false</overWriteSnapshots>
                <overWriteIfNewer>true</overWriteIfNewer>
            </configuration>
        </execution>
    </executions>
</plugin>

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <configuration>
        <archive>
            <manifest>
                <addClasspath>true</addClasspath><!-- 设置classPath -->
                <classpathPrefix>lib/</classpathPrefix><!-- 设置依赖包的目录 -->
                <mainClass>com.adu.mvn_test.HelloWorld</mainClass><!-- 主类 -->
            </manifest>
        </archive>
    </configuration>
</plugin>
这样，mvn clean package后，便会在target下生成mvn-test-0.0.1-SNAPSHOT.jar及lib目录，前者是可执行jar包，后者存放依赖的第三方jar包。

打开mvn-test-0.0.1-SNAPSHOT.jar/META-INF/MANIFEST.MF可看到：

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven
Built-By: xiaoqiang
Build-Jdk: 1.7.0_45
Main-Class: com.adu.mvn_test.HelloWorld
Class-Path: lib/commons-logging-1.1.1.jar lib/log4j-1.2.17.jar

如果eclipse在maven-dependency-plugin的<execution>行报错，则在<bulid>下加如下代码即可： 

<pluginManagement>
	<plugins>

		<!-- 忽略maven-dependency-plugin报的错 -->
		<plugin>
			<groupId>org.eclipse.m2e</groupId>
			<artifactId>lifecycle-mapping</artifactId>
			<version>1.0.0</version>
			<configuration>
				<lifecycleMappingMetadata>
					<pluginExecutions>
						<pluginExecution>
							<pluginExecutionFilter>
								<groupId>org.apache.maven.plugins</groupId>
								<artifactId>maven-dependency-plugin</artifactId>
								<versionRange>[2.0,)</versionRange>
								<goals>
									<goal>copy-dependencies</goal>
								</goals>
							</pluginExecutionFilter>
							<action>
								<ignore />
							</action>
						</pluginExecution>
					</pluginExecutions>
				</lifecycleMappingMetadata>
			</configuration>
		</plugin>
	</plugins>
</pluginManagement>


四. maven-compiler-plugin

指定JDK版本和编码
maven 2.1默认用jdk 1.3来编译，maven3 貌似是用jdk 1.5，如果项目用的jdk 1.6也会有问题，compiler插件可以指定JDK版本为1.6。
windows默认使用GBK编码，java项目经常编码为utf8，也需要在compiler插件中指出，否则中文乱码可能会出现编译错误。

<plugin> 
	<groupId>org.apache.maven.plugins</groupId> 
	<artifactId>maven-compiler-plugin</artifactId>
	<version>3.1</version> 
	<configuration> 
		<source>1.6</source> 
		<target>1.6</target> 
		<encoding>UTF8</encoding> 
	</configuration> 
</plugin>

五.maven-surefire-plugin

maven是使用surefire插件执行测试的，它按照指定格式的类名来查找匹配的测试类。

默认包含的测试类：

  • **/*Test.java
  • **/Test*.java
  • **/*TestCase.java

默认排除的测试类：

  • **/Abstract*Test.java
  • **/Abstract*TestCase.java

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.16</version>
    <configuration>
        <argLine>-Xms128m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=256m</argLine><!-- 设置单元测试时虚拟机内存 -->
        <includes>
            <include>**/*Test.java</include>
        </includes>
        <excludes>
            <exclude>**/TestConstants.java</exclude>
        </excludes>
        <forkMode>always</forkMode>
    </configuration>
</plugin>
forkMode:Maven运行测试用例时，是通过调用maven的surefire插件并fork一个子进程来执行用例的。forkmode属性中指明是要为每个测试创建一个进程，还是所有测试在同一个进程中完成。forkMode可设置值有 “never”， “once”， “always” 和 “pertest”。pretest： 每一个测试创建一个新进程，为每个测试创建新的JVM是单独测试的最彻底方式，但也是最慢的，不适合hudson上持续回归。once：在一个进程中进行所有测试。once为默认设置，在Hudson上持续回归时建议使用默认设置。always：在一个进程中并行的运行脚本，Junit4.7以上版本才可以使用，

使用该插件需要指定如下内容：

<testSourceDirectory>src/test/java</testSourceDirectory>
<testOutputDirectory>target/test-classes</testOutputDirectory>
<testResources>
	<testResource>
		<directory>src/test/java</directory>
		<includes>
			<include>**/*.xml</include>
			<include>**/*.properties</include>
			<include>**/*.java</include>
		</includes>
	</testResource>
	<testResource>
		<directory>src/test/resources</directory>
		<includes>
			<include>**/*.xml</include>
			<include>**/*.properties</include>
		</includes>
	</testResource>
</testResources>

5.1 跳过单元测试

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-surefire-plugin</artifactId>
	<configuration>
		<skipTests>true</skipTests>
	</configuration>
</plugin>

skip=true，表示跳过单元测试，相当于-Dmaven.test.skip=true。


但是在执行mvn test -Dtest时，也会被跳过。解决方法是用excludes跳过所有测试，而不是用skipTests.

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-surefire-plugin</artifactId>
	<version>2.16</version>
	<configuration>
		<!-- <skipTests>true</skipTests> -->
		<excludes>
			<exclude>**/*.java</exclude>
		</excludes>
	</configuration>
</plugin>

即跳过所有test。这样再执行mvn test -Dtest就没有问题了。

六. maven-shade-plugin

构建包含依赖的jar包，http://maven.apache.org/plugins/maven-shade-plugin/。

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-shade-plugin</artifactId>
	<version>1.4</version>
	<executions>
		<execution>
			<phase>package</phase><!-- 要绑定到的生命周期的阶段 -->
			<goals>
				<goal>shade</goal><!-- 要绑定的插件的目标 -->
			</goals>
			<configuration>
				<transformers>
					<transformer
						implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
						<mainClass>com.adu.mvn_test.HelloWorld</mainClass><!-- 指定可执行jar包的主程序入口 -->
					</transformer>
				</transformers>
			</configuration>
		</execution>
	</executions>
</plugin>

mvn clean package后，target下可以看到 mvn-test-0.0.1-SNAPSHOT.jar和 original-mvn-test-0.0.1-SNAPSHOT.jar两个jar包，前者是带有依赖包(会解压)和Main-Class信息的可运行jar包，后者是原始的jar包(不包含依赖及Main-Class信息)。
打开mvn-test-0.0.1-SNAPSHOT.jar/META-INF/MANIFEST.MF可看到Main-Class: com.adu.mvn_test.HelloWorld信息。
可运行jar包的执行：$java -jar mvn-test-0.0.1-SNAPSHOT.jar 或者直接双击。

七.maven-assembly-plugin

构建自定义格式的分发包，http://maven.apache.org/plugins/maven-assembly-plugin/。

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-assembly-plugin</artifactId>
	<version>2.2</version>
	<configuration>
		<archive>
			<manifest>
				<mainClass>com.adu.mvn_test.HelloWorld</mainClass>
			</manifest>
		</archive>
		<descriptorRefs>
			<descriptorRef>
				jar-with-dependencies
			</descriptorRef>
		</descriptorRefs>
	</configuration>
</plugin>

这样mvn assembly:assembly后，便会在target目录下生成mvn-test-0.0.1-SNAPSHOT-jar-with-dependencies.jar，即是带有依赖包(会解压)和Main-Class信息的可运行jar包。

7.1 assembly绑定到package阶段

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-assembly-plugin</artifactId>
	<version>2.2</version>
	<executions>
		<execution>
			<id>make-assembly</id><!-- 名称随意指定 -->
			<phase>package</phase><!-- 绑定到pakcage阶段 -->
			<goals>
				<goal>single</goal><!-- 插件目标 -->
			</goals>
		</execution>
	</executions>
	<configuration>
		<archive>
			<manifest>
				<mainClass>com.adu.mvn_test.HelloWorld</mainClass><!--主类 -->
			</manifest>
		</archive>
		<descriptorRefs>
			<descriptorRef>
				jar-with-dependencies<!-- 带依赖 -->
			</descriptorRef>
		</descriptorRefs>
	</configuration>
</plugin>

这样，mvn package即可达到上面的结果。


7.2 不解压到目标jar包

默认assembly会将依赖的jar包解压到目标jar包里，如果想不解压，可用如下配置。

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-assembly-plugin</artifactId>
	<version>2.2</version>
	<configuration>
		<descriptors>
			<descriptor>src/main/resources/assembly.xml</descriptor>
		</descriptors>
	</configuration>
</plugin>

assembly.xml的内容如下： 
<assembly>
	<id>jar-with-dependencies</id>
	<formats>
		<format>jar</format>
	</formats>
	<includeBaseDirectory>false</includeBaseDirectory>
	<dependencySets>
		<dependencySet>
			<unpack>false</unpack><!--不解压 -->
			<scope>runtime</scope>
		</dependencySet>
	</dependencySets>
</assembly>
但是这种方法，运行jar的时候一直提示找不到主类，正在解决中。。。。。


转载请注明：http://blog.youkuaiyun.com/waterystone/article/details/43987789

waterystone
关注
Maven 构建报告与文档生成
秋元的博客
02-19 1269
Maven 是一种强大的构建工具，它不仅可以帮助我们构建和管理项目，还提供了生成项目报告和文档的功能。通过 Maven 的插件，我们可以自动生成代码文档（如 Javadoc），执行测试并生成测试报告，以及其他构建过程中的重要信息报告。本文将详细介绍如何使用 Maven 生成项目的构建报告和文档。Maven 可以通过一些插件生成多种类型的报告，常见的报告包括：这些报告可以帮助开发人员、团队和项目管理员了解项目的健康状况、测试覆盖率以及其他关键指标。 是生成 Javadoc 的官方插件，默认情况下，Maven
maven常用插件示例——编译、打包、拷贝依赖和资源、ant脚本
Mutou_ren的博客
03-19 452
记录下maven打包的常用插件使用方法 <build> <plugins> <!--编译插件，JDK8，编码UTF-8--> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler...
Maven 常用插件的详细整理
08-29
主要介绍了Maven 常用插件的详细整理的相关资料,这里整理了maven的常用插件需要的朋友可以看下，需要的朋友可以参考下
常用Maven插件介绍
weixin_30783629的博客
02-09 409
常用Maven插件介绍 我们都知道Maven本质上是一个插件框架，它的核心并不执行任何具体的构建任务，所有这些任务都交给插件来完成，例如编译源代码是由maven- compiler-plugin完成的。进一步说，每个任务对应了一个插件目标（goal），每个插件会有一个或者多个目标，例如maven- compiler-plugin的compile...
Maven常用插件
YIYIYI
10-09 3034
Maven常用插件
maven 常用插件
weixin_33852020的博客
07-28 117
maven插件是用来完成构建任务的。用户可以通过两种方式调用Maven插件。 第一种方式是将插件与生命周期绑定，如命令mvn compile就实现了maven-compiler-plugin的调用目标。 第二种方式是直接在命令行指定要执行的插件，如mvn archetype:generate 就表示调用maven-archetype-plugin。1....
[maven] 常用插件解析
weixin_34198453的博客
03-31 869
参考资料：http://my.oschina.net/zh119893/blog/276090    我们都知道Maven本质上是一个插件框架，它的核心并不执行任何具体的构建任务，所有这些任务都交给插件来完成。 例如编译源代码是由maven-compiler-plugin完成的。 进一步说，每个任务对应了一个插件目标（goal），每个插件会有一个或者多个目标。 例如maven-compi...
maven 自定义插件小示例
05-01
通过以上步骤，你可以根据项目需求定制自己的Maven插件，增强Maven的灵活性和实用性。在实际开发中，自定义插件可以帮助解决特定场景下的问题，提高开发效率。对于熟悉Maven的开发者来说，掌握自定义插件的创建和...
Maven常用插件整理.docx
06-19
本文将详细介绍Maven中的常用插件及其功能。 1. Maven Assembly Plugin Maven Assembly 插件允许开发者将项目的输出，包括依赖、模块、网站文档和其他文档集成到一个单一的文档中，以便于定制打包。这个插件支持...
Maven 插件列表详解
栗筝i的博客
06-19 3511
Maven 是一个强大的项目管理和构建工具，广泛应用于 Java 项目中。作为一款优秀的构建管理工具，Maven 不仅提供了标准化的项目结构和依赖管理，还通过其丰富的插件系统，极大地扩展了其功能和灵活性。无论是代码编译、测试、打包，还是部署、报告生成，Maven 插件都扮演着不可或缺的角色。 本文将深入探讨 Maven 的插件体系，详细介绍各类插件的用途、主要目标和适用的生命周期阶段。内容涵盖了 Maven 官方插件、被淘汰的插件、社区驱动的 MojoHaus 插件、国内外企业开发的非官方插件以及如何自定
Maven Surefire 插件简介
最新发布
疯一样的码农
11-26 1383
Maven Surefire 插件是 Maven 项目中运行单元测试的重要工具。通过使用此插件，可以确保在构建过程中运行单元测试，有助于保持代码质量并及早发现问题。本指南全面介绍了设置和使用 Maven Surefire 插件的方法，并提供了一个实际示例帮助您入门。掌握这些知识后，您可以有效地管理和运行 Maven 项目中的单元测试。
Maven之常用插件
lengdetianxia2010的专栏
04-02 275
1. maven-compiler-plugin    编译Java源码，设置编译的JDK版本&lt;plugin&gt;     &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;     &lt;artifactId&gt;maven-compiler-plugin&lt;/artifactId&gt; &lt;version...
Maven的常用插件
yy310585的博客
04-11 228
Maven的常用插件 编译器插件 通过编译器插件，我们可以配置使用的JDK的版本： 配置编译器插件：pom.xml配置片段 <!-- 配置maven的编译插件 --> <build> <plugins> <!--JDK编译插件 --> <plugin> <!--插件坐标 --> <groupId>org.apache.maven.plugins
maven常用插件
qq_43750656的博客
11-09 194
1.资源编译插件 maven项目在打包时默认只打包resources目录下的资源文件，如果某些资源文件放在了java目录下，不会将其打包。 在项目的pom.xml文件下添加如下内容 <resources> <!--将src/main/resources目录下的所有资源文件打包--> <resource> <directory>src/main/resources</directory> <includes>
常用Maven插件介绍（上）
yaowj2的专栏
01-13 2738
转自http://www.infoq.com/cn/news/2011/04/xxb-maven-7-plugin     我们都知道Maven本质上是一个插件框架，它的核心并不执行任何具体的构建任务，所有这些任务都交给插件来完成，例如编译源代码是由maven-compiler-plugin完成的。进一步说，每个任务对应了一个插件目标（goal），每个插件会有一个或者多个目标，例如maven
Maven 常用插件
qq_38074398的博客
12-15 1025
Maven 常用插件
Maven打包带依赖
千里之行始于足下
06-14 6237
之前总是 打出的jar 不带依赖 然后 找半天 索性写在这里记下来 <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin...
Truststore Maven插件示例应用与项目构建
### 插件示例项目结构 从描述中，我们可以知道该示例项目有特定的结构，用来展示如何利用Truststore Maven插件进行以下操作： 1. **受托人**: 项目描述中提到的“受托人”可能是指“Truststore”，这表明有一个...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值