feat(@142vip/redis): 新增RedisFactory工厂类，优化Redis实例创建的核心逻辑 (#718)

Author: mmdapl

packages/redis/README.md

@@ -9,6 +9,80 @@ npm install @142vip/redis
 pnpm i @142vip/redis
 ```
 
+## 使用
+
+### 创建工厂类
+```typescript
+import { RedisFactory } from '@142vip/redis'
+
+// 初始化工厂类实例
+const redisFactory = new RedisFactory()
+```
+
+- `redisFactory.createClient()` ：创建客户端
+- `redisFactory.createCluster()` ：创建集群客户端
+- `redisFactory.getClient()` ：获取客户端
+
+## 配置
+
+### 简单&哨兵模式
+```typescript
+// 默认连接 127.0.0.1:6379
+redisFactory.getClient()
+// 连接 127.0.0.1:6380, db 4,使用密码 123456
+redisFactory.getClient({
+  url: 'redis://:123456@127.0.0.1:6380/4',
+})
+// 用户名、密码都可以通过 URI 传递。
+redisFactory.getClient({
+  url: 'redis://username:password@127.0.0.1:6380/4',
+})
+redisFactory.getClient({
+  port: 6379, // 端口
+  host: '127.0.0.1', // host主机地址
+  username: 'default', // 需要redis版本大于6
+  password: 'my-top-secret',
+  db: 0, // 默认0
+})
+```
+
+### 集群模式
+
+```typescript
+redisFactory.getClient({
+  clusterNodes: [
+    {
+      host: '127.0.0.1',
+      port: 6379,
+    },
+    {
+      host: '127.0.0.1',
+      port: 6380,
+    },
+  ],
+  // 可选
+  clusterOptions: {
+    // 集群模式下，每个节点的连接配置
+    redisOptions: {
+      username: 'default', // 需要redis版本大于6
+      password: 'my-top-secret',
+      db: 0, // 默认0
+    },
+  },
+})
+```
+
+## 最佳实践
+
+- [egg-redis](https://github.com/eggjs/egg-redis)
+- [@142vip/nest-redis](https://github.com/142vip/nest-redis)
+
+## 参考
+
+- [IORedis Npm](https://www.npmjs.com/package/redis)
+- [IORedis Github](https://github.com/luin/ioredis)
+- [IORedis 官网](https://redis.io/)
+
 ## 证书
 
 [MIT](https://opensource.org/license/MIT)

packages/redis/src/core/redis.factory.ts

@@ -0,0 +1,35 @@
+import type Cluster from 'ioredis/built/cluster'
+import Redis from 'ioredis'
+import { RedisClient, RedisClientConfig, RedisClusterConfig, RedisConfig } from './redis.interface'
+
+/**
+ * Redis工厂类
+ */
+export class RedisFactory {
+  /**
+   * 简单&哨兵模式
+   */
+  public createClient(config: RedisClientConfig): Redis {
+    return config.url != null ? new Redis(config.url, config) : new Redis(config)
+  }
+
+  /**
+   * 集群模式
+   */
+  public createCluster(config: RedisClusterConfig): Cluster {
+    return new Redis.Cluster(config.clusterNodes, config.clusterOptions)
+  }
+
+  /**
+   * 获取Redis客户端
+   */
+  public getClient(config: RedisConfig): RedisClient {
+    // 集群模式
+    if (config.clusterNodes != null) {
+      return this.createCluster(config as RedisClusterConfig)
+    }
+    else {
+      return this.createClient(config)
+    }
+  }
+}

packages/redis/src/core/redis.interface.ts

@@ -0,0 +1,38 @@
+import Redis from 'ioredis'
+import Cluster, { ClusterNode } from 'ioredis/built/cluster'
+import { ClusterOptions } from 'ioredis/built/cluster/ClusterOptions'
+import { RedisOptions } from 'ioredis/built/redis/RedisOptions'
+
+/**
+ * io-redis支持的连接模式
+ */
+export enum RedisMode {
+  STANDARD = 'standard',
+  CLUSTER = 'cluster',
+  SENTINEL = 'sentinel',
+}
+
+/**
+ * 单机、哨兵配置
+ */
+export interface RedisClientConfig extends RedisOptions {
+  url?: string
+}
+
+/**
+ * 集群配置
+ */
+export interface RedisClusterConfig {
+  clusterNodes: ClusterNode[]
+  clusterOptions?: ClusterOptions
+}
+
+/**
+ * Redis 建立连接配置
+ */
+export interface RedisConfig extends RedisClientConfig, Partial<RedisClusterConfig> {}
+
+/**
+ * Redis 客户端
+ */
+export type RedisClient = Redis | Cluster

packages/redis/src/index.ts

@@ -1,2 +1,2 @@
-export * from './io-redis'
-export * from './redis'
+export * from './core/redis.factory'
+export * from './core/redis.interface'