Spring中常见的BeanFactory后处理器

常见的BeanFacatory后处理器

先给出没有添加任何BeanFactory后处理器的测试代码

public class TestBeanFactoryPostProcessor {public static void main(String[] args) {GenericApplicationContext context = new GenericApplicationContext();context.registerBean("config", Config.class);context.refresh();for (String beanDefinitionName : context.getBeanDefinitionNames()) {System.out.println(beanDefinitionName);}context.close();}
}

在配置类中我们编写了如下信息

@Configuration
@ComponentScan("com.zmt.test5")
public class Config {@Beanpublic Bean2 bean2(){return new Bean2();}@Beanpublic SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource){SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();sqlSessionFactoryBean.setDataSource(dataSource);return sqlSessionFactoryBean;}@Beanpublic DruidDataSource dataSource(){DruidDataSource dataSource = new DruidDataSource();dataSource.setUrl("jdbc:mysql://localhost:3306/test");dataSource.setUsername("root");dataSource.setPassword("123456");return dataSource;}
}

同时还有一个Bean1添加了@Component注解并且能够被扫描到，所以理论上来讲，我们可以观察到五个beanName，那么执行测试代码观察输出结果

可以看到，这里只输出了一个beanName，我们可以推测出其他注解没有生效，那么接下来我们将常用的BeanFactory后处理器也注册到BeanFactory后，观察输出结果

public class TestBeanFactoryPostProcessor {public static void main(String[] args) {GenericApplicationContext context = new GenericApplicationContext();context.registerBean("config", Config.class);//添加BeanFactory后处理器context.registerBean(ConfigurationClassPostProcessor.class);//用来解析 @ComponentScan @Bean @Import @ImportResource注解context.registerBean(MapperScannerConfigurer.class,bd -> {bd.getPropertyValues().add("basePackage","com.zmt.test.mapper");});//扫描Mapper，相当于@MapperScan注解context.refresh();for (String beanDefinitionName : context.getBeanDefinitionNames()) {System.out.println(beanDefinitionName);}context.close();}
}

添加Spring提供的BeanFactory后处理器之后，可以正常将Bean对象添加到context容器当中了，执行结果如下

接下来我们模拟实现在BeanFactory后处理器当中具体如何解析这些注解。

模拟实现组件扫描

首先是模拟实现@ComponentScan注解是如何扫描包，获取类资源的

public class TestBeanFactoryPostProcessor {public static void main(String[] args) throws IOException {GenericApplicationContext context = new GenericApplicationContext();context.registerBean("config", Config.class);//模拟ConfigurationPostProcessor处理器中如何解析@ComponentScan注解ComponentScan componentScan = AnnotationUtils.findAnnotation(Config.class, ComponentScan.class);if (componentScan != null) {for (String s : componentScan.basePackages()) {//将com.zmt.test5.bean转化格式为classpath*:com/zmt/test5/bean/**/*.classString path = "classpath*:"+s.replace(".", "/")+"/**/*.class";//创建出一个元数据读取工厂，用来读取类资源信息CachingMetadataReaderFactory factory = new CachingMetadataReaderFactory();//通过getResource方法获取到path中的所有类资源Resource[] resources = context.getResources(path);for (Resource resource : resources) {//读取类资源信息MetadataReader reader = factory.getMetadataReader(resource);System.out.println("类名："+reader.getClassMetadata());System.out.println("是否添加了@Component注解："+reader.getAnnotationMetadata().hasAnnotation(Component.class.getName()));System.out.println("是否添加了@Component的派生注解:"+reader.getAnnotationMetadata().hasMetaAnnotation(Component.class.getName()));}}}context.refresh();for (String beanDefinitionName : context.getBeanDefinitionNames()) {System.out.println(beanDefinitionName);}context.close();}
}

运行结果如下，可以正常识别类上是否添加了@Component注解或是派生注解

能够扫描到类上添加的注解之后，我们是需要将注解添加到BeanDefinitionMap当中去的，那么继续完善我们的测试方法

public class TestBeanFactoryPostProcessor {public static void main(String[] args) throws IOException {GenericApplicationContext context = new GenericApplicationContext();context.registerBean("config", Config.class);//模拟ConfigurationPostProcessor处理器中如何解析@ComponentScan注解ComponentScan componentScan = AnnotationUtils.findAnnotation(Config.class, ComponentScan.class);if (componentScan != null) {for (String s : componentScan.basePackages()) {//将com.zmt.test5转化格式为classpath*:com/zmt/test5/**/*.classString path = "classpath*:" + s.replace(".", "/") + "/**/*.class";//创建出一个元数据读取工厂，用来读取类资源信息CachingMetadataReaderFactory factory = new CachingMetadataReaderFactory();//通过getResource方法获取到path中的所有类资源Resource[] resources = context.getResources(path);//创建Bean名称生成器AnnotationBeanNameGenerator generator = new AnnotationBeanNameGenerator();for (Resource resource : resources) {//读取类资源信息MetadataReader reader = factory.getMetadataReader(resource);System.out.println("类名1：" + reader.getClassMetadata());AnnotationMetadata annotationMetadata = reader.getAnnotationMetadata();System.out.println("是否添加了@Component注解：" + annotationMetadata.hasAnnotation(Component.class.getName()));System.out.println("是否添加了@Component的派生注解:" + annotationMetadata.hasMetaAnnotation(Component.class.getName()));if (annotationMetadata.hasAnnotation(Component.class.getName()) ||annotationMetadata.hasMetaAnnotation(Component.class.getName())) {//如果该类添加了注解，需要添加到BeanDefinitionMap当中去,生成BeanDefinition对象AbstractBeanDefinition bd = BeanDefinitionBuilder.genericBeanDefinition(reader.getClassMetadata().getClassName()).getBeanDefinition();DefaultListableBeanFactory beanFactory = context.getDefaultListableBeanFactory();//生成Bean名称String name = generator.generateBeanName(bd,beanFactory);System.out.println("name:"+name);//将BeanDefinition注册到beanFactorybeanFactory.registerBeanDefinition(name,bd);}}}}context.refresh();for (String beanDefinitionName : context.getBeanDefinitionNames()) {System.out.println(beanDefinitionName);}context.close();}
}

我们通过打断点查看beanFactory中是否将BeanDefinition信息注册到BeanDefinitionMap当中去，结果如下

至此已经实现了组件扫描，但是目前我们的实现是在容器初始化 [refresh()方法] 之前就做好了，我们应该将这些实现抽取到一个BeanFactory后处理器当中，等待refresh()方法回调，因此我们将这些实现代码放入一个组件扫描后处理器。

public class ComponentScanPostProcessor implements BeanFactoryPostProcessor {@Override //在执行context.refresh()方法时回调该方法public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {try {ComponentScan componentScan = AnnotationUtils.findAnnotation(Config.class, ComponentScan.class);if (componentScan != null) {for (String s : componentScan.basePackages()) {//将com.zmt.test5转化格式为classpath*:com/zmt/test5/**/*.classString path = "classpath*:" + s.replace(".", "/") + "/**/*.class";//创建出一个元数据读取工厂，用来读取类资源信息CachingMetadataReaderFactory factory = new CachingMetadataReaderFactory();//通过getResource方法获取到path中的所有类资源Resource[] resources = new PathMatchingResourcePatternResolver().getResources(path);//创建Bean名称生成器AnnotationBeanNameGenerator generator = new AnnotationBeanNameGenerator();for (Resource resource : resources) {//读取类资源信息MetadataReader reader = factory.getMetadataReader(resource);System.out.println("类名1：" + reader.getClassMetadata());AnnotationMetadata annotationMetadata = reader.getAnnotationMetadata();System.out.println("是否添加了@Component注解：" + annotationMetadata.hasAnnotation(Component.class.getName()));System.out.println("是否添加了@Component的派生注解:" + annotationMetadata.hasMetaAnnotation(Component.class.getName()));if (annotationMetadata.hasAnnotation(Component.class.getName()) ||annotationMetadata.hasMetaAnnotation(Component.class.getName())) {//如果该类添加了注解，需要添加到BeanDefinitionMap当中去,生成BeanDefinition对象AbstractBeanDefinition bd = BeanDefinitionBuilder.genericBeanDefinition(reader.getClassMetadata().getClassName()).getBeanDefinition();if (configurableListableBeanFactory instanceof DefaultListableBeanFactory){DefaultListableBeanFactory beanFactory = (DefaultListableBeanFactory) configurableListableBeanFactory;String name = generator.generateBeanName(bd,beanFactory);System.out.println("name:"+name);beanFactory.registerBeanDefinition(name,bd);}}}}}} catch (IOException e) {e.printStackTrace();}}
}

修改此时的测试代码，将我们自定义的BeanFactory后处理器注册到context当中

public class TestBeanFactoryPostProcessor {public static void main(String[] args) throws IOException {GenericApplicationContext context = new GenericApplicationContext();context.registerBean("config", Config.class);//模拟ConfigurationPostProcessor处理器中如何解析@ComponentScan注解context.registerBean(ComponentScanPostProcessor.class);context.refresh();for (String beanDefinitionName : context.getBeanDefinitionNames()) {System.out.println(beanDefinitionName);}context.close();}
}