文章目录
- 一、前言
- 二、MyBatis-Plus自定义sql注入器功能实现
- 2.1、编写自定义sql类
- 2.2、将自定义sql添加到BaseMapper中
- 2.3、编写自己的sql注入器
一、前言
在日常开发过程中,我们可能会发现 MyBatis-Plus 提供的那些自带的 sql 语句无法满足我们的开发需求,想要加一些自定义的 sql,而且要应用于所有的 Mapper 上,需要怎么实现呢?
二、MyBatis-Plus自定义sql注入器功能实现
官方文档地址:https://baomidou.com/pages/42ea4a/
2.1、编写自定义sql类
编写一个自定义 sql 类,要继承 AbstractMethod
类,然后实现其 injectMappedStatement
方法来定义 sql 语句并加入到 MappedStatement
里,也可以重写 getMethod
方法来修改方法名。
ps:这里以 LogicDeleteByIdWithFill
(逻辑删除并做自动填充)举例,这个是 MyBatis-Plus 自己做的扩展,如果需要自己定义 sql,仿照这个或者DefaultSqlInjector
类里的各个默认方法写就可以了。
其实如果自己在 xml 里写 sql 的话,最终也是添加到 MappedStatement
里,这里其实就是模拟了这个操作,而且每个 Mapper 都会走这段代码,看似每个 Mapper 的 xml 里没有这些方法,但其实都存在。
2.2、将自定义sql添加到BaseMapper中
这里建议写一个自己的 BaseMapper
继承自 MyBatis-Plus 的 BaseMapper
,然后所有的业务 Mapper 都继承自己的 BaseMapper
public interface MyBaseMapper<T> extends BaseMapper<T> {
/**
* 带自动填充的删除
*
* @param entity
* @return
*/
int deleteByIdWithFill(T entity);
}
注意,这里的方法名要与2.1中 getMethod
方法返回的方法名一致。
2.3、编写自己的sql注入器
编写一个自己的 sql 注入器,继承 DefaultSqlInjector
,实现其 getMethodList
方法,将之前写的自定义 sql 类加入其中
@Component
public class MySqlInjector extends DefaultSqlInjector {
@Override
public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
List<AbstractMethod> methodList = super.getMethodList(mapperClass);
methodList.add(new LogicDeleteByIdWithFill());
return methodList;
}
}
这样就会在原本的方法基础上增加我们自定义的这个方法。