mybatis-plus源码分析之sql注入器

时间 2019-12-07

原文原文链接

微信公众号「后端进阶」，专一后端技术分享：Java、Golang、WEB框架、分布式中间件、服务治理等等。
老司机倾囊相授，带你一路进阶，来不及解释了快上车！

mybatis-plus是彻底基于mybatis开发的一个加强工具，它的设计理念是在mybatis的基础上只作加强不作改变，为简化开发、提升效率而生，它在mybatis的基础上增长了不少实用性的功能，好比增长了乐观锁插件、字段自动填充功能、分页插件、条件构造器、sql注入器等等，这些在开发过程当中都是很是实用的功能，mybatis-plus可谓是站在巨人的肩膀上进行了一系列的创新，我我的极力推荐。下面我会详细地从源码的角度分析mybatis-plus（下文简写成mp）是如何实现sql自动注入的原理。java

温故知新

咱们回顾一下mybatis的Mapper的注册与绑定过程，我以前也写过一篇「Mybatis源码分析之Mapper注册与绑定」，在这篇文章中，我详细地讲解了Mapper绑定的最终目的是将xml或者注解上的sql信息与其对应Mapper类注册到MappedStatement中，既然mybatis-plus的设计理念是在mybatis的基础上只作加强不作改变，那么sql注入器必然也是在将咱们预先定义好的sql和预先定义好的Mapper注册到MappedStatement中。程序员

如今我将Mapper的注册与绑定过程用时序图再梳理一遍：spring

解析一下这几个类的做用：sql

SqlSessionFactoryBean：继承了FactoryBean和InitializingBean，符合spring loc容器bean的基本规范，可在获取该bean时调用getObject()方法到SqlSessionFactory。
XMLMapperBuilder：xml文件解析器，解析Mapper对应的xml文件信息，并将xml文件信息注册到Configuration中。
XMLStatementBuilder：xml节点解析器，用于构建select/insert/update/delete节点信息。
MapperBuilderAssistant：Mapper构建助手，将Mapper节点信息封装成statement添加到MappedStatement中。
MapperRegistry：Mapper注册与绑定类，将Mapper的类信息与MapperProxyFactory绑定。
MapperAnnotationBuilder：Mapper注解解析构建器，这也是为何mybatis能够直接在Mapper方法添加注解信息就能够不用在xml写sql信息的缘由，这个构建器专门用于解析Mapper方法注解信息，并将这些信息封装成statement添加到MappedStatement中。

从时序图可知，Configuration配置类存储了全部Mapper注册与绑定的信息，而后建立SqlSessionFactory时再将Configuration注入进去，最后通过SqlSessionFactory建立出来的SqlSession会话，就能够根据Configuration信息进行数据库交互，而MapperProxyFactory会为每一个Mapper建立一个MapperProxy代理类，MapperProxy包含了Mapper操做SqlSession全部的细节，所以咱们就能够直接使用Mapper的方法就能够跟SqlSession进行交互。数据库

饶了一圈，发现我如今还没讲sql注入器的源码分析，你不用慌，你得体现出老司机的成熟稳定，以前我也跟你说了sql注入器的原理了，只剩下源码分析，这时候咱们应该在源码分析以前作足前戏，前戏作足就剩下撕、拉、扯、剥开源码的外衣了，来不及解释了快上车！后端

源码分析

从Mapper的注册与绑定过程的时序图看，要想将sql注入器无缝连接地添加到mybatis里面，那就得从Mapper注册步骤添加，果真，mp很鸡贼地继承了MapperRegistry这个类而后重写了addMapper方法：缓存

com.baomidou.mybatisplus.MybatisMapperRegistry#addMapper：微信

public <T> void addMapper(Class<T> type) {
    if (type.isInterface()) {
        if (hasMapper(type)) {
            // TODO 若是以前注入 直接返回
            return;
            // throw new BindingException("Type " + type +
            // " is already known to the MybatisPlusMapperRegistry.");
        }
        boolean loadCompleted = false;
        try {
            knownMappers.put(type, new MapperProxyFactory<>(type));
            // It's important that the type is added before the parser is run
            // otherwise the binding may automatically be attempted by the
            // mapper parser. If the type is already known, it won't try.
            // TODO 自定义无 XML 注入
            MybatisMapperAnnotationBuilder parser = new MybatisMapperAnnotationBuilder(config, type);
            parser.parse();
            loadCompleted = true;
        } finally {
            if (!loadCompleted) {
                knownMappers.remove(type);
            }
        }
    }
}

方法中将MapperAnnotationBuilder替换成了自家的MybatisMapperAnnotationBuilder，在这里特别说明一下，mp为了避免更改mybatis原有的逻辑，会用继承或者直接粗暴地将其复制过来，而后在原有的类名上加上前缀“Mybatis”。mybatis

com.baomidou.mybatisplus.MybatisMapperAnnotationBuilder#parse：架构

public void parse() {
    String resource = type.toString();
    if (!configuration.isResourceLoaded(resource)) {
        loadXmlResource();
        configuration.addLoadedResource(resource);
        assistant.setCurrentNamespace(type.getName());
        parseCache();
        parseCacheRef();
        Method[] methods = type.getMethods();
        // TODO 注入 CURD 动态 SQL (应该在注解以前注入)
        if (BaseMapper.class.isAssignableFrom(type)) {
            GlobalConfigUtils.getSqlInjector(configuration).inspectInject(assistant, type);
        }
        for (Method method : methods) {
            try {
                // issue #237
                if (!method.isBridge()) {
                    parseStatement(method);
                }
            } catch (IncompleteElementException e) {
                configuration.addIncompleteMethod(new MethodResolver(this, method));
            }
        }
    }
    parsePendingMethods();
}

sql注入器就是从这个方法里面添加上去的，首先判断Mapper是不是BaseMapper的超类或者超接口，BaseMapper是mp的基础Mapper，里面定义了不少默认的基础方法，意味着咱们一旦使用上mp，经过sql注入器，不少基础的数据库操做均可以直接继承BaseMapper实现了，开发效率爆棚有木有！

com.baomidou.mybatisplus.toolkit.GlobalConfigUtils#getSqlInjector：

public static ISqlInjector getSqlInjector(Configuration configuration) {
  // fix #140
  GlobalConfiguration globalConfiguration = getGlobalConfig(configuration);
  ISqlInjector sqlInjector = globalConfiguration.getSqlInjector();
  if (sqlInjector == null) {
    sqlInjector = new AutoSqlInjector();
    globalConfiguration.setSqlInjector(sqlInjector);
  }
  return sqlInjector;
}

GlobalConfiguration是mp的全局缓存类，用于存放mp自带的一些功能，很明显，sql注入器就存放在GlobalConfiguration中。

这个方法是先从全局缓存类中获取自定义的sql注入器，若是在GlobalConfiguration中没有找到自定义sql注入器，就会设置一个mp默认的sql注入器AutoSqlInjector。

sql注入器接口：

// SQL 自动注入器接口
public interface ISqlInjector {
  
  // 根据mapperClass注入SQL
  void inject(MapperBuilderAssistant builderAssistant, Class<?> mapperClass);

  // 检查SQL是否注入(已经注入过再也不注入)
  void inspectInject(MapperBuilderAssistant builderAssistant, Class<?> mapperClass);

  // 注入SqlRunner相关
  void injectSqlRunner(Configuration configuration);

}

全部自定义的sql注入器都须要实现ISqlInjector接口，mp已经为咱们默认实现了一些基础的注入器：

com.baomidou.mybatisplus.mapper.AutoSqlInjector
com.baomidou.mybatisplus.mapper.LogicSqlInjector

其中AutoSqlInjector提供了最基本的sql注入，以及一些通用的sql注入与拼装的逻辑，LogicSqlInjector在AutoSqlInjector的基础上复写了删除逻辑，由于咱们的数据库的数据删除实质上是软删除，并非真正的删除。

com.baomidou.mybatisplus.mapper.AutoSqlInjector#inspectInject：

public void inspectInject(MapperBuilderAssistant builderAssistant, Class<?> mapperClass) {
    String className = mapperClass.toString();
    Set<String> mapperRegistryCache = GlobalConfigUtils.getMapperRegistryCache(builderAssistant.getConfiguration());
    if (!mapperRegistryCache.contains(className)) {
        inject(builderAssistant, mapperClass);
        mapperRegistryCache.add(className);
    }
}

该方法是sql注入器的入口，在入口处添加了注入事后再也不注入的判断功能。

// 注入单点 crudSql
@Override
public void inject(MapperBuilderAssistant builderAssistant, Class<?> mapperClass) {
  this.configuration = builderAssistant.getConfiguration();
  this.builderAssistant = builderAssistant;
  this.languageDriver = configuration.getDefaultScriptingLanguageInstance();

  // 驼峰设置 PLUS 配置 > 原始配置
  GlobalConfiguration globalCache = this.getGlobalConfig();
  if (!globalCache.isDbColumnUnderline()) {
    globalCache.setDbColumnUnderline(configuration.isMapUnderscoreToCamelCase());
  }
  Class<?> modelClass = extractModelClass(mapperClass);
  if (null != modelClass) {
    // 初始化 SQL 解析
    if (globalCache.isSqlParserCache()) {
      PluginUtils.initSqlParserInfoCache(mapperClass);
    }
    TableInfo table = TableInfoHelper.initTableInfo(builderAssistant, modelClass);
    injectSql(builderAssistant, mapperClass, modelClass, table);
  }
}

注入以前先将Mapper类提取泛型模型，由于继承BaseMapper须要将Mapper对应的model添加到泛型里面，这时候咱们须要将其提取出来，提取出来后还须要将其初始化成一个TableInfo对象，TableInfo存储了数据库对应的model全部的信息，包括表主键ID类型、表名称、表字段信息列表等等信息，这些信息经过反射获取。

com.baomidou.mybatisplus.mapper.AutoSqlInjector#injectSql：

protected void injectSql(MapperBuilderAssistant builderAssistant, Class<?> mapperClass, Class<?> modelClass, TableInfo table) {
  if (StringUtils.isNotEmpty(table.getKeyProperty())) {
    /** 删除 */
    this.injectDeleteByIdSql(false, mapperClass, modelClass, table);
    /** 修改 */
    this.injectUpdateByIdSql(true, mapperClass, modelClass, table);
    /** 查询 */
    this.injectSelectByIdSql(false, mapperClass, modelClass, table);
  } 
  /** 自定义方法 */
  this.inject(configuration, builderAssistant, mapperClass, modelClass, table);
}

全部须要注入的sql都是经过该方法进行调用，AutoSqlInjector还提供了一个inject方法，自定义sql注入器时，继承AutoSqlInjector，实现该方法就好了。

com.baomidou.mybatisplus.mapper.AutoSqlInjector#injectDeleteByIdSql：

protected void injectSelectByIdSql(boolean batch, Class<?> mapperClass, Class<?> modelClass, TableInfo table) {
  SqlMethod sqlMethod = SqlMethod.SELECT_BY_ID;
  SqlSource sqlSource;
  if (batch) {
    sqlMethod = SqlMethod.SELECT_BATCH_BY_IDS;
    StringBuilder ids = new StringBuilder();
    ids.append("\n<foreach item=\"item\" index=\"index\" collection=\"coll\" separator=\",\">");
    ids.append("#{item}");
    ids.append("\n</foreach>");
    sqlSource = languageDriver.createSqlSource(configuration, String.format(sqlMethod.getSql(),
                                                                            sqlSelectColumns(table, false), table.getTableName(), table.getKeyColumn(), ids.toString()), modelClass);
  } else {
    sqlSource = new RawSqlSource(configuration, String.format(sqlMethod.getSql(), sqlSelectColumns(table, false),
                                                              table.getTableName(), table.getKeyColumn(), table.getKeyProperty()), Object.class);
  }
  this.addSelectMappedStatement(mapperClass, sqlMethod.getMethod(), sqlSource, modelClass, table);
}

我随机选择一个删除sql的注入，其它sql注入都是相似这么写，SqlMethod是一个枚举类，里面存储了全部自动注入的sql与方法名，若是是批量操做，SqlMethod的定义的sql语句在添加批量操做的语句。再根据table和sql信息建立一个SqlSource对象。

com.baomidou.mybatisplus.mapper.AutoSqlInjector#addMappedStatement：

public MappedStatement addMappedStatement(Class<?> mapperClass, String id, SqlSource sqlSource,
                                          SqlCommandType sqlCommandType, Class<?> parameterClass, String resultMap, Class<?> resultType,
                                          KeyGenerator keyGenerator, String keyProperty, String keyColumn) {
  // MappedStatement是否存在
  String statementName = mapperClass.getName() + "." + id;
  if (hasMappedStatement(statementName)) {
    System.err.println("{" + statementName
                       + "} Has been loaded by XML or SqlProvider, ignoring the injection of the SQL.");
    return null;
  }
  /** 缓存逻辑处理 */
  boolean isSelect = false;
  if (sqlCommandType == SqlCommandType.SELECT) {
    isSelect = true;
  }
  return builderAssistant.addMappedStatement(id, sqlSource, StatementType.PREPARED, sqlCommandType, null, null, null,
                                             parameterClass, resultMap, resultType, null, !isSelect, isSelect, false, keyGenerator, keyProperty, keyColumn,
                                             configuration.getDatabaseId(), languageDriver, null);
}

sql注入器的最终操做，这里会判断MappedStatement是否存在，这个判断是有缘由的，它会防止重复注入，若是你的Mapper方法已经在Mybatis的逻辑里面注册了，mp不会再次注入。最后调用MapperBuilderAssistant助手类的addMappedStatement方法执行注册操做。

到这里，一个sql自动注入器的源码就分析完了，其实实现起来很简单，由于它利用了Mybatis的机制，站在巨人的肩膀上进行创新。

我但愿在大家从此的职业生涯里，不要只作一个只会调用API的crud程序员，咱们要有一种刨根问底的精神。阅读源码很枯燥，但阅读源码不只会让你知道API底层的实现原理，让你知其然也知其因此然，还能够开阔你的思惟，提高你的架构设计能力，经过阅读源码，能够看到大佬们是如何设计一个框架的，为何会这么设计。