Mybatis-Plus--动态表名插件的用法

柔情只为你懂 2023-10-02 14:54 9阅读 0赞

原文网址：[Mybatis-Plus--动态表名插件的用法\_IT利刃出鞘的博客-CSDN博客][Mybatis-Plus--_IT_-CSDN]

## 简介 ##

**说明**

本文介绍MybatisPlus的动态表名插件的用法。

**官网**

[https://baomidou.com/guide/interceptor.html][https_baomidou.com_guide_interceptor.html]

**场景**

拿小编的实际项目来说，小编公司手里掌握着国内各个部分地区的医院患者数据，一个医院的患者的数据流量肯定是很大的，这个时候如果全部放在同一张表中，那么可想而知数据量的庞大。所以数据库设计的时候可以一家医院对应一张表，分开来存储，表中的列名都是一样的，只是表名不同。

或者还可以做日志的存储，日志数据量也是很大的，可以分一个月对应一张表，比如：log\_201907、log\_201908等等之类的。

## 配置 ##

package com.example.demo.config;
     
    import com.baomidou.mybatisplus.core.parser.ISqlParser;
    import com.baomidou.mybatisplus.core.parser.ISqlParserFilter;
    import com.baomidou.mybatisplus.core.parser.SqlParserHelper;
    import com.baomidou.mybatisplus.extension.parsers.DynamicTableNameParser;
    import com.baomidou.mybatisplus.extension.parsers.ITableNameHandler;
    import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
    import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
    import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor;
    import com.baomidou.mybatisplus.extension.plugins.tenant.TenantHandler;
    import com.baomidou.mybatisplus.extension.plugins.tenant.TenantSqlParser;
    import net.sf.jsqlparser.expression.Expression;
    import net.sf.jsqlparser.expression.StringValue;
    import org.apache.ibatis.mapping.MappedStatement;
    import org.apache.ibatis.reflection.MetaObject;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Profile;
     
    import java.util.*;
     
    @Configuration
    public class MyBatisPlusConfig {
        // 分页插件
        @Bean
        public PaginationInterceptor paginationInterceptor() {
            PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
     
            // 创建SQL解析器集合
            List<ISqlParser> sqlParserList = new ArrayList<>();
     
            // 动态表名SQL解析器
            DynamicTableNameParser dynamicTableNameParser = new DynamicTableNameParser();
            Map<String,ITableNameHandler> tableNameHandlerMap = new HashMap<>();
            // Map的key就是需要替换的原始表名
            tableNameHandlerMap.put("tb_user",new ITableNameHandler(){
                @Override
                public String dynamicTableName(MetaObject metaObject, String sql, String tableName) {
                    // 自定义表名规则，或者从配置文件、request上下文中读取
     
                    // 假设这里的用户表根据年份来进行分表操作
                    Date date = new Date();
                    String year = String.format("%tY", date);
                    // 返回最后需要操作的表名，sys_user_2019
                    return "tb_user_" + year;
                }
            });
            dynamicTableNameParser.setTableNameHandlerMap(tableNameHandlerMap);
            sqlParserList.add(dynamicTableNameParser);
            paginationInterceptor.setSqlParserList(sqlParserList);
     
            return paginationInterceptor;
        }
    }

## **测试** ##

MP会针对配置的表名做动态解析，从sql中可以看出表名已经替换成tb\_user\_2019了。

@Test
        public void select(){
            List<User> users = userMapper.selectList(Wrappers.<User>lambdaQuery().eq(User::getAge, 18));
            users.forEach(System.out::println);
        }

INFOStarted UserMapperTest in 3.409 seconds (JVM running for 4.233)
    DEBUG==>  Preparing: SELECT id, name, age, phone FROM tb_user_2019 WHERE tb_user_2019.tenant_id = 'jiannan' AND age = ? 
    DEBUG==> Parameters: 18(Integer)

**注意**

如果自定义规则的表名返回为空，则会按照实际的表名来处理。

如果配置了多租户SQL解析器，过滤了特定的sql，则也会按照实际表名来处理。  
如下代码使用了@SqlParser注解来过滤这条sql不需要加租户ID，执行这条sql的时候同样也会把动态表名SQL解析也会过滤掉，按照实际表名处理，MP可能后续版本会进行改进。

public interface UserMapper extends BaseMapper<User> {
        @SqlParser(filter = true)
        @Update("update xxx")
        int updateByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper, @Param("user") User user);
    }

## 其他网址 ##

[Mybatis-Plus\_贱男\_IT贱男-CSDN博客][Mybatis-Plus_IT_-CSDN]

[MyBatis-Plus 高级功能 —— 动态表名SQL解析器\_贱男-CSDN博客\_mybatis plus 动态表名][MyBatis-Plus _ _ _SQL_-CSDN_mybatis plus]

[Mybatis-Plus--_IT_-CSDN]: https://knife.blog.csdn.net/article/details/121274228
[https_baomidou.com_guide_interceptor.html]: https://baomidou.com/guide/interceptor.html
[Mybatis-Plus_IT_-CSDN]: https://blog.csdn.net/weixin_38111957/category_9020340.html
[MyBatis-Plus _ _ _SQL_-CSDN_mybatis plus]: https://blog.csdn.net/weixin_38111957/article/details/101196130