巧用Nginx反向代理Nodejs的socket并开启wss/https服务

这里主要描述Nginx这边的设置,后端socket业务代码各不相同。socket监听端口我们假设你用的是3000端口,那么在Nginx设置反向代理并开启https/wss方法如下:

1、在宝塔面板内安装Nginx1.18以上版本(能装新版本尽量不要用太老的版本,太老的版本不支持socket反向代理)

2、解析一个二级域名到你的云服务器,然后用Nginx新建一个网站绑定好域名,在浏览器能正常访问到类似一下的页面:

巧用Nginx反向代理Nodejs的socket并开启wss/https服务_第1张图片
wss.abc.com

3、在开启反向代理之前,必须先申请免费的ssl证书,开启https。

巧用Nginx反向代理Nodejs的socket并开启wss/https服务_第2张图片
利用宝塔面板申请ssl证书
巧用Nginx反向代理Nodejs的socket并开启wss/https服务_第3张图片
自动申请并部署证书
巧用Nginx反向代理Nodejs的socket并开启wss/https服务_第4张图片
部署证书成功

证书自动部署成功后,右上角有个强制HTTPS的开关,开启后浏览器http方式访问会强制跳转到https上。
4、nodejs下正常写一个监听3000端口的http服务,我图方便用的是express+socket.io:

//app.js代码如下:
const express = require('express');
const app = express();
const server  = require('http').createServer(app);    //开启一个http服务
const io = require('socket.io')(server, {transports: ['websocket', 'polling']});    //将socket.io以websocket长连接方式挂载到server的http服务上

//访客端建立链接(握手成功)后的业务写在io.on里
io.on('connection', function (socket) {   
    /*这里需要爬个坑,因为我们是通过Nginx反向代理的方式与访客端建立socket长连接的,
      在socket里拿到的只能是127.0.0.1这样的IP,
      那么我们需要在Nginx配置socket代理的时候将访客端握手前发起的https请求的真实IP传进来,让socket能正常获取到。
      Nginx配置socket代理的代码我后面再描述,这里先写个获取真实IP的方法:
    */

    // 获取访客端真实的IP 拿到访客端IP可以做定位查询,记录访问轨迹等等用途。
    var ip = socket.handshake.headers["x-real-ip"];   

    // 将访客真实IP发送给访客端
    socket.emit('ip', ip);   

    // 获取访客端握手时传来的abc参数
     var abc = socket.handshake.query.abc; 
   
    // 将abc参数发送给访客端   
    socket.emit('query', abc);   

    /*
        其他业务代码省略几万字符......
    */

    // 'msg'类型的访客消息 触发的事件
    socket.on('msg', function(msg){   
        console.log(msg)
    });

    // 访客端断开链接触发的事件
    socket.on('disconnect',async function(){   
        console.log(socket.id)
    });

});

let port = 3000;
// 监听3000端口,提供http服务
server.listen(port, function(){
    console.log('app启动成功! 使用端口:'+port);
});
//app.js end

5、配置Nginx反向代理https/wss

巧用Nginx反向代理Nodejs的socket并开启wss/https服务_第5张图片
添加反向代理

在刚才我们配置ssl认证书的设置界面选择下方的反向代理,然后把你要代理的url填进去,我们刚才app.js里面监听的是3000端口的http服务,所以这里填http://127.0.0.1:3000(这里是代理的本机3000端口),点击提交然后继续配置反向代理规则。


巧用Nginx反向代理Nodejs的socket并开启wss/https服务_第6张图片
找到配置文件内的反向代理规则

接下来点开配置文件,在右侧打开的一堆配置信息内找到 引用的反向代理规则路径,如图阴影选择起来的内容,域名跟自己的域名有变化。
最后一步,把找到的引用规则替换成如下内容:

#引用反向代理规则,注释后配置的反向代理将无效
location /
        {
            proxy_pass http://127.0.0.1:3000;
            proxy_set_header Host $host;
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
            proxy_set_header  X-Real-IP  $remote_addr;
        }

划重点:proxy_set_header  X-Real-IP  $remote_addr; 这个就是传递给socket的访客真实请求IP

巧用Nginx反向代理Nodejs的socket并开启wss/https服务_第7张图片
修改方向代理规则

点击保存,Nginx反向代理socket设置完毕。去启动app.js 测试把,另外访客端建立建立socket链接的代码如下:

//user.js   在html引用这段js代码前需要先在html引用https://lib.baomitu.com/socket.io/3.1.1/socket.io.js这个外部socket.io客服端,不然你建立下面链接会报错。

// 初始化websocket,连接服务端
//var socket = io("wss://127.0.0.1",{"transports":["websocket","polling"]}); 默认wss://协议websocket方式请求握手

// 如果想要在访客端发起握手时,向后端提交abc参数,就用https://协议建立链接    后端在soket建立链接后可以直接拿到访客端传递的abc参数
var socket = io("https://127.0.0.1",{"transports":["websocket","polling"],"force new connection": true,    "query": "abc=123" });

socket.heartbeatTimeout = 28000;    // 心跳检测时间28秒

socket.on("ip", function(data){            // 监听"ip"类型的消息事件
    console.log(data)
    socket.emit("msg", "我是访客");    // 向服务器发送消息
});

socket.on("query", function(data){     // 监听"query"类型的消息
    localStorage.abc=data;                  // 将接收到的数据缓存到本地浏览器
});

你可能感兴趣的:(巧用Nginx反向代理Nodejs的socket并开启wss/https服务)