Spring Boot中的SimpMessagingTemplate是什么，原理，以及如何使用

╰半橙微兮° 2024-03-17 13:11 24阅读 0赞

## Spring Boot中的SimpMessagingTemplate是什么，原理，以及如何使用 ##

SimpMessagingTemplate是Spring Framework中的一个类，用于向WebSocket客户端发送消息。在Spring Boot应用程序中，可以使用SimpMessagingTemplate来实现WebSocket通信的消息发送功能。本文将介绍SimpMessagingTemplate的原理和使用方法。

![在这里插入图片描述][8989c1311525449284bb84b1ed8fb5c1.png]

### SimpMessagingTemplate是什么 ###

SimpMessagingTemplate是Spring Framework中的一个类，用于向WebSocket客户端发送消息。在Spring Boot应用程序中，可以使用SimpMessagingTemplate来实现WebSocket通信的消息发送功能。

SimpMessagingTemplate类提供了多种方法来向WebSocket客户端发送消息，支持多种消息类型，例如文本消息、二进制消息、对象消息等。

### 原理 ###

SimpMessagingTemplate的原理是通过WebSocket消息代理来向WebSocket客户端发送消息。在启用WebSocket消息代理之后，可以使用SimpMessagingTemplate类来向WebSocket客户端发送消息。

SimpMessagingTemplate类中的sendMessage方法用于向WebSocket客户端发送消息，该方法会将消息发送到WebSocket消息代理，由WebSocket消息代理负责将消息转发给目标WebSocket客户端。

在Spring Boot中，可以通过注入SimpMessagingTemplate类的实例来向WebSocket客户端发送消息。具体代码如下：

@RestController
    public class GreetingController {
        
        @Autowired
        private SimpMessagingTemplate messagingTemplate;
    
        @MessageMapping("/hello")
        public void greeting(HelloMessage message) throws Exception {
        
            Thread.sleep(1000); // simulated delay
            Greeting greeting = new Greeting("Hello, " + message.getName() + "!");
            messagingTemplate.convertAndSend("/topic/greetings", greeting);
        }
    }

在上述代码中，我们在GreetingController类中注入了SimpMessagingTemplate类的实例messagingTemplate。在greeting方法中，我们通过messagingTemplate.convertAndSend方法向"/topic/greetings"地址发送一条Greeting类型的消息。

### 如何使用 ###

下面我们来演示如何使用SimpMessagingTemplate类来向WebSocket客户端发送消息。

#### 步骤1：添加依赖 ####

在使用SimpMessagingTemplate之前，需要在项目中添加以下依赖：

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

#### 步骤2：定义WebSocket配置类 ####

在项目中定义一个WebSocket配置类，用于配置WebSocket消息代理的相关参数。具体代码如下：

@Configuration
    @EnableWebSocketMessageBroker
    public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
        
        @Override
        public void configureMessageBroker(MessageBrokerRegistry registry) {
        
            registry.enableSimpleBroker("/topic");
            registry.setApplicationDestinationPrefixes("/app");
        }
    
        @Override
        public void registerStompEndpoints(StompEndpointRegistry registry) {
        
            registry.addEndpoint("/ws").withSockJS();
        }
    }

该配置类中使用@EnableWebSocketMessageBroker注解来启用WebSocket消息代理功能，使用configureMessageBroker方法来配置消息代理的相关参数，使用registerStompEndpoints方法来注册Stomp协议的WebSocket端点。

在configureMessageBroker方法中，我们使用enableSimpleBroker方法来配置消息代理的地址，这里我们将消息代理地址设置为"/topic"，表示所有以"/topic"开头的消息都会被路由到消息代理上。setApplicationDestinationPrefixes方法用于设置应用程序的目的地前缀，这里我们将其设置为"/app"，表示所有以"/app"开头的消息都会被路由到控制器上。

在registerStompEndpoints方法中，我们使用addEndpoint方法来添加WebSocket端点，这里我们将WebSocket端点设置为"/ws"，并使用withSockJS方法启用SockJS支持，以便在不支持WebSocket的浏览器上进行通信。

#### 步骤3：定义WebSocket控制器 ####

在项目中定义一个WebSocket控制器，用于处理WebSocket消息。具体代码如下：

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

在上述代码中，我们使用@Controller注解来标识该类为WebSocket控制器，使用@MessageMapping注解来映射WebSocket请求地址"/hello"，使用@SendTo注解来指定发送消息的地址。在greeting方法中，我们处理接收到的HelloMessage类型的消息，并返回一个Greeting类型的消息。

#### 步骤4：定义消息类型 ####

在项目中定义消息类型，用于在WebSocket客户端和服务器之间传递消息。具体代码如下：

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;
        }
    
        public void setContent(String content) {
        
            this.content = content;
        }
    }

在上述代码中，我们定义了HelloMessage和Greeting两种消息类型，分别用于表示客户端发送的消息和服务器返回的消息。

#### 步骤5：使用SimpMessagingTemplate发送消息 ####

在需要向WebSocket客户端发送消息的地方注入SimpMessagingTemplate类的实例，使用其convertAndSend方法向指定地址发送消息。具体代码如下：

@Autowired
    private SimpMessagingTemplate messagingTemplate;
    
    public void sendMessage(String destination, Object message) {
        
        messagingTemplate.convertAndSend(destination, message);
    }

在上述代码中，我们注入SimpMessagingTemplate类的实例messagingTemplate，并定义了一个sendMessage方法，用于向指定地址发送消息。

### 总结 ###

SimpMessagingTemplate是Spring Framework中用于向WebSocket客户端发送消息的类，使用它可以实现WebSocket通信的消息发送功能。在Spring Boot应用程序中，可以通过WebSocket消息代理来实现WebSocket通信，使用SimpMessagingTemplate类可以方便地向WebSocket客户端发送消息。本文介绍了SimpMessagingTemplate的原理和使用方法，希望对读者有所帮助。

[8989c1311525449284bb84b1ed8fb5c1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/d6b5b018f93a41ce93504acb3a91b605.png