原文： https://javatutorial.net/java-websockets-tutorial

在本教程中，我将向您展示如何制作一个在 Glassfish 4 上运行的简单聊天应用程序。我将使用两个 API 来实现此目的：Jetty 和 JSON API。

我们将首先从基于 Web 的客户端开始。 看下面的图片。 它的用户名有一个字段，您可以在其中输入聊天消息的一个字段，以及到目前为止保存对话的文本区域。

Glassfish 和 Jetty 的 Java WebSockets 教程 - 图1

网络客户端和 Javascript

我们可以在 JavaScript 中使用WebSocket在客户端和服务器之间创建全双工连接。 JavaScript Websocket具有 3 种方法

onopen – 在客户端和服务器创建连接时调用

onmessage – 服务器向客户端发送消息时执行此方法

onclose – 客户端和服务器之间的连接被破坏时调用此方法

用户单击“发送”按钮后，用户名和消息本身将转换为 JSON 格式并发送到服务器。

您将在下面找到客户端的完整代码：

  1. <?xml version='1.0' encoding='UTF-8' ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml"
  4.     xmlns:h="http://java.sun.com/jsf/html">
  6. <h:head>
  7.     <title>WebSockets Chat</title>
  8.     <meta name="author" content="javatutorial.net" />
  9.     <script type="text/javascript" charset="utf-8" src="js/jquery-1.3.2.js"></script>
  10.     <link type="text/css" rel="stylesheet" href="css/style.css" />
  11.     <script type="text/javascript">
  12.     var ws;
  14.     $(document).ready(
  15.             function() {
  16.                 ws = new WebSocket("ws://localhost:8080/chat");
  17.                 ws.onopen = function(event) {
  19.                 }
  20.                 ws.onmessage = function(event) {
  21.                     var $textarea = $('#messages');
  22.                     var json = JSON.parse(event.data);
  23.                     $textarea.val($textarea.val() + json.username + ": " + json.message + "\n");
  24.                     $textarea.animate({
  25.                         scrollTop : $textarea.height()
  26.                     }, 1000);
  27.                 }
  28.                 ws.onclose = function(event) {
  30.                 }
  32.             });
  34.     function sendMessage() {
  35.         var message = {
  36.                 "username": $('#username').val(),
  37.                 "message": $('#message').val() 
  38.             }
  39.         ws.send(JSON.stringify(message));
  40.         $('#message').val('');
  41.     }
  42.     </script>
  43. </h:head>
  44. <h:body>
  45.     <div id="body">
  46.         <div id="menu">
  47.             <p class="welcome">
  48.                 User: <input id="username" value="anonymous" />
  49.             </p>
  50.             <div style="clear: both"></div>
  51.         </div>
  53.         <div id="chatbox">
  54.             <textarea id="messages" rows="16" cols="50" readonly="readonly"></textarea>
  55.         </div>
  57.         <form name="message" action="">
  58.             <input name="usermsg" type="text" id="message" size="63" /> <input
  59.                 type="button" name="submitmsg" value="Send..."
  60.                 onclick="sendMessage();" />
  61.         </form>
  62.     </div>
  63. </h:body>
  64. </html>

实现 Websocket 服务器

我将使用 Glassfish 4.1 部署 WebSocket 服务器。 我们将使用 Jetty 9.x 作为 Websocket 服务器，而 Glassfish 已在 Jetty 中内置。 我们将使用的另一个 API 是 JSON API，它也是 Glassfish 4 的一部分。请查看下面的 Maven pom 文件以获取所需的依赖关系

  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>net.javatutorial</groupId>
  6.     <artifactId>ChatServer</artifactId>
  7.     <version>0.0.1</version>
  8.     <packaging>war</packaging>
  10.     <name>ChatServer</name>
  11.     <url>http://javatutorial.net</url>
  13.     <properties>
  14.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  15.     </properties>
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>javax</groupId>
  20.             <artifactId>javaee-api</artifactId>
  21.             <version>6.0</version>
  22.             <scope>provided</scope>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.eclipse.jetty</groupId>
  26.             <artifactId>jetty-server</artifactId>
  27.             <version>9.2.7.v20150116</version>
  28.             <scope>provided</scope>
  29.         </dependency>
  30.         <dependency>
  31.             <groupId>org.eclipse.jetty.websocket</groupId>
  32.             <artifactId>javax-websocket-server-impl</artifactId>
  33.             <version>9.2.7.v20150116</version>
  34.             <scope>provided</scope>
  35.         </dependency>
  36.         <dependency>
  37.             <groupId>org.eclipse.jetty</groupId>
  38.             <artifactId>jetty-annotations</artifactId>
  39.             <version>9.2.7.v20150116</version>
  40.             <scope>provided</scope>
  41.         </dependency>
  42.         <dependency>
  43.             <groupId>org.eclipse.jetty</groupId>
  44.             <artifactId>jetty-webapp</artifactId>
  45.             <version>9.2.7.v20150116</version>
  46.             <scope>provided</scope>
  47.         </dependency>
  48.         <dependency>
  49.             <groupId>javax.json</groupId>
  50.             <artifactId>javax.json-api</artifactId>
  51.             <version>1.0</version>
  52.             <scope>provided</scope>
  53.         </dependency>
  54.     </dependencies>
  55.     <build>
  56.         <plugins>
  57.             <plugin>
  58.                 <groupId>org.apache.maven.plugins</groupId>
  59.                 <artifactId>maven-compiler-plugin</artifactId>
  60.                 <version>3.1</version>
  61.                 <inherited>true</inherited>
  62.                 <configuration>
  63.                     <source>1.6</source>
  64.                     <target>1.6</target>
  65.                 </configuration>
  66.             </plugin>
  67.             <plugin>
  68.                 <artifactId>maven-war-plugin</artifactId>
  69.                 <version>2.3</version>
  70.                 <configuration>
  71.                     <webXml>src/main/webapp/WEB-INF/web.xml</webXml>
  72.                 </configuration>
  73.             </plugin>
  74.         </plugins>
  75.     </build>
  76. </project>

ChatMessage对象保存用户名和消息字符串，以提供Decoder和Encoder将结构转换为 JSON 格式。

  1. package net.javatutorial.chatserver.pojos;
  3. import java.io.StringReader;
  4. import java.util.Collections;
  6. import javax.json.Json;
  7. import javax.json.JsonObject;
  8. import javax.json.JsonReader;
  9. import javax.json.JsonReaderFactory;
  10. import javax.websocket.DecodeException;
  11. import javax.websocket.Decoder;
  12. import javax.websocket.EncodeException;
  13. import javax.websocket.Encoder;
  14. import javax.websocket.EndpointConfig;
  16. public class ChatMessage {
  18.     public static class MessageEncoder implements Encoder.Text<ChatMessage> {
  19.         @Override
  20.         public void init(EndpointConfig config) {
  21.         }
  23.         @Override
  24.         public String encode(ChatMessage message) throws EncodeException {
  25.             return Json.createObjectBuilder()
  26.                     .add("username", message.getUsername())
  27.                     .add("message", message.getMessage()).build().toString();
  28.         }
  30.         @Override
  31.         public void destroy() {
  32.         }
  33.     }
  35.     public static class MessageDecoder implements Decoder.Text<ChatMessage> {
  36.         private JsonReaderFactory factory = Json
  37.                 .createReaderFactory(Collections.<String, Object> emptyMap());
  39.         @Override
  40.         public void init(EndpointConfig config) {
  41.         }
  43.         @Override
  44.         public ChatMessage decode(String str) throws DecodeException {
  45.             ChatMessage message = new ChatMessage();
  47.             JsonReader reader = factory.createReader(new StringReader(str));
  48.             JsonObject json = reader.readObject();
  49.             message.setUsername(json.getString("username"));
  50.             message.setMessage(json.getString("message"));
  52.             return message;
  53.         }
  55.         @Override
  56.         public boolean willDecode(String str) {
  57.             return true;
  58.         }
  60.         @Override
  61.         public void destroy() {
  62.         }
  63.     }
  65.     private String username;
  66.     private String message;
  68.     public ChatMessage() {
  69.     }
  71.     public ChatMessage(String username, String message) {
  72.         super();
  73.         this.username = username;
  74.         this.message = message;
  75.     }
  77.     public String getUsername() {
  78.         return username;
  79.     }
  81.     public void setUsername(String username) {
  82.         this.username = username;
  83.     }
  85.     public String getMessage() {
  86.         return message;
  87.     }
  89.     public void setMessage(String message) {
  90.         this.message = message;
  91.     }
  93. }

最后，我们将需要 Websocket 服务器端点。

  1. package net.javatutorial.chatserver.sockets;
  3. import java.io.IOException;
  4. import java.util.Collections;
  5. import java.util.HashSet;
  6. import java.util.Set;
  8. import javax.websocket.EncodeException;
  9. import javax.websocket.OnClose;
  10. import javax.websocket.OnMessage;
  11. import javax.websocket.OnOpen;
  12. import javax.websocket.Session;
  13. import javax.websocket.server.ServerEndpoint;
  15. import net.javatutorial.chatserver.pojos.ChatMessage;
  16. import net.javatutorial.chatserver.pojos.ChatMessage.MessageDecoder;
  17. import net.javatutorial.chatserver.pojos.ChatMessage.MessageEncoder;
  19. @ServerEndpoint(value = "/chat", encoders = { MessageEncoder.class }, decoders = { MessageDecoder.class })
  20. public class ChatServerEndpoint {
  21.     private static final Set<Session> sessions = Collections
  22.             .synchronizedSet(new HashSet<Session>());
  24.     @OnOpen
  25.     public void onOpen(Session session) {
  26.         sessions.add(session);
  27.     }
  29.     @OnClose
  30.     public void onClose(Session session) {
  31.         sessions.remove(session);
  32.     }
  34.     @OnMessage
  35.     public void onMessage(ChatMessage message, Session client)
  36.             throws IOException, EncodeException {
  37.         for (Session session : sessions) {
  38.             session.getBasicRemote().sendObject(message);
  39.         }
  40.     }
  41. }

您可以在此处下载完整的源代码和 Eclipse 项目。