Java WebSocket框架

引言

随着互联网和移动互联网的迅猛发展，实时通信成为了应用程序的一项重要能力。WebSocket作为一种在Web上实现双向通信的协议，极大地丰富了Web应用程序的交互方式。而在Java领域，也有许多优秀的WebSocket框架可供选择，本文将介绍其中几个主流的Java WebSocket框架。

1. Java WebSocket API

Java WebSocket API是Java EE 7规范中引入的原生WebSocket支持。借助Java WebSocket API，开发者可以很方便地创建WebSocket服务器和客户端。

API提供了javax.websocket包，其中包含了服务器端和客户端的接口和类。通过这些接口和类，我们可以实现WebSocket的基本功能，如建立连接、发送和接收消息、关闭连接等。

示例代码如下所示：

@ServerEndpoint("/chat")
public class ChatServer {
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Connected: " + session.getId());
    }

    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println("Message from " + session.getId() + ": " + message);
    }

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

上述代码是一个简单的WebSocket服务器示例。通过@ServerEndpoint注解标记类为WebSocket服务器，并且指定了WebSocket的URI路径。通过@OnOpen、@OnMessage和@OnClose注解，我们可以定义连接建立、接收消息和关闭连接时的处理逻辑。

Java WebSocket API是Java EE规范的一部分，因此在Java EE 7或更高版本中，API已经默认可用，无需额外的依赖。

2. Jetty WebSocket

Jetty是一款轻量级的Java Web服务器，同时也提供了功能丰富的WebSocket支持。

Jetty WebSocket提供了易于使用的API和函数式编程模型，使我们可以快速开发可扩展的WebSocket服务器应用程序。

示例代码如下所示：

import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.api.annotations.OnWebSocketConnect;
import org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage;
import org.eclipse.jetty.websocket.api.annotations.WebSocket;

@WebSocket
public class ChatHandler {
    @OnWebSocketConnect
    public void onConnect(Session session) {
        System.out.println("Connected: " + session.getRemoteAddress());
    }

    @OnWebSocketMessage
    public void onMessage(Session session, String message) {
        System.out.println("Message: " + message);
    }
}

上述代码是一个使用Jetty WebSocket的示例。通过@WebSocket注解标记类为WebSocket处理器，并且通过注解来定义连接建立和接收消息时的处理逻辑。

在使用Jetty WebSocket时，我们需要添加Jetty WebSocket依赖。我们可以通过Maven来管理依赖，添加以下依赖配置：

<dependency>
    <groupId>org.eclipse.jetty.websocket</groupId>
    <artifactId>javax-websocket-server-impl</artifactId>
    <version>9.4.35.v20201120</version>
</dependency>
<dependency>
    <groupId>org.eclipse.jetty.websocket</groupId>
    <artifactId>javax-websocket-client-impl</artifactId>
    <version>9.4.35.v20201120</version>
</dependency>

3. Netty WebSocket

Netty是一款高性能的网络应用程序框架，其提供了强大的异步和事件驱动的网络编程能力。Netty也提供了WebSocket支持，使我们可以通过简洁的API来实现WebSocket服务器和客户端。

示例代码如下所示：

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.http.HttpObjectAggregator;
import io.netty.handler.codec.http.HttpServerCodec;
import io.netty.handler.codec.http.websocketx.WebSocketFrameEncoder;
import io.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandler;

public class WebSocketServer {
    public static void main(String[] args) throws Exception {
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        try {
            ServerBootstrap server = new ServerBootstrap();
            server.group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .childHandler(new ChannelInitializer<SocketChannel>() {
                        @Override
                        protected void initChannel(SocketChannel ch) {
                            ChannelPipeline pipeline = ch.pipeline();
                            pipeline.addLast(new HttpServerCodec());
                            pipeline.addLast(new HttpObjectAggregator(65536));
                            pipeline.addLast(new WebSocketServerProtocolHandler("/websocket"));
                            pipeline.addLast(new WebSocketFrameEncoder());
                            pipeline.addLast(new ChatHandler());
                        }
                    });

            server.bind(8080).sync().channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }
}

上述代码是使用Netty WebSocket的简单服务器示例。通过构建ServerBootstrap实例，并设置相关的handler和参数，我们可以开启一个WebSocket服务器。

在使用Netty WebSocket时，我们需要添加Netty WebSocket依赖。我们可以通过Maven来管理依赖，添加以下依赖配置：

<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-all</artifactId>
    <version>4.1.53.Final</version>
</dependency>

4. Spring WebSocket

Spring WebSocket是Spring框架中的一部分，通过Spring WebSocket，我们可以很方便地集成WebSocket功能到Spring应用程序中。

示例代码如下所示：

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new ChatHandler(), "/chat").setAllowedOrigins("*");
    }
}

public class ChatHandler extends TextWebSocketHandler {
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) {
        System.out.println("Message: " + message.getPayload());
    }
}

上述代码是一个使用Spring WebSocket的示例。通过WebSocketConfigurer和WebSocketHandlerRegistry接口，我们可以轻松地注册并配置WebSocket处理器。

在使用Spring WebSocket时，我们需要添加Spring WebSocket依赖。我们可以通过Maven来管理依赖，添加以下依赖配置：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
    <version>2.4.0</version>
</dependency>

5. 基于Java WebSocket API的聊天应用

我们可以使用Java WebSocket API来构建一个简单的聊天室应用程序。下面是一个使用Java WebSocket API的聊天服务器示例：

@ServerEndpoint("/chat")
public class ChatServer {
    private static Set<Session> sessions = Collections.synchronizedSet(new HashSet<>());

    @OnOpen
    public void onOpen(Session session) {
        sessions.add(session);
        System.out.println("New connection: " + session.getId());
    }

    @OnMessage
    public void onMessage(String message, Session session) {
        sendMessageToAll("Message from " + session.getId() + ": " + message);
    }

    @OnClose
    public void onClose(Session session) {
        sessions.remove(session);
        System.out.println("Connection closed: " + session.getId());
    }

    private void sendMessageToAll(String message) {
        for (Session session : sessions) {
            try {
                session.getBasicRemote().sendText(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

上述代码定义了一个WebSocket服务器，用于处理聊天室中的消息。当有新的连接建立时，onOpen方法会被调用，将连接添加到会话列表中。当接收到消息时，onMessage方法会将该消息发送给所有连接。当连接关闭时，onClose方法会将该连接从会话列表中删除。

在浏览器中，我们可以使用JavaScript的WebSocket API来连接到该聊天服务器：

var socket = new WebSocket("ws://localhost:8080/chat");

socket.onopen = function() {
    console.log("Connected to server");
};

socket.onmessage = function(event) {
    console.log("Message received: " + event.data);
};

socket.onclose = function(event) {
    console.log("Connection closed");
};

function sendMessage() {
    var message = document.getElementById("message").value;
    socket.send(message);
    document.getElementById("message").value = "";
}

上述代码连接到聊天服务器，并在接收到新消息时打印在控制台上。通过sendMessage函数，我们可以将输入框中的消息发送给聊天服务器。

6. 基于Jetty WebSocket的实时股票行情应用

我们可以使用Jetty WebSocket来创建一个实时股票行情应用程序。下面是一个使用Jetty WebSocket的股票服务器示例：

import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.api.annotations.OnWebSocketConnect;
import org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage;
import org.eclipse.jetty.websocket.api.annotations.WebSocket;

import java.util.Random;

@WebSocket
public class StockHandler {
    private Session session;
    private Random random = new Random();

    @OnWebSocketConnect
    public void onConnect(Session session) {
        this.session = session;
        System.out.println("New connection: " + session.getRemoteAddress());

        Thread thread = new Thread(() -> {
            try {
                while (true) {
                    int price = random.nextInt(100);
                    session.getRemote().sendString(String.valueOf(price));
                    Thread.sleep(1000); // 每一秒发送一次股价
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        });
        thread.start();
    }

    @OnWebSocketMessage
    public void onMessage(String message) {
        // 不处理客户端发送的消息
    }
}

在上述代码中，onConnect方法在新连接建立时被调用。我们通过定时线程发送随机生成的股票价格，将其作为实时的股票行情数据。通过session.getRemote().sendString方法，我们将股票价格发送给客户端。

在浏览器中，我们可以使用JavaScript的WebSocket API来连接到股票服务器，并在接收到新的股票价格时进行处理。

var socket = new WebSocket("ws://localhost:8080/stock");

socket.onopen = function() {
    console.log("Connected to server");
};

socket.onmessage = function(event) {
    var price = event.data;
    console.log("Stock price: " + price);
    // 在页面上更新股票价格
    document.getElementById("stockPrice").innerText = price;
};

socket.onclose = function(event) {
    console.log("Connection closed");
};

上述代码将接收到的股票价格打印在控制台上，并将其更新到页面上显示。

7. 基于Spring WebSocket的实时聊天室应用

我们可以使用Spring WebSocket来构建一个实时的聊天室应用程序。下面是一个使用Spring WebSocket的聊天服务器示例：

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new ChatHandler(), "/chat").setAllowedOrigins("*");
    }
}

public class ChatHandler extends TextWebSocketHandler {
    private List<WebSocketSession> sessions = new CopyOnWriteArrayList<>();

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        System.out.println("New connection: " + session.getRemoteAddress());
        sessions.add(session);
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        System.out.println("Message: " + message.getPayloadAsString());

        for (WebSocketSession s : sessions) {
            s.sendMessage(message);
        }
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        System.out.println("Connection closed: " + session.getRemoteAddress());
        sessions.remove(session);
    }
}

在上述代码中，ChatHandler被定义为WebSocket处理器，用于处理聊天室消息。在连接建立时，afterConnectionEstablished方法会被调用，并将新的会话添加到会话列表中。当接收到消息时，handleTextMessage方法会将该消息发送给所有的会话。当连接关闭时，afterConnectionClosed方法会将该会话从会话列表中删除。

在浏览器中，我们可以使用JavaScript的WebSocket API来连接到聊天服务器，并在接收到新消息时进行处理。

var socket = new WebSocket("ws://localhost:8080/chat");

socket.onopen = function() {
    console.log("Connected to server");
};

socket.onmessage = function(event) {
    var message = event.data;
    console.log("Message received: " + message);
    // 在页面上展示消息
    var div = document.createElement("div");
    div.innerText = message;
    document.getElementById("chatMessages").appendChild(div);
};

socket.onclose = function(event) {
    console.log("Connection closed");
};

function sendMessage() {
    var message = document.getElementById("message").value;
    socket.send(message);
    document.getElementById("message").value = "";
}

以上案例给出了使用Java WebSocket框架构建简单的聊天应用、实时股票行情应用以及实时聊天室应用的示例。通过这些案例，我们可以更好地理解Java WebSocket框架在不同领域的应用。

结论

本文简要介绍了几个主流的Java WebSocket框架，包括Java WebSocket API、Jetty WebSocket、Netty WebSocket和Spring WebSocket。每个框架都提供了易于使用且功能强大的API，使开发者能够快速开发出高性能、实时通信的WebSocket应用程序。

无论你是在Java EE环境中开发，还是使用独立的Web服务器框架，都可以根据自己的需求选择合适的WebSocket框架。希望本文对初学者理解和使用Java WebSocket框架有所帮助。

参考文献：

• Java EE 7 WebSocket API：https://javaee.github.io/tutorial/websocket.html
• Jetty WebSocket：https://www.eclipse.org/jetty/documentation/current/websocket-jetty.html
• Netty WebSocket：https://netty.io/4.1/api/io/netty/handler/codec/http/websocketx/WebSocketServerProtocolHandler.html
• Spring WebSocket：https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#websocket