自定义MyBatis拦截器更改表名

by emanjusaka from ​ https://www.emanjusaka.top/archives/10 彼岸花开可奈何
本文欢迎分享与聚合，全文转载请留下原文地址。

自定义MyBatis拦截器可以在方法执行前后插入自己的逻辑，这非常有利于扩展和定制 MyBatis 的功能。本篇文章实现自定义一个拦截器去改变要插入或者查询的数据源。
@Intercepts

@Intercepts是Mybatis的一个注解，它的主要作用是标识一个类为拦截器。该注解通过一个@Signature注解(即拦截点),来指定拦截那个对象里面的某个方法。
具体来说，@Signature注解的属性type用于指定拦截器类型，可能的值包括：

• Executor（sql的内部执行器）
  
• ParameterHandler（拦截参数的处理）
  
• StatementHandler（拦截sql的构建）
  
• ResultSetHandler（拦截结果的处理）。
  

method属性表示在指定的拦截器类型中要拦截的方法
args属性表示拦截的方法对应的参数
实现步骤

• 实现org.apache.ibatis.plugin.Interceptor接口，重写一下的方法：
  
  
• 添加拦截器注解，@Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})})
  
• 配置文件中添加拦截器
  
  注意需要在 Spring Boot 的 application.yml 文件中配置 mybatis 配置文件的路径。
  mybatis拦截器目前不支持在application.yml配置文件中通过属性配置，目前只支持通过xml配置或者代码配置。
  

代码实现

Mybatis拦截器：

1. package top.emanjusaka.springboottest.mybatis.plugin;
3. import org.apache.ibatis.executor.statement.StatementHandler;
4. import org.apache.ibatis.mapping.BoundSql;
5. import org.apache.ibatis.mapping.MappedStatement;
6. import org.apache.ibatis.plugin.Interceptor;
7. import org.apache.ibatis.plugin.Intercepts;
8. import org.apache.ibatis.plugin.Invocation;
9. import org.apache.ibatis.plugin.Signature;
10. import org.apache.ibatis.reflection.DefaultReflectorFactory;
11. import org.apache.ibatis.reflection.MetaObject;
12. import org.apache.ibatis.reflection.SystemMetaObject;
13. import top.emanjusaka.springboottest.mybatis.annotation.DBTableStrategy;
15. import java.lang.reflect.Field;
16. import java.sql.Connection;
17. import java.util.regex.Matcher;
18. import java.util.regex.Pattern;
20. /**
21. * @Author emanjusaka
22. * @Date 2023/10/18 17:25
23. * @Version 1.0
24. */
25. @Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})})
26. public class DynamicMybatisPlugin implements Interceptor {
27.     private Pattern pattern = Pattern.compile("(from|into|update)[\\s]{1,}(\\w{1,})", Pattern.CASE_INSENSITIVE);
29.     @Override
30.     public Object intercept(Invocation invocation) throws Throwable {
31.         StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
32.         MetaObject metaObject = MetaObject.forObject(statementHandler, SystemMetaObject.DEFAULT_OBJECT_FACTORY, SystemMetaObject.DEFAULT_OBJECT_WRAPPER_FACTORY, new DefaultReflectorFactory());
33.         MappedStatement mappedStatement = (MappedStatement) metaObject.getValue("delegate.mappedStatement");
34.         // 获取自定义注解判断是否进行分表操作
35.         String id = mappedStatement.getId();
36.         String className = id.substring(0, id.lastIndexOf("."));
37.         Class<?> clazz = Class.forName(className);
38.         DBTableStrategy dbTableStrategy = clazz.getAnnotation(DBTableStrategy.class);
39.         if (null == dbTableStrategy || !dbTableStrategy.changeTable() || null == dbTableStrategy.tbIdx()) {
40.             return invocation.proceed();
41.         }
42.         // 获取SQL
43.         BoundSql boundSql = statementHandler.getBoundSql();
44.         String sql = boundSql.getSql();
45.         // 替换SQL表名
46.         Matcher matcher = pattern.matcher(sql);
47.         String tableName = null;
48.         if (matcher.find()) {
49.             tableName = matcher.group().trim();
50.         }
51.         assert null != tableName;
52.         String replaceSql = matcher.replaceAll(tableName + "_" + dbTableStrategy.tbIdx());
53.         // 通过反射修改SQL语句
54.         Field field = boundSql.getClass().getDeclaredField("sql");
55.         field.setAccessible(true);
56.         field.set(boundSql, replaceSql);
57.         field.setAccessible(false);
58.         return invocation.proceed();
59.     }
60. }

复制代码

mapper的xml：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
3.         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
4. <mapper namespace="top.emanjusaka.springboottest.score.repository.IScoreRepository">
5.     <select id="selectAll" resultType="top.emanjusaka.springboottest.score.model.vo.ScoreVO">
6.         select * from score
7.     </select>
8. </mapper>

复制代码

切换表名的注解：

1. package top.emanjusaka.springboottest.score.repository;
3. import org.apache.ibatis.annotations.Mapper;
4. import top.emanjusaka.springboottest.mybatis.annotation.DBTableStrategy;
5. import top.emanjusaka.springboottest.score.model.vo.ScoreVO;
7. import java.util.List;
9. /**
10. * @Author emanjusaka
11. * @Date 2023/10/18 17:45
12. * @Version 1.0
13. */
14. @Mapper
15. @DBTableStrategy(changeTable = true,tbIdx = "2")
16. public interface IScoreRepository {
17.     List<ScoreVO> selectAll();
18. }

复制代码

测试代码：

1. package top.emanjusaka.springboottest;
3. import org.junit.jupiter.api.Test;
4. import org.springframework.boot.test.context.SpringBootTest;
5. import top.emanjusaka.springboottest.score.model.vo.ScoreVO;
6. import top.emanjusaka.springboottest.score.service.IScore;
8. import javax.annotation.Resource;
9. import java.util.List;
11. @SpringBootTest
12. class SpringBootTestApplicationTests {
13.     @Resource
14.     private IScore score;
15.     @Test
16.     void contextLoads() {
17.         List<ScoreVO> list = score.selectAll();
18.         list.forEach(System.out::println);
19.     }
21. }

复制代码

运行结果


通过上图可以看出，现在表名已经修改成了score_2了。通过这种机制，我们可以应用到自动分表中。本文的表名的索引是通过注解参数传递的，实际应用中需要通过哈希散列计算。

本文原创，才疏学浅，如有纰漏，欢迎指正。如果本文对您有所帮助，欢迎点赞，并期待您的反馈交流，共同成长。
原文地址： https://www.emanjusaka.top/archives/10
微信公众号：emanjusaka的编程栈

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！