扛起来——mybatis自定义分页插件（PageHelper）和自定义日志打印（Log）

最新推荐文章于 2024-04-19 15:49:21 发布

华达州

最新推荐文章于 2024-04-19 15:49:21 发布

阅读量814

点赞数

分类专栏：笔记项目文章标签： mybatis java maven mysql

华达州猛学java

本文链接：https://blog.csdn.net/m0_46841460/article/details/119516176

版权

笔记同时被 2 个专栏收录

7 篇文章 0 订阅

订阅专栏

项目

7 篇文章 0 订阅

订阅专栏

文章目录

一、环境准备

为了不被其他干扰，本项目单纯的引入mybatis依赖和测试环境

1、导入以下依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.hdz</groupId>
    <artifactId>mybatisPluginTest</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <!--mybatis核心包-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.3</version>
        </dependency>
        <!--mysql驱动包-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
        </dependency>
        <!-- 单元测试 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

2、创建mybatis核心配置文件（SqlMapConfig.xml）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
    <environments default="mysql">
        <environment id="mysql">
            <!--配置事务的类型，使用本地事务策略-->
            <transactionManager type="JDBC"></transactionManager>
            <!--是否使用连接池 POOLED表示使用链接池，UNPOOLED表示不使用连接池-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/demo0806"/>
                <property name="username" value="root"/>
                <property name="password" value="123"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="mapper/UserMapper.xml"></mapper>
    </mappers>
</configuration>

上面的配置文件并没有加入我们自定义的插件

二、创建实体类和mapper层

1、创建User实体类

public class User {
    private Integer id;
    private String username;
    private String nickName;
    private Date birthday;
    private String sex;
    private String address;
}

2、创建自定义的Page类和PageHelper

public class HdzPage {

    //当前页码数
    private long pageNum;

    //每页条数
    private long pageSize;

    //查询的偏移量
    private long offset;

    public HdzPage(long pageNum,long pageSize){
        this.pageNum = pageNum;
        this.pageSize = pageSize;
        this.offset = (pageNum-1)*pageSize;
    }
}

public class HdzPageHelper {

    //类似于一个本地缓存
    private static final ThreadLocal<HdzPage> LOCAL_PAGE = new ThreadLocal<HdzPage>();

    //开启分页
    public static void startPage(long pageNum,long pageSize){
        HdzPage hdzPage = new HdzPage(pageNum, pageSize);
        LOCAL_PAGE.set(hdzPage);
    }

    //移除分页参数
    public static void removePage(){
        LOCAL_PAGE.remove();
    }

    //获取分页参数
    public static HdzPage getPage(){
        return LOCAL_PAGE.get();
    }

}

注意：上面使用的LOCAL_PAGE类似于一个缓存，它能保证线程安全的存储一个变量

在mybatis中只提供了四个可供拦截的方法：

ParameterHandler：处理SQL的参数对象；
(getParameterObject, setParameters)
ResultSetHandler：处理SQL的返回结果集；
(handleResultSets, handleOutputParameters)
StatementHandler：执行SQL语句；
(prepare, parameterize, batch, update, query)
Executor：执行器，执行增删改查操作；
(update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)

虽然提供了四个可拦截扩展的方法，但是只有一个Interceptor接口，需要使用注解@Intercepts和@Signature来指定拦截的方法。

我们看一下@Signature注解的源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({})
public @interface Signature {
	//需要拦截的类型（这里我们需要拦截执行器Executor）
    Class<?> type();
	//需要拦截的方法（我们需要添加分页插件，所以拦截查询方法query）
    String method();
	//被拦截方法的参数列表
    Class<?>[] args();
}

3、创建HdzPageInterceptor并实现Interceptor接口

@Intercepts(
        {
                @Signature(type = Executor.class,method ="query",args = {MappedStatement.class,Object.class, RowBounds.class, ResultHandler.class}),
                @Signature(type = Executor.class,method ="query",args = {MappedStatement.class,Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class})
        }
)
public class HdzPageInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        try {
            // 从 invocation 中获取参数
            Object[] args = invocation.getArgs();

            //第一个默认是MappedStatement(解析xml文件之后)
            MappedStatement ms = (MappedStatement)args[0];

            //第二个默认是查询参数
            Object parameter = args[1];

            //第三个默认是RowBounds
            RowBounds rowBounds = (RowBounds)args[2];

            //第四个默认是结果处理resultHandler
            ResultHandler resultHandler = (ResultHandler) args[3];

            //获取sql执行器
            Executor executor = (Executor) invocation.getTarget();
            CacheKey cacheKey;
            BoundSql boundSql;

            //获取分页参数
            HdzPage page = HdzPageHelper.getPage();
            //如果开启了分页
            if(page!=null){
                //获取之前绑定的sql
                boundSql = ms.getBoundSql(parameter);
                //拼接并获取开启分页之后的sql
                String pageSql = getPageSql(boundSql,page);
                //重新绑定sql
                BoundSql pageBoundSql = new BoundSql(ms.getConfiguration(), pageSql, boundSql.getParameterMappings(), parameter);
                //重新生成缓存主键
                cacheKey = executor.createCacheKey(ms, parameter, rowBounds, boundSql);
                //返回执行器的query方法
                return executor.query(ms, parameter, RowBounds.DEFAULT, resultHandler,cacheKey,pageBoundSql);
            }
            //执行后续操作   注意：一定不要忘记这行代码，如果不加，则后续操作不会执行
            return invocation.proceed();
        } finally {
            //无论是否执行成功都移除缓存当中的分页参数
                HdzPageHelper.removePage();
        }
    }

    @Override
    public Object plugin(Object target) {
        //将插件加入，动态代理之后就能返回加入插件的代理对象
        return Plugin.wrap(target,this);
    }

    @Override
    public void setProperties(Properties properties) {

    }

    /**
     * 获取拼接分页之后的sql语句
     * @author 华达州
     * @date 2021/8/8 15:17
     * @param boundSql
     * @param page
     * @return java.lang.String
     */
    private String getPageSql(BoundSql boundSql,HdzPage page){
        String sql = boundSql.getSql();
        StringBuilder sqlBuilder = new StringBuilder();
        sqlBuilder.append(sql);
        if(page.getOffset() > 0){
        //拼接sql，在原先的sql语句后面拼接" limit offset,pageSize "
            sqlBuilder.append(" LIMIT ").append(page.getOffset()).append(",").append(page.getPageSize());
        }else{
            sqlBuilder.append(" LIMIT ").append(page.getPageSize());
        }
        return sqlBuilder.toString();
    }
}

三、测试结果

1、不添加分页插件

@Test
    public void testFindAll() throws IOException {
        //加载主配置文件，目的是为了构建SqlSessionFactory对象
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");

        //创建SqlSessionFactory对象
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);

        //通过SqlSessionFactory工厂对象创建SqlSesssion对象
        SqlSession sqlSession = factory.openSession();

        //通过Session创建UserDao接口代理对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = mapper.findAll();
        for (User user : userList) {
            System.out.println(user);
        }
    }

结果输出：
在这里插入图片描述
下面是UserMapper.xml文件，执行的语句是查询所有

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.hdz.mapper.UserMapper">
    <select id="findAll" resultType="com.hdz.entity.User">
        select * from user
    </select>
</mapper>

我们发现一共有三条数据

2、开启分页插件

首先在SqlMapConfig.xml文件中添加插件：

<plugins>
        <plugin interceptor="com.hdz.plugin.HdzPageInterceptor"></plugin>
</plugins>

随后测试：

@Test
    public void testFindWithPage() throws IOException{
        //加载主配置文件，目的是为了构建SqlSessionFactory对象
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");

        //创建SqlSessionFactory对象
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);

        //通过SqlSessionFactory工厂对象创建SqlSesssion对象
        SqlSession sqlSession = factory.openSession();

        //通过Session创建UserDao接口代理对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        HdzPageHelper.startPage(1,2);
        List<User> userList = mapper.findAll();
        for (User user : userList) {
            System.out.println(user);
        }
    }

测试结果：
在这里插入图片描述
我们发现，开启分页之后，指定当前页码为1，每页条数为2，即 HdzPageHelper.startPage(1,2);输出为两条数据，说明分页功能成功，插件集成完毕

四、自定义日志插件

有了上面的自定义分页插件的基础，日志插件就再简单不过了。主要体现为在拦截方法的时候打印一点东西，可能在执行前，也可能在执行后

1、定义SQlLogPlugin实现Interceptor接口

//args: 你需要mybatis传入什么参数给你 type :你需要拦截的对象  method=要拦截的方法
@Intercepts(
        @Signature(type = StatementHandler.class,method ="prepare",args = {Connection.class,Integer.class})
)
public class SQlLogPlugin implements Interceptor {

    private String methodPageFlag;

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        System.out.println("......................StatementHandler");
        Object o = invocation.proceed();
        System.out.println("......................StatementHandler-after");
        return o;
    }
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target,this);
    }
    
    @Override
    public void setProperties(Properties properties) {
        methodPageFlag = properties.getProperty("methodPageFlag");
        System.out.println("testName："+properties.getProperty("testName"));
        System.out.println("methodPageFlag："+methodPageFlag);

    }
}

这里实现的主要是打印东西，可以看见我们在后续操作执行前和执行后都进行了打印

2、测试日志插件

同样在SqlMapConfig.xml配置文件中添加插件，这次我们结合分页插件一起使用：

<plugins>
        <plugin interceptor="com.hdz.plugin.HdzPageInterceptor"></plugin>
        <plugin interceptor="com.hdz.plugin.SQlLogPlugin">
            <property name="testName" value="华达州"/>
            <property name="methodPageFlag" value="Page"/>
        </plugin>
    </plugins>

测试结果如下：
在这里插入图片描述
以上就是所有内容了，功能可以自己扩展，那个打印日志的我只测试了拦截StatementHandler方法，还有三个方法可以自行测试
项目地址：https://gitee.com/huadazhou/mybatis-plugin.git
拿走记得关注

华达州

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
打赏
0
评论
扛起来——mybatis自定义分页插件（PageHelper）和自定义日志打印（Log）

文章目录一、环境准备1、导入以下依赖2、创建mybatis核心配置文件（SqlMapConfig.xml）二、创建实体类和mapper层1、创建User实体类2、创建自定义的Page类和PageHelper3、创建HdzPageInterceptor并实现Interceptor接口三、测试结果1、不添加分页插件2、开启分页插件四、自定义日志插件1、定义SQlLogPlugin实现Interceptor接口2、测试日志插件一、环境准备为了不被其他干扰，本项目单纯的引入mybatis依赖和测试环境1、导入
复制链接

扫一扫