org.beetl.sql.ext.spring.BeetlSqlClassPathScanner Maven / Gradle / Ivy

Go to download
package org.beetl.sql.ext.spring;

import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.config.RuntimeBeanReference;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.GenericBeanDefinition;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.core.type.filter.TypeFilter;

import java.io.IOException;
import java.util.Arrays;
import java.util.Set;

/**
 * 对指定的BeetlSql的基础包中对应的Mapper接口进行扫描
 *
 * @author woate
 */

public class BeetlSqlClassPathScanner extends ClassPathBeanDefinitionScanner {
	/**
	 * 这用于指定SqlManagerFactoryBean的名称，利用Spring Bean机制自动创建
	 */
	String sqlManagerFactoryBeanName;

	String suffix;

	public BeetlSqlClassPathScanner(BeanDefinitionRegistry registry) {
		super(registry, false);
	}

	public void registerFilters() {
		addIncludeFilter(new TypeFilter() {
			@Override
			public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
					throws IOException {
				String className = metadataReader.getClassMetadata().getClassName();
//				metadataReader.getAnnotationMetadata().getAnnotationTypes()
				// 这里设置包含条件
				return className.endsWith(suffix);
			}
		});
		addExcludeFilter(new TypeFilter() {
			@Override
			public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
					throws IOException {
				String className = metadataReader.getClassMetadata().getClassName();
				return className.endsWith("package-info");
			}
		});
	}

	@Override
	protected Set doScan(String... basePackages) {
		Set beanDefinitions = super.doScan(basePackages);
		// 如果指定的基础包路劲中不存在任何类对象，则提示
		if (beanDefinitions.isEmpty()) {
			logger.warn("BeetlSql没有在 '" + Arrays.toString(basePackages) + "' 包中找到任何Mapper，请检查配置");
		} else {
			processBeanDefinitions(beanDefinitions);
		}
		return beanDefinitions;
	}

	/**
	 * 重新父类的判断是否能够实例化的组件
	 *
	 * @param beanDefinition
	 * @return
	 */
	@Override
	protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
		// 原方法这里不是判断是否为接口和是不依赖
		return beanDefinition.getMetadata().isInterface() && beanDefinition.getMetadata().isIndependent();
	}

	/**
	 * 对扫描到的含有BeetlSqlFactoryBean的Bean描述信息进行遍历
	 *
	 * @param beanDefinitions
	 */
	void processBeanDefinitions(Set beanDefinitions) {
		GenericBeanDefinition definition;
		for (BeanDefinitionHolder holder : beanDefinitions) {
			logger.debug(holder.toString());
			definition = (GenericBeanDefinition) holder.getBeanDefinition();
			String mapperClassName = definition.getBeanClassName();
			// 必须在这里加入泛型限定，要不然在spring下会有循环引用的问题
			definition.getConstructorArgumentValues().addGenericArgumentValue(mapperClassName);
			definition.getPropertyValues().add("mapperInterface", mapperClassName);
			// 根据工厂的名称创建出SqlManager
			definition.getPropertyValues().add("sqlManager", new RuntimeBeanReference(this.sqlManagerFactoryBeanName));
			definition.setBeanClass(BeetlSqlMapperFactoryBean.class);
			// 设置Mapper按照接口组装
			definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
			if (logger.isDebugEnabled()) {
				logger.debug("已开启BeetSql自动按照类型注入 '" + holder.getBeanName() + "'.");
			}

		}
	}

	public String getSqlManagerFactoryBeanName() {
		return sqlManagerFactoryBeanName;
	}

	public void setSqlManagerFactoryBeanName(String sqlManagerFactoryBeanName) {
		this.sqlManagerFactoryBeanName = sqlManagerFactoryBeanName;
	}

	public String getSuffix() {
		return suffix;
	}

	public void setSuffix(String suffix) {
		this.suffix = suffix;
	}
}