maven项目如何打包运行指定java程序(maven-shade-plugin插件的使用)
其实maven项目的打包就是将项目代码打包成可执行文件，在maven中有默认的打包插件，但是想要运行指定java程序就要使用maven-shade-plugin插件
maven-jar-plugin是maven的默认打包插件，用来创建 project jar
maven-shade-plugin用来打可执行包，包含依赖，以及对依赖进行取舍过滤
1 maven-shade-plugin介绍
maven-plugin-shade 插件提供了两个主要的能力：
- 把整个项目（包含它的依赖）都打包到一个 “uber-jar” 中；
- shade - 即重命名某些依赖的包。
具体来说，它提供了以下功能：
- 按需选择要添加到最终 jar 包中依赖；
- 重定位 class 文件；
- 生成可执行 jar 包；
- 生成项目资源文件。
2 基本用法
maven-plugin-shade 必须和 Maven 构建生命周期中的 package 阶段绑定，
也就是说，当执行mvn package时会自动触发 shade。
要使用 maven-plugin-shade，只需要在 pom.xml 的 < plugins > 标签下添加它的配置即可，示例如下：
<project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-shade-pluginartifactId>
<version>3.2.4version>
<executions>
<execution>
<phase>packagephase>
<goals>
<goal>shadegoal>
goals>
execution>
executions>
<configuration>
configuration>
plugin>
plugins>
build>
...
project>
项目中常用写法
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-shade-pluginartifactId>
<version>1.4version>
<executions>
<execution>
<phase>packagephase>
<goals>
<goal>shadegoal>
goals>
<configuration>
<filters>
<filter>
<artifact>*:*artifact>
<excludes>
<exclude>META-INF/*.SFexclude>
<exclude>META-INF/*.DSAexclude>
<exclude>META-INF/*.RSAexclude>
excludes>
filter>
filters>
<transformers>
<transformer
implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>cn.fileserver.HttpFileServermainClass>
transformer>
<transformer
implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.handlersresource>
transformer>
<transformer
implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.schemasresource>
transformer>
transformers>
configuration>
execution>
executions>
plugin>
plugins>
build>
project>
3 常用功能
3.1 按需选择需要添加到最终 jar 包中依赖
3.1.1 使用
使用groupId:artifactId为标识，在filter内部可以使用 / 更细致地控制，既可以移除代码文件，也可以移除配置文件，示例如下：
<configuration>
<filters>
<filter>
<artifact>junit:junitartifact>
<includes>
<include>junit/framework/**include>
<include>org/junit/**include>
includes>
<excludes>
<exclude>org/junit/experimental/**exclude>
<exclude>org/junit/runners/**exclude>
excludes>
filter>
filters>
configuration>
3.1.2 使用
使用
<configuration>
<artifactSet>
<excludes>
<exclude>classworlds:classworldsexclude>
<exclude>junit:junitexclude>
<exclude>jmock:*exclude>
<exclude>*:xml-apisexclude>
<exclude>org.apache.maven:lib:testsexclude>
<exclude>log4j:log4j:jar:exclude>
excludes>
artifactSet>
configuration>
3.3.3 使用
除了可以通过自定义的 filters 来过滤依赖，此插件还支持自动移除项目中没有使用到的依赖，以此来最小化 jar 包的体积，只需要添加一项配置即可。示例如下：
建议maven-shade-plugin的版本为3.2.4，低版本会报错
<configuration>
<minimizeJar>trueminimizeJar>
configuration>
3.2 重定位 class 文件
如果最终的 jar 包被其他的项目所依赖的话，直接地引用此 jar 包中的类可能会导致类加载冲突，这是因为 classpath 中可能存在重复的 class 文件。为了解决这个问题，我们可以使用 shade 提供的重定位功能，把部分类移动到一个全新的包中。示例如下：
涉及标签：
<pattern>：原始包名
<shadedPattern>：重命名后的包名
<excludes>：原始包内不需要重定位的类，类名支持通配符
<configuration>
<relocations>
<relocation>
<pattern>org.codehaus.plexus.utilpattern>
<shadedPattern>org.shaded.plexus.utilshadedPattern>
<excludes>
<exclude>org.codehaus.plexus.util.xml.Xpp3Domexclude>
<exclude>org.codehaus.plexus.util.xml.pull.*exclude>
excludes>
relocation>
relocations>
configuration>
在上述示例中，我们把 org.codehaus.plexus.util 包内的所有子包及 class 文件（除了 ~.xml.Xpp3Dom 和 ~.xml.pull 包下的所有 class 文件）重定位到了 org.shaded.plexus.util 包内。
当然，如果包内的大部分类我们都不需要，一个个排除就显得很繁琐了。此时我们也可以使用
<project>
...
<relocation>
<pattern>org.codehaus.plexus.utilpattern>
<shadedPattern>org.shaded.plexus.utilshadedPattern>
<includes>
<include>org.codehaud.plexus.util.io.*include>
includes>
relocation>
...
project>
3.3 生成可执行 jar 包指定启动类
使用 maven-plugin-shade 后，最终生成的 jar 包可以包含所有项目所需要的依赖。
我们会想，能不能直接运行这个 uber-jar 呢？
答案是当然可以，并且十分简单，只需要指定java -jar jar包就可以了。示例如下：
<project>
...
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>cn.fileserver.HttpFileServermainClass>
transformer>
transformers>
configuration>
...
project>
3.4 生成可执行 jar 包不指定启动类
在打包后，有可能有多个mainClass，那么就可以在pom.xml中不指定java -cp jar包 全路径类名启动即可
<project>
...
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>mainClass>
transformer>
transformers>
configuration>
...
project>
3.5 定制 MANIFEST.MF 文件
熟悉 jar 包的朋友们都知道，jar 包中在META-INF中默认会包含一个 MANIFEST.MF 文件
MANIFEST.MF
Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Built-By: lvxy
Created-By: Apache Maven 3.8.1
Build-Jdk: 1.8.0_261
Main-Class: cn.fileserver.HttpFileServer
里面描述了一些 jar 包的信息。使用 java 自带的 jar 命令打包的时候可以指定 MANIFEST.MF，其中也可以指定 Main-Class 来使得 jar 包可运行。那么使用 shade 来指定和直接在 MANIFEST.MF 文件中指定有什么区别呢？
答案是没有区别，细心的读者会发现 implementation属性，其值为 "~.ManifestResourceTransformer"，意思是 Manifest 资源文件转换器。上述示例只自指定了启动类，因此 shade 会为我们自动生成一个包含 Main-Class 的 MANIFEST.MF 文件，然后在打 jar 包时指定这个文件。
那如果我们想要完全定制 MANIFEST.MF 文件内容怎么办呢？我们可以使用
<project>
...
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<manifestEntries>
<Main-Class>cn.fileserver.HttpFileServerMain-Class>
<Build-Number>123Build-Number>
manifestEntries>
transformer>
transformers>
configuration>
...
project>
此时的 MANIFEST.MF
Manifest-Version: 1.0
Build-Number: 123
Archiver-Version: Plexus Archiver
Built-By: lvxy
Created-By: Apache Maven 3.8.1
Build-Jdk: 1.8.0_261
Main-Class: cn.fileserver.HttpFileServer
4 生成资源文件
项目中涉及到的依赖可能会有它们所必需的资源文件，使用 shade 可以把它们聚合在同一个 jar 包中。
默认地，shade 为我们提供了 12 个 ResourceTransformer 类：
| 类名 | 作用 |
|---|---|
| ApacheLicenseResourceTransformer | 防止 LICENSE 文件重复 |
| ApacheNoticeResourceTransformer | 准备合并的 NOTICE |
| AppendingTransformer | 为某个资源文件附加内容 |
| ComponentsXmlResourceTransformer | 聚合 Plexus components.xml |
| DontIncludeResourceTransformer | 防止包含指定的资源 |
| GroovyResourceTransformer | 合并 Apache Groovy 的扩展模块 |
| IncludeResourceTransformer | 添加项目中的文件为资源文件 |
| ManifestResourceTransformer | 自定义 MANIFEST 文件 |
| PluginXmlResourceTransformer | 聚合 Maven 的 plugin.xml 配置 |
| ResourceBundleAppendingTransformer | 合并 ResourceBundles |
| ServicesResourceTransformer | 重定位且合并 META-INF/services 资源文件中的 class 文件. |
| XmlAppendingTransformer | 为 XML 资源文件附加内容 |
这里介绍一些常用的Transformer,
更多的Transformer见:
http://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html
4.1 ManifestResourceTransformer
往MANIFEST文件中写入Main-Class是可执行包的必要条件。ManifestResourceTransformer可以轻松实现。
<configuration>
<transformers>
<transformer
implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>com.lcifn.ApplicationmainClass>
transformer>
transformers>
configuration>
4.2 AppendingTransformer
用来处理多个jar包中存在重名的配置文件的合并，尤其是spring。
<configuration>
<transformers>
<transformer
implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.handlersresource>
transformer>
<transformer
implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.schemasresource>
transformer>
transformers>
configuration>
4.3 ServicesResourceTransformer
JDK的服务发现机制是基于META-INF/services/目录的，如果同一接口存在多个实现需要合并 ，则可以使用此Transformer。
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
transformers>
configuration>
5 原始构件与shade构件
默认情况下，shade插件会覆盖基于项目的jar包，而生成包含所有依赖的jar包。但有时需要原始的jar包和shade后的jar包同时被部署，可以配置如下。
<configuration>
<shadedArtifactAttached>trueshadedArtifactAttached>
<shadedClassifierName>execshadedClassifierName>
configuration>
参考文章：
https://blog.51cto.com/u_15127499/2672787
https://blog.csdn.net/iflink/article/details/122389637