SpringUtil (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.extra.spring.SpringUtil

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.config.BeanFactoryPostProcessor, org.springframework.context.ApplicationContextAware
```
@Component
public class SpringUtil
extends Object
implements org.springframework.beans.factory.config.BeanFactoryPostProcessor, org.springframework.context.ApplicationContextAware
```
Spring(Spring boot)工具封装，包括：
1. Spring IOC容器中的bean对象获取
2. 注册和注销Bean
Since:

5.1.0

Author:

loolly

Constructor Summary

Constructors
Constructor and Description

SpringUtil()

Constructors
Constructor and Description
`SpringUtil()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getActiveProfile()` 获取当前的环境配置，当有多个环境配置时，只获取第一个
`static String[]`	`getActiveProfiles()` 获取当前的环境配置，无配置返回null
`static org.springframework.context.ApplicationContext`	`getApplicationContext()` 获取`ApplicationContext`
`static String`	`getApplicationName()` 获取应用程序名称
`static <T> T`	`getBean(Class<T> clazz)` 通过class获取Bean
`static <T> T`	`getBean(String name)` 通过name获取 Bean
`static <T> T`	`getBean(String name, Class<T> clazz)` 通过name,以及Clazz返回指定的Bean
`static <T> T`	`getBean(TypeReference<T> reference)` 通过类型参考返回带泛型参数的Bean
`static org.springframework.beans.factory.ListableBeanFactory`	`getBeanFactory()` 获取`ListableBeanFactory`，可能为`ConfigurableListableBeanFactory` 或 `ApplicationContextAware`
`static String[]`	`getBeanNamesForType(Class<?> type)` 获取指定类型对应的Bean名称，包括子类
`static <T> Map<String,T>`	`getBeansOfType(Class<T> type)` 获取指定类型对应的所有Bean，包括子类
`static org.springframework.beans.factory.config.ConfigurableListableBeanFactory`	`getConfigurableBeanFactory()` 获取`ConfigurableListableBeanFactory`
`static String`	`getProperty(String key)` 获取配置文件配置项的值
`static <T> T`	`getProperty(String key, Class<T> targetType, T defaultValue)` 获取配置文件配置项的值
`static String`	`getProperty(String key, String defaultValue)` 获取配置文件配置项的值
`void`	`postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)`
`static void`	`publishEvent(org.springframework.context.ApplicationEvent event)` 发布事件
`static void`	`publishEvent(Object event)` 发布事件 Spring 4.2+ 版本事件可以不再是`ApplicationEvent`的子类
`static <T> void`	`registerBean(String beanName, T bean)` 动态向Spring注册Bean 由`BeanFactory` 实现，通过工具开放API 更新: shadow 2021-07-29 17:20:44 增加自动注入，修复注册bean无法反向注入的问题
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`static void`	`unregisterBean(String beanName)` 注销bean 将Spring中的bean注销，请谨慎使用

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpringUtil
```
public SpringUtil()
```
- Method Detail
  - postProcessBeanFactory
```
public void postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)
                            throws org.springframework.beans.BeansException
```
    Specified by:
    
    postProcessBeanFactory in interface org.springframework.beans.factory.config.BeanFactoryPostProcessor
    
    Throws:
    
    org.springframework.beans.BeansException
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
  - getApplicationContext
```
public static org.springframework.context.ApplicationContext getApplicationContext()
```
    获取ApplicationContext
    
    Returns:
    
    ApplicationContext
  - getBeanFactory
```
public static org.springframework.beans.factory.ListableBeanFactory getBeanFactory()
```
    获取ListableBeanFactory，可能为ConfigurableListableBeanFactory 或 ApplicationContextAware
    
    Returns:
    
    ListableBeanFactory
    
    Since:
    
    5.7.0
  - getConfigurableBeanFactory
```
public static org.springframework.beans.factory.config.ConfigurableListableBeanFactory getConfigurableBeanFactory()
                                                                                                           throws UtilException
```
    获取ConfigurableListableBeanFactory
    
    Returns:
    
    ConfigurableListableBeanFactory
    
    Throws:
    
    UtilException - 当上下文非ConfigurableListableBeanFactory抛出异常
    
    Since:
    
    5.7.7
  - getBean
```
public static <T> T getBean(String name)
```
    通过name获取 Bean
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    name - Bean名称
    
    Returns:
    
    Bean
  - getBean
```
public static <T> T getBean(Class<T> clazz)
```
    通过class获取Bean
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    clazz - Bean类
    
    Returns:
    
    Bean对象
  - getBean
```
public static <T> T getBean(String name,
                            Class<T> clazz)
```
    通过name,以及Clazz返回指定的Bean
    
    Type Parameters:
    
    T - bean类型
    
    Parameters:
    
    name - Bean名称
    
    clazz - bean类型
    
    Returns:
    
    Bean对象
  - getBean
```
public static <T> T getBean(TypeReference<T> reference)
```
    通过类型参考返回带泛型参数的Bean
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    reference - 类型参考，用于持有转换后的泛型类型
    
    Returns:
    
    带泛型参数的Bean
    
    Since:
    
    5.4.0
  - getBeansOfType
```
public static <T> Map<String,T> getBeansOfType(Class<T> type)
```
    获取指定类型对应的所有Bean，包括子类
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    type - 类、接口，null表示获取所有bean
    
    Returns:
    
    类型对应的bean，key是bean注册的name，value是Bean
    
    Since:
    
    5.3.3
  - getBeanNamesForType
```
public static String[] getBeanNamesForType(Class<?> type)
```
    获取指定类型对应的Bean名称，包括子类
    
    Parameters:
    
    type - 类、接口，null表示获取所有bean名称
    
    Returns:
    
    bean名称
    
    Since:
    
    5.3.3
  - getProperty
```
public static String getProperty(String key)
```
    获取配置文件配置项的值
    
    Parameters:
    
    key - 配置项key
    
    Returns:
    
    属性值
    
    Since:
    
    5.3.3
  - getProperty
```
public static String getProperty(String key,
                                 String defaultValue)
```
    获取配置文件配置项的值
    
    Parameters:
    
    key - 配置项key
    
    defaultValue - 默认值
    
    Returns:
    
    属性值
    
    Since:
    
    5.8.24
  - getProperty
```
public static <T> T getProperty(String key,
                                Class<T> targetType,
                                T defaultValue)
```
    获取配置文件配置项的值
    
    Type Parameters:
    
    T - 属性值类型
    
    Parameters:
    
    key - 配置项key
    
    targetType - 配置项类型
    
    defaultValue - 默认值
    
    Returns:
    
    属性值
    
    Since:
    
    5.8.24
  - getApplicationName
```
public static String getApplicationName()
```
    获取应用程序名称
    
    Returns:
    
    应用程序名称
    
    Since:
    
    5.7.12
  - getActiveProfiles
```
public static String[] getActiveProfiles()
```
    获取当前的环境配置，无配置返回null
    
    Returns:
    
    当前的环境配置
    
    Since:
    
    5.3.3
  - getActiveProfile
```
public static String getActiveProfile()
```
    获取当前的环境配置，当有多个环境配置时，只获取第一个
    
    Returns:
    
    当前的环境配置
    
    Since:
    
    5.3.3
  - registerBean
```
public static <T> void registerBean(String beanName,
                                    T bean)
```
    动态向Spring注册Bean
    由BeanFactory 实现，通过工具开放API
    更新: shadow 2021-07-29 17:20:44 增加自动注入，修复注册bean无法反向注入的问题
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    beanName - 名称
    
    bean - bean
    
    Since:
    
    5.4.2
  - unregisterBean
```
public static void unregisterBean(String beanName)
```
    注销bean
    将Spring中的bean注销，请谨慎使用
    
    Parameters:
    
    beanName - bean名称
    
    Since:
    
    5.7.7
  - publishEvent
```
public static void publishEvent(org.springframework.context.ApplicationEvent event)
```
    发布事件
    
    Parameters:
    
    event - 待发布的事件，事件必须是ApplicationEvent的子类
    
    Since:
    
    5.7.12
  - publishEvent
```
public static void publishEvent(Object event)
```
    发布事件 Spring 4.2+ 版本事件可以不再是ApplicationEvent的子类
    
    Parameters:
    
    event - 待发布的事件
    
    Since:
    
    5.7.21

Class SpringUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpringUtil

Method Detail

postProcessBeanFactory

setApplicationContext

getApplicationContext

getBeanFactory

getConfigurableBeanFactory

getBean

getBean

getBean

getBean

getBeansOfType

getBeanNamesForType

getProperty

getProperty

getProperty

getApplicationName

getActiveProfiles

getActiveProfile

registerBean

unregisterBean

publishEvent

publishEvent