WebSocket的简单实现

原创于 2021-11-16 09:33:58 发布 · 1.4k 阅读

CC 4.0 BY-SA版权

文章标签：

WebSocket协议作为TCP上的新协议，解决了HTTP只能由客户端发起的限制，实现了服务器与浏览器之间的双向通信。建立WebSocket连接需要一次握手，之后即可进行持久的数据传输。本文通过js和java代码示例解释了WebSocket的连接过程，包括打开、发送消息、接收消息及关闭连接，并提供了参考的API文档链接。

WebSocket协议是基于TCP的一种新的网络协议。浏览器通信通常是基于HTTP 协议，为什么还需要另一个协议？因为http只能由客户端发起，不能由服务端发起。

而WebSocket 浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

▲图源网上

WebSocket规范

WebSocket 协议本质上是一个基于 TCP 的协议。为了建立一个 WebSocket 连接，客户端浏览器首先要向服务器发起一个 HTTP 请求，这个请求和通常的 HTTP 请求不同，包含了一些附加头信息，附加信息如图所示

▲图源网上

连接过程（以js（客户端）和java（服务器端）为例）

1. WebSocket 首先会发出Handshake（握手请求），对应js代码和Java代码里的onopen方法。

2. 客户端发送至服务端

js：ws.send（ String msg） ps：入参可以是字符串或者json字符串java：onMessage(String message）message为客户端传来的信息

3. 服务端发送到客户端

java：sendUser（ String msg） js：ws.onmessage

4.断开连接onclose（ CloseReason reason）

CloseReason.CloseCode ( WebSocket关闭连接的状态码，类似http的404)

js部分：

var ws = new WebSocket("ws://server_ip//websocket")ws.onopen = function(evt){    console.log("Connection open ...");    ws.send("Hello WebSockets!");};    ws.onmessage = function(evt){    console.log("Received Message:" + evt.data);ws.close();};ws.onclose = function(evt){    console.log("Connection closed.");}

java部分（javax实现）：

ps： session 用来唯一标识连接对象

使用注解@ServerEndpoint

@ServerEndpoint(value = "/websocket", configurator = GetHttpSessionConfigurator.class)public class WebSocketEndpoint { private     static Logger logger =LoggerFactory.getLogger(WebSocketEndpoint.class);    // 保存所有的用户session    private static Map<String, Session> SESSION_MAP = new Hashtable<String, Session>();    @OnOpen    public void onOpen(Session session, EndpointConfig config) throws IOException {        logger.info("【WebSocket原生】用户{}连接", session.getId());    HttpSession httpSession = (HttpSession) config.getUserProperties().get(HttpSession.class.getName());    httpSession.setAttribute("scoketSessionId", session.getId()); logger.info("【WebSocket原生】httpSessionId:{},sessionId:{}",    httpSession.getId(),    httpSession.getAttribute("scoketSessionId")); SESSION_MAP.put(session.getId(), session);    // 发送sessionId给前端    Msg4Ws<String> msg4Ws = new Msg4Ws<String>(10000, "ws的sessionId", session.getId());    String message = new ObjectMapper().writeValueAsString(msg4Ws); // 转为json    send2User(session, message);    }@OnMessagepublic void onMessage(Session session, String message) { logger.info("【WebSocket原生】收到消息：" + message); String resultMsg = message + " received at server"; logger.info("【WebSocket原生】返回信息：" + resultMsg); try {    send2User(session, resultMsg);    } catch (IOException e) {    @OnError    public void onError(Throwable t){System.err.println("【WebSockt原生】出错了");t.printStackTrace();    }    @OnClose    public void onClose(Session session,CloseReason reason){logger.info("用户{}"        【WebSockt原生】退出链接："+session.getId());        SESSION_MAP.remove(session.getId());    }/** * 向指定用户发送信息 *  * @param session  *  * @param msg  * @throws IOException  **/     {        SESSION_MAP.get(sessionId).getBasicRemote().sendText(msg);    } }