在Spring框架中,@Bean
注解是用于显式声明一个Bean的核心方式之一,尤其在基于Java的配置中。Spring框架中的@Bean
注解实现原理涉及多个核心机制,包括配置类解析、Bean定义注册、动态代理及依赖注入等
@Bean
注解的作用@Bean
用于标注在方法上,表示该方法返回的对象应由Spring容器管理,成为一个Bean。它通常与@Configuration
类配合使用,替代传统的XML配置方式,提供更灵活的Bean定义。
关键特性:
显式声明Bean:将任意对象(包括第三方库的类)纳入Spring容器。
控制Bean的创建逻辑:可在方法中编写自定义初始化代码。
支持依赖注入:方法参数自动注入其他Bean。
生命周期管理:指定初始化和销毁方法。
@Bean
的基本用法@Configuration
public class AppConfig {
@Bean
public DataSource dataSource() {
// 自定义数据源配置
return new HikariDataSource();
}
@Bean
public UserService userService(UserRepository userRepository) {
// 依赖注入UserRepository
return new UserServiceImpl(userRepository);
}
}
@Configuration
:标记类为配置类,Spring会代理其方法以确保Bean的单例性。
方法名默认作为Bean名称(可通过name
属性修改)。
@Bean
注解的属性属性 | 说明 |
---|---|
name / value |
定义Bean的名称(默认使用方法名)。例如:@Bean("myBean") 。 |
initMethod |
指定Bean初始化后调用的方法。 |
destroyMethod |
指定Bean销毁前调用的方法(默认自动检测close 或shutdown 方法)。 |
autowire |
已弃用,Spring 5+推荐使用构造器或Setter注入。 |
@Bean
注解的原理1. 配置类的解析与Bean定义生成
步骤说明:
触发时机:Spring容器启动时,ConfigurationClassPostProcessor
(后处理器)扫描所有@Configuration
类。
解析过程:
@Configuration
或@Component
(隐式配置)标记的类。@Bean
方法:遍历类中所有@Bean
注解的方法,生成对应的BeanDefinition
。BeanDefinition
注册到BeanFactory
的BeanDefinitionRegistry
中。源码关键点:
ConfigurationClassParser
解析配置类,提取@Bean
方法。
ConfigurationClassBeanDefinitionReader
将方法转换为BeanDefinition
,并注册到容器。
2. 动态代理确保单例行为(仅限@Configuration类)
步骤说明:
CGLIB代理:@Configuration
类会被CGLIB增强,生成代理子类。
单例保护:代理类拦截@Bean
方法的调用,确保多次调用返回同一实例(单例模式)。
@Configuration
public class AppConfig {
@Bean
public DataSource dataSource() {
// 实际仅执行一次,后续调用返回代理结果
return new HikariDataSource();
}
}
源码关键点:
ConfigurationClassEnhancer
通过CGLIB生成代理类。
代理逻辑在BeanMethodInterceptor
中实现,拦截方法调用并缓存结果。
3. Bean实例化与依赖注入
步骤说明:
实例化时机:当容器首次请求Bean时(或预初始化时),调用@Bean
方法创建实例。
依赖注入:
方法参数注入:通过AutowiredAnnotationBeanPostProcessor
解析方法参数,从容器中获取依赖Bean。
属性注入:若方法体内需要其他Bean,可通过@Autowired
或直接调用applicationContext.getBean()
(不推荐)。
示例代码:
@Bean
public ServiceA serviceA(Repository repo) { // 参数repo自动注入
return new ServiceA(repo);
}
源码关键点:
SimpleInstantiationStrategy
负责调用@Bean
方法。
DependencyDescriptor
解析方法参数依赖。
4. 生命周期管理
步骤说明:
初始化方法:通过@Bean(initMethod = "init")
指定,在Bean实例化后调用。
销毁方法:通过@Bean(destroyMethod = "cleanup")
指定,在容器关闭时调用。
与接口的结合:若Bean实现InitializingBean
或DisposableBean
,Spring会自动调用其生命周期方法。
源码关键点:
InitDestroyAnnotationBeanPostProcessor
处理自定义初始化和销毁方法。
DisposableBeanAdapter
在容器关闭时触发销毁逻辑。
5. 条件化注册与作用域控制
步骤说明:
条件化注册:通过@Conditional
系列注解(如@ConditionalOnClass
)控制Bean是否注册。
@Bean
@ConditionalOnProperty(name = "db.enabled", havingValue = "true")
public DataSource dataSource() {
return new HikariDataSource();
}
作用域控制:通过@Scope
指定Bean的作用域(如prototype
、request
)。
@Bean
@Scope("prototype")
public PrototypeBean prototypeBean() {
return new PrototypeBean();
}
源码关键点:
ConditionEvaluator
在注册前检查条件是否满足。
Scope
接口实现类(如SingletonScope
、PrototypeScope
)管理Bean实例的生命周期。
6. 与非@Configuration类的区别
行为差异:
普通类中的@Bean方法(如@Component
类):
无CGLIB代理,多次调用方法会创建新实例。
依赖需通过@Autowired
注入字段,而非方法参数。
@Configuration类中的@Bean方法:
示例对比:
@Component
public class ComponentConfig {
@Bean
public DataSource dataSource() {
// 每次调用生成新实例(非单例)
return new HikariDataSource();
}
}
总结:@Bean注解的核心实现流程
ConfigurationClassPostProcessor
处理@Configuration
类,提取@Bean
方法。BeanDefinition
并注册到容器。@Configuration
类生成CGLIB代理,确保单例行为。@Bean
方法创建实例,自动注入参数依赖。通过这一机制,@Bean
注解实现了灵活、可控的Bean定义方式,尤其适用于整合第三方库或需要复杂初始化的场景。
@Scope
@Bean
@Scope("prototype") // 每次请求新实例
public MyPrototypeBean myPrototypeBean() {
return new MyPrototypeBean();
}
@Conditional
@Bean
@ConditionalOnProperty(name = "feature.enabled", havingValue = "true")
public FeatureService featureService() {
return new FeatureServiceImpl();
}
@Primary
@Bean
@Primary
public DataSource primaryDataSource() {
// 当存在多个DataSource时,优先使用此Bean
return new HikariDataSource();
}
@Bean
与@Component
的区别特性 | @Bean |
@Component |
---|---|---|
应用位置 | 方法上 | 类上 |
适用场景 | 第三方库的类、需自定义初始化的对象 | 自定义类(直接由Spring实例化) |
控制粒度 | 更灵活(可在方法中编写逻辑) | 较简单(自动扫描+默认构造器) |
依赖注入方式 | 通过方法参数显式声明 | 通过@Autowired 隐式注入 |
@Bean
的依赖注入在@Bean
方法中,参数会自动注入容器中已存在的Bean:
@Bean
public ServiceA serviceA(Repository repo, @Value("${config.value}") String value) {
return new ServiceA(repo, value);
}
Repository
类型的Bean和配置属性注入。public class MyBean {
public void init() {
System.out.println("Bean初始化完成");
}
public void cleanup() {
System.out.println("Bean即将销毁");
}
}
@Configuration
public class AppConfig {
@Bean(initMethod = "init", destroyMethod = "cleanup")
public MyBean myBean() {
return new MyBean();
}
}
@Configuration
类:通过CGLIB代理,确保多次调用@Bean
方法返回同一实例。
@Component
类中的@Bean
:无代理,每次调用方法会创建新实例(需避免直接调用方法)。
@Bean
public RestTemplate restTemplate() {
RestTemplate restTemplate = new RestTemplate();
restTemplate.setConnectTimeout(5000);
return restTemplate;
}
@Bean
方法的依赖顺序正确,或使用Setter注入打破循环。@Bean
的核心价值:灵活控制Bean的创建过程,整合非Spring管理的类。
适用场景:配置数据源、工具类(如RestTemplate)、需要复杂初始化的对象。
关键点:方法参数注入、作用域控制、生命周期管理。
通过合理使用@Bean
,开发者可以更精细地管理Spring容器中的组件,尤其适用于需要高度定制化的项目场景。