## 缓存（Caching）
缓存是一项伟大而简单的技术，可以帮助提高应用程序的性能。它充当临时数据存储，提供高性能的数据访问。
### 安装
我们首先需要安装所需的包：
```bash
$ npm install cache-manager
$ npm install -D @types/cache-manager
```
### 内存缓存
`Nest`为各种缓存存储提供程序提供了统一的 `API`。内置的是内存中的数据存储。但是，您可以轻松地切换到更全面的解决方案，比如 `Redis` 。为了启用缓存，首先导入 `CacheModule` 并调用它的 `register()` 方法。
```typescript
import { CacheModule, Module } from '@nestjs/common';
import { AppController } from './app.controller';
@Module({
imports: [CacheModule.register()],
controllers: [AppController],
})
export class ApplicationModule {}
```
### 与缓存存储的交互
为了和缓存管理器实例进行交互，需要使用`CACHE_MANAGER`标记将其注入到你的类，如下所示:
```typescript
constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}
```
> `Cache`类是从`cache-manager`中导入的，而`CACHE_MANAGER`则是从`@nestjs/common`包中导入的。
`Cache`实例(来自cache-manager包)上的`get`方法被用来从缓存中检索键值。如果该键在缓存中不存在，则返回null。
```typescript
const value = await this.cacheManager.get('key');
```
使用`set`方法将一个键值对添加到缓存中:
```typescript
await this.cacheManager.set('key', 'value');
```
缓存的默认过期时间是5秒。
你可以为特定的键手动指定一个TTL(过期时间，以秒为单位)，如下所示:
```typescript
await this.cacheManager.set('key', 'value', { ttl: 1000 });
```
如果要让缓存永不过期，请将配置的`ttl`属性设置为`0`。
```typescript
await this.cacheManager.set('key', 'value', { ttl: 0 });
```
使用`del`方法从缓存中删除一个键值对:
```typescript
await this.cacheManager.del('key');
```
使用`reset`方法清空整个缓存:
```typescript
await this.cacheManager.reset();
```
### 自动缓存响应
> 在 [GraphQL](https://docs.nestjs.com/graphql/quick-start) 应用中，拦截器针对每个字段解析器分别运行，因此，`CacheModule`(使用拦截器来缓存响应)将无法正常工作。
要启用自动缓存响应，只需在想缓存数据的地方绑定`CacheInterceptor`。
```typescript
@Controller()
@UseInterceptors(CacheInterceptor)
export class AppController {
@Get()
findAll(): string[] {
return [];
}
}
```
> 警告: 只有使用 `GET` 方式声明的节点会被缓存。此外，注入本机响应对象( `@Res()` )的 `HTTP` 服务器路由不能使用缓存拦截器。有关详细信息，请参见[响应映射](https://docs.nestjs.com/interceptors#response-mapping)。
### 全局缓存
为了减少重复代码量，可以将`CacheInterceptor`全局绑定到每个端点(endpoints):
```typescript
import { CacheModule, Module, CacheInterceptor } from '@nestjs/common';
import { AppController } from './app.controller';
import { APP_INTERCEPTOR } from '@nestjs/core';
@Module({
imports: [CacheModule.register()],
controllers: [AppController],
providers: [
{
provide: APP_INTERCEPTOR,
useClass: CacheInterceptor,
},
],
})
export class AppModule {}
```
### 自定义缓存
所有缓存的数据有其自己的过期时间(TTL)。要个性化不同值，将选项对象传递给`register()`方法。
```typescript
CacheModule.register({
ttl: 5, //秒
max: 10, //缓存中最大和最小数量
});
```
### 全局使用模块[#](#use-module-globally)
当你想在其他模块中使用 `CacheModule` 时，你需要导入它（这是任何 Nest 模块的标准）。 或者，通过将选项对象的 `isGlobal` 属性设置为` true` 来将其声明为全局模块，如下所示。 在这种情况下，一旦将 `CacheModule` 加载到根模块（例如，`AppModule`）中，您就不需要在其他模块中导入 `CacheModule`。
~~~typescript
CacheModule.register({
isGlobal: true,
});
~~~
### 全局缓存重载
使能全局缓存后，缓存入口存储在基于路径自动生成的`Cachekey`中。你可能需要基于每个方法重载特定的缓存设置(`@CacheKey()`和`@CacheTTL()`)，允许为独立控制器方法自定义缓存策略。这在使用[不同存储缓存](https://docs.nestjs.com/techniques/caching#different-stores)时是最有意义的。
```typescript
@Controller()
export class AppController {
@CacheKey('custom_key')
@CacheTTL(20)
findAll(): string[] {
return [];
}
}
```
> `@CacheKey()`和`@CacheTTL()`装饰器从`@nestjs/common`包导入。
`@CacheKey()`装饰器可以有或者没有一个对应的`@CacheTTL()`装饰器，反之亦然。你可以选择仅覆盖`@CacheKey()`或`@CacheTTL()`。没有用装饰器覆盖的设置将使用全局注册的默认值（见[自定义缓存](https://docs.nestjs.com/techniques/caching#customize-caching))。
### WebSockets 和 微服务
显然，您可以毫不费力地使用 `CacheInterceptor WebSocket` 订阅者模式以及 `Microservice` 的模式（无论使用何种服务间的传输方法）。
> 译者注: 微服务架构中服务之间的调用需要依赖某种通讯协议介质，在 `nest` 中不限制你是用消息队列中间件，`RPC/gRPC` 协议或者对外公开 `API` 的 `HTTP` 协议。
```typescript
@CacheKey('events')
@UseInterceptors(CacheInterceptor)
@SubscribeMessage('events')
handleEvent(client: Client, data: string[]): Observable<string[]> {
return [];
}
```
然而，需要一个附加的`@CacheKey()`装饰器来指定一个用于依次存储并获取缓存数据的键。注意，你不应该缓存所有的内容。永远也不要去缓存那些用于实现业务逻辑也不是简单地查询数据的行为。
此外，你可以使用`@CacheTTL()`装饰器来指定一个缓存过期时间(TTL)，用于覆盖全局默认的 TTL 值。
```typescript
@CacheTTL(10)
@UseInterceptors(CacheInterceptor)
@SubscribeMessage('events')
handleEvent(client: Client, data: string[]): Observable<string[]> {
return [];
}
```
> `@CacheTTL()`装饰器可以使用或不使用相应的装饰器`@CacheKey()`。
### 调整追踪
默认地，`Nest`使用请求 URL(在一个`HTTP`app 中)或者缓存键（在`websockets`和`microservices`应用中，通过`@CacheKey()`装饰器设置）来联系缓存记录和路径。然而，有时你可能想要根据不同要素设置追踪，例如`HTTP headers`(比如，确定合适`profile`路径的`Authorization`)。
为了达到这个目的，创建一个`CacheInterceptor`的子类并覆盖`trackBy()`方法。
```typescript
@Injectable()
class HttpCacheInterceptor extends CacheInterceptor {
trackBy(context: ExecutionContext): string | undefined {
return 'key';
}
}
```
### 不同的存储
服务在底层使用[缓存管理器(cache-manager)](https://github.com/BryanDonovan/node-cache-manager)。`cache-manager`包支持一个宽范围的可用存储，例如，[Redis](https://github.com/dabroek/node-cache-manager-redis-store)存储。一个完整的支持存储列表见[这里](https://github.com/BryanDonovan/node-cache-manager#store-engines)。要设置`Redis`存储，简单地将该包和相应的选项传递给`register()`方法。
> 译者注: 缓存方案库目前可选的有 `redis, fs, mongodb, memcached` 等。
```typescript
import * as redisStore from 'cache-manager-redis-store';
import { CacheModule, Module } from '@nestjs/common';
import { AppController } from './app.controller';
@Module({
imports: [
CacheModule.register({
store: redisStore,
host: 'localhost',
port: 6379,
}),
],
controllers: [AppController],
})
export class ApplicationModule {}
```
### 异步配置
你可能想异步传递模块选项来代替在编译时静态传递。在这种情况下，可以使用`registerAsync()`方法，它提供了不同的处理异步配置的方法。
一个方法是使用工厂函数：
```typescript
CacheModule.registerAsync({
useFactory: () => ({
ttl: 5,
}),
});
```
我们的工厂行为和其他异步模块工厂一样（它可以使用`inject`异步注入依赖）。
```typescript
CacheModule.registerAsync({
imports: [ConfigModule],
useFactory: async (configService: ConfigService) => ({
ttl: configService.getString('CACHE_TTL'),
}),
inject: [ConfigService],
});
```
此外，你也可以使用`useClass`方法：
```typescript
CacheModule.registerAsync({
useClass: CacheConfigService,
});
```
上述构造器将在`CacheModule`内部实例化`CacheConfigService`并用它来得到选项对象，`CacheConfigService`需要使用`CacheOptionsFactory`接口来提供配置选项：
```typescript
@Injectable()
class CacheConfigService implements CacheOptionsFactory {
createCacheOptions(): CacheModuleOptions {
return {
ttl: 5,
};
}
}
```
如果你希望使用在其他不同模块中导入的现有的配置提供者，使用`useExisting`语法：
```typescript
CacheModule.registerAsync({
imports: [ConfigModule],
useExisting: ConfigService,
});
```
这和`useClass`工作模式相同，但有一个根本区别——`CacheModule`将查找导入的模块来重用任何已经创建的`ConfigService`，以代替自己创实例化。
> `CacheModule#register` 和 `CacheModule#registerAsync` 和 `CacheOptionsFactory` 有一个可选的泛型（类型参数）来缩小特定于存储的配置选项，使其类型安全。
### 示例[#](#example)
[此处](https://github.com/nestjs/nest/tree/master/sample/20-cache)提供了一个工作示例。
- 介绍
- 概述
- 第一步
- 控制器
- 提供者
- 模块
- 中间件
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 自定义装饰器
- 基础知识
- 自定义提供者
- 异步提供者
- 动态模块
- 注入作用域
- 循环依赖
- 模块参考
- 懒加载模块
- 应用上下文
- 生命周期事件
- 跨平台
- 测试
- 技术
- 数据库
- Mongo
- 配置
- 验证
- 缓存
- 序列化
- 版本控制
- 定时任务
- 队列
- 日志
- Cookies
- 事件
- 压缩
- 文件上传
- 流式处理文件
- HTTP模块
- Session(会话)
- MVC
- 性能（Fastify）
- 服务器端事件发送
- 安全
- 认证（Authentication）
- 授权（Authorization）
- 加密和散列
- Helmet
- CORS（跨域请求）
- CSRF保护
- 限速
- GraphQL
- 快速开始
- 解析器（resolvers）
- 变更（Mutations）
- 订阅（Subscriptions）
- 标量（Scalars）
- 指令（directives）
- 接口（Interfaces）
- 联合类型
- 枚举（Enums）
- 字段中间件
- 映射类型
- 插件
- 复杂性
- 扩展
- CLI插件
- 生成SDL
- 其他功能
- 联合服务
- 迁移指南
- Websocket
- 网关
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 适配器
- 微服务
- 概述
- Redis
- MQTT
- NATS
- RabbitMQ
- Kafka
- gRPC
- 自定义传输器
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 独立应用
- Cli
- 概述
- 工作空间
- 库
- 用法
- 脚本
- Openapi
- 介绍
- 类型和参数
- 操作
- 安全
- 映射类型
- 装饰器
- CLI插件
- 其他特性
- 迁移指南
- 秘籍
- CRUD 生成器
- 热重载
- MikroORM
- TypeORM
- Mongoose
- 序列化
- 路由模块
- Swagger
- 健康检查
- CQRS
- 文档
- Prisma
- 静态服务
- Nest Commander
- 问答
- Serverless
- HTTP 适配器
- 全局路由前缀
- 混合应用
- HTTPS 和多服务器
- 请求生命周期
- 常见错误
- 实例
- 迁移指南
- 发现
- 谁在使用Nest？