【Bean注册】⭐️SpringBoot 项目中常用 Bean 注册方式

目录

👋前言

📫一、 Bean 注册方式

🌱二、代码

        2.1 @Component 注解

        2.2  @Bean 注册

        2.3 @Import 注册

        2.4  @FactoryBean 注册

        2.5 @ComponentScan 注册

        2.6 ApplicationContext 注册

💞️三、章末

---

👋前言

        小伙伴们大家好，使用 SpringBoot 框架会极大程度简化开发，该框架亦是基于 Spring 框架，Spring 中有一个很重要的特性就是 IOC 容器，就是将项目中的 Bean 对象交由容器统一管理，在项目中注册Bean 交由容器管理的方式有很多，再来系统学习下常见方式；

        上次全面的了解了 Validation 框架的运行时校验实现，文章链接如下：

【Javax.Validation】✈️整合 SpringBoot 实现运行时的参数校验-CSDN博客

📫一、 Bean 注册方式

注册	使用场景
@Component(以及派生注解 @Service, @Repository, @Controller)	常用于组件类，控制层，业务层声明等
@Bean	手动定义Bean处理某种场景
@Import	将多个配置类统一管理
@FactoryBean	创建复杂的bean,可以指定Bean实例创建逻辑
@ComponentScan	用于自动扫描某个包下的用Component 声明的类
ApplicationContext	获取Spring 容器的上下文

🌱二、代码

        2.1 @Component 注解

        常用的使用方式就是在类上方使用该注解声明为一个配置类，单元测试下

import org.springframework.stereotype.Component;

/**
 * @author HuangBen 
 */
@Component
public class ComponentTest {
    //私有构造方法，避免手动创建对象
    private ComponentTest(){};
    
    //测试方法
    public void beantest(){
        System.out.println("@component bean define --- ");
    }
}

        注：SpringBoot 项目单元测试需要引入以下依赖：

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-test</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>

        2.2  @Bean 注册

        在声明了 @Configuration 配置类中的方法加上该注解即可，这里也可以在@Bean 注解中指定 bean 的名称，引入的时候可以搭配 @Qualifier 注解指定引入的 bean 名称

@Configuration
public class AppConfig {

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

        2.3 @Import 注册

        这种方式主要是用于多个配置类时，将多个配置类中的 bean 对象引入到当前类，通过当前类统一管理

@Configuration
public class OtherConfig {
    //其他配置类    

    @Bean
    public AnotherBean anotherBean() {
        return new AnotherBean();
    }
}

@Configuration
@Import(OtherConfig.class)
public class MainConfig {
    // 主要配置类，导入 OtherConfig 中定义的 Bean进行管理
}

        2.4  @FactoryBean 注册

        这种方式是实现 FactoryBean 接口创建自己的 bean 对象工厂，该工厂会返回一个 Bean 对象实例，使用的时候注入自定义工厂 bean ,在通过工厂对象的 get 方法获取实例对象

// 定义一个FactoryBean，用于创建MyBean实例  
public class MyFactoryBean implements FactoryBean<MyBean> {  
    @Override  
    public MyBean getObject() throws Exception {  
        // 创建并返回MyBean实例  
        return new MyBean();  
    }  
  
    ...
}  
  
// 在配置类中使用@Bean注解注册MyFactoryBean  
@Configuration  
public class AppConfig {  
    @Bean  
    public FactoryBean<MyBean> myFactoryBean() {  
        return new MyFactoryBean();  
    }  
}

        2.5 @ComponentScan 注册

        该注解主要是搭配 @Component 注解使用，在该注解方法参数标注需要扫描的包，会自动扫描该包下的被组件类注解声明的类

// 定义一个Service类，并使用@Service注解标记  
@Service  
public class MyService {  
    // 服务逻辑...  
}  
  
// 在主配置类中使用@ComponentScan注解指定扫描的包路径  
@Configuration  
@ComponentScan(basePackages = "com.example.myapp")  
public class AppConfig {  
    // 其他Bean定义...  
}

        2.6 ApplicationContext 注册

        通过实现 ApplicationContextAware 接口，重写 setApplicationContext 方法，spring 容器初始化时会调用该方法

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.stereotype.Component;

/**
 * @author HuangBen 
 */
@Component
public class MyBeanRegistrar implements ApplicationContextAware {
    private ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
        registerBean();
    }

    private void registerBean() {
        RootBeanDefinition beanDefinition = new RootBeanDefinition(ComponentTest.class);
        ((ConfigurableApplicationContext) applicationContext).getBeanFactory().registerSingleton("myBean", beanDefinition);
    }
}

💞️三、章末

        文章到这里就结束了~