Spring原理篇-BeanFactoryPostProcessor的使用

85 阅读2分钟

1、BeanFactoryPostProcessor的使用

下面我们来实际使用一下 BeanFactoryPostProcessor ,来体会它对 BeanDefinition 的访问和修改。

先说下需求吧:构造几个 Color 的类对象,并在 bean 还没有创建之前,把 bean 的名称设置到 bean 的属性上。

1.1 声明bean

咱不搞那么复杂的模型,一个 Color 的抽象类加两个子类就好:(注意两个子类要标注 @Component 注解注册到 IOC 容器)

public abstract class Color {

    protected String name;
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
}
@Component
public class Red extends Color {
    
    @Override
    public String toString() {
        return "Red{" + "name='" + name + ''' + "}";
    }
}
@Component
public class Green extends Color {
    
    @Override
    public String toString() {
        return "Green{" + "name='" + name + ''' + "}";
    }
}

1.2 编写后置处理器

先理一下思路:后置处理器中,既然拿到的参数是 BeanFactory ,那就可以取出里面的 BeanDefinition ,并给它们添加属性值了。

先把架子写出来,由于 ConfigurableListableBeanFactory 无法通过类型取出指定的 bean ,所以只能取出全部,挨个判断了:

@Component
public class ColorNameSetterFactoryPostProcessor implements BeanFactoryPostProcessor {
    
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        Stream.of(beanFactory.getBeanDefinitionNames()).forEach(beanName -> {
            BeanDefinition beanDefinition = beanFactory.getBeanDefinition(beanName);
            
        });
    }
}

之后就是判断 BeanDefinition 内部生成 bean 的类型了,由于只能获取到 beanClassName ,没有办法取父类,所以只能借助反射来搞定了:

public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    Stream.of(beanFactory.getBeanDefinitionNames()).forEach(beanName -> {
        BeanDefinition beanDefinition = beanFactory.getBeanDefinition(beanName);
        if (StringUtils.hasText(beanDefinition.getBeanClassName())) {
            if (Class.forName(beanDefinition.getBeanClassName()).getSuperclass().equals(Color.class)) {

            }
        }
    });
}

不过这样写,Class.forName() 方法会提示需要捕捉 ClassNotFoundException 。最简单的方法是在整个 foreach 外层套一个 try-catch ,不过我们可以利用 SpringFramework 中的工具类 ClassUtils 来避免异常捕捉:

java
复制代码
ClassUtils.resolveClassName(beanDefinition.getBeanClassName(), this.getClass().getClassLoader())

ClassUtils.resolveClassName() 方法内部已经帮我们搞定了 try-catch ,所以不会再出现异常类型检查和捕捉的提示。

如果这样判断后,bean 的父类确实是 Color ,那就可以添加属性值了:(以下是完整写法)

public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    Stream.of(beanFactory.getBeanDefinitionNames()).forEach(beanName -> {
        BeanDefinition beanDefinition = beanFactory.getBeanDefinition(beanName);
        if (StringUtils.hasText(beanDefinition.getBeanClassName())) {
            if (ClassUtils.resolveClassName(beanDefinition.getBeanClassName(), this.getClass().getClassLoader())
                .getSuperclass().equals(Color.class)) {
                beanDefinition.getPropertyValues().add("name", beanName);
            }
        }
    });
}

1.3 测试运行

与前面的套路一样,直接使用注解 IOC 容器,包扫描驱动:

public class FactoryProcessorApplication {
    
    public static void main(String[] args) throws Exception {
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(
                "com.linkedbear.spring.postprocessor.h_factoryprocessor");
        Red red = ctx.getBean(Red.class);
        System.out.println(red);
    }
}

运行 main 方法,控制台打印出 red 的 name 属性,证明 ColorNameSetterFactoryPostProcessor 已经起到了作用。

1.4 替代方案

可能会有小伙伴察觉到哪里不对劲了:哎,这个策略如果用 BeanPostProcessor 实现,岂不是更简单?

public class ColorNameSetterPostProcessor implements BeanPostProcessor {
    
    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        if (bean instanceof Color) {
            Color color = (Color) bean;
            color.setName(beanName);
        }
        return bean;
    }
}

显然,这种写法更简单是吧。对于这种需求来讲,固然是使用 BeanPostProcessor 更好。小伙伴辩证的根据需求确定解决方案,这个非常好!既然 SpringFramework 中有这个设计,自然也有它的使用场景,而且我们最好对比着来看这两种不同的后置处理器。