egg-redis

egg-redis

Redis client(support redis protocol) based on ioredis for egg framework

Install

npm i egg-redis --save

redis Plugin for egg, support egg application access to redis.

This plugin based on ioredis, if you want to know specific usage, you should refer to the document of ioredis.

Configuration

Change ${app_root}/config/plugin.js to enable redis plugin:

exports.redis = {
  enable: true,
  package: 'egg-redis',
};

Configure redis information in ${app_root}/config/config.default.js:

Single Client

config.redis = {
  client: {
    port: 6379,          // Redis port
    host: '127.0.0.1',   // Redis host
    password: 'auth',
    db: 0,
  },
}

Multi Clients

config.redis = {
  clients: {
    foo: {                 // instanceName. See below
      port: 6379,          // Redis port
      host: '127.0.0.1',   // Redis host
      password: 'auth',
      db: 0,
    },
    bar: {
      port: 6379,
      host: '127.0.0.1',
      password: 'auth',
      db: 1,
    },
  }
}

Sentinel

config.redis = {
  client: {
    sentinels: [{          // Sentinel instances
      port: 26379,         // Sentinel port
      host: '127.0.0.1',   // Sentinel host
    }],
    name: 'mymaster',      // Master name
    password: 'auth',
    db: 0
  },
}

No password

Redis support no authentication access, but we are highly recommend you to use redis requirepass in redis.conf.

$vim /etc/redis/redis.conf

requirepass xxxxxxxxxx  // xxxxxxxxxx is your password

Because it may be cause security risk, refer:

• https://ruby-china.org/topics/28094
• https://zhuoroger.github.io/2016/07/29/redis-sec/

If you want to access redis with no password, use password: null.

See ioredis API Documentation for all available options.

Customize ioredis version

egg-redis using ioredis@4 now, if you want to use other version of ioredis, you can pass the instance by config.redis.Redis:

// config/config.default.js
config.redis = {
  Redis: require('ioredis'), // customize ioredis version, only set when you needed
  client: {
    port: 6379,          // Redis port
    host: '127.0.0.1',   // Redis host
    password: 'auth',
    db: 0,
  },
}

weakDependent

config.redis = {
  client: {
    port: 6379,          // Redis port
    host: '127.0.0.1',   // Redis host
    password: 'auth',
    db: 0,
    weakDependent: true, // this redis instance won't block app start
  },
}

Usage

In controller, you can use app.redis to get the redis instance, check ioredis to see how to use.

// app/controller/home.js

module.exports = app => {
  return class HomeController extends app.Controller {
    async index() {
      const { ctx, app } = this;
      // set
      await app.redis.set('foo', 'bar');
      // get
      ctx.body = await app.redis.get('foo');
    }
  };
};

Multi Clients

If your Configure with multi clients, you can use app.redis.get(instanceName) to get the specific redis instance and use it like above.

// app/controller/home.js

module.exports = app => {
  return class HomeController extends app.Controller {
    async index() {
      const { ctx, app } = this;
      // set
      await app.redis.get('instance1').set('foo', 'bar');
      // get
      ctx.body = await app.redis.get('instance1').get('foo');
    }
  };
};

Clients Depend on Redis Cluster

Before you start to use Redis Cluster, please checkout the document first, especially confirm cluster-enabled yes in Redis Cluster configuration file.

In controller, you also can use app.redis to get the redis instance based on Redis Cluster.

// app/config/config.default.js

exports.redis = {
   client: {
     cluster: true,
     nodes: [{
       host: '127.0.0.1',
       port: '6379',
       family: 'user',
       password: 'password',
       db: 'db',
     }, {
       host: '127.0.0.1',
       port: '6380',
       family: 'user',
       password: 'password',
       db: 'db',
     }]
   },
};

// app/controller/home.js

module.exports = app => {
  return class HomeController extends app.Controller {
    async index() {
      const { ctx, app } = this;
      // set
      await app.redis.set('foo', 'bar');
      // get
      ctx.body = await app.redis.get('foo');
    }
  };
};

Questions & Suggestions

Please open an issue here.

License

MIT

Contributors

Made with contributors-img.

Changelog

2.6.1 (2025-01-19)

Bug Fixes

• typings of config for multi cluster clients (#32) (511c75c)

2.6.0 / 2024-04-07

features

• [9f02a13] - feat: remove node password and db validate on cluster mode (#39) (KenyeeCheung <[e-mail]>)

2.5.0 / 2023-06-06

features

• [3088929] - feat: support redis path mode (#33) (QingDeng <[e-mail]>)

others

• [83d5404] - docs: fix default redis version (dead-horse <[e-mail]>)

2.4.0 / 2019-06-13

features

• [5fbd718] - feat: add config.client.weakDependent (#30) (Yiyu He <[e-mail]>)

others

• [b307f52] - chore: test on node@12 (dead-horse <[e-mail]>)

2.3.2 / 2019-04-24

fixes

• [ce7e40e] - fix: should listen redis ready event before app start (#29) (killa <[e-mail]>)

2.3.1 / 2019-04-10

fixes

• [3b0fa5a] - fix(types): add multi client support for typescript (#27) (mars <[e-mail]>)

2.3.0 / 2018-12-18

• feat: redis sentinel config support (#26)
• deps: add @types/ioredis to deps (#25)

2.2.0 / 2018-12-04

features

• [f062dd5] - feat: support typescript (#23) (耐小心 <[e-mail]>)

2.1.0 / 2018-11-28

features

• [ee3fda1] - feat: support customize ioredis version (#21) (Yiyu He <[e-mail]>)

2.0.1 / 2018-11-28

fixes

• [fbfbbfa] - fix: show real redis server time by TIME command (#20) (fengmk2 <[e-mail]>)

2.0.0 / 2018-02-27

others

• [70e85e2] - chore: add package.files (dead-horse <[e-mail]>)
• [45585e8] - chore: update dependencies and fix ci (#16) (Yiyu He <[e-mail]>)
• [8b88641] - refactor: use async function (#15) (QIAO <[e-mail]>)
• [8dd3776] - deps: Update ioredis (#14) (thegatheringstorm <[e-mail]>)
• [59d9579] - docs: fix some typo (#13) (kyle <[e-mail]>)
• [de17719] - docs:add nopassword doc (#12) (Adams <[e-mail]>)
• [5b0dd99] - chore:bump to 1.0.2 (jtyjty99999 <[e-mail]>),

1.0.2 / 2017-07-13

• fix : fix check method (#10)
• docs: add configuration details (#9)
• test: upgrade all deps (#7)
• docs:fix redis cluster doc (#6)

1.0.1 / 2017-02-21

• fix:fix zero judgement (#5)

1.0.0 / 2017-02-17

• feat: implement with ioredis