spring-boot 集成mybatis的分页插件PageHelper和Generator (番外)

2023-10-31

分页插件PageHelper

参看了pagehelper-spring-boot,使用起来非常放方便,关于更多PageHelper可以点击https://github.com/pagehelper/Mybatis-PageHelper

添加maven依赖

根据上面地址中的说明,只需要添加如下依赖,并且可以不再mybatis的依赖

<!--分页插件-->
<dependency>
      <groupId>com.github.pagehelper</groupId>
      <artifactId>pagehelper-spring-boot-starter</artifactId>
      <version>1.0.0</version>
</dependency>

拦截器PageInterceptor

PageInterceptor是PageHelper-5.0版本中新的拦截器,com.github.pagehelper.PageHelper则成为了接口Dialect的一个实现类

在拦截器PageInterceptor中可以看到如下内容

    private Dialect dialect;
    private String default_dialect_class = "com.github.pagehelper.PageHelper";

    public void setProperties(Properties properties) {
        this.msCountMap = CacheFactory.createCache(properties.getProperty("msCountCache"), "ms", properties);
        String dialectClass = properties.getProperty("dialect");
        if(StringUtil.isEmpty(dialectClass)) {
            dialectClass = this.default_dialect_class;
        }

        try {
            Class e = Class.forName(dialectClass);
            this.dialect = (Dialect)e.newInstance();
        } catch (Exception var5) {
            throw new PageException(var5);
        }

        this.dialect.setProperties(properties);

        try {
            this.additionalParametersField = BoundSql.class.getDeclaredField("additionalParameters");
            this.additionalParametersField.setAccessible(true);
        } catch (NoSuchFieldException var4) {
            throw new PageException(var4);
        }
    }
可以看出,com.github.pagehelper.PageHelper是拦截器默认的Dialect。也可以选择其它的Dialect实现,可以在application.properties中如下配置。

pagehelper.dialect=com.github.pagehelper.dialect.helper.MySqlDialect
其它的Dialect实现在com.github.pagehelper.dialect下找到,不过一般不需要进行特殊配置,使用默认的com.github.pagehelper.PageHelper即可。

而在com.github.pagehelper.PageHelper中有以下两个参数。

    private PageParams pageParams;
    private PageAutoDialect autoDialect;
    public void setProperties(Properties properties) {
        this.pageParams = new PageParams();
        this.autoDialect = new PageAutoDialect();
        this.pageParams.setProperties(properties);
        this.autoDialect.setProperties(properties);
    }
其中PageParams中有以下属性。

    protected boolean offsetAsPageNum = false;
    protected boolean rowBoundsWithCount = false;
    protected boolean pageSizeZero = false;
    protected boolean reasonable = false;
    protected boolean supportMethodsArguments = false;
PageAutoDialect中有以下属性。

    private boolean autoDialect = true;
    private boolean closeConn = true;
以上内容都可以在application.properties中进行修改,如下所示。

pagehelper.autoDialect=true
pagehelper.closeConn=false
pagehelper.reasonable=true

Pagehelper的使用

我增加了如下测试代码。

    @RequestMapping("/find/mybatis/page")
    public String findUserPageFromMybatis(HttpServletRequest request, Integer pageNum, Integer pageSize) {
        pageNum = pageNum == null ? 1 : pageNum;
        pageSize = pageSize == null ? 10 : pageSize;
        PageHelper.startPage(pageNum, pageSize);
        List<UserMo> list = userMapper.selectUserList();
        PageInfo pageInfo = new PageInfo(list);
        Page page = (Page) list;
        return "PageInfo: " + JSON.toJSONString(pageInfo) + ", Page: " + JSON.toJSONString(page);
    }
运行程序后在浏览器输入 http://127.0.0.1:8080/find/mybatis/page,会看到如下输出。

PageInfo: {
    "endRow": 1,
    "firstPage": 1,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "isFirstPage": true,
    "isLastPage": false,
    "lastPage": 8,
    "list": [
        {
            "createDate": 1483586613000,
            "id": 1,
            "isDeleted": 0,
            "modifyDate": 1483586613000,
            "money": 1.20,
            "name": "sss"
        }
    ],
    "navigateFirstPage": 1,
    "navigateLastPage": 8,
    "navigatePages": 8,
    "navigatepageNums": [1,2,3,4,5,6,7,8],
    "nextPage": 2,
    "pageNum": 1,
    "pageSize": 1,
    "pages": 11,
    "prePage": 0,
    "size": 1,
    "startRow": 1,
    "total": 11
},
Page: [
    {
        "createDate": 1483586613000,
        "id": 1,
        "isDeleted": 0,
        "modifyDate": 1483586613000,
        "money": 1.20,
        "name": "sss"
    }
]

对于其它的调用方式,可以参看 https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md

重要提示

  • 只有紧跟在 PageHelper.startPage 方法后的第一个 MyBatis 的查询(select)方法会被分页。
  • 请不要在系统中配置多个分页插件(使用 spring 时,mybatis-config.xml 和 Spring<bean> 配置方式,请选择其中一种,不要同时配置多个分页插件)。
  • 对于带有 for update 的 sql,会抛出运行时异常,对于这样的 sql 建议手动分页,毕竟这样的 sql 需要重视。
  • 由于嵌套结果方式会导致结果集被折叠,因此分页查询的结果在折叠后总数会减少,所以无法保证分页结果数量正确。

Mybatis-Generator

更多信息可以查看http://www.mybatis.org/http://generator.sturgeon.mopaas.com/,以及https://github.com/mybatis/generator/releases

添加maven依赖及插件

    <!-- Mybatis generator. -->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator</artifactId>
            <version>1.3.5</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.5</version>
        </dependency>
    <build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.5</version>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <dependencies>
                    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
                    <!-- 配置这个依赖主要是为了等下在配置MG的时候可以不用配置classPathEntry这样的一个属性 -->
                    <!-- 避免代码的耦合度太高 -->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>6.0.5</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

添加Mybatis Generator的配置文件

在resources下增加generatorConfig.properties和generatorConfig.xml两个文件。

首先是generatorConfig.xml,如下所示。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <!-- 配置文件路径 -->
    <properties resource="generatorConfig.properties"/>

    <context id="DB2Tables" targetRuntime="MyBatis3">

        <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin" />

        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="false"/>
            <property name="javaFileEncoding" value="UTF-8"/>
        </commentGenerator>

        <jdbcConnection driverClass="${jdbc.driver}"
                        connectionURL="${jdbc.url}"
                        userId="${jdbc.username}"
                        password="${jdbc.password}">
        </jdbcConnection>

        <javaTypeResolver >
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <javaModelGenerator targetPackage="${model.package}" targetProject="${target.project}">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
            <property name="javaExampleTargetPackage" value="${model.package}"/>
            <property name="javaExampleTargetProject" value="${target.project}"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="${xml.package}"  targetProject="${xml.target.project}">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="${mapper.package}"
                             targetProject="${target.project}">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <table tableName="test_user" >
            <generatedKey column="id" sqlStatement="Mysql" type="post" identity="true"/>
        </table>

    </context>
</generatorConfiguration>


然后是generatorConfig.properties,如下所示。

# 数据库连接参数
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://ip:3306/db?useUnicode=true&characterEncoding=utf-8
jdbc.username=root
jdbc.password=xxxxxx

# 包路径配置
model.package=com.generator.model
mapper.package=com.generator.mapper
xml.package=mybatis/mapper

target.project=src/main/java
xml.target.project=src/main/resources

生成代码

通过选中如下图片中的插件运行来生成代码。


运行结束可看到生成的代码。

生成的TestUserMapper中需要自己手动加上@Mapper注解。

测试

对上面的代码稍作修改,如下所示。

    @Autowired
    private TestUserMapper testUserMapper;

    @RequestMapping("/find/mybatis/page")
    public String findUserPageFromMybatis(HttpServletRequest request, Integer pageNum, Integer pageSize) {
        pageNum = pageNum == null ? 1 : pageNum;
        pageSize = pageSize == null ? 10 : pageSize;
        PageHelper.startPage(pageNum, pageSize);
        List<TestUser> list = testUserMapper.selectByExample(new TestUserExample());
        PageInfo pageInfo = new PageInfo(list);
        Page page = (Page) list;
        return "PageInfo: " + JSON.toJSONString(pageInfo) + ", Page: " + JSON.toJSONString(page);
    }
运行后结果与上面的测试结果一致。

对于有特殊需求的可以修改mybatis-generator的源码来实现,比如自动添加@Mapper注解。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

spring-boot 集成mybatis的分页插件PageHelper和Generator (番外) 的相关文章

随机推荐

  • centos7使用rpmbuild制作rpm包

    本文作为我实验的一个总结文档 可能实现的功能比较简单 适合于想要简单入门使用的 希望对朋友们有所帮助 下载rpmbuild程序包 所用系统 centos7 6 yum install rpm build 安装程序包 如果你所要打包的程序需要
  • yum清缓存_YUM 安装及清理

    Yum 全称为 Yellow dog Updater Modified 是一个在Fedora中的Shell前端软件包管理器 基於RPM包管理 能够从指定的服务器自动下载RPM包并且安装 可以自动处理 依赖性关系 并且一次安装所有依赖的软体包
  • 小程序无需编程,体验IoT物联网平台-物模型开发——设备接入类

    微信小程序码 1 准备工作 1 1 注册阿里云账号 浏览器打开 https aliyun com 开通阿里云账号 并通过支付宝实名认证 https www aliyun com gt 1 2 免费开通IoT物联网平台 在产品分类 找到物联网
  • c语言-循环打印星号图形*

    用两层循环 外层循环 控制行 行数 换行 内层循环 控制列 列数 列的符号 第一种效果图 为什么是j lt i 2呢 第一行以0计算 第一行星数为0 第二行为1计算 第二行星数为2 include
  • 【DP练习】美元DOLLARS

    1040 练习题目 美元DOLLARS Description 在以后的若干天里戴维将学习美元与德国马克的汇率 编写程序帮助戴维何时应买或卖马克或美元 使他从100美元开始 最后能获得最高可能的价值 Input 输入文件的第一行是一个自然数
  • Linux TOP CPU %wa 值的理解

    起因 近期阅读到Linux下显示CPU执行情况命令top的使用 网上搜索显示为 单位时间io占用cpu比例 cpu等待输入输出 cpu等待io的时间 起初看来 总觉得是io瓶颈或者是cpu负载率 仔细琢磨 总觉得哪里出了问题 跟进 因为IO
  • 深度优先遍历目录

    磁盘文件系统类型 ext2 ext3 ext4 深度优先遍历目录 include
  • Qt中.pro文件报错问题

    1 error No rule to make target C Program Files x86 Windows Kits 10 Lib 10 0 22621 0 um x64 User32d a needed by debug unt
  • Matlab中特征选择reliefF算法使用方法(分类与回归)

    1 ReliefF简介 ReliefF是特征选择的一种算法 在高维特征样本中 选取部分具有代表性的特征 从而降低样本特征维度 它也是relief算法的进阶 Relief算法只能用来做二分类 但其算法简单 效率高 结果不错 因此才有了其进阶算
  • 超详细!基于Proteus的出租车计价器实现(数字电路课程设计)

    本文阐述基于Proteus 7 8的出租车计价器电路的实现 附具体电路的工程文件下载 工程文件下载链接 设计要求 里程测量精确到1 按起步价7元 3公里 起步价外按1 4元 公里进行计价 等候按1 4元 10分钟计算 具有里程显示 收费显示
  • 浏览器全屏代码

    a href 屏幕切换 a
  • 常用分类算法的优缺点和相关评价指标

    算法 优点 缺点 Bayes 贝叶斯分类法 1 所需估计的参数少 对于缺失数据不敏感 2 有着坚实的数学基础 以及稳定的分类效率 1 假设属性之间相互独立 这往往并不成立 喜欢吃番茄 鸡蛋 却不喜欢吃番茄炒蛋 2 需要知道先验概率 3 分类
  • 力扣刷题-1371.每个元音包含偶数次的最长子字符串、前缀和、动态规划

    一 背景 和为k的子数组 给定一个整数数组和一个整数 k 你需要找到该数组中和为 k 的连续的子数组的个数 示例 1 输入 nums 1 1 1 k 2 输出 2 1 1 与 1 1 为两种不同的情况 来源 力扣 LeetCode 第560
  • 面试题-MQ

    一 RabbitMQ 二 ActiveMQ 部分问题 135 rabbitmq 的使用场景有哪些 136 rabbitmq 有哪些重要的角色 137 rabbitmq 有哪些重要的组件 138 rabbitmq 中 vhost 的作用是什么
  • orbslam2 Framebuffer with requested attributes not available QObject::startTimer: Timers

    orbslam2 Framebuffer with requested attributes not available Using available framebuffer You may see visual artifacts QO
  • Vue-Quill-Editor 简单修改字体大小和样式.(不改源码)

    实现效果图 vue cli的富文本Vue Quill Editor 使用前安装 npm install quill image resize module save npm install vue quill editor save 需要在
  • Python之列表生成式、生成器、可迭代对象与迭代器

    近日刷leetcode 为了更pythonic 不断练习列表生成式 看了大佬的总结觉得很清楚了 Python之列表生成式 生成器 可迭代对象与迭代器
  • android ScrollView 滚动到顶部

    有时候使用ScrollView 里边控件比较多的时候 打开界面 会滑到底部 如果要设置滑动到顶部 一般有两种方法 1 使用fullScrol scrollView fullScroll ScrollView FOCUS DOWN 滚动到底部
  • 中国“东数西算”——展望 CCN 无限发展可能

    大家好 我是晴天defi 这段时间有个词国内的小伙伴肯定对他非常耳熟 没错就是 东数西算 根据国家发改委等部门联合印发通知 将在全国八地启动建设国家算力枢纽节点 并规划了十个国家数据中心集群 至此 全国一体化大数据中心体系完成总体布局设计
  • spring-boot 集成mybatis的分页插件PageHelper和Generator (番外)

    分页插件PageHelper 参看了pagehelper spring boot 使用起来非常放方便 关于更多PageHelper可以点击https github com pagehelper Mybatis PageHelper 添加ma