使用MERN栈+Socket.io遇TypeError：无法读取undefined的room属性

我使用MERN栈结合Socket.io开发项目，连接Socket.io时能够获取到room id，但运行时抛出「无法读取undefined的room属性」错误。

代码片段 #

io.on("connection", socket => {
    // For Users in Room
    const { room } = socket.handshake.query;
    const { user } = addUser({ id: socket.id, room: room });
    if (room) {
        console.log(user) // This value is showing in console.
        socket.join(user.room); // But here's the error begins.
        // io.in(user.room).emit('allUsersData', {
        //     room: user.room,
        //     users: getUsersInRoom(user.room)
        // });
        // console.log(room)

    }
});

控制台输出 #

{ id: 'Z1u-V5zH_VAR1It0AAAC', room: "inv6))8mdb'odz8" }
undefined
F:\Programming\Repositories\my_share\server\server.js:26
        socket.join(user.room);
                         ^

TypeError: Cannot read properties of undefined (reading 'room')
    at Namespace.<anonymous> (F:\Programming\Repositories\my_share\server\server.js:26:26)
    at Namespace.emit (node:events:527:28)
    at Namespace.emitReserved (F:\Programming\Repositories\my_share\server\node_modules\socket.io\dist\typed-events.js:56:22)

原因分析与解决方案 #

从控制台输出能看到，user有一次输出了具体值，但紧接着出现了undefined，说明addUser函数并非每次都能返回包含user属性的对象，导致后续访问user.room时触发报错。

解决步骤： #

1. 检查addUser函数实现：确保该函数在添加用户成功时返回{ user: ... }，失败时返回明确的错误对象（比如{ error: "添加失败原因" }），避免返回undefined或不包含user的结构。
2. 增加存在性校验：在访问user.room前，先确认user是否存在，避免直接访问属性报错：

   io.on("connection", socket => {
       const { room } = socket.handshake.query;
       const result = addUser({ id: socket.id, room: room });
       // 同时校验room和user的存在性
       if (room && result.user) {
           console.log(result.user);
           socket.join(result.user.room);
           // 恢复后续业务逻辑
           // io.in(result.user.room).emit('allUsersData', {
           //     room: result.user.room,
           //     users: getUsersInRoom(result.user.room)
           // });
       } else {
           // 处理异常情况，比如打印错误信息
           console.error("用户添加失败或room参数无效", result?.error);
       }
   });
   

3. 排查重复连接或参数缺失：控制台出现两次输出，可能是客户端重复触发连接事件，或者部分连接未携带room参数。需要确保前端连接Socket.io时，始终正确传递room查询参数。

内容的提问来源于stack exchange，提问作者Fgr Reloaded