Maven pom文件中属性变量有哪些

发布时间：2021-12-30 13:34:07 作者：iii
来源：亿速云阅读：153

# Maven pom文件中属性变量有哪些

## 前言

在Maven项目的`pom.xml`文件中，属性变量（Properties）是重要的配置元素之一。它们允许开发者定义可重用的值，并在整个POM文件中引用这些值，从而提高配置的灵活性和可维护性。本文将详细介绍Maven POM文件中常见的属性变量类型及其用法。

---

## 一、属性变量的基本概念

属性变量在`pom.xml`中通过`<properties>`标签定义，格式为键值对（`<key>value</key>`）。定义后，可以通过`${key}`语法在POM文件中引用。

### 示例
```xml
<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <java.version>11</java.version>
</properties>

二、内置属性（Built-in Properties）

Maven提供了一些内置属性，无需定义即可直接使用：

1. 项目信息属性

${project.groupId}：项目组ID
${project.artifactId}：项目构件ID
${project.version}：项目版本号
${project.name}：项目名称
${project.description}：项目描述

2. 构建路径属性

${project.build.sourceDirectory}：源代码目录（默认src/main/java）
${project.build.testSourceDirectory}：测试代码目录（默认src/test/java）
${project.build.outputDirectory}：编译输出目录（默认target/classes）
${project.build.testOutputDirectory}：测试编译输出目录（默认target/test-classes）

3. POM文件路径

${project.basedir}：POM文件所在目录（即项目根目录）
${project.parent.basedir}：父POM文件目录（仅适用于子模块）

三、自定义属性

开发者可以在<properties>中定义任意自定义变量，常见用途包括：

1. 依赖版本管理

<properties>
    <spring.version>5.3.18</spring.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.version}</version>
    </dependency>
</dependencies>

2. 构建配置

<properties>
    <maven.compiler.source>11</maven.compiler.source>
    <maven.compiler.target>11</maven.compiler.target>
</properties>

3. 资源过滤

通过<resources>配合属性变量实现动态替换：

<properties>
    <environment>dev</environment>
</properties>

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
        </resource>
    </resources>
</build>

四、Settings和Environment变量

1. Maven Settings变量

通过${settings.xxx}引用settings.xml中的配置： - ${settings.localRepository}：本地仓库路径
- ${settings.offline}：是否为离线模式

2. 环境变量

${env.XXX}：引用系统环境变量（如${env.JAVA_HOME}）

五、Maven插件属性

部分插件会暴露自身的属性供POM文件使用：

1. Surefire插件（测试）

${surefire.skipTests}：是否跳过测试

2. 版本插件

${revision}：动态版本号（需配合flatten-maven-plugin使用）

六、属性覆盖优先级

当同名属性存在多个来源时，Maven按以下顺序覆盖： 1. 命令行参数（如-Dkey=value）
2. POM文件中的<properties>
3. settings.xml中的属性
4. 环境变量

七、高级用法

1. 属性默认值

通过${key:-default}语法设置默认值：

<version>${custom.version:-1.0.0}</version>

2. 属性文件加载

通过maven-resources-plugin加载外部.properties文件：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-resources-plugin</artifactId>
            <configuration>
                <propertiesFiles>
                    <propertiesFile>config.properties</propertiesFile>
                </propertiesFiles>
            </configuration>
        </plugin>
    </plugins>
</build>

3. Profile差异化配置

结合<profiles>实现环境切换：

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

八、注意事项

避免循环引用：属性之间不要相互依赖。
谨慎使用环境变量：可能降低构建的可移植性。
属性作用域：自定义属性仅在当前POM及其子模块中有效。

结语

合理使用属性变量能显著提升Maven项目的可维护性。通过内置属性、自定义变量和外部化配置的组合，开发者可以轻松实现多环境构建、依赖版本统一管理等需求。建议结合实际项目需求灵活运用本文介绍的特性。 “`

这篇文章涵盖了Maven POM文件中属性变量的核心知识点，包括内置属性、自定义属性、环境变量、插件属性等，并提供了实际示例和注意事项。如需扩展具体场景的用法，可进一步补充案例说明。