springBoot集成webSocket并使用postMan进行测试

参阅资料：

blog.csdn.net/qq_54773998…

blog.csdn.net/weixin_5699…

简单描绘

简单来讲，webSocket是一种在http协议基础上的另一种新协议，叫ws协议。

http协议是单工通讯，客户端建议恳求，服务端收到恳求并处理，返回给客户端，然后客户端收到服务端的恳求。

ws协议是全双工通讯，客户端建议恳求后，相当于搭建了一个通道，在不断开的情况下，在这期间，服务端能够把恳求发给客户端，客户端也能够在这期间处理别的事情，不必等候服务端的呼应。

如果不理解，可参阅这篇文章：blog.csdn.net/qq_54773998…

webSockt完成

此次webSocket完成不包括前端代码，将运用postMan来完成前端的功能。

依赖

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

装备类

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

webSocketServer

package com.czf.study.wevSocket;
import lombok.extern.slf4j.Slf4j;
import org.junit.platform.commons.util.StringUtils;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
/**
 * @author zfChen
 * @create 2022/11/14 15:11
 */
@ServerEndpoint("/websocket/{userId}")
@Component
@Slf4j
public class WebSocketServer {
    /**静态变量，用来记录当时在线衔接数。应该把它规划成线程安全的。*/
    private static int onlineCount = 0;
    /**concurrent包的线程安全调集，也能够map改成set，用来寄存每个客户端对应的MyWebSocket目标。*/
    private static ConcurrentHashMap<String,WebSocketServer> webSocketMap = new ConcurrentHashMap<>();
    /**与某个客户端的衔接会话，需求通过它来给客户端发送数据*/
    private Session session;
    /**接纳userId*/
    private String userId="";
    /**
     * 衔接树立成功调用的办法*/
    @OnOpen
    public void onOpen(Session session,@PathParam("userId") String userId) {
        this.session = session;
        this.userId=userId;
        if(!webSocketMap.containsKey(userId)){
            //加入调集中
            webSocketMap.put(userId,this);
            //在线数加1
            addOnlineCount();
        }
        log.info("用户衔接:"+userId+",当时在线人数为:" + getOnlineCount());
        try {
            sendMessage("衔接成功");
        } catch (IOException e) {
            log.error("用户:"+userId+",网络异常!!!!!!");
        }
    }
    /**
     * 衔接封闭调用的办法
     */
    @OnClose
    public void onClose() {
        if(webSocketMap.containsKey(userId)){
            webSocketMap.remove(userId);
            //从调集中删除
            subOnlineCount();
        }
        log.info("用户退出:"+userId+",当时在线人数为:" + getOnlineCount());
    }
    /**
     * 收到客户端音讯后调用的办法
     *
     * @param message 客户端发送过来的音讯*/
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("【websocket音讯】收到客户端发来的音讯:{}", message);
    }
    /**
     *
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("用户错误:"+this.userId+",原因:"+error.getMessage());
        error.printStackTrace();
    }
    /**
     * 完成服务器主动推送
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }
    /**
     * 发送自定义音讯
     * */
    public static void sendInfo(String message,@PathParam("userId") String userId) throws IOException {
        log.info("发送音讯到:"+userId+"，报文:"+message);
        if(StringUtils.isNotBlank(userId)&&webSocketMap.containsKey(userId)){
            webSocketMap.get(userId).sendMessage(message);
        }else{
            log.error("用户"+userId+",不在线！");
        }
    }
    public static synchronized int getOnlineCount() {
        return onlineCount;
    }
    public static synchronized void addOnlineCount() {
        WebSocketServer.onlineCount++;
    }
    public static synchronized void subOnlineCount() {
        WebSocketServer.onlineCount--;
    }
}

服务端发恳求接口

外面创立一个接口，模仿服务端发恳求给客户端

@RestController
public class DemoController {
    @RequestMapping("/push/{toUserId}")
    public ResponseEntity<String> pushToWeb(String message, @PathVariable String toUserId) throws IOException {
        WebSocketServer.sendInfo(message,toUserId);
        return ResponseEntity.ok("MSG SEND SUCCESS");
    }
}

测试

运用postMan创立webSocket恳求

输入webSocket的地址，1表明userId=1

此刻控制台输出

2022-11-15 11:51:43.009  INFO 28972 --- [nio-8787-exec-5] com.czf.study.wevSocket.WebSocketServer  : 用户衔接:1,当时在线人数为:1

接下来，模仿服务端给客户端发送恳求，树立一个http恳求

控制台输出

2022-11-15 11:53:48.235  INFO 28972 --- [nio-8787-exec-4] com.czf.study.wevSocket.WebSocketServer  : 发送音讯到:1，报文:hello

客户端收到恳求

双人聊天室

webSocket经常被用作聊天室，两个客户端，通过一个服务端分发恳求，进行沟通。

在此案例中，通过/来区分，前一个是音讯，后一个是发送的目标。

    /**
     * 收到客户端音讯后调用的办法
     *
     * @param message 客户端发送过来的音讯*/
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("【websocket音讯】收到客户端发来的音讯:{}", message);
        String[] split = message.split("/");
        try {
            sendInfo(split[0],split[1]);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

比如

2号用户收到1号发送的音讯

同样的，2号也能够发送音讯给1号。