上篇博文講Spring的IOC容器時說道,雖然容器功能強大,但容器本身只是個空殼,需要我們主動放入裝配對象,並告訴它對象之間的協作關係,然後容器才能按照我們的指示發揮它的魔力,完成裝配bean的使命。這裡,我們把Spring創建應用對象之間的協作關係的行為成為裝配。Spring提供了很多裝配bean ...
上篇博文講Spring的IOC容器時說道,雖然容器功能強大,但容器本身只是個空殼,需要我們主動放入裝配對象,並告訴它對象之間的協作關係,然後容器才能按照我們的指示發揮它的魔力,完成裝配bean的使命。這裡,我們把Spring創建應用對象之間的協作關係的行為成為裝配。Spring提供了很多裝配bean的方式供我們在開發中選擇,我們常用到的有三種裝配機制:自動裝配、Java註解和XML配置。通常我們將第一種稱為隱式的裝配機制,後面兩種為顯示的裝配機制。實際應用中,基於便利性考慮,首選的肯定是隱式的自動化裝配機制,只有當需要註入的bean的源碼不是由自己的程式來維護,而是引入第三方的應用組件的時候,才考慮顯示的方式裝配bean。當然,各種裝配方式在實際應用中是可以自由選擇搭配的,編碼過程中也不必拘泥哪一種,適用就好。本篇博文先來講述隱式的裝配機制——bean的自動化裝配。
你一定很好奇Spring是怎麼來實現其自動化裝配機制的,其實Spring主要通過下麵兩個方面來實現:
- 組件掃描——通過開啟組件掃描功能讓Spring可以自動發現應用上下文中的bean;
- 自動裝配——自動滿足組件之間的依賴關係。
下麵,我們分別來看看Spring如何通過組件掃描和自動裝配來為我們的應用程式自動化的裝配bean。我們先定義一個汽車介面:
1 package spring.facade; 2 3 public interface Car { 4 void drive(); 5 }
組件掃描
組件掃描的要義在於通過掃描控制,讓Spring自動的去發現應用程式中的bean。不過程式中的對象那麼多,Spring怎麼知道哪些對象是需要它去管理創建的呢?這就涉及到Spring的一個組件註解——@Component,被該註解標註的類即為Spring的組件類,Spring容器載入過程中會自動的為該類創建bean(PS:實際上Spring的組件註解按照語義化的分類還有@Controller @Repository @Service等等,分別作用於控制層、持久層和業務層,此處僅是舉例演示,不做區分講解)。所以,我們可以將介面的一個實現標註上該註解,表明實現類是要被Spring創建實例的——
1 package spring.impl; 2 3 import org.springframework.stereotype.Component; 4 import spring.facade.Car; 5 6 @Component 7 public class QQCar implements Car { 8 @Override 9 public void drive() { 10 System.out.println("開QQ車"); 11 } 12 }
不過,Spring的註解掃描預設是不開啟的,所以我們還需要顯示的配置註解啟動。這裡同樣有兩種方式,Java註解和XML的方式,我們分別展示出來——
Java配置類CarConfig :
package spring.config; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; @Configuration @ComponentScan public class CarConfig { }
XML配置文件applicationContext.xml:
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> <!--啟動註解掃描--> <context:component-scan base-package="spring"/> </beans>
接下來我們編寫測試類,看看Spring是不是自動的去發現了我們註解為組件的bean併為我們創建了對象——
1 package spring.test; 2 3 import org.junit.Test; 4 import org.junit.runner.RunWith; 5 import org.springframework.beans.factory.annotation.Autowired; 6 import org.springframework.test.context.ContextConfiguration; 7 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; 8 import spring.config.CarConfig; 9 import spring.impl.QQCar; 10 import static org.junit.Assert.assertNotNull; 11 12 /** 13 * 註解釋義: 14 * @RunWith(SpringJUnit4ClassRunner.class) 測試在Spring環境中運行 15 * @ContextConfiguration 上下文配置註解,指定配置文件(Java類或XML文件)的位置 16 */ 17 @RunWith(SpringJUnit4ClassRunner.class) 18 //@ContextConfiguration(classes = CarConfig.class) //載入Java配置類的方式 19 @ContextConfiguration(locations = "classpath:resource/applicationContext.xml") //載入XML配置的方式 20 public class CarTest { 21 @Autowired 22 private QQCar car ; 23 24 @Test 25 public void carTest(){ 26 assertNotNull(car); 27 } 28 }
雖然現在的編程趨勢是越來越多的使用Java註解的方式,但是上面的測試你會發現,通過XML註解的方式能夠測試成功,而Java註解的方式卻是失敗的,測試會拋出NoSuchBeanDefinitionException的異常,表示沒有QQCar的組件定義,也就是Spring沒有發現它,Why? 原因也很簡單,那就是基於Java註解的方式啟動的註解掃描預設情況下只能掃描配置類所在的包以及其的子包,如果要明確掃描其它包中的組件,需要在啟動掃描的註解 @ComponetScan 中顯示的註明,如改成 @ComponentScan("spring.impl"),上訴的測試就能通過了。如果有多個包要掃描,可以這樣配置:@ComponentScan(basePackages = {"spring.impl","spring.test"}) 不過這樣字元串的表示方式是類型不安全的,而且寫死包名的方式不利於代碼重構,我們可以指定包中所含的類或介面來指定要掃描的包,於是可以這樣標註: @ComponentScan(basePackageClasses = QQCar.class) ,多個包同樣可以用{}來以數組形式的表示。不過這樣對重構依然不友好,最好的方式就是在要掃描的包中定義一個空標介面,該介面僅僅用來指定包掃描的範圍,如此將重構的影響降到最低。
自動裝配
前文的講述只是闡明如何將一個類定義成Spring的組件並啟動Spring的組件掃描,而且我們已經通過測試證實,Spring確實掃描到了我們指定的組件類併為我們創建了對象。不過,創建的對象只是獨立的存在,並沒有和其他對象產生依賴協作;實際應用中,對象之間的依賴協作是再常見不過了,而要將Spring通過組件掃描為我們創建的對象根據實際業務建立起相互的依賴協作,就需要利用Spring的自動裝配。便於演示,我們再定義一個Man類,Man的工作就是開車,我們先通過構造器註入的方式來滿足依賴,看Spring是否會給我們自動註入我們需要的Car的實例對象——
package spring.impl; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import spring.facade.Car; @Component public class Man { private Car car; public Man() { } @Autowired public Man(QQCar car) { this.car = car; } public void work() { car.drive(); } }
測試方法——
1 package spring.test; 2 3 import org.junit.Test; 4 import org.junit.runner.RunWith; 5 import org.springframework.beans.factory.annotation.Autowired; 6 import org.springframework.test.context.ContextConfiguration; 7 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; 8 import spring.config.CarConfig; 9 import spring.impl.Man; 10 11 @RunWith(SpringJUnit4ClassRunner.class) 12 @ContextConfiguration(classes = CarConfig.class) 13 public class CarTest { 14 15 @Autowired 16 Man man; 17 18 @Test 19 public void carTest() { 20 man.work(); 21 } 22 }
如以上代碼,測試當然是成功的,在測試類中,Man作為組件類被Spring掃描並創建了一個對象實例,該實例調用work方法的時候,需要Car的實例對象,而我們在有參構造函數上通過 @Autowired 註解表明瞭對象的依賴關係,程式運行過程中,Spring會自動為我們註入Car的實例對象來滿足對象依賴,這就是自動裝配的精要所在。實際上,不只是構造器上可以用 @Autowired 註解,在屬性的Setter方法上,甚至普通的方法上,都可以用@Autowired 註解來滿足對象之間的依賴,實現自動註入的功能——
1 package spring.impl; 2 3 4 import org.springframework.beans.factory.annotation.Autowired; 5 import org.springframework.stereotype.Component; 6 import spring.facade.Car; 7 8 @Component 9 public class Man { 10 private Car car; 11 12 public Man() { 13 } 14 //構造器實現自動裝配 15 // @Autowired 16 public Man(QQCar car) { 17 this.car = car; 18 } 19 20 //Setter方法實現自動裝配 21 // @Autowired 22 public void setCar(QQCar car) { 23 this.car = car; 24 } 25 //普通方法實現自動裝配 26 @Autowired 27 public void insertCar(QQCar car) { 28 this.car = car; 29 } 30 31 public void work() { 32 car.drive(); 33 } 34 }
我們將Man類中添加不同的方法測試,依然是可以成功的。不過有一點要註意,在非構造器實現自動裝配的時候,雖然我們沒有自己new對象,但Spring創建實例會通過Man的預設的構造器,此時的Man類中如果定義了有參構造器,就一定要把預設構造器構造出來,不然會拋無預設構造器的異常,記住:一定養成類中寫預設構造器的習慣,便於擴展。
自動裝配的歧義性
如果你足夠細心,你會發現博主上面滿足自動裝配的測試代碼中,註入的Car並沒有採用多態的寫法,代碼顯得很低級。其實我是為了測試通過,故意註入了具體的實現,實際業務中當然不會這麼局限的去寫代碼。因為博主Car的介面還有一個賓士車的實現類BenzCar,如果用多態的寫法,自動裝配會有產生歧義性問題,會拋 NoUniqueBeanDefinitionException 異常。那麼,面對這種歧義性,如何去解決呢?你一定知道Spring容器管理的每個bean都會有一個ID作為唯一標識,在上面的示例中,我們描述QQCar類為Spring的組件的時候並沒有明確的設置ID,但是Spring預設會將組件類的類名首字母小寫來作為bean的ID,而我們也可根據我們自己的業務需要自定義ID標識——
package spring.impl;
import org.springframework.stereotype.Component;
import spring.facade.Car;
//這裡指定 chenbenbuyi 為組件的ID
@Component("chenbenbuyi")
public class QQCar implements Car {
@Override
public void drive() {
System.out.println("開QQ車");
}
}
可是測試發現,這並沒有解決介面參數在自動裝配時的歧義性問題,因為在組件上自定義ID是一種後發行為,當你讓Spring在裝配階段從多個介面實現中選擇要自動註入的對象實例時,Spring無法選擇——就好比你只跟我說你要開一輛車,每輛車也都有唯一的車牌號,但我還是不知道你要開什麼車。怎麼辦呢?這裡有多種解決方案,我們可以通過 @Primary註解將我們明確需要自動註入的實現類標註為首選的bean,就想這樣——
1 package spring.impl; 2 3 import org.springframework.context.annotation.Primary; 4 import org.springframework.stereotype.Component; 5 import spring.facade.Car; 6 7 @Component 8 @Primary 9 public class BenzCar implements Car { 10 @Override 11 public void drive() { 12 System.out.println("開賓士車"); 13 } 14 }
當自動裝配的時候,Spring面對歧義性時,會優先選擇被標註為首選的bean進行自動註入。當然,我們還可以採用限定符註解,在使用@Autowired 完成自動裝配的時候限定只讓某個bean作為自動註入的bean——
1 package spring.impl; 2 3 4 import org.springframework.beans.factory.annotation.Autowired; 5 import org.springframework.beans.factory.annotation.Qualifier; 6 import org.springframework.stereotype.Component; 7 import spring.facade.Car; 8 9 @Component 10 public class Man { 11 private Car car; 12 13 public Man() { 14 } 15 //普通方法實現自動裝配 16 @Autowired 17 @Qualifier("chenbenbuyi") //限定ID為 chenbenbuyi 的bean被裝配進來 18 public void insertCar(Car car) { 19 this.car = car; 20 } 21 22 public void work() { 23 car.drive(); 24 } 25 }
自此,關於Spring的自動裝配就闡述得差不多了,下一節系列文章會接著講解Spring的另外兩種常用的裝配機制——Java註解和XML配置。博文所述皆為原創,如要轉載,請註明出處;如果闡述得不恰當的地方,歡迎指教,不勝感激。