Spring?Boot條件注解之@ConditionalOnProperty完全解析

更新時間：2025年02月13日 10:53:03 作者：CodeDunkster

這篇文章主要介紹了SpringBoot中的@ConditionalOnProperty注解,通過配置文件屬性值控制Bean或配置類的加載,實現(xiàn)功能開關和環(huán)境配置,文中通過代碼介紹的非常詳細,需要的朋友可以參考下

前言

在 Spring Boot 項目中，有時候我們希望根據(jù)配置文件中的某個屬性值來決定是否啟用某個功能或加載某個組件。此時，@ConditionalOnProperty 注解就可以發(fā)揮作用。它通過配置文件的屬性值控制 Bean 或配置類的加載，使得我們的程序更具靈活性。

本文將詳細介紹 @ConditionalOnProperty 的用法，并通過 功能開關 和 環(huán)境配置 兩個實際場景來展示它的強大之處。

1. @ConditionalOnProperty 基本用法

語法

@ConditionalOnProperty(
    prefix = "前綴",
    name = "屬性名",
    havingValue = "指定值",
    matchIfMissing = false
)

參數(shù)說明：

prefix：屬性的前綴部分。
name：屬性名稱。
havingValue：屬性的值與 havingValue 相等時條件成立（默認不指定）。
matchIfMissing：如果屬性未定義，是否加載配置（默認 false，即未定義時不加載）。

2. 實戰(zhàn)場景

場景一：功能開關

在實際項目中，我們可能需要通過配置文件中的某個屬性來控制某個功能的啟用或禁用。比如，是否開啟定時任務、是否啟用某個服務等。

示例：通過功能開關啟用日志增強功能

Step 1：配置文件定義開關

在 application.properties 文件中添加一個開關屬性：

feature.logging-enhancement.enabled=true

Step 2：實現(xiàn)日志增強功能

使用 @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 類不會被加載。

場景二：環(huán)境配置

在不同的環(huán)境（開發(fā)、測試、生產(chǎn)）中，我們可能需要加載不同的配置。例如，開發(fā)環(huán)境下使用內(nèi)存數(shù)據(jù)庫，生產(chǎn)環(huán)境下使用 MySQL 數(shù)據(jù)庫。

示例：不同環(huán)境下選擇數(shù)據(jù)源

Step 1：配置文件

在 application.properties 中配置環(huán)境標識：

# 開發(fā)環(huán)境
spring.datasource.env=dev

# 生產(chǎn)環(huán)境
# spring.datasource.env=prod

Step 2：開發(fā)環(huán)境數(shù)據(jù)源配置

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("開發(fā)環(huán)境：加載內(nèi)存數(shù)據(jù)庫");
        return dataSource;
    }
}

Step 3：生產(chǎn)環(huán)境數(shù)據(jù)源配置

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("生產(chǎn)環(huán)境：加載 MySQL 數(shù)據(jù)庫");
        return dataSource;
    }
}

Step 4：測試

開發(fā)環(huán)境：spring.datasource.env=dev控制臺輸出：
```
開發(fā)環(huán)境：加載內(nèi)存數(shù)據(jù)庫
```
生產(chǎn)環(huán)境：spring.datasource.env=prod控制臺輸出：
```
生產(chǎn)環(huán)境：加載 MySQL 數(shù)據(jù)庫
```