基本用法

构建Maven项目的时候,如果没有进行特殊的配置,Maven会按照标准的目录结构查找和处理各种类型文件。
src/main/java和src/test/java
这两个目录中的所有*.java文件会分别在comile和test-comiple阶段被编译,编译结果分别放到了target/classes和targe/test-classes目录中,但是这两个目录中的其他文件都会被忽略掉。
src/main/resouces和src/test/resources
这两个目录中的文件也会分别被复制到target/classes和target/test-classes目录中。
target/classes
打包插件默认会把这个目录中的所有内容打入到jar包或者war包中。

配置示例

  1. <build>
  2. <finalName>${project.parent.artifactId}-${project.version}</finalName>
  3. <resources>
  4. <!-- 所有profile共用的配置文件路径 -->
  5. <resource>
  6. <directory>src/main/resources/common</directory>
  7. </resource>
  8. <!-- 当前profile专用的配置文件路径 -->
  9. <resource>
  10. <directory>src/main/resources/${extra-resource-dir}</directory>
  11. </resource>
  12. <resource>
  13. <directory>src/main/webapp</directory>
  14. <filtering>true</filtering>
  15. <includes>
  16. <include>WEB-INF/web.xml</include>
  17. </includes>
  18. <targetPath>${project.build.directory}/${project.build.finalName}</targetPath>
  19. </resource>
  20. </resources>
  21. </build>
  22. <!-- 打包环境 -->
  23. <profiles>
  24. <!-- 本机开发环境 -->
  25. <profile>
  26. <id>dev</id>
  27. <properties>
  28. <extra-resource-dir>dev</extra-resource-dir>
  29. </properties>
  30. </profile>
  31. <!-- 测试环境 -->
  32. <profile>
  33. <id>test</id>
  34. <activation>
  35. <activeByDefault>true</activeByDefault>
  36. </activation>
  37. <properties>
  38. <extra-resource-dir>test</extra-resource-dir>
  39. <oceanus.auth.rehearse>false</oceanus.auth.rehearse>
  40. </properties>
  41. </profile>
  42. <!-- 生产环境 -->
  43. <profile>
  44. <id>prod</id>
  45. <properties>
  46. <extra-resource-dir>prod</extra-resource-dir>
  47. </properties>
  48. </profile>
  49. </profiles>

当前配置在Web模块的pom文件里。执行mvn package -P dev 后把resource下common目录下里文件全部打包到target/class目录下,同时执行属性替换(如extra-resource-dir取指定profile里的属性Key)后,把extra-resource-dir目录里的文件也全部打包到target/class目录下,如果存在相同目录则只复制文件。

源代码结构:

  1. test-web (模块名,packing=war,version=1.0-SNAPSHOT)
  2. --src
  3. --main
  4. --java
  5. --resources
  6. --common
  7. --spring/spring_common.xml
  8. --dev
  9. --spring/spring_dev.xml
  10. --test
  11. --spring/spring_test.xml
  12. --prod
  13. --spring/spring_prod.xml

如打包命令为:mvn clean package -P dev 打包后:

  1. test-web-1.0-SNAPSHOT
  2. --META-INF
  3. --WEB-INF
  4. --web.xml
  5. --lib(依赖的jar,工程内部的或三方外部的)
  6. --classes(本模块java源代码编译后的class+打包后的资源文件)
  7. --spring
  8. --spring_common.xml
  9. --spring_dev.xml

把common,dev目录下的资源都复制到classes目录下。

截图示例

  1. <build>
  2. <finalName>${project.artifactId}-${project.version}</finalName>
  3. <resources>
  4. <resource>
  5. <directory>src/main/resources/spring</directory>
  6. </resource>
  7. <resource>
  8. <directory>src/main/resources/${extra}</directory>
  9. </resource>
  10. </resources>
  11. <pluginManagement>
  12. </pluginManagement>
  13. </build>
  14. <profiles>
  15. <profile>
  16. <id>dev</id>
  17. <properties>
  18. <extra>dev</extra>
  19. </properties>
  20. </profile>
  21. <profile>
  22. <id>prod</id>
  23. <properties>
  24. <extra>prod</extra>
  25. </properties>
  26. </profile>
  27. </profiles>

image.png
已配置resource,不使用默认的打包策略。

打包时资源文件的配置

默认打包资源文件

在每个模块里的pom.xml, 如果不配置额外插件或不单独定义resources标签,maven会把resource目录下的文件或目录全部打包到WEB-INF/classes目录里。

打包src/main/java目录下的xml

一般情况下,我们用到的资源文件(各种xml,properites,xsd文件等)都放在src/main/resources下面,利用maven打包时,maven能把这些资源文件打包到相应的jar或者war里。
有时候,比如mybatis的mapper.xml文件,我们习惯把它和Mapper.java放一起,都在src/main/java下面,这样利用maven打包时,就需要修改pom.xml文件,来把mapper.xml文件一起打包进jar或者war里了,否则,这些文件不会被打包的。(maven认为src/main/java只是java的源代码路径)

配置POM.XML的resource把xml也打包到mapper目录下

  1. <build>
  2. <!-- 资源目录 -->
  3. <resources>
  4. <resource>
  5. <!-- 设定主资源目录 -->
  6. <directory>src/main/java</directory>
  7. <!-- maven default生命周期,process-resources阶段执行maven-resources-plugin插件的resources目标处理主资源目下的资源文件时,只处理如下配置中包含的资源类型 -->
  8. <includes>
  9. <include>**/*.xml</include>
  10. </includes>
  11. <!-- maven default生命周期,process-resources阶段执行maven-resources-plugin插件的resources目标处理主资源目下的资源文件时,不处理如下配置中包含的资源类型(剔除下如下配置中包含的资源类型)-->
  12. <excludes>
  13. <exclude>**/*.yaml</exclude>
  14. </excludes>
  15. <!-- maven default生命周期,process-resources阶段执行maven-resources-plugin插件的resources目标处理主资源目下的资源文件时,指定处理后的资源文件输出目录,默认是${build.outputDirectory}指定的目录-->
  16. <!--<targetPath>${build.outputDirectory}</targetPath> -->
  17. <!-- maven default生命周期,process-resources阶段执行maven-resources-plugin插件的resources目标处理主资源目下的资源文件时,是否对主资源目录开启资源过滤 -->
  18. <filtering>true</filtering>
  19. </resource>
  20. </resources>
  21. </build>

其中*/这样的写法,是为了保证各级子目录下的资源文件被打包。resources是可以看做是容器,这个容器里面可以放很多个像resource这样的配置。而directory就是配置文件所在的路径,includes从英文单词角度看,就是包含的意思,此时在执行命令,就会把xml也打包到mapper目录下了。

tatgetPath配置打包的war路径,默认为${build.outputDirectory},为项目根目录
Maven的默认配置变量如下:

  1. <directory>${project.basedir}/target</directory>
  2. <outputDirectory>${project.build.directory}/classes</outputDirectory>
  3. <finalName>${project.artifactId}-${project.version}</finalName>
  4. <testOutputDirectory>${project.build.directory}/test-classes</testOutputDirectory>
  5. <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
  6. <scriptSourceDirectory>${project.basedir}/src/main/scripts</scriptSourceDirectory>
  7. <testSourceDirectory>${project.basedir}/src/test/java</testSourceDirectory>
  8. <resources>
  9. <resource>
  10. <directory>${project.basedir}/src/main/resources</directory>
  11. </resource>
  12. </resources>

maven-resources-plugin插件

为了使项目结构更为清晰,Maven区别对待Java代码文件和资源文件,maven-compiler-plugin用来编译Java代码,maven-resources-plugin则用来处理资源文件。

默认的主资源文件目录是src/main/resources,很多用户会需要添加额外的资源文件目录,这个时候就可以通过配置maven-resources-plugin来实现。

  1. <!--
  2. 此plugin可以用
  3. 利用此plugin,把源代码中的xml文件,打包到相应位置,
  4. 这里主要是为了打包Mybatis的mapper.xml文件
  5. -->
  6. <plugin>
  7. <artifactId>maven-resources-plugin</artifactId>
  8. <version>2.5</version>
  9. <executions>
  10. <execution>
  11. <id>copy-xmls</id>
  12. <phase>process-sources</phase>
  13. <goals>
  14. <goal>copy-resources</goal>
  15. </goals>
  16. <configuration>
  17. <outputDirectory>${basedir}/target/classes</outputDirectory>
  18. <resources>
  19. <resource>
  20. <directory>${basedir}/src/main/java</directory>
  21. <includes>
  22. <include>**/*.xml</include>
  23. </includes>
  24. </resource>
  25. </resources>
  26. </configuration>
  27. </execution>
  28. </executions>
  29. </plugin>

src/main/resources目录下的xml等资源文件不被打包

默认resources目录下的文件都会被打包,如果想resources目录下的xml文件不被打包,可通过如下配置:

  1. <!--过滤resource下的文件-->
  2. <resources>
  3. <resource>
  4. <directory>src/main/resources</directory>
  5. <includes>
  6. <include>*.properties</include> <!--打包properties文件-->
  7. </includes>
  8. <excludes>
  9. <exclude>*.xml</exclude> <!--过滤xml与yaml文件-->
  10. <exclude>*.yaml</exclude>
  11. </excludes>
  12. </resource>
  13. </resources>

当然也可以通过插件来实现

  1. <plugin>
  2. <artifactId>maven-resources-plugin</artifactId>
  3. <executions>
  4. <execution>
  5. <id>copy-resources</id>
  6. <phase>validate</phase>
  7. <goals>
  8. <goal>copy-resources</goal>
  9. </goals>
  10. <configuration>
  11. <!-- 并把文件复制到target/conf目录下-->
  12. <outputDirectory>${project.build.directory}/conf</outputDirectory>
  13. <resources>
  14. <resource>
  15. <directory>src/main/resources</directory>
  16. <!-- 指定不需要处理的资源 <excludes> <exclude>WEB-INF/*.*</exclude> </excludes> -->
  17. <excludes> <exclude>**/*.xml</exclude> </excludes>
  18. <filtering>true</filtering>
  19. </resource>
  20. </resources>
  21. </configuration>
  22. </execution>
  23. </executions>
  24. </plugin>

编译好之后,会在target目录下生成conf目录并且把resources目录下的所有文件都自动拷贝到target/conf/目录下.

参考原文链接

https://blog.csdn.net/u011781521/java/article/details/79052725