SpringBoot+Redis BitMap实现签到与统计的项目实践

DROP TABLE IF EXISTS `tb_sign`;
CREATE TABLE `tb_sign` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `user_id` int(11) NOT NULL COMMENT '用户Id',
  `year` year(4) NOT NULL COMMENT '签到的年',
  `month` tinyint(2) NOT NULL COMMENT '签到的月',
  `date` date NOT NULL COMMENT '签到日期',
  `is_backup` tinyint(1) NOT NULL COMMENT '是否补签',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

SETBIT bm1 0 1

help SETBIT

GETBIT bm1 2

BITCOUNT bm1 

BITFIELD key [GET type offset] [SET type offset value] [INCRBY type offset increment] [OVERFLOW WRAP|SAT|FAIL]

127.0.0.1:6379> BITFIELD myint GET u3 3 u1 6
1) (integer) 1
2) (integer) 0

127.0.0.1:6379> BITFIELD myint SET u3 3 5
(integer) 10

# 用户9月17号签到
SETBIT USER_SIGN_KEY:122101:202309 16 1 # 偏移量是从0开始，所以要把17减1
# 检查9月17号是否签到
GETBIT USER_SIGN_KEY:122101:202309 16 # 偏移量是从0开始，所以要把17减1
# 统计9月份的签到次数
BITCOUNT USER_SIGN_KEY:122101:202309
# 获取9月份前30天的签到数据，u30表示取0-29位的数据
BITFIELD USER_SIGN_KEY:122101:202309 get u30 0
# 获取9月份首次签到的日期
BITPOS USER_SIGN_KEY:122101:202309 1 # 返回的首次签到的偏移量，加上1即为当月的某一天

    @GetMapping("sign")
    public Object sign() {
        //1. 获取登录用户
        Long userId = 122101L;
        //2.获取签到使用的key
        String key = RedisKeyUtils.createSignKey(userId);
        //3. 获取今天是本月的第几天设置偏移量
        LocalDateTime now = LocalDateTime.now();
        int offset = now.getDayOfMonth() - 1;
        System.out.println(String.format("入参：key:%s，offset:%s", JSON.toJSONString(key), JSON.toJSONString(offset)));
        //5. 写入redis setbit key offset 1
        Boolean res = jedis.setbit(key, offset, true);
        System.out.println(String.format("出参：%s", JSON.toJSONString(res)));
        return String.format("%s签到成功，签到结果：%s", JSON.toJSONString(now.format(DateTimeFormatter.ofPattern("yyyyMM"))), JSON.toJSONString(res));
    }

    @GetMapping("checkSign")
    public Object checkSign(@RequestParam(value = "sigDate") String sigDate) {
        //1. 获取登录用户
        Long userId = 122101L;
        //2.获取签到使用的key
        LocalDateTime time = TimeUtils.str2LocalDateTime(TimeUtils.PATTERN.YYYYMMDD, sigDate);
        if (Objects.isNull(time)) {
            return false;
        }
        String key = RedisKeyUtils.createSignKey(time, userId);
        //3. 获取今天是本月的第几天设置偏移量
        int offset = time.getDayOfMonth() - 1;
        System.out.println(String.format("入参：key:%s，offset:%s", JSON.toJSONString(key), JSON.toJSONString(offset)));
        Boolean res = jedis.getbit(key, offset);
        System.out.println(String.format("出参：%s", JSON.toJSONString(res)));
        return res;
    }

BITFIELD key GET u[dayOfMonth-1] 0

    @GetMapping("signCount")
    public Object signCount() {
        //1. 获取登录用户
        Long userId = 122101L;
        //2. 获取日期
        LocalDateTime now = LocalDateTime.now();
        //3. 拼接key
        String key = RedisKeyUtils.createSignKey(now, userId);
        //4. 获取今天是本月的第几天
        int offset = now.getDayOfMonth();
        //5. 获取本月截至今天为止的所有的签到记录，返回的是一个十进制的数字 BITFIELD USER_SIGN_KEY1:5:202309 GET u5 0
        String type = String.format("u%d", offset);
        System.out.println(String.format("入参：key:%s,operationType:%s,type:%s", JSON.toJSONString(key), JSON.toJSONString(RedisHelper.OPERATION_TYPE.GET.name()), JSON.toJSONString(type)));
        List<Long> result = RedisHelper.bitField(key, RedisHelper.OPERATION_TYPE.GET, type, "0");
        //没有任务签到结果
        if (result == null || result.isEmpty()) {
            return 0;
        }
        Long num = result.get(0);
        if (num == null || num == 0) {
            return 0;
        }
        //6. 循环遍历
        int count = 0;
        while (true) {
            //6.1 让这个数字与1 做与运算，得到数字的最后一个bit位 判断这个数字是否为0
            if ((num & 1) == 0) {
                //如果为0，签到结束
                break;
            } else {
                count++;
            }
            num >>>= 1;
        }
        System.out.println(String.format("缓存值：%s,签到天数：%d", JSON.toJSONString(result), count));
        return count;
    }

    @GetMapping("getFirstSignDate")
    public Object getFirstSignDate(@RequestParam(value = "time") String time) {
        //1. 获取登录用户
        Long userId = 122101L;
        //2. 获取日期
        LocalDateTime dateTime = TimeUtils.str2LocalDateTime(TimeUtils.PATTERN.YYYYMMDD, time);
        //3. 拼接key
        String key = RedisKeyUtils.createSignKey(dateTime, userId);
        //4. 获取首次出现的位置索引
        long pos = jedis.bitpos(key, true);
        //5. 转换为日期
        String res = pos < 0 ? "无签到记录" : TimeUtils.localDateTime2String(TimeUtils.PATTERN.YYYYMMDD, dateTime.withDayOfMonth((int) (pos + 1)));
        return res;
    }

    @GetMapping("getSignInfo")
    public Object getSignInfo(@RequestParam(value = "time") String time) {
        //1. 获取登录用户
        Long userId = 122101L;
        //2. 获取日期
        LocalDateTime dateTime = TimeUtils.str2LocalDateTime(TimeUtils.PATTERN.YYYYMMDD, time);
        //当月天数
        int monthOfDays = TimeUtils.getDayNumsOfMonth(dateTime);
        Map<String, Boolean> signMap = new HashMap<>(dateTime.getDayOfMonth());
        //3. 拼接key
        String key = RedisKeyUtils.createSignKey(dateTime, userId);
        //4. 设置位数
        String type = String.format("u%d", monthOfDays);
        System.out.println(String.format("入参：key:%s,operationType:%s,type:%s", JSON.toJSONString(key), JSON.toJSONString(RedisHelper.OPERATION_TYPE.GET.name()), JSON.toJSONString(type)));
        List<Long> list = RedisHelper.bitField(key, RedisHelper.OPERATION_TYPE.GET, type, "0");
        if (!CollectionUtils.isEmpty(list)) {
            Long num = list.get(0);
            int i = monthOfDays;
            while (i > 0) {
                String d = TimeUtils.localDateTime2String(TimeUtils.PATTERN.YYYYMMDD, dateTime.withDayOfMonth(i--));
                if ((num & 1) == 0) {
                    signMap.put(d, false);
                } else {
                    signMap.put(d, true);
                }
                num >>>= 1;
            }
        }
        //按照日期排序
        TreeMap sortedMap = new TreeMap(signMap);
        System.out.println("出参：" + JSON.toJSONString(sortedMap));
        return sortedMap;
    }