WebSocket教程

11 篇文章 1 订阅

依赖

<!-- WebSocket依赖,该依赖包含了web依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

WebSocketHandler

创建WebSocket服务器就像实现WebSocketHandler一样简单,或者更可能是扩展TextWebSocketHandler或BinaryWebSocketHandler,下面的示例使用TextWebSocketHandler:

import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.TextMessage;

public class HelloWebSocketHandler extends TextWebSocketHandler {

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) {
        // ...
    }

}

WebSocket握手

定制初始的HTTP WebSocket握手请求的最简单方法是通过HandshakeInterceptor,它公开握手之前和之后的方法,你可以使用这样的拦截器来阻止握手或使WebSocketSession的任何属性有效,下面的示例使用内置的拦截器将HTTP会话属性传递给WebSocket会话:

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {


    public static final String HELLO_SOCKET_URL = "hello";

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(webSocketHandler(), HELLO_SOCKET_URL)
                .addInterceptors(new HttpSessionHandshakeInterceptor());
    }

    @Bean
    public WebSocketHandler webSocketHandler(){
        return new HelloWebSocketHandler();
    }
}

更高级的选项是扩展DefaultHandshakeHandler,该处理程序执行WebSocket握手的步骤,包括验证客户端源、协商子协议和其他细节

@Slf4j
public class WebSocketInterceptor implements HandshakeInterceptor {
    @Override
    public boolean beforeHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Map<String, Object> map) throws Exception {
        System.out.println("握手开始");
        return true;
    }

    @Override
    public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Exception e) {
        System.out.println("握手完成");
    }
}
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {


    public static final String HELLO_SOCKET_URL = "hello";

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
        webSocketHandlerRegistry.addHandler(helloHandler, HELLO_URL)
                .addInterceptors(helloInterceptor());
    }

    @Bean
    public HandshakeInterceptor helloInterceptor(){
        return new WebSocketInterceptor();
    }
}

Spring提供了一个WebSocketHandlerDecorator基类,你可以使用它来修饰WebSocketHandler具有额外的行为。默认情况下,在使用WebSocket Java配置或XML命名空间时,会提供并添加日志记录和异常处理实现。ExceptionWebSocketHandlerDecorator捕获来自任何WebSocketHandler的所有未捕获的异常,并以状态1011关闭WebSocket会话,这表示服务器错误。

服务器配置

每个基础WebSocket引擎都公开了控制运行时特性的配置属性,比如消息缓冲区大小、空闲超时等等。

对于Tomcat、WildFly和GlassFish,你可以将ServletServerContainerFactoryBean添加到WebSocket Java配置中,如下面的示例所示:

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    /**
     * 服务器配置
     *
     * @return
     */
    @Bean
    public ServletServerContainerFactoryBean createWebSocketContainer(){
        ServletServerContainerFactoryBean container = new ServletServerContainerFactoryBean();
        container.setMaxTextMessageBufferSize(8192);
        container.setMaxBinaryMessageBufferSize(8192);
        return container;
    }
}
对于客户端WebSocket配置,你应该使用WebSocketContainerFactoryBean(XML)或ContainerProvider.getWebSocketContainer()(Java配置)

对于Jetty,需要提供预配置的Jetty WebSocketServerFactory,并通过WebSocket Java配置将其插入Spring的DefaultHandshakeHandler,下面的示例展示了如何做到这一点:

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    public static final String HELLO_SOCKET_URL = "hello";

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(webSocketHandler(), HELLO_SOCKET_URL)
                .setHandshakeHandler(handshakeHandler()); // 允许所有的源
    }

    @Bean
    public DefaultHandshakeHandler handshakeHandler() {
        WebSocketPolicy policy = new WebSocketPolicy(WebSocketBehavior.SERVER);
        policy.setInputBufferSize(8192);
        policy.setIdleTimeout(600000);
        return new DefaultHandshakeHandler(new JettyRequestUpgradeStrategy(new WebSocketServerFactory(policy)));
    }
}

允许的源

在Spring Framework 4.1.5中,WebSocket和SockJS的默认行为是只接受相同源的请求,也可以允许所有或指定的源列表。这种检查主要是为浏览器客户端设计的,没有什么可以阻止其他类型的客户端修改Origin header值(请参阅RFC 6454: Web Origin概念以了解更多细节)。

三种可能的行为是:

  • 只允许相同源的请求(默认):在这种模式下,当启用SockJS时,Iframe HTTP响应header X-Frame-Options被设置为SAMEORIGIN,并且JSONP传输被禁用,因为它不允许检查请求的源,因此,当启用该模式时,不支持IE6和IE7。

  • 允许指定的源列表:每个允许的源必须以http://或https://开始,在这种模式下,当启用SockJS时,IFrame传输将被禁用,因此,当启用该模式时,将不支持IE6到IE9。

  • 允许所有的源:要启用此模式,你应该提供*作为允许的源值,在这种模式下,所有的传输都是可用的。

实战

// 入参
@Data
public class UserDTO {
    private String name;
    private WebSocketSession session;
}
// result
@Data
public class UserVO {
    private Long id;
    private String name;
    private String country;
}

Json工具类

@Slf4j
public class JsonUtil {

    public static ObjectMapper mapper = new ObjectMapper();

    public static <T> T parse(String json, Class<T> clazz){
        try {
            return mapper.readValue(json, clazz);
        } catch (JsonProcessingException e) {
            log.error("json解析失败:{}", json);
            return null;
        }
    }

    public static String serialize(Object obj){
        try {
            return mapper.writeValueAsString(obj);
        } catch (JsonProcessingException e) {
            log.error("对象序列化失败");
            return null;
        }
    }
}

@Slf4j
public class HelloWebSocketHandler extends TextWebSocketHandler {

    /**
     * 连接信息
     */
    private static final Map<String, UserDTO> connInfoMap = new HashMap<>();


    /**
     * socket 成功建立事件
     *
     * @param session
     * @throws Exception
     */
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        log.info("websocket成功建立连接,sessionId:{}", session.getId());
    }

    /**
     * socket 断开连接事件
     *
     * @param session
     * @param status
     * @throws Exception
     */
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        session.close();
        connInfoMap.remove(session.getId());
        log.info("websocket断开连接,sessionId:{}", session.getId());
    }


    /**
     * 接收消息事件
     *
     * @param session
     * @param message
     * @throws Exception
     */
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        String payload = message.getPayload();
        log.info("接受到的json数据:{}", payload);
        UserDTO userDTO = JsonUtil.parse(payload, UserDTO.class);
        if (Objects.isNull(userDTO) || userDTO.getName().isEmpty()){
            return;
        }

        userDTO.setSession(session);
        connInfoMap.put(session.getId(), userDTO);

        this.pushBySessionId(session.getId());
    }

    private void pushBySessionId(String sessionId){
        UserDTO userDTO = connInfoMap.get(sessionId);
        Optional.ofNullable(userDTO).orElseThrow(() -> new RuntimeException("未找到该用户session信息"));

        // 从数据库、kafka、内存中获取数据,这里模拟数据
        UserVO userVO = new UserVO();
        userVO.setId(1L);
        userVO.setName(userDTO.getName() + "s");
        userVO.setCountry("CN");

        try {
            userDTO.getSession().sendMessage(new TextMessage(Objects.requireNonNull(JsonUtil.serialize(userVO))));
        } catch (IOException e) {
            log.error("推送消息失败,名称{},errorMsg: {}",userDTO.getName(), e.getMessage());
        }
    }
}

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {


    public static final String HELLO_SOCKET_URL = "hello";

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(webSocketHandler(), HELLO_SOCKET_URL)
                .addInterceptors(new HttpSessionHandshakeInterceptor())
                .setAllowedOrigins("*"); // 允许所有的源
    }

    @Bean
    public WebSocketHandler webSocketHandler(){
        return new HelloWebSocketHandler();
    }

    /**
     * 服务器配置
     * 每个基础WebSocket引擎都公开了控制运行时特性的配置属性,比如消息缓冲区大小、空闲超时等等
     *
     * @return
     */
    @Bean
    public ServletServerContainerFactoryBean createWebSocketContainer(){
        ServletServerContainerFactoryBean container = new ServletServerContainerFactoryBean();
        container.setMaxTextMessageBufferSize(8192);
        container.setMaxBinaryMessageBufferSize(8192);
        return container;
    }
}

参考文献:

https://segmentfault.com/a/1190000016707376

https://cloud.tencent.com/developer/article/1530872

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
当然,我可以为您提供关于 WebSocket 的简单教程WebSocket 是一种在客户端和服务器之间实现双向通信的协议,它可以在一个单独的 TCP 连接上进行全双工通信。 以下是一个简单的 WebSocket 教程: 1. 创建 WebSocket 服务器: 首先,您需要创建一个 WebSocket 服务器来处理客户端的连接和消息。您可以使用不同的编程语言和框架来实现。例如,使用 Node.js 可以使用 'ws' 模块,而使用 Python 可以使用 'websockets' 库。 2. 客户端连接: 在客户端,您需要创建一个 WebSocket 连接来连接到服务器。在大多数现代浏览器中,您可以使用 JavaScript 的 WebSocket API 来实现。通过创建一个新的 WebSocket 对象,并传递服务器的 URL,您可以建立连接。 3. 事件处理: 一旦客户端成功连接到服务器,WebSocket 对象将触发一系列事件来处理不同的情况。例如,'open' 事件表示连接已经建立,'message' 事件表示收到了服务器发送的消息,'close' 事件表示连接已经关闭。 4. 发送和接收消息: 通过 WebSocket 对象,您可以使用 'send()' 方法向服务器发送消息,并使用 'onmessage' 事件来接收服务器发送的消息。消息可以是文本、二进制数据或 JSON 格式。 5. 关闭连接: 当您完成通信时,您可以使用 WebSocket 对象的 'close()' 方法来关闭连接。您还可以选择发送一个关闭帧以告知服务器,然后等待服务器关闭连接。 这是一个简单的 WebSocket 教程的概述。具体的实现细节和代码将取决于您选择的编程语言和框架。您可以根据需要查找更多关于特定语言和框架的详细教程和文档。希望这能帮到您!如果您有任何进一步的问题,请随时问我。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值