6.Storm 項目三種打包方式對比分析 · java核心知識整理

## 一、簡介在將 Storm Topology 提交到服務器集群運行時，需要先將項目進行打包。本文主要對比分析各種打包方式，并將打包過程中需要注意的事項進行說明。主要打包方式有以下三種： * 第一種：不加任何插件，直接使用 mvn package 打包； * 第二種：使用 maven-assembly-plugin 插件進行打包； * 第三種：使用 maven-shade-plugin 進行打包。以下分別進行詳細的說明。 ## 二、mvn package ### 2.1 mvn package的局限不在 POM 中配置任何插件，直接使用 `mvn package` 進行項目打包，這對于沒有使用外部依賴包的項目是可行的。但如果項目中使用了第三方 JAR 包，就會出現問題，因為 `mvn package` 打包后的 JAR 中是不含有依賴包的，如果此時你提交到服務器上運行，就會出現找不到第三方依賴的異常。如果你想采用這種方式進行打包，但是又使用了第三方 JAR，有沒有解決辦法？答案是有的，這一點在官方文檔的[Command Line Client](http://storm.apache.org/releases/2.0.0-SNAPSHOT/Command-line-client.html) 章節有所講解，主要解決辦法如下。 ### 2.2 解決辦法在使用 `storm jar` 提交 Topology 時，可以使用如下方式指定第三方依賴： * 如果第三方 JAR 包在本地，可以使用 `--jars` 指定； * 如果第三方 JAR 包在遠程中央倉庫，可以使用 `--artifacts` 指定，此時如果想要排除某些依賴，可以使用 `^` 符號。指定后 Storm 會自動到中央倉庫進行下載，然后緩存到本地； * 如果第三方 JAR 包在其他倉庫，還需要使用 `--artifactRepositories` 指明倉庫地址，庫名和地址使用 `^` 符號分隔。以下是一個包含上面三種情況的命令示例： ~~~ ./bin/storm jar example/storm-starter/storm-starter-topologies-*.jar \ org.apache.storm.starter.RollingTopWords blobstore-remote2 remote \ --jars "./external/storm-redis/storm-redis-1.1.0.jar,./external/storm-kafka/storm-kafka-1.1.0.jar" \ --artifacts "redis.clients:jedis:2.9.0,org.apache.kafka:kafka_2.10:0.8.2.2^org.slf4j:slf4j-log4j12" \ --artifactRepositories "jboss-repository^http://repository.jboss.com/maven2, \ HDPRepo^http://repo.hortonworks.com/content/groups/public/" ~~~ 這種方式是建立在你能夠連接到外網的情況下，如果你的服務器不能連接外網，或者你希望能把項目直接打包成一個 `ALL IN ONE` 的 JAR，即包含所有相關依賴，此時可以采用下面介紹的兩個插件。 ## 三、maven-assembly-plugin插件 maven-assembly-plugin 是官方文檔中介紹的打包方法，來源于官方文檔：[Running Topologies on a Production Cluster](http://storm.apache.org/releases/2.0.0-SNAPSHOT/Running-topologies-on-a-production-cluster.html) > If you're using Maven, the [Maven Assembly Plugin](http://maven.apache.org/plugins/maven-assembly-plugin/) can do the packaging for you. Just add this to your pom.xml: > > ~~~ > <plugin> > <artifactId>maven-assembly-plugin</artifactId> > <configuration> > <descriptorRefs> > <descriptorRef>jar-with-dependencies</descriptorRef> > </descriptorRefs> > <archive> > <manifest> > <mainClass>com.path.to.main.Class</mainClass> > </manifest> > </archive> > </configuration> > </plugin> > ~~~ > > Then run mvn assembly:assembly to get an appropriately packaged jar. Make sure you [exclude](http://maven.apache.org/plugins/maven-assembly-plugin/examples/single/including-and-excluding-artifacts.html) the Storm jars since the cluster already has Storm on the classpath. 官方文檔主要說明了以下幾點： * 使用 maven-assembly-plugin 可以把所有的依賴一并打入到最后的 JAR 中； * 需要排除掉 Storm 集群環境中已經提供的 Storm jars； * 通過 `<mainClass>` 標簽指定主入口類； * 通過 `<descriptorRef>` 標簽指定打包相關配置。 `jar-with-dependencies` 是 Maven[預定義](http://maven.apache.org/plugins/maven-assembly-plugin/descriptor-refs.html#jar-with-dependencies) 的一種最基本的打包配置，其 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> </dependencySet> </dependencySets> </assembly> ~~~ 我們可以通過對該配置文件進行拓展，從而實現更多的功能，比如排除指定的 JAR 等。使用示例如下： ### 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` 拓展自 `jar-with-dependencies.xml`，使用了 `<excludes>` 標簽排除 Storm jars，具體內容如下： ~~~ <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>  <excludes> <exclude>org.apache.storm:storm-core</exclude> </excludes> </dependencySet> </dependencySets> </assembly> ~~~ > 在配置文件中不僅可以排除依賴，還可以排除指定的文件，更多的配置規則可以參考官方文檔：[Descriptor Format](http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html#) ### 2\. 打包命令采用 maven-assembly-plugin 進行打包時命令如下： ~~~ # mvn assembly:assembly ~~~ 打包后會同時生成兩個 JAR 包，其中后綴為 `jar-with-dependencies` 是含有第三方依賴的 JAR 包，后綴是由 `assembly.xml` 中 `<id>` 標簽指定的，可以自定義修改。提交該 JAR 到集群環境即可直接使用。 ![](https://img.kancloud.cn/6e/4e/6e4e9e93e20f421bd1a0c8601c915a86_755x223.png) ## 四、maven-shade-plugin插件 ### 4.1 官方文檔說明第三種方式是使用 maven-shade-plugin，既然已經有了 maven-assembly-plugin，為什么還需要 maven-shade-plugin，這一點在官方文檔中也是有所說明的，來自于官方對 HDFS 整合講解的章節[Storm HDFS Integration](http://storm.apache.org/releases/2.0.0-SNAPSHOT/storm-hdfs.html)，原文如下： > When packaging your topology, it's important that you use the [maven-shade-plugin](http://storm.apache.org/releases/2.0.0-SNAPSHOT/storm-hdfs.html) as opposed to the [maven-assembly-plugin](http://storm.apache.org/releases/2.0.0-SNAPSHOT/storm-hdfs.html). > > The shade plugin provides facilities for merging JAR manifest entries, which the hadoop client leverages for URL scheme resolution. > > If you experience errors such as the following: > > ~~~ > java.lang.RuntimeException: Error preparing HdfsBolt: No FileSystem for scheme: hdfs > ~~~ > > it's an indication that your topology jar file isn't packaged properly. > > If you are using maven to create your topology jar, you should use the following `maven-shade-plugin` configuration to create your topology jar。這里第一句就說的比較清晰，在集成 HDFS 時候，你必須使用 maven-shade-plugin 來代替 maven-assembly-plugin，否則會拋出 RuntimeException 異常。采用 maven-shade-plugin 打包有很多好處，比如你的工程依賴很多的 JAR 包，而被依賴的 JAR 又會依賴其他的 JAR 包，這樣,當工程中依賴到不同的版本的 JAR 時，并且 JAR 中具有相同名稱的資源文件時，shade 插件會嘗試將所有資源文件打包在一起時，而不是和 assembly 一樣執行覆蓋操作。 ### 4.2 配置采用 `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.3 打包命令使用 maven-shade-plugin 進行打包的時候，打包命令和普通的一樣： ~~~ # mvn package ~~~ 打包后會生成兩個 JAR 包，提交到服務器集群時使用 `非 original` 開頭的 JAR。 ![](https://img.kancloud.cn/fa/a2/faa28454525f63229279271513550684_718x181.png) ## 五、結論通過以上三種打包方式的詳細介紹，這里給出最后的結論：**建議使用 maven-shade-plugin 插件進行打包**，因為其通用性最強，操作最簡單，并且 Storm Github 中所有[examples](https://github.com/apache/storm/tree/master/examples) 都是采用該方式進行打包。 ## 六、打包注意事項無論采用任何打包方式，都必須排除集群環境中已經提供的 storm jars。這里比較典型的是 storm-core，其在安裝目錄的 lib 目錄下已經存在。 ![](https://img.kancloud.cn/79/21/792136beee6c68e5f3d21a8e05cea731_570x327.png) 如果你不排除 storm-core，通常會拋出下面的異常： ~~~ Caused by: java.lang.RuntimeException: java.io.IOException: Found multiple defaults.yaml resources. You're probably bundling the Storm jars with your topology jar. [jar:file:/usr/app/apache-storm-1.2.2/lib/storm-core-1.2.2.jar!/defaults.yaml, jar:file:/usr/appjar/storm-hdfs-integration-1.0.jar!/defaults.yaml] at org.apache.storm.utils.Utils.findAndReadConfigFile(Utils.java:384) at org.apache.storm.utils.Utils.readDefaultConfig(Utils.java:428) at org.apache.storm.utils.Utils.readStormConfig(Utils.java:464) at org.apache.storm.utils.Utils.<clinit>(Utils.java:178) ... 39 more ~~~ ![](https://img.kancloud.cn/6c/d4/6cd49b1111ea289f3f14e51e5035ad42_920x315.png) 作者：heibaiying 鏈接：https://juejin.cn/post/6844903950034944014 來源：掘金著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。