记录MYBATIS-PLUS动态表名的实现

2024-01-29 00:25:16 12 后端开发 737 12 百度已收录

实际上Mybatis-plus官方本来就有提供对动态表名的扩展支持以及给出了具体的Sample。

具体参考官方的sample github。从github的提交历史可以追溯到最开始给出动态表名实现方案的版本是3.1.1，在使用3.1.1以上的版本可以直接通过官方的例子完成

接下来我们尝试解析实现原理:


// 通过Configuration配置完成配置
@Configuration
//扫描自动注解和加载这个文件夹下的mapper文件
@MapperScan("com.baomidou.mybatisplus.samples.dytablename.mapper")
public class MybatisPlusConfig {
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        //分页器,可以看官方的介绍,这个不是重点
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 接下来是动态表名的实现
        DynamicTableNameParser dynamicTableNameParser = new DynamicTableNameParser();
        dynamicTableNameParser.setTableNameHandlerMap(new HashMap<String, ITableNameHandler>(2) {{
            put("user", (metaObject, sql, tableName) -> {
                String year = "_2018";
                int random = new Random().nextInt(1);
                if (random == 1) {
                    year = "_2019";
                }
                return tableName + year;
            });
        }});
        paginationInterceptor.setSqlParserList(Collections.singletonList(dynamicTableNameParser));
        return paginationInterceptor;
    }
}

接下来如果你的 MybatisPlus版本低于3.1.1的话:采用下面的方法实现

因为相关的支持，都是在3.1.1加进去的，所幸的是，3.1.1加进去的扩展所依赖的核心接口并没有改变，所以理论上是可以把3.1.1的扩展类代码copy到自己的项目，这样在3.1.0的版本就可与你实现动态表名了。具体涉及到的扩展类包括：

import com.baomidou.mybatisplus.extension.parsers.DynamicTableNameParser;
import com.baomidou.mybatisplus.extension.parsers.ITableNameHandler;

官方给出的只是一个随机表名，实际业务往往还有很多问题：

1、如何在调用mapper方法时传递我到底要决定使用什么表名？
最开始我琢磨了那个metaObject半天，期望从它入手，但并没有一个很通用的方式，而且在后续的版本中，这个metaObject甚至被移出了这个接口。后来才想到，这里最优的实现只能使用ThreadLocal了。

2、如果使用ThreadLocal，那就意味着每次调用mapper方法之前都要去set一下ThreadLocal，代码很累赘，能不能更优雅地实现呢？
很容易想到，使用AOP或者手写InvocationHandler动态代理的方式来解决。难得有机会手写一次AOP，终于下决心认真去学习了一下AOP那些什么切面，连接点，增强各种乱七八糟的概念，好不容易学完了，发现其实我根本不太用的上。用不上AOP是因为下面的原因3导致代理的不是bean。（有空写写AOP那些概念，其实很简单就能讲清楚）

3、使用动态代理，意味着代理的是mapper类，直接AOP代理mapper还是没办法拿到动态表名，怎么解决？
我想到了先用包装模式，把mapper和dynamicTableName包装起来，再进行AOP，这样包装类实例就得手动new没法用AOP了(也可能有别的办法让实例变成bean)，只能自己搞InvocationHandler了。

4、因为业务上，dynamicTableName每次都是查表获得的，mapper+dynamicTableName的组合包装类实际上每次都new的话属实有点不优雅，应该搞个缓存。
这里就千万要注意我们的mapper方法调用是每个request多线程并发调用的，缓存必须使用ConcurrentHashMap。

神奇吧，一下子，把面试常用的包装模式，动态代理，并发集合，ThreadLocal都玩了一遍，所以还是很有必要记录一下的。

具体实现代码:https://github.com/shougaoshougao/dynamictable

使用@Scope(“prototype”) + AOP + @Cacheable实现
今天闲着没事，决定尝试完全使用spring提供的机制来实现。修改包括一下几个方面：

1、使用@Scope(“prototype”)+@Lookup注入替代手动new MapperWrapper()。

2、使用@Cacheable+ConcurrentMapCacheManager替代手动使用ConcurrentHashMap。

3、使用AOP的@Aspect+@Around(“within(MapperWrapper)”)注解自动设置threadlocal。

详细代码:https://github.com/shougaoshougao/dynamictable/tree/aop

参考文档— 作者：方雲链接：http://events.jianshu.io/p/8f2736f21d8f