WebSocket(一)
1.WebSocket 是什么?
WebSocket 是一种网络通信协议。
2.为什么需要 WebSocket ?
了解计算机网络协议的人,应该都知道:HTTP 协议是一种无状态的、无连接的、单向的应用层协议。它采用了请求/响应模型。通信请求只能由客户端发起,服务端对请求做出应答处理。
这种通信模型有一个弊端:HTTP 协议无法实现服务器主动向客户端发起消息。
这种单向请求的特点,注定了如果服务器有连续的状态变化,客户端要获知就非常麻烦。大多数 Web 应用程序将通过频繁的异步JavaScript和XML(AJAX)请求实现长轮询。轮询的效率低,非常浪费资源(因为必须不停连接,或者 HTTP 连接始终打开)。
然而:
WebSocket 连接允许客户端和服务器之间进行全双工通信,以便任一方都可以通过建立的连接将数据推送到另一端。WebSocket 只需要建立一次连接,就可以一直保持连接状态。这相比于轮询方式的不停建立连接显然效率要大大提高。
3.WebSocket 如何工作?
3.1Web浏览器和服务器都必须实现 WebSockets 协议来建立和维护连接。由于 WebSockets 连接长期存在,与典型的HTTP连接不同,对服务器有重要的影响。
基于多线程或多进程的服务器无法适用于 WebSockets,因为它旨在打开连接,尽可能快地处理请求,然后关闭连接。任何实际的 WebSockets 服务器端实现都需要一个异步服务器。
3.2.1客户端实现webSockets:
以下 API 用于创建 WebSocket 对象。
var Socket = new WebSocket(url, [protocol] );
以上代码中的第一个参数 url, 指定连接的 URL。第二个参数 protocol 是可选的,指定了可接受的子协议。
(还有些扩展细节:webSocket的属性、事件、方法https://www.cnblogs.com/jingmoxukong/p/7755643.html)
实例:
// 初始化一个 WebSocket 对象 var ws = new WebSocket("ws://localhost:9998/echo"); // 建立 web socket 连接成功触发事件 ws.onopen = function () { // 使用 send() 方法发送数据 ws.send("发送数据"); alert("数据发送中..."); }; // 接收服务端数据时触发事件 ws.onmessage = function (evt) { var received_msg = evt.data; alert("数据已接收..."); }; // 断开 web socket 连接成功触发事件 ws.onclose = function () { alert("连接已关闭..."); };
3.2.2服务器端使用Spring实现webSockets:
(服务器端实现webSocket的方式非常丰富,Node.js、Java、C++、Python 等多种语言都有自己的解决方案。可参考https://www.cnblogs.com/jingmoxukong/p/7755643.html)
1.先导jar包(Spring+WebSocket所依赖的jar包):
WebSocketConfigurer
package com.ssm.websocket; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.socket.WebSocketHandler; import org.springframework.web.socket.config.annotation.EnableWebSocket; import org.springframework.web.socket.config.annotation.WebSocketConfigurer; import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry; import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor; /* @Configuration的作用 声明当前类是一个配置类 @Configuration不可以是final类型; @Configuration不可以是匿名类; 嵌套的configuration必须是静态类。 @EnableWebSocket 声明该类支持WebSocket */ @Configuration @EnableWebSocket public class MySocketConfig implements WebSocketConfigurer { //websocket入口,允许访问的域、注册Handler、SockJs支持和拦截器。 public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(myHandler(),"/websocket")//入口路径为websocket .addInterceptors(new SpringWebSocketHandler()) .setAllowedOrigins("*"); //setAllowedOrigins()方法的支持spring4.1.5之后的版本才支持 //setAllowedOrigins(String... val),允许指定的域名或IP(含端口号)建立长连接, // 可以只设置允许自家域名访问,如果不限时使用"*"号,如果指定了域名, // 则必须要以http或https开头。 } @Bean public WebSocketHandler myHandler(){ return new MySocketHandler(); } @Bean public HttpSessionHandshakeInterceptor myHandlerInterceptor(){ return new SpringWebSocketHandler(); } }
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:websocket="http://www.springframework.org/schema/websocket" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/websocket http://www.springframework.org/schema/websocket/spring-websocket.xsd"> <websocket:handlers> <websocket:mapping path="/myHandler" handler="myHandler"/> </websocket:handlers> <bean id="myHandler" class="org.springframework.samples.MyHandler"/> </beans>
![](https://img2018.cnblogs.com/blog/1711104/201907/1711104-20190711140528704-455994832.png)
package com.ssm.websocket; import com.lingdian.pojo.User; import org.springframework.http.server.ServerHttpRequest; import org.springframework.http.server.ServerHttpResponse; import org.springframework.http.server.ServletServerHttpRequest; import org.springframework.web.socket.*; import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor; import javax.servlet.http.HttpSession; import java.util.Map; /* 握手拦截器类 */ public class SpringWebSocketHandler extends HttpSessionHandshakeInterceptor { @Override public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception { System.out.println("Before Handshake"); //在握手之前将HttpSession中的用户,copy放到WebSocket Session中 if (request instanceof ServletServerHttpRequest){ ServletServerHttpRequest servletServerHttpRequest= (ServletServerHttpRequest) request; HttpSession session= servletServerHttpRequest.getServletRequest().getSession(true); if (null!=session){ User user=(User)session.getAttribute("user"); //WebSocket Session attributes.put("user",user); } } return super.beforeHandshake(request,response,wsHandler,attributes); } @Override public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception ex) { super.afterHandshake(request, response, wsHandler, ex); } }
TextWebSocketHandler
或 BinaryWebSocketHandler
,你可以覆写指定的方法。Spring 在收到 WebSocket 事件时,会自动调用事件对应的方法。![](https://img2018.cnblogs.com/blog/1711104/201907/1711104-20190711140655535-856511420.png)
package com.ssm.websocket; import com.lingdian.pojo.Message; import com.lingdian.pojo.User; import com.lingdian.service.MessageService; import org.springframework.web.socket.CloseStatus; import org.springframework.web.socket.TextMessage; import org.springframework.web.socket.WebSocketSession; import org.springframework.web.socket.handler.TextWebSocketHandler; import javax.annotation.Resource; import java.text.SimpleDateFormat; import java.util.Date; import java.util.concurrent.CopyOnWriteArraySet; /*** * 消息处理类 */ public class MySocketHandler extends TextWebSocketHandler { //使用CopyOnWriteArraySet,保证线程安全,当一个用户 // 退出时,这边的用户查看用户列表时不会出现安全失败 private static CopyOnWriteArraySet<WebSocketSession> users=new CopyOnWriteArraySet<WebSocketSession>();; @Resource private MessageService messageService; @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { //super.handleTextMessage(session, message); SimpleDateFormat sd = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); String time = sd.format(new Date()); //从 WebSocket Session中取得用户 User user=(User) session.getAttributes().get("user"); Message message1=new Message(); message1.setUid(user.getId()); message1.setMessage(message.getPayload()); message1.setSendTime(new Date()); //将消息保存到数据库 messageService.insertMessage(message1); //封装要输出的消息到TextMessage,姓名,时间,消息 TextMessage returnMessage = new TextMessage(user.getName()+":" + ""+time+"<br/>"+message.getPayload()); for (WebSocketSession session1 : users) { try{ //使用sendMessage()方法输出消息到客户端 session1.sendMessage(returnMessage); }catch (Exception e){ e.printStackTrace(); continue; } } } /** * 连接成功时候,会触发页面上onopen方法 * 加入一个用户 add进集合 * @param session * @throws Exception */ @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { users.add(session); System.out.println("connect to the websocket success......当前数量:"+users.size()); } /** * 关闭链接时触发,当用户退出时,将用户从集合remove * @param session * @param status * @throws Exception */ @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { users.remove(session); System.out.println("剩余在线用户"+users.size()); } public static CopyOnWriteArraySet<WebSocketSession> getUsers() { return users; } public static void setUsers(CopyOnWriteArraySet<WebSocketSession> users) { MySocketHandler.users = users; } public MessageService getMessageService() { return messageService; } public void setMessageService(MessageService messageService) { this.messageService = messageService; } }
- MySocket——imp——WebSocketConfig
- 为WebSocketHandlerRegistry
- 加上handler(自定义的),配置入口路径
- 加上intercept(自定义的)
- 配置允许访问的域名(什么域名能访问到我这)
- SpringWebSocketHandler——ext——HttpSessionHandshakeInterceptor
- 握手前方法(把session的usercopy到websocket的session中)
- 握手后方法
- MySocketHandler——ext——TextWebSocketHandler或BinaryWebSocketHandler
- 打开连接时触发
- 关闭连接时触发
- 处理消息