springboot +pageHelper 实现全局分页

曾经终败给现在 2023-10-02 14:00 10阅读 0赞

#### springboot +pageHelper 实现全局分页 ####

*   *   *  一、依赖包
         *  二、基本使用
         *   *  FAQ
             *   *  1. 为什么要重新声明一个list函数?
                 *  2. doSelectPageInfo是什么?
                 *  3. 这种写法的代码量看起来不少反多?
         *  三、进阶使用示例
         *   *   *  1、实体类IPage
                 *  2、BaseService
                 *  3、业务SceneService
                 *  4、实现类SceneServiceImpl
                 *  5、Controller接口
         *  四、测试结果
         *  五、常见问题汇总
         *   *   *  1. BaseService作为interface,page为什么可以声明方法体?
                 *  2. PageParam的声明有什么意义?实现IPage是为了什么?
                 *  3. PageParam中除了常规的pageNum/pageSize,为什么还需要一个orderBy?
                 *  4. orderBy如何使用?会有什么问题吗?
                 *  5. pageNum/pageSize一定需要给默认值吗?

#### 一、依赖包 ####

<dependency>
    	<groupId>com.github.pagehelper</groupId>
    	<artifactId>pagehelper-spring-boot-starter</artifactId>
    	<version>1.3.0</version>
    </dependency>

#### 二、基本使用 ####

> 在实际项目运用中，PageHelper的使用非常便利快捷，仅通过PageInfo + PageHelper两个类，就足以完成分页功能，然而往往这种最简单的集成使用方式，却在很多实际应用场景中，没有得到充分的开发利用．

最常见的使用方式：

public PageInfo<ResponseEntityDto> page(RequestParamDto param) {
        
    	PageHelper.startPage(param.getPageNum(), param.getPageSize());
    	List<ResoinseEntityDto> list = mapper.selectManySelective(param);
    	PageInfo<ResponseEntityDto> pageInfo = (PageInfo<ResponseEntityDto>)list;
    	return pageInfo;
    }

在某种程度上而言,上述写法的确是符合PageHelper的使用规范 :

在集合查询前使用`PageHelper.startPage(pageNum,pageSize)`,并且*中间不能穿插执行其他SQL*

但是作为Developer的我们,往往只有在追求完美和极致的道路上才能够寻得突破和机遇;  
以下是合理且规范的基本使用:

public PageInfo<ResponseEntityDto> page(RequestParamDto param) {
        
    	return PageHelper.startPage(param.getPageNum(), param.getPageSize())
    			  .doSelectPageInfo(() -> list(param))
    } 
    public List<ResponseEntityDto> list(RequestParamDto param) {
        
    	return mapper.selectManySelective(param);
    }

##### FAQ #####

###### 1. 为什么要重新声明一个list函数? ######

> 答: 往往在很多实际业务应用场景中, 分页查询是基于大数据量的表格展示需求来进行的.  
> 然而很多时候,譬如: 内部服务的互相调用,OpenAPI的提供.

> 甚至在某些前后端分离联调的业务场景中,是同样需要一个非分页集合查询接口来提供服务的.  
> 另外,暂时以上因素抛开不谈,我们可以根据上述写法来定义和规范某些东西

> 譬如: 分页和集合查询的分离和解耦(解耦详情请看进阶使用),  
> 分页请求的请求和响应与实际业务参数的分离(详情请看进阶使用)等等…

###### 2. doSelectPageInfo是什么? ######

> 答: doSelectPageInfo是PageHelper.startPage()函数返回的默认Page实例内置的函数,该函数可以用以Lambda的形式通过额外的Function来进行查询而不需要再进行多余的PageInfo与List转换,而doSelectPageInfo的参数则是PageHelper内置的Function(ISelect)接口用以达到转换PageInfo的目的

###### 3. 这种写法的代码量看起来不少反多? ######

> 答: 正如同①中所描述的,就代码量而言,确实没有更进一步的简化,但是再某些业务场景中,在已具有list函数接口的情况下,是一种更直观的优化(优化详情请看进阶使用)

#### 三、进阶使用示例 ####

###### 1、实体类IPage ######

package com.dimpt.manage.model;
    
    import com.github.pagehelper.IPage;
    
    public class PageParam<T>  implements IPage {
        
    
            //  description = "页码", defaultValue =  1
            private Integer pageNum = 1;
    
            //	description = "页数", defaultValue = 20
            private Integer pageSize = 20;
    
            //	description = "排序", example = "id desc"
            private String orderBy;
    
            //  description = "参数"
            private T param;
    
            public PageParam<T> setOrderBy(String orderBy) {
        
                this.orderBy = orderBy; // 此处可优化
                return this;
            }
    
            @Override
            public Integer getPageNum() {
        
                    return pageNum;
            }
    
            public void setPageNum(Integer pageNum) {
        
                    this.pageNum = pageNum;
            }
    
            @Override
            public Integer getPageSize() {
        
                    return pageSize;
            }
    
            public void setPageSize(Integer pageSize) {
        
                    this.pageSize = pageSize;
            }
    
            @Override
            public String getOrderBy() {
        
                    return orderBy;
            }
    
            public T getParam() {
        
                    return param;
            }
    
            public void setParam(T param) {
        
                    this.param = param;
            }
    }

###### 2、BaseService ######

>  *  BaseService可以作为全局Service通用接口的封装和声明，而作为通用分页接口page函数却在此处利用interface特有关键字default 直接声明了page函数的方法体body
>  *  在BaseService中我们看到了一个新的PageParam,参考了PageInfo用以包装/声明/分离分页参数和业务参数,且参数类型为泛型,即支持任何数据类型的业务参数  
>     同时也可以看到PageParam实现了IPage接口,并且多了一个orderBy属性字段

package com.dimpt.manage.service;
    
    import com.dimpt.manage.model.PageParam;
    import com.github.pagehelper.PageHelper;
    import com.github.pagehelper.PageInfo;
    
    import java.util.List;
    
    
    /**
     * @param <Param> 泛型request
     * @param <Result> 泛型response
     */
    public interface BaseService<Param, Result> {
        
    
        /**
         * 分页查询
         *
         * @param param 请求参数DTO
         * @return 分页集合
         */
        default PageInfo<Result> page(PageParam<Param> param) {
        
            return PageHelper.startPage(param).doSelectPageInfo(() -> list(param.getParam()));
        }
    
        /**
         * 集合查询
         *
         * @param param 查询参数
         * @return 查询响应
         */
        List<Result> list(Param param);
    }

###### 3、业务SceneService ######

>  *  同为interface接口, 业务Service只需要继承BaseService
>  *  并根据实际使用场景声明请求参数和响应结果的Entity实体即可
>  *  在实际应用中,只需要声明我们通用的业务查询请求参数和响应结果即可

package com.dimpt.manage.service;
    
    import com.dimpt.manage.model.Scene;
    
    public interface SceneService extends BaseService<Scene, Scene > {
        
    ...
    }

###### 4、实现类SceneServiceImpl ######

> 只需要重写list方法体,将实际业务场景中需要处理的业务逻辑处理和查询方法写入其中,并不需要关心分页功能

@Service
    public class SceneServiceImpl implements SceneService {
        
    
     @Override
        public List<Scene> list(Scene scene) {
        
            return parseSO(sceneMapper.getAllSceneDO());// 可根据实际情况将实体做转换
        }
    }

###### 5、Controller接口 ######

> 只需要直接调用service.page即可,而请求参数直接用PageParam包装,将分页参数和业务参数分离,在前后端接口联调中,保持这种分离规范,可以很大程度上的降低沟通和开发成本

package com.dimpt.rest.rest;
    
    import com.dimpt.manage.model.PageParam;
    import com.dimpt.manage.model.Scene;
    
    import com.dimpt.manage.service.SceneService;
    import com.dimpt.rest.anno.ResponseResult;
    import com.github.pagehelper.PageInfo;
    import io.swagger.annotations.Api;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.*;
    
    
    @ResponseResult
    @RestController
    @RequestMapping("/scene")
    @Api(value = "场景管理接口", tags = {
        "场景管理接口"})
    public class SceneController {
        
    
        @Autowired
        private SceneService sceneService;
    
        /**
         * 分页查询
         *
         * @param pageParam 分页查询参数
         * @return 分页查询响应
         */
        @PostMapping(path = "page")
        public PageInfo<Scene> page(@RequestBody PageParam<Scene> pageParam) {
        
            return sceneService.page(pageParam);
        }
    }

#### 四、测试结果 ####

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16]  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16 1]

{
        
      "code": 200,
      "message": "成功",
      "data": {
        
        "total": 19,
        "list": [
          {
        
            "id": "7424f3ec-40f4-4c3f-a2da-02bae1797b5f",
            "name": "tes_xyl11",
            "accountId": "6cbca70d-bad0-4bc0-aee3-44ca72e43385",
            "mapId": null,
            "province": "山西",
            "city": "长治市",
            "county": "长治县",
            "latitude": null,
            "longitude": null,
            "address": null,
            "description": null,
            "createTime": "2021-11-03 23:28:59",
            "status": "0",
            "bindStatus": "0"
          },
          {
        
            "id": "8b6d295d-e540-46a9-b18b-960c45bec0f9",
            "name": "场景S1",
            "accountId": "6cbca70d-bad0-4bc0-aee3-44ca72e43385",
            "mapId": "c8199fe4-d1da-4a00-8b14-3a4937774220",
            "province": "河南省",
            "city": "郑州市",
            "county": "中原区",
            "latitude": 50,
            "longitude": 130,
            "address": "互助路1号",
            "description": "这是一个新场景",
            "createTime": "2021-11-02 01:15:26",
            "status": "0",
            "bindStatus": "1"
          }
    		...
        ],
        "pageNum": 2,
        "pageSize": 10,
        "size": 9,
        "startRow": 11,
        "endRow": 19,
        "pages": 2,
        "prePage": 1,
        "nextPage": 0,
        "isFirstPage": false,
        "isLastPage": true,
        "hasPreviousPage": true,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
          1,
          2
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 2
      }
    }

#### 五、常见问题汇总 ####

###### 1. BaseService作为interface,page为什么可以声明方法体? ######

> 答: Java8中新特性之一就是为interface接口类增加了static/default方法,即声明方法后,其子类或实现都将默认具有这些方法,可以直接调用  
> 而在此处为Page方法声明default是因为page函数只关注分页参数和分页响应,脱离了业务场景,方法体大相径庭,所以索性抽象定义出来,免去了其实现的复杂冗余过程

###### 2. PageParam的声明有什么意义?实现IPage是为了什么? ######

> 答: PageParam是参考PageInfo编写的类(不确定往后PageHelper是否会封装此类,兴许我可以提个Issue上去,也参与开源框架的开发)  
> 编写此类的目的就是为了分离分页和业务数据,让开发者专注于业务的实现和开发,同时也是对分页查询API的一种规范,无论是请求还是响应都将分页相关的数据抽离出来,单独使用  
> 而实现IPage则是因为IPage作为PageHelper内置的interface,在不了解它更多意义上的作用前,可以作为我们分页参数声明的一种规范,而IPage中也只声明了三个方法,分别是pageNum/pageSize/orderBy的Getter方法,另外在源码分析中,我将会提到实现此接口更深层的意义

###### 3. PageParam中除了常规的pageNum/pageSize,为什么还需要一个orderBy? ######

> 答: 常规的分页查询中只需要pageNum/pageSize即可完成分页的目的,但是往往伴随着分页查询的还有筛选排序,而orderBy则是专注基于SQL的动态传参排序

###### 4. orderBy如何使用?会有什么问题吗? ######

> 答: orderBy和pageNum/pageSize一样,都是Pagehelper通过MyBatis拦截器,在query查询中注入进去的,所以在前端传参时,orderBy参数应为数据库column desc/asc这种形式,多字段排序则可以用逗号(,)拼接,譬如: columnA desc,columnB,  
> 但是另外一方面又存在两个问题, 第一就是大多数数据库表字段设计中,都会使用蛇形case命名,而非常规开发中的驼峰case命名,所以存在一层转换,而这种转换可以分配给前端传参时,也可以分配给后端接参时.  
> 第二就是这样赤裸裸的将排序字段暴露在接口中,会存在order by SQL注入的风险,所以在实际使用过程中,我们需要通过某些手段去校验和排查orderBy的传参是否合法,譬如用正则表达式匹配参数值只能含有order by语法中必要的值,例如字段名,desc or asc,不允许包含特殊字符/数据库关键字等

###### 5. pageNum/pageSize一定需要给默认值吗? ######

> 答: 通过阅读PageHelper源码,我们得知在Page查询参数为null时,它并不会赋予它们默认值,并不进行额外的处理,以至于导致分页失败,而给默认值,也是为了谨防前后端调试接口过程中可能会出现的各种意外

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/91351c934dab4354b596f69dd30c5224.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA54ix5omT576955CD55qE56CB54y_,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/2d7cf3b2420e4387a38ffc0b3148d5b5.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA54ix5omT576955CD55qE56CB54y_,size_20,color_FFFFFF,t_70,g_se,x_16