基于SpringBoot+Redis实现签到、签到统计功能
前言
做项目开发时，经常需要实现签到和签到统计的功能。实现这两个功能并不难，通常只用MySQL就可以快速实现，但是这只适用于较小用户量的场景。若是千万级用户量甚至以上的时候，不妨使用Redis来实现，区别就是MySQL占用空间太多，而Redis仅用极小的空间就实现了。
开发文档：https://redis.io/commands/
Redis版本：Redis 7.2.3
一、Redis键之EXISTS命令
1.EXISTS 命令
（1）用法：EXISTS key 或 EXISTS key1 key2 ...
（2）作用：检查指定的一个或多个key是否存在。
（3）返回值：key 存在返回 1 ，否则返回 0 。
（4）示例
redis> SET key1 "Hello"
"OK"
redis> EXISTS key1
(integer) 1
redis> EXISTS nosuchkey
(integer) 0
redis> SET key2 "World"
"OK"
redis> EXISTS key1 key2 nosuchkey
(integer) 2二、Redis位图之BITFIELD命令
1.BITFIELD 命令
（1）用法：BITFIELD key [GET type offset] [SET type offset value] [INCRBY type offset increment] [OVERFLOW WRAP|SAT|FAIL]
（2）位图数据类型：位图的数据类型，如：u3、u8、u16、u32、i8、i16、i32等，其中u3为无符号整数数据类型。
（3）作用：对一个或多个位图进行读取、修改和计算操作。
（4）返回值：若操作成功，则返回一个数组，数组中的每个元素对应一个操作的返回值。若操作失败，则返回一个错误信息。
（5）示例
redis> BITFIELD User-Sign-10001:202311 GET u3 0三、Redis字符串数据类型的Setbit和Getbit命令
1.Setbit 命令
（1）用法：SETBIT key offset value
（2）作用：对 key 所储存的字符串值，设置或清除指定偏移量上的位(bit)。
（3）返回值：指定偏移量原来储存的位。
（4）示例
redis> SETBIT bit 666 1
(integer) 0
redis> GETBIT bit 666
(integer) 1
redis> GETBIT bit 100 # bit 默认被初始化为 0
(integer) 02.Getbit 命令
（1）用法：GETBIT key offset
（2）作用：对 key 所储存的字符串值，获取指定偏移量上的位(bit)。
（3）返回值：指定偏移量储存的位，当偏移量 OFFSET 比字符串值的长度大，或者 key 不存在时，返回 0 。
（4）示例
redis> EXISTS bit
(integer) 0
redis> GETBIT bit 666
(integer) 0
redis> SETBIT bit 666 1
(integer) 0
redis> GETBIT bit 666
(integer) 1四、实战案例
1.添加依赖
（1）pom.xml
org.springframework.boot
spring-boot-starter-data-redis
2.添加Redis配置
（1）application.yml
spring:
#---- ^ redis 配置 ----#
cache:
type: redis # 缓存类型
redis:
host: 127.0.0.1 # Redis数据库主机
port: 6379 # Redis数据库端口
password: 123456 # Redis数据库密码
database: 15 # Redis数据库索引
timeout: 0 # Redis数据库连接超时时间
jedis:
pool:
max-active: 8 # Redis数据库连接池最大连接数
max-idle: 8 # Redis数据库连接池最大空闲连接数
min-idle: 0 # Redis数据库连接池最小空闲连接数
max-wait: -1 # Redis数据库连接池最大阻塞等待时间
#---- / redis 配置 ----#3.控制层
（1）UserController.java
package org.example.controller;
import org.example.service.impl.UserServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import java.util.HashMap;
@Controller
@RequestMapping(value = "api")
public class UserController {
@Autowired
private UserServiceImpl userService;
/**
* 签到
* {
* userId: 10001
* }
*/
@PostMapping(value = "sign")
@ResponseBody
@CrossOrigin
public T sign (@RequestBody HashMap data) {
return userService.sign(data);
}
/**
* 连续签到总数
* {
* userId: 10001
* }
*/
@PostMapping(value = "signCount")
@ResponseBody
@CrossOrigin
public T signCount (@RequestBody HashMap data) {
return userService.signCount(data);
}
}
4.接口层
（1）IUserService.java
package org.example.service;
import java.util.HashMap;
public interface IUserService {
T sign(HashMap data);
T signCount(HashMap data);
}
5.实现层
（1）UserServiceImpl.java
package org.example.service.impl;
import org.example.service.IUserService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.BitFieldSubCommands;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Service;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.HashMap;
import java.util.List;
@Service
public class UserServiceImpl implements IUserService {
private static final String USER_SIGN_KEY = "User-Sign-";
private static final Logger log = LoggerFactory.getLogger(UserServiceImpl.class);
@Autowired
private StringRedisTemplate stringRedisTemplate;
@Override
public T sign(HashMap data) {
HashMap responseObj = new HashMap<>();
try {
// 用户ID，如：10001
Long userId = Long.parseLong(String.valueOf(data.get("userId")));
// 当前日期，如：2023-11-14T10:55:25.099
LocalDateTime now = LocalDateTime.now();
// 键名后缀，如：:202311
String keySuffix = now.format(DateTimeFormatter.ofPattern(":yyyyMM"));
// 完整键名，如：User-Sign-10001:202311
String key = USER_SIGN_KEY + userId + keySuffix;
// 获取今天是本月的第几天，如：14
int dayOfMonth = now.getDayOfMonth();
// SETBIT key offset 1，说明：Redis偏移量从0开始计算
stringRedisTemplate.opsForValue().setBit(key, dayOfMonth - 1, true);
responseObj.put("code", 200);
responseObj.put("success", true);
responseObj.put("msg", "签到成功");
} catch (Exception e) {
responseObj.put("code", 500);
responseObj.put("success", false);
responseObj.put("msg", e.getMessage());
}
return (T) responseObj;
}
@Override
public T signCount(HashMap data) {
HashMap responseObj = new HashMap<>();
try {
// 用户ID，如：10001
Long userId = Long.parseLong(String.valueOf(data.get("userId")));
// 当前日期，如：2023-11-14T10:55:25.099
LocalDateTime now = LocalDateTime.now();
// 键名后缀，如：:202311
String keySuffix = now.format(DateTimeFormatter.ofPattern(":yyyyMM"));
// 完整键名，如：User-Sign-10001:202311
String key = USER_SIGN_KEY + userId + keySuffix;
// 获取今天是本月的第几天，如：14
int dayOfMonth = now.getDayOfMonth();
// 获取从本月开始至今日的所有的签到记录，返回一个十进制的数组， BITFIELD User-Sign-10001:202311 GET u3 0
List result = stringRedisTemplate.opsForValue().bitField(key, BitFieldSubCommands.create().get(BitFieldSubCommands.BitFieldType.unsigned(dayOfMonth)).valueAt(0)); // [3]
if (result == null || result.isEmpty()) {
responseObj.put("data", 0);
responseObj.put("msg", "无签到记录");
} else {
Long num = result.get(0); // 3
if (num == null || num == 0) {
responseObj.put("data", 0);
responseObj.put("msg", "无签到记录");
} else {
int count = 0;
while (true) {
// 让这个数字和1一起做`与运算`，得到数字的最后一个bit位 判断这个数字是否为0
if ((num & 1) == 0) {
// 如果为0，签到结束
break;
} else {
count++;
}
num >>>= 1;
}
responseObj.put("data", count);
responseObj.put("msg", "获取成功");
}
}
responseObj.put("code", 200);
responseObj.put("success", true);
} catch (Exception e) {
responseObj.put("code", 500);
responseObj.put("success", false);
responseObj.put("msg", e.getMessage());
}
return (T) responseObj;
}
}