JavaWeb（苍穹外卖）--学习笔记17（Websocket）

前言

本篇文章是学习B站黑马程序员苍穹外卖的学习笔记📑。我的学习路线是Java基础语法-JavaWeb-做项目，管理端的功能学习完之后，就进入到了用户端微信小程序的开发，🙌用户下单并且支付成功后，需要第一时间通知外卖商家，这是都要用到WebSocket技术了。

先来看看什么是WebSocket

WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议。它使得客户端和服务器之间的数据交换变得更加简单，允许服务器主动向客户端推送数据。在 WebSocket API 中，浏览器和服务器只需要完成一次握手，之后两者之间即可创建持久性的连接，并进行双向数据传输。

✅只看定义还是不好理解的，来和传统的通信方式来对比一下更好理解：

一、先来看看传统网页通信 （也就是Tcp三次握手挥手），是怎么工作的：

举个例子来说：想象一下你去一家餐厅吃饭：

你（客户端）想点菜，就举手叫服务员（向服务器发送请求）服务员过来记下你的菜单，回去厨房（服务器处理）做好后，服务员再把菜端给你（服务器返回结果）吃完后，你想再点一道菜，又得重新举手......

这个过程就是 HTTP 请求的工作方式：

"你问一次，服务器答一次"，而且每次都要重新叫服务员（建立连接），非常麻烦。👉 这种方式叫 "请求-响应"模式，是单向的：只能你问，服务器不能主动告诉你。

二、那 WebSocket 是怎么工作的呢？

还是刚才那家餐厅：你一坐下，就和一个专属服务员建立了一个"专属通道"服务员一直站在旁边，随时听你说话（比如："来杯水"）同时，服务员也能主动告诉你："您的菜好了"、"甜点送您了"......

这个"一直在线、随时沟通"的专属通道，就是 WebSocket！

🌏它最大的优点是：

一旦建立连接，客户端和服务器可以随时互相发消息！

不用再"一问一答"，实现了双向实时通信。

总结来看看他的生命周期（我让AI总结了一下）✌️：

WebSocket 生命周期阶段

连接建立 (Handshake)

客户端通过 HTTP 协议发起一个特殊的请求（Upgrade 请求），请求升级到 WebSocket 协议。

服务端收到请求后，如果同意升级，返回 HTTP 101 状态码（Switching Protocols），并携带 Sec-WebSocket-Accept 等响应头，完成握手。

数据通信 (Data Transfer)

双向通信：客户端和服务端可以随时主动发送数据。

数据帧（Frame）：数据以帧的形式传输，支持文本（Text）和二进制（Binary）类型。

连接关闭 (Closing Handshake)

任一方（客户端或服务端）可以发送关闭帧（Close Frame）请求关闭连接。

另一方收到关闭帧后，应答一个关闭帧，完成四次挥手式的关闭握手。

连接正式关闭，释放资源。

🧠来从入门案例（用WebSocket来实现前端后端互相发消息）看看怎么使用

客户端视角：

html 复制代码

<!DOCTYPE HTML>
<html>
<head>
    <meta charset="UTF-8">
    <title>WebSocket Demo</title>
</head>
<body>
    <input id="text" type="text" />
    <button onclick="send()">发送消息</button>
    <button onclick="closeWebSocket()">关闭连接</button>
    <div id="message">
    </div>
</body>
<script type="text/javascript">
    var websocket = null;
    var clientId = Math.random().toString(36).substr(2);

    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        //连接WebSocket节点
        websocket = new WebSocket("ws://localhost:8080/ws/"+clientId);
    }
    else{
        alert('Not support websocket')
    }

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

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

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

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

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

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

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

服务端：

导入WebSocket的maven坐标

xml 复制代码

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

创建WebSocketServer类用于和客户端通信（这里可以和前端JavaScript结合起来看）

java 复制代码

package com.sky.websocket;
...
/**
 * WebSocket服务
 */
@Component
@ServerEndpoint("/ws/{sid}")
public class WebSocketServer {

    //存放会话对象
    private static Map<String, Session> sessionMap = new HashMap();

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("sid") String sid) {
        System.out.println("客户端：" + sid + "建立连接");
        sessionMap.put(sid, session);
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, @PathParam("sid") String sid) {
        System.out.println("收到来自客户端：" + sid + "的信息:" + message);
    }

    /**
     * 连接关闭调用的方法
     *
     * @param sid
     */
    @OnClose
    public void onClose(@PathParam("sid") String sid) {
        System.out.println("连接断开:" + sid);
        sessionMap.remove(sid);
    }

    /**
     * 群发
     *
     * @param message
     */
    public void sendToAllClient(String message) {
        Collection<Session> sessions = sessionMap.values();
        for (Session session : sessions) {
            try {
                //服务器向客户端发送消息
                session.getBasicRemote().sendText(message);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

}

配置类WebSocketConfiguration，注册WebSocket的服务端组件

java 复制代码

package com.sky.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

/**
 * WebSocket配置类，用于注册WebSocket的Bean
 */
@Configuration
public class WebSocketConfiguration {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

}

创建WebSocketTask类，向每隔5秒向客户端发送消息

java 复制代码

package com.sky.task;

import com.sky.websocket.WebSocketServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@Component
public class WebSocketTask {
    @Autowired
    private WebSocketServer webSocketServer;

    /**
     * 通过WebSocket每隔5秒向客户端发送消息
     */
    @Scheduled(cron = "0/5 * * * * ?")
    public void sendMessageToClient() {
        webSocketServer.sendToAllClient("这是来自服务端的消息：" + DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalDateTime.now()));
    }
}

实现：

链接建立：

服务端成功接到消息

客户端也可以发消息

这部分太难了，我还是一个小白，但是代码都是固定的，只要看着上面流程实现图，大致知道干什么都行

🌐来看看WebSocket在具体外卖项目中怎么使用

接口文档（还是先通过接口文档看看我们要实现什么功能）

🙌用户在小程序中点击催单按钮后，需要第一时间通知外卖商家。通知的形式有如下两种：语音波高，弹出提示框。

通过WebSocket实现管理端页面和服务端保持长连接状态。

当客户催单后，调用WebSocket的相关API实现服务端向客户端推送消息。

(客户催单)代码开发

在controller的user下的OrderController类中写方法：

java 复制代码

 /**
     * 订单催单
     * @param id
     * @return
     */
    @GetMapping("/reminder/{id}")
    @ApiOperation("订单催单")
    public Result reminder(@PathVariable("id") Long id){
        orderService.reminder(id);
        return Result.success();
    }

在service下的OrderService中写：

java 复制代码

   /**
     * 订单催单
     * @param id
     */
    void reminder(Long id);

在service下的impl下的OrderServiceImpl中写：

java 复制代码

@Autowired
    private WebSocketServer webSocketServer;

 /**
     * 客户催单
     * @param id
     */
    @Override
    public void reminder(Long id) {

        // 根据id查询订单
        Orders ordersDB = orderMapper.getById(id);

        // 校验订单是否存在
        if (ordersDB == null) {
            throw new OrderBusinessException(MessageConstant.ORDER_STATUS_ERROR);
        }

        Map map = new HashMap();
        map.put("type", 2 );
        map.put("orderId", id );
        map.put("content", "订单号：" + ordersDB.getNumber());
        String json = JSON.toJSONString(map);

        // 通过WebSocket向客户端推送消息
        webSocketServer.sendToAllClient(json);

    }

小白啊！！！写的不好轻喷啊🤯如果觉得写的不好，点个赞吧🤪（批评是我写作的动力）

...。。。。。。。。。。。...