Koa 中如何使用 koa-session 中间件？

推荐答案

在 Koa 中使用 koa-session 中间件的步骤如下：

1. 安装 koa-session 中间件：

   npm install koa-session

2. 在 Koa 应用中引入并使用 koa-session 中间件：

   // www.javascriptcn.com code example
   const Koa = require('koa');
   const session = require('koa-session');
   
   const app = new Koa();
   
   // 设置 session 的密钥
   app.keys = ['your-secret-key'];
   
   // 配置 session
   const CONFIG = {
     key: 'koa:sess', // cookie key (default is koa:sess)
     maxAge: 86400000, // session 过期时间 (1 天)
     overwrite: true, // 是否可以覆盖 (默认 true)
     httpOnly: true, // 是否仅通过 HTTP 访问 (默认 true)
     signed: true, // 是否签名 (默认 true)
     rolling: false, // 是否在每次请求时重置过期时间 (默认 false)
     renew: false, // 是否在 session 快过期时自动续期 (默认 false)
   };
   
   // 使用 session 中间件
   app.use(session(CONFIG, app));
   
   // 示例路由
   app.use(async (ctx) => {
     if (ctx.path === '/login') {
       ctx.session.user = { name: 'John Doe' };
       ctx.body = 'Logged in';
     } else if (ctx.path === '/logout') {
       ctx.session = null;
       ctx.body = 'Logged out';
     } else {
       ctx.body = `Hello ${ctx.session.user ? ctx.session.user.name : 'Guest'}`;
     }
   });
   
   app.listen(3000, () => {
     console.log('Server running on http://localhost:3000');
   });

本题详细解读

1. 安装 koa-session

首先需要通过 npm 安装 koa-session 中间件。这个中间件用于在 Koa 应用中管理 session。

npm install koa-session

2. 引入并使用 koa-session

在 Koa 应用中引入 koa-session 中间件，并配置 session 的相关参数。app.keys 是用于签名的密钥数组，可以设置一个或多个密钥。

const Koa = require('koa');
const session = require('koa-session');

const app = new Koa();

app.keys = ['your-secret-key'];

3. 配置 session

koa-session 中间件允许你通过配置对象来定制 session 的行为。常见的配置项包括：

• key: cookie 的名称，默认是 koa:sess。
• maxAge: session 的最大存活时间，单位是毫秒。
• overwrite: 是否允许覆盖 session，默认是 true。
• httpOnly: 是否仅通过 HTTP 访问 session，默认是 true。
• signed: 是否对 session 进行签名，默认是 true。
• rolling: 是否在每次请求时重置 session 的过期时间，默认是 false。
• renew: 是否在 session 快过期时自动续期，默认是 false。

// www.javascriptcn.com code example
const CONFIG = {
  key: 'koa:sess',
  maxAge: 86400000,
  overwrite: true,
  httpOnly: true,
  signed: true,
  rolling: false,
  renew: false,
};

app.use(session(CONFIG, app));

4. 使用 session

在路由处理函数中，可以通过 ctx.session 来访问和操作 session。例如，可以在登录时设置 session，在登出时销毁 session。

// www.javascriptcn.com code example
app.use(async (ctx) => {
  if (ctx.path === '/login') {
    ctx.session.user = { name: 'John Doe' };
    ctx.body = 'Logged in';
  } else if (ctx.path === '/logout') {
    ctx.session = null;
    ctx.body = 'Logged out';
  } else {
    ctx.body = `Hello ${ctx.session.user ? ctx.session.user.name : 'Guest'}`;
  }
});

5. 启动应用

最后，启动 Koa 应用并监听端口。

app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

通过以上步骤，你可以在 Koa 应用中成功使用 koa-session 中间件来管理 session。