Mybatis的mapper对象注入到Spring容器中的过程

灰太狼 2023-10-11 17:32 28阅读 0赞

*  整合的核心组件

1.  @MapperScan
2.  MapperScannerRegistrar
3.  ImportBeanDefinitionRegistrar
4.  ClassPathBeanDefinitionScanner
5.  FactoryBean

一、在SpringBoot与Mybatis整合的过程中，往往都会在启动类上标注@MapperScan注解，并指定basePackage。

@MapperScan(basePackages = "com.springmybatis.mapper")

这里的疑惑就是该注解并不是Spring提供的注解，为什么会被解析到？这是因为当Spring解析到一个配置Bean的时候，会进一步解析这个类上的其他注解，然后判断这个注解上没有被Spring的注解修饰，例如@Componet,@Import等。

二、Import注解导入类

@Retention(RetentionPolicy.RUNTIME)
    @Target({
        ElementType.TYPE})
    @Documented
    @Import({
        MapperScannerRegistrar.class})
    @Repeatable(MapperScans.class)
    public @interface MapperScan {
        }

发现这个注解导入了MapperScannerRegistrar，而这个类实现了ImportBeanDefinitionRegistrar接口,通常实现这个接口的类就是注解BeanDefinition的。且通过AnnotationMetadata metadata,还可以拿到@MapperScan注解所有的属性信息。

除此之外，还有通过实现BeanDefinitionRegistryPostProcessor接口，也可以给容器中手动注入一个bean。

@Component
    public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
        
        @Override
        public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        
            BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition();
            AbstractBeanDefinition beanDefinition = beanDefinitionBuilder.getBeanDefinition();
            beanDefinition.setBeanClass(OrderService.class);
            registry.registerBeanDefinition("oo",beanDefinition);
        }
    
        @Override
        public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        
        }
    }

三、通过register给容器中注册BeanDefinition信息

private void registerByClassPathFile(BeanDefinitionRegistry registry, String basePackages) {
        
            String basePackagesPath = basePackages.replaceAll("\\.", Matcher.quoteReplacement(File.separator));
            ClassPathResource cpr = new ClassPathResource(basePackagesPath);
            try {
        
                File file = cpr.getFile();
                for (File mapperFile : file.listFiles()) {
        
                    String name = mapperFile.getName().replaceAll(".class", "");
                    String classQualifiedName = basePackages + "." + name;
                    Class<?> mapperClass = Class.forName(classQualifiedName);
                    doRegister(registry,mapperClass);
                }
            } catch (Exception e) {
        
                e.printStackTrace();
            }
        }
    
        private void doRegister(BeanDefinitionRegistry registry, Class<?> mapperClass) {
        
            AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();
            beanDefinition.setBeanClass(MapperFactory.class);
            beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0,mapperClass);
            registry.registerBeanDefinition(mapperClass.getSimpleName(),beanDefinition);
        }

也可以使用spring提供的ClassPathBeanDefinitionScanner来扫描mapper接口指定的包

public class MybatisScanner extends ClassPathBeanDefinitionScanner {
        
    
        public MybatisScanner(BeanDefinitionRegistry registry) {
        
            super(registry);
        }
    
        @Override
        protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
        
            Set<BeanDefinitionHolder> beanDefinitionHolders = super.doScan(basePackages);
            for (BeanDefinitionHolder beanDefinitionHolder : beanDefinitionHolders) {
        
                BeanDefinition beanDefinition = beanDefinitionHolder.getBeanDefinition();
                //由于我们扫描的是接口，所以这里的beanDefinition中的beanClass是接口的class，修成此处的beanDefinition
                String beanClassName = beanDefinition.getBeanClassName();
                Class<?> mapperClass = null;
                try {
        
                    mapperClass = Class.forName(beanClassName);
                    beanDefinition.getConstructorArgumentValues()
                            .addIndexedArgumentValue(0,mapperClass);
                    beanDefinition.setBeanClassName(MapperFactory.class.getName());
                    super.getRegistry().registerBeanDefinition(mapperClass.getSimpleName(),beanDefinition);
                } catch (Exception e) {
        
                    e.printStackTrace();
                }
            }
            return beanDefinitionHolders;
        }
    
        //这里我们的这个扫描器，恰恰要扫描接口
        @Override
        protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
        
            return beanDefinition.getMetadata().isInterface();
        }
    }

这里需要重写doScan方法和isCandidateComponent方法，因为默认情况下spring会将接口过滤掉，只会扫描类，而mybatis恰恰是需要扫描接口。所以要重写isCandidateComponent，而重写doScan是因为spring扫描到的beanDefinttion中的beanclass都是接口类型，而此时需要借助FactoryBean来创建出mapper对象，此时先要通过 beanDefinition.getConstructorArgumentValues()  
.addIndexedArgumentValue(0,mapperClass);设置创建该bean的时候使用的构造方法传递的参数。  
然后再重新设置beanClass，指定为自定义的FactoryBean类型  
beanDefinition.setBeanClassName(MapperFactory.class.getName());

五、FactoryBean创建Mapper代理对象

public class MapperFactory implements FactoryBean {
        
    
        @Autowired
        private SqlSessionFactory sqlSessionFactory;
    
        private Class mapper;
        
        public MapperFactory(Class mapper){
        
            this.mapper = mapper;
        }
    
        @Override
        public Object getObject() throws Exception {
        
            sqlSessionFactory.getConfiguration().addMapper(mapper);
            Object m = sqlSessionFactory.openSession().getMapper(mapper);
            return m;
        }
    
        @Override
        public Class<?> getObjectType() {
        
            return mapper;
        }
    }