redis自2.8.0之後版本提供Keyspace Notifications功能,允許客戶訂閱Pub / Sub頻道,以便以某種方式接收影響Redis數據集的事件。
可能收到的事件的例子如下:
所有影響給定鍵的命令。
所有接收LPUSH操作的密鑰。
所有密鑰在數據庫中過期0。
因爲 Redis 目前的訂閱與發佈功能採取的是發送即忘(fire and forget)策略, 所以如果你的程序需要可靠事件通知(reliable notification of events), 那麼目前的鍵空間通知可能並不適合你:當訂閱事件的客戶端斷線時, 它會丟失所有在斷線期間分發給它的事件。並不能確保消息送達。未來有計劃允許更可靠的事件傳遞,但可能這將在更一般的層面上解決,或者爲Pub / Sub本身帶來可靠性,或者允許Lua腳本攔截Pub / Sub消息來執行諸如推送將事件列入清單。
事件類型
對於每個修改數據庫的操作,鍵空間通知都會發送兩種不同類型的事件消息:keyspace 和 keyevent。以 keyspace 爲前綴的頻道被稱爲鍵空間通知(key-space notification), 而以 keyevent 爲前綴的頻道則被稱爲鍵事件通知(key-event notification)。
事件是用 __keyspace@DB__:KeyPattern 或者 __keyevent@DB__:OpsType 的格式來發布消息的。
DB表示在第幾個庫;KeyPattern則是表示需要監控的鍵模式(可以用通配符,如:__key*__:*);OpsType則表示操作類型。因此,如果想要訂閱特殊的Key上的事件,應該是訂閱keyspace。
比如說,對 0 號數據庫的鍵 mykey 執行 DEL 命令時, 系統將分發兩條消息, 相當於執行以下兩個 PUBLISH 命令:
PUBLISH __keyspace@0__:sampleKey del
PUBLISH __keyevent@0__:del sampleKey
訂閱第一個頻道 __keyspace@0__:mykey 可以接收 0 號數據庫中所有修改鍵 mykey 的事件, 而訂閱第二個頻道 __keyevent@0__:del 則可以接收 0 號數據庫中所有執行 del 命令的鍵。
開啓配置
鍵空間通知通常是不啓用的,因爲這個過程會產生額外消耗。所以在使用該特性之前,請確認一定是要用這個特性的,然後修改配置文件,或使用config配置。相關配置項如下:
字符 | 發送通知 |
---|---|
K | 鍵空間通知,所有通知以 keyspace@ 爲前綴,針對Key |
E | 鍵事件通知,所有通知以 keyevent@ 爲前綴,針對event |
g | DEL 、 EXPIRE 、 RENAME 等類型無關的通用命令的通知 |
$ | 字符串命令的通知 |
l | 列表命令的通知 |
s | 集合命令的通知 |
h | 哈希命令的通知 |
z | 有序集合命令的通知 |
x | 過期事件:每當有過期鍵被刪除時發送 |
e | 驅逐(evict)事件:每當有鍵因爲 maxmemory 政策而被刪除時發送 |
A | 參數 g$lshzxe 的別名,相當於是All |
輸入的參數中至少要有一個 K 或者 E , 否則的話, 不管其餘的參數是什麼, 都不會有任何通知被分發。上表中斜體的部分爲通用的操作或者事件,而黑體則表示特定數據類型的操作。配置文件中修改 notify-keyspace-events “Kx”,注意:這個雙引號是一定要的,否則配置不成功,啓動也不報錯。例如,“Kx”表示想監控某個Key的失效事件。
也可以通過config配置:CONFIG set notify-keyspace-events Ex (但非持久化)
Redis 使用以下兩種方式刪除過期的鍵:
1.當一個鍵被訪問時,程序會對這個鍵進行檢查,如果鍵已經過期,那麼該鍵將被刪除。
2.底層系統會在後臺查找並刪除那些過期的鍵,從而處理那些已經過期、但是不會被訪問到的鍵。
當過期鍵被以上兩個程序的任意一個發現、 並且將鍵從數據庫中刪除時, Redis 會產生一個 expired 通知。
Redis 並不保證生存時間(TTL)變爲 0 的鍵會立即被刪除: 如果程序沒有訪問這個過期鍵, 或者帶有生存時間的鍵非常多的話, 那麼在鍵的生存時間變爲 0 , 直到鍵真正被刪除這中間, 可能會有一段比較顯著的時間間隔。
因此, Redis 產生 expired 通知的時間爲過期鍵被刪除的時候, 而不是鍵的生存時間變爲 0 的時候。
由於通知收到的是redis key,value已經過期,無法收到,所以需要在key上標記業務數據。
實現步驟:
1.修改配置:鍵空間通知功能耗費CPU,默認關閉,需要修改配置文件redis.conf或 操作CONFIG SET命令,設置notify-keyspace-events選項,來啓用或關閉該功能。
2.對Redis實例進行發佈訂閱,指定監聽類和監聽事件類型
3.監聽類繼承JedisPubSub,實現相應操作;
4.客戶端進行操作,以觸發訂閱事件發生。
代碼實例
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.6.2</version>
</dependency>
配置和訂閱
package cn.slimsmart.redis.demo.nofity;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
import redis.clients.jedis.JedisPubSub;
import java.util.List;
public class notifyTest {
public static void main(String[] args) {
JedisPool pool = new JedisPool(new JedisPoolConfig(), "127.0.0.1");
Jedis jedis = pool.getResource();
config(jedis);//建議在redis配置文件中設置
jedis.psubscribe(new KeyExpiredListener(), "__keyevent@0__:expired");//過期隊列
}
private static void config(Jedis jedis){
String parameter = "notify-keyspace-events";
List<String> notify = jedis.configGet(parameter);
if(notify.get(1).equals("")){
jedis.configSet(parameter, "Ex"); //過期事件
}
}
}
class KeyExpiredListener extends JedisPubSub {
@Override
public void onPSubscribe(String pattern, int subscribedChannels) {
System.out.println("onPSubscribe " + pattern + " " + subscribedChannels);
}
@Override
public void onPMessage(String pattern, String channel, String message) {
System.out.println(
"pattern = [" + pattern + "], channel = [" + channel + "], message = [" + message + "]");
//收到消息 key的鍵值,處理過期提醒
}
}
設置過期消息
package cn.slimsmart.redis.demo.nofity;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
public class TestJedis {
public static void main(String[] args) {
JedisPool pool = new JedisPool(new JedisPoolConfig(), "127.0.0.1");
Jedis jedis = pool.getResource();
jedis.setex("notify-task-001", 10,"empty");
}
}