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的服務。