WebSocket使用介绍，看这篇就够了-六虎

一、WebSocket衔接的树立、音讯的接纳和回复

当涉及到WebSocket结构的深度运用时，一个流行的挑选是运用Java的Spring结构来完成。下面是一个基本的示例，演示了如何运用Spring WebSocket结构进行深度运用：

首先，保证你的项目中包含了Spring WebSocket的相关依赖。在pom.xml文件中增加以下依赖：

<dependencies>
    <!-- Spring WebSocket -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-websocket</artifactId>
    </dependency>
</dependencies>

接下来，创立一个WebSocket装备类，用于装备和办理WebSocket衔接：

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/websocket").setAllowedOrigins("*");
    }
}

在上面的示例中，MyWebSocketHandler是自界说的WebSocket处理程序，它将处理来自客户端的WebSocket衔接和音讯。

接下来，创立一个WebSocket处理程序类来处理WebSocket衔接和音讯的逻辑：

import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
public class MyWebSocketHandler extends TextWebSocketHandler {
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 当WebSocket衔接树立成功时调用
        System.out.println("WebSocket衔接已树立");
    }
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理接纳到的WebSocket音讯
        String payload = message.getPayload();
        System.out.println("接纳到音讯：" + payload);
        // 发送回复音讯给客户端
        String replyMessage = "收到音讯：" + payload;
        session.sendMessage(new TextMessage(replyMessage));
    }
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        // 当WebSocket衔接封闭时调用
        System.out.println("WebSocket衔接已封闭");
    }
}

在上面的示例中，咱们掩盖了afterConnectionEstablished、handleTextMessage和afterConnectionClosed等办法，以处理WebSocket衔接的树立、接纳音讯和衔接封闭等事情。

最终，你能够在你的运用程序中运用WebSocket衔接，例如在控制器中处理WebSocket请求：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;
@Controller
public class WebSocketController {
    @MessageMapping("/send")
    @SendTo("/topic/messages")
    public String sendMessage(String message) {
        // 处理接纳到的音讯，并回来处理结果
        String replyMessage = "处理音讯：" + message;
        return replyMessage;
    }
}

在上面的示例中，咱们运用@MessageMapping注解来指定处理客户端发送的音讯的途径，然后运用@SendTo注解将处理结果发送回指定的订阅途径。

二、播送音讯、用户认证

播送音讯：除了在handleTextMessage办法中直接发送回复音讯给单个客户端外，你还能够运用SimpMessagingTemplate来播送音讯给一切订阅了特定主题的客户端。能够在WebSocketConfig中注入SimpMessagingTemplate，然后在处理程序中运用它发送音讯。

@Autowired
private SimpMessagingTemplate messagingTemplate;
@Override
protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
    // 处理接纳到的WebSocket音讯
    String payload = message.getPayload();
    System.out.println("接纳到音讯：" + payload);
    // 播送音讯给一切订阅了特定主题的客户端
    messagingTemplate.convertAndSend("/topic/messages", "收到音讯：" + payload);
}

用户认证和授权：假如你的运用程序需求对WebSocket衔接进行认证和授权，你能够运用Spring Security结构来完成。你能够在WebSocketConfigurer的registerWebSocketHandlers办法中增加恰当的拦截器来处理认证和授权逻辑。例如，运用HandshakeInterceptor进行握手阶段的认证，并运用ChannelInterceptor来拦截和处理每个音讯的授权逻辑。
处理其他WebSocket事情：除了处理衔接树立、音讯接纳和衔接封闭等事情外，你还能够掩盖其他WebSocket事情的处理办法，例如handleTransportError用于处理传输过错，handleBinaryMessage用于处理二进制音讯等。依据你的需求，挑选适宜的办法进行掩盖和处理。
集成其他功用：你能够将WebSocket与其他功用集成，例如数据库拜访、音讯行列、实时告诉等。运用恰当的组件和库，将WebSocket与你的运用程序的其他部分无缝集成，以完成更复杂的功用。

三、转化器、存储与过滤器

自界说音讯转化器：Spring WebSocket结构支撑运用不同的音讯转化器来处理不同类型的音讯。你能够自界说音讯转化器，以完成自界说的音讯格局和处理逻辑。经过完成WebSocketMessageConverter接口，你能够界说自己的音讯转化器，并在WebSocketConfig中进行装备。

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
                registry.addHandler(new MyWebSocketHandler(), "/websocket")
                .setAllowedOrigins("*")
                .addInterceptors(new HttpSessionHandshakeInterceptor())
                .withSockJS();
    }
    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry) {
        registry.enableSimpleBroker("/topic");
        registry.setApplicationDestinationPrefixes("/app");
    }
    @Override
    public boolean configureMessageConverters(List<MessageConverter> messageConverters) {
        // 增加自界说的音讯转化器
        messageConverters.add(new MyMessageConverter());
        return true;
    }
}

播送音讯给特定用户：除了播送音讯给一切订阅了特定主题的客户端，你还能够运用SimpMessagingTemplate将音讯发送给特定用户。经过将用户标识符作为音讯的目的地，你能够保证音讯仅发送给特定用户。
```
@Autowired
private SimpMessagingTemplate messagingTemplate;
public void sendMessageToUser(String userId, String message) {
   messagingTemplate.convertAndSendToUser(userId, "/queue/messages", message);
}
```
会话办理和状况存储：WebSocket衔接能够树立长时间的会话，你或许需求办理会话状况和存储用户相关的数据。你能够运用WebSocketSession对象来办理会话，并运用恰当的存储机制（例如数据库、缓存等）来存储和检索会话状况。
音讯拦截器和过滤器：Spring WebSocket结构供给了拦截器和过滤器机制，答应你在处理音讯之前或之后履行额定的逻辑。经过完成HandshakeInterceptor和ChannelInterceptor接口，你能够编写自界说的拦截器和过滤器来处理身份验证、音讯转化、日志记载等操作。

四、拦截器、STOMP协议

处理衔接过错：WebSocket衔接或许会呈现过错，例如衔接断开、超时等情况。你能够在handleTransportError办法中处理这些衔接过错，并采取恰当的办法，例如记载日志、从头衔接等。

@Override
public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
    // 处理衔接过错
    System.out.println("衔接过错：" + exception.getMessage());
    // 能够依据具体情况采取恰当的办法，例如封闭衔接、从头衔接等
}

运用WebSocket拦截器：WebSocket拦截器答应你在树立衔接之前和之后履行额定的逻辑。你能够完成HandshakeInterceptor接口，并在WebSocketConfig中注册拦截器来处理握手阶段的逻辑。

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/websocket")
                .setAllowedOrigins("*")
                .addInterceptors(new MyHandshakeInterceptor())
                .withSockJS();
    }
    // ...
}

运用自界说注解：你能够界说自己的注解，以便在WebSocket处理办法中进行更细粒度的控制。经过创立自界说注解并运用@Target(ElementType.METHOD)将其运用于处理办法，你能够在运行时履行特定的逻辑。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CustomWebSocketHandler {
    // 增加自界说属性
}
@CustomWebSocketHandler
public void handleWebSocketMessage(WebSocketSession session, TextMessage message) {
    // 履行自界说逻辑
}

运用STOMP协议：STOMP（Simple Text Oriented Messaging Protocol）是一种简单的文本导向音讯协议，用于在WebSocket之上进行音讯传递。你能够运用Spring的STOMP支撑来完成更高级的音讯传递功用，例如订阅和发布、音讯头、过错处理等。

五、播送办理、守时使命

音讯播送和群组办理：除了向特定用户发送音讯，你或许还需求完成音讯的播送和群组办理功用。Spring WebSocket结构供给了SimpMessagingTemplate和SimpUserRegistry等东西类来完成这些功用。你能够运用SimpMessagingTemplate发送音讯给特定主题或群组，而SimpUserRegistry则用于办理衔接的用户和会话。

@Autowired
private SimpMessagingTemplate messagingTemplate;
@Autowired
private SimpUserRegistry userRegistry;
public void broadcastMessage(String topic, String message) {
    messagingTemplate.convertAndSend(topic, message);
}
public Set<String> getConnectedUsers() {
    return userRegistry.getUsers().stream()
            .map(SimpUser::getName)
            .collect(Collectors.toSet());
}

守时使命和调度：在WebSocket运用中，你或许需求履行守时使命和调度使命，例如守时发送音讯、守时清理会话等。你能够运用Spring结构供给的守时使命调度功用，结合WebSocket结构来完成这些使命。

@Component
public class WebSocketScheduler {
    @Autowired
    private SimpMessagingTemplate messagingTemplate;
    @Scheduled(fixedDelay = 5000) // 每5秒履行一次
    public void sendScheduledMessage() {
        String message = "Scheduled message";
        messagingTemplate.convertAndSend("/topic/messages", message);
    }
}

跨域拜访控制：假如你的WebSocket运用需求跨域拜访控制，你能够装备相应的跨域策略。Spring WebSocket结构供给了setAllowedOrigins办法来设置答应的跨域来历。

@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
    registry.addHandler(new MyWebSocketHandler(), "/websocket")
            .setAllowedOrigins("http://example.com")
            .addInterceptors(new HttpSessionHandshakeInterceptor())
            .withSockJS();
}

安全认证和授权：假如你的WebSocket运用需求安全认证和授权，你能够结合Spring Security结构来完成。经过装备恰当的安全规矩和认证机制，你能够保证只有经过授权的用户才能树立WebSocket衔接和发送音讯。

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/websocket")
                .setAllowedOrigins("*")
                .addInterceptors(new HttpSessionHandshakeInterceptor())
                .withSockJS();
    }
    // ...
}
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
            .antMatchers("/websocket").authenticated()
            .anyRequest().permitAll()
            .and()
            .formLogin()
            .permitAll()
            .and()
            .logout()
            .permitAll();
    }
}

六、存储、多频道办理与布置

音讯存储和持久化：假如你的运用需求存储和持久化音讯，能够结合运用WebSocket和音讯行列或数据库来完成。当接纳到音讯时，你能够将音讯存储到数据库或音讯行列中，并在需求的时分进行读取和处理。

@Autowired
private MessageRepository messageRepository;
public void handleMessage(WebSocketSession session, TextMessage message) {
    // 存储音讯到数据库或音讯行列
    messageRepository.save(message.getPayload());
}
public List<String> getMessages() {
    // 从数据库或音讯行列中读取音讯
    return messageRepository.findAll();
}

多频道办理：假如你的运用需求办理多个频道或主题，能够考虑运用WebSocket的订阅和发布模式。你能够创立多个频道或主题，并在客户端订阅感兴趣的频道，以便接纳相应的音讯。

@Autowired
private SimpMessagingTemplate messagingTemplate;
public void sendMessage(String channel, String message) {
    messagingTemplate.convertAndSend("/topic/" + channel, message);
}
public void subscribeChannel(String channel, WebSocketSession session) {
    messagingTemplate.subscribe("/topic/" + channel, session.getId());
}
public void unsubscribeChannel(String channel, WebSocketSession session) {
    messagingTemplate.unsubscribe("/topic/" + channel, session.getId());
}

跨服务器布置：假如你的运用需求在多个服务器上布置，能够考虑运用分布式音讯署理来完成跨服务器的音讯传递。一种常见的方案是运用RabbitMQ或Apache Kafka等音讯行列作为音讯署理，以保证音讯在不同服务器之间的牢靠传递。

过错处理和反常处理：在处理WebSocket衔接和音讯时，或许会呈现过错和反常。你能够完成WebSocketHandler接口的handleTransportError和handleMessageException办法来处理衔接过错和音讯反常，并进行相应的处理，例如记载日志、发送过错音讯等。

public class MyWebSocketHandler implements WebSocketHandler {

    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        // 处理衔接过错
    }
    @Override
    public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
        try {
            // 处理接纳到的音讯
        } catch (Exception e) {
            // 处理音讯反常
        }
    }
}

七、会话心跳

音讯编解码：在WebSocket运用中，音讯的编码和解码是一个重要的环节。你能够运用Spring供给的音讯编解码器来完成音讯的转化和处理。例如，能够运用TextMessageEncoder和TextMessageDecoder来进行文本音讯的编解码。

public class MyTextMessageEncoder implements MessageEncoder<String> {
    @Override
    public ByteBuffer encode(String message) throws EncodeException {
        // 完成音讯的编码逻辑
    }
}
public class MyTextMessageDecoder implements MessageDecoder<String> {
    @Override
    public String decode(ByteBuffer message) throws DecodeException {
        // 完成音讯的解码逻辑
    }
}

心跳检测：为了保证WebSocket衔接的稳定性，你能够完成心跳检测机制来监控衔接的状况。能够运用守时使命来发送心跳音讯，并在一守时间内未收到心跳响应时，断开衔接或进行相应的处理。

@Component
public class HeartbeatScheduler {
    @Autowired
    private SimpMessagingTemplate messagingTemplate;
    @Scheduled(fixedDelay = 10000) // 每10秒发送一次心跳音讯
    public void sendHeartbeatMessage() {
        messagingTemplate.convertAndSend("/topic/heartbeat", "Heartbeat");
    }
}
public class MyWebSocketHandler extends TextWebSocketHandler {
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        if ("Heartbeat".equals(message.getPayload())) {
            // 收到心跳音讯，进行相应处理
            // ...
        } else {
            // 处理其他音讯
            // ...
        }
    }
}

自界说拦截器：你能够运用自界说拦截器来对WebSocket衔接进行拦截和处理。拦截器能够用于认证、授权、日志记载等方面。经过完成HandshakeInterceptor接口，你能够在树立衔接之前和之后进行相应的操作。

public class MyHandshakeInterceptor implements HandshakeInterceptor {
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response,
                                   WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {
        // 在树立衔接之前进行处理
        // ...
        return true;
    }
    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response,
                               WebSocketHandler wsHandler, Exception exception) {
        // 在树立衔接之后进行处理
        // ...
    }
}

会话办理：在WebSocket运用中，你或许需求办理和盯梢每个衔接的会话信息。你能够经过保护一个会话办理器来完成会话的创立、销毁和查询等操作。

public class SessionManager {
    private Map<String, WebSocketSession> sessions = new ConcurrentHashMap<>();
    public void addSession(WebSocketSession session) {
        sessions.put(session.getId(), session);
    }
    public void removeSession(WebSocketSession session) {
        sessions.remove(session.getId());
    }
    public WebSocketSession getSession(String sessionId) {
        return sessions.get(sessionId);
    }
    public List<WebSocketSession> getAllSessions() {
        return new ArrayList<>(sessions.values());
    }
}

WebSocket使用介绍，看这篇就够了

一、WebSocket衔接的树立、音讯的接纳和回复

二、播送音讯、用户认证

三、转化器、存储与过滤器

四、拦截器、STOMP协议

五、播送办理、守时使命

六、存储、多频道办理与布置

七、会话心跳

作者信息

推广

WebSocket使用介绍，看这篇就够了

一、WebSocket衔接的树立、音讯的接纳和回复

二、播送音讯、用户认证

三、转化器、存储与过滤器

四、拦截器、STOMP协议

五、播送办理、守时使命

六、存储、多频道办理与布置

七、会话心跳

相关文章

协程入门教程：runBlocking和async的特点、用法和区别

【前端专场 学习资料一】第五届字节跳动青训营

短视频媒体处理系统应急响应自动化实践

回归分析：逻辑斯蒂回归模型，非线性分类任务案例

作者信息

推广

【前端专场学习资料一】第五届字节跳动青训营