SpringBoot如何監聽redis Key變化事件案例詳解

2022-08-04 18:01:46

一、功能概覽

鍵空間通知使得使用者端可以通過訂閱頻道或模式，來接收那些以某種方式改動了 Redis key變化的事件。

所有修改key鍵的命令。

所有接收到 LPUSH key value [value …] 命令的鍵。

db資料庫中所有已過期的鍵。

事件通過 Redis 的訂閱與釋出功能（pub/sub）來進行分發，因此所有支援訂閱與釋出功能的使用者端都可以在無須做任何修改的情況下，直接使用鍵空間通知功能。

因為 Redis 目前的訂閱與釋出功能採取的是傳送即忘（fire and forget）策略，所以如果你的程式需要可靠事件通知（reliable notification of events），那麼目前的鍵空間通知可能並不適合你：當訂閱事件的使用者端斷線時，它會丟失所有在斷線期間分發給它的事件。

未來將會支援更可靠的事件分發，這種支援可能會通過讓訂閱與釋出功能本身變得更可靠來實現，也可能會在 Lua 指令碼中對訊息（message）的訂閱與釋出進行監聽，從而實現類似將事件推入到列表這樣的操作。

二、事件型別

對於每個修改資料庫的操作，鍵空間通知都會傳送兩種不同型別的事件。

比如說，對 0 號資料庫的鍵 mykey 執行 DEL key [key …]命令時，系統將分發兩條訊息，相當於執行以下兩個 PUBLISH channel message 命令：

PUBLISH __keyspace@0__:mykey del
PUBLISH __keyevent@0__:del mykey

訂閱第一個頻道 __keyspace@0__:mykey 可以接收 0 號資料庫中所有修改鍵 mykey 的事件，而訂閱第二個頻道 __keyevent@0__:del則可以接收 0 號資料庫中所有執行 del 命令的鍵。

以 keyspace 為字首的頻道被稱為鍵空間通知（key-space notification），而以 keyevent 為字首的頻道則被稱為鍵事件通知（key-event notification）。

當 del mykey 命令執行時:

鍵空間頻道的訂閱者將接收到被執行的事件的名字，在這個例子中，就是 del 。
鍵事件頻道的訂閱者將接收到被執行事件的鍵的名字，在這個例子中，就是 mykey 。

三、設定

因為開啟鍵空間通知功能需要消耗一些 CPU ，所以在預設設定下，該功能處於關閉狀態。

可以通過修改 redis.conf 檔案，或者直接使用 CONFIG SET 命令來開啟或關閉鍵空間通知功能：

當 notify-keyspace-events 選項的引數為空字串時，功能關閉。

另一方面，當引數不是空字串時，功能開啟。

notify-keyspace-events 的引數可以是以下字元的任意組合，它指定了伺服器該傳送哪些型別的通知：

輸入的引數中至少要有一個 K或者 E ，否則的話，不管其餘的引數是什麼，都不會有任何通知被分發。

舉個例子，如果只想訂閱鍵空間中和列表相關的通知，那麼引數就應該設為 Kl ，諸如此類。

將引數設為字串"AKE" 表示傳送所有型別的通知。

每當一個鍵因為過期而被刪除時，產生一個 expired 通知。

每當一個鍵因為maxmemory政策而被刪除以回收記憶體時，產生一個 evicted 通知。

所有命令都只在鍵真的被改動了之後，才會產生通知。

比如說，當 SREM key member [member …]試圖刪除不存在於集合的元素時，刪除操作會執行失敗，因為沒有真正的改動鍵，所以這一操作不會傳送通知。

如果對命令所產生的通知有疑問，最好還是使用以下命令，自己來驗證一下：

Redis 使用以下兩種方式刪除過期的鍵：

當一個鍵被存取時，程式會對這個鍵進行檢查，如果鍵已經過期，那麼該鍵將被刪除。

底層系統會在後臺漸進地查詢並刪除那些過期的鍵，從而處理那些已經過期、但是不會被存取到的鍵。
當過期鍵被以上兩個程式的任意一個發現、並且將鍵從資料庫中刪除時， Redis 會產生一個 expired 通知。

Redis 並不保證生存時間（TTL）變為 0 的鍵會立即被刪除：如果程式沒有存取這個過期鍵，或者帶有生存時間的鍵非常多的話，那麼在鍵的生存時間變為 0 ，直到鍵真正被刪除這中間，可能會有一段比較顯著的時間間隔。

因此， Redis 產生expired通知的時間為過期鍵被刪除的時候，而不是鍵的生存時間變為 0 的時候。

三、案例

按上文內容，我們先將redis的鍵空間通知開啟,我們開啟所有的通知，在可以端中測試後沒問題再到程式碼中測試。

連線到redis 輸入一下命令

config set notify-keyspace-events KEA

訂閱鍵空間和鍵事件的主題

psubscribe '__key*__:*'#對所有庫鍵空間通知
 
psubscribe '__keyspace@2__:*' #是對db2資料庫鍵空間通知
 
psubscribe '__keyspace@2__:order*' #是對db2資料庫，key字首為order所有鍵的鍵空間通知

建立一個 key :name valus:zhangsan

set name wsl

觀察訂閱的視窗會受到兩個訊息，第一個是：鍵空間第二個是鍵事件，鍵空間是內容是操作指令，主題中包含有key，鍵事件主題中包含了指令，內容是key。

到這裡說明已經開啟了鍵空間通知

程式碼

以下程式碼採用string型別演示

在設定一下MessageListenerContainer類，將我們寫好的監聽類新增到該類中即可,刪除和過期都是需要新增，我這裡就一起新增了後面就不做演示。

@Configuration
public class RedisConfig {
 
    @Autowired
    private RedisTemplate redisTemplate;
 
    @Autowired
    private RedisUpdateAndAddListener redisUpdateAndAddListener;
 
    @Autowired
    private RedisDeleteListener redisDeleteListener;
 
    @Autowired
    private RedisExpiredListener redisExpiredListener;
 
    @Bean
    RedisMessageListenerContainer container(RedisConnectionFactory connectionFactory) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(connectionFactory);
        //監聽所有的key的set事件
        container.addMessageListener(redisUpdateAndAddListener, redisUpdateAndAddListener.getTopic());
        //監聽所有key的刪除事件
        container.addMessageListener(redisDeleteListener,redisDeleteListener.getTopic());
        //監聽所有key的過期事件
        container.addMessageListener(redisExpiredListener,redisExpiredListener.getTopic());
        return container;
    }
 
 
}

新增和修改都是set指令

所以監聽的主題都一樣,實現MessageListener介面，重寫onMessage這裡就是收到訊息的處理邏輯

@Component
@Data
public class RedisUpdateAndAddListener implements MessageListener {
	//監聽的主題
    private  final PatternTopic topic = new PatternTopic("__keyevent@*__:set");
 
    @Override
    public void onMessage(Message message,byte[] pattern){
        String topic = new String(pattern);
        String msg = new String(message.getBody());
        System.out.println("收到key更新或修改，訊息主題是："+ topic+",訊息內容是："+msg);
    }
 
}

在redis中對name這個key進行set操作

set name wsl

在控制檯就可以看到name這個key被操作了

刪除

跟上面的更新監聽一樣，只需要把訂閱主題更改一下即可。同樣需要新增到這個RedisMessageListenerContainer，上面已經新增，這裡不做演示

@Component
@Data
public class RedisDeleteListener implements MessageListener {
 
    //監聽主題
    private  final PatternTopic topic = new PatternTopic("__keyevent@*__:del");
 
    /**
     *
     * @param message 訊息
     * @param pattern 主題
     */
    @Override
    public void onMessage(Message message, byte[] pattern) {
        String topic = new String(pattern);
        String msg = new String(message.getBody());
        System.out.println("收到key的刪除，訊息主題是："+ topic+",訊息內容是："+msg);
    }
}

在redis輸入命令，del name 在控制檯可以看到已經收到訊息了。

過期

如上面的操作方式一樣

@Data
@Component
public class RedisExpiredListener implements MessageListener {
 
    //監聽主題
    private  final PatternTopic topic = new PatternTopic("__keyevent@*__:expired");
 
    @Override
    public void onMessage(Message message, byte[] pattern) {
        String topic = new String(pattern);
        String msg = new String(message.getBody());
        System.out.println("收到key的過期，訊息主題是："+ topic+",訊息內容是："+msg);
    }
}

在redis中寫一個定時刪除的keySETEX age 18 3三秒後就可以控制檯列印了相關資訊