Websocket——化神篇

WebSocket机制

   WebSocket 是 HTML5 一种新的协议。它实现了欣赏器与服务器全双工通信，能更好的节省服务器资源和带宽并到达实时通讯，它建立在 TCP 之上，同 HTTP 一样通过 TCP 来传输数据，但是它和 HTTP 最大差别是：
WebSocket 是一种双向通信协议，在建立连接后，WebSocket 服务器和 Browser/Client Agent 都能主动的向对方发送或接收数据，就像 Socket 一样；
WebSocket 须要雷同 TCP 的客户端和服务器端通过握手连接，连接成功后才能相互通信。
  和socket区别

   Socket其实并不是一个协议，而是为了方便使用TCP或UDP而抽象出来的一层，是位于应用层和传输控制层之间的一组接口。
    Socket是应用层与TCP/IP协议族通信的中央软件抽象层，它是一组接口。在设计模式中，Socket其实就是一个门面模式，它把复杂的TCP/IP协议族潜伏在Socket接口后面，对用户来说，一组简单的接口就是全部，让Socket去组织数据，以符合指定的协议。
当两台主机通信时，必须通过Socket连接，Socket则利用TCP/IP协议建立TCP连接。TCP连接则更依赖于底层的IP协议，IP协议的连接则依赖于链路层等更低层次。
WebSocket则是一个典范的应用层协议。
区别
Socket是传输控制层协议，WebSocket是应用层协议。
  前世此生

众所周知，Web 应用的交互过程通常是客户端通过欣赏器发出一个哀求，服务器端接收哀求后举行处理并返回结果给客户端，客户端欣赏器将信息呈现，这种机制对于信息变化不是特别频仍的应用尚可，但对于实时要求高、海量并发的应用来说显得捉襟见肘，尤其在当前业界移动互联网发达发展的趋势下，高并发与用户实时响应是 Web 应用经常面临的问题，好比金融证券的实时信息，Web 导航应用中的地理位置获取，交际网络的实时消息推送等。
消息推送常用方式

轮询方式

1.轮询是一种客户端与服务器之间实时通信的技能本领。客户端定期发送哀求来查询服务器是否有新数据或事件，并将响应返 回给客户端。如果服务器有新的数据或事件，则将其返回给客户端；如果没有，则返回一个空响应。客户端收到响应后，可 以处理数据或事件，并根据须要继续发送下一个哀求。
2.长轮询是一种改进的轮询技能，其主要目的是低落轮询过程中的资源消耗和延迟。长轮询的基本原理是客户端发送一个 HTTP哀求给服务器，并保持连接打开，直到服务器有新的数据或事件时才返回响应给客户端。在这期间，服务器会一直保持连接打开，直到超时或有新数据或事件（HTTP1.1版本就是这个性子长连接）
SSE(服务器发送事件)
   SSE在服务器和客户端之间打开一个单向通道
服务端响应的不再是一次性的数据包，而是text/event-stream类型的数据流信息
服务器有数据变动时将数据流式传输到客户端

  WebSocket

客户端API

服务端 API

Endpoint示例

1. @ServerEndpoint("/chat")
2. @Component
3. public class ChatEndpoint {
4.     @OnOpen
5.     //连接建立时被调用
6.     public void onOpen(Session session, EndpointConfig config){}
7.     @OnMessage
8.     //接收到客户端发送的数据时被调用
9.     public void onMessage(String message){}
10.     @OnClose
11.     //连接关闭时被调用
12.     public void onClose(Session session){}
13. }

复制代码

ChatEndpoint类通过实现WebSocket协议，用于处理客户端的连接、消息通报和关闭事件。
在线聊天室实现

流程分析

消息格式

引入坐标

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

复制代码

编写设置类

1. @Configuration
2. public class WebsocketConfig {
4.     @Bean
5.     public ServerEndpointExporter serverEndpointExporter() {
6.         return new ServerEndpointExporter();
7.     }
8. }

复制代码

通过在设置类中界说一个 ServerEndpointExporter 的 @Bean 方法，Spring 会主动创建一个 ServerEndpointExporter 实例，并将其加入到 Spring 容器中。Spring框架会在启动时通过这个实例主动扫描项目中全部使用@ServerEndpoint注解的类，并将它们注册为WebSocket端点。
编写设置类，用于获取 HttpSession 对象

1. public class GetHttpSessionConfig extends ServerEndpointConfig.Configurator {
3.     @Override
4.     public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
5.         //获取HttpSession对象
6.         HttpSession httpSession = (HttpSession) request.getHttpSession();
7.         //将httpSession对象保存起来
8.         sec.getUserProperties().put(HttpSession.class.getName(),httpSession);
9.     }
10. }

复制代码

GetHttpSessionConfig类用于在WebSocket握手过程中获取HTTP会话（HttpSession）对象，并将其保存到用户属性中，以便在WebSocket会话中使用。

ChatEndpoint类

1. package com.itheima.ws;
3. import com.alibaba.fastjson.JSON;
4. import com.itheima.config.GetHttpSessionConfig;
5. import com.itheima.utils.MessageUtils;
6. import com.itheima.ws.pojo.Message;
7. import org.springframework.stereotype.Component;
9. import javax.servlet.http.HttpSession;
10. import javax.websocket.*;
11. import javax.websocket.server.ServerEndpoint;
12. import java.util.Map;
13. import java.util.Set;
14. import java.util.concurrent.ConcurrentHashMap;
16. /**
17. * @version v1.0
18. * @ClassName: ChatEndpoint
19. * @Description: TODO(一句话描述该类的功能)
20. * @Author: 黑马程序员
21. */
22. @ServerEndpoint(value = "/chat",configurator = GetHttpSessionConfig.class)
23. @Component
24. public class ChatEndpoint {
26.     private static final Map<String,Session> onlineUsers = new ConcurrentHashMap<>();
28.     private HttpSession httpSession;
30.     /**
31.      * 建立websocket连接后，被调用
32.      * @param session
33.      */
34.     @OnOpen
35.     public void onOpen(Session session, EndpointConfig config) {
36.         //1，将session进行保存
37.         this.httpSession = (HttpSession) config.getUserProperties().get(HttpSession.class.getName());
38.         String user = (String) this.httpSession.getAttribute("user");
39.         onlineUsers.put(user,session);
40.         //2，广播消息。需要将登陆的所有的用户推送给所有的用户
41.         String message = MessageUtils.getMessage(true,null,getFriends());
42.         broadcastAllUsers(message);
43.     }
45.     public Set getFriends() {
46.         Set<String> set = onlineUsers.keySet();
47.         return set;
48.     }
50.     private void broadcastAllUsers(String message) {
51.         try {
52.             //遍历map集合
53.             Set<Map.Entry<String, Session>> entries = onlineUsers.entrySet();
54.             for (Map.Entry<String, Session> entry : entries) {
55.                 //获取到所有用户对应的session对象
56.                 Session session = entry.getValue();
57.                 //发送消息
58.                 session.getBasicRemote().sendText(message);
59.             }
60.         } catch (Exception e) {
61.             //记录日志
62.         }
63.     }
65.     /**
66.      * 浏览器发送消息到服务端，该方法被调用
67.      *
68.      * 张三  -->  李四
69.      * @param message
70.      */
71.     @OnMessage
72.     public void onMessage(String message) {
73.         try {
74.             //将消息推送给指定的用户
75.             Message msg = JSON.parseObject(message, Message.class);
76.             //获取 消息接收方的用户名
77.             String toName = msg.getToName();
78.             String mess = msg.getMessage();
79.             //获取消息接收方用户对象的session对象
80.             Session session = onlineUsers.get(toName);
81.             String user = (String) this.httpSession.getAttribute("user");
82.             String msg1 = MessageUtils.getMessage(false, user, mess);
83.             session.getBasicRemote().sendText(msg1);
84.         } catch (Exception e) {
85.             //记录日志
86.         }
87.     }
89.     /**
90.      * 断开 websocket 连接时被调用
91.      * @param session
92.      */
93.     @OnClose
94.     public void onClose(Session session) {
95.         //1,从onlineUsers中剔除当前用户的session对象
96.         String user = (String) this.httpSession.getAttribute("user");
97.         onlineUsers.remove(user);
98.         //2,通知其他所有的用户，当前用户下线了
99.         String message = MessageUtils.getMessage(true,null,getFriends());
100.         broadcastAllUsers(message);
101.     }
102. }

复制代码

@ServerEndpoint(value = “/chat”, configurator = GetHttpSessionConfig.class) 这行代码声明了一个 WebSocket 端点，客户端可以通过 /chat 路径与之建立连接，并且在握手阶段使用 GetHttpSessionConfig 类来举行自界说设置。
该类是Spring Boot应用中的一个WebSocket端点，它用于处理聊天功能。主要功能包罗：

• 在用户建立WebSocket连接时保存用户信息和会话对象。
  
• 当用户发送消息时，将消息转发给指定的接收用户。
  
• 当用户断开连接时，从在线用户列表中移除用户并关照其他用户。
  
• 使用GetHttpSessionConfig设置器来获取HTTP会话中的用户信息。
  userController
  

1. package com.itheima.controller;
3. import com.itheima.pojo.Result;
4. import com.itheima.pojo.User;
5. import org.springframework.web.bind.annotation.*;
7. import javax.servlet.http.HttpSession;
10. @RestController
11. @RequestMapping("user")
12. public class UserController {
14.     /**
15.      * 登陆
16.      * @param user 提交的用户数据，包含用户名和密码
17.      * @param session
18.      * @return
19.      */
20.     @PostMapping("/login")
21.     public Result login(@RequestBody User user, HttpSession session) {
22.         Result result = new Result();
23.         if(user != null && "123".equals(user.getPassword())) {
24.             result.setFlag(true);
25.             //将数据存储到session对象中
26.             session.setAttribute("user",user.getUsername());
27.         } else {
28.             result.setFlag(false);
29.             result.setMessage("登陆失败");
30.         }
31.         return result;
32.     }
34.     /**
35.      * 获取用户名
36.      * @param session
37.      * @return
38.      */
39.     @GetMapping("/getUsername")
40.     public String getUsername(HttpSession session) {
42.         String username = (String) session.getAttribute("user");
43.         return username;
44.     }
45. }

复制代码

Result

1. package com.itheima.pojo;
3. import lombok.Data;
5. /**
6. * @version v1.0
7. * @ClassName: Result
8. * @Description: 用来封装http请求的响应数据
9. * @Author: 黑马程序员
10. */
11. @Data
12. public class Result {
13.     private boolean flag;
14.     private String message;
15. }

复制代码

User

1. package com.itheima.pojo;
3. import lombok.Data;
5. /**
6. * @version v1.0
7. * @ClassName: User
8. * @Description: 接收登录请求的数据
9. * @Author: 黑马程序员
10. */
11. @Data
12. public class User {
14.     private String userId;
15.     private String username;
16.     private String password;
17. }

复制代码

MessageUtils

1. package com.itheima.utils;
3. import com.alibaba.fastjson.JSON;
4. import com.itheima.ws.pojo.ResultMessage;
6. /**
7. * @version v1.0
8. * @ClassName: MessageUtils
9. * @Description: 封装json格式消息的工具类
10. * @Author: 黑马程序员
11. */
12. public class MessageUtils {
14.     public static String getMessage(boolean isSystemMessage,String fromName, Object message) {
16.         ResultMessage result = new ResultMessage();
17.         result.setSystem(isSystemMessage);
18.         result.setMessage(message);
19.         if(fromName != null) {
20.             result.setFromName(fromName);
21.         }
22.         return JSON.toJSONString(result);
23.     }
24. }

复制代码

Message

1. package com.itheima.ws.pojo;
3. import lombok.Data;
5. /**
6. * @version v1.0
7. * @ClassName: Message
8. * @Description: 用于封装浏览器发送给服务端的消息数据
9. * @Author: 黑马程序员
10. */
11. @Data
12. public class Message {
13.     private String toName;
14.     private String message;
15. }

复制代码

ResultMessage

1. package com.itheima.ws.pojo;
3. import lombok.Data;
5. /**
6. * @version v1.0
7. * @ClassName: ResultMessage
8. * @Description: 用来封装服务端给浏览器发送的消息数据
9. * @Author: 黑马程序员
10. */
11. @Data
12. public class ResultMessage {
14.     private boolean isSystem;
15.     private String fromName;
16.     private Object message;//如果是系统消息是数组
17. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。