From a38b7cce3d6aa2e68cd3ea60a5fa38cb8c660e45 Mon Sep 17 00:00:00 2001 From: luoxiang <2806718453@qq.com> Date: Mon, 20 May 2019 23:34:45 +0800 Subject: [PATCH 1/2] =?UTF-8?q?=E5=A4=A7=E6=95=B0=E6=8D=AE=E5=BA=94?= =?UTF-8?q?=E7=94=A8=E5=B8=B8=E7=94=A8=E6=89=93=E5=8C=85=E6=96=B9=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- notes/大数据应用常用打包方式.md | 249 +++++++++++++++++++++ 2 files changed, 250 insertions(+), 1 deletion(-) create mode 100644 notes/大数据应用常用打包方式.md diff --git a/README.md b/README.md index 8da6808..de892ae 100644 --- a/README.md +++ b/README.md @@ -176,5 +176,5 @@ TODO ## 十三、公共基础知识 -1. 大数据应用打包方式 +1. [大数据应用常用打包方式](https://github.com/heibaiying/BigData-Notes/blob/master/notes/大数据应用常用打包方式.md) 2. 大数据常用文件格式 \ No newline at end of file diff --git a/notes/大数据应用常用打包方式.md b/notes/大数据应用常用打包方式.md new file mode 100644 index 0000000..e583370 --- /dev/null +++ b/notes/大数据应用常用打包方式.md @@ -0,0 +1,249 @@ +# 大数据应用常用打包方式 + +## 一、简介 + +在提交大数据作业到集群中运行时，通常都需要先将项目打成Jar包。Java项目通常都采用Maven进行构建，常用的打包方式有以下三种： + +- 第一种：不加任何插件，直接使用mvn package打包； +- 第二种：使用maven-assembly-plugin插件进行打包； +- 第三种：使用maven-shade-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`(名称可自定义)，并指定作业的主入口类。 + +```xml + + + + maven-assembly-plugin + + + src/main/resources/assembly.xml + + + + com.heibaiying.wordcount.ClusterWordCountApp + + + + + + +``` + +assembly.xml文件内容如下： + +```xml + + + jar-with-dependencies + + + + jar + + + false + + + / + true + true + runtime + + + org.apache.storm:storm-core + + + + +``` + +### 3.2 打包命令 + +采用maven-assembly-plugin进行打包时命令如下： + +```shell +# mvn assembly:assembly +``` + +打包后会同时生成两个JAR包，其中后缀为`jar-with-dependencies`是含有第三方依赖的JAR包，后缀是由`assembly.xml`中``标签指定的，可以自定义修改。 + +
+ + + + + +## 四、maven-shade-plugin插件 + +`maven-shade-plugin`比`maven-assembly-plugin`功能更丰富，比如你的工程依赖很多的JAR包，而被依赖的JAR又会依赖其他的JAR包，这样,当工程中依赖到不同的版本的 JAR时，并且JAR中具有相同名称的资源文件时，shade插件会尝试将所有资源文件打包在一起时，而不是和assembly一样执行覆盖操作。 + +### 4.1 基本配置 + +采用`maven-shade-plugin`进行打包时候，配置示例如下： + +```xml + + org.apache.maven.plugins + maven-shade-plugin + + true + + + *:* + + META-INF/*.SF + META-INF/*.sf + META-INF/*.DSA + META-INF/*.dsa + META-INF/*.RSA + META-INF/*.rsa + META-INF/*.EC + META-INF/*.ec + META-INF/MSFTSIG.SF + META-INF/MSFTSIG.RSA + + + + + + org.apache.storm:storm-core + + + + + + package + + shade + + + + + + + + + + + +``` + +以上配置来源于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进行打包的时候，打包命令和普通打包一样： + +```shell +# mvn package +``` + +打包后会生成两个JAR包，提交到服务器集群时使用非original开头的Jar。 + +
+ + + +## 五、使用非Maven仓库中的Jar + +通常上面两种打包能够满足大多数的使用场景。但是如果你想把某些没有被Maven管理Jar包打入到最终的Jar中，比如你在`resources/lib`下引入的其他非Maven仓库中的Jar，此时可以使用`maven-jar-plugin`和`maven-dependency-plugin`插件将其打入最终的Jar中。 + +```xml + + + + org.apache.maven.plugins + maven-jar-plugin + + + + true + + lib/ + + com.heibaiying.BigDataApp + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy + compile + + + copy-dependencies + + + + + ${project.build.directory}/lib + + + + + + + +``` + +## 六、排除集群中已经存在的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包依赖添加`provided`标签，此时该Jar包会被排除，但是不建议使用这种方式，因为此时你在本地运行也无法使用该Jar包； ++ 建议直接在`maven-assembly-plugin`或`maven-shade-plugin`的配置文件中使用``进行排除。 + +## 七、使用建议 + +通常使用`maven-shade-plugin`就能够完成大多数的打包需求，其配置简单且适用性最广，因此建议使用此方式。 + From 5e4f55a09c7f22aaf02ef75542c5a11af321627f Mon Sep 17 00:00:00 2001 From: luoxiang <2806718453@qq.com> Date: Mon, 20 May 2019 23:49:01 +0800 Subject: [PATCH 2/2] modify --- notes/大数据应用常用打包方式.md | 32 ++++++++++++++++++---- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/notes/大数据应用常用打包方式.md b/notes/大数据应用常用打包方式.md index e583370..c9133a0 100644 --- a/notes/大数据应用常用打包方式.md +++ b/notes/大数据应用常用打包方式.md @@ -1,12 +1,24 @@ # 大数据应用常用打包方式 + + + ## 一、简介 -在提交大数据作业到集群中运行时，通常都需要先将项目打成Jar包。Java项目通常都采用Maven进行构建，常用的打包方式有以下三种： +在提交大数据作业到集群中运行时，通常都需要先将项目打成Jar包。Java项目通常都采用Maven进行构建，Maven提供的常用打包方式及插件有以下四种： -- 第一种：不加任何插件，直接使用mvn package打包； -- 第二种：使用maven-assembly-plugin插件进行打包； -- 第三种：使用maven-shade-plugin插件进行打包。 +- 不加任何插件，直接使用mvn package打包； +- 使用maven-assembly-plugin插件； +- 使用maven-shade-plugin插件； +- 使用maven-jar-plugin和maven-dependency-plugin插件； 以下分别进行详细的说明。 @@ -104,7 +116,7 @@ assembly.xml文件内容如下： ## 四、maven-shade-plugin插件 -`maven-shade-plugin`比`maven-assembly-plugin`功能更丰富，比如你的工程依赖很多的JAR包，而被依赖的JAR又会依赖其他的JAR包，这样,当工程中依赖到不同的版本的 JAR时，并且JAR中具有相同名称的资源文件时，shade插件会尝试将所有资源文件打包在一起时，而不是和assembly一样执行覆盖操作。 +`maven-shade-plugin`比`maven-assembly-plugin`功能更为强大，比如你的工程依赖很多的JAR包，而被依赖的JAR又会依赖其他的JAR包，这样,当工程中依赖到不同的版本的 JAR时，并且JAR中具有相同名称的资源文件时，shade插件会尝试将所有资源文件打包在一起时，而不是和assembly一样执行覆盖操作。 ### 4.1 基本配置 @@ -247,3 +259,13 @@ Strom官方文档 Running Topologies on a Production Cluster 章节： 通常使用`maven-shade-plugin`就能够完成大多数的打包需求，其配置简单且适用性最广，因此建议使用此方式。 + + +## 参考资料 +关于Maven各个插件的详细配置可以查看其官方文档： ++ maven-assembly-plugin : http://maven.apache.org/plugins/maven-assembly-plugin/ ++ maven-shade-plugin : http://maven.apache.org/plugins/maven-shade-plugin/ ++ maven-jar-plugin : http://maven.apache.org/plugins/maven-jar-plugin/ ++ maven-dependency-plugin : http://maven.apache.org/components/plugins/maven-dependency-plugin/ + +关于maven-shade-plugin的更多配置也可以参考该博客： [maven-shade-plugin 入门指南](https://www.jianshu.com/p/7a0e20b30401) \ No newline at end of file