Socket.IO+ExpressJS+Nginx多API自定义路径配置难题

在单台VPS上部署多个API并通过Nginx反向代理，期望远程访问路径为[myhost].com/apps/app1/api、[myhost].com/apps/app2/api，对应本地Express服务的localhost:[app1 port]、localhost:[app2 port]。目前Express服务正常，但Socket.IO遇到路径矛盾：

• 设置path: "/apps/app1/api/socket.io"时，远程能通过[myhost].com/apps/app1/api/socket.io访问，但本地必须走localhost:[app1 port]/apps/app1/api/socket.io，不符合预期
• 不设置path属性，本地能正常用localhost:[app1 port]/socket.io访问，但远程无法连接Socket.IO

需求：保留远程访问路径的同时，让本地Socket.IO路径简化为localhost:[app1 port]/socket.io

现有配置 #

Express路径映射 #

• 远程：[myhost].com/apps/app1/api → 本地：localhost:[app1 port]
• 远程：[myhost].com/apps/app2/api → 本地：localhost:[app2 port]

Socket.IO当前配置 #

const ioServer = new socketIo.Server(httpServer, {
  .....
  path: "/apps/app1/api/socket.io", // 该属性导致本地路径冗余
});

Nginx当前配置片段 #

......
location /apps {
  index _;
  autoindex on;

  location /apps/app1/api/ {
    proxy_set_header    X-Forwarded-For  $proxy_add_x_forwarded_for;
    proxy_set_header    Host             $http_host;
    proxy_pass          http://localhost:[app1 port];
    proxy_http_version  1.1;
    proxy_set_header    Upgrade          $http_upgrade;
    proxy_set_header    Connection       "upgrade";
  }
  location /apps/app1 {
    index index.html;
  }
  ....

核心思路：让Nginx负责路径转换，Socket.IO仅使用本地简洁路径，远程的长路径由Nginx映射到本地短路径。

1. 修改Socket.IO配置 #

移除path属性（默认值就是/socket.io，无需额外设置）：

const ioServer = new socketIo.Server(httpServer, {
  .....
  // 删掉path配置，或显式写path: "/socket.io"（效果一致）
});

修改后本地即可通过localhost:[app1 port]/socket.io直接访问Socket.IO服务。

2. 修改Nginx配置 #

新增一个专门匹配Socket.IO请求的location规则，优先处理远程路径到本地路径的映射：

......
location /apps {
  index _;
  autoindex on;

  # 优先匹配Socket.IO请求，重写路径
  location /apps/app1/api/socket.io {
    proxy_set_header    X-Forwarded-For  $proxy_add_x_forwarded_for;
    proxy_set_header    Host             $http_host;
    proxy_pass          http://localhost:[app1 port]/socket.io;
    proxy_http_version  1.1;
    proxy_set_header    Upgrade          $http_upgrade;
    proxy_set_header    Connection       "upgrade";
  }

  # 处理普通API请求
  location /apps/app1/api/ {
    proxy_set_header    X-Forwarded-For  $proxy_add_x_forwarded_for;
    proxy_set_header    Host             $http_host;
    proxy_pass          http://localhost:[app1 port];
    proxy_http_version  1.1;
    proxy_set_header    Upgrade          $http_upgrade;
    proxy_set_header    Connection       "upgrade";
  }

  location /apps/app1 {
    index index.html;
  }
  ....

配置说明 #

• 新增的location /apps/app1/api/socket.io会优先捕获远程Socket.IO请求，直接转发到本地服务的/socket.io路径
• 原有的location /apps/app1/api/继续处理普通API请求，保持原有映射逻辑

app2的配置可复制上述逻辑，替换对应的路径和端口即可。

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