目录
很多应用上都有用户签到的功能，尤其是配合积分系统一起使用。现在有以下需求：
- 签到1天得1积分，连续签到2天得2积分，3天得3积分，3天以上均得3积分等。
- 如果连续签到中断，则重置计数，每月重置计数。
- 显示用户某月的签到次数和首次签到时间。
- 在日历控件上展示用户每月签到，可以切换年月显示。
- …
功能分析
对于用户签到数据，如果直接采用数据库存储，当出现高并发访问时，对数据库压力会很大，例如双十一签到活动。这时候应该采用缓存，以减轻数据库的压力，redis是高性能的内存数据库，适用于这样的场景。
如果采用string类型保存，当用户数量大时，内存开销就非常大。
如果采用集合类型保存，例如set、hash，查询用户某个范围的数据时，查询效率又不高。
redis提供的数据类型bitmap（位图），每个bit位对应0和1两个状态。虽然内部还是采用string类型存储，但redis提供了一些指令用于直接操作bitmap，可以把它看作一个bit数组，数组的下标就是偏移量。
它的优点是内存开销小，效率高且操作简单，很适合用于签到这类场景。缺点在于位计算和位表示数值的局限。如果要用位来做业务数据记录，就不要在意value的值。
redis提供了以下几个指令用于操作bitmap：
| 命令 | 说明 | 可用版本 | 时间复杂度 |
|---|---|---|---|
| setbit | 对 key 所储存的字符串值，设置或清除指定偏移量上的位(bit)。 | >= 2.2.0 | o(1) |
| getbit | 对 key 所储存的字符串值，获取指定偏移量上的位(bit)。 | >= 2.2.0 | o(1) |
| bitcount | 计算给定字符串中，被设置为 1 的比特位的数量。 | >= 2.6.0 | o(n) |
| bitpos | 返回位图中第一个值为 bit 的二进制位的位置。 | >= 2.8.7 | o(n) |
| bitop | 对一个或多个保存二进制位的字符串 key 进行位元操作。 | >= 2.6.0 | o(n) |
| bitfield | bitfield 命令可以在一次调用中同时对多个位范围进行操作。 | >= 3.2.0 | o(1) |
考虑到每月要重置连续签到次数，最简单的方式是按用户每月存一条签到数据。key的格式为 u:sign:{uid}:{yyymm}，而value则采用长度为4个字节的（32位）的bitmap（最大月份只有31天）。bitmap的每一位代表一天的签到，1表示已签，0表示未签。
例如 u:sign:1225:202101 表示id=1225的用户在2021年1月的签到记录
# 用户1月6号签到 setbit u:sign:1225:202101 5 1 # 偏移量是从0开始，所以要把6减1 # 检查1月6号是否签到 getbit u:sign:1225:202101 5 # 偏移量是从0开始，所以要把6减1 # 统计1月份的签到次数 bitcount u:sign:1225:202101 # 获取1月份前31天的签到数据 bitfield u:sign:1225:202101 get u31 0 # 获取1月份首次签到的日期 bitpos u:sign:1225:202101 1 # 返回的首次签到的偏移量，加上1即为当月的某一天
示例代码
using stackexchange.redis;
using system;
using system.collections.generic;
using system.linq;
/**
* 基于redis bitmap的用户签到功能实现类
*
* 实现功能：
* 1. 用户签到
* 2. 检查用户是否签到
* 3. 获取当月签到次数
* 4. 获取当月连续签到次数
* 5. 获取当月首次签到日期
* 6. 获取当月签到情况
*/
public class usersigndemo
{
private idatabase _db;
public usersigndemo(idatabase db)
{
_db = db;
}
/**
* 用户签到
*
* @param uid 用户id
* @param date 日期
* @return 之前的签到状态
*/
public bool dosign(int uid, datetime date)
{
int offset = date.day - 1;
return _db.stringsetbit(buildsignkey(uid, date), offset, true);
}
/**
* 检查用户是否签到
*
* @param uid 用户id
* @param date 日期
* @return 当前的签到状态
*/
public bool checksign(int uid, datetime date)
{
int offset = date.day - 1;
return _db.stringgetbit(buildsignkey(uid, date), offset);
}
/**
* 获取用户签到次数
*
* @param uid 用户id
* @param date 日期
* @return 当前的签到次数
*/
public long getsigncount(int uid, datetime date)
{
return _db.stringbitcount(buildsignkey(uid, date));
}
/**
* 获取当月连续签到次数
*
* @param uid 用户id
* @param date 日期
* @return 当月连续签到次数
*/
public long getcontinuoussigncount(int uid, datetime date)
{
int signcount = 0;
string type = $"u{date.day}"; // 取1号到当天的签到状态
redisresult result = _db.execute("bitfield", (rediskey)buildsignkey(uid, date), "get", type, 0);
if (!result.isnull)
{
var list = (long[])result;
if (list.length > 0)
{
// 取低位连续不为0的个数即为连续签到次数，需考虑当天尚未签到的情况
long v = list[0];
for (int i = 0; i < date.day; i++)
{
if (v >> 1 << 1 == v)
{
// 低位为0且非当天说明连续签到中断了
if (i > 0) break;
}
else
{
signcount += 1;
}
v >>= 1;
}
}
}
return signcount;
}
/**
* 获取当月首次签到日期
*
* @param uid 用户id
* @param date 日期
* @return 首次签到日期
*/
public datetime? getfirstsigndate(int uid, datetime date)
{
long pos = _db.stringbitposition(buildsignkey(uid, date), true);
return pos < 0 ? null : date.adddays(date.day - (int)(pos + 1));
}
/**
* 获取当月签到情况
*
* @param uid 用户id
* @param date 日期
* @return key为签到日期，value为签到状态的map
*/
public dictionary<string, bool> getsigninfo(int uid, datetime date)
{
dictionary<string, bool> signmap = new dictionary<string, bool>(date.day);
string type = $"u{getdayofmonth(date)}";
redisresult result = _db.execute("bitfield", (rediskey)buildsignkey(uid, date), "get", type, 0);
if (!result.isnull)
{
var list = (long[])result;
if (list.length > 0)
{
// 由低位到高位，为0表示未签，为1表示已签
long v = list[0];
for (int i = getdayofmonth(date); i > 0; i--)
{
datetime d = date.adddays(i - date.day);
signmap.add(formatdate(d, "yyyy-mm-dd"), v >> 1 << 1 != v);
v >>= 1;
}
}
}
return signmap;
}
private static string formatdate(datetime date)
{
return formatdate(date, "yyyymm");
}
private static string formatdate(datetime date, string pattern)
{
return date.tostring(pattern);
}
/**
* 构建签到key
*
* @param uid 用户id
* @param date 日期
* @return 签到key
*/
private static string buildsignkey(int uid, datetime date)
{
return $"u:sign:{uid}:{formatdate(date)}";
}
/**
* 获取月份天数
*
* @param date 日期
* @return 天数
*/
private static int getdayofmonth(datetime date)
{
if (date.month == 2)
{
return 28;
}
if (new int[] { 1, 3, 5, 7, 8, 10, 12 }.contains(date.month))
{
return 31;
}
return 30;
}
static void main(string[] args)
{
connectionmultiplexer connection = connectionmultiplexer.connect("192.168.0.104:7001,password=123456");
usersigndemo demo = new usersigndemo(connection.getdatabase());
datetime today = datetime.now;
int uid = 1225;
{ // dosign
bool signed = demo.dosign(uid, today);
if (signed)
{
console.writeline("您已签到：" + formatdate(today, "yyyy-mm-dd"));
}
else
{
console.writeline("签到完成：" + formatdate(today, "yyyy-mm-dd"));
}
}
{ // checksign
bool signed = demo.checksign(uid, today);
if (signed)
{
console.writeline("您已签到：" + formatdate(today, "yyyy-mm-dd"));
}
else
{
console.writeline("尚未签到：" + formatdate(today, "yyyy-mm-dd"));
}
}
{ // getsigncount
long count = demo.getsigncount(uid, today);
console.writeline("本月签到次数：" + count);
}
{ // getcontinuoussigncount
long count = demo.getcontinuoussigncount(uid, today);
console.writeline("连续签到次数：" + count);
}
{ // getfirstsigndate
datetime? date = demo.getfirstsigndate(uid, today);
if (date.hasvalue)
{
console.writeline("本月首次签到：" + formatdate(date.value, "yyyy-mm-dd"));
}
else
{
console.writeline("本月首次签到：无");
}
}
{ // getsigninfo
console.writeline("当月签到情况：");
dictionary<string, bool> signinfo = new dictionary<string, bool>(demo.getsigninfo(uid, today));
foreach (var entry in signinfo)
{
console.writeline(entry.key + ": " + (entry.value ? "√" : "-"));
}
}
}
}
运行结果
更多应用场景
- 统计活跃用户：把日期作为key，把用户id作为offset，1表示当日活跃，0表示当日不活跃。还能使用位计算得到日活、月活、留存率等数据。
- 用户在线状态：跟统计活跃用户一样。
总结
- 位图优点是内存开销小，效率高且操作简单；缺点是位计算和位表示数值的局限。
- 位图适合二元状态的场景，例如用户签到、在线状态等场景。
- string类型最大长度为512m。 注意setbit时的偏移量，当偏移量很大时，可能会有较大耗时。 位图不是绝对的好，有时可能更浪费空间。
- 如果位图很大，建议分拆键。如果要使用bitop，建议读取到客户端再进行位计算。
参考资料
基于redis位图实现用户签到功能
redis 深度历险：核心原理与应用实践
redis：bitmap的setbit,getbit,bitcount,bitop等使用与应用场景
bitfield set command is not working
到此这篇关于redis基于bitmap实现用户签到功能的文章就介绍到这了,更多相关redis bitmap用户签到内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com！