膳逸：用户分页查询功能开发文档

Prored303

已于 2024-06-24 14:11:12 修改

阅读量1.7k

点赞数 16

分类专栏：膳逸文章标签： spring boot java

于 2024-06-24 13:05:16 首次发布

本文链接：https://blog.csdn.net/Prored/article/details/139922494

版权

膳逸专栏收录该内容

8 篇文章 0 订阅

订阅专栏

目录标题

概述

本开发文档详细描述了MIS系统中的分页查询活动接口的设计与实现。通过该接口，用户可以根据各种条件查询活动信息，返回符合条件的活动列表，并支持分页显示。

功能需求

分页查询活动：用户可以通过提交查询条件来分页获取活动信息，包括活动名称、状态、开始时间、结束时间等。
权限控制：确保只有具有特定权限的用户可以访问此接口。

接口详情

分页查询活动接口

接口路径

/mis_user/searchActivityByPage

请求方法

POST

Body 请求参数

{
  "page": 1,
  "length": 10,
  "id": null,
  "activityName": "",
  "startTime": "",
  "endTime": "",
  "status": null
}

请求参数

名称	位置	类型	必选	说明
Token	header	string	否	none
body	body	object	否	none
» page	body	integer	是	none
» length	body	integer	是	none
» id	body	integer	否	none
» activityName	body	string	否	none
» startTime	body	string	否	none
» endTime	body	string	否	none
» status	body	integer	否	活动状态（0未开始，1进行中，2已结束）

返回示例

成功

{
  "msg": "success",
  "result": {
    "totalCount": 7,
    "pageSize": 10,
    "totalPage": 1,
    "pageIndex": 1,
    "list": [
      {
        "reward": "大白兔礼包",
        "start_time": "2024-06-01",
        "requirements": "连续打卡1天",
        "participants_count": 103,
        "name": "六一活动",
        "end_time": "2024-08-07",
        "description": "儿童节活动",
        "count_day": 1,
        "id": 1,
        "picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221703940.png",
        "status": 1
      },
      {
        "reward": "劳动礼包",
        "start_time": "2024-05-01",
        "requirements": "连续打卡5天",
        "participants_count": 502,
        "name": "五一活动",
        "end_time": "2024-08-30",
        "description": "劳动节活动",
        "count_day": 5,
        "id": 2,
        "picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221704667.png",
        "status": 1
      },
      {
        "reward": "春节大礼包",
        "start_time": "2024-02-01",
        "requirements": "连续打卡10天",
        "participants_count": 1000,
        "name": "春节活动",
        "end_time": "2024-03-01",
        "description": "春节活动",
        "count_day": 10,
        "id": 3,
        "picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221705143.png",
        "status": 1
      },
      {
        "reward": "有机会获得健康饮食礼包或运动器材",
        "start_time": "2024-06-14",
        "requirements": "用户每天上传一张照片，这张照片可以是与父亲一起共进餐，或者为父亲准备的美食照片。可以只包含食物，不一定要包含父亲。即图片要求满足下面之一即可：1.有食物；2.有人物和食物；",
        "participants_count": 1003,
        "name": "\"父爱如山，食在心间\"父亲节特别活动",
        "end_time": "2024-06-23",
        "description": "上传与父亲的进餐瞬间",
        "count_day": 5,
        "id": 8,
        "picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406161248411.jpg",
        "status": 1
      },
      {
        "reward": "欢度元旦大礼包",
        "start_time": "2023-12-31",
        "requirements": "连续打卡1天",
        "participants_count": 0,
        "name": "元旦活动",
        "end_time": "2023-12-31",
        "description": "欢度元旦",
        "count_day": 1,
        "id": 9,
        "picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221929172.png",
        "status": 1
      },
      {
        "reward": "情人节大礼包",
        "start_time": "2024-02-14",
        "requirements": "打卡一天",
        "participants_count": 0,
        "name": "情人节活动",
        "end_time": "2024-02-14",
        "description": "情人节",
        "count_day": 1,
        "id": 10,
        "picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221932526.png",
        "status": 1
      },
      {
        "reward": "5积分",
        "start_time": "2024-06-20",
        "requirements": "发布一张光盘图片",
        "participants_count": 0,
        "name": "七一活动",
        "end_time": "2024-06-27",
        "description": "学习建党精神，珍惜粮食资源",
        "count_day": 0,
        "id": 12,
        "picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406232003814.jpg",
        "status": 1
      }
    ]
  },
  "code": 200
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» msg	string	true	none	none
» result	object	true	none	none
»» totalCount	integer	true	none	none
»» pageSize	integer	true	none	none
»» totalPage	integer	true	none	none
»» pageIndex	integer	true	none	none
»» list	[object]	true	none	none
»»» reward	string	true	none	none
»»» start_time	string	true	none	none
»»» requirements	string	true	none	none
»»» participants_count	integer	true	none	none
»»» name	string	true	none	none
»»» end_time	string	true	none	none
»»» description	string	true	none	none
»»» id	integer	true	none	none
»»» picture	string	true	none	none
»»» status	integer	true	none	none
»»» count_day	integer	true	none	none

实现细节

控制器代码

@PostMapping("/searchActivityByPage")
    @SaCheckLogin
    @SaCheckPermission(value = {"ROOT", "ACTIVITY:SELECT"}, mode = SaMode.OR)
    public R searchActivityByPage(@RequestBody @Valid searchActivityByPageForm form) {
        Map param = BeanUtil.beanToMap(form);
        int page = form.getPage();
        int length = form.getLength();
        int start = (page - 1) * length;
        param.put("start", start);
        PageUtils pageUtils = misUserService.searchActivityByPage(param);
        return R.ok().put("result", pageUtils);
    }

表单验证类

@Data
public class searchActivityByPageForm {
    @NotNull(message = "page不能为空")
    @Min(value = 1, message = "page最小值为1")
    private Integer page;

    @NotNull(message = "length不能为空")
    @Range(min = 10, max = 50, message = "length每页长度不正确，最小10，最大50")
    private Integer length;

    @Min(value = 1, message = "id最小值为1")
    private Integer id;

//    @NotNull(message = "活动名称不能为空")
    private String activityName;

    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private DateTime startTime;

    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private DateTime endTime;

    @Range(min = 0, max = 2, message = "status状态码不正确，0未开始，1进行中，2已结束")
    private Byte status;
}

MisUserDao.xml

 <select id="searchActivityByPage" parameterType="Map" resultType="java.util.HashMap">
        SELECT a.id,
        a.name,
        a.description,
        a.requirements,
        a.start_time,
        a.end_time,
        a.participants_count,
        a.reward,
        a.status,
        a.picture,
        a.count_day
        FROM activity a
        WHERE 1 = 1
        <if test="id != null and id != ''">
            AND a.id = #{id}
        </if>
        <if test="activityName != null and activityName != ''">
            AND a.name LIKE CONCAT('%', #{activityName}, '%')
        </if>
        <if test="status != null and description != ''">
            AND a.status = #{status}
        </if>
        <if test="startTime != null">
            AND a.start_time &gt;= #{startTime}
        </if>
        <if test="endTime != null">
            AND a.end_time &lt;= #{endTime}
        </if>
        LIMIT #{length} OFFSET #{start}
    </select>

通过上述文档，实现了分页查询活动功能