springboot如何获取websocket的header头信息-Toy模板网

这篇具有很好参考价值的文章主要介绍了springboot如何获取websocket的header头信息。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

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

springboot如何获取websocket的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();
        }
    }