如何在Tapestry项目中通过Tapestry5-Hornet实现WebSocket？求参考与示例

我懂，找Tapestry5-Hornet的WebSocket示例确实挺费劲的，这个库的公开资源不算多。我整理了一套实用的实现步骤和代码片段，应该能帮你快速搭建起来：

1. 先搞定依赖与基础配置 #

如果你的项目用Maven，先在pom.xml里添加Tapestry5-Hornet的依赖：

<dependency>
    <groupId>org.apache.tapestry</groupId>
    <artifactId>tapestry5-hornet</artifactId>
    <version>5.8.0</version> <!-- 替换为你项目实际的Tapestry版本号 -->
</dependency>

注意：要保证版本和你的Tapestry核心版本匹配，避免兼容性问题

2. 实现WebSocket处理端点 #

创建一个处理WebSocket消息的类，继承Hornet提供的WebSocketHandler接口，处理连接、消息、关闭和错误事件：

import org.apache.tapestry5.hornet.websocket.WebSocket;
import org.apache.tapestry5.hornet.websocket.WebSocketHandler;

public class ChatWebSocket implements WebSocketHandler {

    @Override
    public void onOpen(WebSocket webSocket) {
        // 连接建立时的逻辑，比如记录客户端ID
        System.out.println("新客户端连接: " + webSocket.getId());
    }

    @Override
    public void onMessage(WebSocket webSocket, String message) {
        // 收到消息后广播给所有在线客户端
        for (WebSocket client : webSocket.getSession().getWebSockets()) {
            client.send("[" + webSocket.getId() + "]说: " + message);
        }
    }

    @Override
    public void onClose(WebSocket webSocket) {
        // 连接关闭时清理资源
        System.out.println("客户端断开连接: " + webSocket.getId());
    }

    @Override
    public void onError(WebSocket webSocket, Throwable throwable) {
        // 捕获并处理WebSocket错误
        System.err.println("WebSocket发生错误: " + throwable.getMessage());
        throwable.printStackTrace();
    }
}

3. 在Tapestry模块中注册端点 #

需要在你的AppModule里把刚才的WebSocket处理器映射到具体的路径，这样前端才能连接：

import org.apache.tapestry5.hornet.HornetModule;
import org.apache.tapestry5.hornet.websocket.WebSocketHandlerMapping;
import org.apache.tapestry5.ioc.Configuration;
import org.apache.tapestry5.ioc.annotations.Contribute;
import org.apache.tapestry5.ioc.services.ServiceBinder;

public class AppModule {

    public static void bind(ServiceBinder binder) {
        // 绑定WebSocket处理器为服务
        binder.bind(ChatWebSocket.class);
    }

    @Contribute(HornetModule.class)
    public static void contributeWebSocketHandlers(Configuration<WebSocketHandlerMapping> config, ChatWebSocket chatWebSocket) {
        // 映射路径/ws/chat到我们的ChatWebSocket处理器
        config.add(new WebSocketHandlerMapping("/ws/chat", chatWebSocket));
    }
}

4. 前端页面连接WebSocket #

在你的Tapestry页面里添加JavaScript代码，实现客户端与WebSocket服务端的交互：

<t:body>
    <div class="chat-container">
        <input type="text" id="msgInput" placeholder="输入消息..." />
        <button onclick="sendMsg()">发送</button>
        <div id="msgDisplay"></div>
    </div>

    <script>
        // 建立WebSocket连接，路径要和后端映射的一致
        const ws = new WebSocket(`ws://${window.location.host}/ws/chat`);

        ws.onopen = () => {
            console.log("WebSocket连接成功");
        };

        ws.onmessage = (event) => {
            // 接收服务端消息并展示
            const msgDisplay = document.getElementById("msgDisplay");
            msgDisplay.innerHTML += `<p>${event.data}</p>`;
        };

        ws.onclose = () => {
            console.log("WebSocket连接关闭");
        };

        function sendMsg() {
            const input = document.getElementById("msgInput");
            const msg = input.value.trim();
            if (msg) {
                ws.send(msg);
                input.value = "";
            }
        }
    </script>
</t:body>

额外的参考思路 #

• 源码注释：Tapestry5-Hornet的源码里有不少关键类的注释，比如WebSocket、WebSocketHandler，可以直接查看这些注释了解更多用法细节
• 身份验证：如果需要对WebSocket连接做身份验证，可以在onOpen方法里通过webSocket.getRequest()获取请求的Cookie或参数，自定义验证逻辑
• 消息格式：如果要传输复杂数据，可以把消息序列化为JSON格式，在服务端和客户端分别做解析

内容的提问来源于stack exchange，提问作者Hobas Matius