鍵空間通知（keyspace notification）

一 、功能概覽

鍵空間通知使得客戶端可以通過(guò)訂閱頻道或模式， 來(lái)接收那些以某種方式改動(dòng)了 Redis key變化的事件。

所有修改key鍵的命令。

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

db數(shù)據(jù)庫(kù)中所有已過(guò)期的鍵。

事件通過(guò) Redis 的訂閱與發(fā)布功能（pub/sub）來(lái)進(jìn)行分發(fā)， 因此所有支持訂閱與發(fā)布功能的客戶端都可以在無(wú)須做任何修改的情況下， 直接使用鍵空間通知功能。

因?yàn)?Redis 目前的訂閱與發(fā)布功能采取的是發(fā)送即忘（fire and forget）策略， 所以如果你的程序需要可靠事件通知（reliable notification of events）， 那么目前的鍵空間通知可能并不適合你： 當(dāng)訂閱事件的客戶端斷線時(shí)， 它會(huì)丟失所有在斷線期間分發(fā)給它的事件。

未來(lái)將會(huì)支持更可靠的事件分發(fā)， 這種支持可能會(huì)通過(guò)讓訂閱與發(fā)布功能本身變得更可靠來(lái)實(shí)現(xiàn)， 也可能會(huì)在 Lua 腳本中對(duì)消息（message）的訂閱與發(fā)布進(jìn)行監(jiān)聽(tīng)， 從而實(shí)現(xiàn)類(lèi)似將事件推入到列表這樣的操作。

二、事件類(lèi)型

對(duì)于每個(gè)修改數(shù)據(jù)庫(kù)的操作，鍵空間通知都會(huì)發(fā)送兩種不同類(lèi)型的事件。

比如說(shuō)，對(duì) 0 號(hào)數(shù)據(jù)庫(kù)的鍵 mykey 執(zhí)行 DEL key [key …]命令時(shí)， 系統(tǒng)將分發(fā)兩條消息， 相當(dāng)于執(zhí)行以下兩個(gè) PUBLISH channel message 命令：

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

訂閱第一個(gè)頻道 __keyspace@0__:mykey 可以接收 0 號(hào)數(shù)據(jù)庫(kù)中所有修改鍵 mykey 的事件， 而訂閱第二個(gè)頻道 __keyevent@0__:del則可以接收 0 號(hào)數(shù)據(jù)庫(kù)中所有執(zhí)行 del 命令的鍵。

以 keyspace 為前綴的頻道被稱(chēng)為鍵空間通知（key-space notification）， 而以 keyevent 為前綴的頻道則被稱(chēng)為鍵事件通知（key-event notification）。

當(dāng) del mykey 命令執(zhí)行時(shí):

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

三、配置

因?yàn)殚_(kāi)啟鍵空間通知功能需要消耗一些 CPU ， 所以在默認(rèn)配置下， 該功能處于關(guān)閉狀態(tài)。

可以通過(guò)修改 redis.conf 文件， 或者直接使用 CONFIG SET 命令來(lái)開(kāi)啟或關(guān)閉鍵空間通知功能：

當(dāng) notify-keyspace-events 選項(xiàng)的參數(shù)為空字符串時(shí)，功能關(guān)閉。

另一方面，當(dāng)參數(shù)不是空字符串時(shí)，功能開(kāi)啟。

notify-keyspace-events 的參數(shù)可以是以下字符的任意組合， 它指定了服務(wù)器該發(fā)送哪些類(lèi)型的通知：

輸入的參數(shù)中至少要有一個(gè) K或者 E ， 否則的話， 不管其余的參數(shù)是什么， 都不會(huì)有任何通知被分發(fā)。

舉個(gè)例子， 如果只想訂閱鍵空間中和列表相關(guān)的通知， 那么參數(shù)就應(yīng)該設(shè)為 Kl ， 諸如此類(lèi)。

將參數(shù)設(shè)為字符串"AKE" 表示發(fā)送所有類(lèi)型的通知。

每當(dāng)一個(gè)鍵因?yàn)檫^(guò)期而被刪除時(shí)，產(chǎn)生一個(gè) expired 通知。

每當(dāng)一個(gè)鍵因?yàn)?code>maxmemory政策而被刪除以回收內(nèi)存時(shí)，產(chǎn)生一個(gè) evicted 通知。

所有命令都只在鍵真的被改動(dòng)了之后，才會(huì)產(chǎn)生通知。

比如說(shuō)，當(dāng) SREM key member [member …]試圖刪除不存在于集合的元素時(shí)，刪除操作會(huì)執(zhí)行失敗，因?yàn)闆](méi)有真正的改動(dòng)鍵，所以這一操作不會(huì)發(fā)送通知。

如果對(duì)命令所產(chǎn)生的通知有疑問(wèn)， 最好還是使用以下命令， 自己來(lái)驗(yàn)證一下：

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

當(dāng)一個(gè)鍵被訪問(wèn)時(shí)，程序會(huì)對(duì)這個(gè)鍵進(jìn)行檢查，如果鍵已經(jīng)過(guò)期，那么該鍵將被刪除。

底層系統(tǒng)會(huì)在后臺(tái)漸進(jìn)地查找并刪除那些過(guò)期的鍵，從而處理那些已經(jīng)過(guò)期、但是不會(huì)被訪問(wèn)到的鍵。
當(dāng)過(guò)期鍵被以上兩個(gè)程序的任意一個(gè)發(fā)現(xiàn)、 并且將鍵從數(shù)據(jù)庫(kù)中刪除時(shí)， Redis 會(huì)產(chǎn)生一個(gè) expired 通知。

Redis 并不保證生存時(shí)間（TTL）變?yōu)?0 的鍵會(huì)立即被刪除： 如果程序沒(méi)有訪問(wèn)這個(gè)過(guò)期鍵， 或者帶有生存時(shí)間的鍵非常多的話， 那么在鍵的生存時(shí)間變?yōu)?0 ， 直到鍵真正被刪除這中間， 可能會(huì)有一段比較顯著的時(shí)間間隔。

因此， Redis 產(chǎn)生expired通知的時(shí)間為過(guò)期鍵被刪除的時(shí)候， 而不是鍵的生存時(shí)間變?yōu)?0 的時(shí)候。

三、案例

按上文內(nèi)容，我們先將redis的鍵空間通知開(kāi)啟,我們開(kāi)啟所有的通知，在可以端中測(cè)試后沒(méi)問(wèn)題再到代碼中測(cè)試。

連接到redis 輸入一下命令

config set notify-keyspace-events KEA

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

psubscribe '__key*__:*'#對(duì)所有庫(kù)鍵空間通知
 
psubscribe '__keyspace@2__:*' #是對(duì)db2數(shù)據(jù)庫(kù)鍵空間通知
 
psubscribe '__keyspace@2__:order*' #是對(duì)db2數(shù)據(jù)庫(kù)，key前綴為order所有鍵的鍵空間通知

創(chuàng)建一個(gè) key :name valus:zhangsan

set name wsl

觀察訂閱的窗口 會(huì)受到兩個(gè)消息，第一個(gè)是：鍵空間 第二個(gè)是鍵事件，鍵空間是內(nèi)容是操作指令，主題中包含有key，鍵事件主題中包含了指令，內(nèi)容是key。

到這里說(shuō)明已經(jīng)開(kāi)啟了鍵空間通知

代碼

以下代碼采用string類(lèi)型演示

在配置一下MessageListenerContainer類(lèi)，將我們寫(xiě)好的監(jiān)聽(tīng)類(lèi)添加到該類(lèi)中即可,刪除和過(guò)期都是需要添加，我這里就一起添加了后面就不做演示。

@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);
        //監(jiān)聽(tīng)所有的key的set事件
        container.addMessageListener(redisUpdateAndAddListener, redisUpdateAndAddListener.getTopic());
        //監(jiān)聽(tīng)所有key的刪除事件
        container.addMessageListener(redisDeleteListener,redisDeleteListener.getTopic());
        //監(jiān)聽(tīng)所有key的過(guò)期事件
        container.addMessageListener(redisExpiredListener,redisExpiredListener.getTopic());
        return container;
    }
 
 
}

新增和修改都是set指令

所以監(jiān)聽(tīng)的主題都一樣,實(shí)現(xiàn)MessageListener接口，重寫(xiě)onMessage這里就是收到消息的處理邏輯

@Component
@Data
public class RedisUpdateAndAddListener implements MessageListener {
	//監(jiān)聽(tīng)的主題
    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+",消息內(nèi)容是："+msg);
    }
 
}

在redis中對(duì)name這個(gè)key進(jìn)行set操作

set name wsl

在控制臺(tái)就可以看到name這個(gè)key被操作了

刪除

跟上面的更新監(jiān)聽(tīng)一樣，只需要把訂閱主題更改一下即可。同樣需要添加到這個(gè)RedisMessageListenerContainer，上面已經(jīng)添加，這里不做演示

@Component
@Data
public class RedisDeleteListener implements MessageListener {
 
    //監(jiān)聽(tīng)主題
    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+",消息內(nèi)容是："+msg);
    }
}

 在redis輸入命令，del name 在控制臺(tái)可以看到已經(jīng)收到消息了。

過(guò)期

如上面的操作方式一樣

@Data
@Component
public class RedisExpiredListener implements MessageListener {
 
    //監(jiān)聽(tīng)主題
    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的過(guò)期，消息主題是："+ topic+",消息內(nèi)容是："+msg);
    }
}

 在redis中寫(xiě)一個(gè)定時(shí)刪除的keySETEX age 18 3三秒后就可以控制臺(tái)打印了相關(guān)信息

總結(jié)

到此這篇關(guān)于SpringBoot如何監(jiān)聽(tīng)redis Key變化事件案例的文章就介紹到這了,更多相關(guān)SpringBoot監(jiān)聽(tīng)redis Key變化事件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論