# @eggjs/session 中文文档

规范地址：https://npmcn.com/package/%40eggjs/session/

版本：5\.1\.0
npm 元数据更新时间：2026-10-07T08:19:43.634Z
中文译文更新时间：2026-11-13T09:55:24.857Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：12.1 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>= 22\.18\.0
- 运行依赖：2 个
- peer 依赖：egg 4\.2\.0
- 首次发布：2025-01-19T09:54:31.039Z
- 最新版本发布：2026-10-07T08:19:43.296Z
- 近 30 天下载量：5041（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：54（近 12 个月 33 个）

## 中文简介

彩蛋会话插件

## 安装

```sh
npm install @eggjs/session
```

也可以使用：`pnpm add @eggjs/session`、`yarn add @eggjs/session`、`bun add @eggjs/session`

## README

# @eggjs/ 会话

[![NPM version](https://img.shields.io/npm/v/@eggjs/session.svg?style=flat-square)](https://npmjs.org/package/@eggjs/session) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/session/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/session) [![npm download](https://img.shields.io/npm/dm/@eggjs/session.svg?style=flat-square)](https://npmjs.org/package/@eggjs/session) [![Node.js Version](https://img.shields.io/node/v/@eggjs/session.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/) ![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/session)

彩蛋会话插件,基于 [科亚语会话](https://github.com/koajs/session)。 。 。 .

## 使用量

`session` 是默认启用的彩蛋内置插件.

```js
// {app_root}/config/plugin.js
exports.session = true; // enable by default
```

### 外部存储

蛋片段支持外部商店,可以将会话存储在redis,memcacked或其他数据库中.

例如,如果想要将会话存储在 redis 中,则必须:

1.  依赖性 [@eggjs/ redis (英语)](https://github.com/eggjs/egg/tree/next/plugins/redis)

```bash
npm i --save @eggjs/redis
```

2.  导入 `@eggjs/redis` 作为插件并设置配置

```js
// config/plugin.js
exports.redis = {
  enable: true,
  package: '@eggjs/redis',
};
```

```js
// config/config.default.js
exports.redis = {
  // your redis configurations
};
```

3.  用 redis 执行会话存储

```js
// app.js

module.exports = (app) => {
  // set redis session store
  // session store must have 3 methods
  // define sessionStore in `app.js` so you can access `app.redis`
  app.sessionStore = {
    async get(key) {
      const res = await app.redis.get(key);
      if (!res) return null;
      return JSON.parse(res);
    },

    async set(key, value, maxAge) {
      // maxAge not present means session cookies
      // we can't exactly know the maxAge and just set an appropriate value like one day
      if (!maxAge) maxAge = 24 * 60 * 60 * 1000;
      value = JSON.stringify(value);
      await app.redis.set(key, value, 'PX', maxAge);
    },

    async destroy(key) {
      await app.redis.del(key);
    },
  };

  // session store can be a session store class
  // app.sessionStore = class Store {
  //   constructor(app) {
  //     this.app = app;
  //   }
  //   async get() {}
  //   async set() {}
  //   async destroy() {}
  // };
};
```

一旦您使用外部会话商店,会话会话会强烈依赖于您的外部会话商店,如果您的外部会话商店下架,则无法访问会话. **仅在必要时使用外部会话存储, 避免将会话用作缓存, 保持会话的倾斜并用 cookie 存储 !**

## 配置

支持所有配置在 [科亚语会话](https://github.com/koajs/session)。 。 。 .

-   对数

```bash
Support not to print the session value when session event trigger log. Default to be true.
```

[查看默认配置](https://github.com/eggjs/egg/tree/next/plugins/session/src/config/config.default.ts)

## 问题和建议

请打开一个问题 [这里](https://github.com/eggjs/egg/issues)。 。 。 .

## 许可证

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

## 贡献者

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

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

## 常见问题

### @eggjs/session 是什么？

彩蛋会话插件

### 如何安装 @eggjs/session？

在项目目录运行 npm install @eggjs/session，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：egg（4\.2\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @eggjs/session 支持 TypeScript 吗？

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

### @eggjs/session 支持 ESM 还是 CommonJS？

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

### @eggjs/session 需要什么版本的 Node\.js？

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

### @eggjs/session 可以商用吗？

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

### @eggjs/session 的下载量有多少？

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

### @eggjs/session 还在维护吗？

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