Spring Boot条件注解之@ConditionalOnProperty完全解析_Java

前言

在 spring boot 项目中，有时候我们希望根据配置文件中的某个属性值来决定是否启用某个功能或加载某个组件。此时，@conditionalonproperty 注解就可以发挥作用。它通过配置文件的属性值控制 bean 或配置类的加载，使得我们的程序更具灵活性。

本文将详细介绍 @conditionalonproperty 的用法，并通过 功能开关 和 环境配置 两个实际场景来展示它的强大之处。

1. @conditionalonproperty 基本用法

语法

@conditionalonproperty(
    prefix = "前缀",
    name = "属性名",
    havingvalue = "指定值",
    matchifmissing = false
)

参数说明：

prefix：属性的前缀部分。
name：属性名称。
havingvalue：属性的值与 havingvalue 相等时条件成立（默认不指定）。
matchifmissing：如果属性未定义，是否加载配置（默认 false，即未定义时不加载）。

2. 实战场景

场景一：功能开关

在实际项目中，我们可能需要通过配置文件中的某个属性来控制某个功能的启用或禁用。比如，是否开启定时任务、是否启用某个服务等。

示例：通过功能开关启用日志增强功能

step 1：配置文件定义开关

在 application.properties 文件中添加一个开关属性：

feature.logging-enhancement.enabled=true

step 2：实现日志增强功能

使用 @conditionalonproperty 来决定是否加载日志增强的 bean：

import org.springframework.boot.autoconfigure.condition.conditionalonproperty;
import org.springframework.context.annotation.bean;
import org.springframework.context.annotation.configuration;

@configuration
@conditionalonproperty(prefix = "feature.logging-enhancement", name = "enabled", havingvalue = "true", matchifmissing = false)
public class loggingenhancementconfig {

    @bean
    public string loggingenhancement() {
        system.out.println("日志增强功能已启用！");
        return "logging enhancement activated";
    }
}

step 3：测试

当 feature.logging-enhancement.enabled=true 时，loggingenhancementconfig 类会被加载，控制台会输出：
```
日志增强功能已启用！
```
当 feature.logging-enhancement.enabled=false 或未配置时，loggingenhancementconfig 类不会被加载。

场景二：环境配置

在不同的环境（开发、测试、生产）中，我们可能需要加载不同的配置。例如，开发环境下使用内存数据库，生产环境下使用 mysql 数据库。

示例：不同环境下选择数据源

step 1：配置文件

在 application.properties 中配置环境标识：

# 开发环境
spring.datasource.env=dev

# 生产环境
# spring.datasource.env=prod

step 2：开发环境数据源配置

import org.springframework.boot.autoconfigure.condition.conditionalonproperty;
import org.springframework.context.annotation.bean;
import org.springframework.context.annotation.configuration;

import javax.sql.datasource;
import org.springframework.jdbc.datasource.drivermanagerdatasource;

@configuration
@conditionalonproperty(prefix = "spring.datasource", name = "env", havingvalue = "dev")
public class devdatasourceconfig {

    @bean
    public datasource devdatasource() {
        drivermanagerdatasource datasource = new drivermanagerdatasource();
        datasource.setdriverclassname("org.h2.driver");
        datasource.seturl("jdbc:h2:mem:testdb");
        datasource.setusername("sa");
        datasource.setpassword("");
        system.out.println("开发环境：加载内存数据库");
        return datasource;
    }
}

step 3：生产环境数据源配置

import org.springframework.boot.autoconfigure.condition.conditionalonproperty;
import org.springframework.context.annotation.bean;
import org.springframework.context.annotation.configuration;

import javax.sql.datasource;
import org.springframework.jdbc.datasource.drivermanagerdatasource;

@configuration
@conditionalonproperty(prefix = "spring.datasource", name = "env", havingvalue = "prod")
public class proddatasourceconfig {

    @bean
    public datasource proddatasource() {
        drivermanagerdatasource datasource = new drivermanagerdatasource();
        datasource.setdriverclassname("com.mysql.cj.jdbc.driver");
        datasource.seturl("jdbc:mysql://localhost:3306/proddb");
        datasource.setusername("root");
        datasource.setpassword("password");
        system.out.println("生产环境：加载 mysql 数据库");
        return datasource;
    }
}

step 4：测试