egg-redis
Redis client(support redis portocal) 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,
host: '127.0.0.1',
password: 'auth',
db: 0,
},
}
Multi Clients
config.redis = {
clients: {
foo: {
port: 6379,
host: '127.0.0.1',
password: 'auth',
db: 0,
},
bar: {
port: 6379,
host: '127.0.0.1',
password: 'auth',
db: 1,
},
}
}
Sentinel
config.redis = {
client: {
sentinels: [{
port: 26379,
host: '127.0.0.1',
}],
name: 'mymaster',
password: 'auth',
db: 0
},
}
No password
Redis support no authentication access, but we are highly recommand 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:
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@3 now, if you want to upgrade your ioredis, you can pass the instance by config.redis.Redis
:
config.redis = {
Redis: require('ioredis'),
client: {
port: 6379,
host: '127.0.0.1',
password: 'auth',
db: 0,
},
}
Usage
In controller, you can use app.redis
to get the redis instance, check ioredis to see how to use.
module.exports = app => {
return class HomeController extends app.Controller {
async index() {
const { ctx, app } = this;
await app.redis.set('foo', 'bar');
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.
module.exports = app => {
return class HomeController extends app.Controller {
async index() {
const { ctx, app } = this;
await app.redis.get('instance1').set('foo', 'bar');
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.
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',
}]
},
};
module.exports = app => {
return class HomeController extends app.Controller {
async index() {
const { ctx, app } = this;
await app.redis.set('foo', 'bar');
ctx.body = await app.redis.get('foo');
}
};
};
Questions & Suggestions
Please open an issue here.
License
MIT