maven 打包排除指定文件

maven 打包排除指定文件

2015-10-16 13:57  3197人阅读  评论(0)  收藏  举报

  分类：

maven（16） 

记一次我对maven深刻变革的认知。

当我还不知道Maven本质上其实只是一个插件框架，当我还不知道maven有生命周期的概念，不知道maven的生命周期是抽象的，更不知道maven的每一个构建任务是如何工作的（比如编译、打包）。maven的使用对我来说真是有不少痛苦和折磨。

项目中我把常用的工具类给集中到个项目里了，这样方便其它项目共用和工具类的独立，可是我的工具类项目也要进行测试，测试的时候也要打印日志，就使用了log4j.properties进行debug日志查看。此时使用maven打包时，总是把log4j.properties给打到jar包里。导致其它项目在日志打印方面不方便管理 。于是踏上了寻找maven打包排除指定文件的方法，而这个时候我对maven的生命周期、阶段、插件、目标知道的了了无几，经过波折，才发现了通往光明的最佳道路，那就是必须了解mavenr的生命周期、阶段、插件、目标是什么，它们之间有什么关系，而我在哪里可以得到这样的帮助。

生命周期：

Maven有三套相互独立的生命周期，Clean Lifecycle 在进行真正的构建之前进行一些清理工作，Default Lifecycle 构建的核心部分，编译，测试，打包，部署等等，Site Lifecycle 生成项目报告，站点，发布站点。其中每个生命周期又分n个阶段.

阶段(phase)：

每套生命周期都由一组阶段(Phase)组成，我们平时在命令行输入的命令总会对应于一个特定的阶段。比如，运行mvn package，这个的package是Defalut生命周期的一个阶段。

Clean生命周期一共包含了三个阶段：

pre-clean  执行一些需要在clean之前完成的工作，

clean  移除所有上一次构建生成的文件，

post-clean  执行一些需要在clean之后立刻完成的工作

Site生命周期的各个阶段：

pre-site     执行一些需要在生成站点文档之前完成的工作

site    生成项目的站点文档

post-site     执行一些需要在生成站点文档之后完成的工作，并且为部署做准备

site-deploy     将生成的站点文档部署到特定的服务器上

最重要的Default生命周期

validate

generate-sources

process-sources

generate-resources

process-resources     复制并处理资源文件，至目标目录，准备打包。

compile     编译项目的源代码。

process-classes

generate-test-sources

process-test-sources

generate-test-resources

process-test-resources     复制并处理资源文件，至目标测试目录。

test-compile     编译测试源代码

process-test-classes

test     使用合适的单元测试框架运行测试。这些测试代码不会被打包或部署。

prepare-package

package     接受编译好的代码，打包成可发布的格式，如 JAR 。

pre-integration-test

integration-test

post-integration-test

verify

install     将包安装至本地仓库，以让其它项目依赖。

deploy     将最终的包复制到远程的仓库，以让其它开发人员与项目共享。

基本上，根据名称我们就能猜出每个阶段的用途，关于其它阶段的解释，请参: http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html

请记住maven的生命周期是抽像的，phase也是，通过phase和插件的target进行绑定，phase才有意义，比如:default的生命周期的compile phase和插件maven-compiler-plugin的compile目标（goal）进行绑定就可以完代码在编译phase做编译task。

插件和插件目标：

maven的核心仅仅定定义了抽像的生命周期，具体的任务都是交给插件完在的，插件以独立的构件形式存在，对于插件本身为了能够复用代码，往往能够完成多个任务，例如：maven-dependency-plugin能够基于项目依赖做很多事情，它能够分析项目依赖，帮助找出无用的依赖，列出项目的依赖树，和依赖之间的冲突。因此这些功能聚集在一块叫插件。每个功能就叫插件目标。

插件绑定：

maven的生命周期与插件相互绑定，用以完成实际的构建任务，具体而言是生命周期的阶段（phase)和插件的目标（target）相互绑定，以完成某个具体的构建任务，内置绑定：为了能让用户几乎不用任何配就能构建maven项目，maven在核心为一些生命周期阶段绑定了很多插件的目标，当用户通过命令行调用生命周期阶段的时候，对应的插件目标就会执行相应的任务，clean生命周期权有pre-clean、clean、post-clena三个阶段，其中的clean与maven-clean-plugin：clean绑定，maven-clean-plugin仅有clean这一个目标，其作用就是删除项目的输出目录，具体的参考请查看官网。

自定义绑定：

	 <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <id>copy</id>
                        <phase>install</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>
                              ${project.build.directory}/lib
                            </outputDirectory>
                        </configuration>
                    </execution>
                </executions>
            </plugin>


在声明插件的时候增加 <phase>install</phase>就可以将插件目标绑定的这个生命周期了，当这个生命周期执行的进修，插件目标就会被执行。

其中configuration是为这个插件目标配置的属性。配置属性可以在execution下面也可以直接在plugin下面配置。





言回本文，通过上面简单了解，我知道要现在应该是package的阶段执行了org.apache.maven.plugins:maven-jar-plugin插件的jar目标，所以我们应该在这个插件上配置一些属性就可以了，打开官网的插件介绍，我们找到jar这一项点进去。

http://maven.apache.org/plugins/

http://maven.apache.org/plugins/maven-jar-plugin/jar-mojo.html

发现jar目标有excludes属生，这样我们在我们工具类项目中加入以下插件配置(注意：maven-jar-plugin打包的默认认已经排除"**/package.html")，打包的时候就不会把properties打到jar包里了：
<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-jar-plugin</artifactId>
	<version>2.4</version>
	<configuration>
		<excludes>
			<exclude>**/*.properties</exclude>
		</excludes>
	</configuration
</plugin>





用户可以通过两种方式调用Maven插件目标。第一种方式是将插件目标与生命周期阶段（lifecycle phase）绑定，这样用户在命令行只是输入生命周期阶段而已，例如Maven默认将maven-compiler-plugin的compile目标与compile生命周期阶段绑定，因此命令mvn
 compile实际上是先定位到compile这一生命周期阶段，然后再根据绑定关系调用maven-compiler-plugin的compile目标。第二种方式是直接在命令行指定要执行的插件目标，例如mvn
 archetype:generate 就表示调用maven-archetype-plugin的generate目标，这种带冒号的调用方式与生命周期无关。





本文通过一个小小的例子引出maven的插件和插件目标，相信明白了这些以后，在使用maven的打包的时候，很多问题就不会像无头苍蝇不知道怎么下手了.

参考如下：

http://juvenshun.iteye.com/blog/213959

http://www.infoq.com/cn/news/2011/04/xxb-maven-7-plugin

http://www.ibm.com/developerworks/cn/java/j-5things13/