一、背景
先抛出一个问题,我们项目是基于mybatis-plus做Dao层开发,我现在有两个表结构相同的表table1和table2,如何对这两个表做操作呢,写两个Mapper和两个xxxPO?这显然不够优雅,但是如果我们的Mapper中有很多自定义的逻辑和方法或者table表不是两个而是10个呢,那么显然重复写Mapper和xxxPO不符合复用性和可扩展性,那么在Mybatis-Plus中如何使用一个Mapper和xxxPO查询多个表结构相同的表,这里可以借助MybatisPlus的动态表名拦截器。
二、实现过程
1.需求
存在3个表结构相同的表t_user1、t_user2、t_user3,我想通过一套Mapper及PO实现对这三个表的手动或以某种策略的增删改查。
2.环境准备
以mysql数据库为例,建表语句如下:
CREATE TABLE `t_user1` (
`id` int(11) NOT NULL,
`name` varchar(255) DEFAULT NULL,
`age` int(11) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
对应的Mapper为UserMapper。
package com.fkp.dynamic_table_name.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.fkp.dynamic_table_name.entity.User;
/**
* @author fkp
*/
public interface UserMapper extends BaseMapper<User> {
}
对应的实体类为User。注意这里的@TableName("t_user")是t_user不是具体的哪个表名。
package com.fkp.dynamic_table_name.entity;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
/**
* @author fkp
*/
@TableName("t_user")
@Data
public class User {
@TableId
private Integer id;
private String name;
private Integer age;
}
3.实现动态表名切换
①手动切换
借助ThreadLocal,执行查询前设置ThreadLocal中的值来决定查哪个表。
定义手动切换的工具类
package com.fkp.dynamic_table_name.utils;
/**
* @author fengkunpeng
* @version 1.0
* @description
* @date 2023/9/20 15:56
*/
public class DynamicTableNameUtils {
//t_user -> t_user1 - t_user3
private static final ThreadLocal<Integer> DYNAMIC_TABLE_T_USER = new ThreadLocal<>();
public static void applyTable(int index){
DYNAMIC_TABLE_T_USER.set(index);
}
public static void releaseCurrTableName(){
//默认访问t_user1
DYNAMIC_TABLE_T_USER.set(1);
}
public static String getCurrTableName(){
return "t_user" + DYNAMIC_TABLE_T_USER.get();
}
}
实现MybatisPlus动态表明拦截器,实现逻辑。
package com.fkp.dynamic_table_name.config;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.DynamicTableNameInnerInterceptor;
import com.fkp.dynamic_table_name.constant.CommonConstants;
import com.fkp.dynamic_table_name.utils.DynamicTableNameUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.Optional;
/**
* @author fengkunpeng
* @version 1.0
* @description
* @date 2023/9/20 15:41
*/
@Configuration(proxyBeanMethods = false)
public class MybatisPlusConfig {
//拦截器,获取到表名给替换
@Bean
public MybatisPlusInterceptor dynamicTableNameInnerInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
DynamicTableNameInnerInterceptor dynamicTableNameInnerInterceptor = new DynamicTableNameInnerInterceptor();
dynamicTableNameInnerInterceptor.setTableNameHandler((sql, tableName) -> {
//若操作的表是t_user表,则从ThreadLocal中取表名t_user1 - t_user3,默认t_user1
if(StringUtils.equalsIgnoreCase(CommonConstants.TABLE_KEY_OBJECT, tableName)){
tableName = DynamicTableNameUtils.getCurrTableName();
//执行完本次操作后还原标志位,避免在后续操作中影响对原来表的正常操作
DynamicTableNameUtils.releaseCurrTableName();
}
return tableName;
//这里也可以采用某种策略切换表名,例如t_user(id%3 + 1)
});
interceptor.addInnerInterceptor(dynamicTableNameInnerInterceptor);
return interceptor;
}
}
②自动切换
使用某种策略决定对哪个表操作,例如id%3 + 1为表的后缀。
实现过程参考手动切换场景,只不过不需要ThreadLocal的工具类,直接在拦截器中书写相关逻辑即可。
遗留问题
在拦截器中无法取到预编译sql对应的参数。后续解决。