這份指南詳細(xì)整理了 Spring Boot 中最核心的配置綁定、自動(dòng)裝配以及條件注解。這些注解是理解 Spring Boot "約定大于配置" (Convention over Configuration) 機(jī)制的基石。

本文檔詳細(xì)解析 Spring Boot 中用于配置綁定、自動(dòng)裝配流程控制及條件加載的核心注解。

1. 配置屬性綁定 (Configuration Binding)

這一組注解的主要作用是將 application.yml 或 application.properties 中的配置值綁定到 Java Bean 中。

@ConfigurationProperties

• 用途：將配置文件中指定前綴的屬性值自動(dòng)綁定到 Java 類的字段上。
• 關(guān)鍵點(diǎn)：
  • 僅僅加上這個(gè)注解，Spring 容器并不會(huì)自動(dòng)注冊它。它需要配合 @EnableConfigurationProperties 或 @Component (配合掃描) 使用。
  • 支持松散綁定 (Relaxed Binding)，例如 first-name 可以綁定到 firstName。

@EnableConfigurationProperties

• 用途：顯式地開啟 @ConfigurationProperties 注解類的功能，并將該類注冊為 Spring Bean。
• 場景：通常用在 @Configuration 類上，用于引入第三方的配置類，或者當(dāng)你不想在配置類上加 @Component 時(shí)使用。

@ConfigurationPropertiesScan

• 用途：從 Spring Boot 2.2 開始引入。它會(huì)掃描指定包路徑下所有標(biāo)注了 @ConfigurationProperties 的類，并自動(dòng)注冊為 Bean。
• 優(yōu)勢：省去了在配置類上寫一堆 @EnableConfigurationProperties({A.class, B.class}) 的麻煩。

?? 代碼示例

1. 配置文件 (application.yml)

app:
  server:
    timeout: 5000
    enabled: true

2. 配置類 POJO

import org.springframework.boot.context.properties.ConfigurationProperties;
// 聲明前綴，Spring 會(huì)去查找 app.server.*
@ConfigurationProperties(prefix = "app.server")
public class ServerProperties {
    private Integer timeout;
    private boolean enabled;
    // 必須要有 Getter/Setter
    public Integer getTimeout() { return timeout; }
    public void setTimeout(Integer timeout) { this.timeout = timeout; }
    public boolean isEnabled() { return enabled; }
    public void setEnabled(boolean enabled) { this.enabled = enabled; }
}

3. 啟用配置 (三種方式選其一)

• 方式 A：配合 @Component (最簡單)

  • 在 ServerProperties 上直接加 @Component，配合 @ConfigurationProperties。

• 方式 B：使用 @EnableConfigurationProperties (推薦用于庫開發(fā))

  @Configuration
  @EnableConfigurationProperties(ServerProperties.class)
  public class MyConfig { ... }

• 方式 C：使用 @ConfigurationPropertiesScan (適合大型項(xiàng)目)

  @SpringBootApplication
  @ConfigurationPropertiesScan("com.example.config") // 掃描指定包
  public class MyApplication { ... }

2. 自動(dòng)裝配核心 (Auto Configuration)

@EnableAutoConfiguration

• 用途：Spring Boot 的魔法核心。它告訴 Spring Boot 根據(jù)添加的 jar 依賴自動(dòng)配置 Spring 應(yīng)用。

• 原理：

  • 它利用 SpringFactoriesLoader 機(jī)制。
  • 掃描 classpath 下所有 jar 包中的 META-INF/spring.factories (Spring Boot 2.x) 或 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports (Spring Boot 3.x)。
  • 加載其中聲明的配置類，但在加載前會(huì)通過 @Conditional 系列注解進(jìn)行過濾。

• 注意：通常包含在 @SpringBootApplication 中，很少單獨(dú)使用。

3. 條件注解 (Conditionals)

這一組注解決定了 Bean 是否會(huì)被創(chuàng)建并注冊到容器中。這是實(shí)現(xiàn)“自動(dòng)裝配”邏輯判斷的關(guān)鍵。

@Conditional

• 用途：最底層的注解。它接收一個(gè)實(shí)現(xiàn)了 Condition 接口的類。只有當(dāng) matches 方法返回 true 時(shí)，Bean 才會(huì)被創(chuàng)建。
• 場景：編寫非常復(fù)雜的自定義邏輯判斷時(shí)使用。

@ConditionalOnProperty

• 用途：這是 @Conditional 的擴(kuò)展，專門用于判斷配置文件中是否存在某個(gè)屬性，或該屬性的值是否等于特定值。

• 常用屬性：

  • prefix: 屬性前綴。
  • name: 屬性名。
  • havingValue: 期望的值（如果匹配則加載）。
  • matchIfMissing: 如果配置文件中沒寫這個(gè)屬性，默認(rèn)是否加載（true 為加載）。

?? 代碼示例：基于配置開關(guān)功能的 Bean

假設(shè)我們根據(jù)配置決定啟用 "短信通知" 還是 "郵件通知"。

1. 配置文件

feature:
  notification: sms  # 改為 email 則加載 EmailService

2. 業(yè)務(wù) Bean 定義

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class NotificationConfig {
    @Bean
    // 當(dāng) feature.notification = email 時(shí)生效
    @ConditionalOnProperty(prefix = "feature", name = "notification", havingValue = "email")
    public NotificationService emailService() {
        return new EmailNotificationService();
    }
    @Bean
    // 當(dāng) feature.notification = sms 時(shí)生效
    // matchIfMissing = true 表示如果不配這個(gè)配置，默認(rèn)也啟用 SMS
    @ConditionalOnProperty(prefix = "feature", name = "notification", havingValue = "sms", matchIfMissing = true)
    public NotificationService smsService() {
        return new SmsNotificationService();
    }
}

?? 代碼示例：自定義 @Conditional (高階用法)

如果 @ConditionalOnProperty 無法滿足需求（比如判斷操作系統(tǒng)、判斷某個(gè)文件是否存在），可以使用 @Conditional。

// 1. 定義判斷邏輯
public class WindowsCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return context.getEnvironment().getProperty("os.name").contains("Windows");
    }
}
// 2. 使用注解
@Bean
@Conditional(WindowsCondition.class) // 只有在 Windows 系統(tǒng)下才加載該 Bean
public CmdService cmdService() {
    return new WindowsCmdService();
}

4. 總結(jié)速查表

到此這篇關(guān)于SpringBoot自動(dòng)裝配注解的實(shí)現(xiàn)示例的文章就介紹到這了,更多相關(guān)SpringBoot自動(dòng)裝配注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論