springboot 中 分页实现
本次要讲的是典型的两种分页方式，即sql分页和插件分页。
一、sql分页
基于sql语句的分页，不需要特殊依赖。
1.1 依赖
因为使用了mybatis、mysql ，所以要添加相关依赖。这里版本没有特别需求，选择你想要的版本即可。
org.mybatis.spring.boot
mybatis-spring-boot-starter
${mybatis-version}
mysql
mysql-connector-java
${mysql-version}
本人使用的版本：
1.3.1
5.1.32
1.2 Dao层
在ArticleMapper .java中，分页函数如下：
package com.sqlb.mapper;
import com.sqlb.pojo.Article;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;
import java.util.Map;
@Mapper
public interface ArticleMapper {
/**
*sql 分页
*/
List list(Map map);
}
对应的ArticleMapper .xml中如下：
1.3 Service层
@Service
public class ArticleServiceImpl implements ArticleService {
@Autowired
private ArticleMapper articleMapper;
@Override
public List list(Integer pageNum, Integer pageSize) {
return articleMapper.listWithBLOBs(PageParam.getParams(pageNum, pageSize));
}
}
1.4 Controller层
@Controller
@RequestMapping("/article")
public class ArticleController {
@Autowired
ArticleService articleService;
@ResponseBody
@RequestMapping("/list")
public List list(@RequestParam(defaultValue = "1",value = "currentPage") Integer pageNum,
@RequestParam(defaultValue = "10",value = "pageSize") Integer pageSize){
return articleService.list(pageNum,pageSize);
}
}
当然，使用mybatis记得在application.yml中配置一把，以及mysql数据连接池配置。
mybatis:
configuration:
map-underscore-to-camel-case: true
mapper-locations: mybatis/*/*Mapper.xml
type-aliases-package: com.sqlb.pojo
mysql数据连接池配置这里就不用多说了吧。不知道的，就赶紧去学习下基础知识。
Article类和表结构
- Article类
import java.util.Date;
public class Article {
private Integer id;
private String author;
private Date createTime;
private String typeName;
private String imageUrl;
private String content;
//此处省去get、set方法
}
- 表结构
CREATE TABLE `article` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT 'id编号',
`content` text NOT NULL COMMENT '文章内容，代码控制不可超过1000字',
`author` varchar(128) DEFAULT NULL COMMENT '作者',
`create_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '创建时间',
`type_name` enum('0','1','2','3','4') NOT NULL DEFAULT '1' COMMENT '文章类型',
`image_url` varchar(255) DEFAULT NULL COMMENT '图片地址',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=21 DEFAULT CHARSET=utf8mb4;
sql分页就是这么多了，运行访问http://localhost:8081/article/list可以得到你想要的数据。
二、插件分页
显然，这种方法是要导入第三方jar包的，具体方法如下。
2.1 插件依赖
com.github.pagehelper
pagehelper-spring-boot-starter
${pagehelper-version}
这里要说明一下，本人使用的版本是：
1.1.1
本人开始使用的是当前最新版本1.2.4，本人这里不行，内部原因不详。您如果使用抛错的话，建议可以切换不同版本试试。
com.github.pagehelper
pagehelper-spring-boot-starter
1.2.4
2.2 配置
springboot最大的特色就是只需简单的配置，就可以进行快捷的开发，配置如下：
pagehelper:
helper-dialect: mysql
reasonable: true
support-methods-arguments: true
params: count=countSql
2.3 Dao层
ArticleMapper .java
import com.github.pagehelper.Page;
import com.sqlb.pojo.Article;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;
import java.util.Map;
@Mapper
public interface ArticleMapper {
/**
* 插件 分页 查询表中部分字段
*/
Page findByPage();
/**
* 插件 分页 查询表中所有字段
*/
Page findWithBLOBsByPage();
}
ArticleMapper .xml
这里有两个分页，不同点就是findWithBLOBsByPage把所有的字段都查询出来了，而findByPage相比之下少查询了一个字段。这里需要提出的是，本人的使用findByPage查询部分字段时，会报java.lang.NoSuchMethodException错误，具体原因暂时不详，以后明白了再记出来，如果哪个大神明白细节的还望不吝赐教~~~
2.4 Service层
此处才用到PageHelper插件
import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import com.sqlb.mapper.ArticleMapper;
import com.sqlb.pojo.Article;
import com.sqlb.service.ArticleService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class ArticleServiceImpl implements ArticleService {
@Autowired
private ArticleMapper articleMapper;
@Override
public Page findByPage(Integer pageNum, Integer pageSize) {
//用插件进行分页
PageHelper.startPage(pageNum, pageSize);
return articleMapper.findByPage();
}
@Override
public Page findWithBLOBsByPage(Integer pageNum, Integer pageSize) {
//用插件进行分页
PageHelper.startPage(pageNum, pageSize);
return articleMapper.findWithBLOBsByPage();
}
}
2.5 Controller层
首先要创建一个返回给前端的pojo对象，新建一个分页数据类PageInfo：
import com.github.pagehelper.Page;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
/**
* @描叙： 分页 数据结构
*/
public class PageInfo implements Serializable {
private static final long serialVersionUID = 1L;
//当前页
private int pageNum;
//每页的数量
private int pageSize;
//总记录数
private long total;
//总页数
private int pages;
//结果集
private List list;
//是否为第一页
private boolean isFirstPage = false;
//是否为最后一页
private boolean isLastPage = false;
public PageInfo() {
}
/**
* 包装Page对象
*
* @param list
*/
public PageInfo(List list) {
if (list instanceof Page) {
Page page = (Page) list;
this.pageNum = page.getPageNum();
this.pageSize = page.getPageSize();
this.pages = page.getPages();
this.list = page;
this.total = page.getTotal();
} else if (list instanceof Collection) {
this.pageNum = 1;
this.pageSize = list.size();
this.pages = 1;
this.list = list;
this.total = list.size();
}
if (list instanceof Collection) {
//判断页面边界
judgePageBoudary();
}
}
/**
* 判定页面边界
*/
private void judgePageBoudary() {
isFirstPage = pageNum == 1;
isLastPage = pageNum == pages;
}
public int getPageNum() {
return pageNum;
}
public void setPageNum(int pageNum) {
this.pageNum = pageNum;
}
public int getPageSize() {
return pageSize;
}
public void setPageSize(int pageSize) {
this.pageSize = pageSize;
}
public long getTotal() {
return total;
}
public void setTotal(long total) {
this.total = total;
}
public int getPages() {
return pages;
}
public void setPages(int pages) {
this.pages = pages;
}
public List getList() {
return list;
}
public void setList(List list) {
this.list = list;
}
public boolean isIsFirstPage() {
return isFirstPage;
}
public void setIsFirstPage(boolean isFirstPage) {
this.isFirstPage = isFirstPage;
}
public boolean isIsLastPage() {
return isLastPage;
}
public void setIsLastPage(boolean isLastPage) {
this.isLastPage = isLastPage;
}
@Override
public String toString() {
final StringBuffer sb = new StringBuffer("PageInfo{");
sb.append("pageNum=").append(pageNum);
sb.append(", pageSize=").append(pageSize);
sb.append(", total=").append(total);
sb.append(", pages=").append(pages);
sb.append(", list=").append(list);
sb.append(", isFirstPage=").append(isFirstPage);
sb.append(", isLastPage=").append(isLastPage);
sb.append(", navigatepageNums=");
sb.append('}');
return sb.toString();
}
}
ArticleController.java中，数据转换如下：
import com.github.pagehelper.Page;
import com.sqlb.pojo.Article;
import com.sqlb.pojo.PageInfo; //刚才新建的分页数据对象
import com.sqlb.service.ArticleService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
@RequestMapping("/article")
public class ArticleController {
@Autowired
ArticleService articleService;
@ResponseBody
@RequestMapping("/page")
public PageInfo findWithBLOBsByPage(@RequestParam(defaultValue = "1",value = "currentPage") Integer pageNum,
@RequestParam(defaultValue = "10",value = "pageSize") Integer pageSize){
Page articles = articleService.findWithBLOBsByPage(pageNum, pageSize);
// 需要把Page包装成PageInfo对象才能序列化。该插件也默认实现了一个PageInfo
PageInfo pageInfo = new PageInfo<>(articles);
return pageInfo;
}
}
插件分页就是这么多了，运行访问http://localhost:8081/article/list可以得到你想要的数据。
