【SpringBoot+WebSocket】实现简单的即时通讯

Bummon.

已于 2023-08-12 17:36:27 修改

阅读量1.1k

点赞数 4

文章标签： spring boot websocket java

于 2023-03-21 12:03:03 首次发布

本文链接：https://blog.csdn.net/HackAzrael/article/details/129684007

版权

SpringBoot整合Websocket实现简单的即时通讯

前言
代码编写
测试
- 客户端向服务端发送消息
- 测试服务端向客户端发送消息
推荐

前言

很多网站为了实现推送技术，所用的技术都是轮询。轮询是在特定的时间间隔（如每10秒请求一次），由浏览器对服务器发出HTTP请求，然后由服务器返回最新的数据给客户端的浏览器。

这种传统的模式带来很明显的缺点，即浏览器需要不断的向服务器发出请求，然而HTTP请求可能包含较长的头部，其中真正有效的数据可能只是很小的一部分，显然这样会浪费很多的带宽等资源。

而比较新的技术去做轮询的效果是Comet。这种技术虽然可以双向通信，但依然需要反复发出请求。而且在Comet中，普遍采用的长链接，也会消耗服务器资源。

在这种情况下，HTML5定义了WebSocket协议，能更好的节省服务器资源和带宽，并且能够更实时地进行通讯。

代码编写

依赖

        <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

这里的clientId是为了区别客户端，适用于与指定客户端通讯的场景，可以使用业务中的用户id来传递

@Slf4j
@Component
@ServerEndpoint(value = "/api/ws/{clientId}")
public class WebSocketServer {

    @PostConstruct
    public void init() {
        log.info("加载WebSocket");
    }

    private static final AtomicInteger ONLINE_COUNT = new AtomicInteger(0);
    /**
     * concurrent包的线程安全Map，用来存放每个客户端对应的Session对象
     */
    private static Map<String, Session> SESSION_MAP = new ConcurrentHashMap<>();

    private Session theSession;

    /**
     * @param session
     * @date 2023-03-13 17:41:02
     * @author Bummon
     * @description 连接成功回调方法
     */
    @OnOpen
    public void onOpen(@PathParam("clientId") String clientId, Session session) {
        if (!SESSION_MAP.containsKey(clientId)) {
            //连接数+1
            int count = ONLINE_COUNT.getAndIncrement();
        }
        SESSION_MAP.put(clientId, session);
        this.theSession = session;
        log.info("客户端[{}]建立连接，当前连接数：{}", clientId, ONLINE_COUNT.get());
        sendMessage(session, "连接成功");
    }

    /**
     * @date 2023-03-13 17:43:29
     * @author Bummon
     * @description 连接关闭回调方法
     */
    @OnClose
    public void onClose(@PathParam("clientId") String clientId) {
        SESSION_MAP.remove(clientId);
        if (!SESSION_MAP.containsKey(clientId)) {
            //连接数-1
            int count = ONLINE_COUNT.getAndDecrement();
        }
        log.info("连接[{}]关闭，当前连接数：{}", clientId, ONLINE_COUNT.get());
    }

    /**
     * @param message 客户端发来的消息
     * @param session
     * @date 2023-03-13 17:45:08
     * @author Bummon
     * @description 收到客户端的消息回调方法
     */
    @OnMessage
    public void onMessage(String message, Session session, @PathParam("clientId") String clientId) {
        log.info("来自客户端[{}]的消息：{}", clientId, message);
        sendMessage(session, "收到消息：" + message);
    }

    /**
     * @param session
     * @param throwable
     * @date 2023-03-13 17:47:40
     * @author Bummon
     * @description 抛异常回调方法
     */
    @OnError
    public void onError(Session session, Throwable throwable) {
        log.error("发生错误：{}", throwable.getMessage());
        throwable.printStackTrace();
    }

    /**
     * @param session
     * @param message 要发送的消息
     * @date 2023-03-13 17:51:01
     * @author Bummon
     * @description 发送消息
     */
    public static void sendMessage(Session session, String message) {
        try {
            session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            log.error("发送消息出错：{}", e.getMessage());
        }
    }

    /**
     * @param message 要发送的消息
     * @date 2023-03-13 18:01:45
     * @author Bummon
     * @description 向指定客户端发送消息
     */
    public static void sendMessage(String clientId, String message) {
        Session session = null;
        for (String s : SESSION_MAP.keySet()) {
            if (s.equals(clientId)) {
                session = SESSION_MAP.get(s);
            }
        }
        if (session != null) {
            sendMessage(session, message);
        } else {
            log.warn("未找到指定的clientId：{}", clientId);
        }
    }

    /**
     * @param message 要发送的消息
     * @date 2023-03-13 17:53:06
     * @author Bummon
     * @description 群发所有人
     */
    public static void broadCastInfo(String message) throws IOException {
        SESSION_MAP.keySet().forEach(a -> {
            Session session = SESSION_MAP.get(a);
            if (session.isOpen()) {
                sendMessage(a, message);
            }
        });
    }

Controller

@RestController
@RequiredArgsConstructor
public class TestController {
    
    @RequestMapping("/push/{toClientId}")
    public ResponseEntity<String> pushMessage(@PathVariable String toClientId,String message) throws IOException {
        WebSocketServer.sendMessage(toClientId, message);
        return ResponseEntity.ok("SUCCESS");
    }
}