Spring Boot 中的 SockJS

这篇具有很好参考价值的文章主要介绍了Spring Boot 中的 SockJS。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

Spring Boot 中的 SockJS

在 Spring Boot 中,SockJS 是一个用于实现 WebSocket 的兼容性解决方案。本文将介绍 SockJS 的原理、使用方法和示例代码。

Spring Boot 中的 SockJS,Java 教程,spring boot,后端,java

什么是 SockJS

SockJS 是一种浏览器与服务器之间的通信协议,它可以在浏览器和服务器之间建立一个基于 HTTP 的双向通信通道。SockJS 的主要作用是提供一种 WebSocket 的兼容性解决方案,使得不支持 WebSocket 的浏览器也可以使用 WebSocket。

SockJS 实现了一个 WebSocket 的兼容层,它可以在浏览器和服务器之间建立一个基于 HTTP 的通信通道,然后通过这个通道进行双向通信。当浏览器不支持 WebSocket 时,SockJS 会自动切换到使用轮询(polling)或长轮询(long-polling)的方式进行通信。

SockJS 的原理

SockJS 的原理是通过建立一个基于 HTTP 的通信通道来实现 WebSocket 的双向通信。当浏览器支持 WebSocket 时,SockJS 会直接使用 WebSocket 进行通信;当浏览器不支持 WebSocket 时,SockJS 会自动切换到使用轮询(polling)或长轮询(long-polling)的方式进行通信。

在使用 SockJS 时,首先需要在客户端和服务器端分别引入 sockjs-client.jssockjs-server,然后在客户端通过 new SockJS(url) 的方式建立一个 SockJS 连接。

客户端和服务器端之间的通信是基于事件的,当客户端发送消息时,服务器端会触发一个 onmessage 事件,然后将消息发送回客户端。客户端在接收到消息后,会触发一个 onmessage 事件,然后处理收到的消息。

如何使用 SockJS

使用 SockJS 非常简单,在 Spring Boot 中,只需要在配置文件中添加以下内容即可:

spring:
  websocket:
    enabled: true
    broker:
      relay-host: localhost
      relay-port: 61613
      user: guest
      password: guest
      relay-path: /stomp

以上配置表示启用 WebSocket,并将消息发送到 localhost61613 端口,使用 guest/guest 的用户名和密码进行认证,使用 /stomp 路径进行消息传输。

接下来,我们需要在客户端中建立一个 SockJS 连接,并实现 onmessage 事件的回调方法。代码如下:

var socket = new SockJS('/gs-guide-websocket');
stompClient = Stomp.over(socket);
stompClient.connect({}, function(frame) {
    stompClient.subscribe('/topic/greetings', function(greeting){
        showGreeting(JSON.parse(greeting.body).content);
    });
});

以上代码中,new SockJS('/gs-guide-websocket') 表示使用 /gs-guide-websocket 路径建立一个 SockJS 连接。stompClient.connect({}, function(frame){...}) 表示连接成功后执行的回调方法,stompClient.subscribe('/topic/greetings', function(greeting){...}) 表示订阅 /topic/greetings 目的地,当有消息发布到该目的地时触发回调方法。

最后,我们需要在服务器端实现消息发送和接收的功能。代码如下:

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {

    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry) {
        registry.enableStompBrokerRelay("/topic")
            .setRelayHost("localhost")
            .setRelayPort(61613)
            .setClientLogin("guest")
            .setClientPasscode("guest")
            .setSystemHeartbeatSendInterval(5000)
            .setSystemHeartbeatReceiveInterval(4000);
        registry.setApplicationDestinationPrefixes("/app");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/gs-guide-websocket").withSockJS();
    }
}

以上代码中,@EnableWebSocketMessageBroker 注解表示启用 WebSocket 消息代理,configureMessageBroker 方法用于配置消息代理,registerStompEndpoints 方法用于注册 SockJS 端点。

接下来,我们需要在控制器中实现消息发送和接收的功能。代码如下:

@Controller
public class GreetingController {

    @MessageMapping("/hello")
    @SendTo("/topic/greetings")
    public Greeting greeting(HelloMessage message) throws Exception {
        Thread.sleep(1000); // simulated delay
        return new Greeting("Hello, " + HtmlUtils.htmlEscape(message.getName()) + "!");
    }

}

以上代码中,@MessageMapping("/hello") 注解表示处理 /hello 目的地的消息,@SendTo("/topic/greetings") 注解表示将处理结果发送到 /topic/greetings 目的地。greeting 方法实现了消息的处理逻辑。

示例代码

以下是一个完整的示例代码,包括客户端和服务器端的代码:

客户端代码

<!DOCTYPE html>
<html>
<head>
    <title>Hello WebSocket</title>
    <script src="/webjars/sockjs-client/1.1.2/dist/sockjs.min.js"></script>
    <script src="/webjars/stomp-websocket/2.3.3/dist/stomp.min.js"></script>
    <script src="/js/app.js"></script>
</head>
<body>
    <div>
        <label>What is your name?</label>
        <input type="text" id="name" />
        <button type="button" onclick="send()">Send</button>
    </div>
    <div id="greetings">
    </div>
</body>
</html>
var socket = new SockJS('/gs-guide-websocket');
stompClient = Stomp.over(socket);
stompClient.connect({}, function(frame) {
    stompClient.subscribe('/topic/greetings', function(greeting){
        showGreeting(JSON.parse(greeting.body).content);
    });
});

function send() {
    var name = document.getElementById('name').value;
    stompClient.send("/app/hello", {}, JSON.stringify({ 'name': name }));
}

function showGreeting(message) {
    var div = document.createElement('div');
    div.appendChild(document.createTextNode(message));
    document.getElementById('greetings').appendChild(div);
}

服务器端代码

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {

    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry) {
        registry.enableStompBrokerRelay("/topic")
            .setRelayHost("localhost")
            .setRelayPort(61613)
            .setClientLogin("guest")
            .setClientPasscode("guest")
            .setSystemHeartbeatSendInterval(5000)
            .setSystemHeartbeatReceiveInterval(4000);
        registry.setApplicationDestinationPrefixes("/app");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/gs-guide-websocket").withSockJS();
    }
}

@Controller
public class GreetingController {

    @MessageMapping("/hello")
    @SendTo("/topic/greetings")
    public Greeting greeting(HelloMessage message) throws Exception {
        Thread.sleep(1000); // simulated delay
        return new Greeting("Hello, " + HtmlUtils.htmlEscape(message.getName()) + "!");
    }

}

public class HelloMessage {

    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

public class Greeting {

    private String content;

    public Greeting(String content) {
        this.content = content;
    }

    public String getContent() {
        return content;
    }

}

以上代码实现了一个简单的聊天室,用户在输入框中输入自己的名字,然后点击发送按钮,将消息发送到服务器端,服务器端将收到的消息处理后发送回客户端,客户端显示收到的消息。当多个用户同时使用该聊天室时,每个用户都可以看到其他用户发送的消息。

总结

本文介绍了 Spring Boot 中的 SockJS,包括 SockJS 的原理、文章来源地址https://www.toymoban.com/news/detail-518311.html

到了这里,关于Spring Boot 中的 SockJS的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • HttpServiceProxyFactory 在 Spring Boot 3 中的应用:Spring Boot 3 使用 HttpServiceProxyFactory 调用远程接口

    博主猫头虎的技术世界 🌟 欢迎来到猫头虎的博客 — 探索技术的无限可能! 专栏链接 : 🔗 精选专栏 : 《面试题大全》 — 面试准备的宝典! 《IDEA开发秘籍》 — 提升你的IDEA技能! 《100天精通Golang》 — Go语言学习之旅! 领域矩阵 : 🌐 猫头虎技术领域矩阵 : 深入探索

    2024年02月02日
    浏览(58)
  • Spring Boot进阶(97):从入门到精通:Spring Boot整合Kubernetes详细教程

      随着云计算和容器化技术的发展,Kubernetes已经成为了当今最为流行的容器编排平台之一。而Spring Boot则是Java领域中最为流行的Web应用开发框架之一。将两者结合起来,可以帮助开发者更加高效地构建、部署和管理基于Spring Boot的应用程序。   本文将介绍如何在Spring B

    2024年02月06日
    浏览(52)
  • Spring Boot 中的 @EnableDiscoveryClient 注解

    Spring Boot 是一个快速开发 Spring 应用程序的框架,它提供了一些基础设施,使得我们可以快速地开发出高效、可靠的应用程序。其中,@EnableDiscoveryClient 注解是 Spring Boot 中一个非常重要的注解,它提供了一种便捷的方式来将 Spring Boot 应用程序注册到服务注册中心中。本文将介

    2024年02月12日
    浏览(48)
  • Spring Boot 中的 @HystrixCommand 注解

    在分布式系统中,服务之间的调用是不可避免的。但随着服务数量的增加,服务之间的依赖关系也会变得越来越复杂,服务的故障也会变得越来越常见。一旦某个服务出现故障,它所依赖的服务也会受到影响,导致整个系统出现故障。为了应对这种情况,Netflix 开发了 Hystri

    2024年02月17日
    浏览(40)
  • Spring Boot 中的 @CacheEvict 注解

    在 Spring Boot 中,缓存是提高应用性能的重要手段。为了更好地管理缓存,Spring Boot 提供了一系列的缓存注解,其中 @CacheEvict 注解用于清空缓存。 本文将介绍 @CacheEvict 注解的含义、原理以及如何使用。 @CacheEvict 注解用于清空缓存。它可以标注在方法上,表示在执行该方法后

    2024年02月09日
    浏览(54)
  • Spring Boot 中的 @Cacheable 注解

    在 Spring Boot 中,缓存是一个非常重要的话题。当我们需要频繁读取一些数据时,为了提高性能,可以将这些数据缓存起来,避免每次都从数据库中读取。为了实现缓存,Spring Boot 提供了一些缓存注解,其中最常用的是 @Cacheable 注解。 @Cacheable 注解用于标记一个方法需要被缓存

    2024年02月12日
    浏览(62)
  • Spring Boot中的service层

    spring Boot中的service层是业务逻辑层,负责处理业务需求,封装业务方法,调用dao层的数据操作1。service层一般是一个接口和一个实现类,用@Service注解标注实现类2。service层的接口可以在controller层中调用,实现数据的传递和处理。 一个service层的示例代码如下: 首先,需要定义

    2024年02月12日
    浏览(43)
  • Spring Boot中的@EnableAutoConfiguration注解

    Spring Boot是一个非常流行的Java框架,它可以快速创建基于Spring的应用程序。Spring Boot提供了许多自动配置功能,使得开发者可以非常容易地创建一个可运行的应用程序。其中,@EnableAutoConfiguration注解是Spring Boot自动配置功能的核心之一。 @EnableAutoConfiguration注解是Spring Boot的核心

    2024年02月11日
    浏览(63)
  • Spring Boot 中的 CD 工具

    在现代软件开发中,持续交付(Continuous Delivery,简称 CD)已经成为了一个非常重要的开发模式。CD 工具可以帮助我们自动化构建、测试、部署和发布软件,提高软件交付的速度和质量。在 Spring Boot 中,有许多优秀的 CD 工具可以使用。本文将介绍一些常用的 CD 工具,并说明如

    2024年02月12日
    浏览(43)
  • Spring Boot 中的负载均衡

    负载均衡是分布式系统中非常重要的一个概念,它可以帮助我们将请求分摊到多个服务实例中,从而提高系统的可用性和性能。在 Spring Boot 中,负载均衡通常是通过 Ribbon 实现的。本文将深入探讨 Spring Boot 中的负载均衡是什么,其原理以及如何使用。 负载均衡是指将请求分

    2024年02月12日
    浏览(72)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包