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

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

版本：6\.0\.1
npm 元数据更新时间：2025-04-14T15:15:57.697Z
中文译文更新时间：2026-11-08T22:57:02.405Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：13.6 kB，3 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>= 7\.6\.0
- 运行依赖：5 个
- 首次发布：2024-01-08T02:41:34.215Z
- 最新版本发布：2025-04-14T15:15:57.521Z
- 近 30 天下载量：5462（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

Koa 的静态缓存

## 安装

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

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

## README

# Koa 静态缓存

[![NPM version](https://img.shields.io/npm/v/koa-static-cache.svg?style=flat-square)](https://npmjs.org/package/koa-static-cache) [![build status](https://img.shields.io/travis/koajs/static-cache.svg?style=flat-square)](https://travis-ci.org/koajs/static-cache) [![Test coverage](https://img.shields.io/coveralls/koajs/static-cache.svg?style=flat-square)](https://coveralls.io/r/koajs/static-cache?branch=master) [![David deps](https://img.shields.io/david/koajs/static-cache.svg?style=flat-square)](https://david-dm.org/koajs/static-cache)

Koa的静态服务器.

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

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

## 安装

```js
$ npm install koa-static-cache
```

## API 密码

### 静态缓存( dir \[, 选项\] \[, 文件\])

```js
var path = require('path')
var staticCache = require('koa-static-cache')

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

-   `dir` (str) - 您想要服务的目录,优先级比 `options.dir`。 。 。 .
-   `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) - 可选文件对象. 见下文.
-   `files` (obj) - 可选文件对象. 见下文.

### 别名

例如,如果您有此异名对象:

```js
{
  '/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
var files = {}

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

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

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

#### 编辑文件对象

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

```js
var 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
var LRU = require('lru-cache')
var files = new LRU({ max: 1000 })

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

## 许可证

《麻省理工学院许可证》

版权 (c) 2013 Jonathan Ong [我@jongleberry.com (英语)](mailto:me@jongleberry.com)

特此免费准许任何人获得副本 ,用于处理 在软件中不受限制,包括不受限制的权利 使用、复制、修改、合并、出版、分发、分许可证和/或出售 软件的复制件,并允许该软件所针对的人 满足下列条件:

上述版权通知和本许可通知应列入 软件的所有副本或大部分.

软件是提供的"AS IS", 没有任何的恐惧, EXPRESS OR ,包括但不限制于雇佣军的保障, 特别目的和非目的的证明。 绝对不会 B. 任何索赔、索赔或其他索赔的索赔人或 责任,在契约、契约或其他行为中,产生于, 或与溶剂或溶剂的使用或 软件.

## 常见问题

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

Koa 的静态缓存

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

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

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

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cabloy\_\_koa-static-cache 是否存在。

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

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

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

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

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

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

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

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