WebSocket的使用

最新推荐文章于 2024-07-30 21:53:02 发布

Santiago_M

最新推荐文章于 2024-07-30 21:53:02 发布

阅读量991

点赞数

分类专栏： java代码前端文章标签： WebSocket 即时通讯 web端消息通讯

本文链接：https://blog.csdn.net/Santiago_M/article/details/79165165

版权

java代码同时被 2 个专栏收录

22 篇文章 0 订阅

订阅专栏

前端

8 篇文章 0 订阅

订阅专栏

由于最近学习微信小程序做聊天时，有幸涉及到WebSocket协议；在这里我就把我认为最好理解的方法给大家呈现下前辈的文章；

声明参考引用的文章有：

http://blog.csdn.net/wwd0501/article/details/54582912

https://www.cnblogs.com/xdp-gacl/p/5193279.html

https://www.cnblogs.com/winkey4986/p/5478332.html

首先需要了解啥什么是WebSocket：

定义：是HTML5一种新的协议。它实现了浏览器与服务器全双工通信(full-duplex)。一开始的握手需要借助HTTP请求完成。

原理：WebSocket同HTTP一样也是应用层的协议，但是它是一种双向通信协议，是建立在TCP之上的。

目的：即时通讯，替代轮询

优点：轮询技术会导致过多不必要的请求，浪费流量和服务器资源，每一次请求、应答，都浪费了一定流量在相同的头部信息上，然而WebSocket的出现可以弥补这一缺点。在WebSocket中，只需要服务器和浏览器通过HTTP协议进行一个握手的动作，然后单独建立一条TCP的通信通道进行数据的传送。

注意：WebSocket和Socket没有半毛钱关系；是两个不完全不一样的东西；Socket是位于应用层和传输控制层之间的一组接口；（建立网络通信连接至少要一对端口号(socket)。socket本质是编程接口(API)，对TCP/IP的封装，TCP/IP也要提供可供程序员做网络开发所用的接口）；然而，WebSocket是应用层的协议。

随着H5以及微信公众号，小程序的快速发展；用户的消息等待时间急剧减短；响应速度也随之提高，这时及时消息也成为了程序的必须，之前的轮询机制太过浪费，所以WebSocket必定被重视；实现web端消息即时通讯的代码：

前端代码：

<%@ page language="java" pageEncoding="UTF-8" %>
<!DOCTYPE html>
<html>
<head>
<title>Java后端WebSocket的Tomcat实现</title>
</head>
<body>
Welcome<br/><input id="text" type="text"/>
<button οnclick="send()">发送消息</button>
<hr/>
<button οnclick="openWebSocket()">开启WebSocket连接</button>
<button οnclick="closeWebSocket()">关闭WebSocket连接</button>
<hr/>
<div id="message"></div>
</body>

<script type="text/javascript">
(function(window){
openWebSocket_m()
})(this);
var websocket = null;
function openWebSocket_m(){
//判断当前浏览器是否支持WebSocket
if ('WebSocket' in window) {
websocket = new WebSocket("ws://localhost:8080/WX_auth/websocket/李");
}else {
alert('当前浏览器 Not support websocket')
}

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

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

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

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

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

//将消息显示在网页上
function setMessageInnerHTML(innerHTML) {
document.getElementById('message').innerHTML += innerHTML + '<br/>';
}
}
//开启WebSocket连接
function openWebSocket() {
openWebSocket_m();
}
//关闭WebSocket连接
function closeWebSocket() {
websocket.close();
}

//发送消息
function send() {
var message = ‘{To:All,message:’+document.getElementById('text').value+'}';
websocket.send(message);
}
</script>
</html>

后端代码：

import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import com.alibaba.fastjson.JSONObject;

/**
* @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
* 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
*/
@ServerEndpoint("/websocket/{username}")
public class WebSocket {
//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话，可以使用Map来存放，其中Key可以为用户标识（这里就使用的Map实现一对一和一对多）

//private static CopyOnWriteArraySet<WebSocketTest> webSocketSet = new CopyOnWriteArraySet<WebSocketTest>();

private static Map<String, WebSocket> clients = new ConcurrentHashMap<String, WebSocket>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;

//单个连接的名称，及其session的关键字
private String username;
  /**
* 连接建立成功调用的方法
* @param session 可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
*/
@OnOpen
public void onOpen(@PathParam("username") String username, Session session) throws IOException {
this.username = username;
this.session = session;
addOnlineCount(); //在线数加1
clients.put(username, this); //将webSocket的连接存在map中，通过用户名来指定对应的session
System.out.println(username+"已连接"+session.getId()+"在线人数"+ getOnlineCount());
}
    /**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() throws IOException {
clients.remove(username);
subOnlineCount(); //在线数减1
System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());
}
   /**
* 收到客户端消息后调用的方法
* @param message 客户端发送过来的消息
* @param session 可选的参数
*/
@OnMessage
public void onMessage(String message) throws IOException { //message是服务器收到的消息json串；里面包括发给说，发的什么

System.out.println("来自客户端的消息:" + message);
JSONObject jsonTo = JSONObject.parseObject(message);
if (!jsonTo.get("To").equals("All")){ //一对一发
sendMessageTo("给一个人说："+jsonTo.get("message ").toString(), jsonTo.get("To").toString());
}else{ //群发
sendMessageAll("给所有人说："+jsonTo.get("message ").toString());
}
}
   /**
* 发生错误时调用
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
error.printStackTrace();
}
   /**
* 发给某一个人。
* @param message
* @throws IOException
*/
public void sendMessageTo(String message, String To) throws IOException {
// session.getBasicRemote().sendText(message);
//session.getAsyncRemote().sendText(message);
for (WebSocket item : clients.values()) {
if (item.username.equals(To) )
item.session.getAsyncRemote().sendText(To+‘---’+message);
}
}
//群发
public void sendMessageAll(String message) throws IOException {
for (WebSocket item : clients.values()) {
item.session.getAsyncRemote().sendText(message);
}
}
//保证onlineCount的线程安全，使用同步锁
public static synchronized int getOnlineCount() {
return onlineCount;
}

public static synchronized void addOnlineCount() {
WebSocket.onlineCount++;
}

public static synchronized void subOnlineCount() {
WebSocket.onlineCount--;
}

public static synchronized Map<String, WebSocket> getClients() {
return clients;
}
}

最后给大家说下如何后台主动推送消息给前端（消息推送，而非即时通讯）

第一步:
将之前的WebSocket端点设置成静态公共

public static Map<String, WebSocket> clients = new ConcurrentHashMap<String, WebSocket>();

第二步：

在服务端的某个方法中，调用该Set集合

        //群发消息
        for(MyWebSocket item: MyWebSocket.webSocketSet){ 
                try {
                  if(message!=null&&!"".equals(message)){
                      item.sendMessage(message);
                  }
                } catch (IOException e) {
                    e.printStackTrace();
                    continue;
                }
            }

或者：直接是其类中方法onMessage

@RequestMapping(value = "/login1", method = RequestMethod.GET)
public void login1(ModelMap modelMap,HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
String message="你好-----";
//群发消息
WebSocketTest.onMessage( message, WebSocketTest.session);
}

结果：