maven-war-plugin

最新推荐文章于 2024-07-31 14:15:43 发布
最新推荐文章于 2024-07-31 14:15:43 发布
阅读量4.3k 收藏 1
点赞数
分类专栏： maven

Apache Maven WAR Plugin

The WAR Plugin is responsible for collecting all artifact dependencies, classes and resources of the web application and packaging them into a web application archive.

“打包“这个词听起来比较土，比较正式的说法应该是”构建项目软件包“，具体说就是将项目中的各种文件，比如源代码、编译生成的字节码、配置文件、文档，按照规范的格式生成归档，最常见的当然就是JAR包和WAR包了，复杂点的例子是Maven官方下载页面的分发包，它有自定义的格式，方便用户直接解压后就在命令行使用。作为一款”打包工具“，Maven自然有义务帮助用户创建各种各样的包，规范的JAR包和WAR包自然不再话下，略微复杂的自定义打包格式也必须支持，本文就介绍一些常用的打包案例以及相关的实现方式，除了前面提到的一些包以外，你还能看到如何生成源码包、Javadoc包、以及从命令行可直接运行的CLI包。

任何一个Maven项目都需要定义POM元素packaging（如果不写则默认值为jar）。顾名思义，该元素决定了项目的打包方式。实际的情形中，如果你不声明该元素，Maven会帮你生成一个JAR包；如果你定义该元素的值为war，那你会得到一个WAR包；如果定义其值为POM（比如是一个父模块），那什么包都不会生成。除此之外，Maven默认还支持一些其他的流行打包格式，例如ejb3和ear。你不需要了解具体的打包细节，你所需要做的就是告诉Maven，”我是个什么类型的项目“，这就是约定优于配置的力量。

对应于同样的package生命周期阶段，Maven为jar项目调用了maven-jar-plugin，为war项目调用了maven-war-plugin，换言之，packaging直接影响Maven的构建生命周期。了解这一点非常重要，特别是当你需要自定义打包行为的时候，你就必须知道去配置哪个插件。

war plugin的常用配置参数

archiveClasses配置项

该配置的值为true|false，默认是false。表示是否将class进行打包。
正常情况下war类型的工程，java代码编译后的类文件会放到WEB-INF/classes目录下面，散装。 当该参数配置为true时，会将所有的class打包为一个jar，jar的名字与war的名字一致（除了后缀）。然后把这个jar放到WEB-INF/lib目录下，此时WEB-INF/classes目录下是空的。

attachClasses配置项

该配置的值为true|false，默认是false。表示在发布war包的时候是否同时发布一个jar包（只有classes，不包含页面相关文件）。
正常情况下war类型的工程，当我们执行install或者deploy的时候build出一个war包，安装到本地或者发布到远程。
当该参数配置为true时，除了war包外还会多出一个jar包，不过该jar包的classifier默认为classes。

overlays配置节点

overlays配置的作用是，将指定war包中的内容与当前项目进行合并。合并策略：如果存在同名冲突，则使用当前项目中的文件。 overlay的具体配置项（include|exclude）可以指定包含或者排除特定模式的文件。

配置示例

多war合并

archiveClasses和attachClasses参数可以同时配置为true。此时打包文件中含有lib，不含classes。发布时会同时发布classifier为classes的jar包。

如果当前工程A需要从B工程的war包中合入页面文件，同时代码中也要使用B的类文件。工程B包含配置如下：

 

1

2

3

4

5

6

7

8

 
 

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-war-plugin</artifactId>

<version>2.6</version>

<configuration>

<attachClasses>true</attachClasses>

</configuration>

</plugin>

 

工程A包含配置如下：

 

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

 
 

<dependencies>

<dependency>

<groupId>groupB</groupId>

<artifactId>B</artifactId>

<version>1.0-SNAPSHOT</version>

<classifier>classes</classifier>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>groupB</groupId>

<artifactId>B</artifactId>

<version>1.0-SNAPSHOT</version>

<type>war</type>

</dependency>

</dependencies>

<build>

<plugins>

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-war-plugin</artifactId>

<version>2.6</version>

<configuration>

<overlays>

<overlay>

<groupId>groupB</groupId>

<artifactId>B</artifactId>

</overlay>

</overlays>

</configuration>

</plugin>

</plugins>

</build>

可注意如果同名的文件夹会进行合并，不合并空文件夹。

把class文件打包成jar，怎么排除resources目录?

正常情况下war类型的工程，java代码编译后的类文件会放到WEB-INF/classes目录下面，散装。 当archiveClasses参数配置为true时，会将所有的class打包为一个jar，jar的名字与war的名字一致。然后把这个jar放到WEB-INF/lib目录下，此时WEB-INF/classes目录下是空的，但如果想在war包的WEB-INF/classes中保留logback.xml配置文件，该怎么做？

 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

 
 

<plugin>

<artifactId>maven-war-plugin</artifactId>

<version>3.0.0</version>

<configuration>

<archiveClasses>true</archiveClasses>

<webResources>

<resource>

<directory>src/main/resources</directory>

<targetPath>WEB-INF/classes</targetPath>

<filtering>true</filtering>

</resource>

</webResources>

</configuration>

</plugin>

对项目进行动态打包，不同的环境使用不同的配置文件打包

demo 1

 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

 
 

project/

`-- src

|-- main

| |-- java

| |-- resources

| | |-- local

| | | |-- logback.xml

| | | |-- spring-dataSource.xml

| | | `-- variable.propertes

| | |-- product

| | | |-- logback.xml

| | | |-- spring-dataSource.xml

| | | `-- variable.propertes

| | `-- qa

| | |-- logback.xml

| | |-- spring-dataSource.xml

| | `-- variable.propertes

| |-- webapp

`-- test

 

1

2

 
 

maven package –P local 开发环境

maven package –P product 生产环境

 

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

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

 
 

<profiles>

<profile>

<id>local</id>

<properties>

<package.environment>local</package.environment>

</properties>

<activation>

<activeByDefault>true</activeByDefault>

</activation>

</profile>

<profile>

<id>product</id>

<properties>

<package.environment>product</package.environment>

</properties>

</profile>

</profiles>

<build>

<resources>

<!-- class文件打包成jar包，排除相关配置文件和jrebel配置文件 -->

<resource>

<directory>src/main/resources</directory>

<excludes>

<exclude>local/*</exclude>

<exclude>product/*</exclude>

<exclude>rebel.xml</exclude>

</excludes>

<filtering>true</filtering>

</resource>

</resources>

<plugins>

<!-- 区别dev环境与生产环境logback.xml配置 -->

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-war-plugin</artifactId>

<configuration>

<archiveClasses>true</archiveClasses>

<failOnMissingWebXml>false</failOnMissingWebXml>

<webResources>

<resource>

<directory>src/main/resources/${package.environment}</directory>

<filtering>true</filtering>

<targetPath>WEB-INF/classes</targetPath>

</resource>

</webResources>

</configuration>

</plugin>

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-jar-plugin</artifactId>

<executions>

<execution>

<id>default-jar</id>

<phase>package</phase>

<goals>

<goal>jar</goal>

</goals>

</execution>

</executions>

</plugin>

</plugins>

</build>

demo 2

 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

 
 

project/

`-- src

|-- main

| |-- java

| |-- env

| | |-- dev

| | | |-- log4j.properties

| | | |-- spring-dataSource.xml

| | | `-- variable.propertes

| | |-- prod

| | | |-- log4j.properties

| | | |-- spring-dataSource.xml

| | | `-- variable.propertes

| | `-- qa

| | |-- log4j.properties

| | |-- spring-dataSource.xml

| | `-- variable.propertes

| |-- resources

| `-- webapp

`-- test

 

1

2

 
 

mvn clean package -P dev

mvn clean package -P qa

 

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

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

 
 

<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/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<packaging>war</packaging>

<version>0.0.1-SNAPSHOT</version>

<name>demo Maven Webapp</name>

<groupId>webapp</groupId>

<artifactId>webapp</artifactId>

<scm>

<connection>scm:svn:http://127.0.0.1/dummy</connection>

<developerConnection>scm:svn:https://127.0.0.1/dummy</developerConnection>

<tag>HEAD</tag>

<url>http://127.0.0.1/dummy</url>

</scm>

<properties>

<spring-version>3.1.0.RELEASE</spring-version>

</properties>

<build>

<finalName>${final.name}</finalName>

<plugins>

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-war-plugin</artifactId>

<version>2.1.1</version>

<configuration>

<overlays>

<overlay>

<groupId>TransactionResource</groupId>

<artifactId>TransactionResource</artifactId>

<excludes>

<exclude>WEB-INF/web.xml</exclude>

</excludes>

</overlay>

</overlays>

<webResources>

<resource>

<directory>${runtime.env}</directory>

<targetPath>WEB-INF/classes</targetPath>

</resource>

</webResources>

</configuration>

</plugin>

</plugins>

</build>

<dependencies>

……

</dependencies>

<profiles>

<profile>

<id>dev</id>

<activation>

<activeByDefault>true</activeByDefault>

</activation>

<properties>

<runtime.env>src/main/env/dev</runtime.env>

<final.name>webapp</final.name>

</properties>

<dependencies>

<dependency>

<groupId>com.eightqiu</groupId>

<artifactId>CodeCmns</artifactId>

<version>0.0.1-SNAPSHOT</version>

</dependency>

</dependencies>

</profile>

<profile>

<id>qa</id>

<properties>

<runtime.env>src/main/env/qa</runtime.env>

<final.name>webapp_${buildNumber}</final.name>

</properties>

<build>

<plugins>

<plugin>

<groupId>org.codehaus.mojo</groupId>

<artifactId>buildnumber-maven-plugin</artifactId>

<version>1.1</version>

<executions>

<execution>

<phase>validate</phase>

<goals>

<goal>create</goal>

</goals>

</execution>

</executions>

<configuration>

<format>{0,date,yyyyMMdd}</format>

<items>

<item>timestamp</item>

</items>

</configuration>

</plugin>

</plugins>

</build>

<reporting>

<plugins>

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-javadoc-plugin</artifactId>

<version>2.8.1</version>

</plugin>

</plugins>

</reporting>

<dependencies>

<dependency>

<groupId>com.eightqiu</groupId>

<artifactId>CodeCmns</artifactId>

<version>0.0.1-SNAPSHOT</version>

<scope>provided</scope>

</dependency>

</dependencies>

</profile>

<profile>

<id>prod</id>

<properties>

<runtime.env>src/main/env/prod</runtime.env>

<final.name>webapp</final.name>

</properties>

<dependencies>

<dependency>

<groupId>com.eightqiu</groupId>

<artifactId>CodeCmns</artifactId>

<version>0.0.1-SNAPSHOT</version>

<scope>provided</scope>

</dependency>

</dependencies>

</profile>

</profiles>

</project>

 

bingguang1993
关注
专栏目录
Maven-war-plugin插件
李度的博客
05-27 1万+
在项目开发中，A依赖于B，如果两个都是jar项目，那就好办，但是今天在项目中，遇到A和B都是war项目的时候，那就遇到棘手的时候了，编译会报错，错误描述如下： 错误描述可以发现，没有发现jar包，这样就需要用到Maven-war-plugin插件来把B项目生成jar包来给A依赖了，现在说说如何使用Maven-war-plugin插件 1、在A（pom.xml）配置：添加Maven-war-plugin。 <plugins> <plugin> ...
maven-war-plugin 详解
weixin_34205076的博客
06-08 3825
在进行项目发布的时候,可能会碰到这样的情况, 希望在保持项目源代码不变的前提下,希望能够针对不同的运行环境获得相应的运行包.(比如war包)那么使用配置文件是可以解决这个问题的.可以将项目中和运行环境相关的一些参数 放到配置文件中, 每个环境一份,这样,在打包前只要指定这次打包我需要指定这次打包需要哪个配置文件即可,于是就可以使运行包与环境相对应了.但是这样的做法有个不好...
maven-war-plugin-3.2.3.jar
02-26
java运行依赖jar包
maven-war-plugin：Apache Maven WAR插件
02-04
贡献给 您已发现错误或对超酷的新功能有任何想法？ 贡献代码是将某些东西还给开源社区的好方法。 在深入研究代码之前，我们需要一些准则供贡献者遵循，以便我们有机会掌握最新知识。 入门 确保您拥有。 确保您具有。 如果您打算实施一项新功能，则有必要先在上讨论您的更改。 这样，您可以确保您不会浪费时间在Apache Maven范围之外的东西上。 假设您的问题不存在，请提交该问题的票证。 清楚地描述问题，包括在出现错误时重现的步骤。 确保填写您知道存在问题的最早版本。 在GitHub上分叉存储库。 进行和提交更改 我们通过GitHub接受拉取请求。 是贡献者交流的主要渠道。 有一些准则可使
Maven 项目中的 maven-war-plugin 插件
最新发布
weixin_45131142的博客
07-31 317
targetPath>：指定资源在 WAR 文件中的目标路径，这里是 WEB-INF/lib/，表示将资源复制到 WAR 文件的 WEB-INF/lib/ 目录下。includes>：指定要包含的文件的通配符模式，这里是 **/*.jar，表示包含 src/main/resources 目录下所有的 .jar 文件。directory>：指定要包含的资源的目录，这里是 src/main/resources，表示将该目录下的资源包含在 WAR 文件中。
maven-war-plugin 插件报错解决
weixin_65287123的博客
03-21 1074
解决如下添加依赖。
maven-war-plugin插件
laughing
11-10 177
maven-war-plugin插件用于打包项目生成war包，读取属性文件中的可配置的值，比如数据源，spring中bean注入的地址等 ${user.home}/property.properties trademanager org.apache.maven.plugins maven-war-plugin 2....
maven安装、配置与plugins报红的解决方法
2301_81034686的博客
06-19 1320
本文章详细介绍maven的安装与配置过程以及项目中plugins报红的解决问题
Maven - "maven-war-plugin"的使用
热门推荐
小小默：进无止境
10-26 2万+
【1】默认方式将工程打war包这里不使用maven-war-plugin，使用默认配置安装工程：安装后本地仓库会有war包：也就是说，不使用插件的时候，默认的maven web工程打war包和你部署在tomcat时项目一致。【2】war包调用war包也就是说，一个maven web工程依赖另外一个maven工程。假设A依赖B。这里B的pom.xml如下： <plugin> <g
maven-war-plugin-2.2.jar
02-26
java运行依赖jar包
maven-war-plugin-2.1.jar
03-14
maven-war-plugin-2.1.jar
maven-war-plugin-2.1.1.jar
02-26
java运行依赖jar包
maven-war-plugin：Maven打war包时，排除和包含指定文件或目录
琦彦
12-10 2万+
通过使用&lt;packagingIncludes&gt;和&lt;packagingExcludes&gt;配置参数，可以在WAR文件中包含或排除某些文件或者目录。 可以通过逗号分隔，配置多个文件或者目录路径。 使用**等通配符表示多个目录，使用*表示文件或目录名称的可选部分。 **：可以删除当前文件夹和文件夹里的内容 示例1：从WEB-INF / lib中排除所有JAR文件 &...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值