Cachified使用教程

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库，旨在加速应用程序运行，通过缓存值来提升性能。它设计灵活，支持多种常见缓存适配器，确保缓存能够自动清理过期数据。目前，Cachified 提供了对Redis、Redis-JSON以及Cloudflare KV的支持。这使得开发者可以轻松集成强大而高效的缓存机制到他们的应用中，无论是处理复杂的数据库查询还是频繁的外部API调用。

项目快速启动

为了快速上手Cachified，首先确保你的环境中安装了Node.js。之后，可以通过npm或yarn来添加Cachified到你的项目中：

npm install --save @epic-web/cachified
# 或者，如果你偏好Yarn：
yarn add @epic-web/cachified

接下来，实现一个简单的缓存用户信息的例子：

import { cachified } from '@epic-web/cachified';

const cache = new Map();

async function getUserById(userId) {
    return cachified({
        ttl: 120_000,       // 缓存有效期两分钟
        staleWhileRevalidate: 300_000, // 允许缓存数据在五分钟内“变旧”但仍可被使用，同时后台更新缓存
        cacheKey: `user-${userId}`,
        async getFreshValue() {
            const response = await fetch(`https://jsonplaceholder.typicode.com/users/${userId}`);
            return response.json();
        },
    });
}

// 使用示例
(async () => {
    console.log(await getUserById(1)); // 首次调用将请求网络数据并缓存结果
})();

这段代码展示了一个基本的缓存逻辑，其中用户的ID作为键值，缓存其相关信息，过期时间为两分钟。在缓存过期后的五分钟窗口期内，即使数据已不新鲜，也能立即返回旧数据，同时后台异步更新缓存。

应用案例和最佳实践

异步数据获取优化

在构建需要频繁访问慢速服务的应用时（比如远程API、数据库查询），Cachified通过Stale While Revalidate模式确保用户体验流畅，即便数据暂时不是最新的。利用这种方法，首次加载数据时，应用仍然保持响应性，后续访问则优先提供缓存数据，同时在后台刷新数据。

软清除策略

Cachified提供了软清除功能，允许数据在一定时间内依然可用，但不会被立即移除。这对于实现平滑的数据过渡非常有用，例如：

import { cachified, softPurge } from '@epic-web/cachified';

// ... 初始化cache和getUserById函数 ...

// 当需要更新某条数据但又不想影响当前使用者时
await softPurge({ cacheKey: 'user-1' });

// 即使之后立刻访问该数据，仍会返回之前缓存的内容，但在后台会发起新的请求以更新缓存。

典型生态项目

虽然直接提及的特定生态项目较少，Cachified因其通用性和适应性，广泛适用于任何需要缓存策略的Node.js应用程序。特别是在微服务架构、基于API的web应用或是需要高效处理重复数据请求的场景下，Cachified都能发挥关键作用。结合现有的缓存服务（如Redis、Cloudflare KV等），开发者可以构建出高性能、低延迟的应用环境。

---

以上就是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