介绍

一个 Koa.js 的 SESSION 的中间件

安装

npm install koa-session

例子

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

app.keys = ['some secret hurr'];

const CONFIG = {
  key: 'koa:sess',   //cookie key (default is koa:sess)
  maxAge: 86400000,  // cookie的过期时间 maxAge in ms (default is 1 days)
  overwrite: true,   //是否可以overwrite    (默认default true)
  httpOnly: true,    //cookie是否只有服务器端可以访问 httpOnly or not (default true)
  signed: true,      //签名默认true
  rolling: false,    //在每次请求时强行设置cookie，这将重置cookie过期时间（默认：false）
  renew: false,     //(boolean) renew session when session is nearly expired
};

app.use(session(CONFIG, app));
// or if you prefer all default config, just use => app.use(session(app));

app.use(ctx => {
 let n = ctx.session.views || 0;
 ctx.session.views = ++n;
 ctx.body = n + ' views';
});

app.listen(3000);
console.log('listening on port 3000');

API

设置

ctx.session.userId = "1";

获取

ctx.session.userId

销毁

this.session = null;

官方文档：

https://github.com/koajs/session#readme

修改时间 2021-12-15