Анализ механизма Mybatis Plus для реализации динамического оператора SQL.

MyBatis

Углубленный анализ механизма Mybatis Plus, реализующего динамические операторы SQL.

Mybatis-Plus (сокращенно MP) — это инструмент улучшения Mybatis, так как же его улучшить? На самом деле в нем уже инкапсулированы некоторые crud-методы, так что нет необходимости писать xml для разработки, достаточно вызывать эти методы напрямую, как в JPA. Затем в этой статье будет прочитана конкретная реализация следующего MP, чтобы увидеть, как реализованы эти улучшения.

Начальный класс: MybatisSqlSessionFactoryBuilder

В методе класса ввода MybatisSqlSessionFactoryBuilder#build при запуске приложения XML-файл динамической конфигурации, настроенный mybatis plus (сокращенно MP), вводится в Mybatis.

public class MybatisSqlSessionFactoryBuilder extends SqlSessionFactoryBuilder {
    public SqlSessionFactory build(Configuration configuration) {
            // ... 省略若干行 
            if (globalConfig.isEnableSqlRunner()) {
                new SqlRunnerInjector().inject(configuration);
            }
            // ... 省略若干行 
            return sqlSessionFactory;
        }
}

Это включает в себя 2 функциональных класса MP2

  1. Расширяет класс MybatisConfiguration, унаследованный от Mybatis: построение динамического сценария MP, регистрация и другие логические суждения.
  2. SqlRunnerInjector: MP по умолчанию вставляет некоторые методы динамического сценария xml.

Класс MybatisConfiguration

Здесь мы сосредоточимся на анализе класса MybatisConfiguration.В MybatisConfiguration MP инициализирует свой собственный MybatisMapperRegistry, а MybatisMapperRegistry — это регистр MP для загрузки пользовательских методов SQL.

Многие методы в MybatisConfiguration переписаны с использованием MybatisMapperRegistry.

Среди них есть 3 перегруженных метода addMapper для реализации функции регистрации динамических скриптов MP.

public class MybatisConfiguration extends Configuration {
    /**
     * Mapper 注册
     */
    protected final MybatisMapperRegistry mybatisMapperRegistry = new MybatisMapperRegistry(this);
    // ....

    /**
     * 初始化调用
     */
    public MybatisConfiguration() {
        super();
        this.mapUnderscoreToCamelCase = true;
        languageRegistry.setDefaultDriverClass(MybatisXMLLanguageDriver.class);
    }

    /**
     * MybatisPlus 加载 SQL 顺序：
     * <p> 1、加载 XML中的 SQL </p>
     * <p> 2、加载 SqlProvider 中的 SQL </p>
     * <p> 3、XmlSql 与 SqlProvider不能包含相同的 SQL </p>
     * <p>调整后的 SQL优先级：XmlSql > sqlProvider > CurdSql </p>
     */
    @Override
    public void addMappedStatement(MappedStatement ms) {
        // ...
    }
    
    // ... 省略若干行 
    /**
     * 使用自己的 MybatisMapperRegistry
     */
    @Override
    public <T> void addMapper(Class<T> type) {
        mybatisMapperRegistry.addMapper(type);
    }
    // .... 省略若干行 
}

В MybatisMapperRegistry MP заменяет MapperAnnotationBuilder mybatis собственным MybatisMapperAnnotationBuilder MP.

public class MybatisMapperRegistry extends MapperRegistry {
    @Override
    public <T> void addMapper(Class<T> type) {
        // ... 省略若干行 
        MybatisMapperAnnotationBuilder parser = new MybatisMapperAnnotationBuilder(config, type);
        parser.parse();
        // ... 省略若干行 
    }
}

В методе addMapper класса MybatisMapperRegistry он действительно входит в базовый класс MybatisMapperAnnotationBuilder МП, а класс MybatisMapperAnnotationBuilder является ключевым классом МП для реализации динамических скриптов.

MybatisMapperAnnotationBuilder динамически конструируется

В методе анализатора MP's Core Class MyBatismapperannotationBuilder MP MP пересекает классы Mapper, которые будут загружены один за другим, а методы загрузки включают следующее

public class MybatisMapperAnnotationBuilder extends MapperAnnotationBuilder {
    @Override
    public void parse() {
        //... 省略若干行 
        for (Method method : type.getMethods()) {
            /** for循环代码, MP判断method方法是否是@Select @Insert等mybatis注解方法**/
            parseStatement(method);
            InterceptorIgnoreHelper.initSqlParserInfoCache(cache, mapperName, method);
            SqlParserHelper.initSqlParserInfoCache(mapperName, method);
        }
        /** 这2行代码, MP注入默认的方法列表**/
        if (GlobalConfigUtils.isSupperMapperChildren(configuration, type)) {
            GlobalConfigUtils.getSqlInjector(configuration).inspectInject(assistant, type);
        }
        //... 省略若干行 
    }

    @Override
    public void inspectInject(MapperBuilderAssistant builderAssistant, Class<?> mapperClass) {
        Class<?> modelClass = extractModelClass(mapperClass);
        //... 省略若干行 
        List<AbstractMethod> methodList = this.getMethodList(mapperClass);
        TableInfo tableInfo = TableInfoHelper.initTableInfo(builderAssistant, modelClass);
        // 循环注入自定义方法
        methodList.forEach(m -> m.inject(builderAssistant, mapperClass, modelClass, tableInfo));
        mapperRegistryCache.add(className);
    }
}
public class DefaultSqlInjector extends AbstractSqlInjector {

    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        return Stream.of(
            new Insert(),
            //... 省略若干行 
            new SelectPage()
        ).collect(toList());
    }
}

В MyBatismapperannotationBuilder MP действительно регистрирует динамические операторы SQL, настроенные структурой в двигатель MyBatis. Абстрактный Method реализует конструкцию оператора SQL конкретного метода.

Конкретный класс экземпляра AbstractMethod, создание инструкции SQL для конкретного метода

Возьмите класс SelectById в качестве примера, чтобы проиллюстрировать

/**
 * 根据ID 查询一条数据
 */
public class SelectById extends AbstractMethod {
    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        /** 定义 mybatis xml method id, 对应 <id="xyz"> **/
        SqlMethod sqlMethod = SqlMethod.SELECT_BY_ID;
        /** 构造id对应的具体xml片段 **/
        SqlSource sqlSource = new RawSqlSource(configuration, String.format(sqlMethod.getSql(),
            sqlSelectColumns(tableInfo, false),
            tableInfo.getTableName(), tableInfo.getKeyColumn(), tableInfo.getKeyProperty(),
            tableInfo.getLogicDeleteSql(true, true)), Object.class);
        /** 将xml method方法添加到mybatis的MappedStatement中 **/
        return this.addSelectMappedStatementForTable(mapperClass, getMethod(sqlMethod), sqlSource, tableInfo);
    }
}

На данный момент MP завершил процесс загрузки XML-конфигурации пользовательского метода при запуске, после чего последовала динамическая замена и предварительная компиляция mybatis ${variable} #{variable}, которая вошла в собственную функцию mybatis.

в заключении

MP переписал и заменил в общей сложности более десяти классов мибати, в основном, как показано на следующем рисунке:

В общем, MP реализует расширение mybatis, что немного громоздко и не интуитивно понятно. Фактически, согласно MybatisMapperAnnotationBuilder, xml файл пользовательского метода конструируется и преобразуется в ресурсный ресурс mybatis. Вы можете только наследовать и переписывать один класс Mybatis: SqlSessionFactoryBean Например:

public class YourSqlSessionFactoryBean extends SqlSessionFactoryBean implements ApplicationContextAware {

    private Resource[] mapperLocations;

    @Override
    public void setMapperLocations(Resource... mapperLocations) {
        super.setMapperLocations(mapperLocations);
        /** 暂存使用mybatis原生定义的mapper xml文件路径**/
        this.mapperLocations = mapperLocations;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void afterPropertiesSet() throws Exception {
        ConfigurableListableBeanFactory beanFactory = getBeanFactory();
        /** 只需要通过将自定义的方法构造成xml resource和原生定义的Resource一起注入到mybatis中即可, 这样就可以实现MP的自定义动态SQL和原生SQL的共生关系**/
        this.setMapperLocations(InjectMapper.getMapperResource(this.dbType, beanFactory, this.mapperLocations));
        super.afterPropertiesSet();
    }
}

В этой статье процесс реализации MP для реализации динамического заявления кратко введен, а возможный более удобный метод. В следующей статье я введем, как еще один MyBATIS Framework Framework, свободно владеет MyBatis, реализует механизм для достижения динамических утверждений без переписывания любых системных методов MyBatis.

Введение и исходный код Fluent Mybatis

Используйте FluentMybatis для реализации динамической сборки mybatis sql и свободного синтаксиса API.

Сложный вложенный запрос с нулевой xml-конфигурацией Fluent Mybatis

Свободная документация и примеры Mybatis Свободный исходный код Mybatis, github

Категории