@Configuration

在一次關于Spring注解的面試中，可能會經曆面試官的一段奪命連環問：

@Configuration有什麼用？ @Configuration和XML有什麼差別？哪種好？ Spring是如何基于來擷取Bean的定義的？ @Autowired 、 @Inject、@Resource 之間有什麼差別？ @Value、@PropertySource 和 @Configuration？ Spring如何處理帶@Configuration @Import的類？ @Profile有什麼用？ @Configuration 如何嵌套？ Spring如何對Bean進行延遲初始化？ Spring項目怎麼進行單元測試？ @Configuration 使用上有哪些限制？

本文就來嘗試回答下以上問題。簡單介紹下@Configuration 注解，并且你看一下他的基本用法以及和其他注解産生化學反應。文章内容較長，建議收藏。

@Configuration 基本說明

定義：訓示一個類聲明一個或者多個@Bean 聲明的方法并且由Spring容器統一管理，以便在運作時為這些bean生成bean的定義和服務請求的類。例如：

上述AppConfig 加入@Configuration 注解，表明這就是一個配置類。有一個myBean()的方法，傳回一個MyBean()的執行個體，并用@Bean 進行注釋，表明這個方法是需要被Spring進行管理的bean。@Bean 如果不指定名稱的話，預設使用myBean名稱，也就是小寫的名稱。

建立一個SpringBoot項目(别問我為什麼，因為這樣建立項目比較快)。

pom.xml 檔案如下：

在config 包下建立一個MyConfiguration環境配置，和上面的示例代碼相似，完整的代碼如下：

說明MyConfiguration 是一個配置類，能夠在此類下面聲明管理多個Bean，我們聲明了一個MyBean的bean，希望它被容器加載和管理。

在pojo包下建立一個MyBean的類，具體代碼如下

建立一個SpringConfigurationApplication類，用來測試MyConfiguration類，具體代碼如下：

輸出：

從輸出的結果可以看到，預設名稱為myBean 的bean随着容器的加載而加載，因為myBean方法傳回一個myBean的構造方法，是以myBean被初始化了。

可以通過使用XML方式定義的開啟基于注解的啟動，然後再定義一個MyConfiguration的bean，在<code>/resources</code>目錄下建立 application-context.xml 代碼如下：

需要引入applicationContext.xml ，在SpringConfigurationApplication 需要進行引入，修改後的SpringConfigurationApplication如下：

必須以類的方式提供(即不是從工廠方法傳回的執行個體)

@Configuration 注解的類必須是非final的

配置類必須是非本地的（即可能不在方法中聲明）,native 标注的方法

任何嵌套的@Configuration 都必須是static 的。

@Bean 方法可能不會反過來建立更多配置類

@Configuration注解作用在類上，就和普通類一樣能夠進行互相嵌套，定義内部類。

在上述代碼中，隻需要在應用程式的上下文中注冊 AppConfig 。由于是嵌套的@Configuration 類，DatabaseConfig 将自動注冊。當AppConfig 、DatabaseConfig 之間的關系已經隐含清楚時，這就避免了使用@Import 注解的需要。

<code>@Configuration</code> 通常和<code>Environment</code> 一起使用，通過<code>@Environment</code> 解析的屬性駐留在一個或多個"屬性源"對象中，<code>@Configuration</code>類可以使用<code>@PropertySource</code>，向Environment 對象提供屬性源

為了便于測試，我們引入junit4和spring-test 的依賴，完整的配置檔案如下

在config 包下定義一個 EnvironmentConfig 類，注入Environment 屬性，完整代碼如下：

在<code>/resources</code> 目錄下建立beanName.properties 檔案，如下：

啟動并進行Junit測試，輸出如下：

@Configuration 可以和@Value 和@PropertySource 一起使用讀取外部配置檔案，具體用法如下：

在config 包下建立一個ReadValueFromPropertySource類，代碼如下

通過@PropertySource引入的配置檔案，使@Value 能夠擷取到屬性值，在給myBean()方法指定了一個名稱叫做myTestBean。

修改MyBean類，增加一個name屬性和一個構造器，再生成其toString() 方法

在SpringConfigurationApplication中進行測試，如下

使用Applicatio@InConntext 就能夠擷取myTestBean 這個bean，再生成myBean的執行個體。

輸出：myBean = MyBean{name='bean.name.component'}

@Import的定義(來自于JavaDoc)：表明一個或者多個配置類需要導入，提供與Spring XML中相等的功能，允許導入@Configuration 、@ImportSelector、@ImportBeanDefinitionRegistar的實作，以及正常元件類似于AnnotationConfigApplicationContext。可能用于類級别或者是原注解。

如果XML或者其他非@Configuration标記的Bean資源需要被導入的話，使用@ImportResource。下面是一個示例代碼：

在pojo 包下建立兩個配置類，分别是CustomerBo, SchedualBo

在config 包下建立一個AppConfig，導入CustomerBo 和 SchedulerBo 。

在config 包下建立一個ImportWithConfiguration ，用于測試@Import 和 @Configuration 的使用

@ImportResource: 這個注解提供了與@Import 功能相似作用，通常與@Configuration 一起使用，通過AnnotationConfigApplicationContext 進行啟動，下面以一個示例來看一下具體用法：

在config下建立TestService 類，聲明一個構造函數，類初始化時調用

在/resources 目錄下建立 importResources.xml ，為了導入TestService

然後在config 下建立一個ImportResourceWithConfiguration， 用于讀取配置檔案

輸出：test @importResource success

@Lazy : 表明一個bean 是否延遲加載，可以作用在方法上，表示這個方法被延遲加載；

可以作用在@Component (或者由@Component 作為原注解) 注釋的類上，表明這個類中所有的bean 都被延遲加載。

如果沒有@Lazy注釋，或者@Lazy 被設定為false，那麼該bean 就會急切渴望被加載；除了上面兩種作用域，@Lazy 還可以作用在@Autowired和@Inject注釋的屬性上，在這種情況下，它将為該字段建立一個惰性代理，作為使用ObjectFactory或Provider的預設方法。下面來示範一下：

修改MyConfiguration類，在該類上添加@Lazy 注解，新增一個IfLazyInit()方法，檢驗是否被初始化。

修改SpringConfigurationApplication 啟動類，放開之前MyConfiguration 的啟動類

輸出你會發現沒有關于bean的定義資訊，但是當吧@Lazy 注釋拿掉，你會發現輸出了關于bean的初始化資訊：

基于ComponentScan() 來擷取Bean的定義

@Configuration 使用@Component 進行原注解，是以@Configuration 類也可以被元件掃描到（特别是使用XML元素）。

在這裡認識幾個注解: @Controller, @Service, @Repository, @Component

<code>@Controller</code>: 表明一個注解的類是一個"Controller"，也就是控制器，可以把它了解為MVC 模式的Controller 這個角色。這個注解是一個特殊的@Component，允許實作類通過類路徑的掃描掃描到。它通常與@RequestMapping 注解一起使用。

<code>@Service</code>: 表明這個帶注解的類是一個"Service"，也就是服務層，可以把它了解為MVC 模式中的Service層這個角色，這個注解也是一個特殊的@Component，允許實作類通過類路徑的掃描掃描到

<code>@Repository</code>: 表明這個注解的類是一個"Repository",團隊實作了JavaEE 模式中像是作為"Data Access Object" 可能作為DAO來使用，當與 PersistenceExceptionTranslationPostProcessor 結合使用時，這樣注釋的類有資格獲得Spring轉換的目的。這個注解也是@Component 的一個特殊實作，允許實作類能夠被自動掃描到

@Component: 表明這個注釋的類是一個元件，當使用基于注釋的配置和類路徑掃描時，這些類被視為自動檢測的候選者。

也就是說，上面四個注解标記的類都能夠通過@ComponentScan 掃描到，上面四個注解最大的差別就是使用的場景和語義不一樣，比如你定義一個Service類想要被Spring進行管理，你應該把它定義為<code>@Service</code> 而不是<code>@Controller</code>。因為我們從語義上講，<code>@Service</code>更像是一個服務的類，而不是一個控制器的類，<code>@Component</code>通常被稱作元件，它可以标注任何你沒有嚴格予以說明的類，比如說是一個配置類，它不屬于MVC模式的任何一層，這個時候你更習慣于把它定義為 <code>@Component</code>。

<code>@Controller</code>，<code>@Service</code>，<code>@Repository</code> 的注解上都有<code>@Component</code>，是以這三個注解都可以用<code>@Component</code>進行替換。

來看一下代碼進行了解：

定義五個類，類上分别用<code>@Controller</code>, <code>@Service</code>, <code>@Repository</code>, <code>@Component</code>, <code>@Configuration</code> 進行标注，分别如下

在MyConfiguration上加上@ComponentScan 注解，掃描上面5個類所在的包位置。代碼如下：

修改 SpringConfigurationApplication 中的代碼，如下：

由輸出可以清楚的看到，上述定義的五個類成功被@ComponentScan 掃描到，并在程式啟動的時候進行加載。

@Autowired 、 @Inject、@Resource 的差別

@Inject: 這是jsr330 的規範，通過<code>AutowiredAnnotationBeanPostProcessor</code> 類實作的依賴注入。位于javax.inject包内，是Java自帶的注解。

不加@Named注解，需要配置與變量名一緻即可。

<code>@Autowired</code>: @Autowired 是Spring提供的注解，通過<code>AutowiredAnnotationBeanPostProessor</code> 類實作注入。位于<code>org.springframework.beans.factory.annotation</code> 包内，是Spring 中的注解

預設是通過byType 實作注入

<code>@Resource</code>: @Resource 是jsr250規範的實作，@Resource通過<code>CommonAnnotationBeanPostProcessor</code> 類實作注入。@Resource 一般會指定一個name屬性，如下：

<code>@Autowired</code>和<code>@Inject</code>基本是一樣的，因為兩者都是使用<code>AutowiredAnnotationBeanPostProcessor</code>來處理依賴注入。

但是<code>@Resource</code>是個例外，它使用的是<code>CommonAnnotationBeanPostProcessor</code>來處理依賴注入。當然，兩者都是BeanPostProcessor。

在介紹完上述三者的差別之後，可以對Environment的屬性以上述注入方式進行改造

@Profile

@Profile: 表示當一個或多個@Value 指定的配置檔案處于可用狀态時，元件符合注冊條件，可以進行注冊。

三種設定方式：

可以通過ConfigurableEnvironment.setActiveProfiles()以程式設計的方式激活

可以通過AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME (spring.profiles.active )屬性設定為

JVM屬性

作為環境變量，或作為web.xml 應用程式的Servlet 上下文參數。也可以通過@ActiveProfiles 注解在內建測試中以聲明方式激活配置檔案。

作用域

作為類級别的注釋在任意類或者直接與@Component 進行關聯，包括@Configuration 類

作為原注解，可以自定義注解

作為方法的注解作用在任何方法

注意:

如果一個配置類使用了Profile 标簽或者@Profile 作用在任何類中都必須進行啟用才會生效，如果@Profile({"p1","!p2"}) 辨別兩個屬性，那麼p1 是啟用狀态 而p2 是非啟用狀态的。

@RunWith 和 @ContextConfiguration

Junit4 測試類，用于注解在類上表示通過Junit4 進行測試，可以省略編寫啟動類代碼，是ApplicationContext 等啟動類的替換。一般用@RunWith 和 @Configuration 進行單元測試，這是軟體開發過程中非常必要而且具有專業性的一部分，上面EnvironmentConfig 類證明了這一點：

@Enable 啟動Spring内置功能

詳情查閱@EnableAsync，@EnableScheduling，@EnableTransactionManagement，@EnableAspectJAutoProxy，@EnableWebMvc官方文檔