前言

随着我们开发的阅读平台内容越来越丰富，注册的用户越来越多，单表的数据存储结构已经不能满足项目的需求。我们需要对用户表进行必要的拆分以提高系统的可靠性和可用性，目前我们把用户表拆分为 256个子表，如图：

对数据表拆分的方式有很多，经典的如 Sharding JDBC，这里我介绍如何使用MyBatis-Plus的动态表名插件 实现数据的拆分。

动态表名插件是什么？

DynamicTableNameInnerInterceptor是mybatis-plug的一个拦截器插件，可以自己定义需要拦截的表单，然后对它进行加工，这时mybatis-plus就会把SQL代码的表名加上你的这个装饰。

• 原理为解析替换设定表名为处理器的返回表名，表名建议可以定义复杂一些避免误替换
• 例如：真实表名为 user 设定为 UserTableNameHandler 处理器替换为 user_0001 等
• TableNameHandler tableNameHandler是一个接口。使用动态表名插件时，必须要有 TableNameHandler的实现类。

public interface TableNameHandler {
    String dynamicTableName(String sql, String tableName);
}

DynamicTableNameInnerInterceptor 的changeTable 方法 如下

栗子

模拟使用场景

一个 User 对应多张表（多张表结构一致，只有表名称不同），在使用时，可以动态映射表名称。
比如：按照用户ID分表，根据自定义的Hash算法找到我们需要的表名。

表user_0001

CREATE TABLE `user_0001` (
  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `nick_name` varchar(32) NOT NULL COMMENT '用户昵称',
  `gender` tinyint(2) unsigned NOT NULL COMMENT '性别',
  `type` tinyint(2) unsigned NOT NULL COMMENT '用户类型',
  `is_vip` tinyint(2) unsigned NOT NULL COMMENT '是否VIP',
  `grade` tinyint(2) unsigned NOT NULL COMMENT '等级',
  `create_time` datetime NOT NULL COMMENT '创建时间',
  `address` varchar(256) DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `idx_nickname` (`nick_name`)
) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='用户表';

表user_0002

CREATE TABLE `user_0002` (
  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `nick_name` varchar(32) NOT NULL COMMENT '用户昵称',
  `gender` tinyint(2) unsigned NOT NULL COMMENT '性别',
  `type` tinyint(2) unsigned NOT NULL COMMENT '用户类型',
  `is_vip` tinyint(2) unsigned NOT NULL COMMENT '是否VIP',
  `grade` tinyint(2) unsigned NOT NULL COMMENT '等级',
  `create_time` datetime NOT NULL COMMENT '创建时间',
  `address` varchar(256) DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `idx_nickname` (`nick_name`)
) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='用户表';

引入依赖

<dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.3</version>
        </dependency>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-core</artifactId>
            <version>5.7.13</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>
        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.23</version>
        </dependency>
        <!--druid-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.11</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.21</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <type>jar</type>
            <version>2.0.32</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.2</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
            <version>3.4.1</version>
        </dependency>
    </dependencies>

DbTableUtil 分表类

/**
 * Hash 分表
 * @author yangyanping
 * @date 2024-03-29
 */
public class DbTableUtil {
    private static final int TABLE_SIZE = 256;

    public DbTableUtil() {
    }

    public static String getTableIndex(Object shardKey, int sliceSize) {
        int hashValue = Math.abs(shardKey.hashCode());
        int tableIndex = hashValue % sliceSize + 1;
        return String.format("%04d", tableIndex);
    }

    public static String hash(long key, int sliceSize) {
        long hashValue = Math.abs(key);
        int tableIndex = (int)(hashValue % (long)sliceSize + 1L);
        return String.format("%04d", tableIndex);
    }

    public static String hash(long key) {
        return hash(key, 256);
    }
}

请求参数动态表名传递辅助类

/**
 * 请求参数动态表名传递辅助类
 *
 * @author yangyanping
 * @date 2024-03-29
 */
public class RequestDynamicTableNameHelper {

    /**
     * 请求参数存取（表名）。请求参数自定义，官方Demo定义为ThreadLocal<Map<String, Object>>
     */
    private static final ThreadLocal<String> REQUEST_DATA = new ThreadLocal<>();

    /**
     * 设置请求参数
     *
     * @param requestData
     *            请求参数-表名
     */
    public static void setRequestData(String requestData) {
        REQUEST_DATA.set(requestData);
    }

    /**
     * 获取请求参数
     *
     * @return 请求参数-表名
     */
    public static String getRequestData() {
        return REQUEST_DATA.get();
    }

    /**
     * 移除获取请求参数（表名）
     */
    public static void remove() {
        REQUEST_DATA.remove();
    }
}

动态表名处理器

/**
 * 动态表名处理器---根据用户ID分表
 * mybatis-plus提供了动态表名处理器接口TableNameHandler，
 * 只需要在系统中实现该接口，并作为插件加载到mybatis-plus中就可以使用
 *
 * @author yangyanping
 * @date 2023-02-15
 */
@Slf4j
public class UserTableNameHandler implements TableNameHandler {
    @Override
    public String dynamicTableName(String sql, String tableName) {
        //表名增加hash值
        String userId = RequestDynamicTableNameHelper.getRequestData();
        String tabSuffix = tableName + "_" + DbTableUtil.getTableIndex(Convert.toLong(userId), 256);
        log.info("UserAscribe#tabSuffix={}", tabSuffix);

        return tabSuffix;
    }
}

注入动态表名插件

MyBatisPlusConfig配置中添加动态表名 DynamicTableNameInnerInterceptor插件。

使用多个功能插件时注意顺序关系，官方建议使用如下顺序：

• 多租户,动态表名
• 分页,乐观锁
• sql 性能规范,防止全表更新与删除

@Configuration
@MapperScan("com.mysql.dao.user")
public class MyBatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(dynamicTableNameInnerInterceptor());

        return interceptor;
    }

    @Bean
    public DynamicTableNameInnerInterceptor dynamicTableNameInnerInterceptor(){
        DynamicTableNameInnerInterceptor dynamicTableNameInnerInterceptor =
                new DynamicTableNameInnerInterceptor();

        Map<String, TableNameHandler> tableNameHandlerMap = new HashMap<>();

        TableNameHandler userTableNameHandler = new UserTableNameHandler();
        tableNameHandlerMap.put("user", userTableNameHandler);

        dynamicTableNameInnerInterceptor.setTableNameHandlerMap(tableNameHandlerMap);

        return dynamicTableNameInnerInterceptor;
    }
}

UserInfo 类和 UserInfoDao

@Data
@TableName("user")
public class UserInfo {
    private Long id;

    private String nickName;

    private Integer gender;

    private Integer type;

    private Integer isVip;

    private Integer grade;

    private String address;
}

public interface BookInfoDao {
}

单元测试

@RunWith(SpringRunner.class)
@SpringBootTest(classes = WebApplication.class)
public class DynamicTableNameTest {

    @Resource
    private UserInfoDao userInfoDao;

    @Test
    public void insert0001() {
        RequestDynamicTableNameHelper.setRequestData("1");
        UserInfo userInfo = new UserInfo();
        userInfo.setId(1L);
        userInfo.setNickName("user1");
        userInfo.setGender(1);
        userInfo.setType(1);
        userInfo.setGrade(1);
        userInfo.setIsVip(1);
        userInfo.setAddress("");
        userInfo.setCreateTime(new Date());
        userInfoDao.insert(userInfo);
    }

    @Test
    public void insert0256() {
        RequestDynamicTableNameHelper.setRequestData("256");
        UserInfo userInfo = new UserInfo();
        userInfo.setId(256L);
        userInfo.setNickName("user256");
        userInfo.setGender(1);
        userInfo.setType(1);
        userInfo.setGrade(1);
        userInfo.setIsVip(1);
        userInfo.setAddress("");
        userInfo.setCreateTime(new Date());
        userInfoDao.insert(userInfo);
    }
}