手把手教你如何扩展（破解）mybatisplus的sql生成 | 京东云技术团队

原创

于 2023-11-10 11:09:37 发布 · 560 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#sql #京东云 #java #mybatis #mybatisplus

文章介绍了如何在MybatisPlus基础上扩展常用的CRUD方法，如自定义查询，以及如何利用GyhSqlInjector和GyhBaseMapper实现分库分表的SQL优化。作者郭艳红提到通过自定义Mapper和注入器来增强功能，提高开发效率。

mybatisplus 的常用CRUD方法

众所周知，mybatisplus提供了强大的代码生成能力，他默认生成的常用的CRUD方法（例如插入、更新、删除、查询等）的定义，能够帮助我们节省很多体力劳动。

他的BaseMapper中定义了这些常用的CRUD方法，我们在使用时，继承这个BaseMapper类就默认拥有了这些能力。

如果我们的业务中，需要类似的通用Sql时，该如何实现呢？

是每个Mapper中都定义一遍类似的Sql吗？

显然这是最笨的一种方法。

此时我们可以借助mybatisplus这个成熟框架，来实现我们想要的通用Sql。

扩展常用CRUD方法

新增一个通用sql

比如有一个这样的需求，项目中所有表或某一些表，都要执行一个类似的查询，如`SelectByErp`，那么可以这样实现。（这是一个最简单的sql实现，使用时可以根据业务需求实现更为复杂的sql：比如多租户系统自动增加租户id参数、分库分表系统增加分库分表字段条件判断）

定义一个SelectByErp类，继承AbstractMethod类，并实现injectMappedStatement方法
定义sql方法名、sql模板、实现sql的拼接组装

/**
 * 新增一个通用sql
 */
public class SelectByErp extends AbstractMethod {
     // 需要查询的列名
    private final String erpColumn = "erp";
    // sql方法名
    private final String method = "selectByErp";
    // sql模板
    private final String sqlTemplate = "SELECT %s FROM %s WHERE %s=#{%s} %s";

    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
       	// 获取需要查询的字段名及属性名
        TableFieldInfo erpFiled = getErpProperty(tableInfo);
        // 拼接组装sql
        SqlSource sqlSource = new RawSqlSource(configuration, String.format(sqlTemplate,
                sqlSelectColumns(tableInfo, false),
                tableInfo.getTableName(), 
                erpFiled.getColumn(), erpFiled.getProperty(),
                tableInfo.getLogicDeleteSql(true, false)), Object.class);
        return this.addSelectMappedStatementForTable(mapperClass, method, sqlSource, tableInfo);
}
	/**
     * 查询erp列信息
     */
    private T