手把手教你玩兒一下 Redis Module 之模塊解讀

引子

Redis 如今的 Stable 版本是4.0.11, 對Redis比較關注的童鞋都知道,4.0引入了 Module 。 咱們先一塊兒看看 Redis 4.0都更新了啥?

---

官方說法

Redis 4.0 was released as GA in July 2017. Contains several big improvements: a modules system, much better replication (PSYNC2), improvements to eviction policies, threaded DEL/FLUSH, mixed RDB+AOF format, Raspberry Pi support as primary platform, the new MEMORY command, Redis Cluster support for Nat/Docker, active memory defragmentation, memory usage and performance improvements, much faster Redis Cluster key creation, many other smaller features and a number of behavior fixed.

簡單總結一下:

1. 自定義擴展 redis 的模塊, 固然相比 redis lua 腳原本說，仍是有些學習成本的…

2. psync2 他的好處在於 redis 主從切換後，不須要從新進行 從新 fullsync 同步，只須要部分同步，有點相似 binlog 那種. 具體實現還沒看，阿里本身是經過 timestamp 時間戳實現的.

3. memory 指令能夠估算內容大小

4. 非數據命令的異步執行，咱們知道 redis 處理請求是單線程的，執行數據偏大的 flush 及 del 會阻塞的，redis 4.0 加了異步操做的功能….

多圖預告

我們今天就玩兒一下 Redis Module

模塊能夠作什麼

1. 站在巨人的肩膀上 (訪問 Redis 數據空間)

**官方模塊教程 redis.io/topics/modu… **

Redis 提供了兩套數據訪問的 API，一套是較高層的，相似於 Lua 腳本的 API，每每用來調用 API 沒有提供支持的 Redis 命令。 另外一套是底層 API，速度很快，基本和 Redis 原生命令同樣快，也提供了一些對各類數據結構的進行處理的函數，是推薦的數據訪問方式。

高層 API 使用RedisModule_Call調用 Redis 命令，如：

RedisModuleCallReply *reply;
reply = RedisModule_Call(ctx,"INCR","sc",argv[1],"10");
複製代碼

底層 API 使用RedisModule_OpenKey打開並獲取 Key 指針繼而進行後續處理，如：

RedisModuleKey *key;
key = RedisModule_OpenKey(ctx,"somekey",REDISMODULE_READ);
複製代碼

2. 走的更遠 (實現新的數據結構)

對於簡單的數據結構，可使用 DMA(direct memory access) 將結構編碼保存到 Redis 的 String 類型中，如：

// 獲取字符串內存指針繼而修改其內容
size_t len;
char *myptr = RedisModule_StringDMA(key,&len,REDISMODULE_WRITE);
//  增大，減小或建立字符串
RedisModule_StringTruncate(key,1024);
複製代碼

也可使用 API 註冊並實現新的數據結構，能夠控制內存的分配與釋放，RDB 序列化，AOF 重寫等。這裏是 Redis 官方的一個例子，好奇的同窗能夠本身點進去看看。

3. 靈活拓展 (實現阻塞命令)

阻塞命令（Blocking commands）會阻塞客戶端，直到某個指望的事件發生纔會返回，好比 List 的BLPOP命令。模塊 API 也提供了實現阻塞命令的功能。 Redis 在內置命令集中有一些阻塞命令。其中最經常使用的是 BLPOP（或對稱 BRPOP），它阻止等待到達列表的元素。 關於阻塞命令的有趣事實是它們不會阻塞整個服務器，而只是阻塞它們的客戶端。一般阻塞的緣由是咱們指望發生一些外部事件：這多是 Redis 數據結構中的一些變化，例如 BLPOP 狀況，線程中發生的長計算，從網絡接收一些數據，等等。

詳細見文檔: redis.io/topics/modu…

4. 自由發揮 (加載模塊)

模塊有兩種加載方式，一是在配置文件redis.conf中使用 loadmodule /path/to/mymodule.so 在 Redis 啓動時加載。

查看加載的模塊:

另外一種方式在運行時使用命令 MODULE LOAD /path/to/panda.so 加載。

使用MODULE UNLOAD panda卸載。

在載入的模塊的時候能夠傳入參數，如：loadmodule panda.so hello panda 1234， 參數會被傳入模塊的OnLoad方法中。

5. 人多力量大 (對 Redis Cluster 的支持)

官方文檔提供了兩個API

RedisModule_IsKeysPositionRequest(ctx);
RedisModule_KeyAtPos(ctx,pos);
複製代碼

在首次RedisModule_CreateCommand() 時須要 調用API方法

int RedisModule_CreateCommand(RedisModuleCtx *ctx, const char *name, RedisModuleCmdFunc cmdfunc, const char *strflags, int firstkey, int lastkey, int keystep);
複製代碼

其中的strflags參數的一個 flag 爲getkeys-api，意思是這個方法是否支持返回參數中 key。一個方法接收的參數有多個，但並非每個都是 key，好比LRANGE key start stop中，只有第一個參數是 key。而 Redis 須要知道一個命令涉及到哪些 key，才能在集羣中找到對應的服務器並執行命令。

能夠參考這個模塊的代碼 github.com/RedisLabsMo…

官方模塊倉庫 (Redis Module Hub)

官方模塊倉庫收錄不少優質的模塊:

新數據結構，如：

rejson 提供了對原生 JSON 格式支持，容許對 JSON 數據內的值進行獲取與修改

Redis Graph 添加了對圖數據庫的支持 等等

對現有數據結構功能的擴展，如：

rxkeys 提供了按正則表達式批量獲取與刪除條目的功能 rxhashes 提供了在 Hash 中改變現有條目的值並返回原值的原子操作 rxlists 提供了 7 個新的列表操做方法。

百聞不如一run

寫了一個很是簡單的Redis Module 用於學習

redis-module-panda

A simple redis module , Just for fun

Inspire And Thanks

redis.io/topics/modu… redislabs.com/community/r… github.com/erans/redis… github.com/dayeshisir/…

安裝

1. 克隆代碼

git clone https://github.com/wujunze/redis-module-panda.git
複製代碼

2. make

make
複製代碼

3. 加載模塊

redis 的版本必須大於4.0

查看已經安裝的模塊

加載模塊

Run

127.0.0.1:6379> panda.hello
複製代碼

測試命令

卸載模塊

完整的測試過程

** 代碼倉庫: github.com/wujunze/red… **

以爲有收穫請star哦, 還有下集,Thanks

Inspire And Thanks

redis.io/topics/modu…

redislabs.com/community/r…

liangshuang.name/2017/08/19/…

github.com/erans/redis…

github.com/dayeshisir/…

筆者才疏學淺,倉促成文,若有不當之處,還請你們斧正.