Maven - 打包可执行jar包

• 打包方法

  • 方法一：使用maven-jar-plugin和maven-dependency-plugin

  • 方法二：使用maven-assembly-plugin (推荐)

  • 方法三：使用maven-shade-plugin

  • 方法四：使用onejar-maven-plugin

  • 方法五：使用spring-boot-maven-plugin

  • 方法六：使用tomcat7-maven-plugin

• 参考

打包方法

方法一：使用maven-jar-plugin和maven-dependency-plugin

首先，maven-jar-plugin的作用是配置mainClass和指定classpath。

    org.apache.maven.plugins
    maven-jar-plugin
    
        
            
                true
                libs/
                
                    org.baeldung.executable.ExecutableMavenJar
                
            
        
    

addClasspath: 是否在manifest文件中添加classpath。默认为false。如果为true，则会在manifest文件中添加classpath，这样在启动的时候就不用再手动指定classpath了。如下所示，文件中增加了Class-Path一行

Manifest-Version: 1.0                                                                                                                                         
Archiver-Version: Plexus Archiver
Built-By: michealyang
Class-Path: libs/jetty-server-9.4.7.v20170914.jar lib/javax.servlet-api
 -3.1.0.jar libs/jetty-http-9.4.7.v20170914.jar 
Created-By: Apache Maven 3.3.9
Build-Jdk: 1.8.0_162-ea
Main-Class: com.michealyang.jetty.embeded.EmbeddedJettyServer

classpathPrefix: classpath的前缀。如上面的manifest文件中，Class-Path的值中，每个jar包的前缀都是libs/。本质上，这个配置的值是所依赖jar包所在的文件夹。配置正确了才能找到依赖
mainClass: 指定启动时的Main Class

其次，maven-dependency-plugin会把所依赖的jar包copy到指定目录

    org.apache.maven.plugins
    maven-dependency-plugin
    
        
            copy-dependencies
            prepare-package
            
                copy-dependencies
            
            
                
                    ${project.build.directory}/libs
                
            
        
    

executions中的配置都很重要，按照上面的配置来就行了。outputDirectory指定了要将所依赖的jar包copy到哪个目录。要与maven-jar-plugin中的classpathPrefix一致。

执行如下命令，即可打包：

mvn package

打包结果是，自己写的Class在jar包中，所依赖的jar包在libs目录中:

├── embedded-jetty-1.0.0-SNAPSHOT.jar
├── lib
│ ├── jetty-server-9.4.7.v20170914.jar
│ ├── jetty-http-9.4.7.v20170914.jar

执行如下命令即可启动jar包：

java -jar embedded-jetty-1.0.0-SNAPSHOT.jar

优点
有诸多配置项，很自由，每个步骤都可控

缺点
打成的最终jar包中没有所依赖的jar包。依赖跟自己的代码不在一个jar包中。部署或者移动的时候，要考虑到多个文件，比较麻烦

方法二：使用maven-assembly-plugin (推荐)

maven-assembly-plugin可以将所有的东西都打包到一个jar包中。

    org.apache.maven.plugins
    maven-assembly-plugin
    
        
            package
            
                single
            
            
                
                
                    
                        com.michealyang.jetty.embeded.EmbeddedJettyServer
                    
                
                
                
                    jar-with-dependencies
                
            
        
    

执行mvn package后，会在target文件夹下生成两个jar包，一个是不带依赖的jar包，一个是后缀有-dependencies带有依赖的jar包，如：

May 31 16:42 embedded-jetty-1.0.0-SNAPSHOT-jar-with-dependencies.jar
May 31 16:42 embedded-jetty-1.0.0-SNAPSHOT.jar

启动时，直接执行即可：

java -jar embedded-jetty-1.0.0-SNAPSHOT-jar-with-dependencies.jar

优点
所有的东西都打到一个jar包中，很方便
缺点
配置项少，不自由。

方法三：使用maven-shade-plugin

跟maven-assembly-plugin类似，都可以将所有的东西都打包到一个jar包中。

    org.apache.maven.plugins
    maven-shade-plugin
    
        
            
                shade
            
            
                true
                
                    
                        com.michealyang.jetty.embeded.EmbeddedJettyServer
                
            
        
        
    

执行mvn package后，会在target文件夹下生成两个jar包，一个是不带依赖的jar包，一个是后缀有-shaded带有依赖的jar包，如：

May 31 16:53 embedded-jetty-1.0.0-SNAPSHOT-shaded.jar
May 31 16:53 embedded-jetty-1.0.0-SNAPSHOT.jar

启动时，直接执行即可：

java -jar embedded-jetty-1.0.0-SNAPSHOT-jar-with-shaded.jar

优点
功能同maven-assembly-plugin，但比前者强大
缺点
配置起来太麻烦。当你需要高级功能的时候，更是麻烦的不要不要的。

方法四：使用onejar-maven-plugin

This provides custom classloader that knows how to load classes and resources from jars inside an archive, instead of from jars in the filesystem.

    com.jolira
    onejar-maven-plugin
    
        
            
                org.baeldung.executable.
                  ExecutableMavenJar
                true
                
                  ${project.build.finalName}.${project.packaging}
                
            
            
                one-jar
            
        
    

优点
clean delegation model, allows classes to be at the top-level of the One Jar, supports external jars and can support Native libraries
缺点
not actively supported since 2012

方法五：使用spring-boot-maven-plugin

能同时打可执行jar包和war包
This allows to package executable jar or war archives and run an application “in-place”.

需要maven版本不低于3.2

    org.springframework.boot
    spring-boot-maven-plugin
    
        
            
                repackage
            
            
                spring-boot
                
                  org.baeldung.executable.ExecutableMavenJar
                
            
        
    

两个重点：

• goal要写成repackage
• classifier要写成spring-boot

优点
dependencies inside a jar file, you can run it in every accessible location, advanced control of packaging your artifact, with excluding dependencies from the jar file etc., packaging of war files as well

缺点
添加了一些不必要的Spring和Spring Boot依赖

方法六：使用tomcat7-maven-plugin

可打包成一个web工程类型的jar包。其实是内嵌了一个tomcat在里面。

    org.apache.tomcat.maven
    tomcat7-maven-plugin
    2.0
    
        
            tomcat-run
            
                exec-war-only
            
            package
            
                /
                false
                webapp.jar
                utf-8
            
        
    

The goal is set as exec-war-only, path to your server is specified inside configuration tag, with additional properties, like finalName, charset etc. To build a jar, run man package, which will result in creating webapp.jar in your target directory. To run

To run the application, just write this in your console: java -jar target/webapp.jar and try to test it by specifying the localhost:8080/ in a browser.

优点
只有一个jar包
缺点
打包出的文件很大。因为里面内嵌了一个tomcat

参考

How to Create an Executable JAR with Maven