com.livk.commons.SpringContextHolder Maven / Gradle / Ivy
/*
* Copyright 2021-2024 spring-boot-extension the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.livk.commons;
import com.livk.auto.service.annotation.SpringAutoService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.ListableBeanFactory;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.context.properties.bind.PropertySourcesPlaceholdersResolver;
import org.springframework.boot.context.properties.source.ConfigurationPropertySource;
import org.springframework.boot.context.properties.source.ConfigurationPropertySources;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.core.Ordered;
import org.springframework.core.ResolvableType;
import org.springframework.core.annotation.Order;
import org.springframework.core.convert.converter.Converter;
import org.springframework.core.convert.support.GenericConversionService;
import org.springframework.core.env.Environment;
import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import java.util.Arrays;
import java.util.Map;
/**
*
* spring context静态操作工具
*
*
* @author livk
*/
@Slf4j
@SpringAutoService
@Order(Ordered.HIGHEST_PRECEDENCE)
@Component(SpringContextHolder.BEAN_NAME)
public class SpringContextHolder implements BeanFactoryAware, ApplicationContextAware, DisposableBean {
/**
* SpringContextHolder bean name
*/
public static final String BEAN_NAME = "com.livk.commons.spring.context.SpringContextHolder";
private volatile static ApplicationContext applicationContext = null;
private volatile static BeanFactory beanFactory = null;
/**
* Spring事件发布
* @param event 事件
*/
public static void publishEvent(E event) {
applicationContext.publishEvent(event);
}
/**
* 根据BeanName获取Bean
* @param 泛型
* @param name BeanName
* @return spring bean
*/
@SuppressWarnings("unchecked")
public static T getBean(String name) {
return (T) getBeanFactory().getBean(name);
}
/**
* 根据Bean Type获取Bean
* @param 泛型
* @param typeClass 类型
* @return spring bean
*/
public static T getBean(Class typeClass) {
return getBeanFactory().getBean(typeClass);
}
/**
* 根据BeanName和Bean Type获取Bean
* @param 泛型
* @param name BeanName
* @param typeClass 类型
* @return spring bean
*/
public static T getBean(String name, Class typeClass) {
return getBeanFactory().getBean(name, typeClass);
}
/**
* 根据Bean Type获取到ObjectFactory
*
* 可用于延时加载
* @param 泛型
* @param typeClass 类型
* @return spring bean provider
*/
public static ObjectProvider getBeanProvider(Class typeClass) {
return getBeanFactory().getBeanProvider(typeClass);
}
/**
* 根据ResolvableType获取到ObjectFactory
*
* 可用于延时加载
* @param 泛型
* @param resolvableType 类型相关
* @return spring bean provider
*/
public static ObjectProvider getBeanProvider(ResolvableType resolvableType) {
return getBeanFactory().getBeanProvider(resolvableType);
}
/**
* 根据Bean Type获取到map
*
* key为BeanName, value为对应的spring bean
* @param 泛型
* @param typeClass 类型
* @return spring bean map
*/
public static Map getBeansOfType(Class typeClass) {
return getBeanFactory().getBeansOfType(typeClass);
}
/**
* 根据key获取到相关的环境信息
* @param key key
* @return string
*/
public static String getProperty(String key) {
return getProperty(key, String.class);
}
/**
* 根据key获取到相关的环境信息,并转化成对应的类型
* @param 泛型
* @param key key
* @param requiredType 返回类型
* @return value
*/
public static T getProperty(String key, Class requiredType) {
return applicationContext.getEnvironment().getProperty(key, requiredType);
}
/**
* 根据key获取到相关的环境信息,并转化成对应的类型
*
* 如果没有相关的key，则返回defaultValue
* @param 泛型
* @param key key
* @param requiredType 返回类型
* @param defaultValue 默认的返回数据
* @return value
*/
public static T getProperty(String key, Class requiredType, T defaultValue) {
return applicationContext.getEnvironment().getProperty(key, requiredType, defaultValue);
}
/**
* 解析文本占位符${**}
* @param text string
* @return value
*/
public static String resolvePlaceholders(String text) {
return applicationContext.getEnvironment().resolvePlaceholders(text);
}
/**
* {@link Binder#get(Environment)}的补充、用户添加数据转换器
* @param converters 添加转换器
* @return binder
*/
public static Binder binder(Converter... converters) {
Environment environment = applicationContext.getEnvironment();
Iterable sources = ConfigurationPropertySources.get(environment);
PropertySourcesPlaceholdersResolver placeholdersResolver = new PropertySourcesPlaceholdersResolver(environment);
GenericConversionService service = new GenericConversionService();
Arrays.stream(converters).forEach(service::addConverter);
return new Binder(sources, placeholdersResolver, service);
}
/**
* 注册bean
* @param bean类型
* @param bean bean实例
* @param beanName beanName可为空，为空会自动生成
*/
public static void registerBean(T bean, String beanName) {
ResolvableType resolvableType = ResolvableType.forInstance(bean);
BeanDefinitionBuilder definitionBuilder = BeanDefinitionBuilder.rootBeanDefinition(resolvableType, () -> bean);
registerBean(definitionBuilder.getBeanDefinition(), beanName);
}
/**
* 注册bean
* @param beanDefinition bean定义
* @param beanName BeanName
*/
public static void registerBean(BeanDefinition beanDefinition, String beanName) {
if (beanFactory instanceof DefaultListableBeanFactory defaultBeanFactory) {
registerBean(defaultBeanFactory, beanDefinition, beanName);
}
else if (applicationContext instanceof GenericApplicationContext context) {
registerBean(context, beanDefinition, beanName);
}
else {
log.error("bean register fail name: {} instantClass: {}", beanName, beanDefinition.getResolvableType());
}
}
private static void registerBean(BeanDefinitionRegistry registry, BeanDefinition beanDefinition, String beanName) {
beanName = StringUtils.hasText(beanName) ? beanName
: BeanDefinitionReaderUtils.generateBeanName(beanDefinition, registry);
registry.registerBeanDefinition(beanName, beanDefinition);
}
private static ListableBeanFactory getBeanFactory() {
return beanFactory instanceof ListableBeanFactory listableBeanFactory ? listableBeanFactory
: applicationContext;
}
public static ApplicationContext fetch() {
return applicationContext;
}
@Override
public synchronized void setBeanFactory(@Nullable BeanFactory beanFactory) throws BeansException {
SpringContextHolder.beanFactory = beanFactory;
}
@Override
public synchronized void setApplicationContext(@Nullable ApplicationContext applicationContext)
throws BeansException {
SpringContextHolder.applicationContext = applicationContext;
}
@Override
public synchronized void destroy() {
SpringContextHolder.applicationContext = null;
SpringContextHolder.beanFactory = null;
}
}