# @eggjs/koa-static-cache 中文文档

规范地址：https://npmcn.com/package/%40eggjs/koa-static-cache/

版本：7\.1\.0
npm 元数据更新时间：2026-10-07T08:18:30.849Z
中文译文更新时间：2026-11-13T09:58:53.515Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40eggjs/koa-static-cache
原文对照：https://npmcn.com/package/%40eggjs/koa-static-cache/?lang=original
项目主页：https://github.com/eggjs/egg/tree/next/packages/koa-static-cache
源码仓库：https://github.com/eggjs/egg

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：15.7 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：4 个
- 首次发布：2025-01-12T14:06:43.454Z
- 最新版本发布：2026-10-07T08:18:28.645Z
- 近 30 天下载量：4991（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：59（近 12 个月 36 个）

## 中文简介

Koa 的静态缓存中间软件

## 安装

```sh
npm install @eggjs/koa-static-cache
```

也可以使用：`pnpm add @eggjs/koa-static-cache`、`yarn add @eggjs/koa-static-cache`、`bun add @eggjs/koa-static-cache`

## README

# 鸡蛋/可口-静态-缓存

[![NPM version](https://img.shields.io/npm/v/@eggjs/koa-static-cache.svg?style=flat-square)](https://npmjs.org/package/@eggjs/koa-static-cache) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/koa-static-cache/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/koa-static-cache) [![npm download](https://img.shields.io/npm/dm/@eggjs/koa-static-cache.svg?style=flat-square)](https://npmjs.org/package/@eggjs/koa-static-cache) [![Node.js Version](https://img.shields.io/node/v/@eggjs/koa-static-cache.svg?style=flat)](https://nodejs.org/en/download/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com/)

静态缓存中间软件为可口.

本图书馆与其它图书馆如: [静态](https://github.com/koajs/static)数字 :

-   没有目录或 `index.html` 支助.
-   您可以选择将数据存储在内存中 - 它默认会流出 .
-   初始化时切换资产 - 您需要重新启动更新资产的进程 。 (可以用选项关闭 。 preload = false)
-   使用MD5散列总和作为ETag.
-   用途 `.gz` 如果在磁盘上显示文件, 如 nginx gzip static 模块

> 从 [https://github.com/koajs/ static-cache 页面存档备份,存于互联网档案馆](https://github.com/koajs/static-cache),与 TypeScript 重构,以支持共同JS和无害环境管理.

## 安装

```bash
npm install @eggjs/koa-static-cache
```

## API 密码

### 静态缓存( \[选项\])

```js
const path = require('path');
const { staticCache } = require('@eggjs/koa-static-cache');

app.use(
  staticCache(path.join(__dirname, 'public'), {
    maxAge: 365 * 24 * 60 * 60,
  }),
);
```

-   `options.dir` (str) - 您想要服务的目录, 默认为 `process.cwd`。 。 。 .
-   `options.maxAge` (int) - 文件的缓存控制最大年龄, `0` 默认.
-   `options.cacheControl` (str) - 可选缓存控制头. 覆盖 `options.maxAge`。 。 。 .
-   `options.buffer` (bool) - 将文件存储在内存中,而不是在每个请求中从文件系统流出.
-   `options.gzip` (bool) - 当请求的接受-编码包括gzip时,文件会被gzip压缩.
-   `options.usePrecompiledGzip` (bool) - 尝试使用 gzip 文件, 从磁盘中装入, 如 nginx gzip static
-   `options.alias` (obj) - 异名对象地图. 见下文.
-   `options.prefix` (str) - 您想要添加的 url 前缀, 默认为 `''`。 。 。 .
-   `options.dynamic` (bool) - 在初始化时没有缓存的动态负载文件.
-   `options.filter` (函数 QQ 阵列) - 过滤文件在 init dir, 例如 - 跳过非构建( source) 文件 。 如果数组设置 - 只允许列出文件
-   `options.preload` (bool) - 在初始化或不初始化时缓存资产,默认为 `true`总是与 `options.dynamic`。 。 。 .
-   `options.files` (obj) - 可选文件对象. 见下文.

### 别名

比如,如果你有这个 `alias` 对象 :

```js
const options = {
  alias: {
    '/favicon.png': '/favicon-32.png',
  },
};
```

然后请求 `/favicon.png` 将实际返回 `/favicon-32.png` 没有方向什么的. 这在服役时特别重要 [图像](https://github.com/audreyr/favicon-cheat-sheet) 因为你不想存储重复的图像.

### 文件

您可以通过可选文件对象. 这样你就可以做两件事:

#### 将目录合并为一个中间软件

而不是做:

```js
app.use(staticCache('/public/js'));
app.use(staticCache('/public/css'));
```

你可以做到这一点:

```js
const files = {};

// Mount the middleware
app.use(staticCache('/public/js', {}, files));

// Add additional files
staticCache('/public/css', {}, files);
```

好处是,在堆栈中增加一个更少的功能, 以及做一个散列检查而不是两个.

#### 编辑文件对象

例如,如果您想要更改最大年龄 `/package.json`,可以做到以下几点:

```js
const files = {};

app.use(
  staticCache(
    '/public',
    {
      maxAge: 60 * 60 * 24 * 365,
    },
    files,
  ),
);

files['/package.json'].maxAge = 60 * 60 * 24 * 30;
```

#### 启用动态模式时使用 LRU 缓存来避免 OOM

您可以在一个有拖动方法的 lu 缓存实例中通过 : `get(key)` 财务报告和审定财务报表 `set(key, value)`。 。 。 .

```js
const LRU = require('lru-cache');
const files = new LRU({ max: 1000 });

app.use(
  staticCache({
    dir: '/public',
    dynamic: true,
    files,
  }),
);
```

## 许可证

[麻省理工学院](https://npmcn.com/package/%40eggjs/koa-static-cache/LICENSE)

## 贡献者

[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)

制造的 [贡献者-img](https://contrib.rocks/)。 。 。 .

## 常见问题

### @eggjs/koa-static-cache 是什么？

Koa 的静态缓存中间软件

### 如何安装 @eggjs/koa-static-cache？

在项目目录运行 npm install @eggjs/koa-static-cache，或使用 pnpm add / yarn add / bun add。

### @eggjs/koa-static-cache 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @eggjs/koa-static-cache 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @eggjs/koa-static-cache 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.18\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @eggjs/koa-static-cache 可以商用吗？

@eggjs/koa-static-cache 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @eggjs/koa-static-cache 的下载量有多少？

根据 npm 官方下载统计，@eggjs/koa-static-cache 在 2026/10/13 – 2026/11/11 这 30 天内被下载 4,991 次，日均约 166 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @eggjs/koa-static-cache 还在维护吗？

最新版本 7\.1\.0 发布于 2026/10/07（1 个月前）；至今共发布 59 个版本，其中过去 12 个月发布了 36 个；首次发布于 2025/01/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。