使用redis位图bitMap 实现签到功能（PHP版本）

需要优化的地方，请各位看官在评论帮忙指出

一、需求

记录用户签到，查询用户签到

二、技术方案

1、使用mysql(max_time字段为连续签到天数)

思路：
（1）用户签到，插入一条记录，根据create_time查询昨日是否签到，有签到则max_time在原基础+1，否则，max_time=0
（2）检测签到，根据user_id、create_time查询记录是否存在，不存在则表示未签到

2、使用redis位图功能

思路：
（1）每个用户每个月单独一条redis记录，如00101010101010，从左往右代表01-31天（每月有几天，就到几天）
（2）每月8号凌晨，统一将redis的记录，搬至mysql，记录如图

（3）查询当月，从redis查，上月则从mysql获取

3、方案对比

举例：一万个用户签到365天
方案1、mysql 插入365万条记录
·　频繁请求数据库做一些日志记录浪费服务器开销。
·  随着时间推移数据急剧增大
·　海量数据检索效率也不高，同时只能用时间create_time作为区间查询条件，数据量大肯定慢

方案2、mysql 插入12w条记录
· 节省空间，每个用户每天只占用1bit空间 1w个用户每天产生10000bit=1050byte 大概为1kb的数据
· 内存操作存度快

三、实现（方案2）

1、key结构

前缀_年份_月份:用户id -- sign_2019_10:01
查询：
单个：keys sign_2019_10_01
全部：keys sign_*
月份:keys sign_2019_10:*

2、mysql表结构

3、代码（列出1个调用方法，与三个类）

（1）签到方法

public static function userSignIn($userId)
    {
        $time = Time();
        $today = date('d', $time);
        $year = date('Y', $time);
        $month = date('m', $time);
        $signModel = new Sign($userId,$year,$month);
        //1、查询用户今日签到信息
        $todaySign = $signModel->getSignLog($today);
        if ($todaySign) {
            return self::jsonArr(-1, '您已经签到过了', []);
        }
        try {
            Db::startTrans();
            $signModel->setSignLog($today);
            //4、赠送积分
            if (self::SING_IN_SCORE > 0) {
                $dataScore['order_id'] = $userId.'_'.$today;
                $dataScore['type'] = 2;//2、签到
                $dataScore['remark'] = '签到获得积分';
                Finance::updateUserScore(Finance::OPT_ADD, $userId, self::SING_IN_SCORE, $dataScore);
            }
            $code = '0';
            $msg = '签到成功';
            $score = self::SING_IN_SCORE;
            Db::commit();
        } catch (\Exception $e) {
            Db::rollback();
            $code = '-2';
            $msg = '签到失败';
            $score = 0;
        }
        return self::jsonArr($code, $msg, ['score' => $score]);
    }

（2）redis基类

<?php

namespace app\common\redis\db1;

/**
 * redis操作类
 */
class RedisAbstract
{

    /**
     * 连接的库
     * @var int
     */
    protected $_db = 1;//数据库名
    protected $_tableName = '';//表名

    static $redis = null;

    public function __construct()
    {
        return $this->getRedis();
    }

    public function _calcKey($id)
    {
        return $this->_tableName . $id;
    }

    /**
     * 查找key
     * @param $key
     * @return array
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function keys($key)
    {
        return $this->getRedis()->keys($this->_calcKey($key));
    }

    /**
     * 获取是否开启缓存的设置参数
     *
     * @return boolean
     */
    public function _getEnable()
    {
        $conf = Config('redis');
        return $conf['enable'];
    }

    /**
     * 获取redis连接
     *
     * @staticvar null $redis
     * @return \Redis
     * @throws \Exception
     */
    public function getRedis()
    {
        if (!self::$redis) {
            $conf = Config('redis');
            if (!$conf) {
                throw new \Exception('redis连接必须设置');
            }

            self::$redis = new \Redis();
            self::$redis->connect($conf['host'], $conf['port']);
            self::$redis->select($this->_db);
        }
        return self::$redis;
    }

    /**
     * 设置位图
     * @param $key
     * @param $offset
     * @param $value
     * @param int $time
     * @return int|null
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function setBit($key, $offset, $value, $time = 0)
    {
        if (!$this->_getEnable()) {
            return null;
        }
        $result = $this->getRedis()->setBit($key, $offset, $value);
        if ($time) {
            $this->getRedis()->expire($key, $time);
        }
        return $result;
    }

    /**
     * 获取位图
     * @param $key
     * @param $offset
     * @return int|null
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function getBit($key, $offset)
    {
        if (!$this->_getEnable()) {
            return null;
        }
        return $this->getRedis()->getBit($key, $offset);
    }

    /**
     * 统计位图
     * @param $key
     * @return int|null
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function bitCount($key)
    {
        if (!$this->_getEnable()) {
            return null;
        }
        return $this->getRedis()->bitCount($key);
    }

    /**
     * 位图操作
     * @param $operation
     * @param $retKey
     * @param mixed ...$key
     * @return int|null
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function bitOp($operation, $retKey, ...$key)
    {
        if (!$this->_getEnable()) {
            return null;
        }
        return $this->getRedis()->bitOp($operation, $retKey, $key);
    }

    /**
     * 计算在某段位图中 1或0第一次出现的位置
     * @param $key
     * @param $bit 1/0
     * @param $start
     * @param null $end
     * @return int|null
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function bitPos($key, $bit, $start, $end = null)
    {
        if (!$this->_getEnable()) {
            return null;
        }
        return $this->getRedis()->bitpos($key, $bit, $start, $end);
    }

    /**
     * 删除数据
     * @param $key
     * @return int|null
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function del($key)
    {
        if (!$this->_getEnable()) {
            return null;
        }
        return $this->getRedis()->del($key);
    }

}

（3）签到redis操作类

<?php
/**
 * Created by PhpStorm.
 * User: Administrator
 * Date: 2019/9/30
 * Time: 14:42
 */

namespace app\common\redis\db1;


class Sign extends RedisAbstract
{
    public $keySign = 'sign';//签到记录key

    public function __construct($userId,$year,$month)
    {
        parent::__construct();
        //设置当前用户 签到记录的key
        $this->keySign = $this->keySign . '_' . $year . '_' . $month . ':' . $userId;
    }

    /**
     * 用户签到
     * @param $day
     * @return int|null
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function setSignLog($day)
    {
        return $this->setBit($this->keySign, $day, 1);
    }

    /**
     * 查询签到记录
     * @param $day
     * @return int|null
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function getSignLog($userId,$day)
    {
        return $this->getBit($this->keySign, $day);
    }

    /**
     * 删除签到记录
     * @return int|null
     * @throws \Exception
     * @author wenzhen-chen
     */
    public function delSignLig()
    {
        return $this->del($this->keySign);
    }
}

（4） 定时更新至mysql的类

<?php
/**
 * Created by PhpStorm.
 * User: Administrator
 * Date: 2019/10/4
 * Time: 19:03
 */

namespace app\common\business;

use app\common\mysql\SignLog;
use app\common\redis\db1\Sign;

class Cron
{
    /**
     * 同步用户签到记录
     * @throws \Exception
     */
    public static function addUserSignLogToMysql()
    {
        $data = [];
        $time = Time();
        //1、计算上月的年份、月份
        $dataTime = Common::getMonthTimeByKey(0);
        $year = date('Y', $dataTime['start_time']);
        $month = date('m', $dataTime['start_time']);
        //2、查询签到记录的key
        $signModel = new Sign(0, $year, $month);
        $keys = $signModel->keys('sign_' . $year . '_' . $month . ':*');
        foreach ($keys as $key) {
            $bitLog = '';//用户当月签到记录
            $userData = explode(':', $key);
            $userId = $userData[1];
            //3、循环查询用户是否签到（这里没按每月天数存储，直接都存31天了）
            for ($i = 1; $i <= 31; $i++) {
                $isSign = $signModel->getBit($key, $i);
                $bitLog .= $isSign;
            }
            $data[] = [
                'user_id' => $userId,
                'year' => $year,
                'month' => $month,
                'bit_log' => $bitLog,
                'create_time' => $time,
                'update_time' => $time
            ];
        }
        //4、插入日志
        if ($data) {
            $logModel = new SignLog();
            $logModel->insertAll($data, '', 100);
        }

    }
}