Java后端WebSocket的Tomcat实现

Posted 吃饭了吗

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Java后端WebSocket的Tomcat实现相关的知识,希望对你有一定的参考价值。

随着互联网的发展,传统的HTTP协议已经很难满足Web应用日益复杂的需求了。近年来,随着html5的诞生,WebSocket协议被提出,它实现了浏览器与服务器的全双工通信,扩展了浏览器与服务端的通信功能,使服务端也能主动向客户端发送数据。

 

我们知道,传统的HTTP协议是无状态的,每次请求(request)都要由客户端(如浏览器)主动发起,服务端进行处理后返回response结果,而服务端很难主动向客户端发送数据;这种客户端是主动方,服务端是被动方的传统Web模式对于信息变化不频繁的Web应用来说造成的麻烦较小,而对于涉及实时信息的Web应用却带来了很大的不便,如带有即时通信、实时数据、订阅推送等功能的应用。在WebSocket规范提出之前,开发人员若要实现这些实时性较强的功能,经常会使用折衷的解决方法:轮询(polling)和Comet技术。其实后者本质上也是一种轮询,只不过有所改进。

 

轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求,频繁地查询是否有新的数据改动。明显地,这种方法会导致过多不必要的请求,浪费流量和服务器资源。

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上才能运行。

 

新建一个dynamic web项目:

  客户端(Web主页)代码:

技术分享图片
 1 <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
 2 <%
 3 String path = request.getContextPath();
 4 String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
 5 %>
 6  
 7 <!DOCTYPE HTML>
 8 <html>
 9   <head>
10     <base href="<%=basePath%>">
11     <title>My WebSocket</title>
12   </head>
13    
14   <body>
15     Welcome<br/>
16     <input id="text" type="text" /><button onclick="send()">Send</button>    <button onclick="closeWebSocket()">Close</button>
17     <div id="message">
18     </div>
19   </body>
20    
21   <script type="text/javascript">
22       var websocket = null;
23        
24       //判断当前浏览器是否支持WebSocket
25       if(‘WebSocket‘ in window){
26           websocket = new WebSocket("ws://localhost:8080/MyWebSocket/websocket");
27       }
28       else{
29           alert(‘Not support websocket‘)
30       }
31        
32       //连接发生错误的回调方法
33       websocket.onerror = function(){
34           setMessageInnerHTML("error");
35       };
36        
37       //连接成功建立的回调方法
38       websocket.onopen = function(event){
39           setMessageInnerHTML("open");
40       }
41        
42       //接收到消息的回调方法
43       websocket.onmessage = function(event){
44           setMessageInnerHTML(event.data);
45       }
46        
47       //连接关闭的回调方法
48       websocket.onclose = function(){
49           setMessageInnerHTML("close");
50       }
51        
52       //监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
53       window.onbeforeunload = function(){
54           websocket.close();
55       }
56        
57       //将消息显示在网页上
58       function setMessageInnerHTML(innerHTML){
59           document.getElementById(‘message‘).innerHTML += innerHTML + ‘<br/>‘;
60       }
61        
62       //关闭连接
63       function closeWebSocket(){
64           websocket.close();
65       }
66        
67       //发送消息
68       function send(){
69           var message = document.getElementById(‘text‘).value;
70           websocket.send(message);
71       }
72   </script>
73 </html>
技术分享图片

Java Web后端代码

技术分享图片
 1 package com.chen.websocket;
 2 import java.io.IOException;
 3 import java.util.concurrent.CopyOnWriteArraySet;
 4  
 5 import javax.websocket.OnClose;
 6 import javax.websocket.OnError;
 7 import javax.websocket.OnMessage;
 8 import javax.websocket.OnOpen;
 9 import javax.websocket.Session;
10 import javax.websocket.server.ServerEndpoint;
11  
12 //该注解用来指定一个URI,客户端可以通过这个URI来连接到WebSocket。类似Servlet的注解mapping。无需在web.xml中配置。
13 @ServerEndpoint("/websocket")
14 public class MyWebSocket {
15     //静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。
16     private static int onlineCount = 0;
17      
18     //concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话,可以使用Map来存放,其中Key可以为用户标识
19     private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>();
20      
21     //与某个客户端的连接会话,需要通过它来给客户端发送数据
22     private Session session;
23      
24     /**
25      * 连接建立成功调用的方法
26      * @param session  可选的参数。session为与某个客户端的连接会话,需要通过它来给客户端发送数据
27      */
28     @OnOpen
29     public void onOpen(Session session){
30         this.session = session;
31         webSocketSet.add(this);     //加入set中
32         addOnlineCount();           //在线数加1
33         System.out.println("有新连接加入!当前在线人数为" + getOnlineCount());
34     }
35      
36     /**
37      * 连接关闭调用的方法
38      */
39     @OnClose
40     public void onClose(){
41         webSocketSet.remove(this);  //从set中删除
42         subOnlineCount();           //在线数减1    
43         System.out.println("有一连接关闭!当前在线人数为" + getOnlineCount());
44     }
45      
46     /**
47      * 收到客户端消息后调用的方法
48      * @param message 客户端发送过来的消息
49      * @param session 可选的参数
50      */
51     @OnMessage
52     public void onMessage(String message, Session session) {
53         System.out.println("来自客户端的消息:" + message);
54          
55         //群发消息
56         for(MyWebSocket item: webSocketSet){             
57             try {
58                 item.sendMessage(message);
59             } catch (IOException e) {
60                 e.printStackTrace();
61                 continue;
62             }
63         }
64     }
65      
66     /**
67      * 发生错误时调用
68      * @param session
69      * @param error
70      */
71     @OnError
72     public void onError(Session session, Throwable error){
73         System.out.println("发生错误");
74         error.printStackTrace();
75     }
76      
77     /**
78      * 这个方法与上面几个方法不一样。没有用注解,是根据自己需要添加的方法。
79      * @param message
80      * @throws IOException
81      */
82     public void sendMessage(String message) throws IOException{
83         this.session.getBasicRemote().sendText(message);
84         //this.session.getAsyncRemote().sendText(message);
85     }
86  
87     public static synchronized int getOnlineCount() {
88         return onlineCount;
89     }
90  
91     public static synchronized void addOnlineCount() {
92         MyWebSocket.onlineCount++;
93     }
94      
95     public static synchronized void subOnlineCount() {
96         MyWebSocket.onlineCount--;
97     }
98 }
技术分享图片

技术分享图片该Demo在以下环境测试过:

1.Jdk7+Tomcat7.0.47

2.Jdk7+Tomcat7.0.52

3.Jdk7+Tomcat8.0.3

4.Jdk7+Glassfish4

 

注意事项:在Eclipse或者MyEclipse中,需要添加Tomcat的library。直接拷贝Tomcat里lib目录下的jar包有时会出错。

文章转载于: http://blog.chenzuhuang.com/archive/28.html

以上是关于Java后端WebSocket的Tomcat实现的主要内容,如果未能解决你的问题,请参考以下文章

Java后端WebSocket的Tomcat实现

WebSocket学习记录

java后端+前端使用WebSocket实现消息推送

nginx做前端反代负载均衡,后端httpd+tomcat

通过 Tomcat servlet 代理常规 HTTP 和 WebSocket

保姆级 tomcat 快速入门