mybatis-plus高级功能 实现自定义通用方法详解

已于 2022-10-31 18:57:23 修改
阅读量6.4k 收藏 19
点赞数 7
分类专栏： java个人笔记 文章标签： java mybatis mybatis-plus
于 2020-11-10 16:06:28 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42094345/article/details/109599850
版权

前言

MP在一开始就给大家提供了很多通用的方法，在DefaultSqlInjector这个类中，在MethodList这个集合当中包含的都是通用方法类，如果想要使用自定义通用方法，也需要添加到这个集合当中。

/**
 * SQL 默认注入器
 *
 * @author hubin
 * @since 2018-04-10
 */
public class DefaultSqlInjector extends AbstractSqlInjector {
 
    @Override
    public List<AbstractMethod> getMethodList() {
        return Stream.of(
            new Insert(),
            new Delete(),
            new DeleteByMap(),
            new DeleteById(),
            new DeleteBatchByIds(),
            new Update(),
            new UpdateById(),
            new SelectById(),
            new SelectBatchByIds(),
            new SelectByMap(),
            new SelectOne(),
            new SelectCount(),
            new SelectMaps(),
            new SelectMapsPage(),
            new SelectObjs(),
            new SelectList(),
            new SelectPage()
        ).collect(toList());
    }
}

实现自定义方法-以删除时填充为例：

  1. 创建自定义方法的类
  • 类名是DelFillUserMethod，这个是自定义的，但是最好是见名知意的类名。
  • 继承AbstractMethod抽象类，AbstractMethod是抽象的注入方法类,每个通用方法也都继承了这个类，也是为了方便调用里面的方法
  • 重写injectMappedStatement方法，injectMappedStatement内是我们完成我们这个方法具体的逻辑。
  • CustomSqlMethod是自定义的枚举类，我在下面已经贴出来了，这样可以使代码更优雅，我没有选择用官方提供的SqlMethod，是因为我怕到时候不容易维护，所以写了一个自己的，这个全看个人😄。
  • 具体内容我在代码中也有注释。

/**
 * @auther: zpq
 * @date: 2020/11/9 19:55
 * @description: 删除并填充删除人信息
 */
public class DelFillUserMethod extends AbstractMethod {

  @Override
  public MappedStatement injectMappedStatement(
      Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {

    // 获取用户信息
    String userId = UserContext.getCurrent() == null ? null : UserContext.getCurrent().getId2();
    String userName = UserContext.getCurrent() == null ? null : UserContext.getCurrent().getName();

	// set 语句
    String set = "set useflag = 0,deletetime = now(),operatetime = now()";

    if (StringUtils.isNotBlank(userId)) set += ",set deleterid = " + userId;
    if (StringUtils.isNotBlank(userName)) set += ",set deleter = " + userName;

    // 拿到我们定义好的枚举
    CustomSqlMethod sqlMethod = CustomSqlMethod.DEL_FILL_USER;

    /** * 组装自己的sql */
    String sql =
        String.format(
            // 定义好的sql
            sqlMethod.getSql(),
            // 表名
            tableInfo.getTableName(),
            // set 的值
            set,
            // 主键（数据库字段名）
            tableInfo.getKeyColumn(),
            // 实体类属性名
            tableInfo.getKeyProperty(),
            // and 主键 = yes ｜ 如果是false的话就是 and 主键 = no
            tableInfo.getLogicDeleteSql(true, true));

    // 动态SQL标签处理器
    SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, Object.class);

    // 交给mp大佬们处理执行
    return addUpdateMappedStatement(mapperClass, modelClass, sqlMethod.getMethod(), sqlSource);
  }
}
  • CustomSqlMethod枚举类内容
/**
 * @auther: zpq
 * @date: 2020/11/10 14:29
 * @description: 自定义通用sql与方法名称
 */
public enum CustomSqlMethod {
    /**
     * 插入
     */
    INSERT_ONE("insert", "插入一条数据（选择字段插入）", "<script>\nINSERT INTO %s %s VALUES %s\n</script>"),

    /**
     * 删除
     */
    DELETE_BY_ID("deleteById", "根据ID 删除一条数据", "<script>\nDELETE FROM %s WHERE %s=#{%s}\n</script>"),

    /**
     * 逻辑删除
     */
    LOGIC_DELETE_BY_ID("deleteById", "根据ID 逻辑删除一条数据", "<script>\nUPDATE %s %s WHERE %s=#{%s} %s\n</script>"),

    /**
     * 逻辑删除 -> 修改
     */
    DEL_FILL_USER("delFillUser", "删除填充用户信息", "<script>\nUPDATE %s %s WHERE %s=#{%s} %s\n</script>"),
    BATCH_DEL_FILL_USER("batchDelFillUser", "批量删除填充用户信息", "<script>\nUPDATE %s %s WHERE %s IN (%s) %s\n</script>"),

    /**
     * 查询
     */
    SELECT_OBJS("selectObjs", "查询满足条件所有数据", "<script>%s SELECT %s FROM %s %s %s\n</script>");

    private final String method;
    private final String desc;
    private final String sql;

    CustomSqlMethod(String method, String desc, String sql) {
        this.method = method;
        this.desc = desc;
        this.sql = sql;
    }

    public String getMethod() {
        return method;
    }

    public String getDesc() {
        return desc;
    }

    public String getSql() {
        return sql;
    }

}
  1. 创建注入器，并把自定义的方法添加到集合当中。
  • 类名是CustomSqlInjector，自定义的
  • 继承DefaultSqlInjector并重写getMethodList，SQL 默认注入器上面也有提到过，我们得把我们自定义的方法加入到通用方法的集合methodList当中
/**
 * @auther: zpq
 * @date: 2020/11/9 20:00
 * @description: 自定义sql注入器
 * 把自定义的通用方法加入mp的方法集合
 */
@Component
public class CustomSqlInjector extends DefaultSqlInjector {

  @Override
  public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
    // 这里很重要，先要通过父类方法，获取到原有的集合，不然会自带的通用方法会失效的
    List<AbstractMethod> methodList = super.getMethodList(mapperClass);

    /***
     * 添加自定义方法类
     */
    methodList.add(new DelFillUserMethod());
    methodList.add(new BatchDelFillUserMethod());

    return methodList;
  }
}
  1. 最后一步就是在*.dao.*Mapper中加入自定义方法 如下：
  /**
   * @Description: 删除并填充删除人信息
   *
   * @param: id 主键id
   * @auther: zpq
   * @date: 2020/11/10 11:47 上午
   */
  int delFillUser(Serializable id);
  1. 其实以上就算完成了，但是如果同时有好几个Mapper需要用到这个自定义通用方法，这样可能不是那么优雅。
  • 我们创建一个通用SuperMapper,然后继承BaseMapper，这样的话，用到这个方法的mapper只需要继承SuperMapper就可以了，如下：
/**
 * @auther: zpq
 * @date: 2020/11/9 20:10
 * @description: 通用mapper
 */
public interface SuperMapper<T> extends BaseMapper<T> {

  /**
   * @Description: 删除并填充删除人信息
   *
   * @param: id 主键id
   * @auther: zpq
   * @date: 2020/11/10 11:47 上午
   */
  int delFillUser(Serializable id);

  /**
   * @Description: 批量删除并填充删除人信息
   *
   * @param: idList 主键ID列表(不能为 null 以及 empty)
   * @auther: zpq
   * @date: 2020/11/10 3:12 下午
   */
  int batchDelFillUser(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
}
  1. 你可能也已经发现自定义的批量操作的通用方法，我直接贴出来：
/**
 * @auther: zpq
 * @date: 2020/11/10 14:59
 * @description: 批量删除填充用户信息
 */
public class BatchDelFillUserMethod extends AbstractMethod {

  @Override
  public MappedStatement injectMappedStatement(
      Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {

    // 获取用户信息
    String userId = UserContext.getCurrent() == null ? null : UserContext.getCurrent().getId2();
    String userName = UserContext.getCurrent() == null ? null : UserContext.getCurrent().getName();

    // 自己组装sql
    String set = "set useflag = 0,deletetime = now(),operatetime = now()";

    if (StringUtils.isNotBlank(userId)) set += ",set deleterid = " + userId;
    if (StringUtils.isNotBlank(userName)) set += ",set deleter = " + userName;

    // 拿到我们定义好的sql
    CustomSqlMethod sqlMethod = CustomSqlMethod.BATCH_DEL_FILL_USER;

    // 填充sql
    String sql =
        String.format(
            sqlMethod.getSql(),
            tableInfo.getTableName(),
            set,
            tableInfo.getKeyColumn(),
            // foreach in(ids)
            SqlScriptUtils.convertForeach("#{item}", COLLECTION, null, "item", COMMA),
            tableInfo.getLogicDeleteSql(true, true));

    // 动态SQL标签处理器
    SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, Object.class);

    return addUpdateMappedStatement(mapperClass, modelClass, sqlMethod.getMethod(), sqlSource);
  }
}

结束语：

到此mybatis-plus高级功能 实现自定义通用方法详解就结束了，其实很简单，写其他方法也一样，对照着mybatis-plus源码照着抄就行哈哈哈。。。

zhopq
关注
专栏目录
MyBatis-Plus 自定义全局通用操作详解
奇妙的Bug之旅
01-02 473
MyBatis-Plus 是一款在 MyBatis 基础上进行了功能扩展的数据库操作工具，它提供了一系列的增强特性，包括全局通用操作。本文将详细介绍如何自定义全局通用操作，并通过实例演示每个步骤的具体代码。
Mybatis-Plus 常用增删改查方法详解（Wrapper 条件构造器的使用）
zzvar的博客
06-27 1万+
Mybatis-Plus内容一、Mybatis-Plus 概念二、项目准备（以 SpringBoot 项目为例）1. 项目结构图2. 数据表2.1 数据表截图2.2 建表语句3. 项目依赖3.1 集成 SpringBoot 项目3.2 集成 SSM 项目4. application.properties 配置文件5. Employee 实体类6. EmployeeMapper7. App 启动类三、Mybatis-Plus 常用注解四、Mybatis-Plus 日志五、通用 BaseMapper 接口方法
mybatis-plus/mybatis的组件们——拦截器、字段填充器、类型处理器、表名替换、SqlInjector(联合主键处理)
(づ￣ 3￣)づxl
10-27 1万+
最近有个练手的小例子，大概就是配置两个数据源，从一个数据源读取数据写到另一个数据源，虽然最后做了出来，但是不支持事务。。。就当是对mybatis-plus/mybatis组件使用方式的记录吧，本次例子使用的仍是mybatis-plus 回忆一下mybatis核心对象： Configuration 初始化基础配置，比如MyBatis的别名等，一些重要的类型对象，如，插件，映射器，ObjectFa...
mybatis-plus实现自定义通用方法.zip
11-10
去这里也可以直接看，这个只是源码而已而且有个小bug，解决了就说明你ok了，哈哈哈哈哈 https://blog.csdn.net/qq_42094345/article/details/109599850
Mybatis Plus 代码生成器 自定义模板
最新发布
weixin_50762970的博客
10-13 385
mybatis plus 代码生成器 自定义模板
mybatis-plus高级功能之实现自定义通用方法
p393975269的博客
06-25 812
MP在一开始就给大家提供了很多通用的方法，在DefaultSqlInjector这个类中，在MethodList这个集合当中包含的都是通用方法类，如果想要使用自定义通用方法，也需要添加到这个集合当中。CustomSqlMethod是自定义的枚举类，我在下面已经贴出来了，这样可以使代码更优雅，我没有选择用官方提供的SqlMethod，是因为我怕到时候不容易维护。继承AbstractMethod抽象类，AbstractMethod是抽象的注入方法类,每个通用方法也都继承了这个类，也是为了方便调用里面的方法。
Java学习 --- mybatisPlus实现自定义方法
qq_46093575的博客
03-09 1596
一、mybatisPlus实现自定义方法 1、创建映射文件 2、自定义方法 /** * 根据map集合id查询用户 * @param id * @return */ Map<String ,Object> selectMapId(Long id); 3、UserMapper.xml <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper
Mybatis-Plus自定义全局方法
天涯倦客的博客
10-25 2164
Mybatis-Plus自定义全局方法 源码分析
利用Mybatis-Plus实现自定义功能
m0_65577835的博客
03-29 996
/通过id查询接口,以map的形式打印在resource下创建mapper目录,目录下创建mapper.xml文件(这里是Mybatis中的知识点)在mapper.xml中配置我们的映射关系和我们自定义的操作--namespace表示映射的mapper的全类名-->--resultType指定返回类型为map,这里的map是Mybatis-plus为我们起的Map类型的别名-->--id对应的是方法名--></select></mapper>
mybatis-plus优缺点
02-22
1. **学习曲线**：对于初学者来说，Mybatis-Plus的高级功能可能需要一定的时间去学习和掌握。 2. **灵活性受限**：虽然提供了大量的通用功能，但在处理复杂的业务逻辑时，可能需要进行一定程度的手动定制。 3. **...
Mybatis-Plus详解
热门推荐
bier_zm的博客
07-15 2万+
RedirectMyBatis-Plus（简称MP）是⼀个MyBatis的增强⼯具，在MyBatis的基础上只做增强不做改变，为简化开发、提⾼效率⽽⽣。
MyBatisPlus中自定义全局操作流程示例代码
04-27
MyBatisPlus中自定义全局操作流程示例代码
mybatis-plus-demo.zip
09-15
MyBatis-Plus 是 MyBatis 的一个扩展，它提供了许多方便实用的功能，如自动 CRUD 操作、条件构造器、...实际项目中，还可以结合 MyBatis-Plus 的其他高级特性，如自定义全局操作、动态 SQL 等，进一步提升开发体验。
MyBatis-Plus 高级功能 —— 自定义通用方法
贱男
09-24 1万+
一、引言 大家已知MP给大家提供了很多通用的方法，可以看看MP源码中DefaultSqlInjector这个类，在这个集合当中包含了都是通用方法类，如果想要使用自定义通用方法，也需要添加到这个集合当中。 /** * SQL 默认注入器 * * @author hubin * @since 2018-04-10 */ public class DefaultSqlInjector e...
关于mybatis-plus写自定义方法（自定义sql）
jakelihua
06-07 1586
简介：本文讲解，在mybatis-plus中如果不存在某个方法，如何通过自定义的方式，自己写一个。
呼呼哈哈自用Utils
txy_2018的博客
03-25 252
package com.xxxx.crm.exceptions; /** * 自定义参数异常 */ public class NoLoginException extends RuntimeException { private Integer code=300; private String msg="用户未登录!"; public NoLoginException() { super("用户未登录!"); } public NoLogi
MyBatis-plus 自定义通用方法及其实现原理
谈谈1974
09-19 8653
文章目录背景1. 自定义通用方法的实现1.1 新增 Mapper 方法与 SQL 语句脚本映射枚举1.2 新增 Mapper 方法的定义类1.3 新增 SQL 注入器1.4 新增配置类将 SQL 注入器添加到容器1.5 新增基类 Mapper2. 实现原理2.1 自定义 SQL 注入器的注入2.2 自定义 SQL 注入器的使用2.3 Mapper 操作数据库的实现 背景 项目中使用了读写分离的数据库访问框架，这个框架基于 Proxy 模式，对使用方屏蔽了主从数据库，查询时默认路由到从库。但是因为存在主从延迟
【MybatisPlus深入使用指南】mybatisplus创建自定义方法sql注入器，批量操作详细（涵盖主键生成）
各位多多关照
01-26 1196
*** 新增分页拦截器，并设置数据库类型为pgsql* @return*/@Bean@Bean/*** 自定义方法SQL注入器*//*** 如果只需增加方法，保留mybatis plus自带方法，* 可以先获取super.getMethodList()，再添加add*/@Override我写了四个sql注入的类，有更新的，插入的，插入或更新的（根据唯一索引进行判断），接下来，就分别展示一下；/*** 自定义批量插入。
MyBatis-Plus 进阶用法 —— 自定义通用方法
weixin_46724181的博客
11-04 1280
一、前言 MP自带的条件构造器虽然很强大，有时候也避免不了写稍微复杂一点业务的sql，那么那么今天说说MP怎么自定义sql语句吧 go go~ 二、实现 1.a. 我们自定义一个类继承AbstractMethod 类，然后去实现injectMappedStatement 方法。 b. 然后就可以根据自己的业务需求自定义sql。 注意 ：这里面可以不用加配置注解扫描，直接将自定义的sql添加到模板当中就可以。 2 . 这里面有两个注意...
mybatis-plus代码生成器自定义模板怎么处理
06-06
MyBatis-Plus代码生成器提供了自定义模板的功能，可以根据自己的需求生成对应的代码。下面是自定义模板的处理步骤： 1. 在代码生成器的配置文件中，设置自定义模板的路径。例如： ``` <property name="templatePath" value="/templates/mybatis-plus"/> ``` 2. 在自定义模板路径下创建对应的模板文件。例如，创建一个模板文件 `Entity.java.vm`，用于生成实体类的代码。 3. 在模板文件中使用 Velocity 模板语言，编写生成代码的逻辑。例如： ``` package ${package_name}.${module_name}.entity; import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.experimental.Accessors; /** * <p> * ${table_comment} * </p> */ @Data @EqualsAndHashCode(callSuper = false) @Accessors(chain = true) @TableName("${table_name}") public class ${entity_name} { private static final long serialVersionUID = 1L; #foreach($field in $fields) /** * ${field.comment} */ private ${field.javaType} ${field.name}; #end } ``` 4. 在代码生成器中配置要使用的自定义模板。例如： ``` <property name="templateConfig"> <bean class="com.baomidou.mybatisplus.generator.config.TemplateConfig"> <property name="entity" value="/templates/mybatis-plus/Entity.java.vm"/> <property name="mapper" value="/templates/mybatis-plus/Mapper.java.vm"/> <property name="xml" value="/templates/mybatis-plus/Mapper.xml.vm"/> <property name="service" value="/templates/mybatis-plus/Service.java.vm"/> <property name="serviceImpl" value="/templates/mybatis-plus/ServiceImpl.java.vm"/> <property name="controller" value="/templates/mybatis-plus/Controller.java.vm"/> </bean> </property> ``` 在这个例子中，我们配置了生成实体类、Mapper接口、Mapper XML文件、Service接口、Service实现类和Controller类的模板路径。 5. 运行代码生成器，即可根据自定义模板生成对应的代码。 注意：自定义模板的命名必须与 MyBatis-Plus 内置模板的命名一致，才能正确覆盖内置模板。例如，要自定义生成实体类的模板，必须将模板文件命名为 `Entity.java.vm`。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

zhopq

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值