npm 包 egg-redis 使用教程

前言

egg-redis 是一个 Redis 插件，可以轻松地在 Egg.js 框架中集成和使用 Redis。Redis 是一个开源的内存数据结构存储系统，支持多种数据结构，如字符串、哈希表、列表等。

在本文中，我们将介绍如何使用 npm 包 egg-redis 在 Egg.js 中集成 Redis，包括安装、配置以及基本的使用方法。

安装

首先，需要在 Egg.js 项目中安装 egg-redis。可以使用以下命令：

npm install egg-redis --save

配置

在 Egg.js 的配置文件 config/config.default.js 中添加以下配置项：

exports.redis = {
  client: {
    host: 'localhost',
    port: '6379',
    password: '',
    db: '0',
  },
};

这里配置了 Redis 的连接信息，包括主机地址、端口号、密码和数据库编号。

使用

在需要使用 Redis 的地方，可以通过 app.redis 对象访问 Redis 实例。下面是一些常见的使用场景示例。

存储和获取字符串

// 存储字符串
await app.redis.set('key', 'value');

// 获取字符串
const value = await app.redis.get('key');
console.log(value); // 输出：value

存储和获取对象

// 存储对象
await app.redis.hset('hash-key', 'field1', 'value1');
await app.redis.hset('hash-key', 'field2', 'value2');

// 获取对象
const obj = await app.redis.hgetall('hash-key');
console.log(obj); // 输出：{ field1: 'value1', field2: 'value2' }

存储和获取列表

// 存储列表
await app.redis.lpush('list-key', 'value1');
await app.redis.lpush('list-key', 'value2');

// 获取列表
const list = await app.redis.lrange('list-key', 0, -1);
console.log(list); // 输出：[ 'value2', 'value1' ]

存储和获取集合

// 存储集合
await app.redis.sadd('set-key', 'value1');
await app.redis.sadd('set-key', 'value2');

// 获取集合
const set = await app.redis.smembers('set-key');
console.log(set); // 输出：[ 'value2', 'value1' ]

总结

通过本文的介绍，我们了解了 npm 包 egg-redis 的使用方法，并对 Redis 的常见用法有了更深入的了解。在 Egg.js 中使用 egg-redis 可以方便地操作 Redis，提高开发效率。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/45067