当前位置:首页>行业
答疑解惑:解释在Mybatis-Spring下@Mapper与@MapperScan为何不能同时生效以及实现动态条件注册Mapper接口
2023-08-24 06:03:36
来源:博客园


(资料图片)

若项目中使用了@MapperScan注解后,则@Mapper注解不再生效,原因是:@MapperScan注解 会执行@Import(MapperScannerRegistrar.class),而MapperScannerRegistrar又会注册MapperScannerConfigurer BEAN,在MapperScannerConfigurer BEAN中会完成基于配置的包目录扫描注册所有mapper interface代理BEAN,而@Mapper注解的生效是由org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration.MapperScannerRegistrarNotFoundConfiguration 配置BEAN类执行@Import(AutoConfiguredMapperScannerRegistrar.class),在AutoConfiguredMapperScannerRegistrar中会扫描所有@Mapper注解的mapper interface并注册为代理BEAN,但在执行@Import(AutoConfiguredMapperScannerRegistrar.class)时有一个前提,那就是@ConditionalOnMissingBean({ MapperFactoryBean.class, MapperScannerConfigurer.class })【即:在没有MapperFactoryBean 或 MapperScannerConfigurer】时才会执行,由于MapperScannerRegistrarNotFoundConfiguration 是MybatisAutoConfiguration 配置BEAN的子类,所以MapperScannerRegistrarNotFoundConfiguration 会晚于@MapperScan标记的顶级类,故正常情况下一旦使用了@MapperScan注解后,由于MapperScannerConfigurer BEAN已注册,那么MapperScannerRegistrarNotFoundConfiguration 上的@Import(AutoConfiguredMapperScannerRegistrar.class)将不会被执行。

另外要实现动态条件注册Mapper接口,我们只需要在mapper interface上加上@Conditional(...) 条件注解即可,原理是:不论是@MapperScan 或是@Mapper 最终都是使用ClassPathMapperScanner.scan完成扫描并注册成BEAN的,而在scan过程中又会支持较多的TypeFilter,以及在确定候选组件时(org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider#scanCandidateComponents)又会进行条件判断(即:org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider#isConditionMatch),判断是否可以跳过(即:org.springframework.context.annotation.ConditionEvaluator#shouldSkip),在shouldSkip方法中会又会判断是否为Conditional注解,若是则会执行Condition#matches 进行匹配,若返回true则表示符合要求不跳过(即:候选的BEAN),否则跳过,如此即实现了动态条件注册Mapper接口代理BEAN的功能。

关键词:

相关文章