WebSocket 示例

来源：互联网发布：软件外包项目管理制度编辑：程序博客网时间：2024/06/06 10:42

1. 介绍

websocket目前虽然无法普及应用，未来是什么样子，我们不得而知，但现在开始学习应用它，只有好处没有坏处，本随笔的WebSocket是版本13（RFC6455)协议的实现，也是目前websocket的最新协议，协议的英文文档可以查看http://tools.ietf.org/html/rfc6455

浏览器能够与服务器建立连接，通过已建立的通信信道来发送和接收数据而不需要由HTTP协议引入额外其他的开销来实现。

在本教程中我们将在Java EE环境下实现一个简单的websockect服务器端来和客户端进行数据交互。

本教程需要以下环境：

Ubuntu 12.04
JDK 1.7.0.21
Glassfish 4.0

注: Java EE 7中才引入了WebSocket。

2. WebSocket服务器端(以下代码已经验证，可以正常运行)

让我们定义一个 Java EE websocket服务器端：

WebSocketTest.java

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.byteslounge.websockets;
 
import java.io.IOException;
 
import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
 
@ServerEndpoint("/websocket")
public class WebSocketTest {
 
  @OnMessage
  publicvoid onMessage(String message, Session session)
    throwsIOException, InterruptedException {
   
    // Print the client message for testing purposes
    System.out.println("Received: "+ message);
   
    // Send the first message to the client
    session.getBasicRemote().sendText("This is the first server message");
   
    // Send 3 messages to the client every 5 seconds
    intsentMessages = 0;
    while(sentMessages <3){
      Thread.sleep(5000);
      session.getBasicRemote().
        sendText("This is an intermediate server message. Count: "
          + sentMessages);
      sentMessages++;
    }
   
    // Send a final message to the client
    session.getBasicRemote().sendText("This is the last server message");
  }
   
  @OnOpen
  publicvoid onOpen() {
    System.out.println("Client connected");
  }
 
  @OnClose
  publicvoid onClose() {
    System.out.println("Connection closed");
  }
}

你可能已经注意到我们从 javax.websocket包中引入了一些类。

@ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端。注解的值将被用于监听用户连接的终端访问URL地址。

onOpen 和 onClose 方法分别被@OnOpen和@OnClose 所注解。这两个注解的作用不言自明：他们定义了当一个新用户连接和断开的时候所调用的方法。

onMessage 方法被@OnMessage所注解。这个注解定义了当服务器接收到客户端发送的消息时所调用的方法。注意：这个方法可能包含一个javax.websocket.Session可选参数（在我们的例子里就是session参数）。如果有这个参数，容器将会把当前发送消息客户端的连接Session注入进去。

本例中我们仅仅是将客户端消息内容打印出来，然后首先我们将发送一条开始消息，之后间隔5秒向客户端发送1条测试消息，共发送3次，最后向客户端发送最后一条结束消息。

3. 客户端

现在我们要来写websocket测试应用的客户端：

page.html

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<!DOCTYPE html>
<html>
<head>
<title>Testing websockets</title>
</head>
<body>
  <div>
    <input type="submit"value="Start" onclick="start()" />
  </div>
  <div id="messages"></div>
  <script type="text/javascript">
    varwebSocket = 
      newWebSocket('ws://localhost:8080/byteslounge/websocket');
 
    webSocket.onerror =function(event) {
      onError(event)
    };
 
    webSocket.onopen =function(event) {
      onOpen(event)
    };
 
    webSocket.onmessage =function(event) {
      onMessage(event)
    };
 
    functiononMessage(event) {
      document.getElementById('messages').innerHTML
        +='<br />' + event.data;
    }
 
    functiononOpen(event) {
      document.getElementById('messages').innerHTML
        ='Connection established';
    }
 
    functiononError(event) {
      alert(event.data);
    }
 
    functionstart() {
      webSocket.send('hello');
      returnfalse;
    }
  </script>
</body>
</html>