Maven生成可以直接运行的jar包
- 常规打包的现象
- 生成可以直接运行的jar包的方法
- 方法一：使用maven-jar-plugin和maven-dependency-plugin插件打包
- 方法二：使用maven-assembly-plugin插件打包
- 方法三：使用maven-shade-plugin插件打包
常规打包的现象
Maven可以使用mvn package指令对项目进行打包，如果使用java -jar xxx.jar执行运行jar文件，会出现"no main manifest attribute, in xxx.jar"（没有设置Main-Class）、ClassNotFoundException（找不到依赖包）等错误。
要想jar包能直接通过java -jar xxx.jar运行，需要满足：
1、在jar包中的META-INF/MANIFEST.MF中指定Main-Class，这样才能确定程序的入口在哪里；
2、要能加载到依赖包。
生成可以直接运行的jar包的方法
使用Maven有以下几种方法可以生成能直接运行的jar包，可以根据需要选择一种合适的方法。
方法一：使用maven-jar-plugin和maven-dependency-plugin插件打包
在pom.xml中配置：
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.6</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<classpathPrefix>lib/</classpathPrefix>
<mainClass>com.xxg.Main</mainClass>
</manifest>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<version>2.10</version>
<executions>
<execution>
<id>copy-dependencies</id>
<phase>package</phase>
<goals>
<goal>copy-dependencies</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/lib</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>maven-jar-plugin用于生成META-INF/MANIFEST.MF文件的部分内容，com.xxg.Main指定MANIFEST.MF中的Main-Class，true会在MANIFEST.MF加上Class-Path项并配置依赖包，lib/指定依赖包所在目录。
例如下面是一个通过maven-jar-plugin插件生成的MANIFEST.MF文件片段：
Class-Path: lib/commons-logging-1.2.jar lib/commons-io-2.4.jar
Main-Class: com.xxg.Main
只是生成MANIFEST.MF文件还不够，maven-dependency-plugin插件用于将依赖包拷贝到${project.build.directory}/lib指定的位置，即lib目录下。
配置完成后，通过mvn package指令打包，会在target目录下生成jar包，并将依赖包拷贝到target/lib目录下，目录结构如下：
指定了Main-Class，有了依赖包，那么就可以直接通过java -jar xxx.jar运行jar包。
这种方式生成jar包有个缺点，就是生成的jar包太多不便于管理，下面两种方式只生成一个jar文件，包含项目本身的代码、资源以及所有的依赖包。
方法二：使用maven-assembly-plugin插件打包
在pom.xml中配置：
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.5.5</version>
<configuration>
<archive>
<manifest>
<mainClass>com.xxg.Main</mainClass>
</manifest>
</archive>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
</plugin>
</plugins>
</build>打包方式：
mvn package assembly:single
打包后会在target目录下生成一个xxx-jar-with-dependencies.jar文件，这个文件不但包含了自己项目中的代码和资源，还包含了所有依赖包的内容。所以可以直接通过java -jar来运行。
此外还可以直接通过mvn package来打包，无需assembly:single，不过需要加上一些配置：
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.5.5</version>
<configuration>
<archive>
<manifest>
<mainClass>com.xxg.Main</mainClass>
</manifest>
</archive>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>其中package、single即表示在执行package打包时，执行assembly:single，所以可以直接使用mvn package打包。
不过使用此插件会有一些问题：我在工程中依赖了 spring 框架的 jar 包，我打包成功后使用命令来调用 jar 包时报错如下（内网环境）：
Shell代码
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.
关于此问题报错的原因，我在网上找到一篇文章对此有比较详细的解释： 简单来说就是 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插件打包
在pom.xml中配置：
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>2.4.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>com.xxg.Main</mainClass>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>配置完成后，执行mvn package即可打包。在target目录下会生成两个jar包，注意不是original-xxx.jar文件，而是另外一个。和maven-assembly-plugin一样，生成的jar文件包含了所有依赖，所以可以直接运行。
如果项目中用到了Spring Framework，将依赖打到一个jar包中，运行时会出现读取XML schema文件出错。原因是Spring Framework的多个jar包中包含相同的文件spring.handlers和spring.schemas，如果生成一个jar包会互相覆盖。为了避免互相影响，可以使用AppendingTransformer来对文件内容追加合并：
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>2.4.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>com.xxg.Main</mainClass>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.handlers</resource>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.schemas</resource>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
