如何从 NestJS CacheManager 模块获取 redis io 客户端

Question

我目前正在使用 NestJS 的缓存管理器模块，我想知道为什么我无法像这样获得 NodeRedis 客户端：

 constructor(
    @Inject(CACHE_MANAGER) private cacheManager: Cache,
  ) {
    cacheManager.store.getClient();
  }

我收到这个错误：

ERROR in [...].controller.ts:24:24
TS2339: Property 'getClient' does not exist on type 'Store'.
    22 |     @Inject(CACHE_MANAGER) private cacheManager: Cache,
    23 |   ) {
  > 24 |     cacheManager.store.getClient();
       |                        ^^^^^^^^^
    25 |   }

我在注册 CacheModule 时配置了 cache-manager-redis-store 然后我想我可以得到客户端。

Answer 1

tl;dr TypeScript 似乎不支持 cache-manager-redis-store，因为 RedisCache 类型是私有的，无法导入。

作为解决方法，您可以将私有类型复制到您自己的文件中：

import { CACHE_MANAGER, Inject, Injectable } from '@nestjs/common';
import { Store } from 'cache-manager';
import Redis from 'redis';

interface RedisCache extends Cache {
  store: RedisStore;
}

interface RedisStore extends Store {
  name: 'redis';
  getClient: () => Redis.RedisClient;
  isCacheableValue: (value: any) => boolean;
}

@Injectable()
export class CacheService {
  constructor(
    @Inject(CACHE_MANAGER)
    private cacheManager: RedisCache,
  ) {
    cacheManager.store.getClient();
  }
}

深入探讨

看起来NestJS提供的CACHE_MANAGER是由createCacheManager创建的，它导入了npm包cache-manager，然后用store包调用它的caching函数你给。

我认为您使用的 Cache 类型是从 cache-manager 导入的。该类型在同一文件中定义 here and contains a Store contained here。 getClient 不是该接口上的方法方法，因此错误消息是正确的。

但是，由于您使用的是商店的外部包，因此 caching-manager 所知道的比它多。查看 cache-manager-redis-store 的类型，您可以看到有一个类型 RedisStore 扩展 Store 并包含 getClient.

所以 cacheManager 技术上有 getClient 因为你已经用 redis 存储包配置了它，但是你需要将 cacheManager 变量的类型设置为 RedisCache TypeScript 允许它。

根据 cache-manager-redis-store 的 DefinitelyTyped 类型，如果您将包导入为 redisStore，您的类型似乎应该是 redisStore.CacheManagerRedisStore.RedisCache，但似乎存在问题，因为该命名空间CacheManagerRedisStore 未导出。

有an issue about this same problem on the repo and there's an issue asking for TypeScript support。 TypeScript 目前似乎不正确支持此包。

如何从 NestJS CacheManager 模块获取 redis io 客户端

How can I get redis io client from NestJS CacheManager module

nestjs

node-redis

cachemanager

深入探讨