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

admin

一.WebSocket简单介绍
: w3 b. s! ^: ]$ `　　随着互联网的发展，传统的HTTP协议已经很难满足Web应用日益复杂的需求了。近年来，随着HTML5的诞生，WebSocket协议被提出，它实现了浏览器与服务器的全双工通信，扩展了浏览器与服务端的通信功能，使服务端也能主动向客户端发送数据。
( Q0 g! P/ d5 o# U( o) B' m+ B　　我们知道，传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如 浏览器）主动发起，服务端进行处理后返回response结果，而服务端很难主动向客户端发送数据；这种客户端是主动方，服务端是被动方的传统Web模式 对于信息变化不频繁的Web应用来说造成的麻烦较小，而对于涉及实时信息的Web应用却带来了很大的不便，如带有即时通信、实时数据、订阅推送等功能的应 用。在WebSocket规范提出之前，开发人员若要实现这些实时性较强的功能，经常会使用折衷的解决方法：轮询（polling）和Comet技术。其实后者本质上也是一种轮询，只不过有所改进。
　　轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求，频繁地查询是否有新的数据改动。明显地，这种方法会导致过多不必要的请求，浪费流量和服务器资源。
　　Comet技术又可以分为长轮询和流技术。长轮询改进了上述的轮询技术，减小了无用的请求。它会为某些数据设定过期时间，当数据过期后才会向服务端发送请求；这种机制适合数据的改动不是特别频繁的情况。流技术通常是指客户端使用一个隐藏的窗口与服务端建立一个HTTP长连接，服务端会不断更新连接状态以保持HTTP长连接存活；这样的话，服务端就可以通过这条长连接主动将数据发送给客户端；流技术在大并发环境下，可能会考验到服务端的性能。
　　这两种技术都是基于请求-应答模式，都不算是真正意义上的实时技术；它们的每一次请求、应答，都浪费了一定流量在相同的头部信息上，并且开发复杂度也较大。
　　伴随着HTML5推出的WebSocket，真正实现了Web的实时通信，使B/S模式具备了C/S模式的实时通信能力。WebSocket的工作流程是这 样的：浏览器通过javaScript向服务端发出建立WebSocket连接的请求，在WebSocket连接建立成功后，客户端和服务端就可以通过 TCP连接传输数据。因为WebSocket连接本质上是TCP连接，不需要每次传输都带上重复的头部数据，所以它的数据传输量比轮询和Comet技术小 了很多。本文不详细地介绍WebSocket规范，主要介绍下WebSocket在Java Web中的实现。
9 M' y& i4 P; @: e& i: n- o$ `! r; n, @+ i　　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以上的版本才能运行。
& @* O2 I: o/ `6 L% e. T; s
' n& Z# E2 G) E; p3 V9 J  L( K二、WebSocket协议介绍
　WebSocket协议是一种双向通信协议，它建立在TCP之上，同http一样通过TCP来传输数据，但是它和http最大的不同有两点：1.WebSocket是一种双向通信协议，在建立连接后，WebSocket服务器和Browser/UA都能主动的向对方发送或接收数据，就像Socket一样，不同的是WebSocket是一种建立在Web基础上的一种简单模拟Socket的协议；2.WebSocket需要通过握手连接，类似于TCP它也需要客户端和服务器端进行握手连接，连接成功后才能相互通信。简单的建立握手的时序图如下：
- \! U* U, Q- v5 W7 w4 V) U
握手过程：
7 c$ {* O% t: L. Y5 F, p+ CBrowser与WebSocket服务器通过TCP三次握手建立连接，如果这个建立连接失败，那么后面的过程就不会执行，Web应用程序将收到错误消息通知。
! l& h0 N; |! D7 H" r* C. E在TCP建立连接成功后，Browser/UA通过http协议传送WebSocket支持的版本号，协议的字版本号，原始地址，主机地址等等一些列字段给服务器端。
& g' d. ~; {- h* bWebSocket服务器收到Browser/UA发送来的握手请求后，如果数据包数据和格式正确，客户端和服务器端的协议版本号匹配等等，就接受本次握手连接，并给出相应的数据回复，同样回复的数据包也是采用http协议传输。
' v6 P9 [! R' B7 ZBrowser收到服务器回复的数据包后，如果数据包内容、格式都没有问题的话，就表示本次连接成功，触发onopen消息，此时Web开发者就可以在此时通过send接口想服务器发送数据。否则，握手连接失败，Web应用程序会收到onerror消息，并且能知道连接失败的原因。
5 p* k+ i7 @# l& K  ?
三、Tomcat 7中的Websocket架构

如图所示，因为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响应的时序性。
       Tomcat中Websocket的处理流程如下：
接收客户端发来的握手请求，Coyote.http11连接器对socket进行解析，形成HttpServletRequest发送给Container。
Container中的相应WebsocketServlet处理请求，如不接受连接请求，则返回，如接受连接请求，则对请求作出响应，建立起客户端和服务器的socket连接。
  D( D! O9 S- U* r7 z& U服务器此时可以通过WsOutbound发送数据给客户端，同时通过StreamInbound监听socket。
如果接收到客户端发来的数据，则将socket数据解析成frame，判断frame类型，通过事件分发数据到不同的逻辑处理流程。
数据返回时调用WsOutbound对返回的数据进行封装处理，发送给客户端。

: W, G" b  u( ?  X, C四、代码实现以及需求

1 Z0 n5 ^, c" ~: N# B  q6 `1、项目需要，定时向所有在线用户推送一个广告或是推送一个通知之类的(比如服务器升级，请保存好手头工作之类的)。

8 s0 }4 z5 ]! C! U( ^# e) d2、相关环境 ， Nginx、tomcat7、centos 6.5
5 Z5 p9 @+ }% d9 p# x4 h. r
- m. I: u5 [4 R% V; Z- Z3、项目框架，springMvc 4.0.6、layer

4、代码实现：

/ R( S  ~/ G  h. C, g3 IWebSocketConfig：

1. import websocket.handler.SystemWebSocketHandler;
   
2. @Configuration
   
3. @EnableWebMvc
   
4. @EnableWebSocket
   7 P3 f4 D5 S0 G1 P# ]; J& L" D" p, l
5. public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{
   . O! A0 j; x* V; C
6. 
   
7.     @Override
   
8.     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
   
9.          registry.addHandler(systemWebSocketHandler(),"/webSocketServer");
   # y' V, J$ |7 G9 s8 j- l. o5 Z* p
10.          registry.addHandler(systemWebSocketHandler(),"/sockjs/webSocketServer");
    
11.     }
    
12.     @Bean
    
13.     public WebSocketHandler systemWebSocketHandler(){
    
14.         return new SystemWebSocketHandler();
    $ U! W* M6 }' w1 X
15.     }
    
16. }

复制代码

SystemWebSocketHandler：

1. public class SystemWebSocketHandler extends  TextWebSocketHandler {
   ( e$ {/ U8 v9 q# x. ^
2. 
   ( O9 Z) X" R$ M& t: ^
3. 
   ( p* ], k: {" a; M- a
4.     private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();;
   9 T$ t% a% `7 n; q9 O
5. 
   ; ^9 o+ k. F: N- x+ p! [8 D
6.     public void afterConnectionEstablished(WebSocketSession session) throws Exception {
   " n; k9 A* c" A0 ^2 @
7.         System.out.println("ConnectionEstablished");
   
8.         users.add(session);
   
9.         System.out.println("当前用户"+users.size());
   
10.     }
    
11.     /**
    5 b5 e4 h* F) T% J2 h
12.      * 在UI在用js调用websocket.send()时候，会调用该方法
    * @( q6 b1 r7 S* y% q- g
13.      * @Author    张志朋
    
14.      * @param session
    
15.      * @param message
    
16.      * @throws Exception
    - e. X: x, D' m2 v9 G, h
17.      * @Date    2016年3月4日
    ! Q# ]4 t0 a4 I% R+ c. E8 N
18.      * 更新日志
    
19.      * 2016年3月4日 张志朋  首次创建
    
20.      *
    ) L; i, o& f" X9 B# ~6 O
21.      */
    # P" W) p( b' u* j$ Q
22.     @Override
    
23.     protected void handleTextMessage(WebSocketSession session,
    - O6 O/ x5 t( k& o4 M$ h
24.             TextMessage message) throws Exception {
    4 s8 C$ B6 I1 w" V" k6 W
25.         super.handleTextMessage(session, message);
    ' n/ L! M/ Q1 s0 J  }3 [0 R
26.         sendMessageToUsers(session,message);
    0 N% l" z' |* a2 Z
27.     }
    * O$ S$ i: a5 H" _- K0 W
28.     @Override
    
29.     public void handleTransportError(WebSocketSession session, Throwable exception) throws IOException {
    
30.         if(session.isOpen()){
    
31.             session.close();
    . r+ Y  d$ i/ Y  z3 @2 U& t' s
32.         }
    
33.         users.remove(session);
    ) j% t; a5 ?& c$ S
34.     }
    
35. 
    
36.     @Override
    ) v- H* J$ Y+ D, N. e6 ]; }. h
37.     public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
    % |" `1 b3 ]0 O6 d1 r
38.         users.remove(session);
    
39.     }
    
40. 
    5 x+ c, f/ v" T! a
41.     @Override
    
42.     public boolean supportsPartialMessages() {
    
43.         return false;
    1 F1 v) t% ?- n3 K" x
44.     }
    
45.     /**
    * ], Z$ @( A9 A) u, U# k
46.      * 给所有在线用户发送消息
    
47.      * @Author    张志朋
    , P: z0 a! g8 d" {$ h3 S. J. a) |2 e
48.      * @param message  void
    - D6 Q8 y( m% d$ `/ a
49.      * @Date    2016年3月4日
    3 P! j, ^% [4 @' X: D+ T& H" N
50.      * 更新日志
    
51.      * 2016年3月4日 张志朋  首次创建
    
52.      *
    + B; _/ E7 C; c  ^
53.      */
    
54.     public void sendMessageToUsers(WebSocketSession session,TextMessage message) {
    9 k: _9 z5 ]+ }2 e& v4 A$ Y# N0 ~
55.         for (WebSocketSession user : users) {
    % P8 z6 @, B1 E* t
56.             try {
    2 h: J/ m# h) J% l, g% f
57.                 if (user.isOpen()) {
    5 E" u  W/ ?9 ~8 X! P2 g
58.                     user.sendMessage(message);
    
59.                 }
    
60.             } catch (IOException e) {
    
61.                 e.printStackTrace();
    " i4 q; e' O5 b: l9 L" v# z) w
62.             }
    8 x' v0 c9 s! g; B6 J+ F" ~  I
63.         }
    6 L% D( h) o: [( f) n" w9 x' J
64.     }
    
65. }
    8 f- h4 y1 M; p0 D

复制代码

信息输入 index.html：
1 M+ I' p" s6 H/ x

1. <html xmlns="http://www.w3.org/1999/xhtml">
   ; w3 P* o) d% F* D- ?
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>
   4 M. m' u2 C. K: R
6. <script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script>
   
7. <script type="text/javascript">
   ; b5 |: P$ P1 k% `2 w
8. var ws = null;
   
9. $(function () {
   
10.     if ('WebSocket' in window) {
    
11.          ws = new WebSocket('ws://127.0.0.1:8080/webSocketServer');
    1 a  {4 |& H& z. a% {' X
12.     }
    
13.     else if ('MozWebSocket' in window) {
    - j1 D7 _) P9 t4 G8 G
14.         ws = new MozWebSocket("ws://127.0.0.1:8080/webSocketServer");
    , ^* z1 U; \2 [  y  D0 o# u
15.     }
    
16.     else {
    ) H' F6 o! P1 ^5 J
17.         ws = new SockJS("ws://127.0.0.1:8080/webSocketServer");
    
18.     }
    " ]+ r, g0 P2 `! \( K3 z- x% b
19.     ws.onopen = function () {
    * U2 C9 e  s: P. p
20. 
    
21.     };
    
22.     ws.onmessage = function (event) {
    ; l$ w6 a8 R6 S( _: X. Q; C! @5 k: }! a, L
23. 
    
24.     };
    
25.     ws.onclose = function (event) {
    
26. 
    " j. r% R5 S5 T( `1 U% m1 m
27.     };
    ; t0 w' K' i6 @! f, |' I
28. });
    - q+ H5 K9 i0 X+ K7 ^, h9 J0 R4 X4 C7 J
29. function stop(){
    
30.     var message = $("#message").val();
    ; b+ u) x' J4 ~* ~2 c+ }; v
31.     ws.send(message);
    + a( [, E' n" ]; Q# w7 Q8 W1 k/ s$ k
32. }
    
33. </script>
    & k, e1 P; A+ k9 J, b1 l, p* X+ Y
34. </head>
    ! E- N! u! z6 J- U2 o" L3 o4 ^1 s0 X
35. <body class="keBody">
    
36. 请输入提示信息: <textarea id="message"></textarea><br />
    # v/ Q- ]) V6 r; m/ \
37. <input type="button"  value="开始" />
    
38. </body>
    
39. </html>

复制代码

webSocket.js  用于导入项目。

1. document.write("<script language=javascript src='http://127.0.0.1:8080/js/jquery-1.10.2.min.js'></script>");
   2 I. B6 H. @* @5 L/ N+ {& ]& H
2. document.write("<script language=javascript src='http://127.0.0.1:8080/layer/layer.js'></script>");
   
3. document.write("<script language=javascript src='http://cdn.sockjs.org/sockjs-0.3.min.js'></script>");
   ) G* _( k, u. Z7 d9 r
4.     var ws = null;
   
5.     var basePath = "ws://127.0.0.1:8080/";
   
6.     if ('WebSocket' in window) {
   
7.          ws = new WebSocket(basePath+'webSocketServer');
   & f$ e9 [( }$ c0 x0 |4 {
8.     }
   
9.     else if ('MozWebSocket' in window) {
   $ J1 T7 i) y. T# J
10.         ws = new MozWebSocket(basePath+"webSocketServer");
    : M# v4 r# d' A
11.     }
    $ k( q& r( v* b9 A# k8 I
12.     else {
    + C( X. U$ }2 p" c  D: d/ u4 @9 i0 }5 V
13.         ws = new SockJS(basePath+"sockjs/webSocketServer");
    % y9 x) {5 P, q* D5 s& {8 z
14.     }
    
15.     ws.onopen = function () {
    
16. 
    
17.     };
    " O6 e5 F; U3 [) N8 A6 s
18.     ws.onmessage = function (event) {
    
19.         pop(event.data);
    ) @$ S( B  l; P7 @: K
20.     };
    6 Z1 y; o  e8 @6 ?3 ~) M
21.     ws.onclose = function (event) {
    ' Y0 m9 `$ d4 Z1 @$ j' G+ \2 p
22.          ws.close();
    
23.     };
    
24. //提示信息
    
25. function pop(message){
    6 M6 d; m# G  o! ?1 ]0 c
26.     layer.alert(message);
    + D) u) M2 \+ P% c# p
27. }

复制代码

) O) T0 r9 i$ u( U6 m- G5、在项目头部引入
<script language=javascript src='http://127.0.0.1:8080/webSocket.js '></script>

$ Y  D6 y* J$ F) [
0 S% G3 n5 h2 j3 L9 u这时查看后台 会有以下信息 说明 引入成功。
+ k' m+ O/ r2 I  Y, ~0 j1 n7 `

然后在打开页面 index.html 输入以下内容 点击开始即可。
: l! _# R6 `4 a* p3 u3 A/ _- U6 L
. \9 h! G; r! F" v3 Q" a( @# S
, T2 d, H$ M- [如果在网站出现一下提示说明配置成功，这时候所有网站登录用户都可以收到此信息。
* g! Q7 _/ Q3 E8 t+ ]1 Y. Q
( x) y  J7 K$ x! D: Y0 s2 ]. I+ u0 D
6 @: O7 `) R( n" N% i. ~
  l! R% R; g1 i# h项目下载地址：

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

- }5 b0 ^8 M* p- F& q8 y! l
& h1 `! W& Q4 `- J! B

admin

刘继仆 发表于 2016-4-21 07:20
有没有数据库？

( u/ o- D8 Z2 x跟 数据库 没有关系

admin

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

. C7 y0 B/ A! q( j我去 盗我 头像 还不好好回复

admin

destiny123 发表于 2016-5-4 01:20
& J! c. H" [" f3 y9 k* C. ]即时通讯 是这个意思吗

! g, _# C* R0 W# ^; L* Y1 P差不多吧

admin

刘继仆 发表于 2016-4-21 07:20
1 Z$ b" k; n1 V有没有数据库？

出来l

admin

javaWeb12 发表于 2016-10-31 09:22
# O  ?4 ]4 T# q都这么高级了，完全看不懂

" M8 A% U7 T. u9 ?; E  `, J好久 没来了哈