Maven 生成打包可执行jar包

分手后的思念是犯贱 2021-06-10 20:38 645阅读 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对项目打包常用的打包插件有三种，分别是：






















插件 功能
maven-jar-plugin maven 默认打包插件，用来创建 project jar
maven-shade-plugin 打可执行包，executable(fat) jar
maven-assembly-plugin 支持自定义打包方式

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

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

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

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

主要配置如下：

  1. <plugin>
  2.     <groupId>org.apache.maven.plugins</groupId>
  3.     <artifactId>maven-jar-plugin</artifactId>
  4.     <version>2.4</version>
  5.     <!-- 对要打的jar包进行配置 -->
  6.     <configuration>
  7.         <!-- Configuration of the archiver -->
  8.         <archive>
  9.             <!--生成的jar中，不要包含pom.xml和pom.properties这两个文件-->
  10.             <addMavenDescriptor>false</addMavenDescriptor>
  12.             <!-- Manifest specific configuration -->
  13.             <manifest>
  14.                 <!--是否要把第三方jar放到manifest的classpath中-->
  15.                 <addClasspath>true</addClasspath>
  17.                 <!--生成的manifest中classpath的前缀，
  18.                 因为要把第三方jar放到lib目录下，
  19.                 所以classpath的前缀是lib/-->
  20.                 <classpathPrefix>lib/</classpathPrefix>
  21.             </manifest>
  22.         </archive>
  23.         <!--过滤掉不希望包含在jar中的文件-->
  24.         <excludes>
  25.             <!-- 排除不需要的文件夹(路径是jar包内部的路径) -->
  26.             <exclude>**/assembly/</exclude>
  27.         </excludes>
  28.     </configuration>
  29. </plugin>

完整配置见底部

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

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

  1. <plugin>
  2.     <groupId>org.apache.maven.plugins</groupId>
  3.     <artifactId>maven-assembly-plugin</artifactId>
  4.     <version>2.4</version>
  5.     <!-- 对项目的组装进行配置 -->
  6.     <configuration>
  7.         <!-- 指定assembly插件的配置文件所在位置 -->
  8.         <descriptors>
  9.             <descriptor>src/main/resources/assembly/package.xml</descriptor>
  10.         </descriptors>
  11.     </configuration>
  12.     <executions>
  13.         <execution>
  14.             <id>make-assembly</id>
  15.             <!-- 将组装绑定到maven生命周期的哪一阶段 -->
  16.             <phase>package</phase>
  17.             <goals>
  18.                 <!-- 指定assembly插件的打包方式-->
  19.                 <goal>single</goal>
  20.             </goals>
  21.         </execution>
  22.     </executions>
  23. </plugin>

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

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

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

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

这里执行mvn:package

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

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

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

7. 执行jar包

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

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

TestNumber的源码：

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

命令行运行生成的jar

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

运行结果：

运行可执行jar包.jpg

8. pom.xml配置

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

pom.xml文件：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  6.     <!-- ####################### 基础设置 ###################### -->
  7.     <!--groupId:项目或者组织的唯一标志，并且配置时生成路径也是由此生成，如org.myproject.mojo生成的相对路径为：/org/myproject/mojo-->
  8.     <groupId>com.dong</groupId>
  9.     <!--项目的通用名称-->
  10.     <artifactId>bigdata</artifactId>
  11.     <!--打包机制，如pom,jar,maven-plugin,ejb,war,ear,rar,par-->
  12.     <packaging>jar</packaging>
  13.     <!--项目的版本-->
  14.     <version>1.0-SNAPSHOT</version>
  16.     <!-- ####################### 项目信息 ###################### -->
  17.     <!--用户描述项目的名称，无关紧要的东西-->
  18.     <name>bigdata</name>
  19.     <!--写明开发团队的网站，无关紧要-->
  20.     <url>http://http://www.dong.com/.com</url>
  22.     <!-- ####################### 环境设置 ###################### -->
  23.     <properties>
  24.         <!-- 项目执行脚本目录 -->
  25.         <project.script.execute.directory>src/main/scripts/execute</project.script.execute.directory>
  26.         <!-- 项目说明文档目录 -->
  27.         <project.document.directory>document</project.document.directory>
  28.         <!-- 项目配置文件目录 -->
  29.         <project.config.directory>src/main/resources</project.config.directory>
  30.         <!-- 项目编码 -->
  31.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  33.         <!-- 本地编译JDK版本 -->
  34.         <maven.compiler.source>1.8</maven.compiler.source>
  35.         <!-- 项目部署JDK版本 -->
  36.         <maven.compiler.target>1.8</maven.compiler.target>
  37.     </properties>
  39.     <!--
  40.      配置Maven的仓库, 在此处配置的仓库会优先于setting.xml里配置的仓库,
  41.      建议哪个仓库快,哪个配置在前面, 然后如果Maven在前面配置的仓库找不到的话会去后面的仓库找，
  42.      如果后面的仓库都找不到，会去setting.xml中央仓库里找
  43.       -->
  44.     <repositories>
  45.         <!-- 阿里云仓库,配置Maven仓库，速度快配置在最前面 -->
  46.         <repository>
  47.             <id>aliyun</id>
  48.             <url>http://maven.aliyun.com/nexus/content/groups/public</url>
  49.         </repository>
  50.         <!-- 国内备选仓库 -->
  51.         <repository>
  52.             <id>repo2</id>
  53.             <url>http://repo2.maven.org/maven2/</url>
  54.         </repository>
  56.         <!-- Cloudera仓库,如果在阿里云仓库里找不到去Cloudera的仓库里找，主要是CDH版本Hadoop依赖的jar -->
  57.         <repository>
  58.             <id>cloudera</id>
  59.             <url>https://repository.cloudera.com/artifactory/cloudera-repos/</url>
  60.         </repository>
  62.         <!-- Scala仓库,如果前面两个都找不到来仓库找，如果此仓库也找不到，去中央仓库找 -->
  63.         <repository>
  64.             <id>scala-tools.org</id>
  65.             <name>Scala-Tools Maven2 Repository</name>
  66.             <url>http://scala-tools.org/repo-releases</url>
  67.         </repository>
  68.     </repositories>
  70.     <dependencies>
  71.         <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
  72.         <dependency>
  73.             <groupId>org.apache.commons</groupId>
  74.             <artifactId>commons-lang3</artifactId>
  75.             <version>3.4</version>
  76.         </dependency>
  77.     </dependencies>
  79.     <build>
  80.         <finalName>dong</finalName>
  81.         <plugins>
  82.             <!-- The configuration of maven-jar-plugin -->
  83.             <plugin>
  84.                 <groupId>org.apache.maven.plugins</groupId>
  85.                 <artifactId>maven-jar-plugin</artifactId>
  86.                 <version>2.4</version>
  87.                 <!-- 对要打的jar包进行配置 -->
  88.                 <configuration>
  89.                     <!-- Configuration of the archiver -->
  90.                     <archive>
  91.                         <!--生成的jar中，不要包含pom.xml和pom.properties这两个文件-->
  92.                         <addMavenDescriptor>false</addMavenDescriptor>
  94.                         <!-- Manifest specific configuration -->
  95.                         <manifest>
  96.                             <!--是否要把第三方jar放到manifest的classpath中-->
  97.                             <addClasspath>true</addClasspath>
  99.                             <!--
  100.                             生成的manifest中classpath的前缀，
  101.                             因为要把第三方jar放到lib目录下，
  102.                             所以classpath的前缀是lib/
  103.                             -->
  104.                             <classpathPrefix>lib/</classpathPrefix>
  105.                         </manifest>
  106.                     </archive>
  107.                     <!--过滤掉不希望包含在jar中的文件-->
  108.                     <excludes>
  109.                         <!-- 排除不需要的文件夹(路径是jar包内部的路径) -->
  110.                         <exclude>**/assembly/</exclude>
  111.                     </excludes>
  112.                 </configuration>
  113.             </plugin>
  115.             <!-- The configuration of maven-assembly-plugin -->
  116.             <plugin>
  117.                 <groupId>org.apache.maven.plugins</groupId>
  118.                 <artifactId>maven-assembly-plugin</artifactId>
  119.                 <version>2.4</version>
  120.                 <!-- 对项目的组装进行配置 -->
  121.                 <configuration>
  122.                     <!-- 指定assembly插件的配置文件所在位置 -->
  123.                     <descriptors>
  124.                         <descriptor>src/main/resources/assembly/package.xml</descriptor>
  125.                     </descriptors>
  126.                 </configuration>
  127.                 <executions>
  128.                     <execution>
  129.                         <id>make-assembly</id>
  130.                         <!-- 将组装绑定到maven生命周期的哪一阶段 -->
  131.                         <!--<phase>package</phase>-->
  132.                         <goals>
  133.                             <!-- 指定assembly插件的打包方式-->
  134.                             <goal>single</goal>
  135.                         </goals>
  136.                     </execution>
  137.                 </executions>
  138.             </plugin>
  139.         </plugins>
  140.     </build>
  141. </project>

9. package.xml文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <assembly>
  3.     <id>full</id>
  4.     <!-- 最终打包成一个用于发布的zip文件 -->
  5.     <formats>
  6.         <format>zip</format>
  7.     </formats>
  9.     <!-- 把依赖jar包打包进Zip压缩文件的lib目录下 -->
  10.     <dependencySets>
  11.         <dependencySet>
  12.             <!--不使用项目的artifact，第三方jar不要解压，打包进zip文件的lib目录-->
  13.             <useProjectArtifact>false</useProjectArtifact>
  15.             <!-- 第三方jar打包进Zip文件的lib目录下， -->
  16.             <!-- 注意此目录要与maven-jar-plugin中classpathPrefix指定的目录相同, -->
  17.             <!-- 不然这些依赖的jar包加载到ClassPath的时候会找不到-->
  18.             <outputDirectory>lib</outputDirectory>
  20.             <!-- 第三方jar不要解压-->
  21.             <!--<unpack>false</unpack>-->
  22.         </dependencySet>
  23.     </dependencySets>
  25.     <!-- 文件设置，你想把哪些文件包含进去，或者把某些文件排除掉，都是在这里配置-->
  26.     <fileSets>
  27.         <!-- 把项目自己编译出来的可执行jar，打包进zip文件的根目录 -->
  28.         <fileSet>
  29.             <directory>${project.build.directory}</directory>
  30.             <outputDirectory></outputDirectory>
  31.             <includes>
  32.                 <include>*.jar</include>
  33.             </includes>
  34.         </fileSet>
  36.         <!--
  37.         把项目readme说明文档，打包进zip文件根目录下
  38.         (这里针对目录document/readme.txt文件)
  39.         ${projet.document.directory}是pom.xml中自己配置的
  40.          -->
  41.         <fileSet>
  42.             <directoryl>${projet.document.directory}</directoryl>
  43.             <outputDirectory></outputDirectory>
  44.             <includes>
  45.                 <include>readme.*</include>
  46.             </includes>
  47.         </fileSet>
  49.         <!--
  50.         把项目相关的说明文档(除了readme文档)，
  51.         打包进zip文件根目录下的document目录
  52.         (这里针对document/exclode.txt文件)
  53.         ${project.document.directory}是在pom.xml中自己配置的
  54.         -->
  55.         <fileSet>
  56.             <directory>${project.document.directory}</directory>
  57.             <outputDirectory>document</outputDirectory>
  58.             <excludes>
  59.                 <exclude>readme.*</exclude>
  60.             </excludes>
  61.         </fileSet>
  63.         <!--
  64.         把项目的脚本文件目录(src/main/scripts )中的启动脚本文件，
  65.         打包进zip文件的根目录
  66.         (这里针对的是src/scripts/execute/include-file.sh文件)
  67.         ${project.script.execute.directory}
  68.         -->
  69.         <fileSet>
  70.             <directory>${project.script.execute.directory}</directory>
  71.             <outputDirectory></outputDirectory>
  72.             <includes>
  73.                 <include>*</include>
  74.             </includes>
  75.         </fileSet>
  77.     </fileSets>
  78. </assembly>

发表评论

表情：
评论列表 （有 0 条评论，645人围观）

还没有评论，来说两句吧...

相关阅读