koa-session模块

• koa-session模块

  • 下载

  • npm install koa-session --save
    

  • 配置

  • const session_signed_key = ["签名，可以理解为一个标识"];  // 这个是配合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) */
    };
    

  • 使用

  • // 导入Koa
    const Koa = require('koa');
    // 导入koa-session
    const Koa_Session = require('koa-session');      
    
    // 这个是配合signed属性的签名key
    const session_signed_key = ["some secret hurr"]; 
    // 配置
    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 = "zhang";
        const databaseUserPasswd = "123456";
    
        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, err => {
      !err && process.stdout.write('服务启动成功');
    });
    

  • 需要注意的是本地服务，post请求使用的地址必须和浏览器所运行的地址一致，不能出现127.0.0.1和localhost同时出现的情况，否则会被认为是两个地址，无法进行cookie的设置