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

一、应用场景

大家在使用Mybatis进行开发的时候，经常会遇到一种情况：按照月份month将数据放在不同的表里面，查询数据的时候需要跟不同的月份month去查询不同的表。
但是我们都知道，Mybatis是ORM持久层框架，即：实体关系映射，实体Object与数据库表之间是存在一一对应的映射关系。比如：

1. @Data
2. public class Student {
3.     private Integer id;
4.     private String stuName;
5.     private Integer age;
6. }

复制代码

表结构

1. CREATE TABLE `student` (
2.     `id` INT(11) NOT NULL AUTO_INCREMENT,
3.     `stu_name` VARCHAR(64) NOT NULL DEFAULT '0' COMMENT '姓名',
4.     `age` INT(11) NOT NULL COMMENT '年龄',
5.     PRIMARY KEY (`id`)
6. )
7. COMMENT='学生表'
8. COLLATE='utf8_general_ci'
9. ENGINE=InnoDB
10. ;

复制代码

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

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

需要注意的是：

• 在mybatis plus 3.4版本之前，动态表名处理器接口是ITableNameHandler, 需要配合mybatis plus分页插件一起使用才能生效。我们这里只介绍3.4版本之后的实现方式。
  
• 在mybatis plus 3.4.3.2 作废该的方式：dynamicTableNameInnerInterceptor.setTableNameHandlerMap(map); 大家如果见到这种方式实现的动态表名，也是过时的实现方法，新版本中该方法已经删除。
  

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

1. import com.baomidou.mybatisplus.extension.plugins.handler.TableNameHandler;
3. import java.util.Arrays;
4. import java.util.List;
6. /**
7. * 按月份参数，组成动态表名
8. */
9. public class MonthTableNameHandler implements TableNameHandler {
11.     //用于记录哪些表可以使用该月份动态表名处理器（即哪些表按月分表）
12.     private List<String> tableNames;
13.     //构造函数，构造动态表名处理器的时候，传递tableNames参数
14.     public MonthTableNameHandler(String ...tableNames) {
15.         this.tableNames = Arrays.asList(tableNames);
16.     }
18.     //每个请求线程维护一个month数据，避免多线程数据冲突。所以使用ThreadLocal
19.     private static final ThreadLocal<String> MONTH_DATA = new ThreadLocal<>();
20.     //设置请求线程的month数据
21.     public static void setData(String month) {
22.         MONTH_DATA.set(month);
23.     }
24.     //删除当前请求线程的month数据
25.     public static void removeData() {
26.         MONTH_DATA.remove();
27.     }
29.     //动态表名接口实现方法
30.     @Override
31.     public String dynamicTableName(String sql, String tableName) {
32.         if (this.tableNames.contains(tableName)){
33.             return tableName + "_" + MONTH_DATA.get();  //表名增加月份后缀
34.         }else{
35.             return tableName;   //表名原样返回
36.         }
37.     }
38. }

复制代码

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

1. @Configuration
2. @MapperScan("com.zimug")
3. public class MybatisPlusConfig {
5.     @Bean
6.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
7.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
8.         DynamicTableNameInnerInterceptor dynamicTableNameInnerInterceptor = new DynamicTableNameInnerInterceptor();
9.         dynamicTableNameInnerInterceptor.setTableNameHandler(
10.                 //可以传多个表名参数，指定哪些表使用MonthTableNameHandler处理表名称
11.                 new MonthTableNameHandler("student","teacher")
12.         );
13.         //以拦截器的方式处理表名称
14.         interceptor.addInnerInterceptor(dynamicTableNameInnerInterceptor);
15.         //可以传递多个拦截器，即：可以传递多个表名处理器TableNameHandler
16.         //interceptor.addInnerInterceptor(dynamicTableNameInnerInterceptor);
17.         return interceptor;
18.     }
19. }

复制代码

三、测试实现效果

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

1. @Mapper
2. public interface StudentMapper extends BaseMapper<Student> {}

复制代码

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

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

复制代码

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

欢迎关注我的公告号：字母哥杂谈，回复003赠送作者专栏《docker修炼之道》的PDF版本，30余篇精品docker文章。字母哥博客：zimug.com

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