Maven将代码及依赖打成一个Jar包的方式

时间 2019-12-08

标签 maven 代码依赖打成一个 jar 方式栏目 Maven 繁體版

原文原文链接

Maven可使用mvn package指令对项目进行打包，若是使用java -jar xxx.jar执行运行jar文件，会出现"no main manifest attribute, in xxx.jar"（没有设置Main-Class）、ClassNotFoundException（找不到依赖包）等错误。 html

要想jar包能直接经过java -jar xxx.jar运行，须要知足： java

一、在jar包中的META-INF/MANIFEST.MF中指定Main-Class，这样才能肯定程序的入口在哪里； git

二、要能加载到依赖包。 github

使用Maven有如下几种方法能够生成能直接运行的jar包而且是打成一个jar包，能够根据须要选择一种合适的方法。spring

方法一：使用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（在eclipse中执行maven build…… ，而后在Goals中输入 assembly:single）express

打包后会在target目录下生成一个xxx-jar-with-dependencies.jar文件，这个文件不但包含了本身项目中的代码和资源，还包含了全部依赖包的内容。因此能够直接经过java -jar来运行。 apache

此外还能够直接经过mvn package来打包（在eclipse中直接执行maven install），无需assembly:single，不过须要加上一些配置：app

<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>eclipse
  
  
  
  
  
   
   
   
   
    <!-- 这个jar-with-dependencies是assembly预先写好的一个，组装描述引用 -->maven
  
  
  
  
  
					<descriptorRef>jar-with-dependencies</descriptorRef>
				</descriptorRefs>
 <!--工程名--> 
                                        <finalName>${project.name}</finalName>
			</configuration>
			<executions>
				<execution>
					<id>make-assembly</id>
					<phase>package</phase>
					<goals>
						<goal>single</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
 
	</plugins>
</build>

其中<phase>package</phase>、<goal>single</goal>即表示在执行package打包时，执行assembly:single，因此能够直接使用mvn package打包。

不过，若是项目中用到Spring Framework，用这种方式打出来的包运行时会出错，使用下面的方法二能够处理。

方法二：使用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>

方法三：使用maven-jar-plugin和maven-dependency-plugin插件打包

原理是经过修改maven 打jar包的maven-jar-plugin插件的配置信息来生成咱们须要的指定依赖的可执行jar包。

在项目的pom.xml文件中修改默认的jar插件

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>2.3.1</version>
            <configuration>
                <archive>
                    <manifest>
                        <!--运行jar包时运行的主类，要求类全名-->
                        <mainClass>com.hafiz.Runner</mainClass>
                        <!-- 是否指定项目classpath下的依赖 -->
                        <addClasspath>true</addClasspath>
                        <!-- 指定依赖的时候声明前缀 -->
                        <classpathPrefix>./lib/</classpathPrefix>
                        <!--依赖是否使用带有时间戳的惟一版本号,如:xxx-1.3.0-20121225.012733.jar-->
                        <useUniqueVersions>false</useUniqueVersions>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>
<!--接着咱们还要配置maven的maven-dependency-plugin插件把当前项目的全部依赖放到target目录下的lib文件夹下-->
<plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-dependency-plugin</artifactId>
   <executions>
      <execution>
        <id>copy</id>
        <phase>package</phase>
        <goals>
           <goal>copy-dependencies</goal>
        </goals>
        <configuration>
           <outputDirectory>${project.build.directory}/lib</outputDirectory>
        </configuration>
     </execution>
   </executions>
</plugin>

其中，${project.build.directory}表示默认的target文件夹。

咱们经过上文的修改便完成了适用maven生成指定依赖的可执行jar包。

咱们发现生成的manifest文件中已经设置好了Main-Class以及Class-Path，以下：

若是<addClasspath>设置为false,则生成的manifest文件中不会声明依赖(即不会有Class-Path声明)

程序主类以下：

package com.hafiz;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
/**
 * Desc:主类
 * Created by hafiz.zhang on 2018/4/07.
 */
public class Runner {
    public static void main(String[] args) {
        ApplicationContext context 
　　　　　　　　= new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
        System.out.println("context:" + context.getClass());
        System.out.println("The Main Class Is Running....");
    }
}

pom.xml文件以下：

<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.hafiz</groupId>
    <artifactId>assembly-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>assembly-demo</name>
    <url>http://maven.apache.org</url>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <spring.version>4.2.6.RELEASE</spring.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-expression</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.2</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.3.1</version>
                <configuration>
                    <archive>
                        <manifest>
                            <!--运行jar包时运行的主类，要求类全名-->
                            <mainClass>com.hafiz.Runner</mainClass>
                            <!-- 是否指定项目classpath下的依赖 -->
                            <addClasspath>true</addClasspath>
                            <!-- 指定依赖的时候声明前缀 -->
                            <classpathPrefix>./lib/</classpathPrefix>
                            <!--依赖是否使用带有时间戳的惟一版本号,如:xxx-1.3.0-20121225.012733.jar-->
                            <useUniqueVersions>false</useUniqueVersions>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
            <!--把当前项目全部的依赖打包到target目录下的lib文件夹下-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <id>copy</id>
                        <phase>package</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${project.build.directory}/lib</outputDirectory>
                            <!--已存在的Release版本不重复copy-->
                            <overWriteReleases>false</overWriteReleases>
                            <!--已存在的SnapShot版本不重复copy-->
                            <overWriteSnapshots>false</overWriteSnapshots>
                            <!--不存在或者有更新版本的依赖才copy-->
                            <overWriteIfNewer>true</overWriteIfNewer>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

咱们如今进入生成的jar包所在的文件夹下，使用 java -jar xxx.jar来执行生成的jar包

到此咱们就完成了如何使用maven的jar包生成插件来进行生成指定依赖的可执行jar包。

代码Github地址：https://github.com/hafizzhang/assembly-demo.git

参考网址：

http://www.javashuo.com/article/p-usxjyaer-mw.html

http://www.cnblogs.com/hafiz/p/6538107.html

http://www.javashuo.com/article/p-qszbvohu-dx.html