Maven打包方式,以及jar包冲突问题的解决方法

一、打包方式:

Maven可以使用mvn package指令对项目进行打包,如果使用Java -jar xxx.jar执行运行jar文件,会出现"no main manifest attribute, in xxx.jar"(没有设置Main-Class)、ClassNotFoundException(找不到依赖包)等错误。

要想jar包能直接通过java -jar xxx.jar运行,需要满足:

1、在jar包中的META-INF/MANIFEST.MF中指定Main-Class,这样才能确定程序的入口在哪里;

2、要能加载到依赖包。

使用Maven有以下几种方法可以生成能直接运行的jar包,可以根据需要选择一种合适的方法。

方法一:使用maven-jar-plugin和maven-dependency-plugin插件打包

在pom.xml中配置:

[html]  view plain  copy
  1. <build>  
  2.     <plugins>  
  3.   
  4.         <plugin>  
  5.             <groupId>org.apache.maven.plugins</groupId>  
  6.             <artifactId>maven-jar-plugin</artifactId>  
  7.             <version>2.6</version>  
  8.             <configuration>  
  9.                 <archive>  
  10.                     <manifest>  
  11.                         <addClasspath>true</addClasspath>  
  12.                         <classpathPrefix>lib/</classpathPrefix>  
  13.                         <mainClass>com.xxg.Main</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.             <version>2.10</version>  
  22.             <executions>  
  23.                 <execution>  
  24.                     <id>copy-dependencies</id>  
  25.                     <phase>package</phase>  
  26.                     <goals>  
  27.                         <goal>copy-dependencies</goal>  
  28.                     </goals>  
  29.                     <configuration>  
  30.                         <outputDirectory>${project.build.directory}/lib</outputDirectory>  
  31.                     </configuration>  
  32.                 </execution>  
  33.             </executions>  
  34.         </plugin>  
  35.   
  36.     </plugins>  
  37. </build>  

maven-jar-plugin用于生成META-INF/MANIFEST.MF文件的部分内容,<mainClass>com.xxg.Main</mainClass>指定MANIFEST.MF中的Main-Class,<addClasspath>true</addClasspath>会在MANIFEST.MF加上Class-Path项并配置依赖包,<classpathPrefix>lib/</classpathPrefix>指定依赖包所在目录。

例如下面是一个通过maven-jar-plugin插件生成的MANIFEST.MF文件片段:

[html]  view plain  copy
  1. Class-Path: lib/commons-logging-1.2.jar lib/commons-io-2.4.jar  
  2. Main-Class: com.xxg.Main  

只是生成MANIFEST.MF文件还不够,maven-dependency-plugin插件用于将依赖包拷贝到<outputDirectory>${project.build.directory}/lib</outputDirectory>指定的位置,即lib目录下。

配置完成后,通过mvn package指令打包,会在target目录下生成jar包,并将依赖包拷贝到target/lib目录下,目录结构如下:

指定了Main-Class,有了依赖包,那么就可以直接通过java -jar xxx.jar运行jar包。

这种方式生成jar包有个缺点,就是生成的jar包太多不便于管理,下面两种方式只生成一个jar文件,包含项目本身的代码、资源以及所有的依赖包

方法二:使用maven-assembly-plugin插件打包

在pom.xml中配置:

[html]  view plain  copy
  1. <build>  
  2.     <plugins>  
  3.   
  4.         <plugin>  
  5.             <groupId>org.apache.maven.plugins</groupId>  
  6.             <artifactId>maven-assembly-plugin</artifactId>  
  7.             <version>2.5.5</version>  
  8.             <configuration>  
  9.                 <archive>  
  10.                     <manifest>  
  11.                         <mainClass>com.xxg.Main</mainClass>  
  12.                     </manifest>  
  13.                 </archive>  
  14.                 <descriptorRefs>  
  15.                     <descriptorRef>jar-with-dependencies</descriptorRef>  
  16.                 </descriptorRefs>  
  17.             </configuration>  
  18.         </plugin>  
  19.   
  20.     </plugins>  
  21. </build>  

打包方式:

[html]  view plain  copy
  1. mvn package assembly:single  

打包后会在target目录下生成一个xxx-jar-with-dependencies.jar文件,这个文件不但包含了自己项目中的代码和资源,还包含了所有依赖包的内容。所以可以直接通过java -jar来运行。

此外还可以直接通过mvn package来打包,无需assembly:single,不过需要加上一些配置:

[html]  view plain  copy
  1. <build>  
  2.     <plugins>  
  3.   
  4.         <plugin>  
  5.             <groupId>org.apache.maven.plugins</groupId>  
  6.             <artifactId>maven-assembly-plugin</artifactId>  
  7.             <version>2.5.5</version>  
  8.             <configuration>  
  9.                 <archive>  
  10.                     <manifest>  
  11.                         <mainClass>com.xxg.Main</mainClass>  
  12.                     </manifest>  
  13.                 </archive>  
  14.                 <descriptorRefs>  
  15.                     <descriptorRef>jar-with-dependencies</descriptorRef>  
  16.                 </descriptorRefs>  
  17.             </configuration>  
  18.             <executions>  
  19.                 <execution>  
  20.                     <id>make-assembly</id>  
  21.                     <phase>package</phase>  
  22.                     <goals>  
  23.                         <goal>single</goal>  
  24.                     </goals>  
  25.                 </execution>  
  26.             </executions>  
  27.         </plugin>  
  28.   
  29.     </plugins>  
  30. </build>  

其中<phase>package</phase>、<goal>single</goal>即表示在执行package打包时,执行assembly:single,所以可以直接使用mvn package打包。

不过,如果项目中用到spring Framework,用这种方式打出来的包运行时会出错,使用下面的方法三可以处理。

方法三:使用maven-shade-plugin插件打包

在pom.xml中配置:

[html]  view plain  copy
  1. <build>  
  2.     <plugins>  
  3.   
  4.         <plugin>  
  5.             <groupId>org.apache.maven.plugins</groupId>  
  6.             <artifactId>maven-shade-plugin</artifactId>  
  7.             <version>2.4.1</version>  
  8.             <executions>  
  9.                 <execution>  
  10.                     <phase>package</phase>  
  11.                     <goals>  
  12.                         <goal>shade</goal>  
  13.                     </goals>  
  14.                     <configuration>  
  15.                         <transformers>  
  16.                             <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">  
  17.                                 <mainClass>com.xxg.Main</mainClass>  
  18.                             </transformer>  
  19.                         </transformers>  
  20.                     </configuration>  
  21.                 </execution>  
  22.             </executions>  
  23.         </plugin>  
  24.   
  25.     </plugins>  
  26. </build>  

配置完成后,执行mvn package即可打包。在target目录下会生成两个jar包,注意不是original-xxx.jar文件,而是另外一个。和maven-assembly-plugin一样,生成的jar文件包含了所有依赖,所以可以直接运行。

如果项目中用到了Spring Framework,将依赖打到一个jar包中,运行时会出现读取XML schema文件出错。原因是Spring Framework的多个jar包中包含相同的文件spring.handlers和spring.schemas,如果生成一个jar包会互相覆盖。为了避免互相影响,可以使用AppendingTransformer来对文件内容追加合并:



二、项目中遇到的问题


背景:使用spring+maven的方式写了个从kafka取数存入到hive的程序

首先使用maven-assembly-plugin进行打包

在网上查了相关Maven配置如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<build> 
     <plugins> 
   
         <plugin> 
             <groupId>org.apache.maven.plugins</groupId> 
             <artifactId>maven-assembly-plugin</artifactId> 
             <version> 2.5 . 5 </version> 
             <configuration> 
                 <archive> 
                     <manifest> 
                         <mainClass>com.xxg.Main</mainClass> 
                     </manifest> 
                 </archive> 
                 <descriptorRefs> 
                     <descriptorRef>jar-with-dependencies</descriptorRef> 
                 </descriptorRefs> 
             </configuration> 
             <executions> 
                 <execution> 
                     <id>make-assembly</id> 
                     <phase> package </phase> 
                     <goals> 
                         <goal>single</goal> 
                     </goals> 
                 </execution> 
             </executions> 
         </plugin> 
   
     </plugins> 
</build>

使用mvn package打包,抛出如下错误:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
org.springframework.beans.factory.parsing.BeanDefinitionParsingException: Configuration problem: Unable to locate Spring NamespaceHandler for XML schema namespace [http: //www.springframework.org/schema/aop]
Offending resource: class path resource [beans.xml]
 
at org.springframework.beans.factory.parsing.FailFastProblemReporter.error(FailFastProblemReporter.java: 68 )
at org.springframework.beans.factory.parsing.ReaderContext.error(ReaderContext.java: 85 )
at org.springframework.beans.factory.parsing.ReaderContext.error(ReaderContext.java: 80 )
at org.springframework.beans.factory.xml.BeanDefinitionParserDelegate.error(BeanDefinitionParserDelegate.java: 284 )
at org.springframework.beans.factory.xml.BeanDefinitionParserDelegate.parseCustomElement(BeanDefinitionParserDelegate.java: 1335 )
at org.springframework.beans.factory.xml.BeanDefinitionParserDelegate.parseCustomElement(BeanDefinitionParserDelegate.java: 1328 )
at org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader.parseBeanDefinitions(DefaultBeanDefinitionDocumentReader.java: 135 )
at org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader.registerBeanDefinitions(DefaultBeanDefinitionDocumentReader.java: 93 )
at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.registerBeanDefinitions(XmlBeanDefinitionReader.java: 493 )
at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.doLoadBeanDefinitions(XmlBeanDefinitionReader.java: 390 )
at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java: 334 )
at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java: 302 )
at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java: 143 )
at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java: 178 )
at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java: 149 )
at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java: 212 )
at org.springframework.context.support.AbstractXmlApplicationContext.loadBeanDefinitions(AbstractXmlApplicationContext.java: 126 )
at org.springframework.context.support.AbstractXmlApplicationContext.loadBeanDefinitions(AbstractXmlApplicationContext.java: 92 )
at org.springframework.context.support.AbstractRefreshableApplicationContext.refreshBeanFactory(AbstractRefreshableApplicationContext.java: 130 )
at org.springframework.context.support.AbstractApplicationContext.obtainFreshBeanFactory(AbstractApplicationContext.java: 467 )
at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java: 397 )
at org.springframework.context.support.ClassPathXmlApplicationContext.<init>(ClassPathXmlApplicationContext.java: 139 )
at org.springframework.context.support.ClassPathXmlApplicationContext.<init>(ClassPathXmlApplicationContext.java: 83 )
at cn.com.ckx.service.UserServiceTest.testAdd(UserServiceTest.java: 11 )
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java: 39 )
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java: 25 )
at java.lang.reflect.Method.invoke(Method.java: 597 )
at org.junit.runners.model.FrameworkMethod$ 1 .runReflectiveCall(FrameworkMethod.java: 44 )
at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java: 15 )
at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java: 41 )
at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java: 20 )
at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java: 76 )
at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java: 50 )
at org.junit.runners.ParentRunner$ 3 .run(ParentRunner.java: 193 )
at org.junit.runners.ParentRunner$ 1 .schedule(ParentRunner.java: 52 )
at org.junit.runners.ParentRunner.runChildren(ParentRunner.java: 191 )
at org.junit.runners.ParentRunner.access$ 000 (ParentRunner.java: 42 )
at org.junit.runners.ParentRunner$ 2 .evaluate(ParentRunner.java: 184 )
at org.junit.runners.ParentRunner.run(ParentRunner.java: 236 )
at org.eclipse.jdt.internal.junit4.runner.JUnit4TestReference.run(JUnit4TestReference.java: 49 )
at org.eclipse.jdt.internal.junit.runner.TestExecution.run(TestExecution.java: 38 )
at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java: 467 )
at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java: 683 )
at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java: 390 )
at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java: 197 )

查了网上的资料,发现是对应jar包没有添加。可是查了半天发现pom中的依赖都是全的。

解决:使用maven-shade-plugin进行打包

如果项目中用到了Spring Framework,将依赖打到一个jar包中,运行时会出现读取XML schema文件出错。原因是Spring Framework的多个jar包中包含相同的文件spring.handlers和spring.schemas,如果生成一个jar包会互相覆盖。为了避免互相影响,可以使用AppendingTransformer来对文件内容追加合并:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<build> 
     <plugins> 
   
         <plugin> 
             <groupId>org.apache.maven.plugins</groupId> 
             <artifactId>maven-shade-plugin</artifactId> 
             <version> 2.4 . 1 </version> 
             <executions> 
                 <execution> 
                     <phase> package </phase> 
                     <goals> 
                         <goal>shade</goal> 
                     </goals> 
                     <configuration> 
                         <transformers> 
                             <transformer implementation= "org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"
                                 <mainClass>com.xxg.Main</mainClass> 
                             </transformer> 
                             <transformer implementation= "org.apache.maven.plugins.shade.resource.AppendingTransformer"
                                 <resource>META-INF/spring.handlers</resource> 
                             </transformer> 
                             <transformer implementation= "org.apache.maven.plugins.shade.resource.AppendingTransformer"
                                 <resource>META-INF/spring.schemas</resource> 
                             </transformer> 
                         </transformers> 
                     </configuration> 
                 </execution> 
             </executions> 
         </plugin> 
   
     </plugins> 
</build>

再次报错:

1
java.lang.SecurityException: Invalid signature file digest for Manifest main attributes

这是由于一些包重复引用,打包后的 META-INF 目录多出了一些 *.SF 等文件所致。

pom中添加:

1
2
3
4
5
6
7
8
9
10
11
12
<configuration>
           <filters>
             <filter>
               <artifact>*:*</artifact>
               <excludes>
                 <exclude>META-INF/*.SF</exclude>
                 <exclude>META-INF/*.DSA</exclude>
                 <exclude>META-INF/*.RSA</exclude>
               </excludes>
             </filter>
           </filters>
</configuration>

显示结果如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<build>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
                 <version> 1.4 </version>
                 <executions>
                     <execution>
                         <phase> package </phase>
                         <goals>
                             <goal>shade</goal>
                         </goals>
                         <configuration>
                             <filters>
                                 <filter>
                                     <artifact>*:*</artifact>
                                     <excludes>
                                         <exclude>META-INF/*.SF</exclude>
                                         <exclude>META-INF/*.DSA</exclude>
                                         <exclude>META-INF/*.RSA</exclude>
                                     </excludes>
                                 </filter>
                             </filters>
                             <transformers>
                                 <transformer
                                     implementation= "org.apache.maven.plugins.shade.resource.ManifestResourceTransformer" >
                                     <mainClass>com.defonds.RsaEncryptor</mainClass>
                                 </transformer>
                                 <transformer
                                     implementation= "org.apache.maven.plugins.shade.resource.AppendingTransformer" >
                                     <resource>META-INF/spring.handlers</resource>
                                 </transformer>
                                 <transformer
                                     implementation= "org.apache.maven.plugins.shade.resource.AppendingTransformer" >
                                     <resource>META-INF/spring.schemas</resource>
                                 </transformer>
                             </transformers>
                         </configuration>
                     </execution>
                 </executions>
             </plugin>
         </plugins>
     </build>

再次报错:提示 java.lang.NoSuchFieldError: INSTANCE,根据异常提示查了查代码发现是httpclients引用的包冲突了,代码如下


再次,在pom文件中增加如下几行,

<relocations>

<relocation>

<pattern>org.apache.http</pattern>

<shadedPattern>shade.org.apache.http</shadedPattern>

</relocation>

</relocations>

目的是吧org.apache.http转换成shade.org.apache.http(这个包名可以自己定义),另外,依然要加依赖包


通过clean install -Dmaven.test.skip=true命令打包,打包成功过后在服务器上运行,测试成功。


  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值