1. 程式人生 > 其它 >Spring 註解@Bean 和 @Component的區別

Spring 註解@Bean 和 @Component的區別

本文打算介紹幾個不太容易說出其區別,或者用途的 Spring 註解,比如 @Component@Bean 的比較,@ControllerAdvice 是如何處理自定義異常的等等。

Spring 中的一些註解

1. @Component 和 @Bean 的區別是什麼?

  1. 作用物件不同:@Component 註解作用於類,而 @Bean 註解作用於方法、
  2. @Component 通常是通過路徑掃描來自動偵測以及自動裝配到 Spring 容器中(我們可以使用 @ComponentScan 註解定義要掃描的路徑從中找出標識了需要裝配的類自動裝配到 Spring 的 bean 容器中)。@Bean
    註解通常是我們在標有該註解的方法中定義產生這個 bean,@Bean 告訴了 Spring 這是某個類的例項,當我們需要用它的時候還給我。
  3. @Bean 註解比 @Component 註解的自定義性更強,而且很多地方我們只能通過 @Bean 註解來註冊 bean。比如當我們引用第三方庫中的類需要裝配到 Spring 容器時,只能通過 @Bean 來實現。

@Bean 註解使用示例:

@Configuration
public class AppConfig {
    @Bean
public TransferService transferService() {
return new TransferServiceImpl();
    }
}

@Component 註解使用示例:

@Component
public class ServiceImpl implements AService {
    ....
}

下面這個例子是通過 @Component 無法實現的:

@Bean
public OneService getService(status) {
case (status)  {
when 1:
return new serviceImpl1();
when 2:
return new serviceImpl2();
when 3:
return new serviceImpl3();
    }
}

2. Autowire 和 @Resource 的區別

  1. @Autowire@Resource都可以用來裝配bean,都可以用於欄位或setter方法。
  2. @Autowire 預設按型別裝配,預設情況下必須要求依賴物件必須存在,如果要允許 null 值,可以設定它的 required 屬性為 false。
  3. @Resource 預設按名稱裝配,當找不到與名稱匹配的 bean 時才按照型別進行裝配。名稱可以通過 name 屬性指定,如果沒有指定 name 屬性,當註解寫在欄位上時,預設取欄位名,當註解寫在 setter 方法上時,預設取屬性名進行裝配。
注意:如果 name 屬性一旦指定,就只會按照名稱進行裝配。

@Autowire@Qualifier配合使用效果和@Resource一樣:

@Autowired(required = false) @Qualifier("example")
private Example example;

@Resource(name = "example")
private Example example;

@Resource 裝配順序

  1. 如果同時指定 name 和 type,則從容器中查詢唯一匹配的 bean 裝配,找不到則丟擲異常;
  2. 如果指定 name 屬性,則從容器中查詢名稱匹配的 bean 裝配,找不到則丟擲異常;
  3. 如果指定 type 屬性,則從容器中查詢型別唯一匹配的 bean 裝配,找不到或者找到多個丟擲異常;
  4. 如果不指定,則自動按照 byName 方式裝配,如果沒有匹配,則回退一個原始型別進行匹配,如果匹配則自動裝配。

3. 將一個類宣告為 Spring 的 bean 的註解有哪些?

  • @Component :通用的註解,可標註任意類為 Spring 的元件。如果一個 Bean 不知道屬於哪個層,可以使用 @Component 註解標註。
  • @Repository :對應持久層即 Dao 層,主要用於資料庫相關操作。
  • @Service :對應服務層,主要設計一些複雜的邏輯,需要用到 Dao 層。
  • @Controller :對應 Spring MVC 控制層,主要用來接受使用者請求並呼叫 Service 層返回資料給前端頁面。
  • @Configuration :宣告該類為一個配置類,可以在此類中宣告一個或多個 @Bean 方法。

4. @Configuration :配置類註解

@Configuration 表明在一個類裡可以宣告一個或多個 @Bean 方法,並且可以由 Spring 容器處理,以便在執行時為這些 bean 生成 bean 定義和服務請求,例如:

@Configuration
public class AppConfig {

    @Bean
public MyBean myBean() {
// instantiate, configure and return bean ...
    }
}

我們可以通過 AnnotationConfigApplicationContext 來註冊 @Configuration 類:

AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(AppConfig.class);
ctx.refresh();
MyBean myBean = ctx.getBean(MyBean.class);
// use myBean ...

另外也可以通過元件掃描(component scanning)來載入,@Configuration 使用 @Component 進行原註解,因此 @Configuration 類也可以被元件掃描到(特別是使用 XML 的 元素)。@Configuration 類不僅可以使用元件掃描進行引導,還可以使用 @ComponentScan 註解自行配置元件掃描:

@Configuration
@ComponentScan("com.acme.app.services")
public class AppConfig {
// various @Bean definitions ...
}

使用 @Configuration 的約束:

  • 配置類必須以類的方式提供(比如不能是由工廠方法返回的例項)。
  • 配置類必須是非 final 的。
  • 配置類必須是非本地的(即可能不在方法中宣告),native 標註的方法。
  • 任何巢狀的配置類必須宣告為 static。
  • @Bean 方法可能不會反過來建立更多的配置類。

除了單獨使用 @Configuration 註解,我們還可以結合一些外部的 bean 或者註解共同使用,比如 Environment API@PropertySource@Value@Profile 等等許多,這裡就不做詳細介紹了,更多的用法可以參看 Spring @Configuration 的相關文件 。

5. @ControllerAdvice :處理全域性異常利器

在 Spring 3.2 中,新增了 @ControllerAdvice@RestControllerAdvice@RestController 註解,可以用於定義 @ExceptionHandler@InitBinder@ModelAttribute,並應用到所有 @RequestMapping@PostMapping@GetMapping等這些 Controller 層的註解中。預設情況下,@ControllerAdvice 中的方法應用於全域性所有的 Controller。而使用選擇器 annotations()basePackageClasses()basePackages() (或其別名value())來定義更小範圍的目標 Controller 子集。如果聲明瞭多個選擇器,則應用 OR 邏輯,這意味著所選的控制器應匹配至少一個選擇器。請注意,選擇器檢查是在執行時執行的,因此新增許多選擇器可能會對效能產生負面影響並增加複雜性。@ControllerAdvice 我們最常使用的是結合 @ExceptionHandler 用於全域性異常的處理。可以結合以下例子,我們可以捕獲自定義的異常進行處理,並且可以自定義狀態碼返回:

@ControllerAdvice("com.developlee.errorhandle")
public class MyExceptionHandler {
    /**
     * 捕獲CustomException
     * @param e
     * @return json格式型別
     */
    @ResponseBody
    @ExceptionHandler({CustomException.class}) //指定攔截異常的型別
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) //自定義瀏覽器返回狀態碼
    public Map>String, Object< customExceptionHandler(CustomException e) {
        Map&lt;String, Object&gt; map = new HashMap&lt;&gt;();
map.put("code", e.getCode());
map.put("msg", e.getMsg());
return map;
    }
}

更多資訊可以參看 Spring @ControllerAdvice 的官方文件。

6. @Component, @Repository, @Service 的區別

@Component是一個通用的Spring容器管理的單例bean元件。而@Repository, @Service, @Controller就是針對不同的使用場景所採取的特定功能化的註解元件。因此,當你的一個類被@Component所註解,那麼就意味著同樣可以用@Repository, @Service, @Controller 來替代它,同時這些註解會具備有更多的功能,而且功能各異。最後,如果你不知道要在專案的業務層採用@Service還是@Component註解。那麼,@Service是一個更好的選擇。

總結

以上簡單介紹了幾種 Spring 中的幾個註解及程式碼示例,就我個人而言,均是平時用到且不容易理解的幾個,或者容易忽略的幾個。當然,這篇文章並沒有完全介紹完,在今後還會繼續補充完善。