开源项目Cachified常见问题解决方案-CSDN博客

开源项目Cachified常见问题解决方案

cachified 🤑 wrap virtually everything that can store by key to act as cache with ttl/max-age, stale-while-validate, parallel fetch protection and type-safety support 项目地址: https://gitcode.com/gh_mirrors/ca/cachified

Cachified是一个开源项目，旨在帮助开发者通过一个简单的API来缓存数据，以提高应用性能。该项目主要使用TypeScript编程语言，并提供了类型安全的接口。

1. 项目基础介绍

Cachified允许开发者将几乎任何可以通过键存储的数据包装成具有过期时间的缓存（time-to-live, ttl）、支持缓存值验证、批处理和类型安全的缓存。它提供了一种简单的方式来管理缓存数据，包括缓存的有效期、数据验证和并行获取保护等。

2. 新手常见问题及解决步骤

问题一：如何安装Cachified

问题描述：新手可能不清楚如何正确安装Cachified。

解决步骤：

打开命令行工具。

使用npm或yarn进行安装。

npm install @epic-web/cachified
# 或者
yarn add @epic-web/cachified

确保安装成功，可以通过在命令行中运行npm list @epic-web/cachified或yarn list @epic-web/cachified来检查。

问题二：如何使用Cachified创建一个缓存实例

问题描述：新手可能不知道如何创建和使用Cachified的缓存实例。

解决步骤：

在项目中引入Cachified。

import { LRUCache } from 'lru-cache';
import { cachified, CacheEntry, Cache, totalTtl } from '@epic-web/cachified';

创建一个LRUCache实例（注意：LRUCache不是Cachified的一部分，需要单独安装）。
```
const lruInstance = new LRUCache<string, CacheEntry>({ max: 1000 });
```

使用LRUCache实例创建一个Cachified的缓存实例。

const lru: Cache = {
  set(key, value) {
    const ttl = totalTtl(value, metadata);
    return lruInstance.set(key, { ttl: ttl === Infinity ? undefined : ttl, start: value, metadata, createdTime: Date.now() });
  },
  get(key) {
    return lruInstance.get(key);
  },
  delete(key) {
    return lruInstance.delete(key);
  }
};

问题三：如何使用Cachified缓存API调用结果

问题描述：新手可能不清楚如何将API调用结果缓存起来。

解决步骤：

定义一个函数，使用Cachified来缓存API调用结果。

function getUserById(userId: number) {
  return cachified({
    key: `user-${userId}`,
    cache: lru,
    async getFreshValue() {
      const response = await fetch(`https://jsonplaceholder.typicode.com/users/${userId}`);
      return response.json();
    },
    // 缓存有效期为5分钟
    ttl: 300_000
  });
}