Maven 属性

• 1. 自定义属性
  • 1.1 定义自定义属性
  • 1.2 调用自定义属性
  • 1.3 自定义属性的优势
• 2. Maven 内置属性
• 3. Settings 属性
• 4. Java 系统属性
• 5. 环境变量属性
• 6. 综合示例

在 Maven 项目中，属性（Properties）是用于统一管理可复用内容的一个重要工具。通过定义属性，你可以将常用的值（如版本号、路径等）抽取出来，方便在多个地方引用，减少重复配置并提高项目的可维护性。

提示

如果定义的自定义属性没有在项目中使用，那么它不会对构建过程产生任何影响，也就没有实际用途。

1. 自定义属性

自定义属性用于定义项目中常用的变量，方便集中管理和修改。例如，当多个依赖共享相同的版本号时，可以通过定义一个自定义属性来统一管理。

1.1 定义自定义属性

自定义属性通常在 pom.xml 文件的 <properties> 元素中定义。定义格式如下：

<properties>
    <!-- 定义 Spring 的版本号 -->
    <spring.version>5.1.9.RELEASE</spring.version>
    <!-- 定义 JUnit 的版本号 -->
    <junit.version>4.12</junit.version>
</properties>

1.2 调用自定义属性

在项目的其他部分，你可以使用 ${property-name} 的格式来引用这些属性：

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

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>${junit.version}</version>
    <scope>test</scope>
</dependency>

1.3 自定义属性的优势

• 统一管理：版本号或路径只需要在一个地方定义，修改时只需更新一处即可，避免了在多个地方重复修改的麻烦。
• 增强可读性：项目中使用的常量通过属性进行抽象，提升了 pom.xml 文件的可读性。

2. Maven 内置属性

Maven 提供了一些常用的内置属性，方便开发者快速配置项目。以下是常见的内置属性及其作用：

• ${basedir}：表示项目的根目录，通常用于指定相对路径。
• ${project.version}：表示当前项目的版本号。
• ${project.artifactId}：表示当前项目的 artifactId。
• ${project.build.directory}：表示项目的构建输出目录，通常为 target。

示例：

<build>
    <directory>${project.build.directory}/custom-output</directory>
</build>

上述配置将构建输出目录设置为 target/custom-output。

3. Settings 属性

Settings 属性用于引用 Maven 全局配置文件 settings.xml 中的值，这些值可以用于动态配置，特别是在不同环境下进行切换。

调用格式：

<repositories>
    <repository>
        <id>central</id>
        <url>${settings.localRepository}</url> <!-- 使用 settings.xml 中的本地仓库路径 -->
    </repository>
</repositories>

4. Java 系统属性

Java 系统属性用于获取当前 JVM 环境中的信息，如用户目录、临时目录等。常见的 Java 系统属性包括：

• ${user.home}：表示当前用户的主目录。
• ${java.io.tmpdir}：表示 JVM 的临时文件目录。

示例：

<configuration>
    <outputDirectory>${user.home}/output</outputDirectory>
</configuration>

上述配置将输出目录设置为当前用户主目录下的 output 文件夹。

5. 环境变量属性

环境变量属性允许你在 Maven 中引用操作系统级别的环境变量。例如，可以使用 JAVA_HOME 环境变量来指定 Java 的安装路径。

调用格式：

<configuration>
    <jdkHome>${env.JAVA_HOME}</jdkHome>
</configuration>

查询环境变量属性

你可以使用以下命令来查询系统中的所有环境变量属性：

mvn help:system

6. 综合示例

以下是一个包含多种属性的综合示例：

<project>
    <modelVersion>4.0.0</modelVersion>
    <properties>
        <!-- 自定义属性 -->
        <spring.version>5.1.9.RELEASE</spring.version>
        <junit.version>4.12</junit.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <directory>${basedir}/target/custom-output</directory>
    </build>

    <profiles>
        <profile>
            <id>dev</id>
            <properties>
                <localRepo>${settings.localRepository}</localRepo>
            </properties>
        </profile>
    </profiles>
</project>

在这个例子中：

• 使用自定义属性管理依赖的版本号。
• 使用 Maven 内置属性指定构建输出目录。
• 通过 Settings 属性动态获取本地仓库路径。