1. 概念定義

EnvironmentAware 是 Spring 框架中的一個(gè) Aware 回調(diào)接口。它的主要作用是讓 Bean 能夠“感知”到 Spring 容器運(yùn)行時(shí)的環(huán)境配置信息（Environment）。

• 所屬包：org.springframework.context
• 核心方法：void setEnvironment(Environment environment)

2. 核心原理與執(zhí)行時(shí)機(jī)

在 Spring Bean 的生命周期中，Aware 接口的注入發(fā)生在 Bean 實(shí)例化之后、初始化方法（如 @PostConstruct 或 init-method）執(zhí)行之前。

執(zhí)行流程：

1. Spring 容器實(shí)例化 DataSourceAutoConfig。
2. 容器發(fā)現(xiàn)該類實(shí)現(xiàn)了 EnvironmentAware。
3. 容器自動調(diào)用 setEnvironment 方法，并將當(dāng)前的 StandardServletEnvironment（或其它實(shí)現(xiàn)）作為參數(shù)傳入。
4. Bean 獲取到 Environment 對象，存入成員變量供后續(xù)邏輯使用。

3. Environment 對象的作用

通過 setEnvironment 獲取到的 Environment 實(shí)例，可以訪問以下三類數(shù)據(jù)：

• Profiles：判斷當(dāng)前激活的是哪個(gè)環(huán)境（如 dev, test, prod）。
• Properties：獲取 application.properties/yml 中的配置。
• System Settings：獲取 JVM 系統(tǒng)屬性和操作系統(tǒng)環(huán)境變量。

4. 代碼實(shí)現(xiàn)示例

以下是在自動配置類中常見的用法：

import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.context.annotation.Configuration;
@Configuration
public class DataSourceAutoConfig implements EnvironmentAware {
    private Environment env;
    @Override
    public void setEnvironment(Environment environment) {
        // 保存引用，供后續(xù)使用
        this.env = environment;
    }
    public void someMethod() {
        // 1. 獲取配置屬性
        String dbUrl = env.getProperty("spring.datasource.url");
        // 2. 獲取包含默認(rèn)值的屬性
        Integer timeout = env.getProperty("db.timeout", Integer.class, 1000);
        // 3. 檢查當(dāng)前激活的 Profile
        if (env.acceptsProfiles(org.springframework.core.env.Profiles.of("prod"))) {
            // 執(zhí)行生產(chǎn)環(huán)境特有邏輯
        }
    }
}

5. 為什么不直接用 @Value？

雖然 @Value 更簡潔，但在以下場景 EnvironmentAware 更具優(yōu)勢：

6. 復(fù)習(xí)要點(diǎn)（面試常考）

• Aware 接口族：記住它和 BeanNameAware, ApplicationContextAware 屬于同一類，都是容器向 Bean 注入基礎(chǔ)設(shè)施資源。
• 解耦：它讓你的配置類不需要硬編碼，而是根據(jù)外部配置動態(tài)調(diào)整。
• 進(jìn)階：在 Spring Boot 中，如果需要更高級的屬性綁定（如綁定到對象），通常配合 Binder 類在 setEnvironment 中使用。

在編寫自定義 Starter 或高級配置類時(shí)，結(jié)合 EnvironmentAware 和 Binder API 是一種非常專業(yè)的做法。它能讓你像 Spring Boot 內(nèi)部源碼一樣，將 Environment 中的散亂配置自動封裝成一個(gè)標(biāo)準(zhǔn)的 POJO（普通 Java 對象）。

7. 進(jìn)階技巧：結(jié)合 Binder API 實(shí)現(xiàn)屬性批量綁定

在 Spring Boot 2.x 之后，引入了 Binder API。它比原生的 environment.getProperty() 更強(qiáng)大，支持松散綁定（Relaxed Binding，例如 my_prop 綁定到 myProp）和對象嵌套。

7.1 代碼實(shí)現(xiàn)

假設(shè)你有一個(gè)配置類 DataSourceProperties，你想把以 spring.datasource 開頭的屬性全部注入進(jìn)去：

import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.context.annotation.Configuration;
@Configuration
public class DataSourceAutoConfig implements EnvironmentAware {
    private DataSourceProperties properties;
    @Override
    public void setEnvironment(Environment environment) {
        // 1. 獲取 Binder 實(shí)例
        Binder binder = Binder.get(environment);
        // 2. 將指定前綴的配置綁定到具體的對象上
        // 參數(shù) 1: 配置文件中的前綴
        // 參數(shù) 2: 目標(biāo)對象的 Class
        this.properties = binder.bind("spring.datasource", DataSourceProperties.class)
                                .get(); // get() 返回綁定后的對象
        System.out.println("成功綁定配置，數(shù)據(jù)庫地址為: " + properties.getUrl());
    }
}

7.2 為什么要這么做？（對比傳統(tǒng)方案）

1. 手動綁定的靈活性：雖然 @ConfigurationProperties 也能完成綁定，但在某些場景下（例如：你的配置類需要根據(jù) Environment 中的某個(gè)值動態(tài)決定綁定哪一組前綴），Binder API 提供了代碼級的控制力。
2. 不依賴 Bean 容器：Binder 可以在 Bean 還沒完全初始化好時(shí)，就完成屬性的提取和轉(zhuǎn)換。
3. 處理復(fù)雜結(jié)構(gòu)：Binder 能夠自動處理 List、Map 等復(fù)雜集合的綁定，而普通的 getProperty 只能獲取字符串或簡單類型。

7.3 注意事項(xiàng)

• 異常處理：bind 方法返回的是一個(gè) BindResult 對象。如果配置不存在，調(diào)用 .get() 會拋出異常。建議在生產(chǎn)代碼中使用 .orElse(new DataSourceProperties()) 提供默認(rèn)值。
• 依賴：Binder 類位于 spring-boot 包下。如果你是在純 spring-context 環(huán)境（非 Spring Boot）下，則無法使用此 API。

到此這篇關(guān)于Spring中EnvironmentAware 接口的使用小結(jié)的文章就介紹到這了,更多相關(guān)Spring EnvironmentAware 接口內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論