用java WebSocket做一个聊天室

Z时代
2024-01-10
分类：IT

最近一个项目中，需要用到Java的websocket新特性，于是就学了一下，感觉这技术还挺好玩的，瞬间知道网页上面的那些在线客服是怎么做的了。

先看图：

实现了多客户机进行实时通讯。

下面看代码项目结构图：很简单，就1个类，1个页面

然后看具体代码

先看后端代码


package com.main;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
/**
 * @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
 *         注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
 */
@ServerEndpoint("/websocket")
public class H5ServletServerSocket {
 // 静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
 private static int onlineCount = 0;
 // concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话，可以使用Map来存放，其中Key可以为用户标识
 private static CopyOnWriteArraySet<H5ServletServerSocket> webSocketSet = new CopyOnWriteArraySet<H5ServletServerSocket>();
 // 与某个客户端的连接会话，需要通过它来给客户端发送数据
 private Session session;
 /**
 * 连接建立成功调用的方法
 * 
 * @param session
 *      可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
 */
 @OnOpen
 public void onOpen(Session session) {
 this.session = session;
 webSocketSet.add(this); // 加入set中
 addOnlineCount(); // 在线数加1
 System.out.println("有新连接加入！当前在线人数为" + getOnlineCount());
 }
 /**
 * 连接关闭调用的方法
 */
 @OnClose
 public void onClose() {
 webSocketSet.remove(this); // 从set中删除
 subOnlineCount(); // 在线数减1
 System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());
 }
 /**
 * 收到客户端消息后调用的方法
 * 
 * @param message
 *      客户端发送过来的消息
 * @param session
 *      可选的参数
 */
 @OnMessage
 public void onMessage(String message, Session session) {
 System.out.println("来自客户端的消息:" + message);
 // 群发消息
 for (H5ServletServerSocket item : webSocketSet) {
  try {
  item.sendMessage(message);
  } catch (IOException e) {
  e.printStackTrace();
  continue;
  }
 }
 }
 /**
 * 发生错误时调用
 * 
 * @param session
 * @param error
 */
 @OnError
 public void onError(Session session, Throwable error) {
 System.out.println("发生错误");
 error.printStackTrace();
 }
 /**
 * 这个方法与上面几个方法不一样。没有用注解，是根据自己需要添加的方法。
 * 
 * @param message
 * @throws IOException
 */
 public void sendMessage(String message) throws IOException {
 this.session.getBasicRemote().sendText(message);
 // this.session.getAsyncRemote().sendText(message);
 }
 public static synchronized int getOnlineCount() {
 return onlineCount;
 }
 public static synchronized void addOnlineCount() {
 H5ServletServerSocket.onlineCount++;
 }
 public static synchronized void subOnlineCount() {
 H5ServletServerSocket.onlineCount--;
 }
}

接下来是前端页面代码：


<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%
 String path = request.getContextPath();
 String basePath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
  + path + "/";
%>
<!DOCTYPE HTML>
<html>
<head>
<base href="<%=basePath%>">
<title>My WebSocket</title>
</head>
<body>
 欢迎进入聊天室
 <div id="message" style="color: blue">【状态】</div>
 <br /> 昵称
 <input id="username" type="text" required="required"/>
 <br> 内容
 <input id="text" type="text" />
 <br />
 <button onclick="send()">发送</button>
 <button onclick="closeWebSocket()">关闭</button>
</body>
<script type="text/javascript">
 var websocket = null;
 //判断当前浏览器是否支持WebSocket
 if ('WebSocket' in window) {
 websocket = new WebSocket("ws://10.1.1.106:8080/Socket/websocket");
 } else {
 alert('不支持WebSocket!')
 }
 //连接发生错误的回调方法
 websocket.onerror = function() {
 setMessageInnerHTML("error");
 };
 //连接成功建立的回调方法
 websocket.onopen = function(event) {
 setMessageInnerHTML("聊天室开启");
 }
 //接收到消息的回调方法
 websocket.onmessage = function() {
 setMessageInnerHTML(event.data);
 }
 //连接关闭的回调方法
 websocket.onclose = function() {
 setMessageInnerHTML("聊天室关闭");
 }
 //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
 window.onbeforeunload = function() {
 websocket.close();
 }
 //将消息显示在网页上
 function setMessageInnerHTML(innerHTML) {
 document.getElementById('message').innerHTML += innerHTML + '<br/>';
 }
 //关闭连接
 function closeWebSocket() {
 websocket.close();
 }
 //发送消息
 function send() {
 var username = document.getElementById('username').value;
 var message = document.getElementById('text').value;
 var msg = "【" + username + "】发言:" + message
 websocket.send(msg);
 }
</script>
</html>