org.apache.dubbo.common.beans.factory.ScopeBeanFactory 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.common.beans.factory;
import org.apache.dubbo.common.beans.ScopeBeanException;
import org.apache.dubbo.common.beans.support.InstantiationStrategy;
import org.apache.dubbo.common.extension.ExtensionAccessor;
import org.apache.dubbo.common.extension.ExtensionAccessorAware;
import org.apache.dubbo.common.extension.ExtensionPostProcessor;
import org.apache.dubbo.common.logger.ErrorTypeAwareLogger;
import org.apache.dubbo.common.logger.LoggerFactory;
import org.apache.dubbo.common.resource.Disposable;
import org.apache.dubbo.common.utils.StringUtils;
import org.apache.dubbo.rpc.model.ScopeModelAccessor;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Function;
import java.util.stream.Collectors;
import static org.apache.dubbo.common.constants.LoggerCodeConstants.CONFIG_FAILED_DESTROY_INVOKER;
/**
* A bean factory for internal sharing.
*/
public class ScopeBeanFactory {
protected static final ErrorTypeAwareLogger LOGGER = LoggerFactory.getErrorTypeAwareLogger(ScopeBeanFactory.class);
private final ScopeBeanFactory parent;
private ExtensionAccessor extensionAccessor;
private List extensionPostProcessors;
private Map beanNameIdCounterMap = new ConcurrentHashMap<>();
private List registeredBeanInfos = new CopyOnWriteArrayList<>();
private InstantiationStrategy instantiationStrategy;
private AtomicBoolean destroyed = new AtomicBoolean();
public ScopeBeanFactory(ScopeBeanFactory parent, ExtensionAccessor extensionAccessor) {
this.parent = parent;
this.extensionAccessor = extensionAccessor;
extensionPostProcessors = extensionAccessor.getExtensionDirector().getExtensionPostProcessors();
initInstantiationStrategy();
}
private void initInstantiationStrategy() {
for (ExtensionPostProcessor extensionPostProcessor : extensionPostProcessors) {
if (extensionPostProcessor instanceof ScopeModelAccessor) {
instantiationStrategy = new InstantiationStrategy((ScopeModelAccessor) extensionPostProcessor);
break;
}
}
if (instantiationStrategy == null) {
instantiationStrategy = new InstantiationStrategy();
}
}
public T registerBean(Class bean) throws ScopeBeanException {
return this.getOrRegisterBean(null, bean);
}
public T registerBean(String name, Class clazz) throws ScopeBeanException {
return getOrRegisterBean(name, clazz);
}
private T createAndRegisterBean(String name, Class clazz) {
checkDestroyed();
T instance = getBean(name, clazz);
if (instance != null) {
throw new ScopeBeanException("already exists bean with same name and type, name=" + name + ", type=" + clazz.getName());
}
try {
instance = instantiationStrategy.instantiate(clazz);
} catch (Throwable e) {
throw new ScopeBeanException("create bean instance failed, type=" + clazz.getName(), e);
}
registerBean(name, instance);
return instance;
}
public void registerBean(Object bean) {
this.registerBean(null, bean);
}
public void registerBean(String name, Object bean) {
checkDestroyed();
// avoid duplicated register same bean
if (containsBean(name, bean)) {
return;
}
Class beanClass = bean.getClass();
if (name == null) {
name = beanClass.getName() + "#" + getNextId(beanClass);
}
initializeBean(name, bean);
registeredBeanInfos.add(new BeanInfo(name, bean));
}
public T getOrRegisterBean(Class type) {
return getOrRegisterBean(null, type);
}
public T getOrRegisterBean(String name, Class type) {
T bean = getBean(name, type);
if (bean == null) {
// lock by type
synchronized (type) {
bean = getBean(name, type);
if (bean == null) {
bean = createAndRegisterBean(name, type);
}
}
}
return bean;
}
public T getOrRegisterBean(Class type, Function, ? extends T> mappingFunction) {
return getOrRegisterBean(null, type, mappingFunction);
}
public T getOrRegisterBean(String name, Class type, Function, ? extends T> mappingFunction) {
T bean = getBean(name, type);
if (bean == null) {
// lock by type
synchronized (type) {
bean = getBean(name, type);
if (bean == null) {
bean = mappingFunction.apply(type);
registerBean(name, bean);
}
}
}
return bean;
}
public T initializeBean(T bean) {
this.initializeBean(null, bean);
return bean;
}
private void initializeBean(String name, Object bean) {
checkDestroyed();
try {
if (bean instanceof ExtensionAccessorAware) {
((ExtensionAccessorAware) bean).setExtensionAccessor(extensionAccessor);
}
for (ExtensionPostProcessor processor : extensionPostProcessors) {
processor.postProcessAfterInitialization(bean, name);
}
} catch (Exception e) {
throw new ScopeBeanException("register bean failed! name=" + name + ", type=" + bean.getClass().getName(), e);
}
}
private boolean containsBean(String name, Object bean) {
for (BeanInfo beanInfo : registeredBeanInfos) {
if (beanInfo.instance == bean &&
(name == null || StringUtils.isEquals(name, beanInfo.name))) {
return true;
}
}
return false;
}
private int getNextId(Class beanClass) {
return beanNameIdCounterMap.computeIfAbsent(beanClass, key -> new AtomicInteger()).incrementAndGet();
}
public T getBean(Class type) {
return this.getBean(null, type);
}
public T getBean(String name, Class type) {
T bean = getBeanInternal(name, type);
if (bean == null && parent != null) {
return parent.getBean(name, type);
}
return bean;
}
private T getBeanInternal(String name, Class type) {
checkDestroyed();
// All classes are derived from java.lang.Object, cannot filter bean by it
if (type == Object.class) {
return null;
}
List candidates = null;
BeanInfo firstCandidate = null;
for (BeanInfo beanInfo : registeredBeanInfos) {
// if required bean type is same class/superclass/interface of the registered bean
if (type.isAssignableFrom(beanInfo.instance.getClass())) {
if (StringUtils.isEquals(beanInfo.name, name)) {
return (T) beanInfo.instance;
} else {
// optimize for only one matched bean
if (firstCandidate == null) {
firstCandidate = beanInfo;
} else {
if (candidates == null) {
candidates = new ArrayList<>();
candidates.add(firstCandidate);
}
candidates.add(beanInfo);
}
}
}
}
// if bean name not matched and only single candidate
if (candidates != null) {
if (candidates.size() == 1) {
return (T) candidates.get(0).instance;
} else if (candidates.size() > 1) {
List candidateBeanNames = candidates.stream().map(beanInfo -> beanInfo.name).collect(Collectors.toList());
throw new ScopeBeanException("expected single matching bean but found " + candidates.size() + " candidates for type [" + type.getName() + "]: " + candidateBeanNames);
}
} else if (firstCandidate != null) {
return (T) firstCandidate.instance;
}
return null;
}
public void destroy() {
if (destroyed.compareAndSet(false, true)) {
for (BeanInfo beanInfo : registeredBeanInfos) {
if (beanInfo.instance instanceof Disposable) {
try {
Disposable beanInstance = (Disposable) beanInfo.instance;
beanInstance.destroy();
} catch (Throwable e) {
LOGGER.error(CONFIG_FAILED_DESTROY_INVOKER, "", "", "An error occurred when destroy bean [name=" + beanInfo.name + ", bean=" + beanInfo.instance + "]: " + e, e);
}
}
}
registeredBeanInfos.clear();
}
}
private void checkDestroyed() {
if (destroyed.get()) {
throw new IllegalStateException("ScopeBeanFactory is destroyed");
}
}
static class BeanInfo {
private String name;
private Object instance;
public BeanInfo(String name, Object instance) {
this.name = name;
this.instance = instance;
}
}
}