java spring-WebSocket json参数传递与接收

2019/03/21 10:18
阅读数 59

Websocket原理(摘抄)

一、websocket与http

WebSocket是HTML5出的东西(协议),也就是说HTTP协议没有变化,或者说没关系,但HTTP是不支持持久连接的(长连接,循环连接的不算)

首先HTTP有 1.1 和 1.0 之说,也就是所谓的 keep-alive ,把多个HTTP请求合并为一个,但是 Websocket 其实是一个新协议,跟HTTP协议基本没有关系,只是为了兼容现有浏览器的握手规范而已,也就是说它是HTTP协议上的一种补充可以通过这样一张图理解

有交集,但是并不是全部。

另外Html5是指的一系列新的API,或者说新规范,新技术。Http协议本身只有1.0和1.1,而且跟Html本身没有直接关系。。通俗来说,你可以用HTTP协议传输非Html数据,就是这样=。=

再简单来说,层级不一样。

二、Websocket是什么样的协议,具体有什么优点

首先,Websocket是一个持久化的协议,相对于HTTP这种非持久的协议来说。简单的举个例子吧,用目前应用比较广泛的PHP生命周期来解释。

HTTP的生命周期通过 Request 来界定,也就是一个 Request 一个 Response ,那么在 HTTP1.0 中,这次HTTP请求就结束了。

在HTTP1.1中进行了改进,使得有一个keep-alive,也就是说,在一个HTTP连接中,可以发送多个Request,接收多个Response。但是请记住 Request = Response, 在HTTP中永远是这样,也就是说一个request只能有一个response。而且这个response也是被动的,不能主动发起。

教练,你BB了这么多,跟Websocket有什么关系呢?_(:з」∠)_好吧,我正准备说Websocket呢。。

首先Websocket是基于HTTP协议的,或者说借用了HTTP的协议来完成一部分握手。

首先我们来看个典型的 Websocket 握手(借用Wikipedia的。。)

GET /chat HTTP/1.1
Host: server.example.com
Upgrade: websocket Connection: Upgrade Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw== Sec-WebSocket-Protocol: chat, superchat Sec-WebSocket-Version: 13 Origin: http://example.com

熟悉HTTP的童鞋可能发现了,这段类似HTTP协议的握手请求中,多了几个东西。我会顺便讲解下作用。

Upgrade: websocket
Connection: Upgrade

这个就是Websocket的核心了,告诉 Apache 、 Nginx 等服务器:注意啦,我发起的是Websocket协议,快点帮我找到对应的助理处理~不是那个老土的HTTP。

Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==
Sec-WebSocket-Protocol: chat, superchat
Sec-WebSocket-Version: 13

首先, Sec-WebSocket-Key 是一个 Base64 encode 的值,这个是浏览器随机生成的,告诉服务器:泥煤,不要忽悠窝,我要验证尼是不是真的是Websocket助理。

然后, Sec_WebSocket-Protocol 是一个用户定义的字符串,用来区分同URL下,不同的服务所需要的协议。简单理解:今晚我要服务A,别搞错啦~

最后, Sec-WebSocket-Version 是告诉服务器所使用的 Websocket Draft (协议版本),在最初的时候,Websocket协议还在 Draft 阶段,各种奇奇怪怪的协议都有,而且还有很多期奇奇怪怪不同的东西,什么Firefox和Chrome用的不是一个版本之类的,当初Websocket协议太多可是一个大难题。。不过现在还好,已经定下来啦~大家都使用的一个东西~ 脱水: 服务员,我要的是13岁的噢→_→

然后服务器会返回下列东西,表示已经接受到请求, 成功建立Websocket啦!

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade Sec-WebSocket-Accept: HSmrc0sMlYUkAGmm5OPpG2HaGWk= Sec-WebSocket-Protocol: chat

这里开始就是HTTP最后负责的区域了,告诉客户,我已经成功切换协议啦~

Upgrade: websocket
Connection: Upgrade

依然是固定的,告诉客户端即将升级的是 Websocket 协议,而不是mozillasocket,lurnarsocket或者shitsocket。

然后, Sec-WebSocket-Accept 这个则是经过服务器确认,并且加密过后的 Sec-WebSocket-Key 。 服务器:好啦好啦,知道啦,给你看我的ID CARD来证明行了吧。。

后面的, Sec-WebSocket-Protocol 则是表示最终使用的协议。

至此,HTTP已经完成它所有工作了,接下来就是完全按照Websocket协议进行了。具体的协议就不在这阐述了。

——————技术解析部分完毕——————

你TMD又BBB了这么久,那到底Websocket有什么鬼用, http long poll ,或者ajax轮询 不都可以实现实时信息传递么。

好好好,年轻人,那我们来讲一讲Websocket有什么用。来给你吃点胡(苏)萝(丹)卜(红)

三、Websocket的作用

在讲Websocket之前,我就顺带着讲下 long poll 和 ajax轮询 的原理。

ajax轮询

ajax轮询的原理非常简单,让浏览器隔个几秒就发送一次请求,询问服务器是否有新信息。

场景再现:

客户端:啦啦啦,有没有新信息(Request)

服务端:没有(Response)

客户端:啦啦啦,有没有新信息(Request)

服务端:没有。。(Response)

客户端:啦啦啦,有没有新信息(Request)

服务端:你好烦啊,没有啊。。(Response)

客户端:啦啦啦,有没有新消息(Request)

服务端:好啦好啦,有啦给你。(Response)

客户端:啦啦啦,有没有新消息(Request)

服务端:。。。。。没。。。。没。。。没有(Response) —- loop

long poll

long poll 其实原理跟 ajax轮询 差不多,都是采用轮询的方式,不过采取的是阻塞模型(一直打电话,没收到就不挂电话),也就是说,客户端发起连接后,如果没消息,就一直不返回Response给客户端。直到有消息才返回,返回完之后,客户端再次建立连接,周而复始。

场景再现:

客户端:啦啦啦,有没有新信息,没有的话就等有了才返回给我吧(Request)

服务端:额。。 等待到有消息的时候。。来 给你(Response)

客户端:啦啦啦,有没有新信息,没有的话就等有了才返回给我吧(Request) -loop

从上面可以看出其实这两种方式,都是在不断地建立HTTP连接,然后等待服务端处理,可以体现HTTP协议的另外一个特点,被动性。

何为被动性呢,其实就是,服务端不能主动联系客户端,只能有客户端发起。

简单地说就是,服务器是一个很懒的冰箱(这是个梗)(不会、不能主动发起连接),但是上司有命令,如果有客户来,不管多么累都要好好接待。

说完这个,我们再来说一说上面的缺陷(原谅我废话这么多吧OAQ)

从上面很容易看出来,不管怎么样,上面这两种都是非常消耗资源的。

ajax轮询 需要服务器有很快的处理速度和资源。(速度)long poll 需要有很高的并发,也就是说同时接待客户的能力。(场地大小)

所以 ajax轮询 和 long poll 都有可能发生这种情况。

客户端:啦啦啦啦,有新信息么?

服务端:月线正忙,请稍后再试(503 Server Unavailable)

客户端:。。。。好吧,啦啦啦,有新信息么?

服务端:月线正忙,请稍后再试(503 Server Unavailable)

客户端:然后服务端在一旁忙的要死:冰箱,我要更多的冰箱!更多。。更多。。(我错了。。这又是梗。。)

言归正传,我们来说Websocket吧

通过上面这个例子,我们可以看出,这两种方式都不是最好的方式,需要很多资源。

一种需要更快的速度,一种需要更多的’电话’。这两种都会导致’电话’的需求越来越高。

哦对了,忘记说了HTTP还是一个状态协议。

通俗的说就是,服务器因为每天要接待太多客户了,是个健忘鬼,你一挂电话,他就把你的东西全忘光了,把你的东西全丢掉了。你第二次还得再告诉服务器一遍。

所以在这种情况下出现了,Websocket出现了。他解决了HTTP的这几个难题。首先,被动性,当服务器完成协议升级后(HTTP->Websocket),服务端就可以主动推送信息给客户端啦。所以上面的情景可以做如下修改。

客户端:啦啦啦,我要建立Websocket协议,需要的服务:chat,Websocket协议版本:17(HTTP Request)

服务端:ok,确认,已升级为Websocket协议(HTTP Protocols Switched)

客户端:麻烦你有信息的时候推送给我噢。。

服务端:ok,有的时候会告诉你的。

服务端:balabalabalabala

服务端:balabalabalabala

服务端:哈哈哈哈哈啊哈哈哈哈

服务端:笑死我了哈哈哈哈哈哈哈

就变成了这样,只需要经过一次HTTP请求,就可以做到源源不断的信息传送了。(在程序设计中,这种设计叫做回调,即:你有信息了再来通知我,而不是我傻乎乎的每次跑来问你 )

这样的协议解决了上面同步有延迟,而且还非常消耗资源的这种情况。那么为什么他会解决服务器上消耗资源的问题呢?

其实我们所用的程序是要经过两层代理的,即HTTP协议在Nginx等服务器的解析下,然后再传送给相应的Handler(PHP等)来处理。简单地说,我们有一个非常快速的 接线员(Nginx) ,他负责把问题转交给相应的 客服(Handler) 。

本身接线员基本上速度是足够的,但是每次都卡在客服(Handler)了,老有客服处理速度太慢。,导致客服不够。Websocket就解决了这样一个难题,建立后,可以直接跟接线员建立持久连接,有信息的时候客服想办法通知接线员,然后接线员在统一转交给客户。

这样就可以解决客服处理速度过慢的问题了。

同时,在传统的方式上,要不断的建立,关闭HTTP协议,由于HTTP是非状态性的,每次都要重新传输 identity info (鉴别信息),来告诉服务端你是谁。

虽然接线员很快速,但是每次都要听这么一堆,效率也会有所下降的,同时还得不断把这些信息转交给客服,不但浪费客服的处理时间,而且还会在网路传输中消耗过多的流量/时间。

但是Websocket只需要一次HTTP握手,所以说整个通讯过程是建立在一次连接/状态中,也就避免了HTTP的非状态性,服务端会一直知道你的信息,直到你关闭请求,这样就解决了接线员要反复解析HTTP协议,还要查看identity info的信息。

同时由客户主动询问,转换为服务器(推送)有信息的时候就发送(当然客户端还是等主动发送信息过来的。。),没有信息的时候就交给接线员(Nginx),不需要占用本身速度就慢的客服(Handler)了

——————–

至于怎么在不支持Websocket的客户端上使用Websocket。。答案是: 不能

但是可以通过上面说的 long poll 和 ajax 轮询 来 模拟出类似的效果。

 

废话不多说上代码

我的项目是maven项目所以

pom.xml

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-websocket</artifactId>
<version>${spring.version}</version>
</dependency>

注:spring需要4以上的版本,而且所有spring版本要一致。

spring-mvc.xml

 好多人都忘记一点 allowed-origins="*" 是匹配任何一个url   和  setAllowedOrigins("*") 功能相同。而且这一点是必须加上的。否则会报403错误。

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <beans xmlns="http://www.springframework.org/schema/beans"
 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 xmlns:aop="http://www.springframework.org/schema/aop"
 5 xmlns:context="http://www.springframework.org/schema/context"
 6 xmlns:websocket="http://www.springframework.org/schema/websocket"
 7 xmlns:mvc="http://www.springframework.org/schema/mvc"
 8 xsi:schemaLocation="http://www.springframework.org/schema/beans
 9 http://www.springframework.org/schema/beans/spring-beans.xsd
10 http://www.springframework.org/schema/aop
11 http://www.springframework.org/schema/aop/spring-aop.xsd
12 http://www.springframework.org/schema/context
13 http://www.springframework.org/schema/context/spring-context.xsd
14 http://www.springframework.org/schema/mvc
15 http://www.springframework.org/schema/mvc/spring-mvc.xsd
16 http://www.springframework.org/schema/websocket
17 http://www.springframework.org/schema/websocket/spring-websocket.xsd">
18  
19 
20 <!-- 扫描除了service注解的类=controller -->
21 <context:component-scan base-package="com.bcy.acitylion.**.controller"/>
22 <aop:aspectj-autoproxy proxy-target-class="true"/>
23 
24 <mvc:annotation-driven>
25 <mvc:message-converters>
26 <bean class="org.springframework.http.converter.StringHttpMessageConverter"/>
27 <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>
28 </mvc:message-converters>
29 </mvc:annotation-driven>
30 
31  
32 
33 <!-- 开启spring注解 -->
34 <mvc:annotation-driven/>
35 <!-- 静态页面交由默认web servlet处理 -->
36 <mvc:default-servlet-handler/>
37 <!-- 访问项目根目录返回的页面 -->
38 <mvc:view-controller path="/" view-name="login"/>
39 <!-- ViewResolver config -->
40 <!--配置视图解析器,使页面能返回页面逻辑名路径-->
41 <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
42 <property name="prefix" value="/WEB-INF/"/>
43 <property name="suffix" value=".jsp"/>
44 </bean>
45 
46 <!--配置webSocket-->
47 <bean id="customHandler" class="com.bcy.actiylion.webSocket.controller.WebSocketHander"/>
48 <websocket:handlers allowed-origins="*">
49 <!--指定webSocket 地址-->
50 <websocket:mapping path="/socket" handler="customHandler" />
51 <!--webSocket握手-->
52 <websocket:handshake-interceptors>
53 <bean class="com.bcy.actiylion.webSocket.util.WebSocketInterceptor"/>
54 </websocket:handshake-interceptors>
55 </websocket:handlers>
56 
57 </beans>

 替换websocket   xml注册方式,如果spring-mvc.xml不配置websocket,那么就使用代码注册。

setAllowedOrigins(allowsOrigins)--代表匹配所有
@Configuration
@EnableWebMvc
@EnableWebSocket
public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        //允许连接的域,只能以http或https开头
        String[] allowsOrigins = {"*"};
        
       //WebIM WebSocket通道
        registry.addHandler(chatWebSocketHandler(),"/webSocketIMServer").setAllowedOrigins(allowsOrigins).addInterceptors(myInterceptor());
        
    }
    @Bean
    public ChatWebSocketHandler chatWebSocketHandler() {
        return new ChatWebSocketHandler();
    }
    @Bean
    public WebSocketHandshakeInterceptor myInterceptor(){
        return new WebSocketHandshakeInterceptor();
    }
}

 

web.xml

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 xmlns="http://xmlns.jcp.org/xml/ns/javaee"
 4 xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
 5 version="3.1">
 6 
 7  
 8 
 9 <context-param>
10 <param-name>contextConfigLocation</param-name>
11 <param-value>classpath*:spring/spring-*.xml</param-value>
12 </context-param>
13 
14  
15 
16 <!-- ServletContext监听器 begin -->
17 <listener>
18 <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
19 </listener>
20 <!-- Spring内存溢出监听器 begin -->
21 <listener>
22 <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
23 </listener>
24 
25  
26 
27 <!-- 如果是用mvn命令生成的xml,需要修改servlet版本为3.1 -->
28 <!-- 配置DispatcherServlet -->
29 <servlet>
30 <servlet-name>SpringMVC</servlet-name>
31 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
32 <!-- 配置springMVC需要加载的配置文件-->
33 <init-param>
34 <param-name>contextConfigLocation</param-name>
35 <param-value>classpath:spring/springmvc.xml</param-value>
36 </init-param>
37 <load-on-startup>1</load-on-startup>
38 <async-supported>true</async-supported>
39 </servlet>
40 
41  
42 
43 <servlet-mapping>
44 <servlet-name>SpringMVC</servlet-name>
45 <!-- 默认匹配所有的请求 -->
46 <url-pattern>/</url-pattern>
47 </servlet-mapping>
48 
49  
50 
51 <!-- 字符过滤器 -->
52 <filter>
53 <filter-name>encodingFilter</filter-name>
54 <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
55 <async-supported>true</async-supported>
56 <init-param>
57 <param-name>encoding</param-name>
58 <param-value>UTF-8</param-value>
59 </init-param>
60 <init-param>
61 <param-name>forceEncoding</param-name>
62 <param-value>true</param-value>
63 </init-param>
64 </filter>
65 <filter-mapping>
66 <filter-name>encodingFilter</filter-name>
67 <url-pattern>/*</url-pattern>
68 </filter-mapping>
69 <!-- session超时时间 单位是分钟 -->
70 <session-config>
71 <session-timeout>30</session-timeout>
72 </session-config>
73 
74 </web-app>

login.jsp-----发送json信息

 1 <%@ page language="java" contentType="text/html; charset=UTF-8"
 2 pageEncoding="UTF-8"%>
 3 <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
 4 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 5 <html>
 6 <head>
 7 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 8 <title>Insert title here</title>
 9 
10 </head>
11 <script type="text/javascript">
12 
13 window.onload=function(){
14 //var websocket = null;
15 
16 var ws = new WebSocket("ws://localhost:18080/acitylion/socket");
17 // 建立 web socket 连接成功触发事件
18 
19 ws.onopen = function () {
20 var message = { 
21 time: new Date(), 
22 text: "Hello world!", 
23 clientId: "asdfp8734rew" 
24 };
25 ws.send(JSON.stringify(message));
26 alert("数据发送中...");
27 };
28 
29  
30 
31 // 接收服务端数据时触发事件
32 ws.onmessage = function (evt) {
33 var received_msg = evt.data;
34 var bcy = typeof(received_msg);
35 console.log(received_msg);
36 console.log(bcy);
37 
38 };
39 
40  
41 
42 // 断开 web socket 连接成功触发事件
43 ws.onclose = function () {
44 alert("连接已关闭...");
45 }; 
46 }
47 
48  
50 </script>
51 <body>
52 登录页面
53 </body>
54 </html>

 

 

定义一个拦截器

WebSocketInterceptor.class

 1 package com.bcy.actiylion.webSocket.util;
 2 
 3 import java.util.Map;
 4 
 5 
 6 import org.springframework.http.server.ServerHttpRequest;
 7 import org.springframework.http.server.ServerHttpResponse;
 8 import org.springframework.http.server.ServletServerHttpRequest;
 9 import org.springframework.web.socket.WebSocketHandler;
10 import org.springframework.web.socket.server.HandshakeInterceptor;
11 
12 public class WebSocketInterceptor implements HandshakeInterceptor{
13 
14 // 初次握手访问前
15 public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
16 Map<String, Object> attributes) throws Exception {
17 System.out.println("拦截器之前");
18 if (request instanceof ServletServerHttpRequest) {
19 //可以在这里完成你想要的功能。
20 }
21 System.out.println("拦截器之前完成");
22 return true;
23 }
24 
25 //初次握手后
26 public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
27 Exception exception) {
28 System.out.println("拦截器之后");
29 
30 }
31 
32 }

 

核心代码

 

 1 package com.bcy.actiylion.webSocket.controller;
 2 
 3  
 4 
 5 import java.io.IOException;
 6 import java.util.HashMap;
 7 import java.util.Timer;
 8 import java.util.TimerTask;
 9 
10  
11 
12 import org.springframework.web.socket.CloseStatus;
13 import org.springframework.web.socket.TextMessage;
14 import org.springframework.web.socket.WebSocketHandler;
15 import org.springframework.web.socket.WebSocketMessage;
16 import org.springframework.web.socket.WebSocketSession;
17 
18  
19 
20 import com.fasterxml.jackson.databind.ObjectMapper;
21 
22  
23 
24 public class WebSocketHander implements WebSocketHandler {
25 
26  
27 
28 //连接建立后处理
29 public void afterConnectionEstablished(WebSocketSession session) throws Exception {
30 System.out.println("afterConnectionEstablished");
31 
32 }
33 //接收文本消息,并发送出去
34 public void handleMessage(final WebSocketSession session, WebSocketMessage<?> message) throws Exception {
35 String params = (String) message.getPayload();
36 ObjectMapper mapper = new ObjectMapper(); 
37 HashMap<String,Object> map = mapper.readValue(params, HashMap.class); 
38 final Object time = map.get("time");
39 final Object text = map.get("text");
40 final Object clientId = map.get("clientId");
41 System.out.println(time.toString());
42 System.out.println(text.toString());
43 System.out.println(clientId.toString());
44 //定时每3秒钟返回给前台数据
45 Timer timer = new Timer();
46 timer.schedule(new TimerTask() {
47 @Override
48 public void run() {
49 TextMessage reply = new TextMessage("time : "+time+"text:"+text+"clientId:"+clientId);
50 try {
51 session.sendMessage(reply);
52 } catch (IOException e) {
53 e.printStackTrace();
54 }
55 
56 }
57 }, 0,3 * 1000);
58 
59 }
60 //抛出异常时处理
61 public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
62 System.out.println("handleTransportError");
63 
64 }
65 //连接关闭后处理
66 public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
67 System.out.println("afterConnectionClosed");
68 
69 }
70 
71  
72 
73 public boolean supportsPartialMessages() {
74 System.out.println("supportsPartialMessages");
75 return false;
76 }
77 
78 }

 

 

代码完成。

有问题联系我吧

 

 

 

展开阅读全文
打赏
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
在线直播报名
返回顶部
顶部