資料分表Mybatis Plus動態表名最優方案的探索

一、應用場景

大家在使用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 = 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