如何在Spring Boot中实现实时通知

最新推荐文章于 2024-07-24 18:30:50 发布

微赚淘客机器人开发者联盟@聚娃科技

最新推荐文章于 2024-07-24 18:30:50 发布

阅读量1.1k

点赞数 31

文章标签： spring boot 后端 java

本文链接：https://blog.csdn.net/java666668888/article/details/140228858

版权

如何在Spring Boot中实现实时通知

大家好，我是免费搭建查券返利机器人省钱赚佣金就用微赚淘客系统3.0的小编，也是冬天不穿秋裤，天冷也要风度的程序猿！今天我们将讨论如何在Spring Boot应用中实现实时通知功能，这在现代Web应用程序和服务中是非常重要的一部分。

一、什么是实时通知？

实时通知是指系统能够即时将特定信息或事件推送给用户或其他系统的能力。与传统的轮询或定时拉取相比，实时通知能够实现更低的延迟和更高的实时性，为用户提供更好的交互体验。

二、实现实时通知的技术选择

在Spring Boot中，我们可以选择多种技术来实现实时通知，包括但不限于：

WebSocket：提供了双向通信的能力，适用于需要低延迟、高实时性的场景。
Server-Sent Events (SSE)：允许服务器端向客户端单向推送数据，适用于单向通信场景。
消息队列：如RabbitMQ、Kafka等，用于异步消息传递和广播通知。
Webhooks：通过HTTP回调实现事件通知，适用于接收外部系统的事件推送。

本文将重点介绍WebSocket和SSE的实现方式。

三、使用WebSocket实现实时通知

WebSocket是一种先进的通信协议，允许在单个TCP连接上进行全双工通信。在Spring Boot中，我们可以通过Spring WebSocket模块实现WebSocket功能。

1. 添加依赖

首先，在pom.xml中添加Spring WebSocket的依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

2. 创建WebSocket配置类

package cn.juwatech.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

    @Override
    public void configureMessageBroker(MessageBrokerRegistry config) {
        config.enableSimpleBroker("/topic"); // Enable a simple in-memory message broker to carry messages back to the client on destinations prefixed with "/topic"
        config.setApplicationDestinationPrefixes("/app"); // Message-handling methods (message-handling methods) are mapped to the /app prefix
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/ws").withSockJS(); // Use SockJS to enable fallback options for browsers that don’t support websocket
    }
}

3. 编写控制器

package cn.juwatech.controller;

import cn.juwatech.dto.Notification;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;

@Controller
public class NotificationController {

    @MessageMapping("/sendNotification")
    @SendTo("/topic/notification")
    public Notification sendNotification(Notification notification) {
        return notification;
    }
}

4. 编写前端页面（HTML + JavaScript）

<!DOCTYPE html>
<html>
<head>
    <title>Real-time Notifications</title>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/stomp.js/2.3.3/stomp.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/sockjs-client/1.5.0/sockjs.min.js"></script>
    <script>
        var stompClient = null;

        function connect() {
            var socket = new SockJS('/ws');
            stompClient = Stomp.over(socket);
            stompClient.connect({}, function(frame) {
                console.log('Connected: ' + frame);
                stompClient.subscribe('/topic/notification', function(notification) {
                    showNotification(JSON.parse(notification.body).message);
                });
            });
        }

        function showNotification(message) {
            var notificationsDiv = document.getElementById('notifications');
            var p = document.createElement('p');
            p.textContent = message;
            notificationsDiv.appendChild(p);
        }

        window.onload = function() {
            connect();
        };
    </script>
</head>
<body>
    <h2>Real-time Notifications</h2>
    <div id="notifications"></div>
</body>
</html>

四、使用Server-Sent Events (SSE)实现实时通知

Server-Sent Events (SSE)允许服务器端向客户端单向推送数据，适合于需要向客户端发送更新或通知的场景。

1. 创建SSE控制器

package cn.juwatech.controller;

import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;

import java.io.IOException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

@RestController
public class SSEController {

    private final ExecutorService nonBlockingService = Executors.newCachedThreadPool();

    @GetMapping(value = "/sse/notification", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
    public SseEmitter serverSentEvents() {
        SseEmitter emitter = new SseEmitter();
        nonBlockingService.execute(() -> {
            try {
                emitter.send(SseEmitter.event().name("notification").data("New notification"));
                // Simulate sending notifications periodically
                Thread.sleep(3000);
                emitter.send(SseEmitter.event().name("notification").data("Another notification"));
                emitter.complete();
            } catch (Exception e) {
                emitter.completeWithError(e);
            }
        });
        return emitter;
    }
}

2. 前端页面

<!DOCTYPE html>
<html>
<head>
    <title>Server-Sent Events (SSE) Notifications</title>
</head>
<body>
    <h2>Server-Sent Events (SSE) Notifications</h2>
    <div id="notifications"></div>

    <script>
        var notificationsDiv = document.getElementById('notifications');
        var eventSource = new EventSource('/sse/notification');

        eventSource.onmessage = function(event) {
            var message = event.data;
            var p = document.createElement('p');
            p.textContent = message;
            notificationsDiv.appendChild(p);
        };

        eventSource.onerror = function(event) {
            console.error('EventSource error: ', event);
            eventSource.close();
        };
    </script>
</body>
</html>

五、总结

通过本文，我们详细介绍了在Spring Boot应用中实现实时通知的两种主要方式：WebSocket和Server-Sent Events (SSE)。WebSocket适合双向通信和复杂的应用场景，而SSE适合单向通知和简单的推送场景。我们通过具体的代码示例演示了如何在Spring Boot中配置和使用这些技术，以及如何在前端页面接收和展示实时通知。希望本文对你理解和实现实时通知功能有所帮助！

微赚淘客系统3.0小编出品，必属精品！