1. Python技术站首页
  2. 其他
  3. Java

Java后端Tomcat实现WebSocket实例教程

• Java

Java后端Tomcat实现WebSocket实例教程

WebSocket简介

WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket允许服务器端和客户端之间的数据实时交换。它被设计成一种通用的解决方案，可以执行不需要长时间等待的双向数据传输。

实现步骤

步骤1：创建WebSocket处理类

创建一个实现javax.websocket.Endpoint接口的WebSocket处理类。Endpoint是WebSocket API的核心接口，它只有两个方法：

public interface Endpoint {
    public void onOpen(Session session, EndpointConfig endpointConfig);
    public void onClose(Session session, CloseReason closeReason);
}

onOpen方法在WebSocket连接建立成功时调用，onClose方法在WebSocket连接关闭时调用。

实现WebSocket处理类的代码如下：

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import javax.websocket.CloseReason;
import javax.websocket.Endpoint;
import javax.websocket.EndpointConfig;
import javax.websocket.MessageHandler;
import javax.websocket.Session;

public class MyEndpoint extends Endpoint {
    private Session session;
    private Map<String, MessageHandler.Whole<String>> handlers = new HashMap<>();

    @Override
    public void onOpen(Session session, EndpointConfig config) {
        this.session = session;
        session.addMessageHandler(new MessageHandler.Whole<String>() {
            @Override
            public void onMessage(String message) {
                System.out.println("Received message: " + message);
                MessageHandler.Whole<String> handler = handlers.get(message);
                if (handler != null) {
                    handler.onMessage(message);
                }
            }
        });
    }

    @Override
    public void onClose(Session session, CloseReason reason) {
        System.out.println("Closing WebSocket connection...");
    }

    public void sendMessage(String message) throws IOException {
        session.getBasicRemote().sendText(message);
    }

    public void addMessageHandler(String type, MessageHandler.Whole<String> handler) {
        handlers.put(type, handler);
    }

    public void removeMessageHandler(String type) {
        handlers.remove(type);
    }
}

步骤2：配置WebSocket容器

创建一个WebSocket容器，用于处理来自客户端的连接请求。目前支持WebSocket的容器有很多，比如Tomcat、Jetty、Undertow等。以下是在Tomcat中配置WebSocket容器的示例代码：

import org.apache.catalina.Context;
import org.apache.catalina.startup.Tomcat;
import org.apache.tomcat.websocket.server.WsContextListener;
import org.apache.tomcat.websocket.server.WsSci;

public class MyWebSocketContainer {
    public static void main(String[] args) throws Exception {
        Tomcat tomcat = new Tomcat();
        tomcat.setPort(8080);

        Context context = tomcat.addContext("/", null);
        context.addApplicationListener(WsContextListener.class.getName());
        context.addServletContainerInitializer(new WsSci(), null);
        tomcat.start();
        tomcat.getServer().await();
    }
}

这个示例代码中，我们创建了一个Tomcat实例，设置端口号为8080，并创建一个根路径为/的上下文。我们通过addApplicationListener和addServletContainerInitializer方法来启用Tomcat的WebSocket支持。

步骤3：创建WebSocket连接

在客户端创建WebSocket连接时，需要使用WebSocket的API来执行连接。以下是在JavaScript中创建WebSocket连接的示例代码：

var webSocket = new WebSocket("ws://localhost:8080/mywebsocket");

webSocket.onopen = function(event) {
    console.log("WebSocket connected");
    webSocket.send("hello server");
};

webSocket.onmessage = function(event) {
    console.log("Received message: " + event.data);
};

webSocket.onclose = function(event) {
    console.log("WebSocket disconnected");
};

在这个示例代码中，我们创建了一个WebSocket实例，并指定请求连接的URL为ws://localhost:8080/mywebsocket，该路径/mywebsocket指的是我们在后面程序代码中要创建的WebSocket处理类的路径。当WebSocket连接成功建立时，我们会收到一个onopen事件，当WebSocket接收到消息时，我们会收到一个onmessage事件。当WebSocket连接关闭时，我们会收到一个onclose事件。

步骤4：接收WebSocket消息

现在我们已经在客户端成功创建了WebSocket连接，接下来我们在服务端来接收WebSocket发送的消息。在MyEndpoint类中，我们已经实现了一个MessageHandler，它可以处理来自客户端的消息。

session.addMessageHandler(new MessageHandler.Whole<String>() {
    @Override
    public void onMessage(String message) {
        System.out.println("Received message: " + message);
        MessageHandler.Whole<String> handler = handlers.get(message);
        if (handler != null) {
            handler.onMessage(message);
        }
    }
});

在接收到消息后，我们通过handlers取出相应的MessageHandler对象，并调用它的onMessage方法来处理消息。

步骤5：发送WebSocket消息

在MyEndpoint类中，我们定义了一个sendMessage方法，用于向客户端发送消息：

public void sendMessage(String message) throws IOException {
    session.getBasicRemote().sendText(message);
}

在客户端中，我们可以通过WebSocket的send方法来发送消息：

webSocket.send("hello server");

这个示例代码中，我们向服务器发送了一条消息“hello server”。

实例演示

下面是一个简单的实例演示，客户端向服务端发送一条消息，服务端返回一条消息。请按照以下步骤操作：

步骤1：创建MyEndpoint类

import java.io.IOException;

import javax.websocket.Endpoint;
import javax.websocket.EndpointConfig;
import javax.websocket.MessageHandler;
import javax.websocket.Session;

public class MyEndpoint extends Endpoint {

    private Session session;

    @Override
    public void onOpen(Session session, EndpointConfig config) {
        System.out.println("WebSocket connection opened");
        this.session = session;
        session.addMessageHandler(new MessageHandler.Whole<String>() {
            @Override
            public void onMessage(String message) {
                System.out.println("Received message: " + message);
                try {
                    session.getBasicRemote().sendText("Hello client! You said: " + message);
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        });
    }

    @Override
    public void onClose(Session session, javax.websocket.CloseReason reason) {
        System.out.println("WebSocket connection closed");
    }
}

步骤2：创建WebSocket容器

import org.apache.catalina.Context;
import org.apache.catalina.startup.Tomcat;
import org.apache.tomcat.websocket.server.WsContextListener;
import org.apache.tomcat.websocket.server.WsSci;

public class MyWebSocketContainer {

    public static void main(String[] args) throws Exception {

        Tomcat tomcat = new Tomcat();
        tomcat.setPort(8080);

        Context context = tomcat.addContext("/", null);

        context.addApplicationListener(WsContextListener.class.getName());
        context.addServletContainerInitializer(new WsSci(), null);

        Tomcat.addServlet(context, "MyEndpointServlet", new MyEndpointServlet());
        context.addServletMappingDecoded("/myendpoint", "MyEndpointServlet");

        tomcat.start();
        tomcat.getServer().await();
    }
}

步骤3：创建WebServlet类

import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;

import org.apache.tomcat.websocket.server.Constants;
import org.apache.tomcat.websocket.server.WsServerContainer;

@WebServlet(urlPatterns = "/myendpoint")
public class MyEndpointServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;

    @Override
    public void init() {
        WsServerContainer container = (WsServerContainer) getServletContext().getAttribute(Constants.SERVER_CONTAINER_SERVLET_CONTEXT_ATTRIBUTE);
        try {
            container.addEndpoint(MyEndpoint.class);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

步骤4：创建index.html页面

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>WebSocket Test</title>
<script type="text/javascript">
    var webSocket;
    function connect() {
        var username = document.getElementById("username").value;
        webSocket = new WebSocket("ws://localhost:8080/myendpoint");
        webSocket.onopen = function(event) {
            console.log("WebSocket connected");
            webSocket.send(username);
        };
        webSocket.onmessage = function(event) {
            console.log("Received message: " + event.data);
            document.getElementById("output").innerHTML = event.data;
        };
        webSocket.onclose = function(event) {
            console.log("WebSocket disconnected");
        };
    }
    function disconnect() {
        if (webSocket !== undefined) {
            console.log("WebSocket disconnecting...");
            webSocket.close();
        }
    }
</script>
</head>
<body>
    <h1>WebSocket Test</h1>
    <form>
        <label for="username">Username:</label>
        <input type="text" id="username" name="username">
        <button type="button" onclick="connect()">Connect</button>
        <button type="button" onclick="disconnect()">Disconnect</button>
    </form>
    <div id="output"></div>
</body>
</html>

在这个示例代码中，我们定义了两个JavaScript函数connect和disconnect。当用户填写自己的用户名后，点击Connect按钮，connect函数会创建一个WebSocket连接，并向服务器发送用户名。当WebSocket接收到消息时，客户端会显示服务器返回的消息在页面上。

结论

本文详细讲解了如何在Java后端Tomcat中实现WebSocket，步骤包括创建WebSocket处理类、配置WebSocket容器、创建WebSocket连接、接收WebSocket消息和发送WebSocket消息。同时，我们还演示了一个简单的实例，客户端向服务端发送一条消息，服务端返回一条消息。至此，我们已经完成了Java后端Tomcat实现WebSocket的一个实例教程。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：Java后端Tomcat实现WebSocket实例教程 - Python技术站

赞 (0)
0 0 打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023年5月19日
下一篇 2023年5月19日

相关文章

  • Java Web实现文件下载和乱码处理方法

    针对Java Web实现文件下载和乱码处理的完整攻略，可以分为以下几个步骤： 第一步：设置response的headers response.setContentType("application/octet-stream"); // 告诉浏览器当前是二进制文件 response.setHeader("Content-Dispo…

    Java 2023年5月20日
    00

  • 详解Java 类的加载机制

    详解Java 类的加载机制 Java是一种面向对象的编程语言，其面向对象的本质体现在Java类的使用上。在Java中，类是一种由Java源码编写的框架，其封装了需要处理的数据以及需要执行的方法，是Java程序的基本模块。Java类的加载是指将类名转换成Java虚拟机中的一个对象的过程，它是Java中关键的组成部分之一。本篇文章将进行详细讲解Java类的加载机…

    Java 2023年6月15日
    00

  • struts2中类型转换实例代码

    Struts2中类型转换可以将String类型的参数转换为具体的对象类型，比如将字符串形式的日期转换为Date类型。下面是struts2中类型转换的实例代码： 1. 实现TypeConverter接口 public class DateConverter implements TypeConverter { @Override public Object c…

    Java 2023年5月20日
    00

  • Java自定义实现equals()方法过程解析

    Java自定义实现equals()方法过程解析 什么是equals()方法？ 在Java中，equals()方法是用于比较两个对象是否相等的方法。它是Object类中的方法，子类可以覆盖这个方法来实现自己的比较方式。一般来说，我们自定义的类需要重写equals方法，来比较类中的属性是否相等。 equals()方法的实现要点 在Java中重写equals方法时…

    Java 2023年5月18日
    00

  • JSP 开发之servlet中调用注入spring管理的dao

    下面是关于 JSP 开发中在 Servlet 中调用注入 Spring 管理的 DAO 的完整攻略： 1. Maven 依赖 首先，在 pom.xml 文件中添加以下依赖： <!– Spring Framework –> <dependency> <groupId>org.springframework</gro…

    Java 2023年6月16日
    00

  • 微信支付jsapi缺少参数 total_fee 错误分析与解决方法

    下面我就对“微信支付jsapi缺少参数 total_fee 错误分析与解决方法”这个问题进行详细讲解，包括错误原因分析和解决方法。 问题分析 首先，我们需要了解这个错误的含义。这个错误提示是指在调用微信支付 jsapi 时出现了缺少参数 total_fee 的情况。total_fee 参数指订单总金额，如果没有正确传递该参数，那么就会出现这个错误。 下面，我…

    Java 2023年5月23日
    00

  • JSP中九大内置对象和四种属性范围详解

    让我来详细讲解“JSP中九大内置对象和四种属性范围详解”的完整攻略。 一、JSP中九大内置对象 在JSP中，有九个内置对象可以被直接使用，它们分别是： request：代表客户端的请求对象，可以通过它获取请求的参数。 response：代表服务器对客户端的响应对象，可以通过它向客户端返回响应结果。 session：代表用户会话对象，可以通过它在不同的页面之间…

    Java 2023年6月15日
    00

  • JavaWeb之Ajax的基本使用与实战案例

    JavaWeb之Ajax的基本使用与实战案例 Ajax（Asynchronous JavaScript And XML）即异步JavaScript和XML技术，通过在后台与服务器交换数据并更新部分网页实现页面无刷新的异步更新。 Ajax的基本语法 使用Ajax时可以通过XMLHttpRequest对象与后台进行数据交互，其中涉及到的基本语法如下： // 创建…

    Java 2023年5月26日
    00
合作推广
合作推广
分享本页
返回顶部