大数据应用常用打包方式

一、简介

在提交大数据作业到集群上运行时，通常需要先将项目打成 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(名称可自定义)，并指定作业的主入口类：

<build>
    <plugins>
        <plugin>
            <artifactid>maven-assembly-plugin</artifactid>
            <configuration>
                <descriptors>
                    <descriptor>src/main/resources/assembly.xml</descriptor>
                </descriptors>
                <archive>
                    <manifest>
                        <mainclass>com.heibaiying.wordcount.clusterwordcountapp</mainclass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

assembly.xml 文件内容如下：

<assembly xmlns="http://maven.apache.org/assembly/2.0.0"
          xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"
          xsi:schemalocation="http://maven.apache.org/assembly/2.0.0 
                              http://maven.apache.org/xsd/assembly-2.0.0.xsd">
    
    <id>jar-with-dependencies</id>

    <!--指明打包方式-->
    <formats>
        <format>jar</format>
    </formats>

    <includebasedirectory>false</includebasedirectory>
    <dependencysets>
        <dependencyset>
            <outputdirectory>/</outputdirectory>
            <useprojectartifact>true</useprojectartifact>
            <unpack>true</unpack>
            <scope>runtime</scope>
            <!--这里以排除 storm 环境中已经提供的 storm-core 为例，演示排除 jar 包-->
            <excludes>
                <exclude>org.apache.storm:storm-core</exclude>
            </excludes>
        </dependencyset>
    </dependencysets>
</assembly>

3.2 打包命令

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

# mvn assembly:assembly 

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

四、maven-shade-plugin插件

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

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

4.1 基本配置

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

<plugin>
    <groupid>org.apache.maven.plugins</groupid>
    <artifactid>maven-shade-plugin</artifactid>
    <configuration>
        <createdependencyreducedpom>true</createdependencyreducedpom>
        <filters>
            <filter>
                <artifact>*:*</artifact>
                <excludes>
                    <exclude>meta-inf/*.sf</exclude>
                    <exclude>meta-inf/*.sf</exclude>
                    <exclude>meta-inf/*.dsa</exclude>
                    <exclude>meta-inf/*.dsa</exclude>
                    <exclude>meta-inf/*.rsa</exclude>
                    <exclude>meta-inf/*.rsa</exclude>
                    <exclude>meta-inf/*.ec</exclude>
                    <exclude>meta-inf/*.ec</exclude>
                    <exclude>meta-inf/msftsig.sf</exclude>
                    <exclude>meta-inf/msftsig.rsa</exclude>
                </excludes>
            </filter>
        </filters>
        <artifactset>
            <excludes>
                <exclude>org.apache.storm:storm-core</exclude>
            </excludes>
        </artifactset>
    </configuration>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
            <configuration>
                <transformers>
                    <transformer
                       implementation="org.apache.maven.plugins.shade.resource.servicesresourcetransformer"/>
                    <transformer
                       implementation="org.apache.maven.plugins.shade.resource.manifestresourcetransformer">
                    </transformer>
                </transformers>
            </configuration>
        </execution>
    </executions>
</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 进行打包的时候，打包命令和普通打包一样：

# mvn package

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

五、其他打包需求

1. 使用非maven仓库中的jar

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

<build>
    <plugins>
        <plugin>
            <groupid>org.apache.maven.plugins</groupid>
            <artifactid>maven-jar-plugin</artifactid>
            <configuration>
                <archive>
                    <manifest>
                        <addclasspath>true</addclasspath>
                          <!--指定 resources/lib 目录-->
                        <classpathprefix>lib/</classpathprefix>
                          <!--应用的主入口类-->
                        <mainclass>com.heibaiying.bigdataapp</mainclass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
        <plugin>
            <groupid>org.apache.maven.plugins</groupid>
            <artifactid>maven-dependency-plugin</artifactid>
            <executions>
                <execution>
                    <id>copy</id>
                    <phase>compile</phase>
                    <goals>
                         <!--将 resources/lib 目录所有 jar 包打进最终的依赖中-->
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                         <!--将 resources/lib 目录所有 jar 包一并拷贝到输出目录的 lib 目录下-->
                        <outputdirectory>
                            ${project.build.directory}/lib
                        </outputdirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</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 插件，常用配置如下：

<plugin>
    <groupid>org.scala-tools</groupid>
    <artifactid>maven-scala-plugin</artifactid>
    <version>2.15.1</version>
    <executions>
        <execution>
            <id>scala-compile</id>
            <goals>
                <goal>compile</goal>
            </goals>
            <configuration>
                <includes>
                    <include>**/*.scala</include>
                </includes>
            </configuration>
        </execution>
        <execution>
            <id>scala-test-compile</id>
            <goals>
                <goal>testcompile</goal>
            </goals>
        </execution>
    </executions>
</plugin>

参考资料

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

• maven-assembly-plugin :
• maven-shade-plugin :
• maven-jar-plugin :
• maven-dependency-plugin :

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

更多大数据系列文章可以参见 github 开源项目： 大数据入门指南