WebSocket 协议本身并不直接支持像HTTP那样携带自定义头部字段,但在WebSocket连接建立之前,可以利用HTTP升级协议(Upgrade)来传递自定义头信息。具体做法是在WebSocket的HTTP握手请求中添加自定义的HTTP头。
我使用的是java的springboot框架与websocket相结合,为了达到传递自定义头和参数,我实现了
javax.websocket.server.ServerEndpointConfig.Configurator
具体代码如下:
public class MyConfigurator extends Configurator{
@Override
public void modifyHandshake(ServerEndpointConfig serverEndpointConfig, HandshakeRequest request, HandshakeResponse response) {
/*
*相信大家看到了ServerEndpointConfig 、HandshakeRequest 、HandshakeResponse 应该不陌生吧
*实际上ServerEndpointConfig 继承至EndpointConfig,而HandshakeRequest 接口代表一个请求升级到WebSocket的HTTP请求
*HandshakeResponse 接口代表一个响应升级到WebSocket的HTTP响应。
*
*/
//获取请求连接中携带的头和参数;
Map
Map
//接下来可以直接读取这些map中你想要的参数,将值读取出来之后存储到ServerEndpointConfig 中
//String value = (String)parameterMap.get("authentication").get(0);
String value = (String)headers.get("Authentication").get(0);
//...可以验证码头信息的合法性或者直接存储到用户配置里面
serverEndpointConfig.getUserProperties().put("Authentication",value);//存储到用户配置里面
//...其他操作
}
}
接下来就是如何使用这个MyConfigurator 了,我是借用的@ServerEndpoint这个注解创建了websocket端点进行操作,具体如何使用@ServerEndpoint及其一些配置细节,可以自行取参考相关文字和书籍,代码如下:
@Slf4j
@ToString
@EqualsAndHashCode(callSuper = true)
@NoArgsConstructor
@ServerEndpoint(value = "/ws/endpoint",configurator = MyConfigurator.class)//在这里
public class WebSocketEndpoint{
@OnOpen
public void onOpen(Session session, EndpointConfig endpointConfig){
//这里就是取获取之前在MyConfigurator中存储到ServerEndpointConfig 中的参数
String authToken = (String) endpointConfig.getUserProperties().get("Authentication");
//...其他逻辑
}
//...@OnMessage的处理
//...@OnClose的处理
//...@OnError的处理
}
到这里整个需求就算是写完了,希望可以帮助到为此苦恼的人。
精彩链接
发表评论