关于mysql:Mybatisplus使用TableNameHandler分表详解附完整示例源码

为什么要分表

Mysql 是以后互联网零碎中应用十分宽泛的关系数据库，具备 ACID 的个性。

然而 mysql 的单表性能会受到表中数据量的限度，次要起因是 B + 树索引过大导致查问时索引无奈全副加载到内存。读取磁盘的次数变多，而磁盘的每次读取对性能都有很大的影响。

这时一个简略可行的计划就是分表(当然土豪也能够堆硬件)，将一张数据量宏大的表的数据，拆分到多个表中，这同时也缩小了 B + 树索引的大小，缩小磁盘读取次数，进步性能。

两种根底分表逻辑

说完了为什么要分表，上面聊聊业务开发中常见的两种根底的分表逻辑。

按日期分表

这种形式通常会在表名的最初加上年月日，次要实用于按日期划分的统计数据或操作记录。在线实时展现的只有最近表中的数据，其余数据用于离线统计等。

按 id 取模分表

这种形式须要一个 id 生成器，例如 snowflake id 或分布式 id 服务。它保障了雷同 id 的数据都在一张表中，次要实用于保留用户根底信息，零碎中的资源信息，购买记录等。当然这种分表形式扩展性较差，前期数据继续增多后须要按 id 大小分库再分表处理。

上面看下这两种分表逻辑在 mybatis-plus 中的实现。

Mybatis-plus 中的分表实现

说到 java 的分表中间件，可能有人会想到 sharding-jdbc，作为应用很宽泛的一个分表中间件，性能也比较完善，然而应用它须要引入额定的 jar 包和减少学习老本。

实际上 mybatis-plus 自身就提供了一个分表的解决方案，配置应用都很简略，适宜疾速开发零碎。

动静表名处理器

没错，mybatis-plus 提供了动静表名处理器接口TableNameHandler，只须要在零碎中实现该接口，并作为插件加载到 mybatis-plus 中就能够应用，上面来看下具体的步骤。

3.4 版本之前的动静表名接口是 ITableNameHandler，须要和分页插件配合应用。

3.4 版本新增了TableNameHandler，在办法参数上勾销了MetaObject。这里用最新的版本为例，应用形式差异不大。

假如咱们的零碎中有两种分表形式，按日期分表和按 id 取模分表。通过四个步骤来看下具体的应用示例。

1. 创立日期表名处理器

先来看下日期解决的表名处理器，实现 TableNameHandler 接口后，在 dynamicTableName 办法中实现动静生成表名的逻辑，办法的返回值就是查问时要应用的表名。

/**
 * 按天分表解析
 */
public class DaysTableNameParser implements TableNameHandler {

    @Override
    public String dynamicTableName(String sql, String tableName) {String dateDay = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyyMMdd"));
        return tableName + "_" + dateDay;
    }
}

2. 创立 id 取模表名处理器

再来看下按 id 取模表名处理器的实现，这个处理器绝对日期解决就要简单一些，次要起因为 须要动静传入用于分表的 id 值。

在之前的版本中能够在办法中通过解析 MetaObject 中带有的 sql 查问信息，获取分表应用的值。然而这种形式比较复杂，对于不同的 QueryMapper 剖析的形式不同，比拟容易出错。新版本中的办法勾销了 MetaObject 参数，须要应用其余形式传入。

须要留神的是，表名处理器是作为 mybatis-plus 的插件，在我的项目启动时实例化的。这意味着，在运行过程中只有一个对象，多线程处理过程中，一个线程对参数的批改，会影响到其余线程。为了解决这个问题，能够应用 ThreadLocal 来定义参数。

因为当初的框架中大部分会应用线程池，例如 springboot web 我的项目中的 tomcat。所以在每次应用后，须要手动革除本次数据，避免线程复用时的影响。

具体实现如下:

/**
 * 按 id 取模分表处理器
 */
public class IdModTableNameParser implements TableNameHandler {
    private Integer mod;

    // 应用 ThreadLocal 避免多线程相互影响
    private static ThreadLocal<Integer> id = new ThreadLocal<Integer>();

    public static void setId(Integer idValue) {id.set(idValue);
    }

    IdModTableNameParser(Integer modValue) {mod = modValue;}

    @Override
    public String dynamicTableName(String sql, String tableName) {Integer idValue = id.get();
        if (idValue == null) {throw new RuntimeException("请设置 id 值");
        } else {String suffix = String.valueOf(idValue % mod);
            // 这里革除 ThreadLocal 的值，避免线程复用呈现问题
            id.set(null);
            return tableName + "_" + suffix;
        }
    }
}

3. 加载表名处理器

表名处理器理论是 mybatis-plus 的插件，须要在初始化时创立实例并加载。因为零碎中存在两种分表类型，在初始化时能够指定每张表应用的表名处理器。具体实现如下：

@Configuration
@MapperScan(basePackages = "com.yourcom.proname.repository.mapper.mainDb*", sqlSessionFactoryRef = "mainSqlSessionFactory")
public class MainDb {@Bean(name = "mainDataSource")
    @ConfigurationProperties(prefix = "dbconfig.maindb")
    public DataSource druidDataSource() {return DruidDataSourceBuilder.create().build();}

    @Bean(name = "mainTransactionManager")
    public DataSourceTransactionManager masterTransactionManager(@Qualifier(value = "mainDataSource") DataSource dataSource) {return new DataSourceTransactionManager(dataSource);
    }

    @Bean(name = "mainSqlSessionFactory")
    @ConfigurationPropertiesBinding()
    public SqlSessionFactory sqlSessionFactory(@Qualifier(value = "mainDataSource") DataSource dataSource) throws Exception {MybatisSqlSessionFactoryBean factoryBean = new MybatisSqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
          // 加载插件
        factoryBean.setPlugins(mybatisPlusInterceptor());
        return factoryBean.getObject();}

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        DynamicTableNameInnerInterceptor dynamicTableNameInnerInterceptor = new DynamicTableNameInnerInterceptor();
        HashMap<String, TableNameHandler> map = new HashMap<String, TableNameHandler>();

        // 这里为不同的表设置对应表名处理器
        map.put("user_daily_record", new DaysTableNameParser());
        map.put("user_consume_flow", new IdModTableNameParser(10));

        dynamicTableNameInnerInterceptor.setTableNameHandlerMap(map);
        interceptor.addInnerInterceptor(dynamicTableNameInnerInterceptor);
        return interceptor;
    }
}

4. 在 controller 中应用

上面通过 controller 中的三个接口，展现下应用形式：

@RestController
public class TableTestController {
    @Resource
    IUserDailyRecordService userDailyRecordService;

    @Resource
    IUserConsumeFlowService userConsumeFlowService;

    @GetMapping("user/record/today")
    public CommonResVo<UserDailyRecord> getRecordToday(Integer userId) throws Exception {
        // 这里在查问时，会依据零碎以后工夫，主动生成当天的表名
        UserDailyRecord userDailyRecord = userDailyRecordService.getOne(new LambdaQueryWrapper<UserDailyRecord>().eq(UserDailyRecord::getUserId, userId));
        return CommonResVo.success(userDailyRecord);
    }

    @GetMapping("user/consume/flow")
    public CommonResVo<List<UserConsumeFlow>> getConsumeFlow(Integer userId) throws Exception {
        // 设置用于分表的 id 值
        IdModTableNameParser.setId(userId);
        List<UserConsumeFlow> userConsumeFlowList = userConsumeFlowService.list(new LambdaQueryWrapper<UserConsumeFlow>().eq(UserConsumeFlow::getUserId, userId));
        return CommonResVo.success(userConsumeFlowList);
    }

    /**
     * 新增数据
     */
    @PostMapping("user/consume/flow")
    public CommonResVo<Boolean> addConsumeFlow(@RequestBody UserConsumeFlow userConsumeFlow) throws Exception {Integer userId = userConsumeFlow.getUserId();
        // 设置用于分表的 id 值
        IdModTableNameParser.setId(userId);
        userConsumeFlowService.save(userConsumeFlow);
        return CommonResVo.success(true);
    }
}

这篇对 mybatis-plus 动静表名处理器的介绍，通过实现 TableNameHandler 接口，能够按理论状况灵便定义表名的生成规定，心愿对大家有帮忙。

我的项目残缺示例地址：https://gitee.com/dothetrick/…

以上内容属集体学习总结，如有不当之处，欢送在评论中斧正