SpringBoot + MyBatis + PageHelper 分页详解

1. 开发环境

1.1  准备环境

SpringBoot 2.3.5.RELEASE

Pagehelper 1.4.1

Jdk 1.8

MySQL 8.1.0 

postman

2. 功能描述

    前后端分离,此功能为:后端对商品信息的分页查询

    后端服务:controller+service+mapper

3. 核心内容

3.1 数据库表结构与内容

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for food
-- ----------------------------
DROP TABLE IF EXISTS `food`;
CREATE TABLE `food`  (
  `foodId` int(0) NOT NULL AUTO_INCREMENT COMMENT '食品编号',
  `foodName` varchar(30) CHARACTER SET utf8mb3 COLLATE utf8mb3_general_ci NOT NULL COMMENT '食品名称',
  `foodExplain` varchar(30) CHARACTER SET utf8mb3 COLLATE utf8mb3_general_ci NOT NULL COMMENT '食品介绍',
  `foodPrice` decimal(5, 2) NOT NULL COMMENT '食品价格',
  `businessId` int(0) NOT NULL COMMENT '所属商家编号',
  `remarks` varchar(40) CHARACTER SET utf8mb3 COLLATE utf8mb3_general_ci NULL DEFAULT NULL COMMENT '备注',
  PRIMARY KEY (`foodId`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 12 CHARACTER SET = utf8mb3 COLLATE = utf8mb3_general_ci ROW_FORMAT = Dynamic;

-- ----------------------------
-- Records of food
-- ----------------------------
INSERT INTO `food` VALUES (1, '纯肉鲜肉(水饺)', '纯肉馅饺子', 16.00, 10001, NULL);
INSERT INTO `food` VALUES (2, '玉米鲜肉(水饺)', '玉米清香', 15.00, 10001, NULL);
INSERT INTO `food` VALUES (3, '虾仁三鲜(蒸饺)', '三鲜馅饺子', 20.00, 10001, NULL);
INSERT INTO `food` VALUES (4, '素三鲜(蒸饺)', '韭菜鸡蛋虾仁', 15.00, 10001, NULL);
INSERT INTO `food` VALUES (5, '角瓜鸡蛋(蒸饺)', '角瓜清香', 15.00, 10001, NULL);
INSERT INTO `food` VALUES (6, '小白菜肉(水饺)', '小白菜鲜肉',16.00, 10001, NULL);
INSERT INTO `food` VALUES (7, '芹菜牛肉(水饺)', '芹菜牛肉',  22.00, 10001, NULL);
INSERT INTO `food` VALUES (8, '虾腰鲜肉(蒸饺)', '虾仁腰子', 25.00, 10001, NULL);
INSERT INTO `food` VALUES (9, '青椒鲜肉(蒸饺)', '青椒鲜肉',18.00, 10001, NULL);
INSERT INTO `food` VALUES (10, '蛋黄焗豆花', '蛋黄豆花', 8.00, 10002, NULL);
INSERT INTO `food` VALUES (11, '麻婆豆腐', '麻辣味', 14.00, 10002, NULL);
INSERT INTO `food` VALUES (12, '广式小豆腐', '广东风味', 12.00, 10002, NULL);

SET FOREIGN_KEY_CHECKS = 1;

3.2 pom.xml 文件

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.bobo</groupId>
    <artifactId>pageboot</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>
    <name>pageboot</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.0.1</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.29</version>
        </dependency>
        <!--  分页查询插件  -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.4.1</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.70</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3.3 application.properties 文件

server.port=8080
server.servlet.context-path=/bobo

# 开启驼峰命名(数据库表中的字段使用下划线,而对应的实体类对象使用驼峰命名规则)
mybatis.configuration.mapUnderscoreToCamelCase=true

spring.datasource.username=root
spring.datasource.password=12345678
spring.datasource.url=jdbc:mysql://localhost:3306/bobo?characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

mybatis.mapper-locations=classpath:mapper/*.xml
mybatis.type-aliases-package=com.bobo.pageboot.pojo

#pagehelper配置
#指定数据库,不指定的话会默认自动检测数据库类型
pagehelper.helper-dialect=mysql
#是否启用分页合理化。如果启用,当pagenum<1时,会自动查询第一页的数据,当pagenum>pages时,自动查询最后一页数据;不启用的,以上两种情况都会返回空数据
pagehelper.reasonable=true
#默认值false,分页插件会从查询方法的参数值中,自动根据上面 params 配置的字段中取值,查找到合适的值时就会自动分页
pagehelper.support-methods-arguments=true
pagehelper.params=count=countSql

3.4 pojo 类

3.4.1 pojo类=》Food类

package com.bobo.pageboot.pojo;

import lombok.Data;

@Data
public class Food {
    private int FoodId;
    private String FoodName;
    private String FoodExplain;
    private Double FoodPrice;
    private int BusinessId;
    private String remarks;
}

3.4.2 pojo类=》PageRequest类

package com.bobo.pageboot.pojo;

import lombok.Data;

import java.io.Serializable;

@Data
public class PageRequest<T> implements Serializable {
    // 当前页码
    private int page;
    // 每页显示的行数
    private int size;
    // 实体对象
    private T obj;
}

3.4.3 pojo类=》PageResponse类

package com.bobo.pageboot.pojo;

import lombok.Data;

import java.io.Serializable;
import java.util.List;
@Data
public class PageResponse<T> implements Serializable {
    // 当前页码
    private int page;
    // 每页显示的行数
    private int size;
    // 总条数
    private Long total;
    // 结果集合
    private List<T> result;
}

3.5 controller控制层

package com.bobo.pageboot.controller;

import com.alibaba.fastjson.JSONObject;
import com.bobo.pageboot.pojo.Food;
import com.bobo.pageboot.pojo.PageRequest;
import com.bobo.pageboot.pojo.PageResponse;
import com.bobo.pageboot.service.FoodService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/food")
public class FoodController {
    @Autowired
    private FoodService foodService;
    @RequestMapping("/listFoodPageInfo")
    public Object listFoodPageInfo(@RequestBody PageRequest<Food> pageRequest){
        JSONObject jsonObject = new JSONObject();
        PageResponse<Food> pageResponse = foodService.listFoodPageInfo(pageRequest);
        if(pageResponse.getResult()==null||pageResponse.getResult().size()==0){
            jsonObject.put("code",500);
            jsonObject.put("msg","无数据");
        }else{
            jsonObject.put("code",200);
            jsonObject.put("msg","查询成功");
            jsonObject.put("data",pageResponse);
        }
        return jsonObject;
    }
}

3.6 service 层

3.6.1 service接口

package com.bobo.pageboot.service;

import com.bobo.pageboot.pojo.Food;
import com.bobo.pageboot.pojo.PageRequest;
import com.bobo.pageboot.pojo.PageResponse;

public interface FoodService {
    public PageResponse<Food> listFoodPageInfo(PageRequest<Food> pageRequest);
}

3.6.2 service接口实现类

package com.bobo.pageboot.service.impl;

import com.bobo.pageboot.mapper.FoodMapper;
import com.bobo.pageboot.pojo.Food;
import com.bobo.pageboot.pojo.PageRequest;
import com.bobo.pageboot.pojo.PageResponse;
import com.bobo.pageboot.service.FoodService;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class FoodServiceImpl implements FoodService {
    @Autowired
    private FoodMapper foodMapper;
    @Override
    public PageResponse<Food> listFoodPageInfo(PageRequest<Food> pageRequest) {
        //-PageHelper此代码放到前面执行
        PageHelper.startPage(pageRequest.getPage(), pageRequest.getSize());
        List<Food> foodList = foodMapper.listFoodPageInfo(pageRequest.getObj());
        PageInfo<Food> pageInfo = new PageInfo<>(foodList);
        PageResponse<Food> pageResponse = new PageResponse<>();
        pageResponse.setPage(pageRequest.getPage());
        pageResponse.setSize(pageRequest.getSize());
        pageResponse.setTotal(pageInfo.getTotal());
        pageResponse.setResult(pageInfo.getList());
        return pageResponse;
    }
}

3.7 Mapper 层

package com.bobo.pageboot.mapper;

import com.bobo.pageboot.pojo.Food;
import com.bobo.pageboot.pojo.PageRequest;
import com.bobo.pageboot.pojo.PageResponse;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;
@Mapper
public interface FoodMapper {
    public List<Food> listFoodPageInfo(Food food);
}

3.8 mapper映射文件:FoodMapper.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.bobo.pageboot.mapper.FoodMapper">
    <select id="listFoodPageInfo" parameterType="Food" resultType="Food">
        select * from food
        <where>
            <if test="businessId!=null">
                businessId = #{businessId}
            </if>
        </where>
    </select>

</mapper>

4. 项目测试

4.1 启动项目

4.2 使用PostMan进行测试

4.2.1 测试1 (发送请求包含:页码与每页显示的条数

4.2.2 测试2(发送请求包含:页码、每页显示的条数 及 商品的筛选条件

5. 补充:

 注意:springboot 3.x 使用的 pagehelper的版本为 1.4.6

到此,分页查询整理完毕!

# Spring Boot 集成 MyBatis, 分页插件 PageHelper, 通用 Mapper ## 项目依赖 ```xml <!--mybatis--> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.1.1</version> </dependency> <!--mapper--> <dependency> <groupId>tk.mybatis</groupId> <artifactId>mapper-spring-boot-starter</artifactId> <version>1.1.1</version> </dependency> <!--pagehelper--> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.1.1</version> </dependency> ``` ## Spring DevTools 配置 在使用 DevTools 时,通用Mapper经常会出现 class x.x.A cannot be cast to x.x.A。 同一个类如果使用了不同的类加载器,就会产生这样的错误,所以解决方案就是让通用Mapper和实体类使用相同的类加载器即可。 DevTools 默认会对 IDE 中引入的所有项目使用 restart 类加载器,对于引入的 jar 包使用 base 类加载器,因此只要保证通用Mapper的jar包使用 restart 类加载器即可。 在 `src/main/resources` 中创建 META-INF 目录,在此目录下添加 spring-devtools.properties 配置,内容如下: ```properties restart.include.mapper=/mapper-[\\w-\\.]+jar restart.include.pagehelper=/pagehelper-[\\w-\\.]+jar ``` 使用这个配置后,就会使用 restart 类加载加载 include 进去的 jar 包。 ## 集成 MyBatis Generator 通过 Maven 插件集成的,所以运行插件使用下面的命令: >mvn mybatis-generator:generate Mybatis Geneator 详解: >http://blog.csdn.net/isea533/article/details/42102297 ## application.properties 配置 ```properties #mybatis mybatis.type-aliases-package=tk.mybatis.springboot.model mybatis.mapper-locations=classpath:mapper/*.xml #mapper #mappers 多个接口时逗号隔开 mapper.mappers=tk.mybatis.springboot.util.MyMapper mapper.not-empty=false mapper.identity=MYSQL #pagehelper pagehelper.helperDialect=mysql pagehelper.reasonable=true pagehelper.supportMethodsArguments=true pagehelper.params=count=countSql ``` ## application.yml 配置 完整配置可以参考 [src/main/resources/application-old.yml](https://github.com/abel533/MyBatis-Spring-Boot/blob/master/src/main/resources/application-old.yml) ,和 MyBatis 相关的部分配置如下: ```yaml mybatis: type-aliases-package: tk.mybatis.springboot.model mapper-locations: classpath:mapper/*.xml mapper: mappers: - tk.mybatis.springboot.util.MyMapper not-empty: false identity: MYSQL pagehelper: helperDialect: mysql reasonable: true supportMethodsArguments: true params: count=countSql ``` 注意 mapper 配置,因为参数名固定,所以接收参数使用的对象,按照 Spring Boot 配置规则,大写字母都变了带横线的小写字母。针对如 IDENTITY(对应i-d-e-n-t-i-t-y)提供了全小写的 identity 配置,如果 IDE 能自动提示,看自动提示即可。 ## SSM集成的基础项目 >https://github.com/abel533/Mybatis-Spring ## MyBatis工具 http://www.mybatis.tk - 推荐使用 Mybatis 通用 Mapper3 https://github.com/abel533/Mapper - 推荐使用 Mybatis 分页插件 PageHelper https://github.com/pagehelper/Mybatis-PageHelper ## 作者信息 - 作者博客:http://blog.csdn.net/isea533 - 作者邮箱:[email protected]
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值