膳逸：用户每日打卡模块开发文档

于 2024-06-23 22:40:11 发布
阅读量925 收藏 17
点赞数 17
CC 4.0 BY-SA版权
分类专栏： 膳逸 文章标签： 数据库 java maven
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Ban_Xiang/article/details/139907912

后端开发文档

文章目录

1. 用户每日打卡

设计思路

用户每日打卡功能允许用户记录每日的心情、活动等信息。每条打卡记录包含用户ID、文本内容、时间、图片和分析字段。通过数据库插入操作，将用户的打卡信息存储到数据库中。

实现过程

  1. 数据模型定义：

        @NotNull(message = "userId不能为空")
    private Integer userId;

    @NotNull(message = "text不能为空")
    @Size(max = 255, message = "text最大长度为255")
    private String text;

    @NotNull(message = "time不能为空")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private DateTime time;

    @NotNull(message = "images不能为空")
    private String images;

    private String analysis;

  2. 数据库插入操作：

    <!-- 用户每日打卡 -->
    <insert id="checkIn" parameterType="Map">
        insert into check_in(user_id, text, time, images, analysis)
        values (#{userId}, #{text}, #{time}, #{images}, #{analysis})
    </insert>

这样实现的好处

  • 数据完整性：通过注解确保所有必填字段不为空，保证数据的完整性。
  • 灵活性：支持用户输入文本、图片和时间，满足多样化的打卡需求。
  • 扩展性：可以轻松添加新的字段或功能，如分析字段。

POST 用户每日打卡

POST /user/checkIn

用户每日打卡

Body 请求参数

{
  "userId": 5,
  "text": "今天打卡测试",
  "time": "2024-05-24 08:16:46",
  "images": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202405241119574.png",
  "analysis": ""
}

请求参数

名称位置类型必选说明
tokenheaderstring否none
bodybodyobject否none
» userIdbodyinteger是none
» textbodystring是none
» timebodystring是none
» imagesbodystring是none

返回示例

成功

{
  "msg": "success",
  "code": 200
}

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» msgstringtruenonenone

2. 分页查询用户每日打卡

设计思路

分页查询功能允许用户按页查看打卡记录，并支持按用户ID、昵称、姓名、时间范围和排序方式进行筛选。

实现过程

  1. 数据模型定义：

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

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

    private Integer userId;
    private String nickName;
    private String name;

    @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;

    @NotNull(message = "排序不能为空")
    private String order;

  2. 分页查询接口：

        @PostMapping("/searchCheckInByPage")
    @SaCheckLogin
    public R searchCheckInByPage(@RequestBody @Valid searchCheckInByPageForm form) throws ParseException {
        Map param = BeanUtil.beanToMap(form);
        int page = form.getPage();
        int length = form.getLength();
        int start = (page - 1) * length;
        param.put("start", start);
        PageUtils pageUtils = userService.searchCheckInByPage(param);
        return R.ok().put("result", pageUtils);
    }

  3. 服务层实现：

        @Override
    public PageUtils searchCheckInByPage(Map param) {
        ArrayList<HashMap> list = null;
        long count = userDao.countUserCheckIn(param);
        if (count > 0) {
            list = userDao.searchCheckInByPage(param);
        } else {
            list = new ArrayList<>();
        }
        int page = MapUtil.getInt(param, "page");
        int length = MapUtil.getInt(param, "length");
        PageUtils pageUtils = new PageUtils(list, count, page, length);
        return pageUtils;
    }

  4. 数据库查询操作：

    <!-- 查询用户打卡总数 -->
    <select id="countUserCheckIn" parameterType="Map" resultType="long">
        SELECT COUNT(*)
        FROM check_in ci
        JOIN (
            SELECT u.id AS user_id
            FROM user u
            JOIN user_info ui ON u.id = ui.user_id
            WHERE 1 = 1
            <if test="userId != null and userId != ''">
                AND u.id = #{userId}
            </if>
            <if test="nickName != null and nickName != ''">
                AND u.nick_name LIKE CONCAT('%', #{nickName}, '%')
            </if>
            <if test="name != null and name != ''">
                AND ui.name LIKE CONCAT('%', #{name}, '%')
            </if>
        ) sub ON ci.user_id = sub.user_id
        WHERE 1 = 1
        <if test="startTime != null">
            AND ci.time &gt;= #{startTime}
        </if>
        <if test="endTime != null">
            AND ci.time &lt;= #{endTime}
        </if>
    </select>

    <!-- 分页查询用户打卡记录 -->
    <select id="searchCheckInByPage" parameterType="Map" resultType="HashMap">
        SELECT u.nick_name AS nickName,
               ui.name,
               ci.id,
               ci.user_id,
               ci.time,
               ci.text,
               ci.images,
               ci.analysis
        FROM check_in ci
        JOIN user u ON ci.user_id = u.id
        JOIN user_info ui ON u.id = ui.user_id
        WHERE 1 = 1
        <if test="userId != null and userId != ''">
            AND u.id = #{userId}
        </if>
        <if test="nickName != null and nickName != ''">
            AND u.nick_name LIKE CONCAT('%', #{nickName}, '%')
        </if>
        <if test="name != null and name != ''">
            AND ui.name LIKE CONCAT('%', #{name}, '%')
        </if>
        <if test="startTime != null">
            AND ci.time &gt;= #{startTime}
        </if>
        <if test="endTime != null">
            AND ci.time &lt;= #{endTime}
        </if>
        <if test="order == 'desc' ">
            ORDER BY ci.time desc
        </if>
        <if test="order == 'asc' ">
            ORDER BY ci.time asc
        </if>
        LIMIT #{length} OFFSET #{start}
    </select>

这样实现的好处

  • 高效查询：通过分页查询减少一次性查询的数据量，提高查询效率。
  • 灵活筛选：支持多种筛选条件，满足用户的个性化需求。
  • 排序功能：支持按时间升序或降序排序，方便用户查看。

POST 查询用户的打卡信息

POST /user/searchCheckInByPage

查询某一个关注的用户的打卡信息，可以按时间排序也可以默认由近到远，需要被关注的那个用户的id

Body 请求参数

{
  "page": 1,
  "length": 10,
  "userId": 5,
  "startTime": "",
  "endTime": "",
  "order": "desc"
}

请求参数

名称位置类型必选说明
tokenheaderstring否none
bodybodyobject否none
» pagebodyinteger是none
» lengthbodyinteger是最小1，最大50
» userIdbodyinteger是要查询的那个用户的id
» startTimebodystring否none
» endTimebodystring否none
» orderbodystring是按照打卡时间排序，desc或者asc

返回示例

成功

{
  "msg": "success",
  "result": {
    "totalCount": 2,
    "pageSize": 10,
    "totalPage": 1,
    "pageIndex": 1,
    "list": [
      {
        "images": "https://thirdwx.qlogo.cn/mmopen/vi_32/6ibtnStKibXDUTibnu052w40ps0DKqcUZBYaAiberiasgSsTGXwCLAicmXng2gE48ZnibYrmnPIiaVlNWjpCYiby85ibgM8Q/132",
        "user_id": 5,
        "nickName": "绊象",
        "name": "陈泽胜",
        "time": "2024-07-11T18:40:02",
        "text": "今天打卡",
        "analysis": "暂无"
      },
      {
        "images": "https://thirdwx.qlogo.cn/mmopen/vi_32/6ibtnStKibXDUTibnu052w40ps0DKqcUZBYaAiberiasgSsTGXwCLAicmXng2gE48ZnibYrmnPIiaVlNWjpCYiby85ibgM8Q/132",
        "user_id": 5,
        "nickName": "绊象",
        "name": "陈泽胜",
        "time": "2024-05-21T10:00:00",
        "text": "今天打卡",
        "analysis": "暂无"
      }
    ]
  },
  "code": 200
}

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» msgstringtruenonenone
» resultobjecttruenonenone
»» totalCountintegertruenonenone
»» pageSizeintegertruenonenone
»» totalPageintegertruenonenone
»» pageIndexintegertruenonenone
»» list[object]truenonenone
»»» imagesstringtruenonenone
»»» user_idintegertruenonenone
»»» nickNamestringtruenonenone
»»» namestringtruenonenone
»»» timestringtruenonenone
»»» textstringtruenonenone
»»» analysisstringtruenonenone
» codeintegertruenonenone

3. 用户修改每日打卡信息

设计思路

用户可以修改已存在的打卡记录，包括文本内容、时间和图片。通过数据库更新操作，将修改后的信息保存到数据库中。

实现过程

  1. 数据模型定义：

        @NotNull(message = "checkInId不能为空")
    private Integer checkInId;

    @NotNull(message = "text不能为空")
    @Size(max = 255, message = "text最大长度为255")
    private String text;

    @NotNull(message = "time不能为空")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private DateTime time;

    @NotNull(message = "images不能为空")
    private String images;

  2. 数据库更新操作：

    <!-- 修改用户每日打卡信息 -->
    <update id="updateCheckIn" parameterType="Map">
        UPDATE check_in
        SET text = #{text},
            time = #{time},
            images = #{images}
        WHERE id = #{checkInId};
    </update>

这样实现的好处

  • 数据更新：允许用户修改已存在的打卡记录，保持数据的动态更新。
  • 灵活性：支持修改文本、时间和图片，满足用户的多样化需求。

POST 用户修改每日打卡信息

POST /user/updateCheckIn

Body 请求参数

{
  "checkInId": 1,
  "text": "修改打卡信息",
  "time": "2024-06-21 10:00:00",
  "images": "http://dummyimage.com/300x300"
}

请求参数

名称位置类型必选说明
tokenheaderstring否none
bodybodyobject否none
» checkInIdbodyinteger是none
» textbodystring是none
» timebodystring是none
» imagesbodystring是none

返回示例

200 Response

{
  "code": "string",
  "msg": "string"
}

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codestringtruenonenone
» msgstringtruenonenone

4. 用户删除每日打卡信息

设计思路

用户可以删除已存在的打卡记录，通过数据库删除操作，将指定的打卡记录从数据库中移除。

实现过程

  1. 数据模型定义：

        @NotNull(message = "checkInId不能为空")
    private Integer checkInId;

  2. 数据库删除操作：

    <!-- 删除用户打卡信息 -->
    <delete id="deleteCheckIn" parameterType="Map">
        delete from check_in where id = #{checkInId}
    </delete>

POST 用户删除每日打卡信息

POST /user/deleteCheckIn

Body 请求参数

{
  "checkInId": 2
}

请求参数

名称位置类型必选说明
tokenheaderstring否none
bodybodyobject否none
» checkInIdbodyinteger是none

返回示例

200 Response

{
  "code": "string",
  "msg": "string"
}

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codestringtruenonenone
» msgstringtruenonenone

五.查询用户总共打卡多少天

设计思路

该功能用于查询用户总共打卡的天数。通过统计用户在数据库中打卡记录的不同日期，计算出用户总共打卡了多少天。

实现过程

数据模型定义

@NotNull(message = "userId不能为空")
private Integer userId;

数据库查询操作

<select id="countMyCheckIn" parameterType="Map" resultType="java.lang.Long">
    select count(distinct date(time)) from check_in
    where user_id = #{userId}
</select>

这样实现的好处

  • 准确统计：通过统计不同日期的打卡记录，准确计算用户总共打卡的天数。
  • 高效查询：使用 distinct 和 count 组合，确保查询效率和准确性。
  • 简单易用：只需提供用户ID即可获取打卡天数，接口设计简洁明了。

POST 查询总共打卡多少天

POST /user/countMyCheckIn

查询自己总共打卡多少天

Body 请求参数

{
  "userId": 5
}

请求参数

名称位置类型必选说明
tokenheaderstring否none
bodybodyobject否none
» userIdbodyinteger是none

返回示例

成功

{
  "msg": "success",
  "result": 2,
  "code": 200
}

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» msgstringtruenonenone
» resultintegertruenonenone
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值