博客

实现ApplicationContextAware接口

来获取 ApplicationContext ，

实现对Spring管理的Bean的一些操作

/**
 * @author Peppa
 */
@Slf4j
@Component
public class SpringCoreUtil implements ApplicationContextAware, BeanDefinitionRegistryPostProcessor, Ordered {

    private static ApplicationContext applicationContext;

    /**
     * 获取spring 上下文应用对象
     *
     * @return spring应用上下文对象
     * @author bang
     */
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    /**
     * 注入applicationContext对象
     */
    @Override
    public void setApplicationContext(@NotNull ApplicationContext applicationContext) throws BeansException {
        Assert.notNull(applicationContext, "inject applicationContext must not null,please check spring configuration !");
        SpringCoreUtil.applicationContext = applicationContext;
        if (log.isInfoEnabled()) {
            log.info("Inject SpringUtil Class to applicationContext success!");
        }
    }

    /**
     * 从spring容器中获取指定名称的bean
     *
     * @param name
     * @return 一个以所给名字注册的bean的实例
     * @throws BeansException bean异常
     * @author bang
     */
    @SuppressWarnings("unchecked")
    public static <T> T getBean(String name) throws BeansException {
        Assert.notNull(applicationContext, "applicationContext can't be null!");
        return (T) applicationContext.getBean(name);
    }

    /**
     * 从spring容器中获取指定名称,指定类型的的注册bean
     *
     * @param name bean名称
     * @param clz  bean类型
     * @param <T>  bean类型泛型
     * @return 指定类型指定名称的bean
     * @throws BeansException bean异常
     */
    public static <T> T getBean(String name, Class<T> clz) throws BeansException {
        Assert.notNull(applicationContext, "applicationContext can't be null!");
        return applicationContext.getBean(name, clz);
    }

    /**
     * 获取类型为requiredType的对象
     *
     * @param clz bean的类型
     * @return 执行bean类型的实例bean
     * @throws BeansException bean异常
     * @author bang
     */
    public static <T> T getBean(Class<T> clz) throws BeansException {
        Assert.notNull(applicationContext, "applicationContext can't be null!");
        return applicationContext.getBean(clz);
    }

    /**
     * 获取指定类型的所有注册bean对象
     *
     * @param type 指定bean类型
     * @return 指定类型的所有注册bean对象
     * @author bang
     */
    public static <T> Map<String, T> getBeans(Class<T> type) {
        return applicationContext.getBeansOfType(type);
    }

    /**
     * 获取标注指定注解的bean集合
     *
     * @param annotationType 注解类型
     * @return 标注指定注解的bean集合
     */
    public static Map<String, Object> getBeansWithAnnotation(Class<? extends Annotation> annotationType) {
        return applicationContext.getBeansWithAnnotation(annotationType);
    }

    /**
     * 如果BeanFactory包含一个与所给名称匹配的bean定义，则返回true
     *
     * @param name bean的名称
     * @return true:包含bean,false:不包含bean
     */
    public static boolean containsBean(String name) {
        Assert.notNull(applicationContext, "applicationContext can't be null!");
        return applicationContext.containsBean(name);
    }

    /**
     * 判断以给定名字注册的bean定义是一个singleton还是一个prototype。 <br/>
     * 如果与给定名字相应的bean定义没有被找到，将会抛出一个异常（NoSuchBeanDefinitionException）
     *
     * @param name bean的名称
     * @return true:单例bean,false:多实例bean
     * @throws NoSuchBeanDefinitionException 没有此bean定义异常
     */
    public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException {
        Assert.notNull(applicationContext, "applicationContext can't be null!");
        return applicationContext.isSingleton(name);
    }

    /**
     * 获取指定名称的bean对象的注册类型
     *
     * @param name bean的名称
     * @return 注册的bean的类型
     * @throws NoSuchBeanDefinitionException 没有此bean定义异常
     */
    public static Class<?> getType(String name) throws NoSuchBeanDefinitionException {
        Assert.notNull(applicationContext, "applicationContext不能为空!");
        return applicationContext.getType(name);
    }

    /**
     * 如果给定的bean名字在bean定义中有别名，则返回这些别名
     *
     * @param name bean的名称
     * @return bean的别名
     * @throws NoSuchBeanDefinitionException 没有此bean定义异常
     */
    public static String[] getAliases(String name) throws NoSuchBeanDefinitionException {
        Assert.notNull(applicationContext, "applicationContext不能为空!");
        return applicationContext.getAliases(name);
    }

    public static Environment getEnvironment() {
        return getApplicationContext().getEnvironment();
    }

    public static String getProperty(String key, String defaultValue) {
        return getEnvironment().getProperty(key, defaultValue);
    }

    public static <T> T getProperty(String key, Class<T> clazz, T defaultValue) {
        return getEnvironment().getProperty(key, clazz, defaultValue);
    }

    /**
     * 异步发布事件
     *
     * @param event 事件
     */
    public static void publishEvent(ApplicationEvent event) {
        TaskExecutor.execute(() -> applicationContext.publishEvent(event));
    }


    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        // 不做任何业务处理，仅仅让spring优先加载这个SpringCoreUtil类
    }

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        // 不做任何业务处理，仅仅让spring优先加载这个SpringCoreUtil类
    }

    @Override
    public int getOrder() {
        return Ordered.LOWEST_PRECEDENCE;
    }
}