Jfinal 添加 Websocket 服务

1、环境

nginx + tomcat9 + jfinal

2、Nginx配置

项目中遇到websocket连接报404的问题,由于项目是有nginx的,首先检查nginx是否开启了websocket穿透。设置下面两行即可:
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

3、Maven依赖

<!-- WebSocket -->
<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-websocket-api</artifactId>
    <version>9.0.13</version>
    <scope>provided</scope>
</dependency>

检查jar包是否冲突。在开发环境中,我们在maven环境中开发,
引入了javax.websocket-api-1.1.jar这个jar包支持websocket,但是作用范围是provided的,表明该包只在编译和测试的时候用。

4、Jfinal配置处理器

@Override
public void configHandler(Handlers me) {
    me.add(new UrlSkipHandler("^/websocket", false));
}

5、WebSocketController

import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;

import com.jfinal.kit.LogKit;

/**
 * @ServerEndpoint 注解是一个类层次的注解,它的功能主要是将目前的类定义成一个websocket服务器端,
 * 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
 */
@ServerEndpoint("/websocket")
public class WebSocketController {
    //静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。
    private static int onlineCount = 0;

    //concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话,可以使用Map来存放,其中Key可以为用户标识
    private static CopyOnWriteArraySet<WebSocketController> webSocketSet = new CopyOnWriteArraySet<WebSocketController>();

    //与某个客户端的连接会话,需要通过它来给客户端发送数据
    private Session session;

    public static CopyOnWriteArraySet<WebSocketController> getWebSocketSet() {
		return webSocketSet;
	}

	public static void setWebSocketSet(CopyOnWriteArraySet<WebSocketController> webSocketSet) {
		WebSocketController.webSocketSet = webSocketSet;
	}

    /**
     * 连接建立成功调用的方法
     * @param session  可选的参数。session为与某个客户端的连接会话,需要通过它来给客户端发送数据
     */
    @OnOpen
    public void onOpen(Session session){
        this.session = session;
        webSocketSet.add(this);     //加入set中
        addOnlineCount();           //在线数加1
        System.out.println("WebSocket >> 有新连接加入!当前在线人数为 >> " + getOnlineCount());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(){
        webSocketSet.remove(this);  //从set中删除
        subOnlineCount();           //在线数减1
        System.out.println("WebSocket >> 有一连接关闭!当前在线人数为 >> " + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     * @param message 客户端发送过来的消息
     * @param session 可选的参数
     */
    @OnMessage
    public void onMessage(String message, Session session) {
    	if("ping".equals(message))
    		return;
    	System.out.println("WebSocket >> 来自客户端的消息 >> " + message);
        //群发消息
        for(WebSocketController item: webSocketSet){
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
                continue;
            }
        }
    }

    /**
     * 发生错误时调用
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error){
    	System.out.println("WebSocket >> 发生错误");
        error.printStackTrace();
    }

    /**
     * 这个方法与上面几个方法不一样。没有用注解,是根据自己需要添加的方法。
     * @param message
     * @throws IOException
     */
    public void sendMessage(String message) throws IOException{
        this.session.getBasicRemote().sendText(message);
        //this.session.getAsyncRemote().sendText(message);
    }

    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    public static synchronized void addOnlineCount() {
    	WebSocketController.onlineCount++;
    }

    public static synchronized void subOnlineCount() {
    	WebSocketController.onlineCount--;
    }
}

6、前端页面

<script>
	$(document).ready(function() {
		// 指定websocket路径
		var websocket = new WebSocket('ws://域名/websocket');
		websocket.onmessage = function(event) {
		    // 打印websocket信息
		    console.log(event.data);
		};
	});
</script>