Cursor rule

1---
2description: 缓存(Cache)
3globs: 
4---
5# 缓存
6 
7为了方便开发者进行缓存操作的组件，它有利于改善项目的性能。它为我们提供了一个数据中心以便进行高效的数据访问。
8 
9:::
10 
11## 使用
12 
13```ts
14import { InjectClient, Provide } from '@midwayjs/core';
15import { CachingFactory, MidwayCache } from '@midwayjs/cache-manager';
16 
17@Provide()
18export class UserService {
19 
20  @InjectClient(CachingFactory, 'default')
21  cache: MidwayCache;
22 
23  async invoke(name: string, value: string) {
24    // 设置缓存
25    await this.cache.set(name, value);
26    // 获取缓存
27    const data = await this.cache.get(name);
28    // ...
29  }
30}
31```
32 
33## 换成 Redis (v7.1 版本)
34 
35安装依赖，具体可以查看@midwayjs cache
36 
37```bash
38pnpm i cache-manager-ioredis-yet --save
39```
40 
41`src/config/config.default.ts`
42 
43```ts
44import { CoolFileConfig, MODETYPE } from "@cool-midway/file";
45import { MidwayConfig } from "@midwayjs/core";
46// redis缓存
47import { redisStore } from "cache-manager-ioredis-yet";
48 
49export default {
50  // Redis缓存
51  cacheManager: {
52    clients: {
53      default: {
54        store: redisStore,
55        options: {
56          port: 6379,
57          host: "127.0.0.1",
58          password: "",
59          ttl: 0,
60          db: 0,
61        },
62      },
63    },
64  },
65} as unknown as MidwayConfig;
66```
67 
68## 换成 Redis (以往版本)
69 
70```bash
71pnpm i cache-manager-ioredis --save
72```
73 
74`src/config/config.default.ts`
75 
76```ts
77import { CoolFileConfig, MODETYPE } from "@cool-midway/file";
78import { MidwayConfig } from "@midwayjs/core";
79// redis缓存
80import * as redisStore from "cache-manager-ioredis";
81 
82export default {
83  // Redis缓存
84  cache: {
85    store: redisStore,
86    options: {
87      port: 6379,
88      host: "127.0.0.1",
89      password: "",
90      db: 0,
91      keyPrefix: "cool:",
92      ttl: null,
93    },
94  },
95} as unknown as MidwayConfig;
96```
97 
98## 使用
99 
100`src/modules/demo/controller/open/cache.ts`
101 
102```ts
103import { DemoCacheService } from "../../service/cache";
104import { Inject, Post, Provide, Get, InjectClient } from "@midwayjs/core";
105import { CoolController, BaseController } from "@cool-midway/core";
106import { CachingFactory, MidwayCache } from "@midwayjs/cache-manager";
107 
108/**
109 * 缓存
110 */
111@Provide()
112@CoolController()
113export class AppDemoCacheController extends BaseController {
114  @InjectClient(CachingFactory, "default")
115  midwayCache: MidwayCache;
116 
117  @Inject()
118  demoCacheService: DemoCacheService;
119 
120  /**
121   * 设置缓存
122   * @returns
123   */
124  @Post("/set")
125  async set() {
126    await this.midwayCache.set("a", 1);
127    // 缓存10秒
128    await this.midwayCache.set("a", 1, 10 * 1000);
129    return this.ok(await this.midwayCache.get("a"));
130  }
131 
132  /**
133   * 获得缓存
134   * @returns
135   */
136  @Get("/get")
137  async get() {
138    return this.ok(await this.demoCacheService.get());
139  }
140}
141```
142 
143## 方法缓存
144 
145有些业务场景，我们并不希望每次请求接口都需要操作数据库，如：今日推荐、上个月排行榜等，数据存储在 redis
146 
147框架提供了 `@CoolCache` 方法装饰器，方法设置缓存，让代码更优雅
148 
149`src/modules/demo/service/cache.ts`
150 
151```ts
152import { Provide } from "@midwayjs/core";
153import { CoolCache } from "@cool-midway/core";
154 
155/**
156 * 缓存
157 */
158@Provide()
159export class DemoCacheService {
160  // 数据缓存5秒
161  @CoolCache(5000)
162  async get() {
163    console.log("执行方法");
164    return {
165      a: 1,
166      b: 2,
167    };
168  }
169}
170```
171 
172::: warning
173service 主要是处理业务逻辑，`@CoolCache`应该要在 service 中使用，不要在 controller 等其他位置使用
174:::
175