JAVA整合WebSocket实现服务器消息推送(项目源码)

admin

一.WebSocket简单介绍
　　随着互联网的发展，传统的HTTP协议已经很难满足Web应用日益复杂的需求了。近年来，随着HTML5的诞生，WebSocket协议被提出，它实现了浏览器与服务器的全双工通信，扩展了浏览器与服务端的通信功能，使服务端也能主动向客户端发送数据。
9 b+ q, y1 U$ O$ j　　我们知道，传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如 浏览器）主动发起，服务端进行处理后返回response结果，而服务端很难主动向客户端发送数据；这种客户端是主动方，服务端是被动方的传统Web模式 对于信息变化不频繁的Web应用来说造成的麻烦较小，而对于涉及实时信息的Web应用却带来了很大的不便，如带有即时通信、实时数据、订阅推送等功能的应 用。在WebSocket规范提出之前，开发人员若要实现这些实时性较强的功能，经常会使用折衷的解决方法：轮询（polling）和Comet技术。其实后者本质上也是一种轮询，只不过有所改进。
　　轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求，频繁地查询是否有新的数据改动。明显地，这种方法会导致过多不必要的请求，浪费流量和服务器资源。
- c0 b! o& S2 P　　Comet技术又可以分为长轮询和流技术。长轮询改进了上述的轮询技术，减小了无用的请求。它会为某些数据设定过期时间，当数据过期后才会向服务端发送请求；这种机制适合数据的改动不是特别频繁的情况。流技术通常是指客户端使用一个隐藏的窗口与服务端建立一个HTTP长连接，服务端会不断更新连接状态以保持HTTP长连接存活；这样的话，服务端就可以通过这条长连接主动将数据发送给客户端；流技术在大并发环境下，可能会考验到服务端的性能。
" Y" l& p+ S2 p/ n) s) p　　这两种技术都是基于请求-应答模式，都不算是真正意义上的实时技术；它们的每一次请求、应答，都浪费了一定流量在相同的头部信息上，并且开发复杂度也较大。
　　伴随着HTML5推出的WebSocket，真正实现了Web的实时通信，使B/S模式具备了C/S模式的实时通信能力。WebSocket的工作流程是这 样的：浏览器通过javaScript向服务端发出建立WebSocket连接的请求，在WebSocket连接建立成功后，客户端和服务端就可以通过 TCP连接传输数据。因为WebSocket连接本质上是TCP连接，不需要每次传输都带上重复的头部数据，所以它的数据传输量比轮询和Comet技术小 了很多。本文不详细地介绍WebSocket规范，主要介绍下WebSocket在Java Web中的实现。
　　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以上的版本才能运行。
9 `% Z( r8 ?3 U6 W# }
+ l, k# R) G2 \二、WebSocket协议介绍
( R& M- v" m2 I# _　WebSocket协议是一种双向通信协议，它建立在TCP之上，同http一样通过TCP来传输数据，但是它和http最大的不同有两点：1.WebSocket是一种双向通信协议，在建立连接后，WebSocket服务器和Browser/UA都能主动的向对方发送或接收数据，就像Socket一样，不同的是WebSocket是一种建立在Web基础上的一种简单模拟Socket的协议；2.WebSocket需要通过握手连接，类似于TCP它也需要客户端和服务器端进行握手连接，连接成功后才能相互通信。简单的建立握手的时序图如下：

- j3 g: t9 u/ H# B7 N握手过程：
" E# q7 r2 O1 r5 [Browser与WebSocket服务器通过TCP三次握手建立连接，如果这个建立连接失败，那么后面的过程就不会执行，Web应用程序将收到错误消息通知。
) j! s, i2 p' Z# t  x9 a在TCP建立连接成功后，Browser/UA通过http协议传送WebSocket支持的版本号，协议的字版本号，原始地址，主机地址等等一些列字段给服务器端。
) Q0 w# Q4 G" ~/ Q5 ZWebSocket服务器收到Browser/UA发送来的握手请求后，如果数据包数据和格式正确，客户端和服务器端的协议版本号匹配等等，就接受本次握手连接，并给出相应的数据回复，同样回复的数据包也是采用http协议传输。
Browser收到服务器回复的数据包后，如果数据包内容、格式都没有问题的话，就表示本次连接成功，触发onopen消息，此时Web开发者就可以在此时通过send接口想服务器发送数据。否则，握手连接失败，Web应用程序会收到onerror消息，并且能知道连接失败的原因。

( @: u) [! n1 {" @  m) r三、Tomcat 7中的Websocket架构
. b" X" I) J# c7 _2 m1 C
3 E, P2 ?9 a& u9 P8 G' g# k如图所示，因为Websocket通信分为握手和数据传输两个过程，两个过程中需要用到的处理方式是不一样的，握手过程是基于HTTP 1.1基础上的，而数据传输是直接基于TCP的流传输。
       握手过程中，在HttpServletRequest的基础上，封装了WsHttpServletRequest类，添加了对Request的失效操作函数invalidate()。而在数据通信时，接受和处理数据过程中，基于org.apache.coyote.http11.upgrade.UpgradeInbound重新封装了用于处理数据输入流的类StreamInbound，并在StreamInbound的基础上扩展生成了用于消息处理的类MessageInbound。在这两个数据处理类中均留有onData，onTextData/onBinaryData，onOpen，onClose等事件操作函数接口，这些接口将在载入的代码类中实现业务逻辑。在用于数据输出流的类WsOutbound则是封装了UpgradeOutbound对象实例，基于UpgradeOutbound对象的基础上，添加了websocket响应有关的处理逻辑。这里处理函数均为同步调用的函数，保证websocket响应的时序性。
' }& g$ {5 @8 W' I( P0 m/ D* B       Tomcat中Websocket的处理流程如下：
接收客户端发来的握手请求，Coyote.http11连接器对socket进行解析，形成HttpServletRequest发送给Container。
Container中的相应WebsocketServlet处理请求，如不接受连接请求，则返回，如接受连接请求，则对请求作出响应，建立起客户端和服务器的socket连接。
8 a4 I9 r! y' r3 h; b: C0 S, U服务器此时可以通过WsOutbound发送数据给客户端，同时通过StreamInbound监听socket。
如果接收到客户端发来的数据，则将socket数据解析成frame，判断frame类型，通过事件分发数据到不同的逻辑处理流程。
数据返回时调用WsOutbound对返回的数据进行封装处理，发送给客户端。

四、代码实现以及需求
# v  j( ?$ k& Q  U- Y
' c. `, G  B% O& G1、项目需要，定时向所有在线用户推送一个广告或是推送一个通知之类的(比如服务器升级，请保存好手头工作之类的)。
! h, x, T) J* N0 ?7 c
; L8 N, c3 S/ Q; }. ]* _, z2、相关环境 ， Nginx、tomcat7、centos 6.5

: }) I$ v9 }9 |! u3、项目框架，springMvc 4.0.6、layer

4、代码实现：

( C/ k3 v! w  `5 S3 K& C0 o4 ]: A% FWebSocketConfig：

1. import websocket.handler.SystemWebSocketHandler;
   
2. @Configuration
   
3. @EnableWebMvc
   & I- W( g1 w- @. m
4. @EnableWebSocket
   
5. public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{
   & v* M0 \. j. W% ^- Q  {7 N
6. 
   
7.     @Override
   3 P- |$ D' C7 p
8.     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
   ) b6 a. o( U* M: Q8 A4 s5 v
9.          registry.addHandler(systemWebSocketHandler(),"/webSocketServer");
   
10.          registry.addHandler(systemWebSocketHandler(),"/sockjs/webSocketServer");
    
11.     }
    7 o( S% D- i  B& {
12.     @Bean
    
13.     public WebSocketHandler systemWebSocketHandler(){
    $ t5 X! R: D' B- R6 [# f- G9 m
14.         return new SystemWebSocketHandler();
    5 J" W" l5 {' M2 s
15.     }
    / N/ o0 d2 l. S( t
16. }

复制代码

SystemWebSocketHandler：

1. public class SystemWebSocketHandler extends  TextWebSocketHandler {
   
2. 
   
3. 
   
4.     private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();;
   1 N2 ~+ O! a8 H7 R& Z& S* F
5. 
   " Q6 G3 _& S* d7 j9 O3 W9 @
6.     public void afterConnectionEstablished(WebSocketSession session) throws Exception {
   : |. N- X9 n! [4 ~1 Q  |4 G' {
7.         System.out.println("ConnectionEstablished");
   # j/ [  y! q- b
8.         users.add(session);
   
9.         System.out.println("当前用户"+users.size());
   
10.     }
    ' p7 [! ~/ k1 Y- y, V4 q: |
11.     /**
    $ n. w# S* G, Y* y0 L) l. W
12.      * 在UI在用js调用websocket.send()时候，会调用该方法
    
13.      * @Author    张志朋
    
14.      * @param session
    " U, p: @. D3 v& a9 I* ]
15.      * @param message
    ) a1 Z9 g  [& V& _9 @
16.      * @throws Exception
    
17.      * @Date    2016年3月4日
    
18.      * 更新日志
    
19.      * 2016年3月4日 张志朋  首次创建
    6 o# k$ X3 t" m& A
20.      *
    : y( E) k( J' k, m  h
21.      */
    
22.     @Override
    
23.     protected void handleTextMessage(WebSocketSession session,
    ' j! a3 e9 Z( `! s6 i7 m
24.             TextMessage message) throws Exception {
    
25.         super.handleTextMessage(session, message);
    9 V/ q/ Z. `1 n7 Z3 ]1 S# {) ^
26.         sendMessageToUsers(session,message);
    
27.     }
    5 O& G/ I0 F8 m# E9 s) P
28.     @Override
    1 X! ]2 e8 T0 S5 M6 Q2 u: q
29.     public void handleTransportError(WebSocketSession session, Throwable exception) throws IOException {
    8 v3 \& r# k! q0 x% p
30.         if(session.isOpen()){
    ! K, m; s. ^# X4 z5 i
31.             session.close();
    
32.         }
    9 D) \6 |1 |! F
33.         users.remove(session);
    
34.     }
    0 [4 C* W& o0 a& l; z/ S% F
35. 
    
36.     @Override
    # J  r& g) n+ [2 P) v: l
37.     public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
    
38.         users.remove(session);
    
39.     }
    & z2 C' `5 L  T" u0 e9 W: G
40. 
    
41.     @Override
    
42.     public boolean supportsPartialMessages() {
    - {1 K' {# k" f; U. |
43.         return false;
    ' V2 _( U5 Q/ x2 W# a% T4 J
44.     }
    2 b2 \% W4 x& j% n7 ^0 r
45.     /**
    
46.      * 给所有在线用户发送消息
    3 x( U8 C9 }8 i
47.      * @Author    张志朋
    
48.      * @param message  void
    
49.      * @Date    2016年3月4日
    
50.      * 更新日志
    
51.      * 2016年3月4日 张志朋  首次创建
    5 n. w) e; P. F) n* x) A' \1 ^
52.      *
    % l. J5 \) [1 C! b# M; P
53.      */
    
54.     public void sendMessageToUsers(WebSocketSession session,TextMessage message) {
    ; u1 y: _* V* Z$ @4 C
55.         for (WebSocketSession user : users) {
    # M* R6 s, z$ a. n: N' P
56.             try {
    
57.                 if (user.isOpen()) {
    
58.                     user.sendMessage(message);
    
59.                 }
    . D- k+ ^5 a+ k0 \6 O4 A" K
60.             } catch (IOException e) {
    * k" x5 _$ T1 i# D, {
61.                 e.printStackTrace();
    
62.             }
    
63.         }
    . Z/ g9 C! G4 S5 |* O5 F
64.     }
    ; c+ S! w6 ~, \6 j" V5 ?
65. }
      L5 q" L& {( x

复制代码

信息输入 index.html：

1. <html xmlns="http://www.w3.org/1999/xhtml">
   
2. <head>
   
3. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   
4. <title>请输入任意消息</title>
   
5. <script type="text/javascript" src="js/jquery-1.10.2.min.js"></script>
   ' q* R, v. m/ ^6 U5 w
6. <script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script>
   
7. <script type="text/javascript">
   % Z- V$ U" S% S; E, a. B0 N
8. var ws = null;
   
9. $(function () {
   1 m2 P8 I! |: L' q9 H* R- g& P
10.     if ('WebSocket' in window) {
    
11.          ws = new WebSocket('ws://127.0.0.1:8080/webSocketServer');
    ) A3 _. O! l& F$ A3 S
12.     }
    
13.     else if ('MozWebSocket' in window) {
    # F- f: c% t" _. H4 k4 `
14.         ws = new MozWebSocket("ws://127.0.0.1:8080/webSocketServer");
    
15.     }
    + V" J, _0 y/ n1 x" `% ]5 s$ G# P
16.     else {
    # S- J7 O& f1 U" y2 o& Y
17.         ws = new SockJS("ws://127.0.0.1:8080/webSocketServer");
    & S4 ~( u3 H: f3 z4 {* ?
18.     }
    * C1 X& R! U1 W6 f  i) y& q
19.     ws.onopen = function () {
    , m/ r3 C# d0 I0 q5 t( ]% E
20. 
    
21.     };
    5 _% N6 }0 p! y$ ]
22.     ws.onmessage = function (event) {
    
23. 
    0 L% g+ K1 x, e& \7 l8 j
24.     };
    
25.     ws.onclose = function (event) {
    
26. 
    . e/ N* D* O; b3 P* J+ q
27.     };
    & I6 ~$ Z. W: f) a) ~" E
28. });
    
29. function stop(){
    
30.     var message = $("#message").val();
    ; P0 c1 w, O5 Z! S% |7 ]4 s; E
31.     ws.send(message);
    
32. }
    
33. </script>
    
34. </head>
    8 S5 A) X4 B+ g  C- u; c$ k
35. <body class="keBody">
    
36. 请输入提示信息: <textarea id="message"></textarea><br />
    , J! T/ S1 l1 z* c* w
37. <input type="button"  value="开始" />
    0 S. t, i* i7 C. ^) e$ c: {" Q
38. </body>
    + H2 q2 F9 t: ?7 \. p4 `! U. C
39. </html>

复制代码

8 u6 A6 p7 c" M1 k# n% NwebSocket.js  用于导入项目。

1. document.write("<script language=javascript src='http://127.0.0.1:8080/js/jquery-1.10.2.min.js'></script>");
   
2. document.write("<script language=javascript src='http://127.0.0.1:8080/layer/layer.js'></script>");
   % G5 l- S, P6 F- y9 ^
3. document.write("<script language=javascript src='http://cdn.sockjs.org/sockjs-0.3.min.js'></script>");
   % s( o7 I* ?( W' I9 Z& R
4.     var ws = null;
   + L* h9 }9 }( q3 N- u0 \" R
5.     var basePath = "ws://127.0.0.1:8080/";
   
6.     if ('WebSocket' in window) {
   / i5 ~7 a2 |. t* Y/ |4 c
7.          ws = new WebSocket(basePath+'webSocketServer');
   
8.     }
   & [! ~: v' B% V' |/ Y9 d- m
9.     else if ('MozWebSocket' in window) {
   
10.         ws = new MozWebSocket(basePath+"webSocketServer");
    6 q8 Y( u& k2 B9 q
11.     }
    4 P- K+ M( S- j% H
12.     else {
    
13.         ws = new SockJS(basePath+"sockjs/webSocketServer");
    5 e- Q- U. O; e& A; v4 v
14.     }
    
15.     ws.onopen = function () {
    
16. 
    : R4 U, T, i& C/ }; `  f
17.     };
    . T5 t/ \. b" _# @" c9 b( u
18.     ws.onmessage = function (event) {
    
19.         pop(event.data);
    7 O4 Q7 H1 x6 C: x2 Z8 U9 ^4 O1 X$ O
20.     };
    
21.     ws.onclose = function (event) {
    
22.          ws.close();
    
23.     };
    
24. //提示信息
    
25. function pop(message){
    % c; u2 }; a- W' ^" a- K( |! l4 \, h
26.     layer.alert(message);
    
27. }

复制代码

; T! T# A2 k' G7 M1 ]9 s5、在项目头部引入
  P$ e, i) F- Y. @; \<script language=javascript src='http://127.0.0.1:8080/webSocket.js '></script>
5 ?% v1 W/ P( m$ D
- Z6 e( x/ Z2 S: d
5 O# z/ }4 y) W: q* Q0 q+ `7 B/ {这时查看后台 会有以下信息 说明 引入成功。

/ H; v! S, @% _7 T; M9 Z
: d2 H: H9 Z, r然后在打开页面 index.html 输入以下内容 点击开始即可。


如果在网站出现一下提示说明配置成功，这时候所有网站登录用户都可以收到此信息。
3 C& r# R5 @3 p1 U4 X2 G

8 C' a4 h" ?: Q4 H' n
项目下载地址：

游客，如果您要查看本帖隐藏内容请回复

$ W: v$ j0 H+ _, B. D* w

# B! f! ]6 x6 w: A9 f9 a
5 j- J2 W% D/ d  L; ~& w

刘继仆

有没有数据库？

admin

刘继仆 发表于 2016-4-21 07:20
) c9 d/ t% D: X; D( P/ L1 E4 t有没有数据库？

8 b; o, ~& b7 X2 n5 D跟 数据库 没有关系

hhwang

thanks you for share

学语言

下载来学习下。

烈火炎阳

看看新的内容！

Spirit_wolf

谢谢楼主分享，学习！！谢谢楼主分享，学习！！谢谢楼主分享，学习！！谢谢楼主分享，学习！！谢谢楼主分享，学习！！

beyond

111111111111111111

admin

beyond 发表于 2016-4-27 03:50
111111111111111111

我去 盗我 头像 还不好好回复

T参谋长

早想学这个了