egg-redis

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

Install

1$ 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:

1exports.redis = {
2  enable: true,
3  package: 'egg-redis',
4};

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

Single Client

1config.redis = {
2  client: {
3    port: 6379,          // Redis port
4    host: '127.0.0.1',   // Redis host
5    password: 'auth',
6    db: 0,
7  },
8}

Multi Clients

1config.redis = {
2  clients: {
3    foo: {                 // instanceName. See below
4      port: 6379,          // Redis port
5      host: '127.0.0.1',   // Redis host
6      password: 'auth',
7      db: 0,
8    },
9    bar: {
10      port: 6379,
11      host: '127.0.0.1',
12      password: 'auth',
13      db: 1,
14    },
15  }
16}

Sentinel

1config.redis = {
2  client: {
3    sentinels: [{          // Sentinel instances
4      port: 26379,         // Sentinel port
5      host: '127.0.0.1',   // Sentinel host
6    }],
7    name: 'mymaster',      // Master name
8    password: 'auth',
9    db: 0
10  },
11}

No password

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

1
2$vim /etc/redis/redis.conf
3
4requirepass xxxxxxxxxx  // xxxxxxxxxx is your password
5

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:

1// config/config.default.js
2config.redis = {
3  Redis: require('ioredis'), // customize ioredis version, only set when you needed
4  client: {
5    port: 6379,          // Redis port
6    host: '127.0.0.1',   // Redis host
7    password: 'auth',
8    db: 0,
9  },
10}

weakDependent

1config.redis = {
2  client: {
3    port: 6379,          // Redis port
4    host: '127.0.0.1',   // Redis host
5    password: 'auth',
6    db: 0,
7    weakDependent: true, // this redis instance won't block app start
8  },
9}

Usage

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

1// app/controller/home.js
2
3module.exports = app => {
4  return class HomeController extends app.Controller {
5    async index() {
6      const { ctx, app } = this;
7      // set
8      await app.redis.set('foo', 'bar');
9      // get
10      ctx.body = await app.redis.get('foo');
11    }
12  };
13};

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.

1// app/controller/home.js
2
3module.exports = app => {
4  return class HomeController extends app.Controller {
5    async index() {
6      const { ctx, app } = this;
7      // set
8      await app.redis.get('instance1').set('foo', 'bar');
9      // get
10      ctx.body = await app.redis.get('instance1').get('foo');
11    }
12  };
13};

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.

1
2// app/config/config.default.js
3
4exports.redis = {
5   client: {
6     cluster: true,
7     nodes: [{
8       host: '127.0.0.1',
9       port: '6379',
10       family: 'user',
11       password: 'password',
12       db: 'db',
13     }, {
14       host: '127.0.0.1',
15       port: '6380',
16       family: 'user',
17       password: 'password',
18       db: 'db',
19     }]
20   },
21};
22
23// app/controller/home.js
24
25module.exports = app => {
26  return class HomeController extends app.Controller {
27    async index() {
28      const { ctx, app } = this;
29      // set
30      await app.redis.set('foo', 'bar');
31      // get
32      ctx.body = await app.redis.get('foo');
33    }
34  };
35};

Questions & Suggestions

Please open an issue here.

License

MIT