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

admin

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

如图所示，因为Websocket通信分为握手和数据传输两个过程，两个过程中需要用到的处理方式是不一样的，握手过程是基于HTTP 1.1基础上的，而数据传输是直接基于TCP的流传输。
, r3 e1 b/ D" [6 [       握手过程中，在HttpServletRequest的基础上，封装了WsHttpServletRequest类，添加了对Request的失效操作函数invalidate()。而在数据通信时，接受和处理数据过程中，基于org.apache.coyote.http11.upgrade.UpgradeInbound重新封装了用于处理数据输入流的类StreamInbound，并在StreamInbound的基础上扩展生成了用于消息处理的类MessageInbound。在这两个数据处理类中均留有onData，onTextData/onBinaryData，onOpen，onClose等事件操作函数接口，这些接口将在载入的代码类中实现业务逻辑。在用于数据输出流的类WsOutbound则是封装了UpgradeOutbound对象实例，基于UpgradeOutbound对象的基础上，添加了websocket响应有关的处理逻辑。这里处理函数均为同步调用的函数，保证websocket响应的时序性。
0 K' @# Z: X- W( H, c  \9 {* v       Tomcat中Websocket的处理流程如下：
接收客户端发来的握手请求，Coyote.http11连接器对socket进行解析，形成HttpServletRequest发送给Container。
2 d; r/ ?$ |7 b2 {6 u; WContainer中的相应WebsocketServlet处理请求，如不接受连接请求，则返回，如接受连接请求，则对请求作出响应，建立起客户端和服务器的socket连接。
服务器此时可以通过WsOutbound发送数据给客户端，同时通过StreamInbound监听socket。
4 i6 ?, H8 e/ x+ O如果接收到客户端发来的数据，则将socket数据解析成frame，判断frame类型，通过事件分发数据到不同的逻辑处理流程。
数据返回时调用WsOutbound对返回的数据进行封装处理，发送给客户端。
$ X, [" i/ w6 p" ~; Q4 h
# S' [: a& s7 X- M) B% I4 `9 Y四、代码实现以及需求
6 u% C* ^; a1 q
+ [) [0 l4 O7 c  b) }1、项目需要，定时向所有在线用户推送一个广告或是推送一个通知之类的(比如服务器升级，请保存好手头工作之类的)。

2、相关环境 ， Nginx、tomcat7、centos 6.5
7 V1 ?# N/ o) Z! w
3、项目框架，springMvc 4.0.6、layer

7 f7 x' ?, S! D5 T4、代码实现：
) T$ ~5 X2 P3 ]/ i& u5 e  ~
. n; S7 o" a& a! {) D. G& ^; }WebSocketConfig：

1. import websocket.handler.SystemWebSocketHandler;
   
2. @Configuration
   
3. @EnableWebMvc
   
4. @EnableWebSocket
   " v# v8 y% e9 u* n* V- }/ ?# Y
5. public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{
   
6. 
   
7.     @Override
   
8.     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
   
9.          registry.addHandler(systemWebSocketHandler(),"/webSocketServer");
   * }0 q  y3 j: a' V/ G0 w1 o  M
10.          registry.addHandler(systemWebSocketHandler(),"/sockjs/webSocketServer");
    
11.     }
    
12.     @Bean
    
13.     public WebSocketHandler systemWebSocketHandler(){
    
14.         return new SystemWebSocketHandler();
    
15.     }
    
16. }

复制代码

SystemWebSocketHandler：

1. public class SystemWebSocketHandler extends  TextWebSocketHandler {
   
2. 
   8 G4 n# I' o9 ^& _
3. 
   ) D' T5 u# M+ l1 c: J8 I6 H
4.     private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();;
   0 [; S$ u, r; ^3 v! _
5. 
   
6.     public void afterConnectionEstablished(WebSocketSession session) throws Exception {
   
7.         System.out.println("ConnectionEstablished");
   & A/ J/ y; k% ]( D: d
8.         users.add(session);
   3 N) `+ |  x/ |/ a3 S( k
9.         System.out.println("当前用户"+users.size());
   
10.     }
    
11.     /**
    
12.      * 在UI在用js调用websocket.send()时候，会调用该方法
    ( a" _, k( R$ r# B2 }6 Q
13.      * @Author    张志朋
    
14.      * @param session
    
15.      * @param message
    
16.      * @throws Exception
    ; k( D  |& Q" j
17.      * @Date    2016年3月4日
    
18.      * 更新日志
    " m5 }! N; a: a
19.      * 2016年3月4日 张志朋  首次创建
    
20.      *
    
21.      */
    
22.     @Override
    
23.     protected void handleTextMessage(WebSocketSession session,
    , _( S/ B7 K; D: h9 h( l
24.             TextMessage message) throws Exception {
    . V% b2 V% E5 r8 M! o0 \
25.         super.handleTextMessage(session, message);
    ) T8 i" o4 r: X+ l, V9 I
26.         sendMessageToUsers(session,message);
    $ G8 F/ f. O9 m/ k7 t: A+ B
27.     }
    1 b9 P" e; Q" C( r" r  K
28.     @Override
    7 S# I. H# y+ p4 n3 h0 _
29.     public void handleTransportError(WebSocketSession session, Throwable exception) throws IOException {
    # O- b. t; t* r+ }+ Q3 }1 O0 {2 o
30.         if(session.isOpen()){
    
31.             session.close();
    
32.         }
    
33.         users.remove(session);
    7 d9 z$ Q1 w! C( p2 _" I
34.     }
    & [; \  \: W6 F$ `1 g8 L5 b9 \, h" w8 S
35. 
    
36.     @Override
    
37.     public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
    0 S+ C" b$ v6 S" K) r/ @/ x
38.         users.remove(session);
    
39.     }
    
40. 
    
41.     @Override
    4 h$ a; B  \1 A+ m
42.     public boolean supportsPartialMessages() {
    
43.         return false;
    
44.     }
    5 j5 M3 w; ~: B/ A
45.     /**
    5 o. U! W; Q- X2 l
46.      * 给所有在线用户发送消息
    7 V/ c3 r8 d; l3 o7 D5 M' R
47.      * @Author    张志朋
    % C2 q" _$ |& f& b5 c
48.      * @param message  void
    
49.      * @Date    2016年3月4日
    
50.      * 更新日志
    " E3 N' }, j8 a) y% x) C8 M! l
51.      * 2016年3月4日 张志朋  首次创建
    
52.      *
    2 Y$ D! R7 o1 G- h
53.      */
    ; i+ }6 h  w9 X4 P* c: w: s
54.     public void sendMessageToUsers(WebSocketSession session,TextMessage message) {
    # {4 G& g* F2 C, s; p
55.         for (WebSocketSession user : users) {
    2 |: b. @5 C- d$ }0 T& c) F
56.             try {
    4 n) D0 ~+ x8 @* d$ u' I, P% v
57.                 if (user.isOpen()) {
    
58.                     user.sendMessage(message);
    
59.                 }
    $ B# W3 m* ]+ y6 E: K" w. d% O
60.             } catch (IOException e) {
    
61.                 e.printStackTrace();
    3 F3 ~: Z  L% V1 ]/ j& ?; l: i
62.             }
    
63.         }
    
64.     }
    
65. }
    % T2 |! \: x6 w1 S& [1 K

复制代码

信息输入 index.html：
: Y" t* R- i/ ~& S1 ]$ Y. ?6 i4 |

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>
   4 [( }& g  D! W
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>
   / |6 r( A' L' n! r3 Y$ K
7. <script type="text/javascript">
   1 ?% \7 t# A5 j, d0 L
8. var ws = null;
   
9. $(function () {
   
10.     if ('WebSocket' in window) {
    
11.          ws = new WebSocket('ws://127.0.0.1:8080/webSocketServer');
    
12.     }
    3 h* W9 ^9 Z5 ~$ u3 z# M
13.     else if ('MozWebSocket' in window) {
    7 J* G* u3 ?+ d4 v3 s, a! v
14.         ws = new MozWebSocket("ws://127.0.0.1:8080/webSocketServer");
    
15.     }
    
16.     else {
    
17.         ws = new SockJS("ws://127.0.0.1:8080/webSocketServer");
    7 ?6 o* g$ t8 n. h+ w
18.     }
    $ ]' d! F& J, I' r6 l* d, U) u
19.     ws.onopen = function () {
    , n3 G5 W8 Z3 C4 x7 |% x/ ~
20. 
    
21.     };
    ( r: k- a- e3 F  K
22.     ws.onmessage = function (event) {
    
23. 
    ) R6 }$ ~# h7 F& _2 n
24.     };
    
25.     ws.onclose = function (event) {
    
26. 
    9 C( g: B0 [- ?5 R. P1 V" }
27.     };
    
28. });
    
29. function stop(){
    / Y' G$ Q( C: m# ^: I& c
30.     var message = $("#message").val();
    5 ?* _, L; W3 \' k. F9 o1 k
31.     ws.send(message);
    * [6 x  M- j/ `
32. }
    6 N" _: [: q! C9 S) Z; Z: F
33. </script>
    
34. </head>
    
35. <body class="keBody">
    3 v' s4 r8 x5 E- C3 l& f* R! M- R
36. 请输入提示信息: <textarea id="message"></textarea><br />
    
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>");
   4 i! f9 ]5 {; u0 l: G6 j
2. document.write("<script language=javascript src='http://127.0.0.1:8080/layer/layer.js'></script>");
   9 e4 M+ x  p: K1 H3 z* E
3. document.write("<script language=javascript src='http://cdn.sockjs.org/sockjs-0.3.min.js'></script>");
   
4.     var ws = null;
   3 ~! i( ?" j- d& I: x  P' W
5.     var basePath = "ws://127.0.0.1:8080/";
   
6.     if ('WebSocket' in window) {
   
7.          ws = new WebSocket(basePath+'webSocketServer');
   
8.     }
   4 l% ~. ~0 u- e) t; B; G
9.     else if ('MozWebSocket' in window) {
   , h* B4 f# X: A0 a( l
10.         ws = new MozWebSocket(basePath+"webSocketServer");
    + {4 J3 b0 o3 Q1 Q1 D
11.     }
    " K1 |: D5 r: X2 L- c1 }$ L
12.     else {
    
13.         ws = new SockJS(basePath+"sockjs/webSocketServer");
    / u6 V, b5 _3 ]: s
14.     }
    
15.     ws.onopen = function () {
    
16. 
    
17.     };
    
18.     ws.onmessage = function (event) {
    % B4 M% H/ n$ a- y1 ?
19.         pop(event.data);
    
20.     };
    : ?0 x: t! {$ D) |' a4 a
21.     ws.onclose = function (event) {
    * E  a1 V! t: a* U2 |" a& Z6 r
22.          ws.close();
    + x* `7 N0 K( V% T3 s- [
23.     };
    
24. //提示信息
    " W$ F' |9 _! Y, w
25. function pop(message){
    5 I3 @0 _( L- W/ O; M
26.     layer.alert(message);
    
27. }

复制代码

$ H8 M) j& p# B" m5 G( i# F+ w5 l; [5、在项目头部引入
1 p! d- m6 X3 {9 h. I) f<script language=javascript src='http://127.0.0.1:8080/webSocket.js '></script>
' R0 V! @7 _1 k

这时查看后台 会有以下信息 说明 引入成功。

( {  C$ X& T! ~3 W
+ ~( n! G- A1 w; G( C- X然后在打开页面 index.html 输入以下内容 点击开始即可。
4 c$ G; u' D* ?! |$ p
4 U# W% I; l$ Z; u7 O$ n8 a
如果在网站出现一下提示说明配置成功，这时候所有网站登录用户都可以收到此信息。


& c6 v- N( D, p( ~9 c
' \, Y& v: @' \1 k2 O; R$ S* D2 n3 X项目下载地址：

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

* d$ f+ }; @* B5 z9 T

4 a1 Z% ]) S4 y

刘继仆

有没有数据库？

admin

刘继仆 发表于 2016-4-21 07:20
/ U: W! b3 K2 {& J# j有没有数据库？

$ A+ R. `  L6 D跟 数据库 没有关系

hhwang

thanks you for share

学语言

下载来学习下。

烈火炎阳

看看新的内容！

Spirit_wolf

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

beyond

111111111111111111

admin

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

$ x2 I  m. a0 d* V" o2 w我去 盗我 头像 还不好好回复

T参谋长

早想学这个了