com.yixsoft.support.mybatis.spring.annotation

Annotation Type MapperScanner

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Import(value=MyBatisMapperScannerConfigurer.class)
public @interface MapperScanner

Will auto generate a MyBatisMapperScanner Create by davep at 2019-12-18 16:30

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Annotation>	annotationClass This property specifies the annotation that the scanner will search for.
String[]	basePackages Base packages to scan for MyBatis interfaces.
Class<?>	markerInterface This property specifies the parent that the scanner will search for.
Class<? extends org.springframework.beans.factory.support.BeanNameGenerator>	nameGenerator The BeanNameGenerator class to be used for naming detected components within the Spring container.
String	sqlSessionFactoryRef Specifies which SqlSessionFactory to use in the case that there is more than one in the spring context.
String	sqlSessionTemplateRef Specifies which SqlSessionTemplate to use in the case that there is more than one in the spring context.
String[]	value Alias for the basePackages() attribute.

Element Detail

value

public abstract String[] value

Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @MapperScanner("org.my.pkg") instead of @MapperScanner(basePackages= "org.my.pkg")}.

Returns:

packages to scan.

Default:

{}

basePackages

public abstract String[] basePackages

Base packages to scan for MyBatis interfaces. Note that only interfaces with at least one method will be registered; concrete classes will be ignored.

Returns:

packages to scan

Default:

{}

nameGenerator

public abstract Class<? extends org.springframework.beans.factory.support.BeanNameGenerator> nameGenerator

The BeanNameGenerator class to be used for naming detected components within the Spring container.

Returns:

custom bean name generator class

Default:

org.springframework.beans.factory.support.BeanNameGenerator.class

annotationClass

public abstract Class<? extends Annotation> annotationClass

This property specifies the annotation that the scanner will search for.

The scanner will register all interfaces in the base package that also have the specified annotation.

Note this can be combined with markerInterface.

Returns:

custom annotation class to scan

Default:

java.lang.annotation.Annotation.class

markerInterface

public abstract Class<?> markerInterface

This property specifies the parent that the scanner will search for.

The scanner will register all interfaces in the base package that also have the specified interface class as a parent.

Note this can be combined with annotationClass.

Returns:

customer parent interface class to scan

Default:

java.lang.Class.class

sqlSessionTemplateRef

public abstract String sqlSessionTemplateRef

Specifies which SqlSessionTemplate to use in the case that there is more than one in the spring context. Usually this is only needed when you have more than one datasource.

Returns:

sqlSessionTemplate bean name, leave empty if there is only one sqlSessionTemplate

Default:

""

sqlSessionFactoryRef

public abstract String sqlSessionFactoryRef

Specifies which SqlSessionFactory to use in the case that there is more than one in the spring context. Usually this is only needed when you have more than one datasource.

Returns:

sqlSessionFactory bean name, leave empty if there is only one sqlSessionFactory

Default:

""