@Bean 注解是非常常见的一个注解,我们将一个非 @Component 的类交给 Spring 容器管理,就需要用到 @Bean 注解。但是 @Bean 注解并不只是表面上看起来这么简单。
本文章将从 @Bean 的初步使用描述,源码待续。。
目录
@Bean(autowireCandidate = false) 的使用
@Bean 将类交给容器管理
首先创建一个UserService, 不标记 @Component 注解。按照正常情况,Spring容器是不会创建 UserService 这样一个 Bean 的。
@Slf4j
public class UserService {
public void show() {
log.info("show()");
}
}
我们在 ***Application 启动类中添加如下代码,手动通过 @Bean 将 UserService 交给 Spring 容器管理。
@SpringBootApplication
public class StudyApplication {
public static void main(String[] args) {
SpringApplication.run(StudyApplication.class, args);
}
// add------------
@Bean
public UserService getUserService() {
return new UserService();
}
}
然后创建一个类,实现 CommandLineRunner 接口,@Autowire 自动注入 UserService, 并且重写方法 run() 里面调用 UserService 的 show() 方法:
@Component
@Slf4j
public class StudyBeanFirst implements CommandLineRunner {
@Autowired
private UserService userService;
@Override
public void run(String... args) throws Exception {
userService.show();
}
}
可以看到控制台成功输出了
结论:使用 @Bean 注解能将一个类交给容器管理
@Bean注解内的信息
当然,@Bean 不会这么简单,我们看一看注解内有什么东西,直接上源码:
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Bean {
@AliasFor("name")
String[] value() default {};
@AliasFor("value")
String[] name() default {};
/** @deprecated */
@Deprecated
Autowire autowire() default Autowire.NO;
boolean autowireCandidate() default true;
String initMethod() default "";
String destroyMethod() default "(inferred)";
}
- value() 、 name() 是给要交个容器管理的类取一个名字,@Autowired - byName 的时候,可以通过这些名字进行getBean。
- autowire() 是指指定注入的类型,默认为NO,可选择ByName、ByType,但是这个注解已经被建议不再使用了。
- autowireCandidate() 是指,其他地方是否能通过 @Autowire 注入当前 Bean。如果为 false,只能调用 @Bean 标注的方法进行获取 Bean。
- initMethod() 、 destroyMethod() 是指声明周期的方法,在 Bean 初始化、被销毁的时候执行的方法。
@Bean(autowireCandidate = false) 的使用
UserService 保持原本的方式不变,我们再写入一个 SystemService:
@Slf4j
public class SystemService {
private UserService userService;
public SystemService(UserService userService) {
this.userService = userService;
}
public void getSystemMethod() {
userService.show();
}
}
由于 UserService 上面的 Bean为@Bean(autowireCandidate = false),所以不能直接注入,需要其他的处理。
我们也将 SystemService 再 XXXApplication 中以 @Bean 的方式进行操作:
@SpringBootApplication
public class StudyApplication {
public static void main(String[] args) {
SpringApplication.run(StudyApplication.class, args);
}
@Bean
public UserService getUserService() {
return new UserService();
}
@Bean
public SystemService getSystemService() {
return new SystemService(getUserService());
}
}
这样,SystemService 就能获取到 UserSerive 进行操作了。
启动业务类:
@Component
@Slf4j
public class StudyBeanFirst implements CommandLineRunner {
@Autowired
private SystemService systemService;
@Override
public void run(String... args) throws Exception {
systemService.getSystemMethod();
log.info("1");
}
}
输出:
源码待续。。