如何通过自定义标记控制Maven子项目的依赖引入？

问题背景 #

我正在搭建一个用于统一管理依赖的父POM，当前父POM核心配置如下：

<project>
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.12</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.myapp</groupId>
    <artifactId>myapp-common-parent-bom</artifactId>
    <version>0.0.1</version>
    <packaging>pom</packaging>
    <name>myapp-common-parent-bom</name>

    <properties>
        <springboot.version>2.7.12</springboot.version>
        <spring-cloud.version>2022.0.4</spring-cloud.version> 
        <swagger.version>1.6.3</swagger.version>
        <sonar.language>java</sonar.language>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${springboot.version}</version>
        </dependency>
    </dependencies>
</project>

子项目通过以下方式引用该父POM：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://maven.apache.org/POM/4.0.0"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.myapp</groupId>
        <artifactId>myapp-common-parent-bom</artifactId>
        <version>0.0.1</version>
    </parent>
    <groupId>com.myapp</groupId>
    <artifactId>my-service</artifactId>
    <version>0.0.1</version>
    <name>my-service</name>
</project>

我希望通过类似<useLombok>true</useLombok>的属性标记，控制子项目是否自动引入指定依赖（比如Lombok）。之前尝试在父POM中用<optional>!${useLombok}</optional>的配置，但未生效，现寻求可行方案。

解决方案 #

为什么之前的配置无效 #

<optional>属性的作用是标记依赖是否会传递给下游项目，而非控制当前项目是否引入该依赖。即使设置<optional>true</optional>，当前项目依然会引入该依赖，只是依赖当前项目的其他项目不会自动继承它。因此你之前的配置无法实现“控制子项目是否引入”的需求。

方法1：使用Maven Profiles（推荐） #

通过在父POM中定义Profile，利用属性激活条件来控制依赖的引入：

父POM修改：

在父POM中添加<profiles>节点，定义一个激活条件为useLombok=true的Profile：

<project>
    <!-- 原有配置不变 -->

    <properties>
        <!-- 添加默认属性，默认不启用Lombok -->
        <useLombok>false</useLombok>
        <!-- 其他原有属性 -->
        <springboot.version>2.7.12</springboot.version>
        <spring-cloud.version>2022.0.4</spring-cloud.version> 
        <swagger.version>1.6.3</swagger.version>
        <sonar.language>java</sonar.language>
    </properties>

    <!-- 定义Profile -->
    <profiles>
        <profile>
            <id>use-lombok</id>
            <!-- 当useLombok属性为true时自动激活该Profile -->
            <activation>
                <property>
                    <name>useLombok</name>
                    <value>true</value>
                </property>
            </activation>
            <dependencies>
                <dependency>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok</artifactId>
                    <version>1.18.20</version>
                    <scope>provided</scope> <!-- Lombok建议使用provided作用域 -->
                </dependency>
            </dependencies>
        </profile>
    </profiles>

    <!-- 原有dependencies节点可以移除Lombok，改为通过Profile控制 -->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${springboot.version}</version>
        </dependency>
    </dependencies>
</project>

子项目使用：

子项目只需添加useLombok属性即可自动引入Lombok：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://maven.apache.org/POM/4.0.0"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.myapp</groupId>
        <artifactId>myapp-common-parent-bom</artifactId>
        <version>0.0.1</version>
    </parent>
    <groupId>com.myapp</groupId>
    <artifactId>my-service</artifactId>
    <version>0.0.1</version>
    <name>my-service</name>

    <!-- 添加该属性即可激活Lombok依赖 -->
    <properties>
        <useLombok>true</useLombok>
    </properties>
</project>

方法2：使用DependencyManagement+显式引入 #

如果不想用Profile，可以在父POM的dependencyManagement中统一管理依赖版本，子项目根据需求显式引入：

父POM修改：

<project>
    <!-- 原有配置不变 -->

    <dependencyManagement>
        <dependencies>
            <!-- 统一管理Lombok版本 -->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.20</version>
                <scope>provided</scope>
            </dependency>
            <!-- 其他依赖版本管理 -->
        </dependencies>
    </dependencyManagement>

    <!-- 原有dependencies移除Lombok，子项目按需引入 -->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${springboot.version}</version>
        </dependency>
    </dependencies>
</project>

子项目使用：

需要Lombok的子项目直接添加依赖即可（无需写版本）：

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

这种方式更直观，但需要子项目手动添加依赖，适合不需要批量控制的场景。

内容的提问来源于stack exchange，提问作者Ryuzaki