一、利用场景
大家在应用Mybatis进行开发的时候,常常会遇到一种状况:依照月份month将数据放在不同的表外面,查问数据的时候须要跟不同的月份month去查问不同的表。
然而咱们都晓得,Mybatis是ORM长久层框架,即:实体关系映射,实体Object与数据库表之间是存在一一对应的映射关系。比方:
@Datapublic class Student { private Integer id; private String stuName; private Integer age;}
表构造
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'ENGINE=InnoDB;
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之后的版本):
import com.baomidou.mybatisplus.extension.plugins.handler.TableNameHandler;import java.util.Arrays;import java.util.List;/** * 按月份参数,组成动静表名 */public class MonthTableNameHandler implements TableNameHandler { //用于记录哪些表能够应用该月份动静表名处理器(即哪些表按月分表) private List<String> tableNames; //构造函数,结构动静表名处理器的时候,传递tableNames参数 public MonthTableNameHandler(String ...tableNames) { this.tableNames = Arrays.asList(tableNames); } //每个申请线程保护一个month数据,防止多线程数据抵触。所以应用ThreadLocal private static final ThreadLocal<String> 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 interceptor; }}
三、测试实现成果
首先创立一个StudentMapper ,默认状况下StudentMapper 只能操作student表,不能操作student_YYYYMM表。
@Mapperpublic interface StudentMapper extends BaseMapper<Student> {}
上面咱们来写一个单元测试用例,该测试用例test函数模仿一次申请拜访的Controller或者service函数。
@SpringBootTestclass DynamicTableNameTest { @Resource private StudentMapper studentMapper; @Test void test() { //执行数据操作之前设置月份(理论场景下该参数从申请参数中解析) MonthTableNameHandler.setData("202208"); studentMapper.selectById(1); //以id=2查问student_202208这张表 //阅后即焚,将ThreadLocal以后申请线程的数据移除 MonthTableNameHandler.removeData(); }}
当咱们执行这个单元测试用例的时候,咱们发现控制台打印出如下信息,留神看SQL的局部,真的是去查问student_202208这张表了,而不是student表。这阐明咱们的动静表名实现是胜利的。
欢送关注我的布告号:字母哥杂谈,回复003赠送作者专栏《docker修炼之道》的PDF版本,30余篇精品docker文章。字母哥博客:zimug.com