com.flagwind.mybatis.spring.boot

类 ClassPathMapperScanner

java.lang.Object

org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

org.springframework.context.annotation.ClassPathBeanDefinitionScanner

com.flagwind.mybatis.spring.boot.ClassPathMapperScanner

所有已实现的接口:

org.springframework.beans.factory.Aware, org.springframework.context.ResourceLoaderAware, org.springframework.core.env.EnvironmentCapable

public class ClassPathMapperScanner
extends org.springframework.context.annotation.ClassPathBeanDefinitionScanner

A ClassPathBeanDefinitionScanner that registers Mappers by basePackage, annotationClass, or markerInterface. If an annotationClass and/or markerInterface is specified, only the specified types will be searched (searching for all interfaces will be disabled).

This functionality was previously a private class of MapperScannerConfigurer, but was broken out in version 1.2.0.

从以下版本开始:

1.2.0

作者:

Hunter Presnall, Eduardo Macarron

另请参阅:

MapperFactoryBean

字段概要

从类继承的字段 org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

logger

构造器概要

构造器

构造器和说明
ClassPathMapperScanner(org.springframework.beans.factory.support.BeanDefinitionRegistry registry)

方法概要

限定符和类型	方法和说明
protected boolean	checkCandidate(java.lang.String beanName, org.springframework.beans.factory.config.BeanDefinition beanDefinition)
java.util.Set<org.springframework.beans.factory.config.BeanDefinitionHolder>	doScan(java.lang.String... basePackages) Calls the parent search that will search and register all the candidates.
TemplateContext	getTemplateContext()
protected boolean	isCandidateComponent(org.springframework.beans.factory.annotation.AnnotatedBeanDefinition beanDefinition)
void	registerFilters() Configures parent scanner to search for the right interfaces.
void	setAddToConfig(boolean addToConfig)
void	setAnnotationClass(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
void	setConfig(Config config) 配置通用 Mapper
void	setMapperFactoryBean(MapperFactoryBean<?> mapperFactoryBean)
void	setMapperProperties(java.lang.String perfix, org.springframework.core.env.Environment environment) 从环境变量中获取 mapper 配置信息
void	setMapperProperties(java.lang.String prefix, java.lang.String[] properties) 从 properties 数组获取 mapper 配置信息
void	setMarkerInterface(java.lang.Class<?> markerInterface)
void	setSqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)
void	setSqlSessionFactoryBeanName(java.lang.String sqlSessionFactoryBeanName)
void	setSqlSessionTemplate(org.mybatis.spring.SqlSessionTemplate sqlSessionTemplate)
void	setSqlSessionTemplateBeanName(java.lang.String sqlSessionTemplateBeanName)
void	setTemplateContext(TemplateContext templateContext)
void	setTemplateContextBeanName(java.lang.String templateContextBeanName)

从类继承的方法 org.springframework.context.annotation.ClassPathBeanDefinitionScanner

getBeanDefinitionDefaults, getRegistry, isCompatible, postProcessBeanDefinition, registerBeanDefinition, scan, setAutowireCandidatePatterns, setBeanDefinitionDefaults, setBeanNameGenerator, setIncludeAnnotationConfig, setScopedProxyMode, setScopeMetadataResolver

从类继承的方法 org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

addExcludeFilter, addIncludeFilter, clearCache, findCandidateComponents, getEnvironment, getMetadataReaderFactory, getResourceLoader, isCandidateComponent, registerDefaultFilters, resetFilters, resolveBasePackage, setEnvironment, setMetadataReaderFactory, setResourceLoader, setResourcePattern

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ClassPathMapperScanner

public ClassPathMapperScanner(org.springframework.beans.factory.support.BeanDefinitionRegistry registry)

方法详细资料

getTemplateContext

public TemplateContext getTemplateContext()

setTemplateContext

public void setTemplateContext(TemplateContext templateContext)

registerFilters

public void registerFilters()

Configures parent scanner to search for the right interfaces. It can search for all interfaces or just for those that extends a markerInterface or/and those annotated with the annotationClass

doScan

public java.util.Set<org.springframework.beans.factory.config.BeanDefinitionHolder> doScan(java.lang.String... basePackages)

Calls the parent search that will search and register all the candidates. Then the registered objects are post processed to set them as MapperFactoryBeans

覆盖:

doScan 在类中 org.springframework.context.annotation.ClassPathBeanDefinitionScanner

isCandidateComponent

protected boolean isCandidateComponent(org.springframework.beans.factory.annotation.AnnotatedBeanDefinition beanDefinition)

覆盖:

isCandidateComponent 在类中 org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

checkCandidate

protected boolean checkCandidate(java.lang.String beanName,
                                 org.springframework.beans.factory.config.BeanDefinition beanDefinition)

覆盖:

checkCandidate 在类中 org.springframework.context.annotation.ClassPathBeanDefinitionScanner

setAddToConfig

public void setAddToConfig(boolean addToConfig)

setAnnotationClass

public void setAnnotationClass(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

setConfig

public void setConfig(Config config)

配置通用 Mapper

参数:

config -

setMapperFactoryBean

public void setMapperFactoryBean(MapperFactoryBean<?> mapperFactoryBean)

setTemplateContextBeanName

public void setTemplateContextBeanName(java.lang.String templateContextBeanName)

setMapperProperties

public void setMapperProperties(java.lang.String perfix,
                                org.springframework.core.env.Environment environment)

从环境变量中获取 mapper 配置信息

参数:

environment -

setMapperProperties

public void setMapperProperties(java.lang.String prefix,
                                java.lang.String[] properties)

从 properties 数组获取 mapper 配置信息

参数:

properties -

setMarkerInterface

public void setMarkerInterface(java.lang.Class<?> markerInterface)

setSqlSessionFactory

public void setSqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)

setSqlSessionFactoryBeanName

public void setSqlSessionFactoryBeanName(java.lang.String sqlSessionFactoryBeanName)

setSqlSessionTemplate

public void setSqlSessionTemplate(org.mybatis.spring.SqlSessionTemplate sqlSessionTemplate)

setSqlSessionTemplateBeanName

public void setSqlSessionTemplateBeanName(java.lang.String sqlSessionTemplateBeanName)