SpringBoot中注冊(cè)Bean的10種方式總結(jié)

更新時(shí)間：2024年08月11日 11:40:44 作者：碼到三十五

在Spring Boot應(yīng)用中,Bean是構(gòu)成應(yīng)用的核心組件,Spring容器負(fù)責(zé)管理這些Bean,包括它們的創(chuàng)建、配置、組裝、管理和銷(xiāo)毀,在Spring Boot中,有多種方式可以注冊(cè)Bean,本文將詳細(xì)介紹這些不同的注冊(cè)方式,并給出相應(yīng)的示例代碼和適用場(chǎng)景,需要的朋友可以參考下

前言
1. 使用@Component及其派生注解
2. 使用@Bean注解
3. 使用@Import注解
4. 使用ImportSelector接口
5. 使用ImportBeanDefinitionRegistrar接口
6. 使用FactoryBean接口
7. 使用@ComponentScan注解
8. 自動(dòng)配置（Spring Boot Starter）
9. 使用@Enable*注解
10. 編程式地注冊(cè)Bean（使用ApplicationContext）

前言

在Spring Boot應(yīng)用中，Bean是構(gòu)成應(yīng)用的核心組件。Spring容器負(fù)責(zé)管理這些Bean，包括它們的創(chuàng)建、配置、組裝、管理和銷(xiāo)毀。在Spring Boot中，有多種方式可以注冊(cè)Bean，讓Spring容器能夠管理它們。本文將詳細(xì)介紹這些不同的注冊(cè)方式，并給出相應(yīng)的示例代碼和適用場(chǎng)景。

1. 使用@Component及其派生注解

@Component是一個(gè)泛化的注解，用于標(biāo)記一個(gè)類(lèi)作為Spring容器管理的Bean。Spring Boot在啟動(dòng)時(shí)會(huì)自動(dòng)掃描這些注解，并將標(biāo)記的類(lèi)注冊(cè)為Bean。@Service、@Repository和@Controller是@Component的派生注解，分別用于標(biāo)記服務(wù)層、持久層和控制器層的組件。

代碼:

@Service
public class MyService {
    // 服務(wù)邏輯...
}

適用場(chǎng)景:

當(dāng)你需要讓Spring容器管理一個(gè)自定義的類(lèi)的實(shí)例時(shí)，可以使用@Component及其派生注解。

2. 使用@Bean注解

在配置類(lèi)中，可以使用@Bean注解來(lái)聲明一個(gè)Bean。這個(gè)方法會(huì)返回一個(gè)對(duì)象，該對(duì)象會(huì)被注冊(cè)為一個(gè)Bean，并且方法名默認(rèn)作為Bean的ID。

代碼:

@Configuration
public class AppConfig {
    @Bean
    public MyBean myBean() {
        return new MyBean();
    }
}

適用場(chǎng)景:

當(dāng)你需要在Java配置類(lèi)中顯式聲明Bean時(shí)，可以使用@Bean注解。
當(dāng)你需要注冊(cè)一個(gè)非自定義的類(lèi)到容器中時(shí).

3. 使用@Import注解

@Import注解可以用于導(dǎo)入其他配置類(lèi)，這樣可以將分散在不同配置類(lèi)中的Bean集中管理。

代碼:

// 定義一個(gè)配置類(lèi)  
@Configuration  
public class OtherConfig {  
    @Bean  
    public OtherBean otherBean() {  
        return new OtherBean();  
    }  
}  
  
// 在主配置類(lèi)中導(dǎo)入OtherConfig  
@Configuration  
@Import(OtherConfig.class)  
public class AppConfig {  
    // 其他Bean定義...  
}

適用場(chǎng)景:

當(dāng)你需要將多個(gè)配置類(lèi)分散管理，但又想在一個(gè)主配置類(lèi)中集中導(dǎo)入它們時(shí)，可以使用@Import注解。

4. 使用ImportSelector接口

ImportSelector接口允許你根據(jù)條件選擇性地導(dǎo)入配置類(lèi)。實(shí)現(xiàn)這個(gè)接口后，可以返回需要導(dǎo)入的配置類(lèi)的全類(lèi)名數(shù)組。

// 實(shí)現(xiàn)ImportSelector接口  
public class MyImportSelector implements ImportSelector {  
    @Override  
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {  
        // 根據(jù)條件選擇導(dǎo)入的配置類(lèi)  
        return new String[]{OtherConfig.class.getName()};  
    }  
}  
  
// 在主配置類(lèi)中使用@Import注解導(dǎo)入ImportSelector  
@Configuration  
@Import(MyImportSelector.class)  
public class AppConfig {  
    // 其他Bean定義...  
}

適用場(chǎng)景:

當(dāng)你需要根據(jù)不同條件導(dǎo)入不同配置時(shí)，可以使用ImportSelector接口。

5. 使用ImportBeanDefinitionRegistrar接口

ImportBeanDefinitionRegistrar接口允許你在導(dǎo)入配置類(lèi)時(shí)注冊(cè)額外的Bean定義。這在你需要編程式地注冊(cè)Bean時(shí)非常有用。

// 實(shí)現(xiàn)ImportBeanDefinitionRegistrar接口  
public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {  
    @Override  
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {  
        // 注冊(cè)一個(gè)Bean定義  
        RootBeanDefinition beanDefinition = new RootBeanDefinition(MyBean.class);  
        registry.registerBeanDefinition("myBean", beanDefinition);  
    }  
}  
  
// 在主配置類(lèi)中使用@Import注解導(dǎo)入ImportBeanDefinitionRegistrar  
@Configuration  
@Import(MyImportBeanDefinitionRegistrar.class)  
public class AppConfig {  
    // 其他Bean定義...  
}

適用場(chǎng)景:

當(dāng)你需要在導(dǎo)入配置類(lèi)時(shí)動(dòng)態(tài)注冊(cè)Bean時(shí)，可以使用ImportBeanDefinitionRegistrar接口。

6. 使用FactoryBean接口

FactoryBean接口允許你定義一個(gè)工廠Bean，這個(gè)工廠Bean會(huì)返回一個(gè)對(duì)象實(shí)例。當(dāng)你需要控制Bean的創(chuàng)建過(guò)程時(shí)，可以使用這種方式。

// 定義一個(gè)FactoryBean，用于創(chuàng)建MyBean實(shí)例  
public class MyFactoryBean implements FactoryBean<MyBean> {  
    @Override  
    public MyBean getObject() throws Exception {  
        // 創(chuàng)建并返回MyBean實(shí)例  
        return new MyBean();  
    }  
  
    @Override  
    public Class<?> getObjectType() {  
        // 返回FactoryBean創(chuàng)建的Bean類(lèi)型  
        return MyBean.class;  
    }  
  
    @Override  
    public boolean isSingleton() {  
        // 返回FactoryBean創(chuàng)建的Bean是否為單例  
        return true;  
    }  
}  
  
// 在配置類(lèi)中使用@Bean注解注冊(cè)FactoryBean  
@Configuration  
public class AppConfig {  
    @Bean  
    public FactoryBean<MyBean> myFactoryBean() {  
        return new MyFactoryBean();  
    }  
}

適用場(chǎng)景:

當(dāng)你需要控制Bean的創(chuàng)建過(guò)程，或者返回一個(gè)復(fù)雜對(duì)象的實(shí)例時(shí)，可以使用FactoryBean接口。

7. 使用@ComponentScan注解

@ComponentScan注解用于指定Spring Boot啟動(dòng)時(shí)掃描的包路徑。Spring容器會(huì)掃描這些包路徑下的類(lèi)，并將標(biāo)記了@Component、@Service、@Repository、@Controller等注解的類(lèi)注冊(cè)為Bean。

// 定義一個(gè)Service類(lèi)，并使用@Service注解標(biāo)記  
@Service  
public class MyService {  
    // 服務(wù)邏輯...  
}  
  
// 在主配置類(lèi)中使用@ComponentScan注解指定掃描的包路徑  
@Configuration  
@ComponentScan(basePackages = "com.example.myapp")  
public class AppConfig {  
    // 其他Bean定義...  
}

適用場(chǎng)景:

當(dāng)你需要讓Spring Boot在啟動(dòng)時(shí)掃描特定的包路徑，并注冊(cè)其中的Bean時(shí)，可以使用@ComponentScan注解。

8. 自動(dòng)配置（Spring Boot Starter）

Spring Boot的自動(dòng)配置是通過(guò)spring.factories文件實(shí)現(xiàn)的。你可以創(chuàng)建一個(gè)自定義的starter，并在spring.factories文件中指定自動(dòng)配置類(lèi)。這樣，當(dāng)其他項(xiàng)目添加你的starter依賴(lài)時(shí)，Spring Boot會(huì)自動(dòng)配置相關(guān)的Bean。

創(chuàng)建自定義的starter時(shí)，需要在src/main/resources/META-INF目錄下創(chuàng)建一個(gè)spring.factories文件，并指定自動(dòng)配置類(lèi)。

spring.factories:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\  
com.example.demo.autoconfigure.DemoAutoConfiguration

自動(dòng)配置類(lèi):

@Configuration  
public class DemoAutoConfiguration {  
    @Bean  
    public MyBean myBean() {  
        return new MyBean();  
    }  
    // 其他配置...  
}

適用場(chǎng)景:

當(dāng)你需要為Spring Boot應(yīng)用提供一套默認(rèn)的、開(kāi)箱即用的配置時(shí)，可以創(chuàng)建一個(gè)自定義的starter，并使用自動(dòng)配置來(lái)注冊(cè)Bean。

9. 使用@Enable*注解

Spring Boot提供了許多@Enable*注解，如@EnableWebMvc、@EnableCaching等。這些注解通常會(huì)通過(guò)導(dǎo)入一個(gè)或多個(gè)配置類(lèi)來(lái)啟用特定的功能，并注冊(cè)相關(guān)的Bean。

// 在配置類(lèi)上使用@EnableWebMvc注解啟用Spring MVC  
@Configuration  
@EnableWebMvc  
public class WebMvcConfig implements WebMvcConfigurer {  
    // 配置Spring MVC...  
  
    @Override  
    public void addViewControllers(ViewControllerRegistry registry) {  
        // 注冊(cè)視圖控制器...  
    }  
}

適用場(chǎng)景:

當(dāng)你需要使用Spring Boot提供的特定功能，并且這些功能是通過(guò)@Enable*注解來(lái)啟用的時(shí)，可以使用這些注解來(lái)注冊(cè)相關(guān)的Bean。

自定義一個(gè)@Enable:

自定義一個(gè)@Enable類(lèi)似的功能要?jiǎng)?chuàng)建一個(gè)注解，并使用@Import注解來(lái)導(dǎo)入一個(gè)配置類(lèi)或選擇器。這樣，當(dāng)你在應(yīng)用程序中使用這個(gè)自定義的@Enable注解時(shí)，Spring會(huì)自動(dòng)導(dǎo)入并注冊(cè)相關(guān)的配置或組件

// 自定義注解  
@Target(ElementType.TYPE)  
@Retention(RetentionPolicy.RUNTIME)  
@Import(MyEnableConfiguration.class)  
public @interface EnableMyFeature {  
    // 可以添加屬性來(lái)配置功能  
}  
  
// 配置類(lèi)  
@Configuration  
public class MyEnableConfiguration {  
    @Bean  
    public MyFeatureBean myFeatureBean() {  
        return new MyFeatureBean();  
    }  
}  
  
// 使用自定義注解  
@SpringBootApplication  
@EnableMyFeature  
public class MyApplication {  
    public static void main(String[] args) {  
        SpringApplication.run(MyApplication.class, args);  
    }  
}