丽江电子商务网站建设,建设公司简介怎么写,济南网站建设策划方案,中国最顶尖的室内设计公司引言
在这篇文章中#xff0c;我们将介绍在Spring框架#xff08;包括SpringBoot、SpringCloud#xff09;中获取Bean的方法#xff0c;在Spring容器中#xff0c;Bean的存在方式是多种多样的#xff0c;针对不同种类的Bean我们有哪些方法可以获取到它们#xff0c;如何…引言
在这篇文章中我们将介绍在Spring框架包括SpringBoot、SpringCloud中获取Bean的方法在Spring容器中Bean的存在方式是多种多样的针对不同种类的Bean我们有哪些方法可以获取到它们如何安全的获取这些Bean而不会产生错误获取到它们之后我们有能够怎样处理呢今天我们来聊一聊关于在Spring容器中获取Bean的话题。
摘要
本文主要介绍Spring框架中Bean的获取相关知识主要涉及 BeanFactory 和 ListableBeanFactory两个接口中的方法这两个接口也是Spring容器中的核心接口其中定义了获取单个Bean和获取Bean集合的一些强大功能。 文章目录 引言摘要正文常用的Bean获取方式自动注入主动获取 安全的获取Bean安全的获取单个Bean安全的获取Bean列表 获取Bean集合通过类型获取Bean集合通过注解获取Bean集合获取Bean上的注解 总结 正文
在之前的文章中我们介绍了Spring/SpringBoot中的Bean而在使用Spring/SpringBoot框架开发应用程序的过程中主要通过对Bean的操作来实现各种各样的功能那么在Spring/SpringBoot中如何来获取一个或多个Bean也是有讲究的针对不同的Bean对象我们可以采取不同的获取方式今天我们就来介绍一些常用的获取Bean的方式。
为了方便测试在我们先定义几个bean以备使用
public class BeanDemo {private String name;private Long id;//省略getter,setter,toString方法
}public class PersonEntity {private String name;private int age;private Gender gender;//省略getter,setter,toString方法
}public enum Gender {MALE,FEMALE;
}注册bean
public class ConfigDemo{ Beanpublic PersonEntity zhangFei(){return PersonEntity.bornMale(zhang fei);}Beanpublic PersonEntity guanyu(){return PersonEntity.bornMale(guan yu);}Beanpublic PersonEntity liubei(){return PersonEntity.bornMale(liu bei);}Beanpublic PersonEntity sunshangxiang(){return PersonEntity.bornFemale(sun shangxiang);}Beanpublic BeanDemo tongquetai(){BeanDemo res new BeanDemo();res.setId(1L);res.setName(tong que tai);return res;}
}常用的Bean获取方式
自动注入
spring中最常见的Bean查找获取方式就是通过 Autowired注解或 Resource注解注入一个Bean这两者的区别在于 Autowired是Spring提供的注解而 Resource是JavaEE标准中提供的注解两者的使用方式类似详细对比如下
表Autowired和Resource注解对比 对比AutowiredResource提供方Spring2.5JavaEE标准库是否可指定Bean名称否结合Qualifier注解可实现相同功能是是否可指定Bean类型否是官方建议不建议使用建议使用
以下代码说明了 Autowired注解的基本功能
public class BeanLookupComponent implements ApplicationRunner {Autowiredprivate BeanDemo beanDemo;Overridepublic void run(ApplicationArguments args) throws Exception {System.out.println(beanDemo);}
}注意这里 Autowired只支持容器中只存在一个 BeanDemo类型的Bean的情况。如果存在多种同类型的Bean需要结合 Qualifier注解注意本文后续所有测试代码都在 BeanLookupComponent这个类中完成因此部分代码就省略了
Qualifier(liubei)
Autowired
private PersonEntity beanDemo;相对的 Resource注解的用法就要灵活的多
可以按类型注入不指定Bean名称
private BeanDemo resourceBean;当存在多个同类型的Bean时可以通过指定名称明确使用哪一个Bean也可以指定类型
Resource(name guanyu,type PersonEntity.class)
private PersonEntity resourceBean;主动获取
除此之外还可以通过 BeanFactory 接口的 getBean方法获取一个Bean而 BeanFactory接口可以通过实现 BeanFactoryAware接口获取到。
public class BeanLookupComponent implements BeanFactoryAware {private BeanFactory beanFactory;Overridepublic void setBeanFactory(BeanFactory beanFactory) throws BeansException {this.beanFactorybeanFactory;}
}getBean方法是一系列的重载方法可以实现按Bean的名称、类型获取到对应的bean简单示例如下
Override
public void run(ApplicationArguments args) throws Exception {//按名称获取Object liubei beanFactory.getBean(liubei);//处理beanSystem.out.println(liubei);//按类型获取BeanDemo demo beanFactory.getBean(BeanDemo.class);System.out.println(demo);//指定名称和类型可自动转换类型PersonEntity guanyu beanFactory.getBean(guanyu, PersonEntity.class);System.out.println(guanyu);
}以上这三种都是常用的获取Bean的API但这几个API存在同样的问题就是不能保证一定能获取到对应的Bean为什么这么说呢考虑以下几种情况
当没有配置名称为 liubei的bean通过 getBean(liubei)方法能得到什么按类型获取时如果这个类型同时存在多个Bean会得到什么结果
实际上上边这两种做法都会报错
第一种情况程序直接终止提示 A component required a bean named *** that could not be found.第二种情况抛出异常 NoUniqueBeanDefinitionException
安全的获取Bean
安全的获取单个Bean
除了上述几个获取Bean的APISpring提供了 ObjectProviderT这一API能够相对安全的获取Bean这里的安全意思是当要获取的Bean不存在或存在多个时不会直接抛出异常。
对于只想获取一个Bean的情况可以采用如下方式
ObjectProviderBeanDemo beanProvider beanFactory.getBeanProvider(BeanDemo.class);
BeanDemo uniqueBean beanProvider.getIfUnique();
System.out.println(uniqueBean);得到如下打印结果
DemoEntity{nametong que tai, id1}当要获取的类型存在多个Bean时下例中PersonEntity类型的Bean有多个
ObjectProviderPersonEntity personProvider beanFactory.getBeanProvider(PersonEntity.class);
PersonEntity uniquePerson personProvider.getIfUnique();
System.out.println(uniquePerson);这是会返回一个空值打印结果如下
null当然ObjectProvider也支持函数式编程的写法上例的lambda等价写法如下
ObjectProviderBeanDemo beanProvider beanFactory.getBeanProvider(BeanDemo.class);
beanProvider.ifUnique(demo- System.out.println(demo));安全的获取Bean列表
如果想获取到这一类型的全部Bean对象 ObjectProvider也是支持的通过lambda表达式即可实现
ObjectProviderPersonEntity personProvider beanFactory.getBeanProvider(PersonEntity.class);
personProvider.forEach(o- System.out.println(o));或者通过streamAPI进行其他操作如
personProvider.stream().filter(o-o.getGender() Gender.FEMALE).forEach(o- System.out.println(o));获取Bean集合
Spring提供了一些列根据类的名称获取对应类型的Bean名称的工具方法这些方法都在 ListableBeanFactory接口中定义同时在 DefaultListableBeanFactory类中提供了默认的实现而一般情况下我们通过实现 BeanFactoryAware接口而获得的 BeanFactory实际上就是 DefaultListableBeanFactory因此这些方法可以直接使用。
通过类型获取Bean集合
根据类型获取所有Bean的名称可以这样做
if(beanFactory instanceof DefaultListableBeanFactory){DefaultListableBeanFactory listableBeanFactory (DefaultListableBeanFactory) beanFactory;String[] beanNames listableBeanFactory.getBeanNamesForType(PersonEntity.class);System.out.println(Arrays.toString(beanNames));
}以上示例代码的打印结果为
[zhangFei, guanyu, liubei, sunshangxiang]getBeanNamesForType()方法还提供一个需要 ResolvableType类型的重载方法用法类似
String[] beanNames2 listableBeanFactory.getBeanNamesForType(ResolvableType.forType(PersonEntity.class));
System.out.println(Arrays.toString(beanNames2));如果想直接获取到所有的Bean可以通过下面这个方法
MapString, PersonEntity beansOfType listableBeanFactory.getBeansOfType(PersonEntity.class);
beansOfType.entrySet().forEach(entry- System.out.println(entry.getKey() entry.getValue().getName()));这个方法获取到所有的 PersonEntity类型的Bean并打印它们的姓名
zhangFei zhang fei
guanyu guan yu
liubei liu bei
sunshangxiang sun shangxiang同时getBeansOfType还存在一个重载方法允许传入两个boolean的值getBeansOfType(ClassT type, boolean includeNonSingletons, boolean allowEagerInit)后两个boolean值的说明
includeNonSingletons是否包括非单例的BeanallowEagerInit是否提前初始化延迟加载的Bean。但是由于这里是获取Bean的操作即便不允许提前初始化在这里也会被初始化
通过注解获取Bean集合
除此之外ListableBeanFactory还提供根据注解获取对应的Bean名称或Bean对象的方法下列方法用户获取所有通过 Component注解注册的Bean
//根据注解获取Bean的名称
String[] beanAnnoNames listableBeanFactory.getBeanNamesForAnnotation(Component.class);
System.out.println(Arrays.toString(beanAnnoNames));//根据注解获取Bean对象MapBean名称, Bean对象
MapString, Object configBeans listableBeanFactory.getBeansWithAnnotation(Component.class);
configBeans.entrySet().forEach((entry)-{System.out.println(entry.getKey() entry.getValue().getClass());
});以上代码的打印输出内容根据各自的配置不同输出的内容也不同。注意如果是Spring Boot项目输出的内容可能会比较多因为SpringBoot为了方便开发内置注册了很多Bean。
我的输出内容是
[springNotesApplication, beanLookupComponent, appProperties, classPathProp, sourceProperties, org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration, propertySourcesPlaceholderConfigurer, org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration, org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration, org.springframework.boot.autoconfigure.aop.AopAutoConfiguration$ClassProxyingConfiguration, org.springframework.boot.autoconfigure.aop.AopAutoConfiguration, org.springframework.boot.autoconfigure.availability.ApplicationAvailabilityAutoConfiguration, org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration, org.springframework.boot.autoconfigure.context.LifecycleAutoConfiguration, org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration, org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration, org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfiguration]
springNotesApplication class top.sunyog.spring.notes.SpringNotesApplication$$EnhancerBySpringCGLIB$$53408404
beanLookupComponent class top.sunyog.spring.notes.auto.BeanLookupComponent
appProperties class top.sunyog.spring.notes.prop.AppProperties
classPathProp class top.sunyog.spring.notes.prop.ClassPathProp$$EnhancerBySpringCGLIB$$67bc2c5d
sourceProperties class top.sunyog.spring.notes.prop.SourceProperties
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration class org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration
propertySourcesPlaceholderConfigurer class org.springframework.context.support.PropertySourcesPlaceholderConfigurer
org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration class org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration class org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration$ClassProxyingConfiguration class org.springframework.boot.autoconfigure.aop.AopAutoConfiguration$ClassProxyingConfiguration
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration class org.springframework.boot.autoconfigure.aop.AopAutoConfiguration
org.springframework.boot.autoconfigure.availability.ApplicationAvailabilityAutoConfiguration class org.springframework.boot.autoconfigure.availability.ApplicationAvailabilityAutoConfiguration
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration class org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration
org.springframework.boot.autoconfigure.context.LifecycleAutoConfiguration class org.springframework.boot.autoconfigure.context.LifecycleAutoConfiguration
org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration class org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration
org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration class org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration
org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfiguration class org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfiguration获取Bean上的注解
ListableBeanFactory还提供了一个可以获取到Bean上标注的注解的方法 findAnnotationOnBean(String beanName, Class annoType)这个方法需要传入一个Bean名称beanName和一个注解的类型annoType获取到这个Bean上标注的annoType注解这个方法对于需要在运行时获取到Bean的描述业务逻辑非常重要。使用方法如下
Qualifier zhangFeiQualifier listableBeanFactory.findAnnotationOnBean(zhangFei, Qualifier.class);
System.out.println(zhangFeiQualifier.value());这里需要把名称为 zhangFei的Bean配置做一下修改
Bean
Qualifier(value zhang)
public PersonEntity zhangFei(){return PersonEntity.bornMale(zhang fei);
}此时输出结果为
zhang总结
今天主要介绍了在Spring中如何获取BeanSpring框架的最主要的作用就是管理BeanSpring容器中存在着大量的、各种类型的Bean对象因此了解Spring中有哪些方式可以获取到这些Bean对象就显得十分重要。本文主要介绍了 BeanFactory和 ListableBeanFactory两个容器中的获取Bean的方法这两个接口也是Spring中的核心接口很多类都是基于这两个接口而扩展出来的包括 AbstractApplicationContext、DefaultListableBeanFactory等 联系方式 邮箱 qijilaolifoxmail.com 掘金 奇迹老李 微信公众号奇迹老李 ❗版权声明 本文为原创文章版权归作者所有。未经许可禁止转载。更多内容请访问奇迹老李的博客首页
