Spring WebSocket 404错误的解决方法

更新时间：2017年12月10日 09:54:11 作者：Silent_Paladin

这篇文章主要为大家详细介绍了Spring WebSocket 404错误的解决方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下

近来学习 Spring WebSocket 时按照 Spring IN ACTION 中示例编写代码，运行时浏览器报404 错误

WebSocket connection to 'ws://localhost/websocket/marco' failed: Error during WebSocket handshake: Unexpected response code: 404

按照 Spring IN ACTION 中步骤：
首先，继承 AbstractWebSocketHandler，重载以下 3 个方法：
- handleTextMessage – 处理文本类型消息
- afterConnectionEstablished – 新连接建立后调用
- afterConnectionClosed – 连接关闭后调用

import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.AbstractWebSocketHandler;

public class MarcoHandler extends AbstractWebSocketHandler {

 protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
  System.out.println("Received message: " + message.getPayload());
  Thread.sleep(2000);
  session.sendMessage(new TextMessage("Polo!"));
 }

 @Override
 public void afterConnectionEstablished(WebSocketSession session) {
  System.out.println("Connection established!");
 }

 @Override
 public void afterConnectionClosed(WebSocketSession session, CloseStatus status) {
  System.out.println("Connection closed. Status: " + status);
 }

}

其次，使用 JavaConfig 启用 WebSocket 并映射消息处理器

import org.springframework.context.annotation.Bean;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

 @Override
 public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
  registry.addHandler(marcoHandler(), "/marco");
 }

 @Bean
 public MarcoHandler marcoHandler() {
  return new MarcoHandler();
 }

}

最后，编写前端 JS 代码发起连接请求及后续消息交互

var url = 'ws://' + window.location.host + '/websocket/marco';
var sock = new WebSocket(url);

sock.onopen = function() {
 console.log('Opening');
 sock.send('Marco!');
};

sock.onmessage = function(e) {
 console.log('Received Message: ', e.data);
 setTimeout(function() {
  sayMarco()
 }, 2000);
};

sock.onclose = function() {
 console.log('Closing');
};

function sayMarco() {
 console.log('Sending Marco!');
 sock.send('Marco!');
}

部署后打开浏览器运行，直接报 404 错误

上网搜索了一晚上解决方案，包括参考 stackoverflow.com 上的经验都未解决该问题，直到查看到以下文章：
Spring集成webSocket页面访问404问题的解决方法

在此自己也做个记录避免以后遗忘。

WebSocket 实质上借用 HTTP 请求进行握手，启用 Spring WebSocket 需要在 org.springframework.web.servlet.DispatcherServlet 里配置拦截此请求。

以下是解决步骤：

首先，修改 WebSocketConfig 类定义，在类上添加 @Configuration 注解，表明该类以 JavaConfig 形式用作 bean 定义的源（相当于 XML 配置中的 <beans> 元素）。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

 @Override
 public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
  registry.addHandler(marcoHandler(), "/marco");
 }

 @Bean
 public MarcoHandler marcoHandler() {
  return new MarcoHandler();
 }

}

其次，使用 JavaConfig 配置 DispatcherServlet，继承org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer ，重载以下 3 个方法：
- getRootConfigClasses – 返回带有 @Configuration 注解的类将会用来配置 ContextLoaderListener 创建的应用上下文中的 bean
- getServletConfigClasses – 返回带有 @Configuration 注解的类将会用来定义 DispatcherServlet 应用上下文中的 bean
- getServletMappings – 将一个或多个路径映射到 DispatcherServlet 上

实际上，如果只需要 Spring WebSocket 生效，则只需要在 getServletConfigClasses 方法中返回用来定义 DispatcherServlet 应用上下文中的 bean

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class WebSocketInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

 @Override
 protected Class<?>[] getRootConfigClasses() {
  return null;
 }

 @Override
 protected Class<?>[] getServletConfigClasses() {
  return new Class<?>[] {WebSocketConfig.class};
 }

 @Override
 protected String[] getServletMappings() {
  return new String[] {"/"};
 }

}

重新部署后代开浏览器运行成功

客户端消息

服务器消息

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

idea打开和读取*properties文件乱码的解决
本文主要介绍了idea打开和读取*properties文件乱码的解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2023-09-09
Java中Maven的打包方式和执行jar详解
这篇文章主要介绍了Java中maven的打包方式和执行jar，文中有详细的代码示例，有需要的朋友可以借鉴一下
2023-04-04
Java swing实现酒店管理系统
这篇文章主要为大家详细介绍了Java swing实现酒店管理系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-02-02
深度解析Java中ArrayList的使用
ArrayList 类是一个可以动态修改的数组，与普通数组的区别就是它是没有固定大小的限制，我们可以添加或删除元素。本文将通过示例带你深度解析Java中ArrayList的使用，需要的可以参考一下
2022-09-09
Java实现常见排序算法的优化
今天给大家带来的是关于Java的相关知识,文章围绕着Java实现常见排序算法的优化展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
2021-01-01
Java实现配置加载机制
这篇文章主要介绍了Java实现配置加载机制的相关资料,需要的朋友可以参考下
2016-01-01
Spring中的注解@Value("#{}")与@Value("${}")的区别
这篇文章主要介绍了Spring中的注解@Value(“#{}“)与@Value(“${}“)的区别到底是什么,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-06-06
详解Springboot应用中设置Cookie的SameSite属性
Chrome 51 开始，浏览器的 Cookie 新增加了一个SameSite属性，用来防止 CSRF 攻击和用户追踪。今天通过本文给大家介绍Springboot应用中设置Cookie的SameSite属性，感兴趣的朋友一起看看吧
2022-01-01
SpringBoot整合EasyExcel 3.x的完整示例
EasyExcel 是一个基于 Java 的、快速、简洁、解决大文件内存溢出的 Excel 处理工具，它能让你在不用考虑性能、内存的等因素的情况下，快速完成 Excel 的读、写等功能，这篇文章主要介绍了SpringBoot整合EasyExcel3.x的过程,需要的朋友可以参考下
2023-07-07
在idea2023中使用SpringBoot整合Lombok全过程及详细用法
Lombok项目是一个java库,它可以自动插入到编辑器和构建工具中,增强java的性能,本文详细给大家介绍了在idea2023中使用SpringBoot整合Lombok全过程及详细用法,需要的朋友可以参考下
2023-09-09