springboot集成websocket基础方法详细教程

@ServerEndpoint 有哪些方法注解可以用

@ServerEndpoint 是 Java EE 中用于定义 WebSocket 服务器端点的注解，它允许你创建一个端点类来处理客户端的连接、消息和关闭等事件。在这样的类中，你可以使用多个方法注解来处理不同的事件。以下是可以用于 WebSocket 服务器端点类中的方法注解：

1. @OnOpen：用于标记处理客户端连接建立事件的方法。
2. @OnClose：用于标记处理客户端连接关闭事件的方法。
3. @OnMessage：用于标记处理从客户端接收到消息事件的方法。
4. @OnError：用于标记处理出现错误事件的方法。

这些方法注解允许你根据业务逻辑定义适当的处理方法，使你能够在客户端连接建立、关闭、发送消息或发生错误时执行相应的操作。示例如下：

@ServerEndpoint("/endpoint")
public class WebSocketEndpoint {

    @OnOpen
    public void onOpen(Session session) {
        // 处理客户端连接建立的操作
    }

    @OnClose
    public void onClose(Session session, CloseReason closeReason) {
        // 处理客户端连接关闭的操作
    }

    @OnMessage
    public void onMessage(String message, Session session) {
        // 处理从客户端接收到的文本消息
    }

    @OnError
    public void onError(Session session, Throwable throwable) {
        // 处理出现错误的操作
    }
}

使用这些注解，你可以方便地处理与 WebSocket 相关的事件，并根据具体的业务需求执行相应的操作。

参数详解

@OnOpen、@OnMessage、@OnClose 和 @OnError 是 Java EE 中用于处理 WebSocket 事件的注解，它们可以接受不同类型的参数，具体取决于你的需求。以下是每个注解可以接受的参数的一般约定：

1. @OnOpen:
   • Session：表示与客户端的 WebSocket 会话，可以用于向客户端发送消息等操作。
   • EndpointConfig：WebSocket 端点配置对象，可以用来获取配置信息。

@OnOpen
public void onOpen(Session session, EndpointConfig config) {
    // 处理连接建立的操作
}

2. @OnMessage:
   • String 或 byte[]：用于接收从客户端传递的文本或二进制数据。
   • PongMessage：用于接收 Pong 消息。
   • Session：WebSocket 会话对象，可以用于向客户端发送消息。

@OnMessage
public void onMessage(String message, Session session) {
    // 处理文本消息
}

@OnMessage
public void onMessage(byte[] data, Session session) {
    // 处理二进制消息
}

3. @OnClose:
   • Session：表示关闭连接的 WebSocket 会话。
   • CloseReason：提供关闭原因的详细信息。

@OnClose
public void onClose(Session session, CloseReason reason) {
    // 处理连接关闭的操作
}

4. @OnError:
   • Throwable：表示发生错误的异常对象。
   • Session：WebSocket 会话对象。

@OnError
public void onError(Throwable t, Session session) {
    // 处理发生错误的操作
}

注意，你可以根据业务需求选择合适的参数类型，并结合 @OnOpen、@OnMessage、@OnClose 和 @OnError 注解来处理 WebSocket 事件。参数的具体使用方式会根据你的应用程序的要求而有所不同。