Mybatis实现【7】 --基于接口编程的原理

本文详细介绍了如何在Spring框架中整合MyBatis,通过使用MapperScannerConfigurer进行自动扫描和注册Mapper接口,以及如何通过MapperFactoryBean创建Mapper实例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >


MyBatis可以仅通过申明接口并在annotation上注明sql,即可省略配置文件的编写。

这里Mapper是不需要实现类,我们来探究下MyBatis是如何做这层代理的。

bean的注入

1、声明需要注入的包

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
       <!--basePackage指定要扫描的包,可指定多个包,包与包之间用逗号或分号分隔-->
       <property name="basePackage" value="com.cyou.fz.*.*.dao,com.cyou.fz.*.*.*.dao,com.cyou.fz.*.*.*.*.dao"/>
   </bean>

MapperScannerConfig类描述是:

//BeanDefinitionRegistryPostProcessor that searches recursively starting from a base package for
 * interfaces and registers them as MapperFactoryBean. Note that only interfaces with at
 * least one method will be registered; concrete classes will be ignored

MapperScannerConfigurer的Scanner类负责搜索basePackage类下所有的MapperClass并将其注册至spring的beanfinitionHolder中,其注册的classBean为MapperFactoryBean。

1.1、与Spring框架整合注入Bean

MapperScannerConfigurer通过BeanDefinitionRegistryPostProcessor并实现postProcessBeanDefinitionRegistry(...)方法,在Spring初始化时候将Bean及该Bean的一些属性信息(scope、className、beanName等)保存至BeanDefinitionHolder中。

public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
   if (this.processPropertyPlaceHolders) {
     processPropertyPlaceHolders();
   }

   ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
   //...
   scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
 }

实际上调用ClassPathMapperScanner的doscan()方法扫描包并注册

public Set<BeanDefinitionHolder> doScan(String... basePackages) {
    //在super.doScan()中将所有Mapper接口的class注册至BeanDefinitionHolder并放回一个set对象
    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 {
      for (BeanDefinitionHolder holder : beanDefinitions) {
        GenericBeanDefinition definition = (GenericBeanDefinition) holder.getBeanDefinition();

        if (logger.isDebugEnabled()) {
          logger.debug("Creating MapperFactoryBean with name '" + holder.getBeanName() 
              + "' and '" + definition.getBeanClassName() + "' mapperInterface");
        }

        // the mapper interface is the original class of the bean
        // but, the actual class of the bean is MapperFactoryBean
        definition.getPropertyValues().add("mapperInterface", definition.getBeanClassName());
        definition.setBeanClass(MapperFactoryBean.class);

        ///...
    return beanDefinitions;
  }

MapperFactoryBean直接实现了Spring的FactoryBean及InitializingBean接口,作为专门生产Mapper实例的工厂

1.2、通过MapperFactoryBean获取Mapper实例

1.2.1、在创建Mapper实例时,首先在MapperFactoryBean中执行afterPropertiesSet():

public final void afterPropertiesSet() throws IllegalArgumentException, BeanInitializationException {
        // Let abstract subclasses check their configuration.
        checkDaoConfig();

        //...
    }

checkDaoConfig()如下:

//检测当前需要创建的mapperInterface在Configuration中是否存在,不存在则添加
protected void checkDaoConfig() {
    super.checkDaoConfig();

    notNull(this.mapperInterface, "Property 'mapperInterface' is required");

    Configuration configuration = getSqlSession().getConfiguration();
    if (this.addToConfig && !configuration.hasMapper(this.mapperInterface)) {
      try {
        configuration.addMapper(this.mapperInterface);
      } catch (Throwable t) {
        logger.error("Error while adding the mapper '" + this.mapperInterface + "' to configuration.", t);
        throw new IllegalArgumentException(t);
      } finally {
        ErrorContext.instance().reset();
      }
    }
  }

1.2.2、获取Mapper实例

在执行完afterPropertiesSet()方法后,执行getObject()方法来获得Mapper实例:

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

通过调用链,最终调用MapperRegistry的getMapper()方法:

public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
  //这里的knowMappers保存之前afterPropertiesSet中保存进来的mapperInterface
  final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
  if (mapperProxyFactory == null)
    throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
  try {
    return mapperProxyFactory.newInstance(sqlSession);
  } catch (Exception e) {
    throw new BindingException("Error getting mapper instance. Cause: " + e, e);
  }
}

在mapperProxyFactory的newInstance中:

public T newInstance(SqlSession sqlSession) {
   final MapperProxy<T> mapperProxy = new MapperProxy<T>(sqlSession, mapperInterface, methodCache);
   return newInstance(mapperProxy);
 }
protected T newInstance(MapperProxy<T> mapperProxy) {
   return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
 }

这里创建了MapperProxy对象。并与“Mybatis实现【4】”中查询的执行过程对接起来。


该系列文章参考如下书籍及文章:

《Java Persistence with MyBatis 》

《http://www.cnblogs.com/hzhuxin/p/3349836.html》

《http://www.iteye.com/topic/1112327》

《http://www.iteye.com/blogs/subjects/mybatis_internals》

《http://denger.me/2011/05/mybatis-and-spring-interface-integrated/》




















### MyBatis-Plus 实现原理与源码解析 #### 一、基础架构概述 MyBatis-Plus 是基于 MyBatis 构建的一个简化持久层开发的增强工具,它不仅继承了 MyBatis 的核心特性还在此之上进行了多方面的强化。主要增强了代码生成、条件构造器等功能[^1]。 #### 二、代码生成机制 为了减少重复劳动并提升效率,MyBatis-Plus 提供了一套强大的代码生成功能。该模块能够自动生成实体类、Mapper接口以及对应的XML映射文件等资源。这使得开发者可以专注于业务逻辑而非模板化的CRUD操作编码上。具体来说,在初始化项目时配置好数据库连接信息和其他必要参数之后,只需简单调用API即可完成整个项目的骨架搭建工作。 ```java // 自定义全局配置 GlobalConfig globalConfig = new GlobalConfig(); globalConfig.setAuthor("Your Name"); // 设置作者名 AutoGenerator mpg = new AutoGenerator().setGlobalConfig(globalConfig); mpg.execute(); // 执行生成命令 ``` #### 三、条件构造器的设计思路 条件构造器是MyBatis-Plus的一大亮点之一,允许使用者以链式编程的方式构建复杂的查询语句而无需手动拼接SQL字符串。内部实现了多种类型的判断表达式支持(如等于、不等于、大于小于关系运算符),并通过封装好的方法暴露给外部使用。这样既提高了代码可读性和维护性又降低了潜在的安全风险。 ```java QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.eq("name", "Tom").gt("age", 18); // name='Tom' AND age > 18 List<User> userList = userMapper.selectList(queryWrapper); ``` #### 四、分页插件的工作方式 当涉及到大量数据处理时,合理的分页策略显得尤为重要。MyBatis-Plus内置了一个高效易用的分页组件,能够在几乎不影响原有代码结构的前提下轻松实现分页效果。其实现原理是在执行SQL之前拦截请求并对原始SQL进行改写加入LIMIT OFFSET关键字从而达到限制返回记录数目的目的;与此同时还会额外发送一条COUNT(*)统计总条目数量以便前端页面显示导航栏链接。 ```java Page<User> page = new Page<>(current, size); IPage<User> iPage = userService.page(page, null); long total = iPage.getTotal(); // 获取总数 List<User> records = iPage.getRecords(); // 获取当前页的数据列表 ``` #### 五、ActiveRecord模式的应用实践 借鉴于其他ORM框架的成功经验,MyBatis-Plus同样引入了AR(Active Record)理念让对象实例可以直接代表表中的一行记录并且提供了诸如save()、deleteById()等一系列便捷的操作函数用于增删查改动作。这种方式极大地简化了日常开发流程使程序员不必再频繁切换不同层面之间的交互过程。 ```java User user = new User(); user.setName("Jack"); user.insert(); // 插入新纪录 user.setId(id).removeById(); // 删除指定ID的记录 ``` #### 六、自动填充字段的功能介绍 考虑到某些特殊需求场景下可能存在的默认值设定或是时间戳更新等问题,MyBatis-Plus特别加入了属性级别的自动化赋值方案——即在插入或修改某张表格中的任意一行时会依据预设规则自动为特定列赋予相应的新鲜数值比如创建时间和最后更改日期等等。 ```java @TableField(fill = FieldFill.INSERT_UPDATE) private Date updateTime; ``` #### 七、SQL注入防范措施 安全始终是一个不可忽视的话题,尤其是在Web应用程序领域内更是如此。针对这一挑战,MyBatis-Plus采取了一系列有效的防御手段来抵御恶意攻击者试图利用动态输入构造危险指令的行为。例如通过对用户提交的内容做严格校验过滤非法字符集之外还可以借助PreparedStatement机制从根本上杜绝此类隐患的发生可能性。 然而值得注意的是,在一些极端情况下可能会遇到意想不到的问题,例如逻辑删除功能可能导致WHERE子句冲突的情况发生,这是因为mybatis-plus并未充分考虑所有可能出现的实际应用场景所致[^2]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值