springboot如何获取websocket的header头信息_springboot websocket header-CSDN博客

本文链接：https://blog.csdn.net/weixin_43702146/article/details/129284991

文章介绍了如何在WebSocket协议的后端处理中，通过自定义的WebSocket配置类`WebSocketConfig`，在`modifyHandshake()`方法中获取并处理握手请求时的头信息，然后将这些信息存储在`Session`的用户属性中。在需要的时候，通过`getEndpointInstance()`方法初始化端点对象，并提供了一个静态方法`getHeader()`来便捷地从`Session`中获取特定的头信息。如果头信息不存在，会关闭连接。

摘要由CSDN通过智能技术生成

websocket协议与http协议类似，也有属于自己的头信息，如下图所示，为postman在连接时自定义的header：

在这里插入图片描述

那么在后端中，如何像http的HttpServletRequest一样来获取这个头信息的内容呢?

自定义一个WebSocket配置类：

modifyHandshake()方法：建立握手时，连接前的操作，可以获取到源信息，并且传递给Session
getEndpointInstance()方法：初始化端点对象,也就是被@ServerEndpoint所标注的对象

@Configuration
public class WebSocketConfig extends ServerEndpointConfig.Configurator {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
	
	/**
	* 建立握手时，连接前的操作
	*/
    @Override
    public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
        // 这个userProperties 可以通过 session.getUserProperties()获取
        final Map<String, Object> userProperties = sec.getUserProperties();
        Map<String, List<String>> headers = request.getHeaders();
        List<String> remoteIp = headers.get("x-forwarded-for");
        List<String> header1 = headers.get("x1");
        List<String> header2 = headers.get("x2");
        userProperties.put("header1", header1.get(0));
        userProperties.put("header2", header2.get(0));
        userProperties.put("x-forwarded-for", remoteIp.get(0));
    }

	/**
	* 初始化端点对象,也就是被@ServerEndpoint所标注的对象
	*/
    @Override
    public <T> T getEndpointInstance(Class<T> clazz) throws InstantiationException {
        return super.getEndpointInstance(clazz);
    }
}

在@ServerEndpoint(value = "/websocket/document",configurator = WebSocketConfig.class)中指定我们的自定义配置类。

封装一个获取头信息的方法

    public static String getHeader(Session session, String headerName) {
        final String header = (String) session.getUserProperties().get(headerName);
        if (StrUtil.isBlank(header)) {
            log.error("获取header失败，不安全的链接，即将关闭");
            try {
                session.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return header;
    }

在任意能够获取到Session的地方使用即可

    @OnMessage
    public void onMessage(Session session, String message) {
        log.info("client received message:{}, session:{},", message,session.hashCode());
        final String header = WebSocketUtil.getHeader(session, "header1");
        try {
            session.getBasicRemote().sendText(header);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }