JSR356标准Java WebSocket实例,包含JAVA客户端与浏览器js客户端

Java Websocket实例

• 博客分类： 
• java
• websocket

java websocket html5 

记录下自己在用的websocket

 

介绍

现很多网站为了实现即时通讯，所用的技术都是轮询(polling)。轮询是在特定的的时间间隔（如每1秒），由浏览器对服务器发出HTTP request，然后由服务器返回最新的数据给客服端的浏览器。这种传统的HTTP request 的模式带来很明显的缺点 – 浏览器需要不断的向服务器发出请求，然而HTTP request 的header是非常长的，里面包含的数据可能只是一个很小的值，这样会占用很多的带宽。

而最比较新的技术去做轮询的效果是Comet – 用了AJAX。但这种技术虽然可达到全双工通信，但依然需要发出请求。

在 WebSocket API，浏览器和服务器只需要要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。

 

运行环境：

实现了websocket的浏览器：

Chrome	Supported in version 4+
Firefox	Supported in version 4+
Internet Explorer	Supported in version 10+
Opera	Supported in version 10+
Safari	Supported in version 5+

 

依赖：

 

Tomcat 7 或者 J2EE7

 

Java代码  

1. <dependency>  
2.     <groupId>org.apache.tomcat</groupId>  
3.     <artifactId>tomcat-websocket-api</artifactId>  
4.     <version>7.0.47</version>  
5.     <scope>provided</scope>  
6. </dependency>  
7.   
8.   
9. <dependency>  
10.     <groupId>javax</groupId>  
11.     <artifactId>javaee-api</artifactId>  
12.     <version>7.0</version>  
13.     <scope>provided</scope>  
14. </dependency>  

 

 

 

注意：早前业界没有统一的标准，各服务器都有各自的实现，现在J2EE7的JSR356已经定义了统一的标准，请尽量使用支持最新通用标准的服务器。

详见：http://www.oracle.com/technetwork/articles/java/jsr356-1937161.html

           http://jinnianshilongnian.iteye.com/blog/1909962

 

我是用的Tomcat 7.0.57 + Java7

必须是Tomcat 7.0.47以上

详见：http://www.iteye.com/news/28414

 

ps：最早我们是用的Tomcat 7自带的实现，后来要升级Tomcat 8，结果原来的实现方式在Tomcat 8不支持了，就只好切换到支持Websocket 1.0版本的Tomcat了。

 

主流的java web服务器都有支持JSR365标准的版本了，请自行Google。 

 

用nginx做反向代理的需要注意啦，socket请求需要做特殊配置的，切记！

 

Tomcat的处理方式建议修改为NIO的方式，同时修改连接数到合适的参数，请自行Google！

 

服务端

服务端不需要在web.xml中做额外的配置，Tomcat启动后就可以直接连接了。

 

Java代码  

1. import com.dooioo.websocket.utils.SessionUtils;  
2. import org.apache.commons.logging.Log;  
3. import org.apache.commons.logging.LogFactory;  
4.   
5. import javax.websocket.*;  
6. import javax.websocket.server.PathParam;  
7. import javax.websocket.server.ServerEndpoint;  
8.   
9. /** 
10.  * 功能说明：websocket处理类, 使用J2EE7的标准 
11.  *         切忌直接在该连接处理类中加入业务处理代码 
12.  * 作者：liuxing(2014-11-14 04:20) 
13.  */  
14. //relationId和userCode是我的业务标识参数,websocket.ws是连接的路径，可以自行定义  
15. @ServerEndpoint("/websocket.ws/{relationId}/{userCode}")  
16. public class WebsocketEndPoint {  
17.   
18.     private static Log log = LogFactory.getLog(WebsocketEndPoint.class);  
19.   
20.     /** 
21.      * 打开连接时触发 
22.      * @param relationId 
23.      * @param userCode 
24.      * @param session 
25.      */  
26.     @OnOpen  
27.     public void onOpen(@PathParam("relationId") String relationId,  
28.                        @PathParam("userCode") int userCode,  
29.                        Session session){  
30.         log.info("Websocket Start Connecting: " + SessionUtils.getKey(relationId, userCode));  
31.         SessionUtils.put(relationId, userCode, session);  
32.     }  
33.   
34.     /** 
35.      * 收到客户端消息时触发 
36.      * @param relationId 
37.      * @param userCode 
38.      * @param message 
39.      * @return 
40.      */  
41.     @OnMessage  
42.     public String onMessage(@PathParam("relationId") String relationId,  
43.                             @PathParam("userCode") int userCode,  
44.                             String message) {  
45.         return "Got your message (" + message + ").Thanks !";  
46.     }  
47.   
48.     /** 
49.      * 异常时触发 
50.      * @param relationId 
51.      * @param userCode 
52.      * @param session 
53.      */  
54.     @OnError  
55.     public void onError(@PathParam("relationId") String relationId,  
56.                         @PathParam("userCode") int userCode,  
57.                         Throwable throwable,  
58.                         Session session) {  
59.         log.info("Websocket Connection Exception: " + SessionUtils.getKey(relationId, userCode));  
60.         log.info(throwable.getMessage(), throwable);  
61.         SessionUtils.remove(relationId, userCode);  
62.     }  
63.   
64.     /** 
65.      * 关闭连接时触发 
66.      * @param relationId 
67.      * @param userCode 
68.      * @param session 
69.      */  
70.     @OnClose  
71.     public void onClose(@PathParam("relationId") String relationId,  
72.                         @PathParam("userCode") int userCode,  
73.                         Session session) {  
74.         log.info("Websocket Close Connection: " + SessionUtils.getKey(relationId, userCode));  
75.         SessionUtils.remove(relationId, userCode);  
76.     }  
77.   
78. }  

  

 

工具类用来存储唯一key和连接

这个是我业务的需要，我的业务是服务器有对应动作触发时，推送数据到客户端，没有接收客户端数据的操作。

 

Java代码  

1. import javax.websocket.Session;  
2. import java.util.Map;  
3. import java.util.concurrent.ConcurrentHashMap;  
4.   
5. /** 
6.  * 功能说明：用来存储业务定义的sessionId和连接的对应关系 
7.  *          利用业务逻辑中组装的sessionId获取有效连接后进行后续操作 
8.  * 作者：liuxing(2014-12-26 02:32) 
9.  */  
10. public class SessionUtils {  
11.   
12.     public static Map<String, Session> clients = new ConcurrentHashMap<>();  
13.   
14.     public static void put(String relationId, int userCode, Session session){  
15.         clients.put(getKey(relationId, userCode), session);  
16.     }  
17.   
18.     public static Session get(String relationId, int userCode){  
19.         return clients.get(getKey(relationId, userCode));  
20.     }  
21.   
22.     public static void remove(String relationId, int userCode){  
23.         clients.remove(getKey(relationId, userCode));  
24.     }  
25.   
26.     /** 
27.      * 判断是否有连接 
28.      * @param relationId 
29.      * @param userCode 
30.      * @return 
31.      */  
32.     public static boolean hasConnection(String relationId, int userCode) {  
33.         return clients.containsKey(getKey(relationId, userCode));  
34.     }  
35.   
36.     /** 
37.      * 组装唯一识别的key 
38.      * @param relationId 
39.      * @param userCode 
40.      * @return 
41.      */  
42.     public static String getKey(String relationId, int userCode) {  
43.         return relationId + "_" + userCode;  
44.     }  
45.   
46. }  

 

 

推送数据到客户端

 

在其他业务方法中调用

 

Java代码  

1. /** 
2.  * 将数据传回客户端 
3.  * 异步的方式 
4.  * @param relationId 
5.  * @param userCode 
6.  * @param message 
7.  */  
8. public void broadcast(String relationId, int userCode, String message) {  
9.     if (TelSocketSessionUtils.hasConnection(relationId, userCode)) {  
10.         TelSocketSessionUtils.get(relationId, userCode).getAsyncRemote().sendText(message);  
11.     } else {  
12.         throw new NullPointerException(TelSocketSessionUtils.getKey(relationId, userCode) + " Connection does not exist");  
13.     }  
14.   
15. }  

 

我是使用异步的方法推送数据，还有同步的方法

详见：http://docs.oracle.com/javaee/7/api/javax/websocket/Session.html

 

客户端

Js代码  

1. var webSocket = null;  
2. var tryTime = 0;  
3. $(function () {  
4.     initSocket();  
5.   
6.     window.onbeforeunload = function () {  
7.         //离开页面时的其他操作  
8.     };  
9. });  
10.   
11. /** 
12.  * 初始化websocket，建立连接 
13.  */  
14. function initSocket() {  
15.     if (!window.WebSocket) {  
16.         alert("您的浏览器不支持websocket！");  
17.         return false;  
18.     }  
19.   
20.     webSocket = new WebSocket("ws://127.0.0.1:8080/websocket.ws/" + relationId + "/" + userCode);  
21.       
22.     // 收到服务端消息  
23.     webSocket.onmessage = function (msg) {  
24.         console.log(msg);  
25.     };  
26.       
27.     // 异常  
28.     webSocket.onerror = function (event) {  
29.         console.log(event);  
30.     };  
31.       
32.     // 建立连接  
33.     webSocket.onopen = function (event) {  
34.         console.log(event);  
35.     };  
36.   
37.     // 断线重连  
38.     webSocket.onclose = function () {  
39.         // 重试10次，每次之间间隔10秒  
40.         if (tryTime < 10) {  
41.             setTimeout(function () {  
42.                 webSocket = null;  
43.                 tryTime++;  
44.                 initSocket();  
45.             }, 500);  
46.         } else {  
47.             tryTime = 0;  
48.         }  
49.     };  
50.   
51. }  

 

其他调试工具

Java实现一个websocket的客户端

 

Java代码  

1. <dependency>  
2.             <groupId>org.java-websocket</groupId>  
3.             <artifactId>Java-WebSocket</artifactId>  
4.             <version>1.3.0</version>  
5.         </dependency>  

 

Java代码  

1. import java.io.IOException;    
2.     import javax.websocket.ClientEndpoint;    
3.     import javax.websocket.OnError;    
4.     import javax.websocket.OnMessage;    
5.     import javax.websocket.OnOpen;    
6.     import javax.websocket.Session;    
7.          
8.     @ClientEndpoint    
9.     public class MyClient {    
10.         @OnOpen    
11.         public void onOpen(Session session) {    
12.             System.out.println("Connected to endpoint: " + session.getBasicRemote());    
13.             try {    
14.                 session.getBasicRemote().sendText("Hello");    
15.             } catch (IOException ex) {    
16.             }    
17.         }    
18.          
19.         @OnMessage    
20.         public void onMessage(String message) {    
21.             System.out.println(message);    
22.         }    
23.          
24.         @OnError    
25.         public void onError(Throwable t) {    
26.             t.printStackTrace();    
27.         }    
28.     }    

 

Java代码  

1. import java.io.BufferedReader;    
2.     import java.io.IOException;    
3.     import java.io.InputStreamReader;    
4.     import java.net.URI;    
5.     import javax.websocket.ContainerProvider;    
6.     import javax.websocket.DeploymentException;    
7.     import javax.websocket.Session;    
8.     import javax.websocket.WebSocketContainer;    
9.          
10.     public class MyClientApp {    
11.          
12.         public Session session;    
13.          
14.         protected void start()    
15.                  {    
16.          
17.                 WebSocketContainer container = ContainerProvider.getWebSocketContainer();    
18.          
19.                 String uri = "ws://127.0.0.1:8080/websocket.ws/relationId/12345";    
20.                 System.out.println("Connecting to " + uri);    
21.                 try {    
22.                     session = container.connectToServer(MyClient.class, URI.create(uri));    
23.                 } catch (DeploymentException e) {    
24.                     e.printStackTrace();    
25.                 } catch (IOException e) {    
26.                     e.printStackTrace();    
27.                 }                 
28.          
29.         }    
30.         public static void main(String args[]){    
31.             MyClientApp client = new MyClientApp();    
32.             client.start();    
33.          
34.             BufferedReader br = new BufferedReader(new InputStreamReader(System.in));    
35.             String input = "";    
36.             try {    
37.                 do{    
38.                     input = br.readLine();    
39.                     if(!input.equals("exit"))    
40.                         client.session.getBasicRemote().sendText(input);    
41.          
42.                 }while(!input.equals("exit"));    
43.          
44.             } catch (IOException e) {    
45.                 // TODO Auto-generated catch block    
46.                 e.printStackTrace();    
47.             }    
48.         }    
49.     }    

 

 

Chrome安装一个websocket模拟客户端

 

 

 

最后

为了统一的操作体验，对于一些不支持websocket的浏览器，请使用socketjs技术做客户端开发。

 

 

欢迎交流、拍砖！

• 查看图片附件

分享到：   

使用flyway对应用的数据库版本控制 |  在windows和linux上安装ImageMagick与Jm ...

• 2015-01-09 23:57
• 浏览 5970
• 评论(1)
• 分类:编程语言
• 查看更多

相关资源推荐

• unix系列系统镜像下载
• Unix操作系统设计（中文版）
• SUN的UNIX操作系统
• UNIX操作系统设计
• 封装了DAO对象用于直接操纵access数据库 
• WebDriver的Firefox-0.19.0驱动器
• 谈谈网络编程（基于C++）
• C/C++ socket网络编程扫盲篇
• C++基于TCP/IP简单的客户端、服务器通信程序实例
• linux下C/C++网络编程基本：socket实现tcp和udp的例子
• C++网络编程
• C/C++网络编程总结与ZeroMQ
• C++之网络编程
• c++教程(C++教程 网络编程socket)
• C++网络编程方面的开源项目
• 《C++网络编程》
• C++ 网络编程.pdf
• C++ P2P网络编程
• C++网络编程 卷1和卷2 中文 高清.pdf版
• C/C++实现基于UDP的网络编程

参考知识库

Java SE知识库 29501  关注 | 578  收录

Java 知识库 37503  关注 | 3748  收录

Java EE知识库 24050  关注 | 1417  收录

JavaScript知识库 17620  关注 | 1517  收录

jQuery知识库 10798  关注 | 948  收录

AngularJS知识库 5586  关注 | 590  收录

评论

1 楼  wahahachuang5 2017-09-13  

web实时推送技术使用越来越广泛，但是自己开发又太麻烦了，我觉得没有那个必要，GoEasy就挺不错的，服务器稳定，代码简洁易懂；官网: http://goeasy.io/