org.aoju.bus.spring.annotation

Annotation Type EnableMapper

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
 @Inherited
 @Import(value={MybatisConfiguration.class,MapperConfiguration.class,DruidConfiguration.class})
public @interface EnableMapper

开启 Mybatis/Mapper

Since:

JDK 1.8+

Version:

3.6.6

Author:

Kimi Liu

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Annotation>	annotationClass 此属性指定扫描器将搜索的注释。 扫描器将在基本包中注册所有接口指定的注释。 注意，这可以与markerInterface相结合。
String[]	basePackage 扫描MyBatis接口的基本包。注意，用户接口标记等
Class<?>[]	basePackageClass 类型安全替代basePackage()指定包扫描带注释的组件。将扫描指定的每个类的包。 考虑在每个包中创建一个特殊的标记类或接口
Class<? extends MapperFactoryBean>	factoryBean 指定自定义MapperFactoryBean以将MyBatis代理返回为SpringBean
String	mapperHelper 还可以直接配置一个 MapperHelper bean
Class<?>	markerInterface 此属性指定扫描程序将搜索的父级。 扫描器将注册基本包中也具有指定的接口类作为父级。 注意，可以与annotationClass结合使用。
Class<? extends org.springframework.beans.factory.support.BeanNameGenerator>	nameGenerator 用于命名检测到的组件的BeanNameGenerator类。
String[]	properties 通用 Mapper 的配置，一行一个配置
String	sqlSessionFactory 指定数据源信息,有多数据源时可使用或指定对应多 sqlSessionFactory。
String	sqlSessionTemplate 指定数据源信息,有多数据源时可使用或指定对应多 SqlSessionTemplate。
String[]	value basePackageClass()属性的别名。允许更简洁 注释声明，例如: @EnableMapper("org.aoju.pkg") @EnableMapper(basePackage = {"org.aoju.pkg"})

Element Detail

value

public abstract String[] value

basePackageClass()属性的别名。允许更简洁 注释声明，例如: @EnableMapper("org.aoju.pkg") @EnableMapper(basePackage = {"org.aoju.pkg"})

Returns:

the array

Default:

{}

basePackage

public abstract String[] basePackage

扫描MyBatis接口的基本包。注意，用户接口标记等

Returns:

the array

Default:

{}

basePackageClass

public abstract Class<?>[] basePackageClass

类型安全替代basePackage()指定包扫描带注释的组件。将扫描指定的每个类的包。 考虑在每个包中创建一个特殊的标记类或接口

Returns:

the object

Default:

{}

nameGenerator

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

用于命名检测到的组件的BeanNameGenerator类。

Returns:

the object

Default:

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

annotationClass

public abstract Class<? extends Annotation> annotationClass

此属性指定扫描器将搜索的注释。 扫描器将在基本包中注册所有接口指定的注释。 注意，这可以与markerInterface相结合。

Returns:

the object

Default:

java.lang.annotation.Annotation.class

markerInterface

public abstract Class<?> markerInterface

此属性指定扫描程序将搜索的父级。 扫描器将注册基本包中也具有指定的接口类作为父级。 注意，可以与annotationClass结合使用。

Returns:

the object

Default:

java.lang.Class.class

sqlSessionTemplate

public abstract String sqlSessionTemplate

指定数据源信息,有多数据源时可使用或指定对应多 SqlSessionTemplate。

Returns:

the string

Default:

""

sqlSessionFactory

public abstract String sqlSessionFactory

指定数据源信息,有多数据源时可使用或指定对应多 sqlSessionFactory。

Returns:

the string

Default:

""

factoryBean

public abstract Class<? extends MapperFactoryBean> factoryBean

指定自定义MapperFactoryBean以将MyBatis代理返回为SpringBean

Returns:

the object

Default:

org.aoju.bus.spring.mapper.MapperFactoryBean.class

properties

public abstract String[] properties

通用 Mapper 的配置，一行一个配置

Returns:

the string

Default:

{}

mapperHelper

public abstract String mapperHelper

还可以直接配置一个 MapperHelper bean

Returns:

the string

Default:

""