BeanDefinition

Bean的定义,在Spring中,我们可以如何去定义一个Bean?

  1. @Bean
  2. @Component(@Service,@Controller)

还有就是可以通过BeanDefinition

比如,我们可以通过定义一个BeanDefinition对象来表示定义了一个Bean:

  1. // 定义了一个BeanDefinition
  2. AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();
  3. // 当前Bean对象的类型
  4. beanDefinition.setBeanClass(User.class);
  5. // 将BeanDefinition注册到BeanFactory中
  6. DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
  7. beanFactory.registerBeanDefinition("user", beanDefinition);
  8. // 获取Bean
  9. System.out.println(beanFactory.getBean("user"));

我们还可以通过BeanDefinition设置一个Bean的其他属性

  1. beanDefinition.setScope("prototype"); // 设置作用域
  2. beanDefinition.setInitMethodName("init"); // 设置初始化方法
  3. beanDefinition.setAutowireMode(AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE); // 设置自动装配模型

等等

总之,我们通过,@Bean,@Component等方式所定义的Bean,最终都会被解析为BeanDefinition对象。

BeanDefinition可以理解为底层源码级别的一个概念,也可以理解为Spring提供的一种API使用的方式。

BeanDefinitionReader

BeanDefinitionReader分为几类:

AnnotatedBeanDefinitionReader

可以直接把某个类转换为BeanDefinition,并且会解析该类上的注解

注意:它能解析的注解是:@Conditional,@Scope、@Lazy、@Primary、@DependsOn、@Role、@Description

  1. DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
  2. AnnotatedBeanDefinitionReader annotatedBeanDefinitionReader = new AnnotatedBeanDefinitionReader(beanFactory);
  3. // 将User.class解析为BeanDefinition
  4. annotatedBeanDefinitionReader.register(User.class);
  5. System.out.println(beanFactory.getBean("user"));

XmlBeanDefinitionReader

可以解析标签

  1. XmlBeanDefinitionReader xmlBeanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
  2. int i = xmlBeanDefinitionReader.loadBeanDefinitions("spring.xml");
  3. System.out.println(beanFactory.getBean("user"));

ClassPathBeanDefinitionScanner

这个并不是BeanDefinitionReader,但是它的作用和BeanDefinitionReader类似,它可以进行扫描,扫描某个包路径,对扫描到的类进行解析,比如,扫描到的类上如果存在@Component注解,那么就会把这个类解析为一个BeanDefinition

BeanFactory

Spring中比较核心的是BeanFactory的实现类是DefaultListableBeanFactory

image.png
它实现了很多接口,表示,它拥有很多功能:

  1. AliasRegistry:支持别名功能,一个名字可以对应多个别名
  2. BeanDefinitionRegistry:可以注册、保存、移除、获取某个BeanDefinition
  3. BeanFactory:Bean工厂,可以根据某个bean的名字、或类型、或别名获取某个Bean对象
  4. SingletonBeanRegistry:可以直接注册、获取某个单例Bean
  5. SimpleAliasRegistry:它是一个类,实现了AliasRegistry接口中所定义的功能,支持别名功能
  6. ListableBeanFactory:在BeanFactory的基础上,增加了其他功能,可以获取所有BeanDefinition的beanNames,可以根据某个类型获取对应的beanNames,可以根据某个类型获取{类型:对应的Bean}的映射关系
  7. HierarchicalBeanFactory:在BeanFactory的基础上,添加了获取父BeanFactory的功能
  8. DefaultSingletonBeanRegistry:它是一个类,实现了SingletonBeanRegistry接口,拥有了直接注册、获取某个单例Bean的功能
  9. ConfigurableBeanFactory:在HierarchicalBeanFactory和SingletonBeanRegistry的基础上,添加了设置父BeanFactory、类加载器(表示可以指定某个类加载器进行类的加载)、设置Spring EL表达式解析器(表示该BeanFactory可以解析EL表达式)、设置类型转化服务(表示该BeanFactory可以进行类型转化)、可以添加BeanPostProcessor(表示该BeanFactory支持Bean的后置处理器),可以合并BeanDefinition,可以销毁某个Bean等等功能
  10. FactoryBeanRegistrySupport:支持了FactoryBean的功能
  11. AutowireCapableBeanFactory:是直接继承了BeanFactory,在BeanFactory的基础上,支持在创建Bean的过程中能对Bean进行自动装配
  12. AbstractBeanFactory:实现了ConfigurableBeanFactory接口,继承了FactoryBeanRegistrySupport,这个BeanFactory的功能已经很全面了,但是不能自动装配和获取beanNames
  13. ConfigurableListableBeanFactory:继承了ListableBeanFactory、AutowireCapableBeanFactory、ConfigurableBeanFactory
  14. AbstractAutowireCapableBeanFactory:继承了AbstractBeanFactory,实现了AutowireCapableBeanFactory,拥有了自动装配的功能
  15. DefaultListableBeanFactory:继承了AbstractAutowireCapableBeanFactory,实现了ConfigurableListableBeanFactory接口和BeanDefinitionRegistry接口,所以DefaultListableBeanFactory的功能很强大

通过以上分析,我们可以知道,通过DefaultListableBeanFactory我们可以做很多事情,比如:

  1. AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();
  2. beanDefinition.setBeanClass(User.class);
  3. DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
  4. // 注册BeanDefinition
  5. beanFactory.registerBeanDefinition("user", beanDefinition);
  6. // 注册别名
  7. beanFactory.registerAlias("user", "user1");
  8. // 注册BeanPostProcessor
  9. beanFactory.addBeanPostProcessor(new LubanBeanPostProcessor());
  10. // 获取Bean对象
  11. System.out.println(beanFactory.getBean("user1"));
  12. // 根据类型获取beanNames
  13. System.out.println(beanFactory.getBeanNamesForType(User.class));

ApplicationContext

首先ApplicationContext是个接口,可以把它理解为一个特殊的BeanFactory
image.png

  1. HierarchicalBeanFactory:拥有获取父BeanFactory的功能
  2. ListableBeanFactory:拥有获取beanNames的功能
  3. ResourcePatternResolver:资源加载器,可以一次性获取多个资源(文件资源等等)
  4. EnvironmentCapable:可以获取运行时环境(没有设置运行时环境功能)
  5. ApplicationEventPublisher:拥有广播事件的功能(没有添加事件监听器的功能)
  6. MessageSource:拥有国际化功能

又两个比较重要的实现类:

  1. AnnotationConfigApplicationContext
  2. ClassPathXmlApplicationContext

AnnotationConfigApplicationContext

image.png

  1. ConfigurableApplicationContext:继承了ApplicationContext接口,增加了,添加事件监听器、添加BeanFactoryPostProcessor、设置Environment,获取ConfigurableListableBeanFactory等功能
  2. AbstractApplicationContext:实现了ConfigurableApplicationContext接口
  3. GenericApplicationContext:继承了AbstractApplicationContext,实现了BeanDefinitionRegistry接口,拥有了所有ApplicationContext的功能,并且可以注册BeanDefinition,注意这个类中有一个属性(DefaultListableBeanFactory beanFactory)
  4. AnnotationConfigRegistry:可以单独注册某个为类为BeanDefinition(可以处理该类上的@Configuration注解,已经可以处理@Bean注解),同时可以扫描
  5. AnnotationConfigApplicationContext:继承了GenericApplicationContext,实现了AnnotationConfigRegistry接口,拥有了以上所有的功能

ClassPathXmlApplicationContext

image.png
它也是继承了AbstractApplicationContext,但是相对于AnnotationConfigApplicationContext而言,功能没有AnnotationConfigApplicationContext强大,比如不能注册BeanDefinition

国际化

先定义一个MessageSource:

  1. @Bean
  2. public MessageSource messageSource() {
  3. ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
  4. messageSource.setBasename("messages");
  5. return messageSource;
  6. }

有了这个Bean,你可以在你任意想要进行国际化的地方使用该MessageSource。
同时,因为ApplicationContext也拥有国家化的功能,所以可以直接这么用:

  1. annotationConfigApplicationContext.getMessage("test", null, new Locale("en_CN"))

资源加载

ApplicationContext还拥有资源加载的功能,比如,可以直接利用ApplicationContext获取某个文件的内容:

  1. Resource resource = annotationConfigApplicationContext.getResource("file://D:\\IdeaProjects\\spring-framework\\luban\\src\\main\\java\\com\\luban\\entity\\User.java");
  2. System.out.println(resource.contentLength());

你可以想想,如果你不使用ApplicationContext,而是自己来实现这个功能,就比较费时间了。

还比如你可以:

  1. Resource resource = annotationConfigApplicationContext.getResource("classpath:com/luban/entity/User.class");
  2. System.out.println(resource.contentLength());

还可以一次性获取多个:

  1. Resource[] resources = annotationConfigApplicationContext.getResources("classpath:com/luban/service/*.class");
  2. for (Resource resource : resources) {
  3. System.out.println(resource.contentLength());
  4. }

这个功能用到了策略模式

获取运行时环境

  1. // 获取JVM所允许的操作系统的环境
  2. annotationConfigApplicationContext.getEnvironment().getSystemEnvironment();
  3. // 获取JVM本身的一些属性,包括-D所设置的
  4. annotationConfigApplicationContext.getEnvironment().getSystemProperties();
  5. // 还可以直接获取某个环境或properties文件中的属性
  6. annotationConfigApplicationContext.getEnvironment().getProperty("lubanyyy")

注意,可以利用

  1. @PropertySource("classpath:application.properties")

来使得某个properties文件中的参数添加到运行时环境中

事件发布

先定义一个事件监听器

  1. @Bean
  2. public ApplicationListener applicationListener() {
  3. return new ApplicationListener() {
  4. @Override
  5. public void onApplicationEvent(ApplicationEvent event) {
  6. System.out.println("接收到了一个事件");
  7. }
  8. };
  9. }

然后发布一个事件:

  1. annotationConfigApplicationContext.publishEvent("kkk");

类型转化

PropertyEditor

JDK中提供的类型转化工具类

  1. public class StringToUserPropertyEditor extends PropertyEditorSupport implements PropertyEditor {
  2. @Override
  3. public void setAsText(String text) throws IllegalArgumentException {
  4. User user = new User();
  5. user.setName(text);
  6. this.setValue(user);
  7. }
  8. }
  1. StringToUserPropertyEditor propertyEditor = new StringToUserPropertyEditor();
  2. propertyEditor.setAsText("1");
  3. User value = (User) propertyEditor.getValue();
  4. System.out.println(value);

如何向Spring中注册PropertyEditor:

  1. @Bean
  2. public CustomEditorConfigurer customEditorConfigurer() {
  3. CustomEditorConfigurer customEditorConfigurer = new CustomEditorConfigurer();
  4. Map<Class<?>, Class<? extends PropertyEditor>> propertyEditorMap = new HashMap<>();
  5. propertyEditorMap.put(User.class, StringToUserPropertyEditor.class);
  6. customEditorConfigurer.setCustomEditors(propertyEditorMap);
  7. return customEditorConfigurer;
  8. }

假设现在有如下Bean:

  1. @Component
  2. public class UserService {
  3. @Value("true")
  4. User test;
  5. public void test() {
  6. System.out.println(test);
  7. }
  8. }

那么test属性就能正常的完成属性赋值

ConversionService

Spring中提供的类型转化服务,它比PropertyEditor更强大

  1. public class StringToUserConverter implements ConditionalGenericConverter {
  2. @Override
  3. public boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) {
  4. return sourceType.getType().equals(String.class) && targetType.getType().equals(User.class);
  5. }
  6. @Override
  7. public Set<ConvertiblePair> getConvertibleTypes() {
  8. return Collections.singleton(new ConvertiblePair(String.class, User.class));
  9. }
  10. @Override
  11. public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) {
  12. User user = new User();
  13. user.setName((String)source);
  14. return user;
  15. }
  16. }
  1. DefaultConversionService conversionService = new DefaultConversionService();
  2. conversionService.addConverter(new StringToUserConverter());
  3. User value = conversionService.convert("1", User.class);
  4. System.out.println(value);

如何向Spring中注册ConversionService:

  1. @Bean
  2. public ConversionServiceFactoryBean conversionService() {
  3. ConversionServiceFactoryBean conversionServiceFactoryBean = new ConversionServiceFactoryBean();
  4. conversionServiceFactoryBean.setConverters(Collections.singleton(new StringToUserConverter()));
  5. return conversionServiceFactoryBean;
  6. }

TypeConverter

整合了PropertyEditor和ConversionService的功能,是Spring内部用的

  1. SimpleTypeConverter typeConverter = new SimpleTypeConverter();
  2. typeConverter.registerCustomEditor(User.class, new StringToUserPropertyEditor());
  3. //typeConverter.setConversionService(conversionService);
  4. User value = typeConverter.convertIfNecessary("1", User.class);
  5. System.out.println(value);

BeanPostProcessor

Bean的后置处理器,可以在创建每个Bean的过程中进行干涉,是属于BeanFactory中一个属性,讲Bean的生命周期中详细讲。

BeanFactoryPostProcessor

Bean工厂的后置处理器,是属于ApplicationContext中的一个属性,是ApplicationContext在实例化一个BeanFactory后,可以利用BeanFactoryPostProcessor继续处理BeanFactory。

程序员可以通过BeanFactoryPostProcessor间接的设置BeanFactory,比如上文中的CustomEditorConfigurer就是一个BeanFactoryPostProcessor,我们可以通过它向BeanFactory中添加自定义的PropertyEditor。

FactoryBean

允许程序员自定义一个对象通过FactoryBean间接的放到Spring容器中成为一个Bean。

那么它和@Bean的区别是什么?因为@Bean也可以自定义一个对象,让这个对象成为一个Bean。

区别在于利用FactoryBean可以更加强大,因为你通过定义一个XxFactoryBean的类,可以再去实现Spring中的其他接口,比如如果你实现了BeanFactoryAware接口,那么你可以在你的XxFactoryBean中获取到Bean工厂,从而使用Bean工厂做更多你想做的,而@Bean则不行。

spring源码图

Spring源码.jpg