org.apache.dubbo.config.spring.beans.factory.annotation.AbstractAnnotationConfigBeanBuilder 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.beans.factory.annotation;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.dubbo.config.AbstractInterfaceConfig;
import org.apache.dubbo.config.ApplicationConfig;
import org.apache.dubbo.config.ModuleConfig;
import org.apache.dubbo.config.MonitorConfig;
import org.apache.dubbo.config.RegistryConfig;
import org.springframework.context.ApplicationContext;
import org.springframework.util.Assert;
import java.lang.annotation.Annotation;
import java.util.List;
import static org.apache.dubbo.config.spring.util.DubboBeanUtils.getBeans;
import static org.apache.dubbo.config.spring.util.DubboBeanUtils.getOptionalBean;
/**
* Abstract Configurable {@link Annotation} Bean Builder
*
* @since 2.5.7
* @deprecated use {@link AnnotatedInterfaceConfigBeanBuilder}
*/
@Deprecated
abstract class AbstractAnnotationConfigBeanBuilder {
protected final Log logger = LogFactory.getLog(getClass());
protected final A annotation;
protected final ApplicationContext applicationContext;
protected final ClassLoader classLoader;
protected Object bean;
protected Class interfaceClass;
protected AbstractAnnotationConfigBeanBuilder(A annotation, ClassLoader classLoader,
ApplicationContext applicationContext) {
Assert.notNull(annotation, "The Annotation must not be null!");
Assert.notNull(classLoader, "The ClassLoader must not be null!");
Assert.notNull(applicationContext, "The ApplicationContext must not be null!");
this.annotation = annotation;
this.applicationContext = applicationContext;
this.classLoader = classLoader;
}
/**
* Build {@link B}
*
* @return non-null
* @throws Exception
*/
public final B build() throws Exception {
checkDependencies();
B bean = doBuild();
configureBean(bean);
if (logger.isInfoEnabled()) {
logger.info("The bean[type:" + bean.getClass().getSimpleName() + "] has been built.");
}
return bean;
}
private void checkDependencies() {
}
/**
* Builds {@link B Bean}
*
* @return {@link B Bean}
*/
protected abstract B doBuild();
protected void configureBean(B bean) throws Exception {
preConfigureBean(annotation, bean);
configureRegistryConfigs(bean);
configureMonitorConfig(bean);
configureApplicationConfig(bean);
configureModuleConfig(bean);
postConfigureBean(annotation, bean);
}
protected abstract void preConfigureBean(A annotation, B bean) throws Exception;
private void configureRegistryConfigs(B bean) {
String[] registryConfigBeanIds = resolveRegistryConfigBeanNames(annotation);
List registryConfigs = getBeans(applicationContext, registryConfigBeanIds, RegistryConfig.class);
bean.setRegistries(registryConfigs);
}
private void configureMonitorConfig(B bean) {
String monitorBeanName = resolveMonitorConfigBeanName(annotation);
MonitorConfig monitorConfig = getOptionalBean(applicationContext, monitorBeanName, MonitorConfig.class);
bean.setMonitor(monitorConfig);
}
private void configureApplicationConfig(B bean) {
String applicationConfigBeanName = resolveApplicationConfigBeanName(annotation);
ApplicationConfig applicationConfig =
getOptionalBean(applicationContext, applicationConfigBeanName, ApplicationConfig.class);
bean.setApplication(applicationConfig);
}
private void configureModuleConfig(B bean) {
String moduleConfigBeanName = resolveModuleConfigBeanName(annotation);
ModuleConfig moduleConfig =
getOptionalBean(applicationContext, moduleConfigBeanName, ModuleConfig.class);
bean.setModule(moduleConfig);
}
/**
* Resolves the bean name of {@link ModuleConfig}
*
* @param annotation {@link A}
* @return
*/
protected abstract String resolveModuleConfigBeanName(A annotation);
/**
* Resolves the bean name of {@link ApplicationConfig}
*
* @param annotation {@link A}
* @return
*/
protected abstract String resolveApplicationConfigBeanName(A annotation);
/**
* Resolves the bean ids of {@link RegistryConfig}
*
* @param annotation {@link A}
* @return non-empty array
*/
protected abstract String[] resolveRegistryConfigBeanNames(A annotation);
/**
* Resolves the bean name of {@link MonitorConfig}
*
* @param annotation {@link A}
* @return
*/
protected abstract String resolveMonitorConfigBeanName(A annotation);
/**
* Configures Bean
*
* @param annotation
* @param bean
*/
protected abstract void postConfigureBean(A annotation, B bean) throws Exception;
public > T bean(Object bean) {
this.bean = bean;
return (T) this;
}
public > T interfaceClass(Class interfaceClass) {
this.interfaceClass = interfaceClass;
return (T) this;
}
}