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

admin

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

* d0 c& d; O) _5 s4 ~' U  r1 \二、WebSocket协议介绍
6 e8 I+ ?4 b# p/ }# q　WebSocket协议是一种双向通信协议，它建立在TCP之上，同http一样通过TCP来传输数据，但是它和http最大的不同有两点：1.WebSocket是一种双向通信协议，在建立连接后，WebSocket服务器和Browser/UA都能主动的向对方发送或接收数据，就像Socket一样，不同的是WebSocket是一种建立在Web基础上的一种简单模拟Socket的协议；2.WebSocket需要通过握手连接，类似于TCP它也需要客户端和服务器端进行握手连接，连接成功后才能相互通信。简单的建立握手的时序图如下：
) b$ q5 o. V! S4 u9 @2 F' _; n
握手过程：
Browser与WebSocket服务器通过TCP三次握手建立连接，如果这个建立连接失败，那么后面的过程就不会执行，Web应用程序将收到错误消息通知。
, f& B4 {* J2 M* n9 K" n在TCP建立连接成功后，Browser/UA通过http协议传送WebSocket支持的版本号，协议的字版本号，原始地址，主机地址等等一些列字段给服务器端。
WebSocket服务器收到Browser/UA发送来的握手请求后，如果数据包数据和格式正确，客户端和服务器端的协议版本号匹配等等，就接受本次握手连接，并给出相应的数据回复，同样回复的数据包也是采用http协议传输。
Browser收到服务器回复的数据包后，如果数据包内容、格式都没有问题的话，就表示本次连接成功，触发onopen消息，此时Web开发者就可以在此时通过send接口想服务器发送数据。否则，握手连接失败，Web应用程序会收到onerror消息，并且能知道连接失败的原因。
" R3 p7 l' v. g. M( D( c; w/ T  \! R
* u+ Q) t5 G  x: C$ W三、Tomcat 7中的Websocket架构

6 a; W9 @( i- W  Y$ D: D如图所示，因为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响应的时序性。
8 R8 {; [9 A, l$ [6 T       Tomcat中Websocket的处理流程如下：
4 B, g! F5 ~. c& L接收客户端发来的握手请求，Coyote.http11连接器对socket进行解析，形成HttpServletRequest发送给Container。
Container中的相应WebsocketServlet处理请求，如不接受连接请求，则返回，如接受连接请求，则对请求作出响应，建立起客户端和服务器的socket连接。
服务器此时可以通过WsOutbound发送数据给客户端，同时通过StreamInbound监听socket。
如果接收到客户端发来的数据，则将socket数据解析成frame，判断frame类型，通过事件分发数据到不同的逻辑处理流程。
数据返回时调用WsOutbound对返回的数据进行封装处理，发送给客户端。
3 A; X# I, p) T+ i; x, S6 y
0 O/ `( O3 K, |1 R四、代码实现以及需求

$ @+ O+ o' a* z# {" W4 Y6 Y1、项目需要，定时向所有在线用户推送一个广告或是推送一个通知之类的(比如服务器升级，请保存好手头工作之类的)。

2、相关环境 ， Nginx、tomcat7、centos 6.5

" t) I# @$ q8 i$ a  p3 f& m8 w3、项目框架，springMvc 4.0.6、layer

4、代码实现：

WebSocketConfig：

1. import websocket.handler.SystemWebSocketHandler;
   / L  O# D) {( R7 ?! O) }: |0 J( z6 ?
2. @Configuration
   * ?/ f  Q8 ?; h1 L9 @
3. @EnableWebMvc
   5 U- E7 N  i' Q1 b" F$ O
4. @EnableWebSocket
   2 I$ C& S4 j$ n$ g
5. public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{
   ! J7 a5 F& I+ M0 N0 ^9 l: J
6. 
   
7.     @Override
   ' x9 r5 k- }9 Q5 e
8.     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
   
9.          registry.addHandler(systemWebSocketHandler(),"/webSocketServer");
   6 h- S2 q+ a+ i/ B! T& ^
10.          registry.addHandler(systemWebSocketHandler(),"/sockjs/webSocketServer");
    / ?* [5 W, a' e* c, P
11.     }
    : z* l3 T2 [8 D+ y& L
12.     @Bean
    
13.     public WebSocketHandler systemWebSocketHandler(){
    
14.         return new SystemWebSocketHandler();
    ( p. c! _" I- q$ D* |$ V& D5 M( W
15.     }
    
16. }

复制代码

SystemWebSocketHandler：
$ u! E7 K( m" I  \% E0 A1 H

1. public class SystemWebSocketHandler extends  TextWebSocketHandler {
   / {, p7 O% [. f
2. 
   4 m1 S: z  a& z
3. 
   0 w2 s# O* ]8 x
4.     private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();;
   
5. 
   ) c- |  ?. a5 I% X- J& {7 `& O" h
6.     public void afterConnectionEstablished(WebSocketSession session) throws Exception {
   6 o" S( @8 b2 E( X
7.         System.out.println("ConnectionEstablished");
   
8.         users.add(session);
   
9.         System.out.println("当前用户"+users.size());
   8 O$ l: E) D8 {% E3 X. L
10.     }
    
11.     /**
    
12.      * 在UI在用js调用websocket.send()时候，会调用该方法
    # d7 o4 ^6 G5 C8 Q6 h6 w: b
13.      * @Author    张志朋
    
14.      * @param session
    ; A" _( \' A% E
15.      * @param message
    
16.      * @throws Exception
    8 }( ]5 {0 g1 l% {( W( k
17.      * @Date    2016年3月4日
    9 L5 N' C2 u* K! v( H
18.      * 更新日志
    
19.      * 2016年3月4日 张志朋  首次创建
    6 s$ B+ E- k9 I4 }7 g. i5 Z+ z5 _
20.      *
    
21.      */
    . A% A/ d2 Y6 `, A8 Y
22.     @Override
    
23.     protected void handleTextMessage(WebSocketSession session,
    3 m) h. i8 E7 z
24.             TextMessage message) throws Exception {
    & y7 y7 c" }1 u2 ^( V
25.         super.handleTextMessage(session, message);
    / P8 C9 r$ n8 J6 w, }1 l
26.         sendMessageToUsers(session,message);
    
27.     }
    # `( N( d! n9 k7 D$ X
28.     @Override
    ! t7 v, I5 w5 b5 }" B6 w2 \4 x
29.     public void handleTransportError(WebSocketSession session, Throwable exception) throws IOException {
    ) m7 B  O# m2 ~: i
30.         if(session.isOpen()){
    
31.             session.close();
    ) u; O7 |/ o( S3 B: J" [
32.         }
    
33.         users.remove(session);
    
34.     }
    4 Z* I: q' D$ E
35. 
    # K7 U% p/ A0 ^( k) Z& Z+ j
36.     @Override
    
37.     public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
    ) T" K: Y. ^; O% O7 p: ]" j, {
38.         users.remove(session);
    
39.     }
    
40. 
    
41.     @Override
    
42.     public boolean supportsPartialMessages() {
    
43.         return false;
    
44.     }
    
45.     /**
    7 F! C4 x6 b" o# T4 h; [
46.      * 给所有在线用户发送消息
    
47.      * @Author    张志朋
    
48.      * @param message  void
    
49.      * @Date    2016年3月4日
    
50.      * 更新日志
    
51.      * 2016年3月4日 张志朋  首次创建
    
52.      *
    
53.      */
    
54.     public void sendMessageToUsers(WebSocketSession session,TextMessage message) {
    
55.         for (WebSocketSession user : users) {
    4 `- K, Y# P8 u4 ]1 P- `
56.             try {
    
57.                 if (user.isOpen()) {
    
58.                     user.sendMessage(message);
    - n+ F8 C! j% p( n5 ?
59.                 }
    
60.             } catch (IOException e) {
    
61.                 e.printStackTrace();
    
62.             }
    8 ]& J8 `& o+ @( p3 R; X
63.         }
    
64.     }
    
65. }
    / K1 J3 d$ Y3 R* t" U, G

复制代码

信息输入 index.html：

1. <html xmlns="http://www.w3.org/1999/xhtml">
   
2. <head>
   ) d7 Z4 n, F1 x6 a2 }
3. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   
4. <title>请输入任意消息</title>
   ( k  d! e, r  r# \/ F
5. <script type="text/javascript" src="js/jquery-1.10.2.min.js"></script>
   : B- C+ u5 W. C2 k5 j) X
6. <script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script>
   
7. <script type="text/javascript">
   1 E( `$ }* Q: E% m8 u& D
8. var ws = null;
   
9. $(function () {
   5 l( e9 I& p" R* s% J1 P. `4 Y
10.     if ('WebSocket' in window) {
    
11.          ws = new WebSocket('ws://127.0.0.1:8080/webSocketServer');
    0 C( o- z: d# I* c( w; j4 s
12.     }
    
13.     else if ('MozWebSocket' in window) {
    
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");
    
18.     }
    8 h6 V! x$ D7 A. Y$ ^* p
19.     ws.onopen = function () {
    
20. 
    6 }7 s. F6 T. N, ]
21.     };
    
22.     ws.onmessage = function (event) {
    - ~1 u0 a3 I+ {# G4 p6 g
23. 
    
24.     };
    
25.     ws.onclose = function (event) {
    
26. 
    " `* s, n) K, T' {
27.     };
    . w1 z% X) Q$ W. B) F$ S6 m, l- O
28. });
    ; L- n0 R$ M4 a9 w7 _4 J5 c; T8 `
29. function stop(){
    
30.     var message = $("#message").val();
    4 o$ p+ D4 f. u* d1 `) i/ y3 X
31.     ws.send(message);
    
32. }
    
33. </script>
    8 |, G3 C, k+ F* t
34. </head>
    
35. <body class="keBody">
    
36. 请输入提示信息: <textarea id="message"></textarea><br />
    ( t2 {/ U' K4 L& L) }% w
37. <input type="button"  value="开始" />
    5 p0 w3 C+ z4 y/ M9 u6 a; o# d
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. document.write("<script language=javascript src='http://127.0.0.1:8080/layer/layer.js'></script>");
   , e9 a0 B2 S; O$ h, b6 N/ j9 G0 m
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/";
   * O' |2 R' y  y' ]& d; Q
6.     if ('WebSocket' in window) {
   " Z5 `1 z! m+ @# u  D. {. k( g
7.          ws = new WebSocket(basePath+'webSocketServer');
   
8.     }
     J/ J! b6 N+ _+ R
9.     else if ('MozWebSocket' in window) {
   
10.         ws = new MozWebSocket(basePath+"webSocketServer");
    
11.     }
    % `. e; @; A2 ]/ x# C) r% t
12.     else {
    8 N" o% r7 c, n
13.         ws = new SockJS(basePath+"sockjs/webSocketServer");
    
14.     }
    
15.     ws.onopen = function () {
    
16. 
      s# z7 h. B" @8 l+ W
17.     };
    5 F- U1 M- g. M0 L+ d" H
18.     ws.onmessage = function (event) {
    2 N1 Y; u$ B/ I6 g% c% u( b2 a
19.         pop(event.data);
    
20.     };
    4 N- q, b3 s9 k2 ?& b1 C
21.     ws.onclose = function (event) {
    
22.          ws.close();
    
23.     };
    $ w: B7 {2 R" b- m" `- j
24. //提示信息
    
25. function pop(message){
    + H7 W2 c. Y/ H& B7 v2 ]) X( d: S5 V
26.     layer.alert(message);
    7 I# @  w! r0 K6 \  ?9 H9 h
27. }

复制代码

& a' P4 i6 [- w+ \% t7 s0 @2 F5、在项目头部引入
1 Z( m* C: X6 J* Z. `+ N" p/ w<script language=javascript src='http://127.0.0.1:8080/webSocket.js '></script>
% ?2 a' M+ ?1 s3 |8 @* N

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


# V+ I7 m) z, ?5 l6 H& f: N2 X然后在打开页面 index.html 输入以下内容 点击开始即可。
2 ~1 k3 ~2 q4 I+ O7 L) W5 t& F

如果在网站出现一下提示说明配置成功，这时候所有网站登录用户都可以收到此信息。


; O) r' _: E5 Q5 h# k" b
3 o# [/ _% h' N" j1 O5 O. M6 ~项目下载地址：

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

/ L4 y2 B9 w; D/ [1 k2 e

" S& @/ W/ |  S+ }+ Z+ D4 c1 D

刘继仆

有没有数据库？

admin

刘继仆 发表于 2016-4-21 07:20
3 Z% v. J+ L3 G1 `( c& a# A1 S有没有数据库？

6 X. \6 C5 J2 l+ Q跟 数据库 没有关系

hhwang

thanks you for share

学语言

下载来学习下。

烈火炎阳

看看新的内容！

Spirit_wolf

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

beyond

111111111111111111

admin

beyond 发表于 2016-4-27 03:50
& ~6 z* w% o/ l' w- g111111111111111111

# Z; R2 A: N/ Q3 i" H我去 盗我 头像 还不好好回复

T参谋长

早想学这个了