websocket

1. WebSocket介绍

• WebSocket 是一种网络通信协议。RFC6455 定义了它的通信标准。
  
• WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。
  
• HTTP 协议是一种无状态的、无连接的、单向的应用层协议。它采用了请求/响应模型。通信请求只能由客户端发起，服务端对请求做出应答处理。
  
• 这种通信模型有一个弊端：HTTP 协议无法实现服务器主动向客户端发起消息。
  
• 这种单向请求的特点，注定了如果服务器有连续的状态变化，客户端要获知就非常麻烦。大多数 Web 应用程序将通过频繁的异步 AJAX 请求实现长轮询。轮询的效率低，非常浪费资源（因为必须不停连接，或者 HTTP 连接始终打开）。
  

2. websocket协议

• 本协议有两部分：握手和数据传输。
  
• 握手是基于http协议的。
  

• 客户端（浏览器）实现
  

3.1 websocket对象
实现 WebSockets 的 Web 浏览器将通过 WebSocket 对象公开所有必需的客户端功能（主要指支持 Html5 的浏览器）。
以下 API 用于创建 WebSocket 对象：
var ws = new WebSocket(url);
参数url格式说明： ws://ip地址:端口号/资源名称
3.2 websocket事件

WebSocket 对象的相关事件
事件事件处理程序描述onopenwebsocket对象.onopen连接建立时触发onmessagewebsocket对象.onmessage客户端接收服务端数据时触发onerrorwebsocket对象.onerror通信发生错误时触发onclosewebsocket对象.onclose连接关闭时触发3.3 WebSocket方法

WebSocket 对象的相关方法:
方法描述send使用连接时发送消息服务器实现

Java WebSocket应用由一系列的WebSocketEndpoint组成。Endpoint 是一个java对象，代表WebSocket链接的一端，对于服务端，我们可以视为处理具体WebSocket消息的接口， 就像Servlet之与http请求一样。
我们可以通过两种方式定义Endpoint:
· 第一种是编程式， 即继承类 javax.websocket.Endpoint并实现其方法。
· 第二种是注解式, 即定义一个POJO, 并添加 @ServerEndpoint相关注解。
实现流程


服务端如何接收数据

通过为 Session 添加 MessageHandler 消息处理器来接收消息，当采用注解方式定义Endpoint时，我们还可以通过 @OnMessage 注解指定接收消息的方法。
服务端如何推送数据

发送消息则由RemoteEndpoint完成，其实例由Session维护，根据使用情况，我们可以通过
Session.getBasicRemote获取同步消息发送的实例，然后调用其sendXxx()方法就可以发送消息，可以通过
Session.getAsyncRemote获取异步消息发送实例。
实现一个简单的聊天室功能

步骤：

1.首先导入依赖

1. <dependencies>
2.     <dependency>
3.         <groupId>org.springframework.boot</groupId>
4.         <artifactId>spring-boot-starter-websocket</artifactId>
5.     </dependency>

复制代码

Message

1. @Data
2. @AllArgsConstructor
3. @NoArgsConstructor
4. public class Message {
5.     private Long id;
6.     @TableField(value = "from_user_id")
7.     private User fromUser;
8.     @TableField(value = "to_user_id")
9.     private User toUser;
10.      private String content;
11.     @TableField(fill = FieldFill.INSERT)
12.     private LocalDateTime createTime;
14.     @TableField(fill = FieldFill.INSERT)
15.     private LocalDateTime updateTime;
17.     private int messageType;
19.     @TableField(exist = false)
20.     private String toName;
22.     @TableField(exist = false)
23.     private String fromName;
25.     @TableField(exist = false)
26.     private String message;
28.     //添加好友码
29.     public static final int ADD_FRIEND = 2;
30.     //好友列表消息码
31.     public static final int FRIEND_LIST_TYPE = 3;

复制代码

Result

1. @Data
2. @AllArgsConstructor
3. @NoArgsConstructor
4. public class Result<T>{
5.     /**
6.      * 状态码
7.      */
8.     private Integer code;
9.     /**
10.      * 提示信息，如果有错误时，前端可以获取该字段进行提示
11.      */
12.     private boolean flag;
13.     private String message;
14.     private T data; //数据
17.     public static <T> Result<T> success(T object) {
18.         Result<T> r = new Result<T>();
19.         r.data = object;
20.         r.code = 1;
21.         r.flag = true;
22.         return r;
23.     }
25.     public static <T> Result<T> error(String message) {
26.         Result r = new Result();
27.         r.message = message;
28.         r.code = 0;
29.         r.flag = false;
30.         return r;
31.     }
32. }

复制代码

登录

1.     @PostMapping("/login")
2.     public Result<User> login(@RequestBody User user ,HttpSession session){
3.         String password = user.getPassword();
4.         String username = user.getUsername();
5.         log.info("用户登录操作");
6.          //MD5加密
7.         password = DigestUtils.md5DigestAsHex(password.getBytes());
9.         //根据用户名查找数据库
10.         LambdaQueryWrapper<User> wrapper =new LambdaQueryWrapper<>();
11.         wrapper.eq(User::getUsername,username);
12.         User one = userService.getOne(wrapper);
13.         if (one == null){
14.             return Result.error("用户不存在，请先注册");
15.         }if (! one.getPassword().equals(password)){
16.             return Result.error("用户名或者密码有误");
17.         }
18.         // 登录成功，将用户的ID存储到WebSocket连接的Session中
20.         session.setAttribute("userId", one.getId()); // 假设用户ID为one.getId()
21.         String sessionId = session.getId();
23.         return Result.success(one);
24.     }

复制代码

获取用户名

1.     @GetMapping("/getUsername")
2.     private String getUsername(HttpSession session) {
3.         // 从 HttpSession 中获取用户信息
4.         User user = (User) session.getAttribute("user");
5.         if (user != null) {
6.             return user.getUsername();
7.         }
8.         return null;
9.     }

复制代码

配置

1. @Configuration
2. @EnableWebSocketMessageBroker
3. public class WebsocketConfig implements WebSocketMessageBrokerConfigurer {
5.     @Bean
6.     //注入ServerEndpointExporter bean.对象，自动注册使用了@ServerEndpoint
7.     public ServerEndpointExporter serverEndpointExporter(){
8.         return  new ServerEndpointExporter();
9.     }
11.     @Override
12.     public void registerStompEndpoints(StompEndpointRegistry registry) {
13.         // 定义一个 WebSocket 入口，客户端需要连接到它才能接收推送消息
14.         registry.addEndpoint("/websocket").withSockJS();
15.     }
17.     @Override
18.     public void configureMessageBroker(MessageBrokerRegistry config) {
19.         // 启用推送的消息代理（即使用 STOMP 实现 WebSocket 的代理）
20.         config.enableSimpleBroker("/topic");
21.         // 开启基于用户的 WebSocket 会话
22.         config.setUserDestinationPrefix("/user");
23.     }
24. }
28. public class GetHttpSessionConfig extends ServerEndpointConfig.Configurator {
30.     /**
31.      * 获取session对象
32.      * @param sec
33.      * @param request
34.      * @param response
35.      */
36.     @Override
37.     public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
38.          //获取HttpSession.对象
39.         HttpSession httpsession = (HttpSession) request.getHttpSession();
40.         //将httpSession存储到配置对象
41.         sec.getUserProperties().put(HttpSession.class.getName(), httpsession);
42.     }
43. }

复制代码

聊天室功能

1. @ServerEndpoint(value = "/chat",configurator = GetHttpSessionConfig.class)
2. @Component
3. @Slf4j
4. public class ChatEndpoint {
6.     private Session session;
7.     private static HttpSession httpSession;
8.     //用来存储每一个客户端对象对应的ChatEndpoint对象
9.     private static final Map<String,Session> onlineUsers = new ConcurrentHashMap<>();
10.     @OnOpen
11.     public void onopen(Session session, EndpointConfig config) {
12.         //将局部的session对象赋值给成员session
13.         this.session = session;
14.         //获取Httpsession对象 ，键值对集合，得到键获取值
15.         this.httpSession = (HttpSession) config.getUserProperties().get(HttpSession.class.getName());
16.         String user = (String) this.httpSession.getAttribute("user");
17.         onlineUsers.put(user,session);
18.         //广播消息，获取在线的所有好友
19.         String message = MessageUtils.getMessage(true, null, getFriendsName());
20.         broadcastAllUsers(message);
22.     }
24.     /**
25.      * 获取所有在线的好友信息，名称
26.      * @return
27.      */
28.     public Set getFriendsName(){
29.         Set<String> set = onlineUsers.keySet();
30.         return set;
31.     }
33.     /**
34.      * 发给所有人的广播
35.      * @param message
36.      */
37.     private void broadcastAllUsers(String message){
39. //        拿到所有的用户的chatEndpoint对象  //存储用户的session信息
40.         Set<Map.Entry<String,Session>> entries = onlineUsers.entrySet();
41.         //遍历map集合
42.         for (Map.Entry<String, Session> entry : entries) {
43.             //获取所有用户对应的session对象  //拥有getBasicRemote发送消息的方法
44.             Session session =entry.getValue();
45.             //发送消息
46.             try {
47.                 session.getBasicRemote().sendText(message);
48.             } catch (IOException e) {
49.                 e.printStackTrace();
50.             }
51.         }
52.     }
54.     @OnMessage
55.     public void onMessage(String message, @PathParam("username") String username){
56.         try {
57.             log.info("服务端收到用户username={}的消息:{}", username, message);
58.             //将消息转换成message对象
59.             Message msg = JSON.parseObject(message,Message.class);
60.             //获取接收方的用户名
61.             String toName = msg.getToName();
62.             //获取消息数据
63.             String message1 = msg.getMessage();
64.             //获取接收方的用户的session对象
65.             Session session = onlineUsers.get(toName);
66.             if (session != null) {
67.     //            获取当前登录的用户  从session中获取
68.                 String user = (String) httpSession.getAttribute("user");  //user代表的是发送方
69.                 String message2 = MessageUtils.getMessage(false, user, message1);
70.                     session.getBasicRemote().sendText(message2);
71.             }else {
72.                 log.info("未找到用户username{}的session",toName);
74.             }
75.             if (msg.ADD_FRIEND ==2 && session != null){
76.                 //获取发送发
77.                 String user = (String) httpSession.getAttribute("user");
78.                 //获取消息
79.                 String message2 = MessageUtils.getMessage(false, user, message1);
80.                 //发送
81.                 session.getBasicRemote().sendText(message2);
83.                 //将好友添加到相应的列表中,例如用Map存储好友列表
84.                 Map<String, List<String>> friendLists = (Map<String, List<String>>) httpSession.getAttribute("friendLists");
85.                 List<String> friendList=friendLists.get(user);
86.                 friendList.add(toName);
87.                 friendLists.put(user,friendList);
88.                 httpSession.setAttribute("friendLists", friendLists);
89.                 //发送好友列表
90.                 Message friendListMessage = new Message();
91.                 friendListMessage.setMessageType(3);
92.                 friendListMessage.setFromName("System");
93.                 friendListMessage.setToName(user);
94.                 friendListMessage.setMessage(JSON.toJSONString(friendList));
95.                 ChatEndpoint.send(friendListMessage,getFriendsName());
97.             }
98.             else {
99.                 log.info("未找到用户username{}的session",toName);
100.             }
101.         } catch (IOException e) {
102.             throw new RuntimeException(e);
103.         }
104.     }
106.     private static void send(Message friendListMessage, Set friendsName) {
107.         try {
108.             String toName = friendListMessage.getToName();
109.             String message = friendListMessage.getMessage();
110.             Session session = onlineUsers.get(toName);
111.             if (session != null) {
112.                 String json = JSON.toJSONString(message);
113.                 session.getBasicRemote().sendText(json);
114.             } else {
115.                 log.info("未找到用户{}的session", toName);
116.             }
117.         } catch (IOException e) {
118.             throw new RuntimeException(e);
119.         }
120.     }
124.     @OnClose
125.    public void onclose(Session session) {
126.         //提出session中的记录
127.        String user = (String) this.httpSession.getAttribute("user");
128.        onlineUsers.remove(user);
129.        //通知所有用户，此账号下线。
130.        String message = MessageUtils.getMessage(true, null, getFriendsName());
131.        broadcastAllUsers(message);
132.    }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！