广告
返回顶部
首页 > 资讯 > 后端开发 > Python >MyBatis中Mapper的注入问题详解
  • 154
分享到

MyBatis中Mapper的注入问题详解

2024-04-02 19:04:59 154人浏览 薄情痞子

Python 官方文档:入门教程 => 点击学习

摘要

在 SpringBoot 体系中,mybatis 对 Mapper 的注入常见的方式我知道的有 2 种: 1、@MapperScan MapperScan 类是 mybatis-sp

SpringBoot 体系中,mybatis 对 Mapper 的注入常见的方式我知道的有 2 种:

1、@MapperScan

MapperScan 类是 mybatis-spring 包里面的。

通过在启动类上使用 @MapperScan,然后通过 basePackages 属性指定 Mapper 文件所在的目录来进行扫描装载,默认情况下指定目录下的所有.java文件都会被当做 Mapper 来加载处理。


@MapperScan(basePackages = "com.test.springboot.mapper")
@ServletComponentScan(basePackages = "com.test.springboot.filters")
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

可以看到,在 MapperScan 注解上有使用了 @Import(MapperScannerReGIStrar.class) ,也就是把MapperScannerRegistrar 当做配置类注入 Spring 容器


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

MapperScannerRegistrar 类是一个 ImportBeanDefinitionRegistrar 的实现,会在创建注入 Spring 容器后,被 Spring 主动触发。其重载的方法主要是创建并注册了一个 MapperScannerConfigurer 类型的 registry,这个 registry 主要就是去指定的 basePackages目录扫描指定的文件,并将其装载成 BeanDefinition 注入 Spring 容器。


public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {}

@Override
  public void registerBeanDefinitions(AnnotationMetadata importinGClaSSMetadata, BeanDefinitionRegistry registry) {
    AnnotationAttributes mapperScanAttrs = AnnotationAttributes
        .fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));
    if (mapperScanAttrs != null) {
      registerBeanDefinitions(importingClassMetadata, mapperScanAttrs, registry,
          generateBaseBeanName(importingClassMetadata, 0));
    }
  }

  void registerBeanDefinitions(AnnotationMetadata annoMeta, AnnotationAttributes annoAttrs,
      BeanDefinitionRegistry registry, String beanName) {

    BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
    builder.addPropertyValue("processPropertyPlaceHolders", true);

    Class<? extends Annotation> annotationClass = annoAttrs.getClass("annotationClass");
    if (!Annotation.class.equals(annotationClass)) {
      builder.addPropertyValue("annotationClass", annotationClass);
    }
  // ...
  }

下面是MapperScannerConfigurer 的主要实现,其主要依赖于 ClassPathMapperScanner 来实现扫面,在 MapperScan 指定了 basePackages 的情况下,它只会扫描这个指定目录,否则可能就是扫描整个 classpath 了(就类似 SpringBoot 的完整扫描)。


@Override
  public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
    if (this.processPropertyPlaceHolders) {
      processPropertyPlaceHolders();
    }

    ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
    scanner.setAddToConfig(this.addToConfig);
    scanner.setAnnotationClass(this.annotationClass);
    scanner.setMarkerInterface(this.markerInterface);
    scanner.setsqlSessionFactory(this.sqlSessionFactory);
    scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
    scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);
    scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
    scanner.setResourceLoader(this.applicationContext);
    scanner.setBeanNameGenerator(this.nameGenerator);
    scanner.setMapperFactoryBeanClass(this.mapperFactoryBeanClass);
    if (StringUtils.hasText(lazyInitialization)) {
      scanner.setLazyInitialization(Boolean.valueOf(lazyInitialization));
    }
    if (StringUtils.hasText(defaultScope)) {
      scanner.setDefaultScope(defaultScope);
    }
    scanner.registerFilters();
    scanner.scan(
        StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
  }

在 ClassPathMapperScanner 的实现中,我们可以看到他会把扫描到的目标类(比如用 @Mapper 注解的类 xxxMapper.java)的 BeanDefinition 的 beanClass 设置为 MapperFactoryBean,后续根据 BeanDefinition 创建的 Bean 也就是 MapperFactoryBean 的类型了。因为MapperFactoryBean 是一个工厂类,那么在 SpringBoot 要对 xxxMapper 实例化的时候,它会判断到 xxxMapper 对应的 Bean 是一个工厂类,然后会去调用 它的 getObject 方法创建 xxxMapper.java 的实例(当然这里肯定是个代理类)。


private Class<? extends MapperFactoryBean> mapperFactoryBeanClass = MapperFactoryBean.class;

  public void setMapperFactoryBeanClass(Class<? extends MapperFactoryBean> mapperFactoryBeanClass) {
    this.mapperFactoryBeanClass = mapperFactoryBeanClass == null ? MapperFactoryBean.class : mapperFactoryBeanClass;
  }

  
  @Override
  public Set<BeanDefinitionHolder> doScan(String... basePackages) {
    Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);

    if (beanDefinitions.isEmpty()) {
      LOGGER.warn(() -> "No MyBatis mapper was found in '" + Arrays.toString(basePackages)
          + "' package. Please check your configuration.");
    } else {
      processBeanDefinitions(beanDefinitions);
    }

    return beanDefinitions;
  }

  private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
    AbstractBeanDefinition definition;
    BeanDefinitionRegistry registry = getRegistry();
    for (BeanDefinitionHolder holder : beanDefinitions) {
      definition = (AbstractBeanDefinition) holder.getBeanDefinition();
          // ...    String beanClassName = definition.getBeanClassName();
      definition.setBeanClass(this.mapperFactoryBeanClass);

      definition.getPropertyValues().add("addToConfig", this.addToConfig);

      // Attribute for MockitoPostProcessor
      // https://GitHub.com/mybatis/spring-boot-starter/issues/475
      definition.setAttribute(FACTORY_BEAN_OBJECT_TYPE, beanClassName);

      // ...if (ConfigurableBeanFactory.SCOPE_SINGLETON.equals(definition.getScope()) && defaultScope != null) {
        definition.setScope(defaultScope);
      }

      if (!definition.isSingleton()) {
        BeanDefinitionHolder proxyHolder = ScopedProxyUtils.createScopedProxy(holder, registry, true);
        if (registry.containsBeanDefinition(proxyHolder.getBeanName())) {
          registry.removeBeanDefinition(proxyHolder.getBeanName());
        }
        registry.registerBeanDefinition(proxyHolder.getBeanName(), proxyHolder.getBeanDefinition());
      }

    }
  }

 @Override
  public T getObject() throws Exception {
    return getSqlSession().getMapper(this.mapperInterface);
  }

getObject 方法内部是先获取它的 SqlSessionTemplate 实例,然后根据 mapperInterface(这个是 xxxMapper.java 的全限定名)去获取 xxxMapper 对应的 MapperProxy 实例,然后对 xxxMapper 类的方法调用都会因为代理而一步步转到 MapperProxy -> SqlSessionTemplate -> sqlSessionProxy(一个 SqlSession 的代理实例)上去执行。

2、@Mapper

Mapper 类是 mybatis 包里面的。

单纯只在类上加 @Mapper 的注解肯定是没用的,这里我们还需要另外一个官方项目mybatis-spring-boot-autoconfigure 的协助了(这是个自动配置的项目,因此需要 SpringBoot 的支持,换一句话说就是项目还要另外再加入 Spring 官方的 spring-boot-configuration-processor 依赖),这样可以在只加了 @Mapper 注解的情况下让 Mapper文件顺利的被扫描和注入。

为了依赖使用的方便与统一,可以直接使用mybatis-spring-boot-starter依赖


<dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>${mybatis-spring.version}</version>
</dependency>

我们可以在mybatis-spring-boot-autoconfigure 依赖的 META-INF 目录下找到 spring.factories 的文件,这个是 SpringBoot 主动来扫描需要进行自动配置注入的目标文件。这里面可以看到后面的主角 MybatisAutoConfiguration 类,这个类加载了 Mybatis 的配置文件,声明依赖了一些 Bean等,然后也能找到它又通过 @Import 主动注入了一个叫AutoConfiguredMapperScannerRegistrar 的类。


# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisLanguageDriverAutoConfiguration,\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration

@org.springframework.context.annotation.Configuration
@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class })
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(MybatisProperties.class)
@AutoConfigureAfter({ DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class })
public class MybatisAutoConfiguration implements InitializingBean {    // ...
    @org.springframework.context.annotation.Configuration
    @Import(AutoConfiguredMapperScannerRegistrar.class)
    @ConditionalOnMissingBean({ MapperFactoryBean.class, MapperScannerConfigurer.class })
    public static class MapperScannerRegistrarNotFoundConfiguration implements InitializingBean {
      @Override
      public void afterPropertiesSet() {
        logger.debug(
            "Not found configuration for registering mapper bean using @MapperScan, MapperFactoryBean and MapperScannerConfigurer.");
      }
    }    // ...
}

注入的这个AutoConfiguredMapperScannerRegistrar 和前文的MapperScannerRegistrar有点类似,是一个扫描类的注册器。它在这里注册的也是MapperScannerConfigurer, 不同的是这里明确指定扫描的是带 Mapper 注解的文件,然后这里扫描的的 basePackage 是它自动获取的,实际就是启动类所在目录以及子目录。后面的扫描过程也就和方法一的后面是一样的了。


List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
// ...BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
builder.addPropertyValue("processPropertyPlaceHolders", true);
builder.addPropertyValue("annotationClass", Mapper.class);
builder.addPropertyValue("basePackage", StringUtils.collectionToCommaDelimitedString(packages));

MyBtatis 团队貌似更加推崇使用 @Mapper 的方式,因为他们在 AutoConfiguredMapperScannerRegistrar 的注释里面这么写道:这个方法会和 SpringBoot 一样,扫描的是同一个基础 pacakge。如果你想获得更多能力,那么你可以显式的使用 MapperScan 注解,但是 Mapper 注解的方式能使类型映射器正常的工作,开箱即用,就像是在使用 Spring Data JPA 库一样。

参考文章:

关于MyBatis的@Mapper和@MapperScan注解的一点思考

MapperFactoryBean的创建

MapperFactoryBean和MapperScannerConfigurer的作用和区别

到此这篇关于MyBatis中Mapper的注入的文章就介绍到这了,更多相关MyBatis Mapper注入内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: MyBatis中Mapper的注入问题详解

本文链接: https://www.lsjlt.com/news/135915.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • MyBatis中Mapper的注入问题详解
    在 SpringBoot 体系中,MyBatis 对 Mapper 的注入常见的方式我知道的有 2 种: 1、@MapperScan MapperScan 类是 mybatis-sp...
    99+
    2022-11-12
  • 解决mybatis中的mapper命名问题
    mybatis mapper命名问题 mapper文件中id命名最好首字母小写,避免让mybatis认为是一个类 <!--获取供应商列表--> <...
    99+
    2022-11-12
  • 解决springboot mapper注入报红问题
    目录springboot mapper注入报红在mapper接口上加上@Autowired自动注入时,mapper标红为什么会标红?解决方法springboot mapper注入报红...
    99+
    2022-11-12
  • Idea中mapper注入报错问题及解决
    目录Idea中mapper注入报错问题描述解决办法最终效果idea中Mapper接口无法自动注入报"Invalid bound statement (not found) ...
    99+
    2023-05-14
    Idea mapper注入报错 Idea mapper注入 mapper注入报错
  • 解决Mybatis中mapper的ID冲突问题
    mapper 的id冲突原因: 原因一: 在同一个mapper.xml中存在相同的ID 原因二: 同时使用了xml配置和注解配置 解决方案: 只保留xml或者注解即可!!! Myb...
    99+
    2022-11-12
  • Idea中mapper注入报错问题如何解决
    今天小编给大家分享一下Idea中mapper注入报错问题如何解决的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。Idea中ma...
    99+
    2023-07-05
  • 怎么解决mybatis中的mapper命名问题
    这篇文章主要介绍了怎么解决mybatis中的mapper命名问题,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。mybatis mapper命名问题mapper文件中id命名最...
    99+
    2023-06-15
  • springboot多模块化整合mybatis,mapper自动注入失败问题及解决
    目录springboot多模块化整合mybatis,mapper自动注入失败问题解决springboot mapper注入失败的一种原因具体情况是解决办法springboot多模块化...
    99+
    2022-11-12
  • 分析mybatis中@Mapper注解的componentModel属性
    本篇内容主要讲解“分析mybatis中@Mapper注解的componentModel属性”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“分析mybatis中@M...
    99+
    2022-10-19
  • Mybatis中怎么利用mapper解决ID冲突问题
    这篇文章给大家介绍Mybatis中怎么利用mapper解决ID冲突问题,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。mapper 的id冲突原因:原因一:在同一个mapper.xml中存在相同的ID原因二:同时使用了x...
    99+
    2023-06-15
  • Mybatis常用注解中的SQL注入实例详解
    目录前言常见注入场景2.1普通注解2.2 动态sql2.2.1 使用< script>2.2.2 使用Provider注解总结前言 MyBatis3提供了新的基于注解的配...
    99+
    2022-11-13
  • mybatis拦截器无法注入springbean的问题解决
    公司要整合rabbitmq与mybatis拦截器做一个数据同步功能。 整合过程中大部分环节都没什么问题,就是遇到了mybatis拦截器 @Intercepts(@Signature(...
    99+
    2022-11-13
  • mybatis使用${}时sql注入的问题怎么解决
    这篇文章给大家介绍mybatis使用${}时sql注入的问题怎么解决,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。mybatis使用${}时sql注入的问题最近在上线项目的时候,代码审查没有通过,提示有sql注入的风险...
    99+
    2023-06-22
  • 解决mybatis 执行mapper的方法时报空指针问题
    mybatis报空指针 今天在test类掉用service层往数据库存数据的时候,控制台报空指针异常。找了很久找不到原因。 解决 配置文件,注解,依赖都是对的。 最后发现是因为在te...
    99+
    2022-11-12
  • MyBatis通用Mapper中的通用example(排序)详解
    目录MyBatis通用Mapper的通用example(排序)接口实现类MyBatis通用Mapper技巧一、排序二、处理oracle的null异常三、mapper的selec...
    99+
    2022-11-12
  • 关于mybatis使用${}时sql注入的问题
    目录mybatis使用${}时sql注入的问题区别解决方法mybatis sql注入问题之$与#在mybatis中使用$符号在mybatis中使用#符号mybatis使用${}时sq...
    99+
    2022-11-12
  • 详解MyBatis批量插入数据Mapper配置文件的写法
    对于MyBatis配置文件的用法一直不是很熟悉,之前一直是使用注解来开发的,但是注解也有不好的地方就是如果数据库的表结构发生变化在代码中修改起来很麻烦。其实批量插入很简单,这里做些简要的说明。请看配置文件的写法:<insert id=...
    99+
    2023-05-31
    mybatis mapper pp
  • mybatis和mybatisplus批量插入问题示例详解
    目录1. 思路分析:2. rewriteBatchedStatements=true3.使用mybatis批量插入:4. 使用mybatisplus批量插入5业务场景一对多怎么处理:...
    99+
    2023-05-15
    mybatis批量插数据 mybatisplus批量插入 mybatis-plus批量insert
  • Mybatis的sql注释问题怎么解决
    这篇文章主要介绍“Mybatis的sql注释问题怎么解决”,在日常操作中,相信很多人在Mybatis的sql注释问题怎么解决问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”Mybatis的sql注释问题怎么解决...
    99+
    2023-07-02
  • 解决Mybatis映射文件mapper.xml中的注释问题
    目录Mybatis映射文件mapper.xml的注释问题报错信息解决办法mapper.xml文件中的注释注释方式‘无效的列索引’bug和解决小结一下Mybat...
    99+
    2022-11-12
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作