com.alibaba.nacos.spring.beans.factory.annotation.AbstractNacosServiceBeanBuilder Maven / Gradle / Ivy

Go to download
/*
 * 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 com.alibaba.nacos.spring.beans.factory.annotation;

import static com.alibaba.nacos.spring.util.NacosBeanUtils.getNacosServiceFactoryBean;
import static com.alibaba.spring.util.ClassUtils.resolveGenericType;
import static java.lang.String.format;
import static org.springframework.core.annotation.AnnotationUtils.getAnnotationAttributes;

import java.util.Map;
import java.util.Properties;

import org.springframework.beans.factory.BeanCreationException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;

import com.alibaba.nacos.api.annotation.NacosProperties;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.spring.factory.NacosServiceFactory;
import com.alibaba.nacos.spring.util.GlobalNacosPropertiesSource;
import com.alibaba.nacos.spring.util.NacosUtils;

/**
 * Abstract Nacos Service Bean Builder
 *
 * @param  Nacos Service type
 * @author Mercy
 * @since 0.1.0
 */
public abstract class AbstractNacosServiceBeanBuilder
		implements BeanFactoryAware, EnvironmentAware {

	private final Class type;
	private final GlobalNacosPropertiesSource source;
	private BeanFactory beanFactory;
	private Environment environment;

	protected AbstractNacosServiceBeanBuilder(GlobalNacosPropertiesSource source) {
		type = resolveGenericType(getClass());
		this.source = source;
	}

	public S build(NacosProperties nacosProperties) {
		return build(getAnnotationAttributes(nacosProperties));
	}

	public S build(Map nacosPropertiesAttributes) {

		NacosServiceFactory nacosServiceFactory = getNacosServiceFactoryBean(beanFactory);
		Properties properties = resolveProperties(nacosPropertiesAttributes);

		if (properties.isEmpty()) {
			throw new BeanCreationException(
					format("The @%s attributes must be configured",
							NacosProperties.class.getSimpleName()));
		}

		try {
			return createService(nacosServiceFactory, properties);
		}
		catch (NacosException e) {
			throw new BeanCreationException(e.getErrMsg(), e);
		}
	}

	/**
	 * Subtype would implement this method to create target Nacos Service
	 *
	 * @param nacosServiceFactory {@link NacosServiceFactory}
	 * @param properties {@link Properties}
	 * @return target Nacos Service instance
	 * @throws NacosException When Nacos Service creation is failed
	 */
	protected abstract S createService(NacosServiceFactory nacosServiceFactory,
			Properties properties) throws NacosException;

	/**
	 * Resolve Nacos {@link Properties} from {@link NacosProperties @NacosProperties}
	 *
	 * @param nacosProperties {@link NacosProperties @NacosProperties}
	 * @return non-null
	 */
	public final Properties resolveProperties(NacosProperties nacosProperties) {
		Properties globalNacosProperties = resolveGlobalNacosProperties();
		return NacosUtils.resolveProperties(nacosProperties, environment,
				globalNacosProperties);
	}

	/**
	 * Resolve Nacos {@link Properties} from {@link NacosProperties @NacosProperties}
	 *
	 * @param nacosPropertiesAttributes {@link NacosProperties Nacos Properties}'s
	 *     attributes
	 * @return non-null
	 */
	public final Properties resolveProperties(
			Map nacosPropertiesAttributes) {
		Properties globalNacosProperties = resolveGlobalNacosProperties();
		return NacosUtils.resolveProperties(nacosPropertiesAttributes, environment,
				globalNacosProperties);
	}

	private Properties resolveGlobalNacosProperties() {
		return source.getMergedGlobalProperties(beanFactory);
	}

	final Class getType() {
		return type;
	}

	@Override
	public void setBeanFactory(BeanFactory beanFactory) {
		this.beanFactory = beanFactory;
	}

	@Override
	public void setEnvironment(Environment environment) {
		this.environment = environment;
	}
}