使用maven插件对java工程进行打包

现在基本上都是采用maven来进行开发管理，我有一个需求是需要把通过maven管理的java工程打成可执行的jar包，这样也就是说必需把工程依赖的jar包也一起打包。而使用maven默认的package命令构建的jar包中只包括了工程自身的class文件，并没有包括依赖的jar包。我们可以通过配置插件来对工程进行打包，pom具体配置如下：

maven-assembly-plugin

<plugin>
	<artifactId>maven-assembly-plugin</artifactId>
	<configuration>
		<appendAssemblyId>false</appendAssemblyId>
		<descriptorRefs>
			<descriptorRef>jar-with-dependencies</descriptorRef>
		</descriptorRefs>
		<archive>
			<manifest>
				<mainClass>com.chenzhou.examples.Main</mainClass>
			</manifest>
		</archive>
	</configuration>
	<executions>
		<execution>
			<id>make-assembly</id>
			<phase>package</phase>
			<goals>
				<goal>assembly</goal>
			</goals>
		</execution>
	</executions>
</plugin>

 

其中<mainClass></mainClass>的值表示此工程的入口类，也就是包含main方法的类，在我的例子中就是com.chenzhou.examples.Main。配置完pom后可以通过执行mvn assembly:assembly命令来启动插件进行构建。构建成功后会生成jar包，这样我们就可以在命令行中通过java -jar XXX.jar来运行jar件了。 

 

不过使用此插件会有一些问题：我在工程中依赖了spring框架的jar包，我打包成功后使用命令来调用jar包时报错如下（内网环境）：

 

org.xml.sax.SAXParseException: schema_reference.4: Failed to read schema document 'http://www.springframework.org/schema/beans/spring-beans-3.0.xsd', because 1) could not find the document; 2) the document could not be read; 3) the root element of the document is not <xsd:schema>.

关于此问题报错的原因，我在网上找到一篇文章对此有比较详细的解释：http://blog.csdn.net/bluishglc/article/details/7596118 简单来说就是spring在启动时会加载xsd文件，它首先会到本地查找xsd文件（一般都会包含在spring的jar包中），如果找不到则会到xml头部定义的url指定路径下中去寻找xsd，如果找不到则会报错。

附：在spring jar包下的META-INF文件夹中都会包含一个spring.schemas文件，其中就包含了对xsd文件的路径定义，具体如下图所示：

图：spring-aop.jar包下META-INF文件夹下的内容

图：spring.schemas文件内容

由于我的工程是在内网，所以通过url路径去寻找肯定是找不到的，但是比较奇怪的是既然spring的jar包中都会包含，那为什么还是找不到呢？

  原来这是assembly插件的一个bug，具体情况参见：http://jira.codehaus.org/browse/MASSEMBLY-360

该bug产生的原因如下：工程一般依赖了很多的jar包，而被依赖的jar又会依赖其他的jar包，这样，当工程中依赖到不同的版本的spring时，在使用assembly进行打包时，只能将某一个版本jar包下的spring.schemas文件放入最终打出的jar包里，这就有可能遗漏了一些版本的xsd的本地映射，所以会报错。

所以一般推荐使用另外的一个插件来进行打包，插件名称为：maven-shade-plugin，shade插件打包时在对spring.schemas文件处理上，它能够将所有jar里的spring.schemas文件进行合并，在最终生成的单一jar包里，spring.schemas包含了所有出现过的版本的集合，要使用shade插件，必须在pom进行如下配置：

 

<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.AppendingTransformer">
						<resource>META-INF/spring.handlers</resource>
					</transformer>
					<transformer
						implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
						<mainClass>com.chenzhou.examples.Main</mainClass>
					</transformer>
					<transformer
						implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
						<resource>META-INF/spring.schemas</resource>
					</transformer>
				</transformers>
			</configuration>
		</execution>
	</executions>
</plugin>

上面配置文件中有一段定义：

 

<transformer
	implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
	<resource>META-INF/spring.schemas</resource>
</transformer>

  上面这段配置意思是把spring.handlers和spring.schemas文件以append方式加入到构建的jar包中，这样就不会存在出现xsd找不到的情况。

配置完pom后，调用mvn clean install命令进行构建，构建成功后打开工程target目录，发现生成了2个jar包，一个为：original-XXX-0.0.1-SNAPSHOT.jar，另一个为：XXX-0.0.1-SNAPSHOT.jar，其中original...jar里只包含了工程自己的class文件，而另外的一个jar包则包含了工程本身以及所有依赖的jar包的class文件。我们只需要使用第二个jar包就可以了。

参考资料：

http://hi.baidu.com/yuzhi2217/item/2c1714363f25c4f62684f442

http://blog.csdn.net/bluishglc/article/details/7596118

http://jira.codehaus.org/browse/MASSEMBLY-360

 

评论

3 楼 evilseed 2014-09-01  

网上找了好多资料.都不是我遇到的问题.
基本上都说是缺少相应的jar包啊什么的.
原来你这个才是正解.
找了好久.终于看到了正解.
专门登录上来感谢一下.

2 楼 chenzhou123520 2014-04-02  

eddie_520 写道

我用你这种方法，打了jar包，可是还会出现Exception in thread "main" org.springframework.beans.factory.parsing.BeanDefinitionParsingException: Configuration problem: Unable to locate NamespaceHandler for namespace [http://www.springfr
amework.org/schema/context]的错误。
我查看我打包后的jar包内META-INF里的spring.schemas,spring.handlers,spring.factories里都有http\://www.springframework.org/schema/context=org.springframework.context.config.ContextNamespaceHandler的相关信息  包括
http\://www.springframework.org/schema/context/spring-context-3.2.xsd=org/springframework/context/config/spring-context-3.2.xsd等，可是执行就是出错，请给出点建议！谢谢~~~

不好意思，这几天没上iteye，刚刚才看到。你用的是maven-shade-plugin这个插件打包的么？

1 楼 eddie_520 2014-03-21  

我用你这种方法，打了jar包，可是还会出现Exception in thread "main" org.springframework.beans.factory.parsing.BeanDefinitionParsingException: Configuration problem: Unable to locate NamespaceHandler for namespace [http://www.springfr
amework.org/schema/context]的错误。
我查看我打包后的jar包内META-INF里的spring.schemas,spring.handlers,spring.factories里都有http\://www.springframework.org/schema/context=org.springframework.context.config.ContextNamespaceHandler的相关信息  包括
http\://www.springframework.org/schema/context/spring-context-3.2.xsd=org/springframework/context/config/spring-context-3.2.xsd等，可是执行就是出错，请给出点建议！谢谢~~~