当前位置：首页 > news >正文

maven中的maven-resources-plugin插件详解

news 来源：原创 2025/5/30 18:24:58

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到网站

一、插件定位与核心功能

maven-resources-plugin是Maven构建工具的核心插件之一，主要用于处理项目中的资源文件（如配置文件、静态资源、XML文件等）。其核心功能包括：

资源复制
将src/main/resources和src/test/resources目录下的资源文件复制到编译输出目录（如target/classes），确保运行时能正确加载资源。
• 默认行为：即使未在pom.xml中显式声明，Maven默认也会调用该插件。

• 扩展性：支持自定义资源目录，例如添加src/extra-resources作为额外资源来源。
资源过滤
允许在资源文件中使用占位符（如${property}），并在构建时动态替换为实际值。
• 典型场景：多环境配置（开发、测试、生产）中替换数据库连接参数或API密钥。

• 配置方式：在<resource>标签内设置<filtering>true</filtering>开启过滤功能。
包含与排除规则
通过<includes>和<excludes>标签精准控制哪些文件需要处理。
• 示例：仅处理.properties和.xml文件，排除*-dev.properties。

• 通配符语法：**/*.xml表示匹配所有子目录下的XML文件。

在这里插入图片描述

二、核心配置详解

以下为插件在pom.xml中的常见配置项：

基本配置结构

<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-resources-plugin</artifactId><version>3.3.0</version> <!-- 推荐使用最新版本 --><configuration><encoding>UTF-8</encoding> <!-- 资源文件编码 --><resources><resource><directory>src/main/resources</directory><includes><include>**/*.properties</include></includes><filtering>true</filtering></resource></resources></configuration></plugin></plugins>
</build>

关键参数说明
• <encoding>：指定资源文件编码（如UTF-8），避免乱码问题。

• <delimiters>：自定义占位符分隔符（默认${}），例如@property@。

• <nonFilteredFileExtensions>：禁止过滤特定文件类型（如.jpg、.xlsx），防止二进制文件损坏。

• <outputDirectory>：自定义资源输出路径（如target/config）。

多环境配置示例
结合Maven的<profiles>实现不同环境的动态切换：

<profiles><profile><id>dev</id><properties><db.url>jdbc:mysql://localhost:3306/dev</db.url></properties></profile><profile><id>prod</id><properties><db.url>jdbc:mysql://prod-server:3306/prod</db.url></properties></profile>
</profiles>

资源文件config.properties内容：

database.url=${db.url}

构建命令：mvn package -Pprod。

三、典型应用场景

多环境部署
通过资源过滤动态生成不同环境的配置文件，避免硬编码敏感信息。
动态占位符替换
• 示例：在application.yml中使用${project.version}注入项目版本号。

• 高级用法：结合<filter>标签实现多级变量替换或加密值解密。
资源目录扩展
支持非标准目录（如src/main/config）作为资源来源，保持项目结构清晰。
二进制资源保护
通过<nonFilteredFileExtensions>避免对图片、Excel模板等二进制文件进行过滤处理。

四、注意事项与最佳实践

避免过度过滤
• 仅对文本文件（如.properties、.xml）开启过滤，二进制文件（如.jar、.xlsx）需排除。

• 错误示例：过滤Excel文件可能导致打开时乱码。
版本兼容性
• 推荐使用3.2.0+版本，以支持最新功能（如自定义分隔符）。
性能优化
• 通过<excludes>减少不必要的文件复制，提升构建速度。
与Spring Boot集成
• Spring Boot父项目（spring-boot-starter-parent）已预置资源过滤配置，可直接继承使用。