Redis BitMap结构实现签到、连续签到统计

一、利用BitMap结构实现签到功能

我们按月来统计用户签到信息，签到记录为1，未签到则记录为0.

把每一个bit位对应当月的每一天，形成了映射关系。用0和1标示业务状态，这种思路就称为位图（BitMap）。

Redis中是利用string类型数据结构实现BitMap，因此最大上限是512M，转换为bit则是2^32个bit位。

1.1 BitMap用法

Redis中是利用string类型数据结构实现BitMap，因此最大上限是512M，转换为bit则是2^32个bit位。

BitMap的操作命令有：

• SETBIT：向指定位置（offset）存入一个0或1

# key名称 bm1 角标 0 签到与否 0 未签到 1 已签到
SETBIT bm1 0 1

• GETBIT：获取指定位置（offset）的bit值

# 获取第一天签到
GETBIT bm1 0 

• BITCOUNT：统计BitMap中值为1的bit位的数量

BITCOUNT bm1

• BITFIELD：操作（查询、修改、自增）BitMap中的bit数组中的指定位置（offset）的值

# 查询bm1 无符号5为整数，角标从0开始
BITFIELD bm1 GET u5 0

u：代表无符号整数位，所有位数都用于计算转换十进制  1101 = 1+0*2^1+1*2^2+1*2^3 = 13
i：代表有符号整数位  首位作为符号位，不参与计算，1为负数 0 为正数 

首先按位取反 得到 1101 反码为0010
补码=反码+1  0010 + 0001 = 0011 
因为符号位为1，为负数，则真值=补码的相反数=-(1+1*2^1)=-3

• BITFIELD_RO：获取BitMap中bit数组，并以十进制形式返回

# 查询bit数组 无符号四位 从0开始 和无符号五位 从0开始 返回十进制
BITFIELD_RO bm1 GET u4 0 GET u5 0

• BITOP：将多个BitMap的结果做位运算（与、或、异或）

bitop 是一个复合操作， 它可以做多个 Bitmaps 的 and（交集） 、 or（并集） 、 not（非） 、 xor（异或）操作并将结果保存在 destkey 中。

# 设置bitmap数据
setbit 2023:03:18 1 1
setbit 2023:03:18 3 1
setbit 2023:03:18 5 1
setbit 2023:03:18 9 1
setbit 2023:03:17 0 1
setbit 2023:03:17 1 1
setbit 2023:03:17 6 1
setbit 2023:03:17 8 1

# 求2023:03:18和2023:03:1 交集
BITOP and 2023:03-17-18 2023:03:17 2023:03:18

# 求2023:03:18和2023:03:1 并集
BITOP or 2023:03-17-18 2023:03:17 2023:03:18

• BITPOS：查找bit数组中指定范围内第一个0或1出现的位置

BITPOS key bit [start [end [BYTE|BIT]]]
  summary: Find first bit set or clear in a string
  since: 2.8.7
  group: bitmap

# 查找第一个1出现的角标
BITPOS bm1 1

# 查找指定范围内第一个1出现的角标
BITPOS bm1 0 5 1

1.2 代码实现签到功能

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 SETBIT key offset 1
        stringRedisTemplate.opsForValue().setBit(key, dayOfMonth - 1, true);
        return Result.ok();
    }
      

1.3 统计连续签到

连续签到天数：从最后一次签到开始向前统计，直到遇到第一次未签到为止，计算总的签到次数，就是连续签到天数。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-aMs83uMd-1679108903214)(https://note.youdao.com/yws/api/personal/file/4C88AA8F75F24235917625388E710FE2?method=download&shareKey=d9b14f1c2ae1f08e5dfeb8e8af94fc5e)]

1.3.1 如何得到本月到今天为止的所有签到数据

BITFIELD key GET u[dayOfMonth]0

1.3.2 如何从后向前遍历每个bit位

• 与1做与运算，就能得到最后一个bit位
• 随后右移1位，下一位bit位就成为了最后一个bit位

1.3.3 代码实现

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.获取本月截止今天为止的所有的签到记录，返回的是一个十进制的数字 BITFIELD sign:5:202203 GET u14 0
        List 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位  // 判断这个bit位是否为0
            if ((num & 1) == 0) {
                // 如果为0，说明未签到，结束
                break;
            }else {
                // 如果不为0，说明已签到，计数器+1
                count++;
            }
            // 把数字右移一位，抛弃最后一个bit位，继续下一个bit位
            num >>>= 1;
        }
        return Result.ok(count);
    }