Spring自動掃描與自動裝配
知識點
- 自動掃描元件
- 自動裝配 Bean
專案檔案結構
三、實驗步驟
3.1 自動掃描元件
通常你可以在 xml 配置檔案中,宣告一個 bean 或者 component ,然後 Spring 容器會檢查和註冊你的 bean 或 component 。
實際上,Spring 支援自動掃描 bean 或 component ,你可以不必再在 xml 檔案中繁瑣的宣告 bean ,Spring 會自動掃描、檢查你指定包的 bean 或 component 。以下列舉一個簡單的 Spring Project ,包含了 Customer 、 Service 、 DAO 層,由此分析下手動配置和自動掃描的不同。
首先建立一個新的工程,步驟如下圖所示:
修改 pom.xml 檔案,新增 Spring 的部署:
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>4.0.9.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>4.0.9.RELEASE</version>
</dependency>
3.1.1 手動配置 component
先看一下正常手動配置一個 bean 。
DAO 層,建立 CustomerDAO.java 步驟如下:
內容如下:
package com.shiyanlou.spring.dao;
public class CustomerDAO {
@Override
public String toString(){
return "Hello , This is CustomerDAO";
}
}
Service層,建立 CustomerService.java 步驟如下:
內容如下:
package com.shiyanlou.spring.services;
import com.shiyanlou.spring.dao.CustomerDAO;
public class CustomerService {
CustomerDAO customerDAO;
public void setCustomerDAO(CustomerDAO customerDAO) {
this.customerDAO = customerDAO;
}
@Override
public String toString() {
return "CustomerService [customerDAO=" + customerDAO + "]";
}
}
建立並配置 SpringCustomer.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"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
<bean id="customerService" class="com.shiyanlou.spring.services.CustomerService">
<property name="customerDAO" ref="customerDAO" />
</bean>
<bean id="customerDAO" class="com.shiyanlou.spring.dao.CustomerDAO" />
</beans>
最後,建立 App.java 檔案,在路徑 com.shiyanlou.spring.common
下。內容如下:
package com.shiyanlou.spring.common;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.shiyanlou.spring.services.CustomerService;
public class App {
public static void main( String[] args )
{
ApplicationContext context =
new ClassPathXmlApplicationContext(new String[] {"SpringCustomer.xml"});
CustomerService cust = (CustomerService)context.getBean("customerService");
System.out.println(cust);
}
}
實驗結果如下:
3.1.2 自動掃描元件
用註釋 @Component 來表示這個 Class 是一個自動掃描元件。CustomerDAO.java 的內容如下:
package com.shiyanlou.spring.dao;
import org.springframework.stereotype.Component;
@Component
public class CustomerDAO
{
@Override
public String toString() {
return "Hello , This is CustomerDAO";
}
}
CustomerService.java 的內容如下:
package com.shiyanlou.spring.services;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import com.shiyanlou.spring.dao.CustomerDAO;
@Component
public class CustomerService
{
@Autowired
CustomerDAO customerDAO;
@Override
public String toString() {
return "CustomerService [customerDAO=" + customerDAO + "]";
}
}
配置檔案SpringCustomer.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/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">
<context:component-scan base-package="com.shiyanlou.spring" />
</beans>
注意:以上 xml 檔案中,加入了
context:component-scan
標籤,beans
中也加入了標籤,這樣就將 Spring的自動掃描特性引入,base-package
表示元件的存放位置,Spring 將掃描對應資料夾下的 bean(用 @Component註釋過的),將這些bean
註冊到容器中。 最後執行結果與手動配置的結果一致。
最後執行結果與手動配置的結果一致。
3.1.3 自定義掃描元件名稱
上例中,預設情況下,Spring 將把元件 Class 的第一個字母變成小寫,來作為自動掃描元件的名稱,例如將 CustomerService
轉變為 customerService
,你可以用 customerService
這個名字呼叫元件,如下:
CustomerService cust = (CustomerService)context.getBean("customerService");
也可以像下面這樣,建立自定義的元件名稱:
@Service("AAA")
public class CustomerService
...
但是得新增下面的程式碼:
import org.springframework.stereotype.Service;
可以呼叫自己定義的元件了,如下:
CustomerService cust = (CustomerService)context.getBean("AAA");
3.1.4 自動掃描元件的註釋型別
有 4 種註釋型別,分別是:
- @Component ——表示一個自動掃描 component
- @Repository ——表示持久化層的 DAO component
- @Service ——表示業務邏輯層的 Service component
- @Controller ——表示表示層的 Controller component
在專案中,我們可以將所有自動掃描元件都用 @Component 註釋,Spring 將會掃描所有用 @Component 註釋過得元件。 實際上,@Repository 、 @Service 、 @Controller 三種註釋是為了加強程式碼的閱讀性而創造的,可以在不同的應用層中,用不同的註釋,我們可以在上一個專案的基礎上改一下注釋,如下:
DAO 層:
package com.shiyanlou.spring.dao;
import org.springframework.stereotype.Repository;
@Repository
public class CustomerDAO
{
@Override
public String toString() {
return "Hello , This is CustomerDAO";
}
}
Service 層:
package com.shiyanlou.spring.services;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.shiyanlou.spring.dao.CustomerDAO;
@Service
public class CustomerService
{
@Autowired
CustomerDAO customerDAO;
@Override
public String toString() {
return "CustomerService [customerDAO=" + customerDAO + "]";
}
}
3.1.5 自動掃描中過濾元件
1). Filter Component - include
下例演示了用“ filter ”自動掃描註冊元件,這些元件只要匹配定義的“ regex ”的命名規則,Class 前就不需要用 @Component 進行註釋。
DAO 層,CustomerDAO.java 如下:
package com.shiyanlou.spring.dao;
public class CustomerDAO
{
@Override
public String toString() {
return "Hello , This is CustomerDAO";
}
}
Service 層,CustomerService.java如下:
package com.shiyanlou.spring.services;
import org.springframework.beans.factory.annotation.Autowired;
import com.shiyanlou.spring.dao.CustomerDAO;
public class CustomerService
{
@Autowired
CustomerDAO customerDAO;
@Override
public String toString() {
return "CustomerService [customerDAO=" + customerDAO + "]";
}
}
SpringFiltering.xml 配置如下:
.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/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">
<context:component-scan base-package="com.shiyanlou.spring" >
<context:include-filter type="regex"
expression="com.shiyanlou.spring.dao.*DAO.*" />
<context:include-filter type="regex"
expression="com.shiyanlou.spring.services.*Service.*" />
</context:component-scan>
</beans>
以上 xml 檔案中,所有檔名字,只要包含 DAO 和 Service( DAO.,Service. )關鍵字的,都將被檢查註冊到 Spring 容器中。
建立App.java並執行如下:
package com.shiyanlou.spring.common;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.lei.customer.services.CustomerService;
public class App
{
public static void main( String[] args )
{
ApplicationContext context =
new ClassPathXmlApplicationContext(new String[] {"SpringFiltering.xml"});
CustomerService cust = (CustomerService)context.getBean("customerService");
System.out.println(cust);
}
}
執行結果與之前相同。
2). Filter Component——exclude
也可以用 exclude ,制定元件避免被 Spring 發現並被註冊到容器中。以下配置排除用 @Service 註釋過的元件:
<context:component-scan base-package="com.shiyanlou.spring" >
<context:exclude-filter type="annotation"
expression="org.springframework.stereotype.Service" />
</context:component-scan>
以下配置排除包含 DAO 關鍵字的元件:
<context:component-scan base-package="com.shiyanlou.spring" >
<context:exclude-filter type="regex"
expression="com.shiyanlou.spring.dao.*DAO.*" />
</context:component-scan>
3.2 自動裝配 Bean
所謂自動裝配,就是將一個 Bean 注入到其他 Bean 的 Property 中,類似於以下:
<bean id="customer" class="com.shiyanlou.spring.autowire.common.Customer" autowire="byName" />
Spring 支援 5 種自動裝配模式,如下:
- no —— 預設情況下,不自動裝配,通過 ref attribute手動設定。
- byName —— 根據 Property 的 Name 自動裝配,如果一個 bean 的 name ,和另一個 bean 中的
Property 的 name 相同,則自動裝配這個 bean 到 Property 中。 - byType —— 根據 Property 的資料型別( Type )自動裝配,如果一個 bean 的資料型別,相容另一個 bean 中
Property 的資料型別,則自動裝配。 - constructor —— 根據建構函式引數的資料型別,進行 byType 模式的自動裝配。
- autodetect —— 如果發現預設的建構函式,用 constructor 模式,否則,用 byType 模式。
下例中演示自動裝配,CustomerService.java 如下:
package com.shiyanlou.spring.services;
import com.shiyanlou.spring.dao.CustomerDAO;
public class CustomerService {
CustomerDAO customerDAO;
public void setCustomerDAO(CustomerDAO customerDAO) {
this.customerDAO = customerDAO;
}
@Override
public String toString() {
return "CustomerService [customerDAO=" + customerDAO + "]";
}
}
CustomerDAO.java 如下:
package com.shiyanlou.spring.dao;
public class CustomerDAO {
@Override
public String toString(){
return "Hello , This is CustomerDAO";
}
}
3.2.1 Auto-Wiring no
預設情況下,需要通過 ref
來裝配 bean ,如下:
<bean id="customerService" class="com.shiyanlou.spring.services.CustomerService">
<property name="customerDAO" ref="customerDAO" />
</bean>
<bean id="customerDAO" class="com.shiyanlou.spring.dao.CustomerDAO" />
3.2.2 Auto-Wiring byName
根據屬性 Property 的名字裝配 bean ,這種情況,CustomerService 設定了 autowire="byName"
,Spring 會自動尋找與屬性名字 customerDAO
相同的 bean ,找到後,通過呼叫 setCustomerDAO(CustomerDAO customerDAO) 將其注入屬性。
<bean id="customerService" class="com.shiyanlou.spring.services.CustomerService" autowire="byName">
</bean>
<bean id="customerDAO" class="com.shiyanlou.spring.dao.CustomerDAO" />
如果根據 Property name 找不到對應的 bean 配置,如下:
<bean id="customerService" class="com.shiyanlou.spring.services.CustomerService" autowire="byName">
</bean>
<bean id="customerDAO_another" class="com.shiyanlou.spring.dao.CustomerDAO" />
CustomerService 中 Property 名字是 customerDAO ,但是配置檔案中找不到 customerDAO ,只有 customerDAO_another ,這時就會裝配失敗,執行後,CustomerService 中 customerDAO=null 。
3.2.3 Auto-Wiring byType
根據屬性 Property 的資料型別自動裝配,這種情況,CustomerService 設定了 autowire="byType"
,Spring 會自動尋找與屬性型別相同的 bean ,找到後,通過呼叫 setCustomerDAO(CustomerDAO customerDAO) 將其注入。
<bean id="customerService" class="com.shiyanlou.spring.services.CustomerService" autowire="byType">
</bean>
<bean id="customerDAO" class="com.shiyanlou.spring.dao.CustomerDAO" />
如果配置檔案中有兩個型別相同的 bean 會怎樣呢?如下:
<bean id="customerService" class="com.shiyanlou.spring.services.CustomerService" autowire="byType">
</bean>
<bean id="customerDAO" class="com.shiyanlou.spring.dao.CustomerDAO" />
<bean id="customerDAO_another" class="com.shiyanlou.spring.dao.CustomerDAO" />
一旦配置如上,有兩種相同資料型別的 bean 被配置,將丟擲 UnsatisfiedDependencyException 異常,見以下: Exception in thread “main” org.springframework.beans.factory.UnsatisfiedDependencyException: 所以,一旦選擇了 byType
型別的自動裝配,請確認你的配置檔案中每個資料型別定義一個唯一的 bean 。
3.2.4 Auto-Wiring constructor
這種情況下,Spring 會尋找與引數資料型別相同的 bean ,通過建構函式 public Customer(Person person) 將其注入。
<bean id="customerService" class="com.shiyanlou.spring.services.CustomerService" autowire="constructor">
</bean>
<bean id="customerDAO" class="com.shiyanlou.spring.dao.CustomerDAO" />
注意:專案中 autowire 結合 dependency-check 一起使用是一種很好的方法,這樣能夠確保屬性總是可以成功注入。如下:
<bean id="customerService" class="com.shiyanlou.spring.services.CustomerService" autowire="autodetect" dependency-check="objects">
</bean>
<bean id="customerDAO" class="com.shiyanlou.spring.dao.CustomerDAO" />