知識庫 / Spring RSS 訂閱

1. 概述

在本教程中，我們將對 Spring 的 @Component 註解及其相關領域進行全面瞭解。我們將看到我們如何與一些核心 Spring 功能集成，以及如何利用其眾多優勢。

2. Spring ApplicationContext

在理解 @Component 的價值之前，我們需要先了解一些關於 Spring ApplicationContext 的基本知識。

Spring ApplicationContext 是 Spring 存儲並自動管理和分發的對象實例的地方。這些對象被稱為 Bean。

Spring 的一些主要功能包括 Bean 管理和依賴注入的機會。

利用控制反轉原則，Spring 收集應用程序中的 Bean 實例並在適當的時候使用它們。 我們無需處理這些對象的設置和實例化，即可向 Spring 展示 Bean 依賴關係。

能夠使用諸如 @Autowired 這樣的註解將 Spring 管理的 Bean 注入到我們的應用程序中，是創建強大且可擴展的 Spring 代碼的關鍵驅動力。

那麼，我們如何告訴 Spring 我們想要它管理哪些 Bean？ 我們應該利用 Spring 的自動 Bean 檢測功能，通過在我們的類中使用 Stereotype 註解。

3. <em @Component>

@Component 是一個註解，允許 Spring 自動檢測我們的自定義 Bean。

換句話説，無需編寫任何顯式代碼，Spring 將會：

• 掃描應用程序中帶有 @Component 註解的類
• 實例化它們並注入任何指定的依賴項
• 在需要的地方注入它們

然而，大多數開發者更傾向於使用更專業的 Stereotype 註解來執行此功能。

3.1. Spring 樣板註解

Spring 提供了幾個樣板註解，包括 @Controller、@Service 和 @Repository。它們的功能與 @Component 相同。

它們的功能相同，因為它們都是由 @Component 作為元註解構成的複合註解。 它們就像 @Component 的別名，具有專門用途和在 Spring 自動檢測或依賴注入之外的含義。

如果我們需要使用註解來自動檢測 Bean，理論上我們可以只使用 @Component。 另一方面，我們也可以將這些專門註解組合使用，並使用 @Component。

然而，在 Spring 的其他領域，它們會專門查找 Spring 的樣板註解，以提供額外的自動化優勢。 因此，我們最好大多數情況下堅持使用這些已建立的樣板。

以下是一個每個情況的示例，在我們的 Spring Boot 項目中：

@Controller
public class ControllerExample {
}

@Service
public class ServiceExample {
}

@Repository
public class RepositoryExample {
}

@Component
public class ComponentExample {
}

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Component
public @interface CustomComponent {
}

@CustomComponent
public class CustomComponentExample {
}

我們編寫一個測試，以證明每個組件都能被 Spring 自動檢測並添加到 ApplicationContext 中：

@SpringBootTest
@ExtendWith(SpringExtension.class)
public class ComponentUnitTest {

    @Autowired
    private ApplicationContext applicationContext;

    @Test
    public void givenInScopeComponents_whenSearchingInApplicationContext_thenFindThem() {
        assertNotNull(applicationContext.getBean(ControllerExample.class));
        assertNotNull(applicationContext.getBean(ServiceExample.class));
        assertNotNull(applicationContext.getBean(RepositoryExample.class));
        assertNotNull(applicationContext.getBean(ComponentExample.class));
        assertNotNull(applicationContext.getBean(CustomComponentExample.class));
    }
}

3.2. <em @ComponentScan</em>>

在完全依賴 <em @Component</em>> 之前，我們必須理解它只是一個簡單的註解。該註解的作用是區分 Bean 與其他對象，例如領域對象。

但是，Spring 使用 <em @ComponentScan</em>> 註解將它們收集到其 <em ApplicationContext</em>> 中。

package com.baeldung.component.scannedscope;

@Component
public class ScannedScopeExample {
}

package com.baeldung.component.inscope;

@SpringBootApplication
@ComponentScan({"com.baeldung.component.inscope", "com.baeldung.component.scannedscope"})
public class ComponentApplication {
    //public static void main(String[] args) {...}
}

@Test
public void givenScannedScopeComponent_whenSearchingInApplicationContext_thenFindIt() {
    assertNotNull(applicationContext.getBean(ScannedScopeExample.class));
}

package com.baeldung.component.outsidescope;

@Component
public class OutsideScopeExample {
}

@Test
public void givenOutsideScopeComponent_whenSearchingInApplicationContext_thenFail() {
    assertThrows(NoSuchBeanDefinitionException.class, () -> applicationContext.getBean(OutsideScopeExample.class));
}

public class BeanExample {
}

@Bean
public BeanExample beanExample() {
    return new BeanExample();
}

@Test
public void givenBeanComponents_whenSearchingInApplicationContext_thenFindThem() {
    assertNotNull(applicationContext.getBean(BeanExample.class));
}