直接复制即可使用,注释很全。
如果想看看具体细节的,提供更全面的方法的朋友们,请移步到:
【springboot高级】(五:九大常用Aware实现之ApplicationContextAware (源码篇))
package com.osy.util;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.env.Environment;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Component;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.Optional;
/**
* spring上下文工具类
*/
@Component
public class SpringContextUtils implements ApplicationContextAware {
private static ApplicationContext applicationContext; // Spring应用上下文环境
/**
* 实现ApplicationContextAware接口的回调方法,设置上下文环境
*
* @param applicationContext
* @throws BeansException
*/
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
Optional.ofNullable(applicationContext).orElse(SpringContextUtil.applicationContext = applicationContext);
}
/**
* @return ApplicationContext
*/
public static ApplicationContext getApplicationContext() {
return applicationContext;
}
/**
* 获取对象
*
* @param name
* @return Object 一个以所给名字注册的bean的实例
* @throws BeansException
*/
public static Object getBean(String name) throws BeansException {
return applicationContext.getBean(name);
}
/**
* 获取类型为requiredType的对象 如果bean不能被类型转换,相应的异常将会被抛出(BeanNotOfRequiredTypeException)
*
* @param name bean注册名
* @param requiredType 返回对象类型
* @return Object 返回requiredType类型对象
* @throws BeansException
*/
public static <T> T getBean(String name, Class<T> requiredType) throws BeansException {
return applicationContext.getBean(name, requiredType);
}
/**
* 如果BeanFactory包含一个与所给名称匹配的bean定义,则返回true
*
* @param name
* @return boolean
*/
public static boolean containsBean(String name) {
return applicationContext.containsBean(name);
}
/**
* 判断以给定名字注册的bean定义是一个singleton还是一个prototype。
* 如果与给定名字相应的bean定义没有被找到,将会抛出一个异常(NoSuchBeanDefinitionException)
*
* @param name
* @return boolean
* @throws NoSuchBeanDefinitionException
*/
public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException {
return applicationContext.isSingleton(name);
}
/**
* @param name
* @return Class 注册对象的类型
* @throws NoSuchBeanDefinitionException
*/
public static Class getType(String name) throws NoSuchBeanDefinitionException {
return applicationContext.getType(name);
}
/**
* 如果给定的bean名字在bean定义中有别名,则返回这些别名
*
* @param name
* @return
* @throws NoSuchBeanDefinitionException
*/
public static String[] getAliases(String name) throws NoSuchBeanDefinitionException {
return applicationContext.getAliases(name);
}
/**
* 返回环境对象,可以获取一些系统配置或者我们自己的配置
*
* @return
*/
public static Environment getEnvironment() {
return applicationContext.getEnvironment();
}
// 用于查找bean类上面是否有我们指定的注解。看到这里我倒是突发奇想:
// 我们是不是可以对其进行开发的约束,比如对所有contronller里面的,都必须打上controller注解。
// 当然这只是一个个人想法。不喜勿喷
<A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType)
throws NoSuchBeanDefinitionException {
return applicationContext.findAnnotationOnBean(beanName, annotationType);
}
/**
* 返回本地bean工厂是否包含给定名称的bean,忽略祖先上下文中定义的bean
*
* @param name
* @return
*/
public static boolean containsLocalBean(String name) {
return applicationContext.containsLocalBean(name);
}
/**
* 将给定的位置模式解析为资源对象。
*
* @param locationPattern
* @return
* @throws IOException
*/
public static Resource[] getResources(String locationPattern) throws IOException {
return applicationContext.getResources(locationPattern);
}
}