feat(@142vip/nest-redis): 新增RedisModule全局模块，支持注入即使用，补充单元测试、文档 (#719)

Author: mmdapl

packages/nest-redis/README.md

@@ -11,6 +11,63 @@ npm install @142vip/nest-redis
 pnpm i @142vip/nest-redis
 ```
 
+## 配置
+
+```typescript
+import { RedisConfig } from '@142vip/redis'
+
+// 简单配置
+const config: RedisConfig = {
+  url: 'redis://localhost:6379',
+}
+
+// 集群配置
+const clusterConfig: RedisConfig = {
+  clusterNodes: [
+    {
+      url: 'redis://localhost:6379',
+    },
+    {
+      url: 'redis://localhost:6380',
+    },
+  ],
+}
+// ...
+```
+
+## 使用
+
+### 模块注入
+```typescript
+import { RedisModule } from '@142vip/nest-redis'
+
+@Module({
+  imports: [RedisModule.register({
+    url: 'redis://localhost:6379',
+  })],
+})
+export class AppModule {}
+```
+
+### 使用服务
+```typescript
+import { RedisService } from '@142vip/nest-redis'
+
+@Injectable()
+export class AppService {
+  constructor(
+    private readonly redisService: RedisService
+  ) {}
+}
+```
+
+`RedisService`类实例化后，可以直接使用类对应的方法，代码的最佳实践，可以参考模块：[redis-example](https://github.com/142vip/core-x/apps/nest-demo/src/core/redis-example)
+
+## 参考
+
+- [NPM @142vip/redis](https://www.npmjs.com/package/@142vip/redis)
+- [Redis 官网](https://redis.io/)
+
 ## 证书
 
 [MIT](https://opensource.org/license/MIT)

packages/nest-redis/build.config.ts

@@ -0,0 +1,15 @@
+import { createDefaultPreset } from 'ts-jest'
+
+const tsJestTransformCfg = createDefaultPreset().transform
+
+/** @type {import("jest").Config} **/
+export default {
+  testEnvironment: 'node',
+  transform: {
+    ...tsJestTransformCfg,
+  },
+  testMatch: [
+    // "**/__tests__/**/*.[jt]s?(x)",
+    '**/test/**/?(*.)+(spec|test).[tj]s?(x)',
+  ],
+}

packages/nest-redis/jest.config.ts

@@ -23,8 +23,8 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
     }
   },
   "authorInfo": {
@@ -33,21 +33,29 @@
     "url": "https://github.com/142vip",
     "homePage": "https://142vip.cn"
   },
-  "main": "./dist/index.mjs",
-  "module": "./dist/index.mjs",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "unbuild",
-    "typecheck": "tsc --noEmit"
+    "build": "npx nest build",
+    "typecheck": "tsc --noEmit",
+    "test": "npx jest",
+    "test:coverage": "npx jest --coverage"
   },
   "dependencies": {
-    "@142vip/utils": "workspace:*"
+    "@142vip/redis": "workspace:*",
+    "@nestjs/common": "11.1.7",
+    "@nestjs/core": "11.1.7"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "11.0.10",
+    "@nestjs/testing": "11.1.7"
   }
 }

packages/nest-redis/package.json

@@ -0,0 +1,4 @@
+/**
+ * redis client Token 唯一标记
+ */
+export const REDIS_CLIENT_TOKEN = Symbol('@142vip/nest-redis#client-token')

packages/nest-redis/src/core/redis.constants.ts

@@ -0,0 +1,9 @@
+import { Inject } from '@nestjs/common'
+import { REDIS_CLIENT_TOKEN } from './redis.constants'
+
+/**
+ * redis client 装饰器
+ */
+export function InjectRedisClient(): PropertyDecorator & ParameterDecorator {
+  return Inject(REDIS_CLIENT_TOKEN)
+}

packages/nest-redis/src/core/redis.decorator.ts

@@ -0,0 +1,27 @@
+import { RedisConfig } from '@142vip/redis'
+import { DynamicModule, Module } from '@nestjs/common'
+import { REDIS_CLIENT_TOKEN } from './redis.constants'
+import { RedisService } from './redis.service'
+
+@Module({})
+export class RedisModule {
+  public static register(config: RedisConfig): DynamicModule {
+    const redisService = new RedisService(config)
+    const providers = [
+      {
+        provide: RedisService,
+        useValue: redisService,
+      },
+      {
+        provide: REDIS_CLIENT_TOKEN,
+        useValue: redisService.getClient(),
+      },
+    ]
+    return {
+      module: RedisModule,
+      providers,
+      exports: providers,
+      global: true,
+    }
+  }
+}

packages/nest-redis/src/core/redis.module.ts

@@ -0,0 +1,61 @@
+import type { RedisClient, RedisConfig } from '@142vip/redis'
+import { RedisFactory } from '@142vip/redis'
+import { Injectable } from '@nestjs/common'
+
+@Injectable()
+export class RedisService {
+  private readonly config: RedisConfig
+  private readonly client: RedisClient
+
+  constructor(config: RedisConfig) {
+    this.config = config
+    this.client = this.getClient()
+  }
+
+  /**
+   * 获取客户端
+   */
+  public getClient(): RedisClient {
+    return new RedisFactory().getClient(this.config)
+  }
+
+  /**
+   * 存储
+   * - 单位：分钟
+   * @param key
+   * @param data
+   * @param expiredTime
+   */
+  public async setEx<T>(key: string, data: T, expiredTime: number): Promise<void> {
+    const jsonData = JSON.stringify(data)
+    await this.client.set(key, jsonData, 'EX', expiredTime)
+  }
+
+  /**
+   * 获取
+   */
+  public async getEx<T>(key: string): Promise<T | null> {
+    const jsonData = await this.client.get(key)
+
+    try {
+      if (jsonData == null) {
+        return null
+      }
+      return JSON.parse(jsonData) as T
+    }
+    catch {
+      return null
+    }
+  }
+
+  /**
+   * 删除
+   * - 支持延迟双删
+   */
+  public async del(key: string): Promise<void> {
+    await this.client.del(key)
+    setTimeout(async (): Promise<void> => {
+      await this.client.del(key)
+    }, 1000)
+  }
+}

packages/nest-redis/src/core/redis.service.ts

@@ -1 +1,4 @@
-export const test = 1
+export * from './core/redis.constants'
+export * from './core/redis.decorator'
+export * from './core/redis.module'
+export * from './core/redis.service'