Redis實戰之限制操做頻率

最近沉迷於業務開發沒法自拔 🤣，有一段時間沒有更新博文了，後續博文內容計劃把一些業務場景下的實戰方案，或者比較好的設計思路進行分享，就不像以前圍繞着一個主題，消耗不少的時間去整理相關內容(憋大招)，後續可能一篇的內容量就沒那麼豐富，可是儘量針對一個點進行更細化，或者更深刻的分析，經過不斷分享和自我覆盤，進行經驗的沉澱，同時提升博文分享的頻率 🤙

場景

場景1

留言功能限制，30秒 內只能評論 10次，超出次數不讓能再評論，並提示：過於頻繁
複製代碼

場景2

點贊功能限制，10秒 內只能點贊 10次，超出次數後不能再點贊，並禁止操做 1個小時，提示：過於頻繁，被禁止操做1小時
複製代碼

場景3

上傳記錄功能，限制一天只能上傳 100次，超出次數不讓能再上傳，並提示：超出今日上線
複製代碼

抽離本質

在業務開發的過程當中，咱們不斷的參與各類業務場景的方案設計，每每很容易碰到很相似的場景，只不過當前所屬的業務模塊不同，其實這些需求的本質是解決同一個問題，當遇到這種場景的時候，咱們須要根據本身經驗分析抽離出需求的本質問題，實現一個通用的解決方案，讓本身的解決方案更有價值，這可能就是區別於你是有靈魂的工程師仍是cp（copy paste）最強王者吧。

分析上面3個業務場景，能夠從中發現其中有類似的邏輯，稱它爲同類的問題，如今咱們就是要抽離這個問題，設計一個通用的解決方案，勾畫相同邏輯流程圖：

經過分析上面的需求場景，抽離出他們都須要的那些條件：

• 限制對象：用戶
• 限制操做（評論，點贊，記錄， ...）
• 時間範圍X秒內
• 限制操做數Y次
• 超出後禁止操做時間Z（秒/具體時間）
• 超出後不讓再操做，並提示

（最小時間單位用秒：天/小時/分鐘均可換算成秒，用秒能夠解決更多的場景）

若是把功能抽離成一個通用函數是否是大概是這樣：

<?php
/** * 頻率限制 * @param string $action 操做動做 * @param int $userId 發起操做的用戶ID * @param int $time 時間範圍X秒內 * @param int $number 限制操做數Y次 * @param array $expire 超出封印時間Z ['type'=>1,'ttl'=>過時時間/秒] ['type'=>2,'ttl'=>具體過時時間戳] 二選一 * @return bool * @throws \Exception */
public static function frequencyLimit(string $action, int $userId, int $time, int $number, $expire = []) {
    // todo 根據用戶操做動做時間範圍，進行頻率的控制和失效釋放
}

複製代碼

解決方案落地

功能中須要對用戶發起的操做和時間，以及累計次數進行存儲，而且須要失效過時的清理，若是這個時候咱們依賴mysql作存儲，想一想都覺的挺痛苦，這裏主角：redis 終於登場了，基於redis特性，incr的原子操做和key 支持過時機制，內存存儲的效率優點，能夠相對簡單靈活而且又高效的完成目的。

這裏簡單實現個通用功能的代碼：

<?php
/** * 頻率限制 * @param string $action 操做動做 * @param int $userId 發起操做的用戶ID * @param int $time 時間範圍X秒內 * @param int $number 限制操做數Y次 * @param array $expire 超出封印時間Z ['type'=>1,'ttl'=>過時時間/秒] ['type'=>2,'ttl'=>具體過時時間戳] 二選一 * @return bool * @throws \Exception */
public function frequencyLimit(string $action, int $userId, int $time, int $number, $expire = []) {
    if (empty($action) || $userId <= 0 || $time <= 0 || $number <= 0) {
        throw new \Exception('非法參數');
    }
    $key = 'act:limit:' . $action . ':' . $userId;
    $r = RedisClient::connect();
    //獲取當前累計次數
    $current = intval($r->get($key));
    if ($current >= $number) return false;
    //累計並返回最新值
    $current = $r->incr($key);
    //第一次累加，設置控制操做頻率的有效時間
    if ($current === 1) $r->expire($key, $time);
    //未超出限制次數先放過
    if ($current <= $number) return true;
    //超出後根據須要從新設置過時失效時間 $current === $number 判斷保證只從新設置一次
    $type = empty($expire['type']) ? 0 : intval($expire['type']);
    $ttl = empty($expire['ttl']) ? 0 : intval($expire['ttl']);
    if ($current === $number && $ttl > 0 && in_array($type, [1, 2])) {
        if ($type === 1) $r->expire($key, $ttl);
        if ($type === 2) $r->expireAt($key, $ttl);
    }
    return false;
}
//場景1

/** * 評論限制 * @param int $userId * @return bool|string */
public function doComment(int $userId) {
    try {
        $pass = FrequencyLimit::doHandle('comment', $userId, 30, 10);
        if (!$pass) return '過於頻繁';
        // todo 評論邏輯
        return true;
    } catch (\Exception $e) {
        return $e->getMessage();
    }
}

//場景2
/** * 點贊限制 * @param int $userId * @return bool|string */
public function doLike(int $userId) {
    try {
        $pass = FrequencyLimit::doHandle('like', $userId, 10, 10, ['type' => 1, 'ttl' => 1 * 60 * 60]);
        if (!$pass) return '過於頻繁，被禁止操做1小時';
        // todo 點贊邏輯
        return true;
    } catch (\Exception $e) {
        return $e->getMessage();
    }
}

//場景3

/** * 上傳限制 * @param int $userId * @return bool|string */
public function doUpload(int $userId) {
    try {
        $expire = strtotime(date('Y-m-d', strtotime(+1 . 'days')));
        $pass = FrequencyLimit::doHandle('upload', $userId, 1 * 24 * 60 * 60, 100, ['type' => 2, 'ttl' => $expire]);
        if (!$pass) return '超出今日上線';
        // todo 上傳邏輯
        return true;
    } catch (\Exception $e) {
        return $e->getMessage();
    }
}

//場景N
複製代碼

編碼上能夠根據你設計這個通用方案的複雜度進行進一步抽象，如抽象成頻率限制的功能類 等

總結

• 對類似的業務場景進行分析，發現本質問題並設計通用的解決方案
• 讓解決方案更有價值，作一個有靈魂的開發者
• 熟練掌握redis，充分利用它的特性和優點

---

首發於Github🌈大話WEB開發，歡迎Star 🥰