WebSocket学习总结

【简介】

近年来,随着HTML5的诞生,WebSocket协议被提出,它实现了浏览器与服务器的全双工通信,扩展了浏览器与服务端的通信功能,使服务端也能主动向客户端发送数据。

首先,博主谈一下,Http协议缺陷:通信只能由客户端发起。这种单向请求的特点,注定了如果服务器有连续的状态变化,客户端要获知就很麻烦。我们只能通过轮询的方式,每隔一段时间,就发出一个询问,获取服务器有无最新的信息。最典型的就是聊天室。轮询的效率低,且非常浪费资源。

现在来谈谈应时而生的WebSocket。WebSocket最大的特点就是:服务器可以主动的向客户端推送消息,客户端也可以主动向服务器发送信息。

WebSocket的特点:

  1. 建立在TCP协议上,服务器端的实现比较容易。
  2. 与HTTP协议有着良好的兼容性,默认端口也是80和443,并且握手阶段采用HTTP协议。
  3. 数据格式比较轻量,性能开销小,通信高效。
  4. 可以发送文本以及二进制数据。
  5. 没有同源限制,客户端可以与任意服务器通信。
  6. 协议标识符位ws(如果加密则为wss),服务器网址就是URL。

【前后端连接的URL】

ws://localhost:8080/ctm02vmas/webSocket

【前端代码】

<%@ page language="java" pageEncoding="UTF-8" %>
<!DOCTYPE html>
<html>
<head>
    <title>Java后端WebSocket的Tomcat实现</title>
</head>
<body>
    Welcome<br/><input id="text" type="text"/>
    <button onclick="send()">发送消息</button>
    <hr/>
    <button onclick="closeWebSocket()">关闭WebSocket连接</button>
    <hr/>
    <div id="message"></div>
</body>

<script type="text/javascript">
    var websocket = null;
    //判断当前浏览器是否支持WebSocket
    if ('WebSocket' in window) {
        websocket = new WebSocket("ws://localhost:8080/websocket");
    }
    else {
        alert('当前浏览器 Not support websocket')
    }

    //连接发生错误的回调方法
    websocket.onerror = function () {
        setMessageInnerHTML("WebSocket连接发生错误");
    };

    //连接成功建立的回调方法
    websocket.onopen = function () {
        setMessageInnerHTML("WebSocket连接成功");
    }

    //接收到消息的回调方法
    websocket.onmessage = function (event) {
        setMessageInnerHTML(event.data);
    }

    //连接关闭的回调方法
    websocket.onclose = function () {
        setMessageInnerHTML("WebSocket连接关闭");
    }

    //监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
    window.onbeforeunload = function () {
        closeWebSocket();
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //关闭WebSocket连接
    function closeWebSocket() {
        websocket.close();
    }

    //发送消息
    function send() {
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>

【后端代码】 

import com.hikvision.starfish.core.json.JsonUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;


@Component
@ServerEndpoint(value = "/webSocket")
public class WebSocketServer {
    Logger logger=LoggerFactory.getLogger(WebSocketServer.class);
    //记录当前在线连接数
    private static int onlineCount=0;
    private static CopyOnWriteArraySet<WebSocketServer> webSocketSet=new CopyOnWriteArraySet<>();
    private static ConcurrentHashMap<WebSocketServer,String> sessionWithIdMap=new ConcurrentHashMap<>();
    private Session session;


    @OnOpen
    public void onOpen(Session session){
        this.session=session;
        webSocketSet.add(this);
        addOnlineCount();
        logger.info("====加入新连接session:{}!当前在线人数为:{}", this.session.getId(), getOnlineCount());
        try {
            sendMessage(JsonUtil.toJson("连接成功"));
        } catch (IOException e) {
            logger.error("websocket IO异常");
        }
    }
    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);  //从set中删除
        //移除sessionWtihBuildingMap中对应的对象
        sessionWithIdMap.remove(this);
        subOnlineCount();           //在线数减1
        logger.info("====关闭连接session:{}!当前在线人数为:{}", this.session.getId(), getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) throws Exception {
        logger.debug("====来自客户端的消息session:{}---message:{}", session.getId(), message);
        this.session = session;
        //保存session和对应的id
        sessionWithIdMap.put(this, message);
        sendMessage(JsonUtil.toJson("pong=>" + message));
    }

    /**
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        logger.error("发生错误");
        error.printStackTrace();
    }

    public void sendMessage(String message) throws IOException {
        logger.debug("发送至客户端的消息:{}"+message);
        this.session.getBasicRemote().sendText(message);
    }

    /**
     * 获取所有websocket
     */
    public CopyOnWriteArraySet<WebSocketServer> getWebSockets() {
        return webSocketSet;
    }

    /**
     * 群发自定义消息
     */
    public void sendInfo(String message) throws IOException {
        for (WebSocketServer item : webSocketSet) {
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                logger.error("sendInfo error:{}",e);
            }
        }
    }

    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    public static synchronized void addOnlineCount() {
        WebSocketServer.onlineCount++;
    }

    public static synchronized void subOnlineCount() {
        WebSocketServer.onlineCount--;
    }
}

【调用方法】

@Autowired 
WebSocketService service;
service.sendMessage(message);

存在的问题:直接调用sendMessage()会获取不到session,所以我会调用sendInfo。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
好的,下面是 Java 中 WebSocket学习教程: 1. WebSocket 概述 WebSocket 是一种在单个 TCP 连接上进行双向通信的协议。它可以让我们实现实时的 Web 应用程序,而不需要复杂的轮询或长轮询机制。 在 WebSocket 中,客户端和服务器之间可以发送任意数量的消息,并且这些消息都是异步发送和接收的。这使得 WebSocket 成为实现实时应用程序的理想选择。 2. WebSocket API Java 中的 WebSocket API 由以下类和接口组成: - `javax.websocket.Session`:代表一个 WebSocket 连接。 - `javax.websocket.Endpoint`:WebSocket 终端点,用于处理 WebSocket 连接和消息。 - `javax.websocket.MessageHandler`:用于处理 WebSocket 消息的接口。 - `javax.websocket.server.ServerEndpoint`:标注在 WebSocket 服务器端点类上,声明一个 WebSocket 服务端点。 - `javax.websocket.server.ServerEndpointConfig`:WebSocket 服务端点配置类,用于配置 WebSocket 服务器端点。 3. 实现 WebSocket 服务端 要实现一个 WebSocket 服务端,需要完成以下步骤: - 创建一个继承 `javax.websocket.Endpoint` 类的 WebSocket 终端点类。 - 在 WebSocket 终端点类中实现 `onOpen`、`onClose`、`onError` 和 `onMessage` 方法,用于处理 WebSocket 连接和消息。 - 使用 `@ServerEndpoint` 注解标注 WebSocket 终端点类,将其暴露为 WebSocket 服务端点。 下面是一个简单的 WebSocket 服务端实现示例: ```java @ServerEndpoint("/websocket") public class WebSocketServer { @OnOpen public void onOpen(Session session) { System.out.println("WebSocket opened: " + session.getId()); } @OnClose public void onClose(Session session) { System.out.println("WebSocket closed: " + session.getId()); } @OnError public void onError(Session session, Throwable error) { System.err.println("WebSocket error: " + error); } @OnMessage public void onMessage(String message, Session session) { System.out.println("WebSocket message received: " + message); try { session.getBasicRemote().sendText("Received message: " + message); } catch (IOException e) { e.printStackTrace(); } } } ``` 4. 实现 WebSocket 客户端 要实现一个 WebSocket 客户端,需要完成以下步骤: - 创建一个继承 `javax.websocket.Endpoint` 类的 WebSocket 终端点类。 - 在 WebSocket 终端点类中实现 `onOpen`、`onClose`、`onError` 和 `onMessage` 方法,用于处理 WebSocket 连接和消息。 - 使用 `javax.websocket.WebSocketContainer` 接口的 `connectToServer` 方法连接到 WebSocket 服务端点。 下面是一个简单的 WebSocket 客户端实现示例: ```java public class WebSocketClient extends Endpoint { @Override public void onOpen(Session session, EndpointConfig config) { System.out.println("WebSocket opened: " + session.getId()); try { session.getBasicRemote().sendText("Hello, server!"); } catch (IOException e) { e.printStackTrace(); } } @Override public void onClose(Session session, CloseReason closeReason) { System.out.println("WebSocket closed: " + session.getId()); } @Override public void onError(Session session, Throwable error) { System.err.println("WebSocket error: " + error); } @Override public void onMessage(String message, Session session) { System.out.println("WebSocket message received: " + message); try { session.close(); } catch (IOException e) { e.printStackTrace(); } } public static void main(String[] args) { WebSocketContainer container = ContainerProvider.getWebSocketContainer(); String uri = "ws://localhost:8080/websocket"; try { container.connectToServer(new WebSocketClient(), URI.create(uri)); } catch (DeploymentException | IOException e) { e.printStackTrace(); } } } ``` 5. 总结 这就是 Java 中 WebSocket学习教程,我们学习了如何实现 WebSocket 服务端和客户端,并使用 `javax.websocket` 包中的类和接口来处理 WebSocket 连接和消息。希望这个教程对你有所帮助!

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值