在 Spring Boot WebSocket + STOMP 中,可以通过实现 MessageExceptionHandler 接口来自定义异常捕捉和处理逻辑。以下是一个示例代码:
public class CustomMessageExceptionHandler implements MessageExceptionHandler {
private final Logger logger = LoggerFactory.getLogger(CustomMessageExceptionHandler.class);
@Override
public void handleTransportError(WebSocketSession session, Throwable exception) {
logger.error("An error occurred during transport: {}", exception.getMessage());
// 自定义处理逻辑...
}
@Override
public void handleException(WebSocketSession session, Throwable exception) {
if (exception instanceof MyCustomException) { // 自定义异常处理逻辑
logger.error("My custom exception occurred: {}", exception.getMessage());
String errorMessage = "An error occurred: " + exception.getMessage();
StompHeaderAccessor headerAccessor = StompHeaderAccessor.create(StompCommand.ERROR);
headerAccessor.setMessage(errorMessage);
headerAccessor.setSessionId(session.getId());
try {
session.sendMessage(MessageBuilder.createMessage(new byte[0], headerAccessor.getMessageHeaders()));
} catch (IOException e) {
logger.error("Failed to send STOMP error message: {}", e.getMessage());
}
} else {
logger.error("An unexpected exception occurred: {}", exception.getMessage());
// 自定义处理逻辑...
}
}
}
在上述示例中,我们通过实现 MessageExceptionHandler 接口,并重写 handleTransportError 和 handleException 方法来自定义异常捕捉和处理逻辑。当出现 MyCustomException 异常时,会记录日志并发送 STOMP 错误消息给客户端;否则将异常抛出交由 SimpleMessageHandlerExceptionResolver 处理。
接着,在 WebSocket 配置类中注册自定义的 MessageExceptionHandler:
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
@Autowired
private CustomMessageExceptionHandler customMessageExceptionHandler;
@Override
public void configureWebSocketTransport(WebSocketTransportRegistration registration) {
registration.setMessageSizeLimit(1024 * 1024);
registration.addDecoratorFactory((connection, endpoint, headers) -> {
return new ExceptionHandlingDecorator(connection, customMessageExceptionHandler);
});
}
// 其他配置...
}
在上述代码中,我们通过 WebSocketTransportRegistration 的 addDecoratorFactory 方法注册了一个装饰器类 ExceptionHandlingDecorator,并将自定义的 MessageExceptionHandler 作为参数传入。ExceptionHandlingDecorator 类会在处理消息时捕捉可能出现的异常,并调用自定义的 MessageExceptionHandler 进行处理。
以下是 ExceptionHandlingDecorator 类的示例代码:
public class ExceptionHandlingDecorator extends AbstractSessionWebSocketHandlerDecorator {
private final Logger logger = LoggerFactory.getLogger(ExceptionHandlingDecorator.class);
private final MessageExceptionHandler exceptionHandler;
public ExceptionHandlingDecorator(WebSocketSession delegate, MessageExceptionHandler exceptionHandler) {
super(delegate);
this.exceptionHandler = exceptionHandler;
}
@Override
public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
try {
super.handleMessage(session, message);
} catch (Throwable t) {
if (t instanceof TransportException) { // 处理传输层异常
exceptionHandler.handleTransportError(session, t.getCause());
} else { // 处理其他异常
exceptionHandler.handleException(session, t);
}
}
}
}
在上述代码中,我们通过继承 AbstractSessionWebSocketHandlerDecorator 类,并重写 handleMessage 方法来实现异常捕捉和处理逻辑。当出现 TransportException 异常时,会调用 handleTransportError 方法进行处理;否则调用 handleException 方法进行处理。
注意:自定义的 MessageExceptionHandler 实现类需要注册到 WebSocket 配置类中,并且不能与 SimpleMessageHandlerExceptionResolver 同时使用。