点评项目——用户签到模块

2023.12.13

        通常app为了吸引用户每天登陆app，会设定一个签到模块，本章就来实现用户签到模块，包含签到功能和签到统计功能。

BitMap用法

        通常使用二进制位来记录每个月的签到情况，签到记录为1，未签到记录为0。每一个bit位对应当月的每一天，形成映射关系，用0和1标识业务状态，这种思路就成为位图（BitMap）。这样我们就能用极小的空间，来实现大量数据的表示。

        BitMap常见的操作命令有：

• SETBIT：向指定位置（offset）存入一个0或1
• GETBIT：获取指定位置（offset）的bit值
• BITCOUNT：统计BitMap中值为1的bit位的数量
• BITFIELD：操作（查询、修改、自增）BitMap中bit数组中的指定位置（offset）的值
• BITFIELD_RO：获取BitMap中bit数组，并以十进制形式返回
• BITOP：将多个BitMap的结果做位运算（与、或、异或）
• BITPOS：查找bit数组中指定范围内第一个0或1出现的位置

签到功能

        需求：实现签到接口，将当前用户当天签到信息保存到Redis中，请求结构为：

        为什么没有请求参数？ Redis中是利用String类型数据结构实现BitMap，key值我们可以使用用户的id和当前的年月进行拼接，这样同一个用户同一个月的签到记录就会存储在同一个数据结构中，也方便统计单月签到次数，value值就是一串二进制值，不过为了可读性好会将二进制值转为十进制值。  所以这里我们需要的参数就是用户的id和当前的时间，这两个参数都可以直接获取，不需要传过来。  

        下面编写签到功能的实现类代码：

    @Override
    public Result sign() {
        //1.获取当前登陆用户
        Long userId = UserHolder.getUser().getId();
        //2.获取日期
        LocalDateTime now = LocalDateTime.now();
        //3.拼接key
        String keySuffix = now.format(DateTimeFormatter.ofPattern(":yyyyMM"));
        String key = USER_SIGN_KEY + userId + keySuffix;
        //4.获取今天是本月的第几天
        int dayOfMonth = now.getDayOfMonth();
        //5.写入redis
        stringRedisTemplate.opsForValue().setBit(key,dayOfMonth-1,true);
        return Result.ok();
    }

        使用postman模拟签到，注意请求头中需携带登录用户的token：

        查看redis数据，今天是12月13号南京大屠杀死难者国家公祭日，愿逝者安息。所以我们签到的日子是12月的第13天，会使用2字节(16bit)保存，倒数第三个数字为1，代表第13天签到了。

签到统计功能

        下面来实现统计截止当前时间用户在本月的连续签到天数，即从最后一次签到开始向前统计，直到遇到第一次未签到为止，计算总的签到次数，就是连续签到天数。 

        首先我们应该先得到截止今天为止所有的签到数据，可以使用BITFIELD来获取本月第一天到今天的所有签到数据。然后从后向前遍历每个bit位，如果签到了就让计数器+1，未签到就break退出循环。

        下面实现代码：

    @Override
    public Result signCount() {
        //1.获取当前登陆用户
        Long userId = UserHolder.getUser().getId();
        //2.获取日期
        LocalDateTime now = LocalDateTime.now();
        //3.拼接key
        String keySuffix = now.format(DateTimeFormatter.ofPattern(":yyyyMM"));
        String key = USER_SIGN_KEY + userId + keySuffix;
        //4.获取今天是本月的第几天
        int dayOfMonth = now.getDayOfMonth();
        //5.获取本月截止今天为止的所有签到记录，返回的是一个十进制的数字
        List<Long> result = stringRedisTemplate.opsForValue().bitField(
                key,
                BitFieldSubCommands.create().get(BitFieldSubCommands.BitFieldType.unsigned(dayOfMonth)).valueAt(0)
        );
        if(result==null || result.isEmpty()){
            //没有任何签到结果
            return Result.ok(0);
        }
        Long num = result.get(0);
        if(num == null || num == 0){
            return Result.ok(0);
        }
        //6.循环遍历
        int count = 0;
        while (true){
            //6.1 让这个数字与1做与运算，得到数字的最后一个bit位
            if((num & 1) == 0){
                //如果为0，说明未签到，结束
                break;
            }else {
                //如果不为0，说明已签到，计数器+1
                count++;
            }
            //把数字右移1位，抛弃最后一个bit位，继续下一个bit位
            num >>>= 1;
        }
        return Result.ok(count);
    }

        先看看当前redis中的签到数据：

        即连续签到了三天，再用postman测试一下：