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

admin

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

- {) O1 p& P! a4 }* W. F二、WebSocket协议介绍
# u# [+ g0 G+ h　WebSocket协议是一种双向通信协议，它建立在TCP之上，同http一样通过TCP来传输数据，但是它和http最大的不同有两点：1.WebSocket是一种双向通信协议，在建立连接后，WebSocket服务器和Browser/UA都能主动的向对方发送或接收数据，就像Socket一样，不同的是WebSocket是一种建立在Web基础上的一种简单模拟Socket的协议；2.WebSocket需要通过握手连接，类似于TCP它也需要客户端和服务器端进行握手连接，连接成功后才能相互通信。简单的建立握手的时序图如下：
1 T. z0 `1 N3 B* R6 i( U
- b5 Q; c# e8 u& e. {% r5 v0 c8 V握手过程：
Browser与WebSocket服务器通过TCP三次握手建立连接，如果这个建立连接失败，那么后面的过程就不会执行，Web应用程序将收到错误消息通知。
在TCP建立连接成功后，Browser/UA通过http协议传送WebSocket支持的版本号，协议的字版本号，原始地址，主机地址等等一些列字段给服务器端。
WebSocket服务器收到Browser/UA发送来的握手请求后，如果数据包数据和格式正确，客户端和服务器端的协议版本号匹配等等，就接受本次握手连接，并给出相应的数据回复，同样回复的数据包也是采用http协议传输。
Browser收到服务器回复的数据包后，如果数据包内容、格式都没有问题的话，就表示本次连接成功，触发onopen消息，此时Web开发者就可以在此时通过send接口想服务器发送数据。否则，握手连接失败，Web应用程序会收到onerror消息，并且能知道连接失败的原因。
3 h* O/ K/ K# d6 J; X- \  V
" m; {9 A5 l, s  |/ C) ?三、Tomcat 7中的Websocket架构

( n7 _& }0 f! z5 s  c如图所示，因为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连接。
+ i$ x" a7 S& k* s服务器此时可以通过WsOutbound发送数据给客户端，同时通过StreamInbound监听socket。
如果接收到客户端发来的数据，则将socket数据解析成frame，判断frame类型，通过事件分发数据到不同的逻辑处理流程。
6 R6 g1 V# u7 ?: d" N数据返回时调用WsOutbound对返回的数据进行封装处理，发送给客户端。
/ M2 r# T; ?; q
1 c' S2 a5 d+ C5 o1 z; M四、代码实现以及需求
, M: p! p2 q" I& V
1、项目需要，定时向所有在线用户推送一个广告或是推送一个通知之类的(比如服务器升级，请保存好手头工作之类的)。
& [  h' k2 O% ]1 i3 b
2、相关环境 ， Nginx、tomcat7、centos 6.5

# O/ N. _3 k7 L( C% O6 h3、项目框架，springMvc 4.0.6、layer
5 U/ a! l: s3 ^& |9 w- i7 [0 U- M
4、代码实现：
, ?2 X! L5 H+ f
0 ]+ K, ^- Q  w( @$ U& g$ IWebSocketConfig：

1. import websocket.handler.SystemWebSocketHandler;
   
2. @Configuration
   
3. @EnableWebMvc
   
4. @EnableWebSocket
   
5. public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{
   * f+ e& ?$ }' I! V* Q
6. 
   5 g+ S8 F1 ~, a2 t# J5 K& v
7.     @Override
   
8.     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
   . p, _! V5 P; U4 a6 c9 e* l$ ^
9.          registry.addHandler(systemWebSocketHandler(),"/webSocketServer");
   
10.          registry.addHandler(systemWebSocketHandler(),"/sockjs/webSocketServer");
    $ V2 l6 _+ x) z
11.     }
    7 O- R/ H, B0 ^7 P9 Z$ B
12.     @Bean
    ' t5 m, ?+ j  |% u/ z, i
13.     public WebSocketHandler systemWebSocketHandler(){
    
14.         return new SystemWebSocketHandler();
    7 a- U% ~, J2 T1 u% |, M$ M" A) J4 p
15.     }
    
16. }

复制代码

SystemWebSocketHandler：

1. public class SystemWebSocketHandler extends  TextWebSocketHandler {
   0 o' K0 q2 d- h- G3 k
2. 
   7 i) H) R2 A4 h& K* I% J
3. 
   
4.     private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();;
   
5. 
   8 |5 s. k- N3 W1 G) M" I
6.     public void afterConnectionEstablished(WebSocketSession session) throws Exception {
   6 v: j. U$ A$ }+ W/ y+ R2 W
7.         System.out.println("ConnectionEstablished");
   0 G. y' c1 O/ h& J$ ]
8.         users.add(session);
   ; i3 }  S3 B2 \9 _' ^
9.         System.out.println("当前用户"+users.size());
   & p: o; }8 E0 S& _; l% _. k2 p! n2 S
10.     }
    & n* f0 Q8 D- c* E" D
11.     /**
    
12.      * 在UI在用js调用websocket.send()时候，会调用该方法
    
13.      * @Author    张志朋
    " D3 Y: V- z: q# `
14.      * @param session
    
15.      * @param message
    - x! r1 [3 g" x( E! Y! f+ [; U" ]2 D5 K6 Q
16.      * @throws Exception
    
17.      * @Date    2016年3月4日
    $ A' @( ?2 x) g- \3 f/ u* L
18.      * 更新日志
    $ S; v3 _) k6 U- l8 c* r
19.      * 2016年3月4日 张志朋  首次创建
    
20.      *
    
21.      */
    3 S& G- i3 B8 s9 c! R
22.     @Override
    # k% p* A( M5 o# F  T( a% v4 L# d
23.     protected void handleTextMessage(WebSocketSession session,
    
24.             TextMessage message) throws Exception {
    / f7 J$ O2 L$ {% s5 s* ^" Y, `
25.         super.handleTextMessage(session, message);
    4 \5 j# N7 x  D) D
26.         sendMessageToUsers(session,message);
      I7 y1 w! J4 D( h0 K. U
27.     }
    0 R5 [4 o. B4 E: S3 m3 F  d0 S) d
28.     @Override
    $ M; A1 m: f  m7 [
29.     public void handleTransportError(WebSocketSession session, Throwable exception) throws IOException {
    2 P! X% B7 O2 |4 N7 a. P+ T
30.         if(session.isOpen()){
    ) z5 F, o; p8 N5 J6 B: e3 a
31.             session.close();
    7 T6 }( l5 ~9 ~5 Q# R2 M( z
32.         }
    
33.         users.remove(session);
    
34.     }
    
35. 
    3 s9 w' K  i; T/ a& [7 p* V
36.     @Override
    
37.     public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
    
38.         users.remove(session);
    - n9 ^. L% c* `: d9 \4 I
39.     }
    5 @1 d$ Q: U4 _' M: R
40. 
    
41.     @Override
    
42.     public boolean supportsPartialMessages() {
    & O8 h$ G1 D9 p% C- ?& a
43.         return false;
    
44.     }
    
45.     /**
    ; O8 q0 q/ V# \) t8 s- t' s4 ~* @
46.      * 给所有在线用户发送消息
    
47.      * @Author    张志朋
    
48.      * @param message  void
    1 H: |& r" f9 F# C- B
49.      * @Date    2016年3月4日
    % N4 K$ r$ c& ]: a" V/ k* q: \( w
50.      * 更新日志
    9 ?# Q7 m6 T1 Y# @
51.      * 2016年3月4日 张志朋  首次创建
    
52.      *
    
53.      */
    
54.     public void sendMessageToUsers(WebSocketSession session,TextMessage message) {
    & q% V0 b3 c& W4 ~3 _
55.         for (WebSocketSession user : users) {
    
56.             try {
    2 G, @$ u: J! @) i# ?" p6 M
57.                 if (user.isOpen()) {
    
58.                     user.sendMessage(message);
    5 M3 w/ ^: M4 K* s
59.                 }
    
60.             } catch (IOException e) {
    
61.                 e.printStackTrace();
    
62.             }
    
63.         }
    
64.     }
    , {: W4 G, |; U1 v! b6 q4 w) x
65. }
    

复制代码

信息输入 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" />
   . \. r: Z  E- c: G; [7 H& E
4. <title>请输入任意消息</title>
   + J$ I+ e1 |; J6 g
5. <script type="text/javascript" src="js/jquery-1.10.2.min.js"></script>
   
6. <script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script>
   ! v. R5 j7 e; k- C/ t  M) g
7. <script type="text/javascript">
   
8. var ws = null;
   3 x8 B! |3 C: y5 y8 J  I0 o
9. $(function () {
   
10.     if ('WebSocket' in window) {
    
11.          ws = new WebSocket('ws://127.0.0.1:8080/webSocketServer');
    
12.     }
    
13.     else if ('MozWebSocket' in window) {
    / ]# `: V, v% ^$ w
14.         ws = new MozWebSocket("ws://127.0.0.1:8080/webSocketServer");
    
15.     }
    3 V6 [8 h5 J; E$ Y# P
16.     else {
    ; U. e" j7 b8 F) u! s# T
17.         ws = new SockJS("ws://127.0.0.1:8080/webSocketServer");
    / O8 b, @: Q. _( K2 I% T- c$ B
18.     }
    9 h1 X. o  d7 T( t5 w5 A- f8 F
19.     ws.onopen = function () {
    3 L. n2 c  o- X$ d2 u0 J' C) p0 R
20. 
    0 |" A# i. T( }* [! T
21.     };
    
22.     ws.onmessage = function (event) {
    
23. 
    # b; U" C2 e6 u
24.     };
    4 F* _3 |2 {! a$ r8 B/ |3 s
25.     ws.onclose = function (event) {
    
26. 
    
27.     };
    
28. });
    
29. function stop(){
    
30.     var message = $("#message").val();
    7 @& R: K. ]( h# i' p/ P9 _6 b
31.     ws.send(message);
    
32. }
    
33. </script>
    
34. </head>
    
35. <body class="keBody">
    
36. 请输入提示信息: <textarea id="message"></textarea><br />
    
37. <input type="button"  value="开始" />
    7 u' G- a3 U! L4 ]! f
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>");
   6 d3 z" Z2 ?8 |  g
2. document.write("<script language=javascript src='http://127.0.0.1:8080/layer/layer.js'></script>");
   + `: U' v) G4 a  K+ A2 P$ g
3. document.write("<script language=javascript src='http://cdn.sockjs.org/sockjs-0.3.min.js'></script>");
   
4.     var ws = null;
   
5.     var basePath = "ws://127.0.0.1:8080/";
   $ `0 `5 k& {9 Y' d9 D% b9 f
6.     if ('WebSocket' in window) {
   
7.          ws = new WebSocket(basePath+'webSocketServer');
   
8.     }
   ) b" ^5 l" p! Q# F4 E7 |: D$ U: y
9.     else if ('MozWebSocket' in window) {
   
10.         ws = new MozWebSocket(basePath+"webSocketServer");
    % _7 |! v1 |. Z) k
11.     }
    8 O. |! d" p" r1 J5 ]% E: w
12.     else {
    
13.         ws = new SockJS(basePath+"sockjs/webSocketServer");
    ; ~+ T  r' q$ h- W. L. B
14.     }
    
15.     ws.onopen = function () {
    
16. 
    
17.     };
    1 G5 H  q( p* W. j, F
18.     ws.onmessage = function (event) {
    
19.         pop(event.data);
    2 r: Z& W) L- Y$ x' k6 f# h* ~
20.     };
    
21.     ws.onclose = function (event) {
    0 ^$ x& \) h4 u- }/ H
22.          ws.close();
    
23.     };
    
24. //提示信息
    # f' ]  f7 G9 z& W/ S  M# J6 `
25. function pop(message){
    $ i& K) M# C2 g/ p3 D( x1 S- l
26.     layer.alert(message);
    
27. }

复制代码

" P# t* `7 i) o3 r. u5、在项目头部引入
. ~  R; X! C+ M1 F# f<script language=javascript src='http://127.0.0.1:8080/webSocket.js '></script>

/ V2 B# h3 F3 G0 _2 `
这时查看后台 会有以下信息 说明 引入成功。


然后在打开页面 index.html 输入以下内容 点击开始即可。
9 s) k) i& L1 d' ]9 t2 J0 ^2 U4 ?, x

如果在网站出现一下提示说明配置成功，这时候所有网站登录用户都可以收到此信息。
$ P0 F/ u, i; l1 H) B
+ N6 @7 i6 j5 @5 s0 @; c  _" _

项目下载地址：

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

( Z) t8 @: ~1 N# o$ _. s



9 G* y6 \- w" b( S* k3 c. W

admin

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

跟 数据库 没有关系

admin

beyond 发表于 2016-4-27 03:50
, C$ @: X3 t( i% S2 P* m111111111111111111

" h6 o( ~6 N; z6 M1 |) ?" i我去 盗我 头像 还不好好回复

admin

destiny123 发表于 2016-5-4 01:20
即时通讯 是这个意思吗

# s$ U' W, d/ U  I7 k6 f; D差不多吧

admin

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

# w' o3 H4 x( ~: {8 R- U出来l

admin

javaWeb12 发表于 2016-10-31 09:22
) J& t8 [4 ?' S* A( c: `* w' }都这么高级了，完全看不懂

好久 没来了哈