redis之bitmap使用及项目应用

bitmap的使用

本章主要讲解bitmap的使用，bitmap底层也是string类型，通俗可以理解为每个key都是字符串，但是有特殊的命令对该字符串进行位操作。本章的命令对于没有接触过的同学可能会有点生疏，建议从应用场景开始查看以提高兴趣。

注：下列的截图测试数据添加没有完全说明，展示的时候有时候会不理解，有疑惑可以评论区留言

一、bitmap特性说明

1、底层结构为string类型
2、设置的bit位长度最多为2^32-1,意味着每个键值的最大存储为512M
3、新增的bit位默认位0

二、相关命令使用

本章介绍依旧是从命令开始介绍，若觉得无聊建议从应用场景开始看起，再回头看看命令的使用。

（一）setbig

命令格式： SETBIT key offset value

功能：设置一个bit位值

demo说明：

（二）getbit

命令格式： GETBIT key offset

功能：获取一个bit位值

demo说明：

（三）bitcount

命令格式： BITCOUNT key [start end]

功能：统计字符串被设置为1的bit数

demo说明：

（四）bitop

命令格式： BITOP operation destkey key [key ...]

功能：对一个或多个保存二进制位的字符串 key 进行位元操作，并将结果保存到 destkey 上

demo说明：
首先设置给键为test1000和test4000设置一批数据

对test1000和test4000做逻辑并，并将结果保存到resultand 同理其他位运算就不一一演示

（五）BITFIELD

命令格式：# key [GET type offset] [SET type offset value] [INCRBY type offset increment] [OVERFLOW WRAP|SAT|FAIL]

功能：本命令会把Redis字符串当作位数组，并能对变长位宽和任意未字节对齐的指定整型位域进行寻址。

demo说明： 表示对test1000取出五位无符号数，二进制累加起来刚好29

（六）bitpos

命令格式：BITPOS key bit [start] [end]

功能：返回字符串里面第一个被设置为1或者0的bit位。start、end表示的是字节，一字节的8bit。start=0且end=2表示在前三个字节内寻找

demo说明：
首先设置一批数据（这里从1设置，但其实数据是从零开始，没设置默认为0）

查看范围在第一字节到第二字节首次设为为1的bit位

查看首次设为为0的bit位

查看范围在第一字节到第二字节首次设为为0的bit位

三、应用场景

(一) 实现签到功能

1、需求

前台用户：

• 用户签到、今日是否已签到、每月的签到记录  
  复制代码

后台管理：

• 统计每天有多少用户签到    
  复制代码

2、设计

• 采用redis的bitmap存储
• 存储每天所有用户签到：bitmap的key设计为 userSign+日期，如userSign_20211122,偏移量offen采用用户的id
• 存储单个用户每月签到：bitmap的key设计为 userSign+id+日期，如userSign_用户id_202111,偏移量offen采用每月的第几天
• 用户签到则在对应的键以及对应的偏移量设置值为1

3、代码开发

前台功能接口

下面接口实现比较细化，主要是为了方便查看。正常项目开发肯定会将多种数据封装在一个接口返回。如当日是否已签到、某月签到日历、连续签到次数这几个接口会封装成一个接口

a、用户签到接口

@ApiOperation("签到")
@PostMapping(value = "/userSign")
public RestResponse userSign() throws Exception{
    //用户id,平时我们得从token或者session中获取
    Long userId = 123456L;
    LocalDate localDate = LocalDate.now();

    //用户每月的签到键
    String userKey = "userSign_"+ Long.valueOf(userId)+"_"+String.valueOf(localDate.getYear()) + localDate.getMonth().getValue();
    //所有用户每月的签到键
    String signKey = "userSign_"+"_"+String.valueOf(localDate.getYear()) + localDate.getMonth().getValue();

    //今天是当月的第几天
    int date = localDate.getDayOfMonth();
    //用户每月的签到集合
    Boolean result = redisTemplate.opsForValue().setBit(userKey, new Long(date), true);

    if(result){
        //首先判断该用户是否已签到   setBit 会返回原始值，若原本是true，则表示已签到
        return new RestResponse(60001,"你今天已签到了哦！明天再来");

    }else{
        //所有用户每月的签到集合
        redisTemplate.opsForValue().setBit(signKey, userId, true);
        //返回信息
        return new RestResponse(0,"签到成功");
    }
}
复制代码

b、获取用户每月的签到数据

@ApiOperation("获取用户每月的签到数据")
@PostMapping(value = "/getSignData")
public RestResponse getSignData(Integer year, Integer month) throws Exception{

    LocalDate selectLocalDate = LocalDate.of(year,month,1);
    //查询的月份有少天
    int lengthMonth = selectLocalDate.lengthOfMonth();

    //用户id,平时我们得从token或者session中获取
    Long userId = 123456L;
    String userKey = "userSign_"+ Long.valueOf(userId)+"_"+String.valueOf(year) +String.valueOf(month);

    long mask = 0b1;
    //用bitfield命令取出第一天到当月最后一天的数据
    List<Long> signList = (List<Long>)redisTemplate.execute((RedisCallback<List<Long>>) con -> con.bitField(userKey.getBytes(), BitFieldSubCommands.create().get(BitFieldSubCommands.BitFieldType.unsigned(lengthMonth+1)).valueAt(0)));
    //签到数据
    List<Long> userSignList = new ArrayList<>();

    if (!CollectionUtils.isEmpty(signList)) {
        long sign = signList.get(0) == null ? 0 : signList.get(0);
        for (int i = selectLocalDate.lengthOfMonth(); i > 0; i--) {
            //从最后一天往前算
            userSignList.add((sign & mask));

            //最低位前进一天
            sign >>= 1;
        }
    }
    //翻转list
    Collections.reverse(userSignList);
    //打印结果
    System.out.println(userSignList);
    return new RestResponse(0,"获取成功",userSignList);
}
复制代码

c、今日是否已签到

@ApiOperation("今日是否已签到")
@GetMapping(value = "/checkSign")
public RestResponse checkSign() throws Exception{
    //用户id,平时我们得从token或者session中获取
    Long userId = 123456L;
    LocalDate localDate = LocalDate.now();

    //用户每月的签到键
    String userKey = "userSign_"+ Long.valueOf(userId)+"_"+String.valueOf(localDate.getYear()) + localDate.getMonth().getValue();
    //今天是当月的第几天
    int date = localDate.getDayOfMonth();
    //用户每月的签到集合
    Boolean result = redisTemplate.opsForValue().getBit(userKey, new Long(date));

    //自己将数据封装返回  我这里只是给个提示
    if(result){
        return new RestResponse(0,"今日已签到");

    }else{
        return new RestResponse(0,"今日未签到");
    }
}
复制代码

d、用户当月总签到次数

@ApiOperation("当月总签到次数")
@GetMapping(value = "/countSignTimes")
public RestResponse countSignTimes() throws Exception{
    //用户id,平时我们得从token或者session中获取
    Long userId = 123456L;
    LocalDate localDate = LocalDate.now();

    //用户每月的签到键
    String userKey = "userSign_"+ Long.valueOf(userId)+"_"+String.valueOf(localDate.getYear()) + localDate.getMonth().getValue();

    Long count = (Long) redisTemplate.execute((RedisCallback<Long>) connection -> connection.bitCount(userKey.getBytes()));

    return new RestResponse(0,"当月已签到"+String.valueOf(count)+"次");

}
复制代码

后台功能接口

a、统计每天有多少用户签到

@ApiOperation("统计每天有多少用户签到")
@GetMapping(value = "/countAllUserSignTimes")
public RestResponse countAllUserSignTimes(Integer year, Integer month,Integer day) throws Exception{
    //用户id,平时我们得从token或者session中获取
    LocalDate localDate = LocalDate.now();

    //所有用户每天的签到键
    String signKey = "userSign_"+String.valueOf(localDate.getYear()) + localDate.getMonth().getValue() + localDate.getDayOfMonth();

    Long count = (Long) redisTemplate.execute((RedisCallback<Long>) connection -> connection.bitCount(signKey.getBytes()));

    return new RestResponse(0,"该天有"+String.valueOf(count)+"用户签到");

}
复制代码

4、测试

这里用工具postman简单地测试一下功能，按顺序从上往下

（1）用户签到

（2）获取用户每月的签到数据

（3）今日是否已签到

（4） 当月签到次数

（5） 统计每天有多少用户签到

(二) 实现用户活跃度

有需要可以评论，后续补充

(三) 实现记录登陆状态

有需要可以评论，后续补充