当前位置：首页 > 文章列表 > 文章 > java教程 > Java实现WebSocket实时聊天教程

Java实现WebSocket实时聊天教程

2025-08-05 09:51:47 0浏览收藏

本教程详解如何使用Java和WebSocket构建实时聊天应用。主要讲解如何利用Java EE或Spring框架，搭建服务端WebSocket端点，并使用浏览器WebSocket API实现客户端连接和双向通信。文章涵盖环境搭建、服务端代码编写（包括连接管理、消息广播等）、Spring Boot配置WebSocket支持、前端WebSocket连接实现，以及跨域问题、JSON数据格式、用户身份识别、消息持久化和并发安全等关键注意事项。通过本教程，开发者可以掌握Java WebSocket实时聊天功能的核心技术，构建稳定、高效的聊天系统。

在Java中使用WebSocket实现实时聊天功能，主要通过Java EE或Spring框架实现，核心是建立服务端WebSocket端点并让客户端通过浏览器API连接通信。1. 准备开发环境：确保使用支持WebSocket的容器，如Tomcat 7+或Spring Boot，并添加相应依赖；2. 编写服务端代码：定义@ServerEndpoint类处理连接、消息广播和连接管理；3. 配置WebSocket支持：在Spring Boot中注册WebSocket配置类并设置跨域允许；4. 前端连接WebSocket：使用原生WebSocket API创建连接、监听消息并发送数据；5. 注意事项：处理跨域问题、使用JSON格式传输结构化数据、用户身份识别、消息持久化及并发安全。整个流程需关注连接管理、异常处理和消息设计等细节，才能构建稳定聊天系统。

Java中使用WebSocket实现实时聊天功能的完整实现方案

在Java中使用WebSocket实现实时聊天功能，主要是借助Java EE或Spring框架提供的WebSocket支持来完成。核心思路是建立一个服务端WebSocket端点，客户端通过浏览器的WebSocket API连接并收发消息，从而实现双向通信。

下面从几个关键部分入手，带你一步步实现一个基础但完整的实时聊天功能。

1. 准备开发环境

要使用WebSocket，首先确保你的项目运行在支持WebSocket的容器上，比如Tomcat 7+、Jetty或使用Spring Boot内置的Tomcat。

如果你用的是Spring Boot，添加如下依赖即可：

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

如果是纯Java EE项目，确保你有javax.websocket-api依赖，并部署在支持Servlet 3.1以上的服务器上。

2. 编写WebSocket服务端代码

在服务端，你需要定义一个WebSocket端点类，用来处理连接、接收消息、广播消息等逻辑。

以下是一个简单的例子：

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

@ServerEndpoint("/chat")
public class ChatEndpoint {

    private static final Set<Session> sessions = new CopyOnWriteArraySet<>();

    @OnOpen
    public void onOpen(Session session) {
        sessions.add(session);
    }

    @OnMessage
    public void onMessage(String message, Session session) {
        // 收到消息后广播给所有连接的客户端
        for (Session s : sessions) {
            try {
                if (s.isOpen()) {
                    s.getBasicRemote().sendText(message);
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    @OnClose
    public void onClose(Session session) {
        sessions.remove(session);
    }

    @OnError
    public void onError(Session session, Throwable throwable) {
        throwable.printStackTrace();
    }
}

这段代码的关键点在于：

使用@ServerEndpoint注解指定访问路径
sessions集合保存当前所有活跃的连接
收到消息后遍历所有连接发送消息（广播）

3. 配置WebSocket支持（Spring Boot为例）

如果你使用的是Spring Boot，需要注册一个配置类来启用WebSocket支持：

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketRegistry registry) {
        registry.addHandler(new ChatWebSocketHandler(), "/chat")
                 .setAllowedOrigins("*"); // 允许跨域请求
    }
}

同时，你需要实现一个继承自TextWebSocketHandler的处理器类，用于处理连接和消息逻辑。

4. 前端页面如何连接WebSocket

前端只需要使用浏览器原生的WebSocket API就可以连接服务端。

一个简单的HTML + JavaScript示例：

<!DOCTYPE html>
<html>
<head>
    <title>Chat</title>
</head>
<body>
    &lt;input type=&quot;text&quot; id=&quot;messageInput&quot;&gt;
    <button onclick="sendMessage()">发送</button>
    <div id="chatBox"></div>

    <script>
        const ws = new WebSocket("ws://localhost:8080/chat");

        ws.onopen = function () {
            console.log("已连接");
        };

        ws.onmessage = function (event) {
            const chatBox = document.getElementById("chatBox");
            chatBox.innerHTML += "<p>" + event.data + "</p>";
        };

        function sendMessage() {
            const input = document.getElementById("messageInput");
            ws.send(input.value);
            input.value = "";
        }
    </script>
</body>
</html>

这段代码做了几件事：