Maven 生成打包可执行jar包

分手后的思念是犯贱 2021-06-10 20:38 576阅读 0赞

最近IDEA打可执行Jar包搞了三天，一直失败，好好学习一下Maven-assembly，在此记录一下

## 1. 需求 ##

项目打包，满足以下要求：

1.  整个项目打一个Zip包下面包括应用程序、应用程序依赖的jar包、说明文档
2.  项目打的jar包可以执行不同类里的Main函数
3.  项目源码打的jar包要与依赖的第三方jar包分开
4.  项目里的执行脚本也要一块打包并进行分类
5.  document目录下的readme.txt放在压缩包的根目录下,其他的还放在这个目录下
6.  打的jar包去掉不需要的目录(文件)

## 2. 开发环境 ##

IDEA-2016 Maven3.3.9  
项目的目录结构：

![70][]

## 3. Maven打包插件介绍 ##

assembly翻译过来就是组装、装配的意思  
Maven对项目打包常用的打包插件有三种，分别是：

<table> 
 <thead> 
  <tr> 
   <th>插件</th> 
   <th>功能</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>maven-jar-plugin</td> 
   <td>maven 默认打包插件，用来创建 project jar</td> 
  </tr> 
  <tr> 
   <td>maven-shade-plugin</td> 
   <td>打可执行包，executable(fat) jar</td> 
  </tr> 
  <tr> 
   <td>maven-assembly-plugin</td> 
   <td>支持自定义打包方式</td> 
  </tr> 
 </tbody> 
</table>

这里使用maven-jar-plugin和maven-assembly-plugin  
项目目录：

每次找jar包之前先clean一下，不然的话IDEA会认为你的项目没有修改而不重新加载

另：配置文件的注释已经很详细了，这里就不另外再说明了

## 4. Maven使用maven-jar-plugin打可执行jar包 ##

主要配置如下：

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <version>2.4</version>
        
        <configuration>
            
            <archive>
                
                <addMavenDescriptor>false</addMavenDescriptor>
    
                
                <manifest>
                    
                    <addClasspath>true</addClasspath>
                    
                    
                    <classpathPrefix>lib/</classpathPrefix>
                </manifest>
            </archive>
            
            <excludes>
                
                <exclude>**/assembly/</exclude>
            </excludes>
        </configuration>
    </plugin>

完整配置见底部

## 5. Maven使用maven-assembly-plugin装需要打包的文件打进zip包 ##

pom.xml下的主要配置如下：

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-assembly-plugin</artifactId>
        <version>2.4</version>
        
        <configuration>
            
            <descriptors>
                <descriptor>src/main/resources/assembly/package.xml</descriptor>
            </descriptors>
        </configuration>
        <executions>
            <execution>
                <id>make-assembly</id>
                
                <phase>package</phase>
                <goals>
                    
                    <goal>single</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

assembly插件的配置文件package.xml见底部

## 6. Maven生成可执行jar包及zip项目压缩包 ##

双击执行mvn:package会生成两个包：可执行jar包和项目压缩包，因为assembly的装配配置的是绑定到这上面来的  
双击执行assembly:single只生成项目压缩包

![02\_Maven打可执行jar包和项目压缩包.jpg][02_Maven_jar_.jpg]

这里执行mvn:package

![03\_Maven生成的可执行jar包和项目压缩包.jpg][03_Maven_jar_.jpg]

解压后的项目压缩包目录结构：

![04\_解压后的项目压缩包目录结构.jpg][04_.jpg]

## 7. 执行jar包 ##

解压缩生成的项目包  
TestString的源码：

public class TestString {
        public static void main(String[] args) {
            String[] arr = new String[]{"aaa", "bbb", "ccc", "DDD", "EEE", "FFF"};
            System.out.println(StringUtils.join(arr, "---"));
        }
    }

TestNumber的源码：

public class TestNumber {
        public static void main(String[] args) {
            Integer[] arr = new Integer[]{11, 22, 33, 44, 55, 66};
            System.out.println(StringUtils.join(arr, "---"));
        }
    }

命令行运行生成的jar

java -classpath dong.jar com.dong.bigdata.TestString
    java -classpath dong.jar com.dong.bigdata.TestNumber

运行结果：

![运行可执行jar包.jpg][jar_.jpg]

## 8. pom.xml配置 ##

包含两个文件：  
pom.xml整体的配置  
package.xml包含在pom.xml中，用于指定assembly装配时的配置

pom.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
    <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.dong</groupId>
        
        <artifactId>bigdata</artifactId>
        
        <packaging>jar</packaging>
        
        <version>1.0-SNAPSHOT</version>
    
        
        
        <name>bigdata</name>
        
        <url>http://http://www.dong.com/.com</url>
    
        
        <properties>
            
            <project.script.execute.directory>src/main/scripts/execute</project.script.execute.directory>
            
            <project.document.directory>document</project.document.directory>
            
            <project.config.directory>src/main/resources</project.config.directory>
            
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    
            
            <maven.compiler.source>1.8</maven.compiler.source>
            
            <maven.compiler.target>1.8</maven.compiler.target>
        </properties>
    
        
        <repositories>
            
            <repository>
                <id>aliyun</id>
                <url>http://maven.aliyun.com/nexus/content/groups/public</url>
            </repository>
            
            <repository>
                <id>repo2</id>
                <url>http://repo2.maven.org/maven2/</url>
            </repository>
    
            
            <repository>
                <id>cloudera</id>
                <url>https://repository.cloudera.com/artifactory/cloudera-repos/</url>
            </repository>
    
            
            <repository>
                <id>scala-tools.org</id>
                <name>Scala-Tools Maven2 Repository</name>
                <url>http://scala-tools.org/repo-releases</url>
            </repository>
        </repositories>
    
        <dependencies>
            
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-lang3</artifactId>
                <version>3.4</version>
            </dependency>
        </dependencies>
    
        <build>
            <finalName>dong</finalName>
            <plugins>
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-jar-plugin</artifactId>
                    <version>2.4</version>
                    
                    <configuration>
                        
                        <archive>
                            
                            <addMavenDescriptor>false</addMavenDescriptor>
    
                            
                            <manifest>
                                
                                <addClasspath>true</addClasspath>
    
                                
                                <classpathPrefix>lib/</classpathPrefix>
                            </manifest>
                        </archive>
                        
                        <excludes>
                            
                            <exclude>**/assembly/</exclude>
                        </excludes>
                    </configuration>
                </plugin>
    
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-assembly-plugin</artifactId>
                    <version>2.4</version>
                    
                    <configuration>
                        
                        <descriptors>
                            <descriptor>src/main/resources/assembly/package.xml</descriptor>
                        </descriptors>
                    </configuration>
                    <executions>
                        <execution>
                            <id>make-assembly</id>
                            
                            
                            <goals>
                                
                                <goal>single</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    </project>

## 9. package.xml文件 ##

<?xml version="1.0" encoding="UTF-8"?>
    <assembly>
        <id>full</id>
        
        <formats>
            <format>zip</format>
        </formats>
    
        
        <dependencySets>
            <dependencySet>
                
                <useProjectArtifact>false</useProjectArtifact>
    
                
                
                
                <outputDirectory>lib</outputDirectory>
    
                
                
            </dependencySet>
        </dependencySets>
    
        
        <fileSets>
            
            <fileSet>
                <directory>${project.build.directory}</directory>
                <outputDirectory></outputDirectory>
                <includes>
                    <include>*.jar</include>
                </includes>
            </fileSet>
    
            
            <fileSet>
                <directoryl>${projet.document.directory}</directoryl>
                <outputDirectory></outputDirectory>
                <includes>
                    <include>readme.*</include>
                </includes>
            </fileSet>
    
            
            <fileSet>
                <directory>${project.document.directory}</directory>
                <outputDirectory>document</outputDirectory>
                <excludes>
                    <exclude>readme.*</exclude>
                </excludes>
            </fileSet>
    
            
            <fileSet>
                <directory>${project.script.execute.directory}</directory>
                <outputDirectory></outputDirectory>
                <includes>
                    <include>*</include>
                </includes>
            </fileSet>
    
        </fileSets>
    </assembly>

[70]: /images/20210527/83a12553f13342c1be84dd3155425a61.png
[02_Maven_jar_.jpg]: /images/20210527/e0b13e4e0c8f4bd4a089c92eb59ec744.png
[03_Maven_jar_.jpg]: /images/20210527/afdf838be01b4b25824e6802b0a57e0a.png
[04_.jpg]: /images/20210527/db73d9ef0a84476787b961bbe33ef0d1.png
[jar_.jpg]: /images/20210527/bc60f878ece140ffa1c539f88e002d3d.png