nodeJs封裝redis-lua腳本方案

一馒稍、先啰嗦幾句

redis從2.6版本集成對(duì)lua腳本的支持,所以運(yùn)用redis時(shí)滥比,一些復(fù)雜的場(chǎng)景可以考慮通過(guò)lua腳本來(lái)處理牙咏,一段lua腳本在執(zhí)行期具有原子性臼隔, 因此可以避免多服務(wù)或者并發(fā)的很多問(wèn)題,例如一個(gè)杜撰的場(chǎng)景:

設(shè)計(jì)一個(gè)搶紅包應(yīng)用妄壶,需要發(fā)放10000個(gè)紅包回饋用戶躬翁。設(shè)計(jì)方案是多實(shí)例,由redis存儲(chǔ)一個(gè)計(jì)數(shù)器盯拱,每次用戶發(fā)起搶紅包請(qǐng)求時(shí),首先判斷計(jì)數(shù)器是否已經(jīng)累計(jì)到10000了例嘱,是則返回已搶光狡逢,否則發(fā)放紅包(用戶搶到紅包的信息也存儲(chǔ)在redis)。

分析:

該場(chǎng)景下拼卵,如果設(shè)計(jì)方案中用戶搶紅包的行為不是放入隊(duì)列的奢浑, 而是簡(jiǎn)單并發(fā), 那么查詢r(jià)edis計(jì)數(shù)器這一步操作腋腮,很可能就會(huì)在臨界點(diǎn)雀彼,例如已經(jīng)被搶了9999個(gè)了,此時(shí)兩個(gè)用戶幾乎同時(shí)搶紅包即寡,都查詢到還能繼續(xù)搶徊哑,最后發(fā)放了兩個(gè)紅包出去。當(dāng)然聪富,這還是樂(lè)觀的莺丑,實(shí)際情況可能是瞬間并發(fā)量非常大,導(dǎo)致發(fā)放了更多的紅包出去。

那么我們希望

查詢計(jì)數(shù)器跟存儲(chǔ)搶到紅包的信息兩個(gè)操作是原子性的梢莽,redis為我們提供了multi萧豆,實(shí)際上也是無(wú)法做到的,multi只適合可以并行的操作昏名,對(duì)于這種需要先執(zhí)行A再能決定是否執(zhí)行B的串行操作不適用涮雷。

此時(shí)lua就可以幫我們忙了,在lua里查詢轻局,判斷洪鸭,確定搶到紅包完全是一個(gè)原子操作,也不需要把搶紅包動(dòng)作設(shè)計(jì)為一個(gè)隊(duì)列嗽交,更不需要去擔(dān)心并發(fā)的影響卿嘲。

此外,兩個(gè)操作合并為一個(gè)lua腳本去執(zhí)行時(shí)夫壁,還節(jié)省了一步redis的io耗時(shí)拾枣。

進(jìn)一步講,redis緩存了所有執(zhí)行過(guò)的lua腳本盒让,只要設(shè)計(jì)得當(dāng)梅肤,這個(gè)操作向redis傳送腳本的帶寬可以節(jié)省到一個(gè)sha碼的大小。

所以lua腳本對(duì)于redis來(lái)說(shuō)可以是一把利刃邑茄。

對(duì)于redis怎么調(diào)lua以及l(fā)ua怎么寫(xiě)不作深入姨蝴,如果不了解可以學(xué)習(xí)一下相關(guān)的內(nèi)容。切入正題肺缕,nodeJs項(xiàng)目如果有用到redis左医,并且redis有調(diào)用lua腳本的需求,可以參考以下的方案封裝:

/**
 *
 * lua腳本集合
 *
 * 用于一些對(duì)redis原有數(shù)據(jù)有執(zhí)行依賴的事務(wù)
 *
 * @author {cmx}
 */

// redis連接同木,本身不創(chuàng)建浮梢,由外部傳入。
const redisClient;

let instance = {
  script : {

  }
};

// 用于記錄已在redis緩存過(guò)的腳本sha碼
let bufferScript = {};


/**
 * 搶紅包動(dòng)作的腳本定義(keysLength值為KEY的個(gè)數(shù))
 * 
 * KEYS[1]      計(jì)數(shù)器key
 * KEYS[2]      用戶已搶到紅包key
 * ARGV[1]      紅包數(shù)額
 * ARGV[2]      limit
 *
 * @return 1 成功  -1 失敗1
 */
instance.script.grabbingRedPacket = {
  code : `
    if(redis.call('xxx', KEYS[1]) < tonumber(ARGV[2]))
    then
      if(redis.call('xxx', KEYS[2], ARGV[1]) == 1)
      then
        return 1
      end
    else
      return -1
    end
  `,
  keysLength : 2
};


/**
 *
 * lua執(zhí)行器 自動(dòng)判斷是否已經(jīng)緩存過(guò)  從而決定是向redis傳遞腳本還是sha
 *
 * @param name    本腳本所支持的指令  位于 instance.script 下
 * @param ...param  該指令所期待的參數(shù), 按照KEYS到ARGV的順序羅列
 */
instance.run = function(name, ...param) {
  return new Promise((resolve, reject) => {
    if (!redisClient) {
      reject('redisClient is no ready');
    } else if (!instance.script[name]) {
      reject('this command is not supported');
    } else {
      if (bufferScript[name]) {
        redisClient.evalsha(bufferScript[name], instance.script[name].keysLength, ...param, (err, result) => {
          if (err) {
            reject(err);
          } else {
            resolve(result);
          }
        });
      } else {
        redisClient.script('load', instance.script[name].code, (err, sha) => {
          if (err) {
            reject(err);
          } else {
            bufferScript[name] = sha;
            redisClient.evalsha(sha, instance.script[name].keysLength, ...param, (err, result) => {
              if (err) {
                reject(err);
              } else {
                resolve(result);
              }
            });
          }
        });
      }
    }
  });
}


module.exports = function(client) {
  if (!client) {
    return;
  }
  redisClient = client;
  return instance;
}

除查詢類型的命令外, 增改刪類型的命令返回值簡(jiǎn)單遵循一個(gè)規(guī)范:

  • 成功 返回值大于0
  • 失敗 返回值小于0

具體成功原因和失敗原因由具體的返回值決定彤路。

命令

裝載一些項(xiàng)目需要用到的腳本, 全部位于 luaScript.script 下秕硝。

執(zhí)行器

簡(jiǎn)單封裝了一個(gè)用于執(zhí)行腳本的方法 luaScript.run(name, ....param), 自動(dòng)緩存腳本的sha碼, 可以確保在服務(wù)存活周期內(nèi)重復(fù)執(zhí)行一段腳本時(shí), 都是采用執(zhí)行sha碼的方案, 而不是每次把腳本完整傳送到redis。其中 name 為已支持的腳本命令, 例如有 luaScript.script.grabbingRedPacket, 那么調(diào)用時(shí) name 填入 grabbingRedPacket洲尊。

二远豺、使用方法:

  1. 引入
const redis = require('redis');
const client = redis.createClient(config.REDIS_PORT, config.REDIS_HOST, config.REDIS_OPTIONS);
// 傳入一個(gè)redis連接即可
const luaScript = require('xxx/lua-script')(client);
  1. 調(diào)用
// 不需要關(guān)心這個(gè)腳本keys的數(shù)量, luaScript已經(jīng)幫助實(shí)現(xiàn)了這個(gè)邏輯, 直接羅列命令期望的參數(shù)即可。
luaScript.run('grabbingRedPacket',
    counterKey,
    userKey,
    amount,
    limit
  ).then(res => {
    ...
});
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末坞嘀,一起剝皮案震驚了整個(gè)濱河市躯护,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌丽涩,老刑警劉巖榛做,帶你破解...
    沈念sama閱讀 222,946評(píng)論 6 518
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡检眯,警方通過(guò)查閱死者的電腦和手機(jī)厘擂,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,336評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)锰瘸,“玉大人刽严,你說(shuō)我怎么就攤上這事”苣” “怎么了舞萄?”我有些...
    開(kāi)封第一講書(shū)人閱讀 169,716評(píng)論 0 364
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)管削。 經(jīng)常有香客問(wèn)我倒脓,道長(zhǎng),這世上最難降的妖魔是什么含思? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 60,222評(píng)論 1 300
  • 正文 為了忘掉前任崎弃,我火速辦了婚禮,結(jié)果婚禮上含潘,老公的妹妹穿的比我還像新娘饲做。我一直安慰自己,他們只是感情好遏弱,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,223評(píng)論 6 398
  • 文/花漫 我一把揭開(kāi)白布盆均。 她就那樣靜靜地躺著,像睡著了一般漱逸。 火紅的嫁衣襯著肌膚如雪泪姨。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 52,807評(píng)論 1 314
  • 那天饰抒,我揣著相機(jī)與錄音驴娃,去河邊找鬼。 笑死循集,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的蔗草。 我是一名探鬼主播咒彤,決...
    沈念sama閱讀 41,235評(píng)論 3 424
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼咒精!你這毒婦竟也來(lái)了镶柱?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 40,189評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤模叙,失蹤者是張志新(化名)和其女友劉穎歇拆,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,712評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡故觅,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,775評(píng)論 3 343
  • 正文 我和宋清朗相戀三年厂庇,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片输吏。...
    茶點(diǎn)故事閱讀 40,926評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡权旷,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出贯溅,到底是詐尸還是另有隱情拄氯,我是刑警寧澤,帶...
    沈念sama閱讀 36,580評(píng)論 5 351
  • 正文 年R本政府宣布它浅,位于F島的核電站译柏,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏姐霍。R本人自食惡果不足惜鄙麦,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,259評(píng)論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望邮弹。 院中可真熱鬧黔衡,春花似錦、人聲如沸腌乡。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,750評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)与纽。三九已至侣签,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間急迂,已是汗流浹背影所。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,867評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留僚碎,地道東北人猴娩。 一個(gè)月前我還...
    沈念sama閱讀 49,368評(píng)論 3 379
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像勺阐,于是被迫代替她去往敵國(guó)和親卷中。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,930評(píng)論 2 361

推薦閱讀更多精彩內(nèi)容