nginx反向代理，负载均衡和yeauty集成的websocket的使用

    被要求一个这样的需求：要求项目和websocket使用一个端口。经过一周激烈争论，领导终于同意可以可以开通一个端口，一个月了，端口还没有开。

正式环境已经通过此方法进行部署，没有问题。

前言

    因涉及到内外网安全问题，被要求使用nginx进行代理，不能直连。即对websocket做一个反向代理即可。

    项目信息：springboot(cloud等)，yeauty集成的websocket(推荐使用，实现非常方便)，nginx，websocket在线测试网站(百度搜有很多)

项目搭建

 

引入依赖

    <dependencies>
        <dependency>
            <groupId>org.yeauty</groupId>
            <artifactId>netty-websocket-spring-boot-starter</artifactId>
            <version>0.7.5</version>
        </dependency>
    </dependencies>

 

添加代码

    有两个文件，可以直接复制到项目中，如图：

 Websocket.java:

package com.example.springboottest.common.websocket;


import org.springframework.stereotype.Component;
import org.yeauty.annotation.*;
import org.yeauty.pojo.Session;

import java.util.ArrayList;
import java.util.List;

@Component
@ServerEndpoint(port = 9906,path = "/WebSocket")
public class WebSocket {

    /**
     * 存放所有在线的客户端
     */


    private static List<Session> clients = new ArrayList<>();

    @OnOpen
    public void onOpen(Session session) {
        System.out.println("open");
        System.out.println("remoteAddress" + session.remoteAddress());
        //将新用户存入在线的组
        clients.add(session);
        sendMessage("hello Word!");
    }

    /**
     * 客户端关闭
     *
     * @param session session
     */


    @OnClose
    public void onClose(Session session) {
        System.out.println(session.remoteAddress() + ":closeWebSocket");
    }

    /**
     * 发生错误
     *
     * @param throwable e
     */


    @OnError
    public void onError(Throwable throwable) {
        System.out.println("websocket:error");
        throwable.printStackTrace();
    }

    /**
     * 收到客户端发来消息
     *
     * @param message 消息对象
     */

    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println(message);
        sendMessage("hello Word!");
    }

    public void sendMessage(String message) {
        try {
            if (clients.size() > 0) {
                for (Session session : clients) {
                    session.sendText(message);
                }
            }

        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

WebSocketConfig.java:

package com.example.springboottest.common.websocket;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;
import org.yeauty.standard.ServerEndpointExporter;


@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

启动项目测试websocket

 

 

nginx代理

     NGINX从1.3版本开始支持WebSocket，其可以作为一个反向代理和为WebSocket程序做负载均衡。此博客不涉及内部原理等，放个干货。

反向代理

    先把我自己的nginx配置发出来：

#user  nobody;
worker_processes  1;

#error_log  logs/error.log;
#error_log  logs/error.log  notice;
#error_log  logs/error.log  info;

#pid        logs/nginx.pid;


events {
    worker_connections  1024;
}


http {
  map $http_upgrade $connection_upgrade {
    default upgrade;
    ''   close;
  }

  upstream websocket {
    #ip_hash;
    hash $remote_addr consistent;
    server localhost:9907;  
  }

# 以下配置是在server上下文中添加，location指用于websocket连接的path。

  server {
    listen       9908;
    server_name localhost;
    #access_log /var/log/nginx/yourdomain.log;

    location /WebSocket {
      root   html;
      index  index.html index.htm;
      proxy_pass http://websocket/WebSocket;
      proxy_connect_timeout 4s;                #配置点1
      proxy_read_timeout 60s;                  #配置点2，如果没效，可以考虑这个时间配置长一点
      proxy_send_timeout 12s;                  #配置点3

      proxy_set_header Host $host;
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

      proxy_http_version 1.1;
      proxy_set_header Upgrade $http_upgrade;
      proxy_set_header Connection "upgrade";
        }
    }
}

    代理端口为9908，坚挺的地址就是/WebSocket，下面测试一下：

 

 

 至此反向代理已经完成。

负载均衡

如果想做负载均衡，可以在upstream websocket {}中加一个server就可以了，比如复制一下项目，将websocket端口改为9907

@ServerEndpoint(port = 9907,path = "/WebSocket")
连上之后发送信息为hello world!2
sendMessage("hello Word!2");

 

  

然后连上反向代理的链接，连接之后发现连的是9906的链接，如图：

 

 

 此时我把9906断掉，再次连接时：

 

 此时遇到问题，当负载均衡时，9906断了之后，没有自动转为9907的链接。在客户端监听此链接，如果查实连接不上则进行重新链接，即可使用9907的服务。