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

admin

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

二、WebSocket协议介绍
6 S# q" F1 z! J! k& @3 C　WebSocket协议是一种双向通信协议，它建立在TCP之上，同http一样通过TCP来传输数据，但是它和http最大的不同有两点：1.WebSocket是一种双向通信协议，在建立连接后，WebSocket服务器和Browser/UA都能主动的向对方发送或接收数据，就像Socket一样，不同的是WebSocket是一种建立在Web基础上的一种简单模拟Socket的协议；2.WebSocket需要通过握手连接，类似于TCP它也需要客户端和服务器端进行握手连接，连接成功后才能相互通信。简单的建立握手的时序图如下：

6 p  O& a' o8 ?4 S7 i6 m, z握手过程：
Browser与WebSocket服务器通过TCP三次握手建立连接，如果这个建立连接失败，那么后面的过程就不会执行，Web应用程序将收到错误消息通知。
2 p( c  ^( r" a9 `* q在TCP建立连接成功后，Browser/UA通过http协议传送WebSocket支持的版本号，协议的字版本号，原始地址，主机地址等等一些列字段给服务器端。
WebSocket服务器收到Browser/UA发送来的握手请求后，如果数据包数据和格式正确，客户端和服务器端的协议版本号匹配等等，就接受本次握手连接，并给出相应的数据回复，同样回复的数据包也是采用http协议传输。
Browser收到服务器回复的数据包后，如果数据包内容、格式都没有问题的话，就表示本次连接成功，触发onopen消息，此时Web开发者就可以在此时通过send接口想服务器发送数据。否则，握手连接失败，Web应用程序会收到onerror消息，并且能知道连接失败的原因。

三、Tomcat 7中的Websocket架构
  ^4 R. p' w* s# n$ X
2 e' d- I0 j0 N4 q( H2 ?5 C4 ~7 G  Q如图所示，因为Websocket通信分为握手和数据传输两个过程，两个过程中需要用到的处理方式是不一样的，握手过程是基于HTTP 1.1基础上的，而数据传输是直接基于TCP的流传输。
5 G* \5 h, Q: k: k5 J2 k       握手过程中，在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的处理流程如下：
5 Q( e' ~) b/ {! P. R0 Z接收客户端发来的握手请求，Coyote.http11连接器对socket进行解析，形成HttpServletRequest发送给Container。
Container中的相应WebsocketServlet处理请求，如不接受连接请求，则返回，如接受连接请求，则对请求作出响应，建立起客户端和服务器的socket连接。
服务器此时可以通过WsOutbound发送数据给客户端，同时通过StreamInbound监听socket。
* r0 i( h4 _; E) o" B4 G7 P如果接收到客户端发来的数据，则将socket数据解析成frame，判断frame类型，通过事件分发数据到不同的逻辑处理流程。
% f( e  M* a" Z# R9 z数据返回时调用WsOutbound对返回的数据进行封装处理，发送给客户端。

四、代码实现以及需求

1、项目需要，定时向所有在线用户推送一个广告或是推送一个通知之类的(比如服务器升级，请保存好手头工作之类的)。
" \" R3 E$ U4 b, I! e
2、相关环境 ， Nginx、tomcat7、centos 6.5
( n2 ~: i/ b8 I5 e4 y* S
3、项目框架，springMvc 4.0.6、layer

2 i, q% ^: t+ b4、代码实现：

6 E* e5 D+ T/ k. PWebSocketConfig：

1. import websocket.handler.SystemWebSocketHandler;
   
2. @Configuration
   
3. @EnableWebMvc
   * j; m' A- a$ b: C- Z* \
4. @EnableWebSocket
   % K8 C8 H, M' \" R) g, ]( o
5. public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{
   
6. 
   # B$ b# d& |0 m/ `
7.     @Override
   
8.     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
   ! K! n' K5 V7 v
9.          registry.addHandler(systemWebSocketHandler(),"/webSocketServer");
   ' C1 {5 ?2 }. [# k- M0 Z' R
10.          registry.addHandler(systemWebSocketHandler(),"/sockjs/webSocketServer");
    
11.     }
    8 \5 K/ P# `$ r/ v1 q
12.     @Bean
    : @. g% e) g; y) o$ q
13.     public WebSocketHandler systemWebSocketHandler(){
    . ~  I5 A% C3 R$ ^& u4 a
14.         return new SystemWebSocketHandler();
    7 [2 v4 J. ?$ z1 s# h3 [- K
15.     }
    
16. }

复制代码

SystemWebSocketHandler：

1. public class SystemWebSocketHandler extends  TextWebSocketHandler {
   
2. 
   & z& Z  m8 s& e
3. 
   , ~/ p  L$ i% M
4.     private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();;
   / X7 q' b* z. b0 ~, p4 G7 d
5. 
   * m1 s# @0 B  l9 x7 A
6.     public void afterConnectionEstablished(WebSocketSession session) throws Exception {
   7 n% |6 j3 o& O, {6 c
7.         System.out.println("ConnectionEstablished");
   
8.         users.add(session);
   + ^8 E! c0 x  r/ B4 \
9.         System.out.println("当前用户"+users.size());
   6 ~8 |" \4 v# m- N4 a: w0 s. ~6 |
10.     }
    ! n$ f6 a: M, K1 A* y
11.     /**
    3 u" ^; ~$ i5 Q% K: w& Z
12.      * 在UI在用js调用websocket.send()时候，会调用该方法
    " W8 t  ?' d) a# R
13.      * @Author    张志朋
    5 n' o. s  v6 B) w9 b
14.      * @param session
    
15.      * @param message
    $ ~/ ~, w% f( m
16.      * @throws Exception
    / t. l4 ~- o4 Q) D
17.      * @Date    2016年3月4日
    - {& U  R2 g4 q4 u" H2 W+ b
18.      * 更新日志
    
19.      * 2016年3月4日 张志朋  首次创建
    0 A! [. h7 j5 W& ?* Y. C" @
20.      *
    $ x" g+ ?) h9 G. T: y  r
21.      */
    
22.     @Override
    
23.     protected void handleTextMessage(WebSocketSession session,
    - ]' [6 O6 G( {, ?3 D" O9 R+ s1 u
24.             TextMessage message) throws Exception {
    
25.         super.handleTextMessage(session, message);
    
26.         sendMessageToUsers(session,message);
    ! _' f7 c$ K0 P# ^6 o! `* {3 m- I
27.     }
    
28.     @Override
    
29.     public void handleTransportError(WebSocketSession session, Throwable exception) throws IOException {
    
30.         if(session.isOpen()){
      }% `7 z9 ^5 {! z8 [, q) p2 o
31.             session.close();
    9 m/ k8 B  j1 Q6 |0 a# Z
32.         }
    
33.         users.remove(session);
    * ], {  u% L) y) D' [
34.     }
    & y# h/ o1 T, t
35. 
    
36.     @Override
    * G+ e/ f, k% z. J+ o
37.     public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
    # Y/ H+ g) G5 ]5 [/ g) n
38.         users.remove(session);
    
39.     }
    
40. 
    
41.     @Override
    4 F4 x# y4 u. \, t! N- w. h& o0 ~
42.     public boolean supportsPartialMessages() {
    
43.         return false;
    
44.     }
    9 q! a# u0 j* m4 L
45.     /**
    
46.      * 给所有在线用户发送消息
    . z: |% J# K; Y' g
47.      * @Author    张志朋
    * _) J6 h- c: W  S
48.      * @param message  void
    + m' n% \) k& q: a7 j
49.      * @Date    2016年3月4日
    5 q5 D* j% C2 g: Q; k+ T
50.      * 更新日志
    / F, a' T* ?$ U+ A- X; S! H. V
51.      * 2016年3月4日 张志朋  首次创建
    
52.      *
    
53.      */
    ) G- X* X  e1 y; F, S
54.     public void sendMessageToUsers(WebSocketSession session,TextMessage message) {
    
55.         for (WebSocketSession user : users) {
    
56.             try {
    
57.                 if (user.isOpen()) {
    
58.                     user.sendMessage(message);
    
59.                 }
    
60.             } catch (IOException e) {
    
61.                 e.printStackTrace();
    
62.             }
    
63.         }
    
64.     }
    
65. }
    

复制代码

信息输入 index.html：
( r% B, m6 u* [% N  o# I; X6 r

1. <html xmlns="http://www.w3.org/1999/xhtml">
   6 B5 G1 @% H0 M+ g( X1 _) k
2. <head>
   
3. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   
4. <title>请输入任意消息</title>
   ' m$ t. ~+ v7 S! d' G7 @; o) d
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>
   
7. <script type="text/javascript">
   
8. var ws = null;
   ) F! ^  ?/ K8 c$ D6 {. \% G9 p
9. $(function () {
   3 J" S; H  T0 n
10.     if ('WebSocket' in window) {
    $ X( ^# x' z3 D- L) [+ M
11.          ws = new WebSocket('ws://127.0.0.1:8080/webSocketServer');
    
12.     }
    ! N0 [- s: K+ c: O  ^
13.     else if ('MozWebSocket' in window) {
    
14.         ws = new MozWebSocket("ws://127.0.0.1:8080/webSocketServer");
    , ~( T4 |2 e3 `- M* I3 y# o  I' `2 ^# [
15.     }
    $ K" H. W' I: v0 n7 E
16.     else {
    9 T: A3 G& U$ F( L
17.         ws = new SockJS("ws://127.0.0.1:8080/webSocketServer");
    
18.     }
    ; X4 V8 ^0 R( g: L( A
19.     ws.onopen = function () {
    
20. 
    3 E9 G& y8 y, X% t7 i# Z$ _. R
21.     };
    
22.     ws.onmessage = function (event) {
    " t0 n2 R* G3 G, F6 _8 T1 f
23. 
    
24.     };
    
25.     ws.onclose = function (event) {
    
26. 
    
27.     };
    
28. });
    
29. function stop(){
    
30.     var message = $("#message").val();
    ; ~1 J7 {6 d/ I0 @  H2 Q: A
31.     ws.send(message);
    / \. y; F' g9 i# i
32. }
    ( `. @; I* |. I
33. </script>
    
34. </head>
    
35. <body class="keBody">
    
36. 请输入提示信息: <textarea id="message"></textarea><br />
    6 I% j0 S2 S# t% ~' y
37. <input type="button"  value="开始" />
    
38. </body>
    1 R6 M! q3 Q" Z1 ~$ g4 S
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>");
   * |5 v3 ~. W# s# _* Q/ J1 v- Y; o
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>");
   / l% R' u7 }0 H2 d
4.     var ws = null;
   
5.     var basePath = "ws://127.0.0.1:8080/";
   - V: U1 z% v' K; h9 G
6.     if ('WebSocket' in window) {
   
7.          ws = new WebSocket(basePath+'webSocketServer');
   
8.     }
   
9.     else if ('MozWebSocket' in window) {
   
10.         ws = new MozWebSocket(basePath+"webSocketServer");
    : a3 _9 X& H# F/ Z4 L0 s$ H
11.     }
    
12.     else {
    : V' D6 G. u1 x0 b6 w
13.         ws = new SockJS(basePath+"sockjs/webSocketServer");
    * Z$ Z4 _+ S) W; I
14.     }
    ( W5 [; N# L: l; p' M
15.     ws.onopen = function () {
    
16. 
    0 w/ s6 _3 r  ~
17.     };
    
18.     ws.onmessage = function (event) {
    3 X/ k2 m% K6 I7 m! j9 y2 q
19.         pop(event.data);
    
20.     };
    
21.     ws.onclose = function (event) {
    
22.          ws.close();
    " V1 ^  U9 n7 i$ B" ^
23.     };
    
24. //提示信息
    
25. function pop(message){
    
26.     layer.alert(message);
    ! X6 L* ^# m/ P0 R
27. }

复制代码

5、在项目头部引入
7 W1 h: c- [6 w/ }! O<script language=javascript src='http://127.0.0.1:8080/webSocket.js '></script>
3 D+ q. u6 p) W, e6 l5 {
8 r5 T8 k( b# p& j1 N8 X5 L
) n3 k. q/ {, {这时查看后台 会有以下信息 说明 引入成功。
8 O0 Z/ B2 D( U" @

, {2 b1 B# ~5 v/ G8 f" d然后在打开页面 index.html 输入以下内容 点击开始即可。

; P5 a; p5 Q( C2 Y
如果在网站出现一下提示说明配置成功，这时候所有网站登录用户都可以收到此信息。
, c$ V' j8 W8 O* m1 M
, z% ^; ^6 w7 e: i/ G9 H6 K$ e

* J" o7 L  @* o& \, v项目下载地址：

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

3 w& q! q  x; B  k% h8 j8 y

admin

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

8 i& u% E5 M: p3 L  n跟 数据库 没有关系

admin

beyond 发表于 2016-4-27 03:50
4 K$ o7 A0 o0 n" y, |+ S1 O# W& D: V111111111111111111

我去 盗我 头像 还不好好回复

admin

destiny123 发表于 2016-5-4 01:20
3 k4 o3 b/ N' C即时通讯 是这个意思吗

差不多吧

admin

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

, `3 y! v, z, L9 R% V出来l

admin

javaWeb12 发表于 2016-10-31 09:22
都这么高级了，完全看不懂

- C) p5 S% i  H4 R好久 没来了哈