SpringBoot+Redis BitMap 实现签到与统计功能

引言

在各个项目中，我们都可能需要用到签到和统计功能。签到后会给用户一些礼品以此来吸引用户持续在该平台进行活跃。

签到功能，我们可以通过Redis中的 BitMap功能来实现

Redis BitMap 基本用法

BitMap 基本语法、指令

签到功能我们可以使用MySQL来完成，比如下表：

sql

CREATE TABLE `tb_sign` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
    `user_id` bigint(20) unsigned 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) unsigned DEFAULT NULL COMMENT '是否补签',
    PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=COMPACT;

用户一次签到，就是一条记录，假如有1000万用户，平均每人每年签到次数为10次，则这张表一年的数据量为 1亿条

每签到一次需要使用（8 + 8 + 1 + 1 + 3 + 1）共22 字节的内存，一个月则最多需要600多字节

这样的坏处，占用内存太大了，极大的消耗内存空间！

我们可以根据 Redis中提供的 BitMap 位图功能来实现，每次签到与未签到用0 或1 来标识，一次存31个数字，只用了2字节这样我们就用极小的空间实现了签到功能

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出现的位置

使用 BitMap 完成功能实现

进入redis查询 SETBIT 命令

shell

-> % redis-cli -h 127.0.0.1 -p 6379              
127.0.0.1:6379> help SETBIT

SETBIT key offset value
summary: Sets or clears the bit at offset of the string value. Creates the key if it doesn't exist.
since: 2.2.0
group: bitmap

新增key 进行存储

shell

127.0.0.1:6379> SETBIT bm1 0 1
(integer) 0
127.0.0.1:6379> SETBIT bm1 1 1
(integer) 0
127.0.0.1:6379> SETBIT bm1 2 1
(integer) 0
127.0.0.1:6379> SETBIT bm1 4 1
(integer) 0
127.0.0.1:6379> SETBIT bm1 5 1
(integer) 0

查询 GETBIT命令

shell

127.0.0.1:6379> help GETBIT

GETBIT key offset
summary: Returns a bit value by offset.
since: 2.2.0
group: bitmap

查看指定坐标的签到状态

shell

127.0.0.1:6379> GETBIT bm1 2
(integer) 1

查询 BITFIELD

shell

127.0.0.1:6379> help BITFIELD

BITFIELD key [GET encoding offset|[OVERFLOW WRAP|SAT|FAIL] SET encoding offset value|INCRBY encoding offset increment [GET encoding offset|[OVERFLOW WRAP|SAT|FAIL] SET encoding offset value|INCRBY encoding offset increment ...]]
summary: Performs arbitrary bitfield integer operations on strings.
since: 3.2.0
group: bitmap

无符号查询

shell

127.0.0.1:6379> BITFIELD bm1 get u2 0
1) (integer) 3
127.0.0.1:6379> BITFIELD bm1 get u3 0
1) (integer) 7
127.0.0.1:6379> BITFIELD bm1 get u4 0
1) (integer) 14

BITFIELD bm1 get u2 0 含义: 从 Redis key bm1 中获取从 0 位开始的 2 位，并将这 2 位解释为一个无符号整数。

查询 BITPOS

shell

127.0.0.1:6379> help BITPOS

BITPOS key bit [start [end [BYTE|BIT]]]
summary: Finds the first set (1) or clear (0) bit in a string.
since: 2.8.7
group: bitmap

BITPOS 查询1 和 0 第一次出现的坐标

shell

127.0.0.1:6379> BITPOS bm1 0
(integer) 3
127.0.0.1:6379> BITPOS bm1 1
(integer) 0

SpringBoot 整合 Redis 实现签到功能

需求介绍

采用BitMap实现签到功能
实现签到接口，将当前用户当天签到信息保存到Redis中

思路分析

我们可以把年和月作为BitMap的key，然后保存到一个BitMap中，每次签到就到对应的位上把数字从0 变为1，只要是1，就代表是这一天签到了，反之咋没有签到。

实现签到接口，将当前用户当天签到信息保存至Redis中

提示：因为BitMap 底层是基于String数据结构，因此其操作都封装在字符串操作中了。

code

UserController

java

@PostMapping("sign")
public Result sign() {
    return userService.sign();
}

UserServiceImpl

java

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 = RedisConstants.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();
}

SpringBoot 整合Redis 实现签到统计功能

什么叫做连续签到天数？

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

逻辑分析

获得当前这个月的最后一次签到数据，定义一个计数器，然后不停的向前统计，直到获得第一个非0的数字即可，每得到一个非0的数字计数器+1，直到遍历完所有的数据，就可以获得当前月的签到总天数了

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

BITFIELD key GET u[dayOfMonth] 0

假设今天是7号，那么我们就可以从当前月的第一天开始，获得到当前这一天的位数，是7号，那么就是7位，去拿这段时间的数据，就能拿到所有的数据了，那么这7天里边签到了多少次呢？统计有多少个1即可。

如何从后向前遍历每个Bit位？

注意：bitMap返回的数据是10进制，哪假如说返回一个数字8，那么我哪儿知道到底哪些是0，哪些是1呢？我们只需要让得到的10进制数字和1做与运算就可以了，因为1只有遇见1 才是1，其他数字都是0 ，我们把签到结果和1进行与操作，每与一次，就把签到结果向右移动一位，依次内推，我们就能完成逐个遍历的效果了。

code

UserController

java

@GetMapping("/signCount")
public Result signCount() {
    return userService.signCount();
}

UserServiceImpl

java

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 = RedisConstants.USER_SIGN_KEY + userId + keySuffix;
    //4. 获取今天是本月的第几天
    int dayOfMonth = now.getDayOfMonth();
    //5. 获取本月截至今天为止的所有的签到记录，返回的是一个十进制的数字 BITFIELD sign:5:202301 GET u3 0
    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位 判断这个数字是否为0
        if ((num & 1) == 0) {
            //如果为0，签到结束
            break;
        } else {
            count ++;
        }
        num >>>= 1;
    }
    return Result.ok(count);
}

SpringBoot+Redis BitMap 实现签到与统计功能 #

引言 #

Redis BitMap 基本用法 #

BitMap 基本语法、指令 #

BitMap 的操作指令： #

使用 BitMap 完成功能实现 #

SpringBoot 整合 Redis 实现签到 功能 #

需求介绍 #

思路分析 #

code #

SpringBoot 整合Redis 实现 签到统计功能 #

什么叫做连续签到天数？ #

逻辑分析 #

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

如何从后向前遍历每个Bit位？ #

code #

SpringBoot+Redis BitMap 实现签到与统计功能

引言

Redis BitMap 基本用法

BitMap 基本语法、指令

BitMap 的操作指令：

使用 BitMap 完成功能实现

SpringBoot 整合 Redis 实现签到功能

需求介绍

思路分析

code

SpringBoot 整合Redis 实现签到统计功能

什么叫做连续签到天数？

逻辑分析

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

如何从后向前遍历每个Bit位？

code