nodejs访问redis时的utils封装

前言

本文基于redisco-redis,对redis的操作方法进行了封装,主要实现以下特性

  • 使用co风格访问DB
  • 整个程序使用单一redis client
  • redis client的初始化在第一次访问时进行
  • 封装scan命令替代keyssmembers

准备DB配置文件

// config.js
var redis = {
  RDS_PORT: 6379,
  RDS_HOST: '127.0.0.1',
  RDS_DB: '1'
};

导入第三方Package

var commands = require('redis-commands');
var redis = require('redis');
var wrapper = require('co-redis');
var config = require('./config'); //配置文件

定义redis client的初始化操作

使用redisCo直接进行DB访问,初始为undifined,第一次进行DB访问时,使用initClient函数对该对象进行初始化
initClient方法中,首先使用redis创建client,之后配置该client的错误监听函数,最后使用co-redis进行co

var redisCo;
var initClient = function() {
  var client = redis.createClient(config.redis.RDS_PORT,
    config.redis.RDS_HOST, {
      db: config.redis.RDS_DB
    });
  client.on('error', function(err) {
    console.log('Error ' + err);
  });
  redisCo = wrapper(client);
};

定义helper对象作为该utils模块的对外接口

helper对象的构造函数中

  1. 首先使用redis-commands获取所有redis命令
  2. 对每一个redis命令,在helper中添加与该命令同名的函数
  3. helper中的每个redis的函数中,检查并初始化redisCo之后,调用co-redis执行该命令

由于co-redis封装时所提供的redis命令也是从redis-commands中读取的,从而保证了helper中命令转发时的正确性
(参见co-redisredis的源码)

var helper = function() {
  var self = this;
  commands.list.forEach(function(command) {
    self[command] = function*() {
      if (redisCo === undefined) {
        initClient();
      }
      var res = {};
      var params = arguments;
      res = yield redisCo[command].apply(this, params);
      return res;
    };
  });
};
// 省略
module.exports = new helper();

为helper添加自定义方法

  • cleanup
    用于批量删除redis中的key,可以通过参数指定要删除的keypattern,参数未指定时,删除所有的key
helper.prototype.cleanup = function*(count) {
  var partern = '';
  switch (count) {
    case '0':
      partern = '0x01:*';
      break;
    case '1':
      partern = '0x02:*';
      break;
    case '2':
      partern = '0x10:*';
      break;
    case '3':
      partern = '0x90:*';
      break;
    case '4':
      partern = '0x91:*';
      break;
    default:
      partern = '*';
      break;
  }
  var keys = yield this.keys(partern);
  if (keys.length !== 0) {
    yield this.del(keys);
  }
};
  • scanKeys
    用于替代keys命令获取符合指定pattern的所有key
helper.prototype.scanKeys = function*(pattern) {
  var ret = [];
  var cursor = 0;
  while (true) {
    var res = yield this.scan(cursor, 'MATCH', pattern, 'COUNT', 10);
    cursor = parseInt(res[0]);
    ret = ret.concat(res[1]);
    if (cursor === 0) {
      break;
    }
  }
  return ret;
  • scanMembers
    用于替代smember命令获取指定set的所有成员
helper.prototype.scanMembers = function*(key) {
  var ret = [];
  var cursor = 0;
  while (true) {
    var res = yield this.sscan(key, cursor, 'COUNT', 10);
    cursor = parseInt(res[0]);
    ret = ret.concat(res[1]);
    if (cursor === 0) {
      break;
    }
  }
  return ret;
};
  • 其他

完整的代码

//dbhelper.js
'use strict';
var commands = require('redis-commands');
var redis = require('redis');
var wrapper = require('co-redis');
var config = require('../config');
var redisCo;
var initClient = function() {
  var client = redis.createClient(config.redis.RDS_PORT,
    config.redis.RDS_HOST, {
      db: config.redis.RDS_DB
    });
  client.on('error', function(err) {
    console.log('Error ' + err);
  });
  redisCo = wrapper(client);
};
var helper = function() {
  var self = this;
  commands.list.forEach(function(command) {
    self[command] = function*() {
      if (redisCo === undefined) {
        initClient();
      }
      var res = {};
      var params = arguments;
      res = yield redisCo[command].apply(this, params);
      return res;
    };
  });
};
helper.prototype.cleanup = function*(count) {
  var partern = '';
  switch (count) {
    case '0':
      partern = '0x01:*';
      break;
    case '1':
      partern = '0x02:*';
      break;
    case '2':
      partern = '0x10:*';
      break;
    case '3':
      partern = '0x90:*';
      break;
    case '4':
      partern = '0x91:*';
      break;
    default:
      partern = '*';
      break;
  }
  var keys = yield this.keys(partern);
  if (keys.length !== 0) {
    yield this.del(keys);
  }
};
helper.prototype.scanKeys = function*(pattern) {
  var ret = [];
  var cursor = 0;
  while (true) {
    var res = yield this.scan(cursor, 'MATCH', pattern, 'COUNT', 10);
    cursor = parseInt(res[0]);
    ret = ret.concat(res[1]);
    if (cursor === 0) {
      break;
    }
  }
  return ret;
};
helper.prototype.scanMembers = function*(key) {
  var ret = [];
  var cursor = 0;
  while (true) {
    var res = yield this.sscan(key, cursor, 'COUNT', 10);
    cursor = parseInt(res[0]);
    ret = ret.concat(res[1]);
    if (cursor === 0) {
      break;
    }
  }
  return ret;
};
module.exports = new helper();
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,829评论 1 331
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,603评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,846评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,600评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,780评论 3 272
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,695评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,136评论 2 293
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,862评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,453评论 0 229
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,942评论 2 233
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,347评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,790评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,293评论 3 221
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,839评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,448评论 0 181
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,564评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,623评论 2 249

推荐阅读更多精彩内容

  • 转载地址:http://gnucto.blog.51cto.com/3391516/998509 Redis与Me...
    Ddaidai阅读 21,384评论 0 82
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,050评论 18 139
  • 转自:http://bbs.redis.cn/forum.php?mod=viewthread&tid=481 p...
    木十2036阅读 767评论 0 7
  • Jetty 是一个开源的servlet容器,它为基于Java的web容器,例如JSP和servlet提供运行环境。...
    ccq_inori阅读 228评论 0 2
  • 树丰老师最近组织了秋季写书计划,今天下午泡在图书馆一下午的时间寻找写作的一些方法,为了后期写作做引导,这或许是最为...
    锦潇阅读 376评论 0 2