使用Redis位图实现7天连续签到

需求背景

用户每日签到，以7天为一个周期。签到第一天领取10金币，连续签到两天领30金币，连续签到三天领40金币…期间如果断开则从签到第一天开始

实现思路

实现用户签到功能，我们需要知道用户今日是否签到，用户连续签到的天数，用户签到日历等信息。

对于用户签到数据，如果每条数据都用K/V的方式存储，当用户量大的时候内存开销是非常大的。而位图(BitMap)是由一组bit位组成的，每个bit位对应0和1两个状态，虽然内部还是采用String类型存储，但Redis提供了一些指令用于直接操作位图，可以把它看作是一个bit数组，数组的下标就是偏移量。它的优点是内存开销小、效率高且操作简单，很适合用于签到，用户登录这类场景。

考虑到每月初需要重置连续签到次数，最简单的方式是按用户每月存一条签到数据（也可以每年存一条数据）。Key的格式为u:sign:uid:yyyy-MM，Value则采用长度为4个字节（32位）的位图（最大月份只有31天）。位图的每一位代表一天的签到，1表示已签，0表示未签。例如u:sign:580:2021-08表示ID=580的用户在2021年8月的签到记录。

# 用户2月17号签到
SETBIT u:sign:1000:201902 16 1 # 偏移量是从0开始，所以要把17减1

# 检查2月17号是否签到
GETBIT u:sign:1000:201902 16 # 偏移量是从0开始，所以要把17减1

# 统计2月份的签到次数
BITCOUNT u:sign:1000:201902

# 获取2月份前28天的签到数据
BITFIELD u:sign:1000:201902 get u28 0

# 获取2月份首次签到的日期
BITPOS u:sign:1000:201902 1 # 返回的首次签到的偏移量，加上1即为当月的某一天

上面的两段引用自: https://www.cnblogs.com/liujiduo/p/10396020.html

实例代码

@Slf4j
@Service
public class SignServiceImpl implements SignService {


    private final StringRedisTemplate stringRedisTemplate;

    public SignServiceImpl(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    private int dayOfMonth() {
        DateTime dateTime = new DateTime();
        return dateTime.dayOfMonth().get();
    }

 		/**
     *  按照月份和用户ID生成用户签到标识 UserId:Sign:560:2021-08
     * 
     * @param userId 用户id
     * @return
     */
    private String signKeyWitMouth(String userId) {
        DateTime dateTime = new DateTime();
        DateTimeFormatter fmt = DateTimeFormat.forPattern("yyyy-MM");

        StringBuilder builder = new StringBuilder("UserId:Sign:");
        builder.append(userId).append(":")
                .append(dateTime.toString(fmt));
        return builder.toString();
    }
    
    /**
     * 设置标记位
     * 标记是否签到
     * 
     * @param key
     * @param offset
     * @param tag
     * @return
     */
    public Boolean mark(String key, long offset, boolean tag) {
        return this.stringRedisTemplate.opsForValue().setBit(key, offset, tag);
    }


    /**
     * 统计计数
     *
     * @param key 用户标识
     * @return
     */
    public long bitCount(String key) {
        return stringRedisTemplate.execute((RedisCallback<Long>) redisConnection -> redisConnection.bitCount(key.getBytes()));
    }

	/**
	 * 获取多字节位域 
	 * 
	 */
    public List<Long> bitfield(String buildSignKey, int limit, long offset) {
        return this.stringRedisTemplate
                .opsForValue()
                .bitField(buildSignKey, BitFieldSubCommands.create().get(BitFieldSubCommands.BitFieldType.unsigned(limit)).valueAt(offset));
    }


    /**
     * 判断是否被标记
     *
     * @param key
     * @param offest
     * @return
     */
    public Boolean container(String key, long offest) {
        return this.stringRedisTemplate.opsForValue().getBit(key, offest);
    }


    /**
     * 用户今天是否签到
     * @param userId
     * @return
     */
    @Override
    public SignDetailResponse checkSign(String userId) {
        SignDetailResponse signDetailResponse = new SignDetailResponse();
        DateTime dateTime = new DateTime();

        String signKey = this.signKeyWitMouth(userId);
        int offset = dateTime.getDayOfMonth() - 1;
        int value = this.container(signKey, offset)?1:0;

        signDetailResponse.setTodaySignStatus(SignDetailResponse.TodaySignStatusEnum.fromValue(value));
        return signDetailResponse;
    }


    /**
     *  查询用户当月签到日历
     * @param userId
     * @return
     */
    @Override
    public Map<String, Boolean> querySignedInMonth(String userId) {
        DateTime dateTime = new DateTime();
        int lengthOfMonth = dateTime.dayOfMonth().getMaximumValue();
        Map<String, Boolean> signedInMap = new HashMap<>(dateTime.getDayOfMonth());

        String signKey = this.signKeyWitMouth(userId);
        List<Long> bitfield = this.bitfield(signKey, lengthOfMonth, 0);
        if (!CollectionUtils.isEmpty(bitfield)) {
            long signFlag = bitfield.get(0) == null ? 0 : bitfield.get(0);

            DateTimeFormatter fmt = DateTimeFormat.forPattern("yyyy-MM-dd");
            for (int i = lengthOfMonth; i > 0; i--) {

                DateTime dateTime1 = dateTime.withDayOfMonth(i);
                signedInMap.put(dateTime1.toString(fmt), signFlag >> 1 << 1 != signFlag);
                signFlag >>= 1;
            }
        }
        return signedInMap;
    }


    /**
     *  用户签到
     * @param userId
     * @return
     */
    @Override
    public SignResponse signWithUserId(String userId) {
        SignResponse signResponse = new SignResponse();
        int dayOfMonth = this.dayOfMonth();
        String signKey = this.signKeyWitMouth(userId);
        long offset = (long)dayOfMonth - 1;
        if (Boolean.TRUE.equals(this.mark(signKey, offset, Boolean.TRUE))) {
            signResponse.setCode(SignResponse.CodeEnum.SUCCESS);
        } else {
            signResponse.setCode(SignResponse.CodeEnum.FAILED);
        }

        // 查询用户连续签到次数,最大连续次数为7天
        long continuousSignCount = this.queryContinuousSignCount(userId,7);
        signResponse.setConSignInDay(continuousSignCount);
        return signResponse;
    }

    /**
     *  统计当前月份一共签到天数
     * @param userId
     */
    @Override
    public long countSignedInDayOfMonth(String userId) {
        String signKey = this.signKeyWitMouth(userId);
        return this.bitCount(signKey);
    }

 
    /**
     *  查询用户当月连续签到次数
     * @param userId
     * @return
     */
    @Override
    public long queryContinuousSignCountOfMonth(String userId) {
        int signCount = 0;
        String signKey = this.signKeyWitMouth(userId);
        int dayOfMonth = this.dayOfMonth();
        List<Long> bitfield = this.bitfield(signKey, dayOfMonth, 0);

        if (!CollectionUtils.isEmpty(bitfield)) {
            long signFlag = bitfield.get(0) == null ? 0 : bitfield.get(0);
            DateTime dateTime = new DateTime();
            // 连续不为0即为连续签到次数，当天未签到情况下
            for (int i = 0; i < dateTime.getDayOfMonth(); i++) {
                if (signFlag >> 1 << 1 == signFlag) {
                    if (i > 0) break;
                } else {
                    signCount += 1;
                }
                signFlag >>= 1;
            }
        }
        return signCount;
    }


   /**
     * 以7天一个周期连续签到次数
     * 
     * @param period 周期 
     * @return
     */
    @Override
    public long queryContinuousSignCount(String userId,Integer period){
        //查询目前连续签到次数
        long count = this.queryContinuousSignCountOfMonth(userId);
        //按最大连续签到取余
        if(period != null && period < count){
            long num = count % period;
            if(num == 0){
                count = period;
            }else{
                count = num;
            }
        }
        return count;
    }
}

测试代码

@RunWith(SpringRunner.class)
@WebAppConfiguration
@SpringBootTest(classes = TaskApplication.class)
public class SignTest {

    @Autowired
    private SignService signService;

    @Autowired
    private StringRedisTemplate redisTemplate;

   /**
     * 测试用户按月签到
     */
    @Test
    public void querySignDay() {
        //设置560用户8.16-25号签到
       /*for(int i=17;i<25;i++){
           redisTemplate.opsForValue().setBit("UserId:Sign:560:2021-08",i,true);
       }*/

        System.out.println("560用户今日是否已签到:"+this.signService.checkSign("560").getTodaySignStatus());
        Map<String, Boolean> stringBooleanMap = this.signService.querySignedInMonth("560");
        System.out.println("本月签到情况:");
        for (Map.Entry<String, Boolean> entry : stringBooleanMap.entrySet()) {
            System.out.println(entry.getKey() + ": " + (entry.getValue() ? "√" : "-"));
        }
        long countSignedInDayOfMonth = this.signService.countSignedInDayOfMonth("560");
        System.out.println("本月一共签到:"+countSignedInDayOfMonth+"天");
        System.out.println("目前连续签到:"+ this.signService.queryContinuousSignCount("560",7)+"天");
    }

输出结果

有一个问题需要注意，每个用户每个月存一条数据，会有跨月份的问题。假如一个用户从8.1号一直连续签到，到9.1号是连续签到32天，7天一个周期，也就是连续签到32%7=4天。而我们是按用户每个月存一条数据，这样就会出现跨月的问题。
对此，可以每逢月末最后一天记录目前坚持连续签到的天数，每次签到的时候判断一下本月从1号开始是否一直连续签到，如果一直连续签到，就加上上月连续签到的天数。这样就是总共连续签到的次数了。
参考文章:
https://www.cnblogs.com/liujiduo/p/10396020.html
https://my.oschina.net/magebyte/blog/5200908