• Mybatis 拦截器（Mybatis插件原理）

    Mybatis为我们提供了拦截器机制用于插件的开发，使用拦截器可以无侵入的开发Mybatis插件，Mybatis允许我们在SQL执行的过程中进行拦截，提供了以下可供拦截的接口：

    1. Executor：执行器
    2. ParameterHandler：参数处理器
    3. StatementHandler：语句处理器
    4. ResultSetHandler：结果集处理器

    本篇我们使用拦截器统计查询语句的执行时间：

    一、执行时间拦截器

    在cn.horse.demo下创建QueryExecuteTimeInterceptor类

    QueryExecuteTimeInterceptor类：

    1. package cn.horse.demo;
    2.  
    3. import org.apache.ibatis.cache.CacheKey;
    4. import org.apache.ibatis.executor.Executor;
    5. import org.apache.ibatis.logging.Log;
    6. import org.apache.ibatis.logging.LogFactory;
    7. import org.apache.ibatis.mapping.BoundSql;
    8. import org.apache.ibatis.mapping.MappedStatement;
    9. import org.apache.ibatis.plugin.*;
    10. import org.apache.ibatis.session.ResultHandler;
    11. import org.apache.ibatis.session.RowBounds;
    12.  
    13. import java.util.Properties;
    14.  
    15. @Intercepts({
    16.         @Signature(type = Executor.class, method = "query", args = { MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class }),
    17.         @Signature(type = Executor.class, method = "query", args = { MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class })
    18. })
    19. public class QueryExecuteTimeInterceptor implements Interceptor {
    20.  
    21.     private static final Log LOG = LogFactory.getLog(QueryExecuteTimeInterceptor.class);
    22.  
    23.     @Override
    24.     public Object intercept(Invocation invocation) throws Throwable {
    25.         long startTime = System.currentTimeMillis();
    26.         Object result = invocation.proceed();
    27.         long endTime = System.currentTimeMillis();
    28.         LOG.debug("执行时间: " + (endTime - startTime) + "ms");
    29.         return result;
    30.     }
    31.  
    32.     @Override
    33.     public Object plugin(Object target) {
    34.         return Plugin.wrap(target, this);
    35.     }
    36.  
    37.     @Override
    38.     public void setProperties(Properties properties) {
    39.     }
    40. }

    @Intercepts：配置拦截器用于拦截的哪些接口中的哪些方法。

    @Signature：配置拦截器用于拦截的哪个接口中的哪个方法，需要提供接口类型，方法名，方法参数。

    这里我们拦截了Executor接口中的query方法，此方法是用于执行查询的方法；在实现中，Invocation对象包含了接口(被拦截的接口Executor)、方法(被拦截的方法query)、方法参数等信息，调用proceed方法用于执行被拦截的方法（这里被拦截的方法是Executor的query方法），我们在方法执行前和方法之后进行计时计算出查询的执行时间。

    二、配置拦截器

    在resources下新建mybatis-config.xml配置文件，并引入QueryExecuteTimeInterceptor拦截器

    1. "1.0" encoding="UTF-8" ?>
    2. configuration
    3.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    4.         "http://mybatis.org/dtd/mybatis-3-config.dtd">
    5. <configuration>
    6.     <settings>
    7.         <setting name="logImpl" value="JDK_LOGGING"/>
    8.     settings>
    9.     
    10.     <plugins>
    11.         <plugin interceptor="cn.horse.demo.QueryExecuteTimeInterceptor" />
    12.     plugins>
    13.  
    14.     <environments default="development">
    15.         <environment id="development">
    16.             <transactionManager type="JDBC"/>
    17.             <dataSource type="POOLED">
    18.                 <property name="driver" value="org.gjt.mm.mysql.Driver"/>
    19.                 <property name="url" value="jdbc:mysql://localhost:3306/demo?useUnicode=true&useSSL=false&characterEncoding=utf8&allowMultiQueries=true"/>
    20.                 <property name="username" value="root"/>
    21.                 <property name="password" value="horse"/>
    22.             dataSource>
    23.         environment>
    24.     environments>
    25. configuration>

    这里使用plugin标签在mybatis-config.xml配置文件中配置拦截器

    三、启动程序

    1、数据准备

    这里我们直接使用脚本初始化数据库中的数据

    1. -- 如果数据库不存在则创建数据库
    2. CREATE DATABASE IF NOT EXISTS demo DEFAULT CHARSET utf8;
    3. -- 切换数据库
    4. USE demo;
    5. -- 创建用户表
    6. CREATE TABLE IF NOT EXISTS T_USER(
    7.   ID INT PRIMARY KEY,
    8.   USERNAME VARCHAR(32) NOT NULL,
    9.   AGE INT NOT NULL 
    10. );
    11. -- 插入用户数据
    12. INSERT INTO T_USER(ID, USERNAME, AGE)
    13. VALUES(1, '张三', 20),(2, '李四', 22),(3, '王五', 24);

    创建了一个名称为demo的数据库；并在库里创建了名称为T_USER的用户表并向表中插入了数据

    2、创建实体类

    在cn.horse.demo下创建UserInfo类

    UserInfo类：

    1. package cn.horse.demo;
    2.  
    3. public class UserInfo {
    4.     private Integer id;
    5.     private String name;
    6.     private Integer age;
    7.  
    8.     public void setId(Integer id) {
    9.         this.id = id;
    10.     }
    11.  
    12.     public Integer getId() {
    13.         return id;
    14.     }
    15.  
    16.     public void setName(String name) {
    17.         this.name = name;
    18.     }
    19.  
    20.     public String getName() {
    21.         return name;
    22.     }
    23.  
    24.     public void setAge(Integer age) {
    25.         this.age = age;
    26.     }
    27.  
    28.     public Integer getAge() {
    29.         return age;
    30.     }
    31.  
    32.     @Override
    33.     public String toString() {
    34.         StringBuilder stringBuilder = new StringBuilder();
    35.         stringBuilder.append('{');
    36.         stringBuilder.append("id: " + this.id);
    37.         stringBuilder.append(", ");
    38.         stringBuilder.append("name: " + this.name);
    39.         stringBuilder.append(", ");
    40.         stringBuilder.append("age: " + this.age);
    41.         stringBuilder.append('}');
    42.         return stringBuilder.toString();
    43.     }
    44. }

    3、创建映射器、Mapper配置

    在cn.horse.demo下创建UserInfoMapper接口

    UserInfoMapper接口：

    1. package cn.horse.demo;
    2.  
    3. import java.util.List;
    4.  
    5. public interface UserInfoMapper {
    6.  
    7.     List find();
    8. }

    在resources下创建cn/horse/demo目录，并在此目录下创建UserInfoMapper.xml配置文件

    UserInfoMapper.xml配置：

    1. "1.0" encoding="UTF-8" ?>
    2. mapper
    3.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    4.         "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
    5. <mapper namespace="cn.horse.demo.UserInfoMapper">
    6.  
    7.     <resultMap id="userInfoMap" type="cn.horse.demo.UserInfo">
    8.         <result column="ID" property="id" />
    9.         <result column="USERNAME" property="name"/>
    10.         <result column="AGE" property="age"/>
    11.     resultMap>
    12.  
    13.     <select id="find" resultMap="userInfoMap">
    14.         SELECT
    15.             ID,
    16.             USERNAME,
    17.             AGE
    18.         FROM T_USER
    19.     select>
    20. mapper>

    4、引入配置文件

    在resources下mybatis-config.xml配置文件中引入UserInfoMapper映射器。

    1. <mappers>
    2.     <mapper class="cn.horse.demo.UserInfoMapper" />
    3. mappers>

    这里我们使用mapper引入映射器，只需要设置class属性为UserInfoMapper接口的全限类名。

    5、会话工具类

    在cn.horse.demo包下新建SqlSessionUtils工具类

    1. package cn.horse.demo;
    2.  
    3. import org.apache.ibatis.session.SqlSession;
    4. import org.apache.ibatis.session.SqlSessionFactory;
    5. import org.apache.ibatis.session.SqlSessionFactoryBuilder;
    6.  
    7. import java.io.InputStream;
    8. import java.util.Objects;
    9.  
    10. public class SqlSessionUtils {
    11.  
    12.     private static final SqlSessionFactory sqlSessionFactory;
    13.     static {
    14.         // 读取mybatis配置文件
    15.         InputStream inputStream = ClassLoader.getSystemClassLoader().getResourceAsStream("mybatis-config.xml");
    16.         // 根据配置创建SqlSession工厂
    17.         sqlSessionFactory = new SqlSessionFactoryBuilder()
    18.                 .build(inputStream);
    19.     }
    20.  
    21.     /**
    22.      * 开启会话
    23.      * @return
    24.      */
    25.     public static SqlSession openSession() {
    26.         return sqlSessionFactory.openSession();
    27.     }
    28.  
    29.     /**
    30.      * 关闭会话
    31.      * @param sqlSession
    32.      */
    33.     public static void closeSession(SqlSession sqlSession) {
    34.         if(Objects.nonNull(sqlSession)) {
    35.             sqlSession.close();
    36.         }
    37.     }
    38. }

    6、JDK 日志系统配置

    在resources的目录下新建logging.properties配置文件

    1. handlers=java.util.logging.ConsoleHandler
    2. .level=INFO
    3.  
    4. cn.horse.demo.UserInfoMapper.level=FINER
    5. java.util.logging.ConsoleHandler.level=ALL
    6. java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter
    7. java.util.logging.SimpleFormatter.format=%1$tY-%1$tm-%1$td %1$tT.%1$tL %4$s %3$s - %5$s%6$s%n

    在cn.horse.demo下创建JdkLogConfig类

    JdkLogConfig类：

    1. package cn.horse.demo;
    2.  
    3. import java.io.IOException;
    4. import java.io.InputStream;
    5. import java.util.logging.LogManager;
    6.  
    7. public class JdkLogConfig {
    8.  
    9.     public JdkLogConfig() {
    10.         try {
    11.             InputStream inputStream = ClassLoader.getSystemClassLoader().getResourceAsStream("logging.properties");
    12.             LogManager.getLogManager().readConfiguration(inputStream);
    13.         } catch (IOException e) {
    14.             throw new RuntimeException(e);
    15.         }
    16.     }
    17. }

    7、启动程序

    1. package cn.horse.demo;
    2.  
    3. import org.apache.ibatis.logging.Log;
    4. import org.apache.ibatis.logging.LogFactory;
    5. import org.apache.ibatis.session.SqlSession;
    6.  
    7. import java.util.List;
    8. import java.util.function.Consumer;
    9.  
    10. public class Main {
    11.  
    12.     private static final Log LOG;
    13.  
    14.     static {
    15.         // 引入JDK日志配置
    16.         System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");
    17.         LOG = LogFactory.getLog("cn.horse.demo.Main");
    18.     }
    19.  
    20.     public static void main(String[] args) {
    21.  
    22.         // 查询
    23.         find();
    24.     }
    25.  
    26.     private static void find() {
    27.         execute((UserInfoMapper userInfoMapper) -> {
    28.             List userInfoList = userInfoMapper.find();
    29.             for (UserInfo userInfo: userInfoList) {
    30.                 LOG.debug(userInfo.toString());
    31.             }
    32.         });
    33.     }
    34.  
    35.     private static void execute(Consumer function) {
    36.         SqlSession sqlSession = null;
    37.         try {
    38.             sqlSession = SqlSessionUtils.openSession();
    39.             function.accept(sqlSession.getMapper(UserInfoMapper.class));
    40.             sqlSession.commit();
    41.         } finally {
    42.             SqlSessionUtils.closeSession(sqlSession);
    43.         }
    44.     }
    45. }

    execute方法用于执行操作，方法中使用sqlSession.getMapper方法获取映射器对象，然后将映射器对象具体的执行操作委托给了Consumer对象。

    执行的结果如下：

  • 相关阅读:
    【多线程/JAVA】线程的几种状态总结以及sleep()、wait()方法的区别
    『力扣每日一题06』字符串中的第一个唯一字符
    Vulnhub实战-prime1
    mycat2搭建mysql一主双从集群
    【Mysql】重新认识mysql（一）
    三层交换机的工作原理
    解决windows termail中文乱码的问题
    【Rust指南】组织管理|路径表示|访问权限
    零基础学Java（12）静态字段与静态方法
    linux下python导入特定路径的包
  • 原文地址：https://blog.csdn.net/m1729339749/article/details/133668248