Node.js、ws 和 express-session : how to get session object from ws. upgradeReq

Question

我有一个基于 express、express-session 和 ws(用于 websocket 支持)构建的应用程序。

我已经使用这段代码来启用 session 中间件:

app.use(session({secret: 'mysecret',resave: true,saveUninitialized: true,cookie: {}}));

我可以在 get 处理程序中读取和保存 session 变量:

app.get('/', function (req, res) {
  res.send('Hello World!');
  console.log(req.session.test);
  req.session.test="OK";
  req.session.save();
});

(第一次打印“undefined”，第二次按预期打印“OK”)

现在我在同一个应用程序中也有一个由 express 处理的 websocket 服务器，我想在 ws.on("connection", ...) 和 ws.on("message",...)。

问题是没有对原始 req 对象的引用，只是对 upgradeReq 的引用，它是 websocket 连接处理程序的包装器。 检查此 upgradeReq，我可以在包含 session cookie 值的 ws.upgradeReq.headers.cookie 中找到 connect.sid。

wss.on('connection', function connection(ws) {
  var location = url.parse(ws.upgradeReq.url, true);
  console.log(ws.upgradeReq.headers.cookie);
  //....
});

在我看来，可以通过某种方式从中获取原始的 req.session。

我怎样才能做到这一点？

Answer 1

好的，我找到了一个未记录的方法来研究 express-session 的源代码。

首先你需要cookie和cookie-parser作为你的依赖。

所以，导入模块

var cookie = require('cookie');
var cookieParser = require('cookie-parser')

然后，诀窍是在有 websocket 握手时解码 ws“连接”事件处理程序中的签名 cookie。 首先，您需要从 cookie 中解码 connect.sid，即 session ID(仅当您使用 express-session 进行 session 管理时)

wss.on('connection', function connection(ws) {
    var cookies=cookie.parse(ws.upgradeReq.headers.cookie);
    var sid=cookieParser.signedCookie(cookies["connect.sid"],secret);
    ...

请注意， secret 与您在 express-session 中为签名设置的 secret 相同(即在 app.use(session({secret: secret, resave: true, saveUninitialized: true, cookie: {},商店:商店})); ) 此时你在 sid 中​​有 sessoinID，你想从 express-session 中获取 session 对象，它是从商店异步传递给你的(有很多，阅读文档，目前我只测试了express-session 的 MemoryStore)。

为了获得 session ，请在上面几行之后使用此代码

...
store.get(sid,function(err, ss){
        store.createSession(ws.upgradeReq,ss)
    });

回调函数将直接从存储中为您提供 session 对象 (ss)，但它是单独的且没有方法(只是反序列化的 JSON)。因此，出于这个原因，我们再次使用我们将 upgradeReq 和 ss 对象传递给的 store.createSession，这样我就有了一个 session 对象，它具有所有记录的方法(因此我也可以从 ws 回调修改 session )。

新 session 对象可用于:

ws.upgradeReq.session

注意: 在存储异步返回 ss 对象之前， session 对象不可用，因此最好在回调内完成 websocket 事件绑定(bind)(如 on('message',...)传递给 store.get。

这是完整的代码:

wss.on('connection', function connection(ws) {
    var location = url.parse(ws.upgradeReq.url, true);
    //get sessionID
    var cookies = cookie.parse(ws.upgradeReq.headers.cookie);
    var sid = cookieParser.signedCookie(cookies["connect.sid"], secret);
    //get the session object
    store.get(sid, function (err, ss) {
        //create the session object and append on upgradeReq
        store.createSession(ws.upgradeReq, ss)
        //setup websocket bindings
        ws.on('message', function incoming(message) {
            console.log('received: %s', message);
            //..........
        });

    });
});

那么，现在您可以同时使用 ws 和 express-session 来管理 session 数据。

希望对您有所帮助!