tk.mybatis.spring.mapper

Class ClassPathMapperScanner

java.lang.Object

org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

org.springframework.context.annotation.ClassPathBeanDefinitionScanner

tk.mybatis.spring.mapper.ClassPathMapperScanner

All Implemented Interfaces:

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.

Since:

1.2.0

Author:

Hunter Presnall, Eduardo Macarron

See Also:

MapperFactoryBean

Field Summary

Fields inherited from class org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

logger

Constructor Summary

Constructors

Constructor and Description
ClassPathMapperScanner(org.springframework.beans.factory.support.BeanDefinitionRegistry registry)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkCandidate(String beanName, org.springframework.beans.factory.config.BeanDefinition beanDefinition)
Set<org.springframework.beans.factory.config.BeanDefinitionHolder>	doScan(String... basePackages) Calls the parent search that will search and register all the candidates.
MapperHelper	getMapperHelper()
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(Class<? extends Annotation> annotationClass)
void	setConfig(Config config) 配置通用 Mapper
void	setMapperFactoryBean(MapperFactoryBean<?> mapperFactoryBean)
void	setMapperHelper(MapperHelper mapperHelper)
void	setMapperHelperBeanName(String mapperHelperBeanName)
void	setMapperProperties(org.springframework.core.env.Environment environment) 从环境变量中获取 mapper 配置信息
void	setMapperProperties(String[] properties) 从 properties 数组获取 mapper 配置信息
void	setMarkerInterface(Class<?> markerInterface)
void	setSqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)
void	setSqlSessionFactoryBeanName(String sqlSessionFactoryBeanName)
void	setSqlSessionTemplate(org.mybatis.spring.SqlSessionTemplate sqlSessionTemplate)
void	setSqlSessionTemplateBeanName(String sqlSessionTemplateBeanName)

Methods inherited from class org.springframework.context.annotation.ClassPathBeanDefinitionScanner

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

Methods inherited from class org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathMapperScanner

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

Method Detail

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 Set<org.springframework.beans.factory.config.BeanDefinitionHolder> doScan(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

Overrides:

doScan in class org.springframework.context.annotation.ClassPathBeanDefinitionScanner

isCandidateComponent

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

Overrides:

isCandidateComponent in class org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

checkCandidate

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

Overrides:

checkCandidate in class org.springframework.context.annotation.ClassPathBeanDefinitionScanner

getMapperHelper

public MapperHelper getMapperHelper()

setMapperHelper

public void setMapperHelper(MapperHelper mapperHelper)

setAddToConfig

public void setAddToConfig(boolean addToConfig)

setAnnotationClass

public void setAnnotationClass(Class<? extends Annotation> annotationClass)

setConfig

public void setConfig(Config config)

配置通用 Mapper

Parameters:

config -

setMapperFactoryBean

public void setMapperFactoryBean(MapperFactoryBean<?> mapperFactoryBean)

setMapperHelperBeanName

public void setMapperHelperBeanName(String mapperHelperBeanName)

setMapperProperties

public void setMapperProperties(org.springframework.core.env.Environment environment)

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

Parameters:

environment -

setMapperProperties

public void setMapperProperties(String[] properties)

从 properties 数组获取 mapper 配置信息

Parameters:

properties -

setMarkerInterface

public void setMarkerInterface(Class<?> markerInterface)

setSqlSessionFactory

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

setSqlSessionFactoryBeanName

public void setSqlSessionFactoryBeanName(String sqlSessionFactoryBeanName)

setSqlSessionTemplate

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

setSqlSessionTemplateBeanName

public void setSqlSessionTemplateBeanName(String sqlSessionTemplateBeanName)