一、應用場景
大家在使用Mybatis進行開發的時候，經常會遇到一種情況：按照月份month將資料放在不同的表里面，查詢資料的時候需要跟不同的月份month去查詢不同的表，
但是我們都知道，Mybatis是ORM持久層框架，即：物體關系映射，物體Object與資料庫表之間是存在一一對應的映射關系，比如：
@Data
public 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 = https://www.cnblogs.com/zimug/archive/2022/08/12/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表，
@Mapper
public interface StudentMapper extends BaseMapper<Student> {}
下面我們來寫一個單元測驗用例，該測驗用例test函式模擬一次請求訪問的Controller或者service函式，
@SpringBootTest
class 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
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/501686.html
標籤：其他