SpringUtils

111 阅读2分钟

背景:

你可能需要在非Spring管理的类中获取Spring容器中的Bean

实现:

@Component
public class SpringUtils implements BeanFactoryPostProcessor {

    //Spring应用上下文环境
    private static ConfigurableListableBeanFactory beanFactory;

    public static ConfigurableListableBeanFactory getBeanFactory() {
        return beanFactory;
    }

    /**
     * 通过class name获取对象
     *
     * @param name class name
     * @return Object 一个以所给名字注册的bean的实例
     * @throws org.springframework.beans.BeansException Exceptions that might be thrown
     */
    @SuppressWarnings("unchecked")
    public static <T> T getBean(String name) throws BeansException {
        return (T) getBeanFactory().getBean(name);
    }

    /**
     * 获取类型为requiredType的对象
     *
     * @param clz class
     * @return 返回对应的class示例
     * @throws org.springframework.beans.BeansException Exceptions that might be thrown
     */
    public static <T> T getBean(Class<T> clz) throws BeansException {
        return getBeanFactory().getBean(clz);
    }

    /**
     * 如果BeanFactory包含一个与所给名称匹配的bean定义,则返回true
     *
     * @param name class name
     * @return true/false
     */
    public static boolean containsBean(String name) {
        return getBeanFactory().containsBean(name);
    }

    /**
     * 判断以给定名字注册的bean定义是一个singleton还是一个prototype。 如果与给定名字相应的bean定义没有被找到,将会抛出一个异常(NoSuchBeanDefinitionException)
     *
     * @param name class name
     * @return true/false
     * @throws org.springframework.beans.factory.NoSuchBeanDefinitionException Exceptions that might be thrown
     */
    public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException {
        return getBeanFactory().isSingleton(name);
    }

    /**
     * @param name class name
     * @return Class 注册对象的类型
     * @throws org.springframework.beans.factory.NoSuchBeanDefinitionException Exceptions that might be thrown
     */
    public static Class<?> getType(String name) throws NoSuchBeanDefinitionException {
        return getBeanFactory().getType(name);
    }

    /**
     * 如果给定的bean名字在bean定义中有别名,则返回这些别名
     *
     * @param name class name
     * @return 返回class实例
     * @throws org.springframework.beans.factory.NoSuchBeanDefinitionException Exceptions that might be thrown
     */
    public static String[] getAliases(String name) throws NoSuchBeanDefinitionException {
        return getBeanFactory().getAliases(name);
    }

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        SpringUtils.beanFactory = beanFactory;
    }
}

SpringUtils实现了BeanFactoryPostProcessor接口,这是Spring框架提供的一个扩展点接口。通过实现该接口,SpringUtils可以在Spring容器加载Bean定义后,在Bean实例化之前对BeanFactory进行后置处理。

这个类的主要目的是提供一些静态方法,用于方便地访问和操作Spring容器中的BeanFactory。下面是一些主要方法的解释:

  • postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory): 这个方法是BeanFactoryPostProcessor接口的实现方法。在Spring容器加载Bean的定义后,会调用该方法,并传入beanFactory作为参数。SpringUtils将这个beanFactory赋值给自己的静态变量beanFactory,以便后续的静态方法可以使用它。

  • getBeanFactory(): 这个静态方法返回beanFactory,即Spring容器中的BeanFactory实例。其他静态方法可以通过调用这个方法来获取BeanFactory实例。

  • getBean(String name): 这个静态方法用于根据给定的名称获取对应的Bean实例。它通过调用

  • getBeanFactory().getBean(name)来实现,在Spring容器中查找并返回匹配名称的Bean实例。

  • getBean(Class clz): 这个静态方法用于根据给定的类型获取对应的Bean实例。它通过调用

  • getBeanFactory().getBean(clz)来实现,在Spring容器中查找并返回匹配类型的Bean实例。

  • 其他方法,如containsBean(String name)、isSingleton(String name)、getType(String name)和 getAliases(String name),提供了一些额外的功能,用于判断Bean是否存在、获取Bean的类型和别名等。

通过使用SpringUtils类,可以在任何需要访问Spring容器中的Bean的地方,方便地获取和操作Bean实例。