MyBatis-Plus 动态表名SQL解析器的实现

一、引言

先来说下动态名表在什么场景下需要使用呢？

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

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

二、具体实现

动态表名SQL解析器也是基于MP分页插件来实现的，代码如下：

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.*;

/**
 * @Auther: IT贱男
 * @Date: 2019/6/12 15:06
 * @Description: MybatisPlus配置类
 */
@Configuration
public class MyBatisPlusConfig {

  /**
   * 分页插件
   *
   * @return
   */
  @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("sys_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 "sys_user_" + year;
      }
    });
    dynamicTableNameParser.setTableNameHandlerMap(tableNameHandlerMap);
    sqlParserList.add(dynamicTableNameParser);
    paginationInterceptor.setSqlParserList(sqlParserList);

    return paginationInterceptor;
  }

}

代码演示：MP会针对配置的表名做动态解析，从sql中可以看出表名已经替换成sys_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, login_name, name, password, email, salt, sex, age, phone, user_type, status, organization_id, create_time, update_time, version, tenant_id FROM sys_user_2019 WHERE sys_user_2019.tenant_id = 'jiannan' AND is_delete = '0' AND age = ?
DEBUG==> Parameters: 18(Integer)

三、注意细节

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

细节二：如果配置了多租户SQL解析器，过滤了特定的sql，则也会按照实际表名来处理。

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

/**
 * <p>
 * 用户 Mapper 接口
 * </p>
 *
 * @author IT贱男
 * @since 2019-06-14
 */
public interface UserMapper extends BaseMapper<User> {

  /**
   * 自定Wrapper修改
   *
   * @param userWrapper 条件构造器
   * @param user    修改的对象参数
   * @return
   */
  @SqlParser(filter = true)
  int updateByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper, @Param("user") User user);

}

到此这篇关于MyBatis-Plus 动态表名SQL解析器的实现的文章就介绍到这了,更多相关MyBatis-Plus 动态表名SQL解析器内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！