什么是WebSocket 和 Java使用WebSocket实现前后端交互实战（可用作在线沟通）

概念：什么是WebSocket

百度百科介绍

WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket通信协议于2011年被IETF定为标准RFC 6455，并由RFC7936补充规范。WebSocket API也被W3C定为标准。

WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

小结：websocket最大的特点就是允许服务端主动向客户端发送消息。

1、搭建一个普通的springBoot项目，再添加WebSocket依赖

老规矩，从搭建项目开始。

<!--websocket-->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-websocket</artifactId>
	<exclusions>
		<exclusion>
		  <groupId>org.springframework.boot</groupId>
		  <artifactId>spring-boot-starter-tomcat</artifactId>
		</exclusion>
	</exclusions>
</dependency>

2、开启WebSocket支持，同时编写服务

1、开启websocket支持

/**
 * 开启WebSocket支持
 * @author Eric
 * @create 2022-07-18 23:07
 */
@Configuration
public class WebSocketConfig22 {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

2、编写WebSocket服务

package com.yianjia.huozhu.huozhu.websocket;

import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;

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

/**
* @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
* 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
*/
@ServerEndpoint("/webSocket/{userId}")
@Component
@Slf4j
public class NoticeWebsocket {

 //记录连接的客户端
 public static Map<String, Session> clients = new ConcurrentHashMap<>();

 /**
  * userId关联sid（解决同一用户id，在多个web端连接的问题）
  */
 public static Map<String, Set<String>> conns = new ConcurrentHashMap<>();

 private String sid = null;

 private String userId;


 @OnOpen
 public void onOpen(Session session, @PathParam("userId") String userId) {
     this.sid = UUID.randomUUID().toString();
     this.userId = userId;
     clients.put(this.sid, session);

     Set<String> clientSet = conns.get(userId);
     if (clientSet == null) {
         clientSet = new HashSet<>();
         conns.put(userId, clientSet);
     }
     clientSet.add(this.sid);
     //log.info(this.sid + "连接开启！");
 }

 @OnClose
 public void onClose() {
     //log.info(this.sid + "连接断开！");
     clients.remove(this.sid);
 }

 /**
  * 收到消息时执行
  *
  * @param message
  * @param session
  */
 @OnMessage
 public void onMessage(String message, Session session) {
     log.info("收到用户{}的消息:{}", this.userId, message);
     //回复用户
     //session.getAsyncRemote().sendText("收到 " + this.userId + " 的消息:" + message);
     session.getAsyncRemote().sendText(message);
 }


 public static void sendMessage(String noticeType) {
     NoticeWebsocketResp noticeWebsocketResp = new NoticeWebsocketResp();
     noticeWebsocketResp.setNoticeType(noticeType);
     sendMessage(noticeWebsocketResp);
 }


 /**
  * 发送给所有用户
  *
  * @param noticeWebsocketResp
  */
 public static void sendMessage(NoticeWebsocketResp noticeWebsocketResp) {
     String message = JSONObject.toJSONString(noticeWebsocketResp);
     for (Session session1 : NoticeWebsocket.clients.values()) {
         try {
             session1.getBasicRemote().sendText(message);
         } catch (IOException e) {
             e.printStackTrace();
         }
     }
 }

 /**
  * 根据用户id发送给某一个用户
  **/
 public static void sendMessageByUserId(String userId, NoticeWebsocketResp noticeWebsocketResp) {
     if (!StringUtils.isEmpty(userId)) {
         String message = JSONObject.toJSONString(noticeWebsocketResp);
         Set<String> clientSet = conns.get(userId);
         if (clientSet != null) {
             Iterator<String> iterator = clientSet.iterator();
             while (iterator.hasNext()) {
                 String sid = iterator.next();
                 Session session = clients.get(sid);
                 if (session != null) {
                     try {
                         session.getBasicRemote().sendText(message);
                     } catch (IOException e) {
                         e.printStackTrace();
                     }
                 }
             }
         }
     }
 }

 /**
  * 连接错误时执行
  * @param error
  */
 @OnError
 public void onError(Throwable error) {
     log.info("用户id为：{}的连接发送错误", this.userId);
     error.printStackTrace();
 }

}

3、构建一个返回对象

这一步根据需求自定义，如果只想返回一个消息，可以将上面的对象类型改为String，这里就不需要创建这个返回对象了。

/**
 * ws通知返回对象
 * @param <T>
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class NoticeWebsocketResp<T> {

    /**
     * 通知类型
     */
    private String noticeType;

    /**
     * 通知内容
     */
    private T noticeInfo;
}

4、测试

这里我用的是在线的webSocket工具：http://coolaf.com/tool/chattest

---

补充

最后补充下纯文本知识点，本来这一段打算放在开头，但由于内容有点多，影响文章整体阅读，所以决定放在文章末尾，赶时间的朋友可以溜了哦，因为接下来的内容没有实战，只有干巴。

为什么需要WebSocket

• 随着互联网的发展，传统的HTTP协议已经很难满足Web应用日益复杂的需求了
• 我们知道，传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如 浏览器）主动发起，服务端进行处理后返回response结果，而服务端很难主动向客户端发送数据；这种客户端是主动方，服务端是被动方的传统Web模式 对于信息变化不频繁的Web应用来说造成的麻烦较小，而对于涉及实时信息的Web应用却带来了很大的不便，如带有即时通信、实时数据、订阅推送等功能的应 用。在WebSocket规范提出之前，开发人员若要实现这些实时性较强的功能，经常会使用折衷的解决方法：轮询（polling）和Comet技术。其实后者本质上也是一种轮询，只不过有所改进。
• 轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求，频繁地查询是否有新的数据改动。明显地，这种方法会导致过多不必要的请求，浪费流量和服务器资源。
• Comet技术又可以分为长轮询和流技术。长轮询改进了上述的轮询技术，减小了无用的请求。它会为某些数据设定过期时间，当数据过期后才会向服务端发送请求；这种机制适合数据的改动不是特别频繁的情况。流技术通常是指客户端使用一个隐藏的窗口与服务端建立一个HTTP长连接，服务端会不断更新连接状态以保持HTTP长连接存活；这样的话，服务端就可以通过这条长连接主动将数据发送给客户端；流技术在大并发环境下，可能会考验到服务端的性能。
• 这两种技术都是基于请求-应答模式，都不算是真正意义上的实时技术；它们的每一次请求、应答，都浪费了一定流量在相同的头部信息上，并且开发复杂度也较大。
• 伴随着HTML5推出的WebSocket，真正实现了Web的实时通信，使B/S模式具备了C/S模式的实时通信能力。WebSocket的工作流程是这 样的：浏览器通过JavaScript向服务端发出建立WebSocket连接的请求，在WebSocket连接建立成功后，客户端和服务端就可以通过 TCP连接传输数据。因为WebSocket连接本质上是TCP连接，不需要每次传输都带上重复的头部数据，所以它的数据传输量比轮询和Comet技术小 了很多。本文不详细地介绍WebSocket规范，主要介绍WebSocket在Java Web中的实现。
• JavaEE 7中出了JSR-356:Java API for WebSocket规范。不少Web容器，如Tomcat,Nginx,Jetty等都支持WebSocket。Tomcat从7.0.27开始支持 WebSocket，从7.0.47开始支持JSR-356，下面的Demo代码也是需要部署在Tomcat7.0.47以上的版本才能运行。

---

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