org.apache.dubbo.config.spring.util.DubboBeanUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dubbo Show documentation
Show all versions of dubbo Show documentation
The all in one project of dubbo
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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
*
* http://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 org.apache.dubbo.config.spring.util;
import org.apache.dubbo.common.logger.Logger;
import org.apache.dubbo.common.logger.LoggerFactory;
import org.apache.dubbo.config.spring.beans.factory.annotation.DubboConfigAliasPostProcessor;
import org.apache.dubbo.config.spring.beans.factory.annotation.ReferenceAnnotationBeanPostProcessor;
import org.apache.dubbo.config.spring.beans.factory.config.DubboConfigDefaultPropertyValueBeanPostProcessor;
import org.apache.dubbo.config.spring.beans.factory.config.DubboConfigEarlyRegistrationPostProcessor;
import org.apache.dubbo.config.spring.context.DubboApplicationListenerRegistrar;
import org.apache.dubbo.config.spring.context.DubboBootstrapApplicationListener;
import org.apache.dubbo.config.spring.context.DubboLifecycleComponentApplicationListener;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactoryUtils;
import org.springframework.beans.factory.BeanNotOfRequiredTypeException;
import org.springframework.beans.factory.ListableBeanFactory;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import static com.alibaba.spring.util.BeanRegistrar.registerInfrastructureBean;
import static java.util.Collections.emptyList;
import static java.util.Collections.unmodifiableList;
import static org.springframework.util.ObjectUtils.isEmpty;
/**
* Dubbo Bean utilities class
*
* @since 2.7.6
*/
public abstract class DubboBeanUtils {
private static final Logger logger = LoggerFactory.getLogger(DubboBeanUtils.class);
/**
* Register the common beans
*
* @param registry {@link BeanDefinitionRegistry}
* @see ReferenceAnnotationBeanPostProcessor
* @see DubboConfigDefaultPropertyValueBeanPostProcessor
* @see DubboConfigAliasPostProcessor
* @see DubboLifecycleComponentApplicationListener
* @see DubboBootstrapApplicationListener
*/
public static void registerCommonBeans(BeanDefinitionRegistry registry) {
// Since 2.5.7 Register @Reference Annotation Bean Processor as an infrastructure Bean
registerInfrastructureBean(registry, ReferenceAnnotationBeanPostProcessor.BEAN_NAME,
ReferenceAnnotationBeanPostProcessor.class);
// Since 2.7.4 [Feature] https://github.com/apache/dubbo/issues/5093
registerInfrastructureBean(registry, DubboConfigAliasPostProcessor.BEAN_NAME,
DubboConfigAliasPostProcessor.class);
// Since 2.7.9 Register DubboApplicationListenerRegister as an infrastructure Bean
// https://github.com/apache/dubbo/issues/6559
// Since 2.7.5 Register DubboLifecycleComponentApplicationListener as an infrastructure Bean
// registerInfrastructureBean(registry, DubboLifecycleComponentApplicationListener.BEAN_NAME,
// DubboLifecycleComponentApplicationListener.class);
// Since 2.7.4 Register DubboBootstrapApplicationListener as an infrastructure Bean
// registerInfrastructureBean(registry, DubboBootstrapApplicationListener.BEAN_NAME,
// DubboBootstrapApplicationListener.class);
registerInfrastructureBean(registry, DubboApplicationListenerRegistrar.BEAN_NAME,
DubboApplicationListenerRegistrar.class);
// Since 2.7.6 Register DubboConfigDefaultPropertyValueBeanPostProcessor as an infrastructure Bean
registerInfrastructureBean(registry, DubboConfigDefaultPropertyValueBeanPostProcessor.BEAN_NAME,
DubboConfigDefaultPropertyValueBeanPostProcessor.class);
// Since 2.7.15 Register DubboConfigEarlyRegistrationPostProcessor as an infrastructure Bean
registerInfrastructureBean(registry, DubboConfigEarlyRegistrationPostProcessor.BEAN_NAME,
DubboConfigEarlyRegistrationPostProcessor.class);
}
/**
* Get optional bean by name and type if beanName is not null, or else find by type
*
* @param beanFactory
* @param beanName
* @param beanType
* @param
* @return
*/
public static T getOptionalBean(ListableBeanFactory beanFactory, String beanName, Class beanType) throws BeansException {
if (beanName == null) {
return getOptionalBeanByType(beanFactory, beanType);
}
T bean = null;
try {
bean = beanFactory.getBean(beanName, beanType);
} catch (NoSuchBeanDefinitionException e) {
// ignore NoSuchBeanDefinitionException
} catch (BeanNotOfRequiredTypeException e) {
// ignore BeanNotOfRequiredTypeException
logger.warn(String.format("bean type not match, name: %s, expected type: %s, actual type: %s",
beanName, beanType.getName(), e.getActualType().getName()));
}
return bean;
}
private static T getOptionalBeanByType(ListableBeanFactory beanFactory, Class beanType) {
// Issue : https://github.com/alibaba/spring-context-support/issues/20
String[] beanNames = BeanFactoryUtils.beanNamesForTypeIncludingAncestors(beanFactory, beanType, true, false);
if (beanNames == null || beanNames.length == 0) {
return null;
} else if (beanNames.length > 1) {
throw new NoUniqueBeanDefinitionException(beanType, Arrays.asList(beanNames));
}
return (T) beanFactory.getBean(beanNames[0]);
}
public static T getBean(ListableBeanFactory beanFactory, String beanName, Class beanType) throws BeansException {
return beanFactory.getBean(beanName, beanType);
}
/**
* Get beans by names and type
*
* @param beanFactory
* @param beanNames
* @param beanType
* @param
* @return
*/
public static List getBeans(ListableBeanFactory beanFactory, String[] beanNames, Class beanType) throws BeansException {
if (isEmpty(beanNames)) {
return emptyList();
}
List beans = new ArrayList(beanNames.length);
for (String beanName : beanNames) {
T bean = getBean(beanFactory, beanName, beanType);
if (bean != null) {
beans.add(bean);
}
}
return unmodifiableList(beans);
}
}