開發與維運

Spring 5 中文解析核心篇-IoC容器之Environment抽象

2020-09-08
1.13 Environment抽象

Environment接口是在容器中抽象集成，應用環境包括兩個重要的方面：profiles 和 properties。配置文件是一個命名的bean定義邏輯組，只有在給定的配置文件處於激活狀態時才在容器中註冊。可以將bean分配給配置文件，不管它是用XML定義的還是用註解定義的。與profile文件相關的環境對象的角色是確定哪些profile文件(如果有的話)當前是激活的，以及哪些profile文件(如果有的話)在默認情況下應該是激活的。

Properties幾乎在所有應用中扮演一個重要的角色並且可能來自於多個源：屬性文件、JVM系統屬性、系統環境變量、JNDI、servlet上下文參數、Properties對象、Map對象等等。Environment對象的角色與properties關聯去提供給用戶一個便利的服務接口去配置屬性源和解析屬性。

1.13.1 Bean定義Profiles

bean定義屬性文件在核心容器中提供一個機制，它允許在不同的環境中註冊不同bean。環境這個詞對於不同的用戶可能意味著不同的東西，這個特性可以幫助許多使用場景，包括：

  • 在開發中針對內存中的數據源進行工作，而不是在進行QA或生產時從JNDI查找相同的數據源。
  • 當部署應用到執行環境使用註冊健康基礎設施
  • 為客戶A和客戶B部署註冊定製的bean實現。

在實踐應用中考慮第一個使用場景，它需要獲取一個DataSource。在測試環境中，配置假設如下：

@Bean
public DataSource dataSource() {
    return new EmbeddedDatabaseBuilder()
        .setType(EmbeddedDatabaseType.HSQL)
        .addScript("my-schema.sql")
        .addScript("my-test-data.sql")
        .build();
}

現在考慮這個應用怎樣部署到QA或生產環境，假設應用程序數據源註冊在生成應用服務JNDI目錄。我們的dataSource bean看起來類似下面清單：

@Bean(destroyMethod="")
public DataSource dataSource() throws Exception {
    Context ctx = new InitialContext();
    return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
}

問題是如何根據當前環境在使用這兩種變體之間進行切換。隨著時間的流逝，Spring用戶已經設計出多種方法來完成此任務，通常依賴系統環境變量和包含$ {placeholder}佔位符的XML 語句的組合，這些語句根據值解析為正確的配置文件路徑環境變量。Bean定義配置文件是一項核心容器功能，可解決此問題。

如果我們概括前面環境特定的bean定義示例中所示的用例，我們最終需要在特定上下文中註冊特定的bean定義，而不是在其他上下文中註冊。可以這樣說，你希望在情形A中註冊bean定義的某個配置文件，而在情形B中註冊另一個配置文件。我們開始更新配置以反映這種需求。

使用@Profile

@Profile註解允許你去指明哪些組件適合去註冊，當一個或多個指定profile處於激活狀態時。使用我們前面的例子，我們可以重寫dataSource配置如下：

@Configuration
@Profile("development")
public class StandaloneDataConfig {

    @Bean
    public DataSource dataSource() {
        return new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:com/bank/config/sql/schema.sql")
            .addScript("classpath:com/bank/config/sql/test-data.sql")
            .build();
    }
}
@Configuration
@Profile("production")
public class JndiDataConfig {

    @Bean(destroyMethod="")
    public DataSource dataSource() throws Exception {
        Context ctx = new InitialContext();
        return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
    }
}

如前所述，對於@Bean方法，你典型的選擇使用編程式的JNDI查找，通過使用Spring的JndiTemplate/JndiLocatorDelegate幫助類或直接使用前面展示的JNDI InitialContext，而不是使用JndiObjectFactoryBean變體，這將迫使你將返回類型聲明為FactoryBean類型。

配置文件字符串可能包含一個簡單的配置名稱(例如，production)或一個配置表達式。一個配置表達式允許更復雜的配置邏輯去表達(例如，production & us-east)，下面的操作符在profile表達式中是被支持的：

  • !：邏輯非
  • &：邏輯與
  • |：邏輯或

你不能混合&和！操作符而不使用括號。例如，production & us-east | eu-central是無效表達式。它必須被表達類似production & (us-east | eu-central)。

你可以使用@Profile作為一個元數據註解去創建你自定義的註解。以下示例定義了一個自定義@Production註解，你可以將其用作@Profile(“ production”)的替代。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Profile("production")
public @interface Production {
}

如果@Configuration類被標註@Profile，所有的@Bean方法和@Import註解關聯的類都將被繞過，除非一個或多個指定的配置文件被激活。如果@Component或@Configuration類被標記@Profile({"p1", "p2"})，這個類不會被註冊或處理除非配置文件 p1或 p2被激活。如果給的配置前綴是NOT操作符(!)，註解元素僅僅在配置文件沒有被激活時被註冊。例如，@Profile({"p1", "!p2"})，如果配置 p1被激活或者配置p2沒有被激活時註冊才會發生。

@Profile也可以被聲明在方法級別去包含一個特定的配置bean類(例如，用於特定bean的替代)，類似下面例子展示：

@Configuration
public class AppConfig {

    @Bean("dataSource")
    @Profile("development") //1
    public DataSource standaloneDataSource() {
        return new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:com/bank/config/sql/schema.sql")
            .addScript("classpath:com/bank/config/sql/test-data.sql")
            .build();
    }

    @Bean("dataSource")
    @Profile("production") //2
    public DataSource jndiDataSource() throws Exception {
        Context ctx = new InitialContext();
        return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
    }
}
  1. standaloneDataSource方法僅僅在development配置中有效
  2. jndiDataSource方法僅僅在production配置中有效

對於@Bean方法上的@Profile，可以應用一個特殊的場景:在重載相同Java方法名的@Bean方法(類似於構造函數重載)的情況下，需要一致地在所有重載方法上聲明@Profile條件。如果條件不一致，則只有重載方法中第一個聲明的條件重要。因此，@Profile不能被使用去選擇具有特定參數簽名重載方法。在創建時，同一bean的所有工廠方法之間的解析都遵循Spring的構造函數解析方法。

如果你想去定義不同配置條件的bean，使用不同的Java方法名稱，通過使用@Bean name屬性指向相同名稱的bean，類似前面展示例子。如果參數前面都相同(例如，所有的變體有無參構造函數)，這是在一個有效的Java類中表示這種安排的唯一方法(因為只能有一個具有特定名稱和參數簽名的方法)。

XML bean定義配置文件

XML對應項是元素的profile屬性。我們前面的相同配置能被重寫在兩個XML文件中，類似下面：

<beans profile="development"
    xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jdbc="http://www.springframework.org/schema/jdbc"
    xsi:schemaLocation="...">

    <jdbc:embedded-database id="dataSource">
        <jdbc:script location="classpath:com/bank/config/sql/schema.sql"/>
        <jdbc:script location="classpath:com/bank/config/sql/test-data.sql"/>
    </jdbc:embedded-database>
</beans>
<beans profile="production"
    xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jee="http://www.springframework.org/schema/jee"
    xsi:schemaLocation="...">

    <jee:jndi-lookup id="dataSource" jndi-name="java:comp/env/jdbc/datasource"/>
</beans>

也可以避免在同一文件中拆分和嵌套元素，如以下示例所示:

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jdbc="http://www.springframework.org/schema/jdbc"
    xmlns:jee="http://www.springframework.org/schema/jee"
    xsi:schemaLocation="...">

    <!-- other bean definitions -->

    <beans profile="development">
        <jdbc:embedded-database id="dataSource">
            <jdbc:script location="classpath:com/bank/config/sql/schema.sql"/>
            <jdbc:script location="classpath:com/bank/config/sql/test-data.sql"/>
        </jdbc:embedded-database>
    </beans>

    <beans profile="production">
        <jee:jndi-lookup id="dataSource" jndi-name="java:comp/env/jdbc/datasource"/>
    </beans>
</beans>

spring-bean.xsd已被限制為僅允許這些元素作為文件中的最後一個。這應該有助於提供靈活性，而不會在XML文件中引起混亂。

XML對應項不支持前面描述的配置文件表達式：然而，它可能通過!操作符否定一個配置文件。它也可能通過嵌入配置文件應用邏輯and，類型下面例子顯示：

<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:jdbc="http://www.springframework.org/schema/jdbc"
 xmlns:jee="http://www.springframework.org/schema/jee"
 xsi:schemaLocation="...">

 <!-- other bean definitions -->
<beans profile="production">
     <beans profile="us-east">
         <jee:jndi-lookup id="dataSource" jndi-name="java:comp/env/jdbc/datasource"/>
     </beans>
 </beans>
</beans>

在前面的例子中，如果production和us-east配置都被激活，則dataSource bean被暴露。

激活profile

現在我們已經更新了配置文件，我們仍然需要指示Spring哪一個配置文件激活。如果我們已經啟動了我們的應用程序，我們將看到一個NoSuchBeanDefinitionException拋出，因為容器不能找到名稱為dataSource的bean。

可以通過多種方式來激活配置文件，但最直接的方法是可通過ApplicationContext獲得的Environment API以編程方式進行配置。下面例子展示怎樣去做：

AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.getEnvironment().setActiveProfiles("development");
ctx.register(SomeConfig.class, StandaloneDataConfig.class, JndiDataConfig.class);
ctx.refresh();

此外，你也可以聲明式地激活配置文件通過spring.profiles.active屬性，也可通過系統環境變量、JVM屬性、在web.xml中servlet上下文參數，甚至作為JNDI中的條目(查看PropertySource抽象)。在集成測試中，激活配置文件可以通過使用@ActiveProfiles聲明在spring-test模塊(查看上下文配置通過環境配置文件)。

請注意，配置文件不是非此即彼的命題。你可以一次性激活多個配置文件。編程式地，你可以提供多個配置文件名稱給setActiveProfiles()方法，它可以接受String… 可變參數。下面例子激活多個配置文件：

ctx.getEnvironment().setActiveProfiles("profile1", "profile2");

聲明式地，spring.profiles.active可以接收配置名稱逗號分隔列表，類似下面例子展示：

-Dspring.profiles.active="profile1,profile2"

默認profile

默認配置文件表示默認情況下啟用的配置文件。考慮下面例子：

@Configuration
@Profile("default")
public class DefaultDataConfig {

    @Bean
    public DataSource dataSource() {
        return new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:com/bank/config/sql/schema.sql")
            .build();
    }
}

如果沒有profile被激活，dataSource實例被創建。你可以看到這種方式提供一個默認的定義為一個或多個bean。如果任何profile被激活，這個默認profile不被使用。

你可以通過在Environment上使用setDefaultProfiles()改變默認profile名稱或者，聲明式地，通過使用spring.profiles.default屬性。

1.13.2 PropertySource抽象

Spring的Environment抽象提供了可配置屬性源層次結構上的搜索操作。考慮下面清單：

ApplicationContext ctx = new GenericApplicationContext();
Environment env = ctx.getEnvironment();
boolean containsMyProperty = env.containsProperty("my-property");
System.out.println("Does my environment contain the 'my-property' property? " + containsMyProperty);

在前面的片段中，我們看到一個高級別的詢問Spring的方式，是否my-property屬性在當前環境中被定義：去回答這個問題，Environment對象執行搜索PropertySource 集合對象。PropertySource是一個簡單key-value對源的抽象，並且Spring的StandardEnvironment被配置兩個PropertySource 對象，一個描述JVM系統(System.getProperties())屬性集合另一個描述系統環境變量集合(System.getenv())。

這些默認的屬性源適用StandardEnvironment，為在獨立的應用中使用。 StandardServletEnvironment是通過附加默認屬性源填充，包括servlet配置和servlet上下文參數。它可以選擇啟用JndiPropertySource。查看javadock詳情。

具體地說，當你使用StandardEnvironment時，如果my-property系統屬性或my-property環境變量在運行時被描述，調用env.containsProperty("my-property")方法將返回true。

執行的搜索是分層的，默認情況，系統屬性優先級高於環境變量。因此，如果my-property屬性在兩個地方被設置，在調用env.getProperty("my-property")時，系統屬性值將被返回。請注意，屬性值不會合並，而是會被前面的值完全覆蓋。

對於通用的StandardServletEnvironment，完整的層次結構如下，優先級最高的條目位於頂部：

1.ServletConfig參數(如果使用的-例如，如果是DispatcherServlet上下文)

2.ServletContext參數(web.xml 上下文參數)

3.JNDI 環境變量(java:comp/env/)

4.JVM系統參數(-D 命令行參數)

5.JVM系統變量(操作系統環境變量)

最重要地，整個機制是可配置的。也許你有一個自定義的屬性源，你想整合到此搜索中。這樣做，實現和實例化你的PropertySource並且添加到當前的Environment PropertySources集合中。下面例子展示怎樣去做：

ConfigurableApplicationContext ctx = new GenericApplicationContext();
MutablePropertySources sources = ctx.getEnvironment().getPropertySources();
sources.addFirst(new MyPropertySource());

在前面的代碼中，MyPropertySource被添加到最高索引優先級中。如果它包含my-property屬性，則會檢測到並返回該屬性，從而支持任何其他PropertySource中的my-property屬性。MutablePropertySourcesAPI暴露了一些方法，這些方法允許去精確操作屬性源集合。

1.13.3 使用@PropertySource

@PropertySource註解提供一個便捷的和陳述式的機制去添加PropertySource到Spring的Environment中。

給定一個名叫app.properties文件，它包含健值對testbean.name=myTestBean，下面的@Configuration類使用@PropertySource，以這種方式調用testBean.getName()並返回myTestBean：

@Configuration
@PropertySource("classpath:/com/myco/app.properties")
public class AppConfig {

    @Autowired
    Environment env;

    @Bean
    public TestBean testBean() {
        TestBean testBean = new TestBean();
        testBean.setName(env.getProperty("testbean.name"));
        return testBean;
    }
}

@PropertySource資源位置中出現的任何${}佔位符都將根據已經在環境中註冊的屬性源集進行解析，如下面的示例所示：

@Configuration
@PropertySource("classpath:/com/${my.placeholder:default/path}/app.properties")
public class AppConfig {

    @Autowired
    Environment env;

    @Bean
    public TestBean testBean() {
        TestBean testBean = new TestBean();
        testBean.setName(env.getProperty("testbean.name"));
        return testBean;
    }
}

假設my.placeholder在一個已經被註冊的屬性源中被描述(例如，系統屬性或環境變量)，則佔位符被解析為對應值。如果沒有，則使用一個默認值default/path。如果沒有指定默認值並且屬性不能被解析，一個IllegalArgumentException被拋出。

根據Java8約定，@PropertySource註解是可以重複的。然而，所有的@PropertySource註解需要在相同等級被聲明，要麼直接地在配置類上，要麼作為元數據註解在相同自定義註解中。不建議將直接註釋和元註釋混合使用，因為直接註釋會有效地覆蓋元註釋。

參考代碼：com.liyong.ioccontainer.starter.EnvironmentIocContainer

1.13.4 語句中的佔位符解析

在以前，元素中佔位符的值只能根據JVM系統屬性或環境變量來解析。現在情況已經不同了。因為Environment抽象已經集成到容器，很容易通過它來路由佔位符的解析。這意味著你可以按照自己喜歡的任何方式配置解析過程。你可以更改搜索系統屬性和環境變量的優先級，也可以完全刪除它們。你還可以適當地將你自己的屬性源添加到組合中。

具體地說，不論在何處定義customer屬性，只要在環境中可用，以下語句就可以工作：

<beans>
    <import resource="com/bank/service/${customer}-config.xml"/>
</beans>

作者

個人從事金融行業，就職過易極付、思建科技、某網約車平臺等重慶一流技術團隊，目前就職於某銀行負責統一支付系統建設。自身對金融行業有強烈的愛好。同時也實踐大數據、數據存儲、自動化集成和部署、分佈式微服務、響應式編程、人工智能等領域。同時也熱衷於技術分享創立公眾號和博客站點對知識體系進行分享。

博客地址： http://youngitman.tech

CSDN： https://blog.csdn.net/liyong1028826685

微信公眾號：

技術交流群：

Leave a Reply

Your email address will not be published. Required fields are marked *