手把手教你如何扩展（破解）mybatisplus的sql生成

mybatisplus 的常用CRUD方法

众所周知，mybatisplus提供了强大的代码生成能力，他默认生成的常用的CRUD方法（例如插入、更新、删除、查询等）的定义，能够帮助我们节省很多体力劳动。
他的BaseMapper中定义了这些常用的CRUD方法，我们在使用时，继承这个BaseMapper类就默认拥有了这些能力。

如果我们的业务中，需要类似的通用Sql时，该如何实现呢？
是每个Mapper中都定义一遍类似的Sql吗？
显然这是最笨的一种方法。
此时我们可以借助mybatisplus这个成熟框架，来实现我们想要的通用Sql。
扩展常用CRUD方法

新增一个通用sql

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

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

1. /**
2. * 新增一个通用sql
3. */
4. public class SelectByErp extends AbstractMethod {
5.      // 需要查询的列名
6.     private final String erpColumn = "erp";
7.     // sql方法名
8.     private final String method = "selectByErp";
9.     // sql模板
10.     private final String sqlTemplate = "SELECT %s FROM %s WHERE %s=#{%s} %s";
12.     @Override
13.     public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
14.                // 获取需要查询的字段名及属性名
15.         TableFieldInfo erpFiled = getErpProperty(tableInfo);
16.         // 拼接组装sql
17.         SqlSource sqlSource = new RawSqlSource(configuration, String.format(sqlTemplate,
18.                 sqlSelectColumns(tableInfo, false),
19.                 tableInfo.getTableName(),
20.                 erpFiled.getColumn(), erpFiled.getProperty(),
21.                 tableInfo.getLogicDeleteSql(true, false)), Object.class);
22.         return this.addSelectMappedStatementForTable(mapperClass, method, sqlSource, tableInfo);
23. }
24.         /**
25.      * 查询erp列信息
26.      */
27.     private TableFieldInfo getErpProperty(TableInfo tableInfo) {
28.         List<TableFieldInfo> fieldList = tableInfo.getFieldList();
29.         TableFieldInfo erpField = fieldList.stream().filter(filed -> filed.getColumn().equals(erpColumn)).findFirst().get();
30.         return erpField;
31.     }

复制代码

3.定义一个sql注入器GyhSqlInjector，添加SelectByErp对象

1. // 需注入到spring容器中
2. @Component
3. public class GyhSqlInjector extends DefaultSqlInjector {   
4.     @Override
5.     public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
6.         List<AbstractMethod> methodList = super.getMethodList(mapperClass);
7.         // 增加 SelectByErp对象，程序启动后自动加载
8.         methodList.add(new SelectByErp());
9.         return methodList;
10.     }
11. }

复制代码

4.定义一个基础MapperGyhBaseMapper，添加selectByErp方法

1. /**
2. * 自定义的通用Mapper
3. */
4. public interface GyhBaseMapper<T> extends BaseMapper<T> {
5.     List<T> selectByErp(String erp);
6. }

复制代码

5.应用中需要使用该SelectByErp方法的表，都继承GyhBaseMapper，那么这些表将都拥有了selectByErp这个查询方法，程序启动后会自动为这些表生成该sql。

1. public interface XXXMapper extends GyhBaseMapper<XXXTable>

复制代码

添加一个mybatisplus已有sql

1.mybatisplus 常用CRUD方法如最上图，这些方法已经默认会自动生成，但mybatisplus其实提供了更多的方法，如下图，只要我们在启动时添加进去，就可以使用了。

2.比如我想使用AlwaysUpdateSomeColumnById方法，该方法可以在更新时只更新我需要的字段，不进行全字段更新。添加步骤如下。
3.定义一个sql注入器 ，如GyhSqlInjector，添加AlwaysUpdateSomeColumnById对象

1. @Component
2. public class GyhSqlInjector extends DefaultSqlInjector {   
3.     @Override
4.     public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
5.         List<AbstractMethod> methodList = super.getMethodList(mapperClass);
6.         // 添加 AlwaysUpdateSomeColumnById 对象
7.         methodList.add(new AlwaysUpdateSomeColumnById());
8.         return methodList;
9.     }
10. }

复制代码

4.定义一个基础Mapper 如GyhBaseMapper，添加alwaysUpdateSomeColumnById方法

1. /**
2. * 自定义的通用Mapper
3. */
4. public interface GyhBaseMapper<T> extends BaseMapper<T> {
5.     int alwaysUpdateSomeColumnById(@Param(Constants.ENTITY) T entity);
6. }

复制代码

5.继承GyhBaseMapper的其他Mapper，将自动拥有alwaysUpdateSomeColumnById方法

1. /**
2. * 自定义的通用Mapper
3. */
4. public interface GyhBaseMapper<T> extends BaseMapper<T> {
5.     int alwaysUpdateSomeColumnById(@Param(Constants.ENTITY) T entity);
6. }

复制代码

6.继承GyhBaseMapper的其他Mapper，将自动拥有alwaysUpdateSomeColumnById方法
编辑一个mybatisplus已有sql

1.如果想编辑一个mybatisplus已有sql，比如分库分表系统，执行updateById操作时，虽然主键Id已确定，但目标表不确定，此时可能导致该sql在多张表上执行，造成资源浪费，并且分库分表字段不可修改，默认的updateById不能用，需要改造。以下以shardingsphere分库分表为例。
2.定义一个UpdateByIdWithSharding类，继承UpdateById类

1. public class UpdateByIdWithSharding extends UpdateById {
2.     private String columnDot = "`";
3.     private YamlShardingRuleConfiguration yamlShardingRuleConfiguration;
4.     // 注入shardingsphere的分库分表配置信息
5.     public UpdateByIdWithSharding(YamlShardingRuleConfiguration yamlShardingRuleConfiguration) {
6.         this.yamlShardingRuleConfiguration = yamlShardingRuleConfiguration;
7.     }
9.     @Override
10.     public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
11.         String tableName = tableInfo.getTableName();
12.         // shardingsphere 分库分表配置信息
13.         Map<String, YamlTableRuleConfiguration> tables = yamlShardingRuleConfiguration.getTables();
14.         // 判断当前表是否设置了分表字段
15.         if (tables.containsKey(tableName)) {
16.             YamlTableRuleConfiguration tableRuleConfiguration = tables.get(tableName);
17.             // 获取分表字段
18.             String shardingColumn = tableRuleConfiguration.getTableStrategy().getStandard().getShardingColumn();
19.             // 构建sql
20.             boolean logicDelete = tableInfo.isLogicDelete();
21.             SqlMethod sqlMethod = SqlMethod.UPDATE_BY_ID;
22.             // 增加分表字段判断
23.             String shardingAdditional = getShardingColumnWhere(tableInfo, shardingColumn);
24.             // 是否判断逻辑删除字段
25.             final String additional = optlockVersion() + tableInfo.getLogicDeleteSql(true, false);
26.             shardingAdditional = shardingAdditional + additional;
27.             String sql = String.format(sqlMethod.getSql(), tableInfo.getTableName(),
28.                     getSqlSet(logicDelete, tableInfo, shardingColumn),
29.                     tableInfo.getKeyColumn(), ENTITY_DOT + tableInfo.getKeyProperty(),
30.                     shardingAdditional);
31.             SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
32.             return addUpdateMappedStatement(mapperClass, modelClass, sqlMethod.getMethod(), sqlSource);
33.         } else {
34.             return super.injectMappedStatement(mapperClass, modelClass, tableInfo);
35.         }
36.     }
38.     /**
39.      * where条件增加分表字段
40.      */
41.     private String getShardingColumnWhere(TableInfo tableInfo, String shardingColumn) {
42.         StringBuilder shardingWhere = new StringBuilder();
43.         shardingWhere.append(" AND ").append(shardingColumn).append("=#{");
44.         shardingWhere.append(ENTITY_DOT);
45.         TableFieldInfo fieldInfo = tableInfo.getFieldList().stream()
46.                 .filter(f -> f.getColumn().replaceAll(columnDot, StringUtils.EMPTY).equals(shardingColumn))
47.                 .findFirst().get();
48.         shardingWhere.append(fieldInfo.getEl());
49.         shardingWhere.append("}");
50.         return shardingWhere.toString();
51.     }
53.     /**
54.      * set模块去掉分表字段
55.      */
56.     public String getSqlSet(boolean ignoreLogicDelFiled, TableInfo tableInfo, String shardingColumn) {
57.         List<TableFieldInfo> fieldList = tableInfo.getFieldList();
58.         // 去掉分表字段的set设置，即不修改分表字段
59.         String rmShardingColumnSet = fieldList.stream()
60.                 .filter(i -> ignoreLogicDelFiled ? !(tableInfo.isLogicDelete() && i.isLogicDelete()) : true)
61.                 .filter(i -> !i.getColumn().equals(shardingColumn))
62.                 .map(i -> i.getSqlSet(ENTITY_DOT))
63.                 .filter(Objects::nonNull).collect(joining(NEWLINE));
64.         return rmShardingColumnSet;
65.     }
66. }

复制代码

3.定义一个sql注入器GyhSqlInjector，添加UpdateByIdWithSharding对象

1. // 需注入到spring容器中
2. @Component
3. public class GyhSqlInjector extends DefaultSqlInjector {   
4.     /**
5.      * shardingsphere 配置信息
6.      */
7.     @Autowired
8.     private YamlShardingRuleConfiguration yamlShardingRuleConfiguration;
10.     @Override
11.     public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
12.         List<AbstractMethod> methodList = super.getMethodList(mapperClass);
13.         // 添加 UpdateByIdWithSharding 对象，并注入分库分表信息
14.         methodList.add(new UpdateByIdWithSharding(yamlShardingRuleConfiguration));
15.         return methodList;
16.     }
17. }

复制代码

4.定义一个基础MapperGyhBaseMapper，添加新的selectById方法

1. /**
2. * 自定义的通用Mapper
3. */
4. public interface GyhBaseMapper<T> extends BaseMapper<T> {
5.    int updateById(@Param(Constants.ENTITY) T entity);
6. }

复制代码

5.所有参与分表的表，在定义Mapper时继承GyhBaseMapper，那么在使用他的updateById方法时，将自动增加分库分表判断，准确命中目标表，减少其他分表查询的资源浪费。
以上是针对mybatisplus的一些简单改造，希望能为你提供一点点帮助~

作者：京东科技 郭艳红
来源：京东云开发者社区 转载请注明来源

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！