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

admin

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

5 k. x; t. O8 s2 O9 l握手过程：
3 ~3 n- O, C/ b4 _/ q( U7 Z5 J$ \. {Browser与WebSocket服务器通过TCP三次握手建立连接，如果这个建立连接失败，那么后面的过程就不会执行，Web应用程序将收到错误消息通知。
在TCP建立连接成功后，Browser/UA通过http协议传送WebSocket支持的版本号，协议的字版本号，原始地址，主机地址等等一些列字段给服务器端。
WebSocket服务器收到Browser/UA发送来的握手请求后，如果数据包数据和格式正确，客户端和服务器端的协议版本号匹配等等，就接受本次握手连接，并给出相应的数据回复，同样回复的数据包也是采用http协议传输。
Browser收到服务器回复的数据包后，如果数据包内容、格式都没有问题的话，就表示本次连接成功，触发onopen消息，此时Web开发者就可以在此时通过send接口想服务器发送数据。否则，握手连接失败，Web应用程序会收到onerror消息，并且能知道连接失败的原因。

三、Tomcat 7中的Websocket架构
% u( m/ y0 n4 y/ g$ T' @/ O: e* V. O3 }
如图所示，因为Websocket通信分为握手和数据传输两个过程，两个过程中需要用到的处理方式是不一样的，握手过程是基于HTTP 1.1基础上的，而数据传输是直接基于TCP的流传输。
; y( |* d5 L) f       握手过程中，在HttpServletRequest的基础上，封装了WsHttpServletRequest类，添加了对Request的失效操作函数invalidate()。而在数据通信时，接受和处理数据过程中，基于org.apache.coyote.http11.upgrade.UpgradeInbound重新封装了用于处理数据输入流的类StreamInbound，并在StreamInbound的基础上扩展生成了用于消息处理的类MessageInbound。在这两个数据处理类中均留有onData，onTextData/onBinaryData，onOpen，onClose等事件操作函数接口，这些接口将在载入的代码类中实现业务逻辑。在用于数据输出流的类WsOutbound则是封装了UpgradeOutbound对象实例，基于UpgradeOutbound对象的基础上，添加了websocket响应有关的处理逻辑。这里处理函数均为同步调用的函数，保证websocket响应的时序性。
4 d& K; @7 g, {% m' h- N# u5 s, O       Tomcat中Websocket的处理流程如下：
接收客户端发来的握手请求，Coyote.http11连接器对socket进行解析，形成HttpServletRequest发送给Container。
Container中的相应WebsocketServlet处理请求，如不接受连接请求，则返回，如接受连接请求，则对请求作出响应，建立起客户端和服务器的socket连接。
服务器此时可以通过WsOutbound发送数据给客户端，同时通过StreamInbound监听socket。
如果接收到客户端发来的数据，则将socket数据解析成frame，判断frame类型，通过事件分发数据到不同的逻辑处理流程。
2 Y/ Y; K! [! Y7 Z5 `数据返回时调用WsOutbound对返回的数据进行封装处理，发送给客户端。
9 ^8 s' ?; |' M
/ @- ?! M6 f# q7 Y/ P; J! _& B四、代码实现以及需求

1、项目需要，定时向所有在线用户推送一个广告或是推送一个通知之类的(比如服务器升级，请保存好手头工作之类的)。
  D2 d* @4 S/ I& @3 _
2、相关环境 ， Nginx、tomcat7、centos 6.5
$ ^! N5 [0 C4 I, m
3、项目框架，springMvc 4.0.6、layer
5 w) t- E, @6 U# n+ `) W
4、代码实现：
' ~% A' Q# R2 |6 K! p8 x
( a2 Q! N6 E3 l1 y" a' G5 OWebSocketConfig：

1. import websocket.handler.SystemWebSocketHandler;
   7 u, k1 m" j6 a3 ~2 T
2. @Configuration
   4 S4 X( u! b' O* _/ [/ ~$ o
3. @EnableWebMvc
   ! y  B" R$ l- Y
4. @EnableWebSocket
   ' _- M; O8 G' d
5. public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{
   
6. 
   ; f, ?  m* {! a5 `
7.     @Override
   / {/ F1 h& _) J7 {, P
8.     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
   9 e  d, X  `3 M$ [) Q
9.          registry.addHandler(systemWebSocketHandler(),"/webSocketServer");
   - K* @2 `+ a0 A9 T/ \
10.          registry.addHandler(systemWebSocketHandler(),"/sockjs/webSocketServer");
    ! Q  g/ v5 X6 ]5 A
11.     }
    
12.     @Bean
    
13.     public WebSocketHandler systemWebSocketHandler(){
    1 A9 B3 N5 l; ]' c  D: D+ S
14.         return new SystemWebSocketHandler();
    ( C3 F& G6 v7 ^) P( m7 ^3 w: l' u. C
15.     }
    2 V+ K. e* j5 [% q4 s
16. }

复制代码

SystemWebSocketHandler：

1. public class SystemWebSocketHandler extends  TextWebSocketHandler {
   ( L" c! M# o; q& R$ G
2. 
   
3. 
   
4.     private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();;
   
5. 
   + a/ a  P, g  a
6.     public void afterConnectionEstablished(WebSocketSession session) throws Exception {
   ' \4 ?2 M; S1 Y9 O8 V
7.         System.out.println("ConnectionEstablished");
   
8.         users.add(session);
   
9.         System.out.println("当前用户"+users.size());
   , P3 {; t$ z& @% U: [9 q
10.     }
    $ t! P7 @9 B0 C8 D
11.     /**
    
12.      * 在UI在用js调用websocket.send()时候，会调用该方法
    2 f* z6 C8 g8 U' h9 u  K( X
13.      * @Author    张志朋
    + v! u% _) ^4 H. V0 I; S# K" t8 C
14.      * @param session
    
15.      * @param message
    8 ?0 B9 Q& s" t' _8 U2 s$ c7 O' g
16.      * @throws Exception
    
17.      * @Date    2016年3月4日
    
18.      * 更新日志
    , R8 H/ y% W  ?2 o& N; n
19.      * 2016年3月4日 张志朋  首次创建
    
20.      *
    2 c0 K& F& d& A6 A! H- {0 v9 |
21.      */
    6 N( ?  P6 a! z2 ~8 [5 g
22.     @Override
    
23.     protected void handleTextMessage(WebSocketSession session,
    
24.             TextMessage message) throws Exception {
    
25.         super.handleTextMessage(session, message);
    
26.         sendMessageToUsers(session,message);
    9 [4 X* R% f/ H5 S. X
27.     }
    
28.     @Override
    
29.     public void handleTransportError(WebSocketSession session, Throwable exception) throws IOException {
    % D2 ^( d( g9 ~4 d% F
30.         if(session.isOpen()){
    
31.             session.close();
    
32.         }
    
33.         users.remove(session);
    / p5 f6 W& \7 s% o
34.     }
    : h) B! ]1 D" o  j. ?; P" W4 S
35. 
    
36.     @Override
    & I) {3 v- y6 d% Y
37.     public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
    
38.         users.remove(session);
    
39.     }
    
40. 
    # U4 @2 P: k! h% b
41.     @Override
    % T+ v4 L- k& f8 v) k4 a
42.     public boolean supportsPartialMessages() {
    / Q; J) y, {2 o/ O7 G
43.         return false;
    , |7 \9 I' b# g9 z
44.     }
    
45.     /**
    
46.      * 给所有在线用户发送消息
    
47.      * @Author    张志朋
    7 U8 s# A1 ?0 p& a
48.      * @param message  void
    ) K# u3 F8 v  F! |$ C
49.      * @Date    2016年3月4日
    8 q- L$ @. Q7 E$ [8 E; F
50.      * 更新日志
    9 u2 j: r$ N* O' A/ X' ^6 j! K
51.      * 2016年3月4日 张志朋  首次创建
    
52.      *
    
53.      */
    $ M! X9 _# Z3 X# _  D2 u
54.     public void sendMessageToUsers(WebSocketSession session,TextMessage message) {
    
55.         for (WebSocketSession user : users) {
    0 @) T$ n- f8 {- E. Q
56.             try {
    , Z% z! E# Y( l6 p. S+ \' i* C
57.                 if (user.isOpen()) {
    ! i% m* \8 ~4 c0 Y( C) Y' k( t5 D
58.                     user.sendMessage(message);
    + \/ h! W: E6 ?8 V% A) v1 r
59.                 }
    
60.             } catch (IOException e) {
    
61.                 e.printStackTrace();
    3 [( ~5 `. d* e2 w. ~5 W0 |: M) T
62.             }
    3 z9 x# y, Q- ]# u) [; v5 q
63.         }
    2 r2 F5 }( _4 D1 M% g. T
64.     }
    
65. }
    

复制代码

信息输入 index.html：
( D5 ?! W" F2 ?9 y- r; H" ]3 }

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>
   , }8 q8 p  F" g* X% t5 q9 M
5. <script type="text/javascript" src="js/jquery-1.10.2.min.js"></script>
   + H6 o- H2 s" L
6. <script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script>
   
7. <script type="text/javascript">
   
8. var ws = null;
   
9. $(function () {
   
10.     if ('WebSocket' in window) {
    8 I2 R( M" L/ M* d  N
11.          ws = new WebSocket('ws://127.0.0.1:8080/webSocketServer');
    - n" P: Y# J) Q4 |, k! z" Y
12.     }
    ! F; g8 W5 F$ c! X
13.     else if ('MozWebSocket' in window) {
    * H) m6 [8 g1 o
14.         ws = new MozWebSocket("ws://127.0.0.1:8080/webSocketServer");
    
15.     }
    
16.     else {
    " q" V: T5 W, g1 n( m
17.         ws = new SockJS("ws://127.0.0.1:8080/webSocketServer");
    1 m. Q$ P( {4 o- b( ]
18.     }
    
19.     ws.onopen = function () {
    - c# I, o4 D0 [. V$ j$ j
20. 
    9 C" K. }  {, j
21.     };
    
22.     ws.onmessage = function (event) {
    
23. 
    
24.     };
    9 u7 `% \6 J2 z- ]( X
25.     ws.onclose = function (event) {
    
26. 
    
27.     };
    " a9 n$ w; r, X, d" A. C$ A
28. });
    $ g+ Q, e6 p) n( }, j' O
29. function stop(){
    2 \6 K; [' @4 J4 J$ v5 [% x/ \
30.     var message = $("#message").val();
    
31.     ws.send(message);
    ) y+ Y  e0 F% Y* w- u
32. }
    & X( b: r% u! H5 h
33. </script>
    
34. </head>
    
35. <body class="keBody">
    - {2 d; b- O; d3 ^* C' U
36. 请输入提示信息: <textarea id="message"></textarea><br />
    6 n0 z( b( }2 ]/ p
37. <input type="button"  value="开始" />
    9 I) p: ?' n/ A3 E+ K# B1 a# u4 n
38. </body>
    / ?9 \' m* l, y2 V$ ]! f
39. </html>

复制代码

& Z$ z) }1 c' t9 j3 mwebSocket.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>");
   ! y5 b" N0 {, R: f' F) X( I
3. document.write("<script language=javascript src='http://cdn.sockjs.org/sockjs-0.3.min.js'></script>");
   
4.     var ws = null;
   # V+ X, s& l; `& G7 Q1 ~- ]
5.     var basePath = "ws://127.0.0.1:8080/";
   
6.     if ('WebSocket' in window) {
   : T' N/ ^! l+ X* V$ T
7.          ws = new WebSocket(basePath+'webSocketServer');
   
8.     }
   8 e$ a. m+ @+ d6 B9 t( q$ }
9.     else if ('MozWebSocket' in window) {
   
10.         ws = new MozWebSocket(basePath+"webSocketServer");
    ! H8 g$ x1 J- s2 W, Z2 z
11.     }
    
12.     else {
    
13.         ws = new SockJS(basePath+"sockjs/webSocketServer");
    
14.     }
    3 y' I& \+ W, B+ j
15.     ws.onopen = function () {
    $ |; t# e0 i& ^
16. 
    - d; A) ~% ?. C1 `" R$ Q2 ]/ K7 J
17.     };
    . r5 Y& r7 m8 }
18.     ws.onmessage = function (event) {
    
19.         pop(event.data);
    ( z0 g/ A, X& g0 C$ r4 ]
20.     };
    
21.     ws.onclose = function (event) {
    3 e- i. Z, @! w7 k
22.          ws.close();
    % b$ h+ L8 _% z- A# T# F, e
23.     };
    8 c; H& v0 K1 `0 l  \! j5 N
24. //提示信息
    1 [; i/ s, d+ S  @$ V
25. function pop(message){
    3 u9 [+ S3 G5 o: B3 j3 H+ K% ^3 i
26.     layer.alert(message);
    
27. }

复制代码

6 i8 m: U  G! z5 H) j  w5、在项目头部引入
<script language=javascript src='http://127.0.0.1:8080/webSocket.js '></script>

9 |$ D" I( \8 v4 c+ T
这时查看后台 会有以下信息 说明 引入成功。
0 U  {0 t( \2 ~
. b" X* w6 D# B. N2 n& j- f1 C
然后在打开页面 index.html 输入以下内容 点击开始即可。
+ i; c) @1 ?6 q) ?9 h3 Q
& N  P$ P7 h! j
如果在网站出现一下提示说明配置成功，这时候所有网站登录用户都可以收到此信息。


! i& V& b; G+ h
项目下载地址：

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

6 ?6 o$ \7 M1 t& E+ F0 ?0 W1 R
6 q# _2 \! \8 T# X# }4 j$ w: L1 S
; F  z, @! t6 v7 g" z, ?
6 Q; d# ?8 N" j" D% n

刘继仆

有没有数据库？

admin

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

, |2 K5 D$ {- C+ y+ u) x1 d  A跟 数据库 没有关系

hhwang

thanks you for share

学语言

下载来学习下。

烈火炎阳

看看新的内容！

Spirit_wolf

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

beyond

111111111111111111

admin

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

2 U& i% j+ T6 g0 S  h/ M' q我去 盗我 头像 还不好好回复

T参谋长

早想学这个了