数据分表Mybatis Plus动态表名最优方案的探索

数据分表Mybatis Plus动态表名最优方案的探索

一、应用场景二、动态表名处理器接口实现三、测试实现效果

一、应用场景

大家在使用Mybatis进行开发的时候，经常会遇到一种情况：按照月份month将数据放在不同的表里面，查询数据的时候需要跟不同的月份month去查询不同的表。

但是我们都知道，Mybatis是ORM持久层框架，即：实体关系映射，实体Object与数据库表之间是存在一一对应的映射关系。比如：

@Datapublic class Student{ private Integer id; private String stuName; private

表结构

CREATE TABLE `student` ( `id` INT(11) NOT NULL AUTO_INCREMENT, `stu_name` VARCHAR(64) NOT NULL DEFAULT '0' COMMENT '姓名', `age` INT(11) NOT NULL COMMENT '年龄', PRIMARY KEY (`id`))COMMENT='学生表'COLLATE='utf8_general_ci'

Student 实体类与student表是一一对应的关系，如果我们希望将学员表按照月份进行分表，比如：student_202206、student_202207、student_202208，即产生了 「一个实体类及其Mapper需要操作多个数据库分月表，这种情况在Mybatis plus下我们该如何操作数据呢？」 其实方法有很多，我将我实践中总结出的最优方案给大家进行说明。

二、动态表名处理器接口实现

为了处理上述类似的问题，mybatis plus提供了动态表名处理器接口​ ​​TableNameHandler​​ ​，我们只需要实现这个接口，并将这个接口应用配置生效，即可实现动态表名。

需要注意的是：

ITableNameHandler

经过我一段时间的实践总结，我的实现类如下（基于mybatis plus 3.4.3.2之后的版本）：

import com.baomidou.mybatisplus.extension.plugins.handler.TableNameHandler;import java.util.Arrays;import java.util.List;/** * 按月份参数，组成动态表名 */public class MonthTableNameHandler implements TableNameHandler{ //用于记录哪些表可以使用该月份动态表名处理器（即哪些表按月分表） private List tableNames; //构造函数，构造动态表名处理器的时候，传递tableNames参数 public MonthTableNameHandler(String ...tableNames){ this.tableNames = Arrays.asList(tableNames); } //每个请求线程维护一个month数据，避免多线程数据冲突。所以使用ThreadLocal private static final ThreadLocal MONTH_DATA = new ThreadLocal<>(); //设置请求线程的month数据 public static void setData(String month){ MONTH_DATA.set(month); } //删除当前请求线程的month数据 public static void removeData(){ MONTH_DATA.remove(); } //动态表名接口实现方法 @Override public String dynamicTableName(String sql, String tableName){ if (this.tableNames.contains(tableName)){ return tableName + "_" + MONTH_DATA.get(); //表名增加月份后缀 }else{ return tableName; //表名原样返回

大家先对上面的代码有一个基础了解，看了下面的测试过程，再回头看上面的代码中的注释，就比较好理解了。表名处理器写好了之后，我们要让它生效，还需要做如下的配置。配置内容照葫芦画瓢就可以了。需要关注的部分，我都已经给大家添加了注释。

@Configuration@MapperScan("com.zimug")public class MybatisPlusConfig{ @Bean public MybatisPlusInterceptor mybatisPlusInterceptor(){ MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); DynamicTableNameInnerInterceptor dynamicTableNameInnerInterceptor = new DynamicTableNameInnerInterceptor(); dynamicTableNameInnerInterceptor.setTableNameHandler( //可以传多个表名参数，指定哪些表使用MonthTableNameHandler处理表名称 new MonthTableNameHandler("student","teacher") ); //以-的方式处理表名称 interceptor.addInnerInterceptor(dynamicTableNameInnerInterceptor); //可以传递多个-，即：可以传递多个表名处理器TableNameHandler //interceptor.addInnerInterceptor(dynamicTableNameInnerInterceptor); return

三、测试实现效果

首先创建一个StudentMapper ，默认情况下StudentMapper 只能操作student表，不能操作student_YYYYMM表。

@Mapperpublic interface StudentMapper extends BaseMapper {}

下面我们来写一个单元测试用例，该测试用例test函数模拟一次请求访问的Controller或者service函数。

@SpringBootTestclass DynamicTableNameTest{ @Resource private StudentMapper studentMapper; @Test void test(){ //执行数据操作之前设置月份（实际场景下该参数从请求参数中解析） MonthTableNameHandler.setData("202208"); studentMapper.selectById(1); //以id=2查询student_202208这张表 //阅后即焚，将ThreadLocal当前请求线程的数据移除

当我们执行这个单元测试用例的时候，我们发现控制台打印出如下信息，注意看SQL的部分，真的是去查询student_202208这张表了，而不是student表。这说明我们的动态表名实现是成功的。

​按 Esc 退出

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。