一.WebSocket简单介绍
随着互联网的发展，传统的HTTP协议已经很难满足Web应用日益复杂的需求了。近年来，随着HTML5的诞生，WebSocket协议被提出，它实现了浏览器与服务器的全双工通信，扩展了浏览器与服务端的通信功能，使服务端也能主动向客户端发送数据。$ j6 s6 P/ d( K- G‘ m
我们知道，传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如 浏览器）主动发起，服务端进行处理后返回response结果，而服务端很难主动向客户端发送数据；这种客户端是主动方，服务端是被动方的传统Web模式 对于信息变化不频繁的Web应用来说造成的麻烦较小，而对于涉及实时信息的Web应用却带来了很大的不便，如带有即时通信、实时数据、订阅推送等功能的应 用。在WebSocket规范提出之前，开发人员若要实现这些实时性较强的功能，经常会使用折衷的解决方法：轮询（polling）和Comet技术。其实后者本质上也是一种轮询，只不过有所改进。
轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求，频繁地查询是否有新的数据改动。明显地，这种方法会导致过多不必要的请求，浪费流量和服务器资源。
Comet技术又可以分为长轮询和流技术。长轮询改进了上述的轮询技术，减小了无用的请求。它会为某些数据设定过期时间，当数据过期后才会向服务端发送请求；这种机制适合数据的改动不是特别频繁的情况。流技术通常是指客户端使用一个隐藏的窗口与服务端建立一个HTTP长连接，服务端会不断更新连接状态以保持HTTP长连接存活；这样的话，服务端就可以通过这条长连接主动将数据发送给客户端；流技术在大并发环境下，可能会考验到服务端的性能。
这两种技术都是基于请求-应答模式，都不算是真正意义上的实时技术；它们的每一次请求、应答，都浪费了一定流量在相同的头部信息上，并且开发复杂度也较大。. C w( i) E4 k. P, m; g
伴随着HTML5推出的WebSocket，真正实现了Web的实时通信，使B/S模式具备了C/S模式的实时通信能力。WebSocket的工作流程是这 样的：浏览器通过javaScript向服务端发出建立WebSocket连接的请求，在WebSocket连接建立成功后，客户端和服务端就可以通过 TCP连接传输数据。因为WebSocket连接本质上是TCP连接，不需要每次传输都带上重复的头部数据，所以它的数据传输量比轮询和Comet技术小 了很多。本文不详细地介绍WebSocket规范，主要介绍下WebSocket在Java Web中的实现。# k- L0 {# i. k
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以上的版本才能运行。# W" f) D, @: u) Y0 L‘ ~
二、WebSocket协议介绍
WebSocket协议是一种双向通信协议，它建立在TCP之上，同http一样通过TCP来传输数据，但是它和http最大的不同有两点：1.WebSocket是一种双向通信协议，在建立连接后，WebSocket服务器和Browser/UA都能主动的向对方发送或接收数据，就像Socket一样，不同的是WebSocket是一种建立在Web基础上的一种简单模拟Socket的协议；2.WebSocket需要通过握手连接，类似于TCP它也需要客户端和服务器端进行握手连接，连接成功后才能相互通信。简单的建立握手的时序图如下：+ h; ~; q4 `/ {
<ignore_js_op>
握手过程：
Browser与WebSocket服务器通过TCP三次握手建立连接，如果这个建立连接失败，那么后面的过程就不会执行，Web应用程序将收到错误消息通知。
在TCP建立连接成功后，Browser/UA通过http协议传送WebSocket支持的版本号，协议的字版本号，原始地址，主机地址等等一些列字段给服务器端。
WebSocket服务器收到Browser/UA发送来的握手请求后，如果数据包数据和格式正确，客户端和服务器端的协议版本号匹配等等，就接受本次握手连接，并给出相应的数据回复，同样回复的数据包也是采用http协议传输。- s" j: [- c" o- k
Browser收到服务器回复的数据包后，如果数据包内容、格式都没有问题的话，就表示本次连接成功，触发onopen消息，此时Web开发者就可以在此时通过send接口想服务器发送数据。否则，握手连接失败，Web应用程序会收到onerror消息，并且能知道连接失败的原因。5 V, k5 ?2 l7 M( \2 b H
‘ z7 g9 w, D$ O% k) U
三、Tomcat 7中的Websocket架构3 E7 s, g+ f% r% u4 Y% `
) F‘ S5 |4 q- W
如图所示，因为Websocket通信分为握手和数据传输两个过程，两个过程中需要用到的处理方式是不一样的，握手过程是基于HTTP 1.1基础上的，而数据传输是直接基于TCP的流传输。 ‘ ]4 R- C. L! S5 x; y* j
握手过程中，在HttpServletRequest的基础上，封装了WsHttpServletRequest类，添加了对Request的失效操作函数invalidate()。而在数据通信时，接受和处理数据过程中，基于org.apache.coyote.http11.upgrade.UpgradeInbound重新封装了用于处理数据输入流的类StreamInbound，并在StreamInbound的基础上扩展生成了用于消息处理的类MessageInbound。在这两个数据处理类中均留有onData，onTextData/onBinaryData，onOpen，onClose等事件操作函数接口，这些接口将在载入的代码类中实现业务逻辑。在用于数据输出流的类WsOutbound则是封装了UpgradeOutbound对象实例，基于UpgradeOutbound对象的基础上，添加了websocket响应有关的处理逻辑。这里处理函数均为同步调用的函数，保证websocket响应的时序性。
Tomcat中Websocket的处理流程如下：<ignore_js_op>
接收客户端发来的握手请求，Coyote.http11连接器对socket进行解析，形成HttpServletRequest发送给Container。
Container中的相应WebsocketServlet处理请求，如不接受连接请求，则返回，如接受连接请求，则对请求作出响应，建立起客户端和服务器的socket连接。
服务器此时可以通过WsOutbound发送数据给客户端，同时通过StreamInbound监听socket。/ d3 C$ S‘ N4 s" m
如果接收到客户端发来的数据，则将socket数据解析成frame，判断frame类型，通过事件分发数据到不同的逻辑处理流程。
数据返回时调用WsOutbound对返回的数据进行封装处理，发送给客户端。
四、代码实现以及需求
1、项目需要，定时向所有在线用户推送一个广告或是推送一个通知之类的(比如服务器升级，请保存好手头工作之类的)。: f |, D6 R. _0 ~3 d
‘ p- `, F0 Y* g4 B. g9 ]# `
2、相关环境 ， Nginx、tomcat7、centos 6.5
7 } m0 R% \$ F‘ u1 A
3、项目框架，springMvc 4.0.6、layer
! u- Q0 {: B2 u- e. `6 G
4、代码实现：) W R/ N6 U/ C& L/ t3 R) a& h
WebSocketConfig：
- import websocket.handler.SystemWebSocketHandler;$ `, D+ H. H9 E J7 R
- @Configuration
- @EnableWebMvc
- @EnableWebSocket9 Z9 l6 i" h) g4 G$ S" ^& Q
- public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{6 K% ]3 U1 O# C- {% n
- @Override+ J+ `% d% m |3 j6 I7 A+ u‘ \
- public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
- registry.addHandler(systemWebSocketHandler(),"/webSocketServer");4 H0 k% Y9 o8 `/ L6 y7 W/ B‘ n
- registry.addHandler(systemWebSocketHandler(),"/sockjs/webSocketServer");
- }
- @Bean‘ \6 ], m4 }% f‘ E‘ U" \
- public WebSocketHandler systemWebSocketHandler(){
- return new SystemWebSocketHandler();: S- |& U# }/ C" G$ v5 a
- }
- }
复制代码
SystemWebSocketHandler：
- public class SystemWebSocketHandler extends TextWebSocketHandler {
- % }- u" Q6 D# F# P# w; P2 d
- private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();;4 ?+ A. V$ Y/ }& h
- x- y) r8 U/ n; M+ Y$ l
- public void afterConnectionEstablished(WebSocketSession session) throws Exception {
- System.out.println("ConnectionEstablished");
- users.add(session);% X7 y- v( \* u! ^
- System.out.println("当前用户"+users.size());
- }! k5 d‘ v$ [3 b, u5 l, z
- /**( b# S3 }0 }* ?; x* ^
- * 在UI在用js调用websocket.send()时候，会调用该方法
- * @Author 张志朋7 f& A# K4 g8 X. z- |) S3 K
- * @param session
- * @param message- n) Q; i2 ?5 Y, d4 m
- * @throws Exception
- * @Date 2016年3月4日
- * 更新日志& n. c% Q; Y# ]
- * 2016年3月4日 张志朋 首次创建
- *
- */
- @Override
- protected void handleTextMessage(WebSocketSession session,5 l. }, a5 j4 W8 j, U% x
- TextMessage message) throws Exception {( ~( P! W; T. H$ G* U8 W
- super.handleTextMessage(session, message);
- sendMessageToUsers(session,message);
- }
- @Override9 m3 d( B# t% r" z0 e
- public void handleTransportError(WebSocketSession session, Throwable exception) throws IOException {
- if(session.isOpen()){% x j0 I! c0 S5 Y
- session.close();
- }
- users.remove(session);5 @6 y! F$ k, D- s/ N9 v5 V
- }) m1 |, z8 r$ ]0 B
- @Override
- public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {& u* X6 C/ N* }. ?. e2 w
- users.remove(session);, o, ?0 A. J7 o2 z6 `‘ b
- }8 p# X, ?0 m7 `+ J
- % V3 r% E, m; }1 ]5 D
- @Override) A1 [; K/ }6 D% [! ^
- public boolean supportsPartialMessages() {& Y‘ N& U! ~* z( m! h* {. f
- return false;
- } t9 ]* K% z7 C( C# E- |- F+ i
- /**! Z3 L$ S‘ Q. \1 G- p: I3 {. D1 E9 W
- * 给所有在线用户发送消息
- * @Author 张志朋
- * @param message void* Y) `$ f0 T4 M+ b6 q8 X2 p5 F
- * @Date 2016年3月4日
- * 更新日志1 q% I4 Y E. @. Z# H- E
- * 2016年3月4日 张志朋 首次创建
- *5 V5 u3 a+ G5 r# P+ f, Y/ {
- */2 H6 z3 A/ m4 ?0 h( ~5 o% X
- public void sendMessageToUsers(WebSocketSession session,TextMessage message) {/ l f: d! @" [% g% ]% j! ?
- for (WebSocketSession user : users) {
- try {; K! [3 k) B! }. v
- if (user.isOpen()) {
- user.sendMessage(message);, ?$ r7 A% ? n1 ]. [7 @$ j
- }
- } catch (IOException e) {
- e.printStackTrace();: c1 t* |1 j$ I% o4 t8 H
- }% ]6 X6 _9 e) z, `) j% `! H2 N
- }
- }2 ^# o( i `( h‘ Z7 L
- }
复制代码
信息输入 index.html：- \0 z& k; w5 d$ U1 ~( ~* T
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>7 a8 f3 O5 v; b# g3 B: ^
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>请输入任意消息</title>
- <script type="text/javascript" src="js/jquery-1.10.2.min.js"></script>7 @( l1 e# @) X
- <script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script>
- <script type="text/javascript">
- var ws = null;
- $(function () {
- if (‘WebSocket‘ in window) {
- ws = new WebSocket(‘ws://127.0.0.1:8080/webSocketServer‘); 5 S+ j {# E8 F2 o( ^2 L8 A: f: F" d
- }
- else if (‘MozWebSocket‘ in window) {$ j1 }4 R% _- _& z3 F
- ws = new MozWebSocket("ws://127.0.0.1:8080/webSocketServer");
- }
- else {
- ws = new SockJS("ws://127.0.0.1:8080/webSocketServer");+ P& w: ?* O‘ _/ [6 e‘ t, {0 F
- }. v- m! b& `; f0 P3 C5 t
- ws.onopen = function () {/ B$ e Q$ b) D
- / K$ l6 b6 S7 m2 j‘ A; m/ j
- };
- ws.onmessage = function (event) {3 O! h. f! h$ m7 Q* M: s2 Y
- " V1 p. q# `/ K
- };
- ws.onclose = function (event) {
- 6 D7 _" h$ ?, Y
- };! e8 }; o, ^! }( o, Q2 r6 \+ z. o( M
- });
- function stop(){+ x8 U6 s7 p. c( U; G0 i
- var message = $("#message").val();$ w. u: E" p5 `! I
- ws.send(message);6 G u8 P3 a( O |5 W8 g8 [
- }
- </script>; u% \/ M8 b7 O0 D5 t5 h" _
- </head>9 U H/ y, ^‘ M- f# N
- <body class="keBody"> X0 D& H9 u5 d( e0 C: F/ `: R) Q
- 请输入提示信息: <textarea id="message"></textarea><br />
- <input type="button" value="开始" />
- </body>5 ?% i; h6 ?2 b4 M. [/ f/ b+ j
- </html>
复制代码
6 q0 F$ y& l t8 y" a( U( I& n
webSocket.js 用于导入项目。
- document.write("<script language=javascript src=‘http://127.0.0.1:8080/js/jquery-1.10.2.min.js‘></script>");
- document.write("<script language=javascript src=‘http://127.0.0.1:8080/layer/layer.js‘></script>");; Z" F* y3 X" ^* A6 {! Q9 @( M
- document.write("<script language=javascript src=‘http://cdn.sockjs.org/sockjs-0.3.min.js‘></script>");
- var ws = null;0 K‘ _) I, _( z: |( t$ b. g
- var basePath = "ws://127.0.0.1:8080/";9 i2 {9 p1 H‘ T9 b‘ U
- if (‘WebSocket‘ in window) {# w8 N+ p" v, F/ v% K
- ws = new WebSocket(basePath+‘webSocketServer‘); 4 q. Z! u% i( I‘ }. t) o1 |
- }
- else if (‘MozWebSocket‘ in window) {
- ws = new MozWebSocket(basePath+"webSocketServer");0 }9 y3 Y9 T% m3 ?/ [; b; Y7 p
- }
- else {, p. l% Z1 e6 t/ D. m8 q
- ws = new SockJS(basePath+"sockjs/webSocketServer");
- }" C8 y7 f/ C. }# [& W# G
- ws.onopen = function () {
- + J/ T- r4 L" d) [‘ b9 L2 T
- };3 R6 @8 v! b1 K# O
- ws.onmessage = function (event) {
- pop(event.data);- C6 d! {5 ^1 q5 a
- };
- ws.onclose = function (event) {
- ws.close();1 \8 x$ [- o2 \/ Z
- };
- //提示信息
- function pop(message){. ] Q% }1 `; B
- layer.alert(message);* d4 H2 b0 }) I( j, ~, k
- }
复制代码
9 \; ^. D: M; Y% o5 B2 [
5、在项目头部引入% D0 _; w8 y) {( C: n6 e$ K
<script language=javascript src=‘http://127.0.0.1:8080/webSocket.js ‘></script>
这时查看后台 会有以下信息 说明 引入成功。# T; \, y% L c+ d1 ~% U
<ignore_js_op>
然后在打开页面 index.html 输入以下内容 点击开始即可。/ d% h3 B% d: \9 E
<ignore_js_op>
如果在网站出现一下提示说明配置成功，这时候所有网站登录用户都可以收到此信息。, N5 ^, y) H4 C2 ]3 c* }
<ignore_js_op> |
