Node.js的Koa2中如何使用Session完成登录功能？

2020.12.8 约 2615 字预计阅读 6 分钟

项目要用到登录注册，就需要使用到Cookie和Session来保持登录状态，于是就简单研究了一下

Cookie和Session的工作原理

前面已经专门发过一篇帖子记录Cookie和Session的工作原理了，不明白的小伙伴可以看看Cookie、Session是如何保持登录状态的？。

使用Koa的Session中间件

Koa是一个简洁的框架，把许多小功能都拆分成了中间件，用一个洋葱模型保证了中间件丰富的可拓展性，我们要使用Session来保持登录状态，就需要引用Session中间件。

安装Koa-Session中间件

npm install koa-session --save

如果需要使用TypeScript进行开发，则需要引入对应的TS类型声明

npm install @types/koa-session --save

配置Session

Koa-Session需要做一些配置：

const session_signed_key = ["some secret hurr"];  // 这个是配合signed属性的签名key
const session_config = {
    key: 'koa:sess', /**  cookie的key。 (默认是 koa:sess) */
    maxAge: 4000,   /**  session 过期时间，以毫秒ms为单位计算 。*/
    autoCommit: true, /** 自动提交到响应头。(默认是 true) */
    overwrite: true, /** 是否允许重写 。(默认是 true) */
    httpOnly: true, /** 是否设置HttpOnly，如果在Cookie中设置了"HttpOnly"属性，那么通过程序(JS脚本、Applet等)将无法读取到Cookie信息，这样能有效的防止XSS攻击。  (默认 true) */
    signed: true, /** 是否签名。(默认是 true) */
    rolling: true, /** 是否每次响应时刷新Session的有效期。(默认是 false) */
    renew: false, /** 是否在Session快过期时刷新Session的有效期。(默认是 false) */
};

我们需要关注这几个配置：

renew rolling 这两个都可以在用户访问的过程中刷新有效期，不至于让用户访问过程中Session过期成为未登录状态
signed 这个是对客户端Cookie的签名，也就是用一个特点的字符加密，保证客户端Cookie不会被伪造出来
httpOnly 打开这个使得通过程序(JS脚本、Applet等)无法读取Cookie，大大提高了安全性
maxAge 以ms为单位的过期时间

简单的使用

首先理一下思路

判断访问者的Session有没有过登录记录属性
如果有且值为true，则为已登录，否则为未登录
如果为已登录，则不执行判断，直接返回已登录，如果为未登录，则执行下一步登录验证
如果验证成功，则返回的登录成功，并且在它的session中记下登录属性为true，如果验证失败，则返回登录失败。

为了测试方便，以下用Get请求和一个固定的账号密码代替数据库查询，实际开发应该使用POST和数据库比对。同时为了测试方便，将过期时间设置为4000ms，便于快速看到Cookies过期，实际开发应该设置长一些，比如几小时甚至几天，取决于业务需求。

const Koa = require('koa');                               // 导入Koa
const Koa_Session = require('koa-session');   // 导入koa-session     
// 配置
const session_signed_key = ["some secret hurr"];  // 这个是配合signed属性的签名key
const session_config = {
    key: 'koa:sess', /**  cookie的key。 (默认是 koa:sess) */
    maxAge: 4000,   /**  session 过期时间，以毫秒ms为单位计算 。*/
    autoCommit: true, /** 自动提交到响应头。(默认是 true) */
    overwrite: true, /** 是否允许重写 。(默认是 true) */
    httpOnly: true, /** 是否设置HttpOnly，如果在Cookie中设置了"HttpOnly"属性，那么通过程序(JS脚本、Applet等)将无法读取到Cookie信息，这样能有效的防止XSS攻击。  (默认 true) */
    signed: true, /** 是否签名。(默认是 true) */
    rolling: true, /** 是否每次响应时刷新Session的有效期。(默认是 false) */
    renew: false, /** 是否在Session快过期时刷新Session的有效期。(默认是 false) */
};

// 实例化
const app = new Koa();
const session = Koa_Session(session_config, app)
app.keys = session_signed_key;

// 使用中间件，注意有先后顺序
app.use(session);

app.use(ctx => {
    const databaseUserName = "testSession";
    const databaseUserPasswd = "noDatabaseTest";
    // 对/favicon.ico网站图标请求忽略
    if (ctx.path === '/favicon.ico') return;

    if (!ctx.session.logged) {  // 如果登录属性为undefined或者false，对应未登录和登录失败
        // 设置登录属性为false
        ctx.session.logged = false;

        // 取请求url解析后的参数对象，方便比对
        // 如?nickname=post修改&passwd=123解析为{nickname:"post修改",passwd:"123"}
        let query = ctx.request.query;

        // 判断用户名密码是否为空
        if (query.nickname && query.passwd) {

            // 比对并分情况返回结果  
            if (databaseUserName == query.nickname) {  // 如果存在该用户名

                // 进行密码比对并返回结果 
                ctx.body = (databaseUserPasswd == query.passwd) ? "登录成功" : "用户名或密码错误";
                ctx.session.logged = true;
            } else {                    // 如果不存在该用户名                                           //  如果用户名不存在
                ctx.body = "用户名不存在";
            }
        } else {
            ctx.body = "用户名密码不能为空";
        }
    } else {
        ctx.body = "已登录";
    }

}
);

app.listen(3000);
console.log("Koa运行在：http://127.0.0.1:3000");