大数据应用常用打包方式

一、简介

在提交大数据作业到集群上运行时，通常需要先将项目打成 JAR 包。这里以 Maven 为例，常用打包方式如下：

  • 不加任何插件，直接使用 mvn package 打包；
  • 使用 maven-assembly-plugin 插件；
  • 使用 maven-shade-plugin 插件；
  • 使用 maven-jar-plugin 和 maven-dependency-plugin 插件；

以下分别进行详细的说明。

二、mvn package

不在 POM 中配置任何插件，直接使用 mvn package 进行项目打包，这对于没有使用外部依赖包的项目是可行的。但如果项目中使用了第三方 JAR 包，就会出现问题，因为 mvn package 打的 JAR 包中是不含有依赖包，会导致作业运行时出现找不到第三方依赖的异常。这种方式局限性比较大，因为实际的项目往往很复杂，通常都会依赖第三方 JAR。

大数据框架的开发者也考虑到这个问题，所以基本所有的框架都支持在提交作业时使用 --jars 指定第三方依赖包，但是这种方式的问题同样很明显，就是你必须保持生产环境与开发环境中的所有 JAR 包版本一致，这是有维护成本的。

基于上面这些原因，最简单的是采用 All In One 的打包方式，把所有依赖都打包到一个 JAR 文件中，此时对环境的依赖性最小。要实现这个目的，可以使用 Maven 提供的 maven-assembly-plugin 或 maven-shade-plugin 插件。

三、maven-assembly-plugin插件

Assembly 插件支持将项目的所有依赖、文件都打包到同一个输出文件中。目前支持输出以下文件类型：

  • zip
  • tar
  • tar.gz (or tgz)
  • tar.bz2 (or tbz2)
  • tar.snappy
  • tar.xz (or txz)
  • jar
  • dir
  • war

3.1 基本使用

在 POM.xml 中引入插件，指定打包格式的配置文件 assembly.xml(名称可自定义)，并指定作业的主入口类：

  1. <build>
  2.     <plugins>
  3.         <plugin>
  4.             <artifactId>maven-assembly-plugin</artifactId>
  5.             <configuration>
  6.                 <descriptors>
  7.                     <descriptor>src/main/resources/assembly.xml</descriptor>
  8.                 </descriptors>
  9.                 <archive>
  10.                     <manifest>
  11.                         <mainClass>com.heibaiying.wordcount.ClusterWordCountApp</mainClass>
  12.                     </manifest>
  13.                 </archive>
  14.             </configuration>
  15.         </plugin>
  16.     </plugins>
  17. </build>

assembly.xml 文件内容如下：

  1. <assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
  2.           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.           xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 
  4.                               http://maven.apache.org/xsd/assembly-2.0.0.xsd">
  6.     <id>jar-with-dependencies</id>
  8.     <!--指明打包方式-->
  9.     <formats>
  10.         <format>jar</format>
  11.     </formats>
  13.     <includeBaseDirectory>false</includeBaseDirectory>
  14.     <dependencySets>
  15.         <dependencySet>
  16.             <outputDirectory>/</outputDirectory>
  17.             <useProjectArtifact>true</useProjectArtifact>
  18.             <unpack>true</unpack>
  19.             <scope>runtime</scope>
  20.             <!--这里以排除 storm 环境中已经提供的 storm-core 为例，演示排除 Jar 包-->
  21.             <excludes>
  22.                 <exclude>org.apache.storm:storm-core</exclude>
  23.             </excludes>
  24.         </dependencySet>
  25.     </dependencySets>
  26. </assembly>

3.2 打包命令

采用 maven-assembly-plugin 进行打包时命令如下：

  1. # mvn assembly:assembly

打包后会同时生成两个 JAR 包，其中后缀为 jar-with-dependencies 是含有第三方依赖的 JAR 包，后缀是由 assembly.xml 中 <id> 标签指定的，可以自定义修改。

大数据应用常用打包方式 - 图1

四、maven-shade-plugin插件

maven-shade-plugin 比 maven-assembly-plugin 功能更为强大，比如你的工程依赖很多的 JAR 包，而被依赖的 JAR 又会依赖其他的 JAR 包，这样,当工程中依赖到不同的版本的 JAR 时，并且 JAR 中具有相同名称的资源文件时，shade 插件会尝试将所有资源文件打包在一起时，而不是和 assembly 一样执行覆盖操作。

通常使用 maven-shade-plugin 就能够完成大多数的打包需求，其配置简单且适用性最广，因此建议优先使用此方式。

4.1 基本配置

采用 maven-shade-plugin 进行打包时候，配置示例如下：

  1. <plugin>
  2.     <groupId>org.apache.maven.plugins</groupId>
  3.     <artifactId>maven-shade-plugin</artifactId>
  4.     <configuration>
  5.         <createDependencyReducedPom>true</createDependencyReducedPom>
  6.         <filters>
  7.             <filter>
  8.                 <artifact>*:*</artifact>
  9.                 <excludes>
  10.                     <exclude>META-INF/*.SF</exclude>
  11.                     <exclude>META-INF/*.sf</exclude>
  12.                     <exclude>META-INF/*.DSA</exclude>
  13.                     <exclude>META-INF/*.dsa</exclude>
  14.                     <exclude>META-INF/*.RSA</exclude>
  15.                     <exclude>META-INF/*.rsa</exclude>
  16.                     <exclude>META-INF/*.EC</exclude>
  17.                     <exclude>META-INF/*.ec</exclude>
  18.                     <exclude>META-INF/MSFTSIG.SF</exclude>
  19.                     <exclude>META-INF/MSFTSIG.RSA</exclude>
  20.                 </excludes>
  21.             </filter>
  22.         </filters>
  23.         <artifactSet>
  24.             <excludes>
  25.                 <exclude>org.apache.storm:storm-core</exclude>
  26.             </excludes>
  27.         </artifactSet>
  28.     </configuration>
  29.     <executions>
  30.         <execution>
  31.             <phase>package</phase>
  32.             <goals>
  33.                 <goal>shade</goal>
  34.             </goals>
  35.             <configuration>
  36.                 <transformers>
  37.                     <transformer
  38.                        implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
  39.                     <transformer
  40.                        implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
  41.                     </transformer>
  42.                 </transformers>
  43.             </configuration>
  44.         </execution>
  45.     </executions>
  46. </plugin>

以上配置来源于 Storm Github，在上面的配置中，排除了部分文件，这是因为有些 JAR 包生成时，会使用 jarsigner 生成文件签名 (完成性校验)，分为两个文件存放在 META-INF 目录下：

  • a signature file, with a .SF extension；
  • a signature block file, with a .DSA, .RSA, or .EC extension。

如果某些包的存在重复引用，这可能会导致在打包时候出现 Invalid signature file digest for Manifest main attributes 异常，所以在配置中排除这些文件。

4.2 打包命令

使用 maven-shade-plugin 进行打包的时候，打包命令和普通打包一样：

  1. # mvn package

打包后会生成两个 JAR 包，提交到服务器集群时使用非 original 开头的 JAR。

大数据应用常用打包方式 - 图2

五、其他打包需求

1. 使用非Maven仓库中的Jar

通常上面两种打包能够满足大多数的使用场景。但是如果你想把某些没有被 Maven 管理 JAR 包打入到最终的 JAR 中，比如你在 resources/lib 下引入的其他非 Maven 仓库中的 JAR，此时可以使用 maven-jar-plugin 和 maven-dependency-plugin 插件将其打入最终的 JAR 中。

  1. <build>
  2.     <plugins>
  3.         <plugin>
  4.             <groupId>org.apache.maven.plugins</groupId>
  5.             <artifactId>maven-jar-plugin</artifactId>
  6.             <configuration>
  7.                 <archive>
  8.                     <manifest>
  9.                         <addClasspath>true</addClasspath>
  10.                           <!--指定 resources/lib 目录-->
  11.                         <classpathPrefix>lib/</classpathPrefix>
  12.                           <!--应用的主入口类-->
  13.                         <mainClass>com.heibaiying.BigDataApp</mainClass>
  14.                     </manifest>
  15.                 </archive>
  16.             </configuration>
  17.         </plugin>
  18.         <plugin>
  19.             <groupId>org.apache.maven.plugins</groupId>
  20.             <artifactId>maven-dependency-plugin</artifactId>
  21.             <executions>
  22.                 <execution>
  23.                     <id>copy</id>
  24.                     <phase>compile</phase>
  25.                     <goals>
  26.                          <!--将 resources/lib 目录所有 Jar 包打进最终的依赖中-->
  27.                         <goal>copy-dependencies</goal>
  28.                     </goals>
  29.                     <configuration>
  30.                          <!--将 resources/lib 目录所有 Jar 包一并拷贝到输出目录的 lib 目录下-->
  31.                         <outputDirectory>
  32.                             ${project.build.directory}/lib
  33.                         </outputDirectory>
  34.                     </configuration>
  35.                 </execution>
  36.             </executions>
  37.         </plugin>
  38.     </plugins>
  39. </build>

2. 排除集群中已经存在的Jar

通常为了避免冲突，官方文档都会建议你排除集群中已经提供的 JAR 包，如下：

Spark 官方文档 Submitting Applications 章节:

When creating assembly jars, list Spark and Hadoop as provided dependencies; these need not be bundled since they are provided by the cluster manager at runtime.

Strom 官方文档 Running Topologies on a Production Cluster 章节：

Then run mvn assembly:assembly to get an appropriately packaged jar. Make sure you exclude the Storm jars since the cluster already has Storm on the classpath.

按照以上说明，排除 JAR 包的方式主要有两种：

  • 对需要排除的依赖添加 <scope>provided</scope> 标签，此时该 JAR 包会被排除，但是不建议使用这种方式，因为此时你在本地运行也无法使用该 JAR 包；
  • 建议直接在 maven-assembly-plugin 或 maven-shade-plugin 的配置文件中使用 <exclude> 进行排除。

3. 打包Scala文件

如果你使用到 Scala 语言进行编程，此时需要特别注意 ：默认情况下 Maven 是不会把 scala 文件打入最终的 JAR 中，需要额外添加 maven-scala-plugin 插件，常用配置如下：

  1. <plugin>
  2.     <groupId>org.scala-tools</groupId>
  3.     <artifactId>maven-scala-plugin</artifactId>
  4.     <version>2.15.1</version>
  5.     <executions>
  6.         <execution>
  7.             <id>scala-compile</id>
  8.             <goals>
  9.                 <goal>compile</goal>
  10.             </goals>
  11.             <configuration>
  12.                 <includes>
  13.                     <include>**/*.scala</include>
  14.                 </includes>
  15.             </configuration>
  16.         </execution>
  17.         <execution>
  18.             <id>scala-test-compile</id>
  19.             <goals>
  20.                 <goal>testCompile</goal>
  21.             </goals>
  22.         </execution>
  23.     </executions>
  24. </plugin>

参考资料

关于 Maven 各个插件的详细配置可以查看其官方文档：

关于 maven-shade-plugin 的更多配置也可以参考该博客： maven-shade-plugin 入门指南