@EnableWebMvc以及有关WebSocket的一些心得

最新推荐文章于 2024-04-05 09:30:08 发布
最新推荐文章于 2024-04-05 09:30:08 发布
阅读量687 收藏
点赞数
文章标签： websocket java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zuyunfanwoerzi/article/details/120561603
版权

有关@EnableWebMvc

打开@EnableWebMvc查看官方注释，：

 * Adding this annotation to an {@code @Configuration} class imports the Spring MVC
 * configuration from {@link WebMvcConfigurationSupport}, e.g.:

意思就是这个标签注释与@Configuration一起使用，注释在springMvc的配置类上以配置自己需要的springMvc配置

 * <p>To customize the imported configuration, implement the interface
 * {@link WebMvcConfigurer} and override individual methods, e.g.:

这段和上面意思差不多，它实现了WebMvcConfigurer接口，可以通过override很简单的重写原来的配置，至于@EnableWebMvc应该是可注释可不注释

 * <p>If {@link WebMvcConfigurer} does not expose some more advanced setting that
 * needs to be configured consider removing the {@code @EnableWebMvc}
 * annotation and extending directly from {@link WebMvcConfigurationSupport}
 * or {@link DelegatingWebMvcConfiguration}, e.g.:

这段意思就是如果WebMvcConfigurer提供的方法不够用了，可以继承DelegatingWebMvcConfiguration或WebMvcConfigurationSupport并且移除@EnableWebMvc

这三段注释看起来解释的都是一件事，@EnableWebMvc作用：声明被注释类是配置类，并且导入DelegatingWebMvcConfiguration类，很简单，而且实际开发中我们经常使用的WebMvcConfigurer接口并不需要注册@EnableWebMvc也能使用；
它主要关键在于导入DelegatingWebMvcConfiguration类上，这个类它是WebMvcConfigurationSupport的子类，而自动配置类中有这样一段注释：

@Configuration
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class,
		TaskExecutionAutoConfiguration.class, ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {

@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
缺少WebMvcConfigurationSupport类自动注释才会生效，也就是说当我们在配置类上注释了@EnableWebMvc时，自动配置就没了！这一点对那些对spring框架不了解的程序员来说十分不友好，尤其是springBoot框架下，什么静态资源失效，什么映射找不到，那都是家常便饭；
所以如果除非是特殊情况下，最好不要在配置类上注释@EnableWebMvc，其实这个注释现在也基本不用了，如果要简单重写配置，实现WebMvcConfigurer接口即可，@EnableWebMvc加上与否决定是否屏蔽@EnableAutoConfiguration，如果WebMvcConfigurer提供的设置不够，直接继承WebMvcConfigurationSupport类即可，无论加不加@EnableWebMvc接口，都会屏蔽@EnableAutoCongfiguration

WebSocket

webSocket是一种支持后端主动与前端通信的协议，它有两种实现方式：
纯注解方法：
（1）将ServerEndpointExporter实例注入到spring容器进行管理

@Configuration
public class webSocketConfig {
//	@Bean
//	public ServerEndpointExporter getEndPoint() {
//		return new ServerEndpointExporter();
//	}
}

(2) 实现消息处理类，前后端的通过socket发送接收的消息都在这个类里处理

//package com.fh.config;
//
//import java.io.IOException;
//import java.util.concurrent.ConcurrentHashMap;
//
//import javax.websocket.OnClose;
//import javax.websocket.OnError;
//import javax.websocket.OnMessage;
//import javax.websocket.OnOpen;
//import javax.websocket.Session;
//import javax.websocket.server.PathParam;
//import javax.websocket.server.ServerEndpoint;
//import org.springframework.stereotype.Component;
//
//import com.alibaba.fastjson.JSON;
//import com.alibaba.fastjson.JSONObject;
//
//
//@ServerEndpoint("/web/{sid}") 配置映射
//@Component
//public class MyWebSocket {
//	// 存储回话
//	private static ConcurrentHashMap<String,Session> map = 
//			new ConcurrentHashMap<>(); 线程安全
//	
//	@OnOpen 当有新客户端发起连接时调用
//	public void testonOpen(Session session,@PathParam("sid") String sid) {
//		map.put(sid, session);
//		System.out.println("服务端接到到客户端编号："+sid+"的请求连接，已连接");
//		System.out.println("当前服务端连接总数为" + map.size());
//	}
//	
//	@OnClose 当由客户端断开连接时调用，多半是网页关闭
//	public void testonClose(@PathParam("sid") String sid) {
//		System.out.println("服务端接收到编号为"+sid+"的客户端的断开连接请求，已断开");
//		map.remove(sid);
//	}
//	
//	@OnMessage 当客户端给服务端发送消息时调用
//	public void testOnMessage(String message,Session session,@PathParam("sid") String sid) {
//		JSONObject object = JSON.parseObject(message);
//		System.out.println("客户端编号为" + sid);
//		System.out.println("服务端接收到消息，消息为："+object.getString("message"));
//		System.out.println("开始发送消息到特定客户端");
//		try {
//			map.get(object.getString("sid")).getBasicRemote().sendText(object.getString("message"));
//		} catch (IOException e) {
//			// TODO Auto-generated catch block
//			e.printStackTrace();
//		}
//	}
//	
//	@OnError 出错时调用，Throwable参数必须有
//	public void testOnError(@PathParam("sid") String sid,Throwable error) {
//		System.out.println("编号为"+sid+"客户端出错，请检查");
//	}
//}

手动配置方法（老框架使用）:
(1)消息处理类，同第一种方法的（2）

@Component
public class MySocketHandler extends TextWebSocketHandler {
	
	private static ConcurrentHashMap<String,WebSocketSession> map = 
	new ConcurrentHashMap<>();
	
	@Override
	public void afterConnectionEstablished(WebSocketSession session) throws Exception {
		// TODO Auto-generated method stub
		map.put((String)session.getAttributes().get("id"), session);
		System.out.println("已经有一个客户端连接，当前连接数："+ map.size());
		super.afterConnectionEstablished(session);
	}

	@Override
	protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
		// TODO Auto-generated method stub
		System.out.println("接收到客户端发来的消息，"+(String)session.getAttributes().get("id")+"消息为："+ message.getPayload());
		super.handleTextMessage(session, message);
	}

	@Override
	public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
		// TODO Auto-generated method stub
		System.out.println("客户端"+(String)session.getAttributes().get("id")+"出错");
		super.handleTransportError(session, exception);
	}

	@Override
	public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
		// TODO Auto-generated method stub
		System.out.println("已经有一个客户端退出，退出客户端为"+(String)session.getAttributes().get("id")
				+ "，当前连接数："+ map.size());
		super.afterConnectionClosed(session, status);
	}
	
}

afterConnectionEstablished对应@OnOpen，handleTextMessage对应@OnMessage，handleTransportError对应@OnError，afterConnectionClosed对应@OnClose

(2)拦截器，用于拦截客户端发起的连接请求以及后续的消息

public class MySocketIntercepter implements HandshakeInterceptor {

	@Override
	public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
			Map<String, Object> attributes) throws Exception {
		// TODO Auto-generated method stub
		if (request instanceof ServletServerHttpRequest) {
			HttpServletRequest rq2 = ((ServletServerHttpRequest) request).
					getServletRequest();
			String id = rq2.getParameter("id");
			attributes.put("id", id);
			return true;
		}
		System.out.println("websocket连接已经映射到，拦截器取值出错");
		return false;
	}

	@Override
	public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
			Exception exception) {
		// TODO Auto-generated method stub

	}

}

注意消息处理类是无法直接获取请求的，所以如果客户端发来的连接请求带有数据，比如客户端的id之类的，必须在拦截器中处理

（3）注册配置类

@Configuration
@EnableWebSocket
public class TestConfig  implements  WebSocketConfigurer {
	@Autowired
	MySocketHandler handler;
	
	@Override
	public void registerWebSocketHandlers(WebSocketHandlerRegistry arg0) {
		// TODO Auto-generated method stub
		arg0.addHandler(handler, "/webForSSM").addInterceptors(new MySocketIntercepter());
		System.out.println("已经映射");
	}

}

@EnableWebSocket注册到该类上时标识该类是WebSocket的注册类，@Configuration并不是必须的，你用@Componoent也可以，总之能被spring容器扫描即可；

然后是前端的实现：

var websocket;
	function on() {
		if (typeof(WebSocket) == "undefined") {
			alert("此浏览器不支持WebSocket，连接失败;");
		} else {
			var basePath = [[${basePath}]];
			webSocket = new WebSocket((basePath +"webForSSM?id=1").replace('http','ws'));
			webSocket.onopen = function() {
				$(".res").html($(".res").html() + "已打开");
			//$("div.res").html("已连接");
			}
			webSocket.onmessage = function (event) {
				$(".res").html($(".res").html() + event.data);
			}
		}
		
	}
	
	function send() {
		var value = {message :$(".socketText").val(),
				sid : '2'};
		
		webSocket.send(JSON.stringify(value));
	}

如果浏览器支持WebSocket，直接new即可，否则也可以使用socketjs，后端注册类时要改动一下：

@Configuration
@EnableWebSocket
public class TestConfig  implements  WebSocketConfigurer {
	@Autowired
	MySocketHandler handler;
	
	@Override
	public void registerWebSocketHandlers(WebSocketHandlerRegistry arg0) {
		// TODO Auto-generated method stub
//		arg0.addHandler(handler, "/webForSSM").addInterceptors(new MySocketIntercepter());
//		System.out.println("已经映射");
		arg0.addHandler(handler, "/webForSSM").
		addInterceptors(new MySocketIntercepter()).withSockJS();

	}

}

对了，有关之前的配置消息解析器为什么可以@Bean创建：

@Configuration
public class ConfigurationSet {
	
	@Bean
	public StringHttpMessageConverter getConverter() {
		StringHttpMessageConverter temp = new StringHttpMessageConverter();
		temp.setDefaultCharset(Charset.forName("utf-8"));
		return temp;
	}

这个是springboot的优点之一，@Bean会自动将注册到容器中的消息转换器放入到消息转换器的list集合中，也就是自动配置；
注意：转换器自动注册机制是由WebMvcAutoConfiguration实现的,如果你的项目继承了WebMvcConfigurationSupport或者它的子类，会失效，只能手动配置

参考的文章：https://charming.blog.csdn.net/article/details/84636521?utm_medium=distribute.pc_relevant.none-task-blog-2defaultCTRLISTdefault-2.no_search_link&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2defaultCTRLISTdefault-2.no_search_link

zuyunfanwoerzi
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
java 后端源码包websocket client 四种创建方式websocket server 创建方式
07-07
- websocket client 四种创建方式 1. 第一种方式 WebSocketClient 注入方式 2. 第二种方式 @ClientEndpoint 注解方式 3. 第三种方式 extends WebSocketClient 的方式 4. 第四种方式 @ClientEndpoint 简单版 - ...
一文搞懂四种 WebSocket 使用方式
m0_69860228的博客
06-06 6862
在上家公司做IM消息系统的时候，一直是使用 WebSocket 作为收发消息的基础组件，今天就和大家聊聊在 Java 中，使用 WebSocket 所常见的四种姿势，如果大家以后或者现在碰到有要使用 WebSoocket 的情况可以做个参考。上面的思维导图已经给大家列出了三种使用 WebSocket 的方式，下文会对它们的特点进行一一解读，不同的方式具有不同的特点，我们先按下不表。在这里，我想让大家思考一下我在思维导图中列举的第四种做 WebScoket 支持的方案可能是什么？不知道大家能不能猜对，后文将会
基于springboot @EnableWebSocket 注解完成基本的socket通信以及socket握手权限
热门推荐
H291850336的专栏
04-18 1万+
基于spring boot 完成客户端实时通信，此处对整体流程做了简要实现，下一篇讲在此业务上实现通信优化 不涉及socket存储处理以及发送的逻辑代码 首先添加pom 依赖 <dependency> <groupId>org.springframework.boot</groupId> ...
基于STOMP协议的WebSocket消息代理和相关的安全握手处理器以及消息拦截器
最新发布
weixin_36829761的博客
04-05 943
这段代码是一个Spring配置类，用于配置基于STOMP协议的WebSocket消息代理和相关的安全握手处理器以及消息拦截器。这个类通过实现接口来定义WebSocket通信的路由、安全握手以及消息拦截的逻辑。
Spring Boot中的@EnableWebSocketMessageBroker注解是什么，原理，以及如何使用
徐师兄的博客
06-30 4769
在项目中定义一个WebSocket配置类，用于配置WebSocket消息代理的相关参数。} }该配置类中使用@EnableWebSocketMessageBroker注解来启用WebSocket消息代理功能，使用configureMessageBroker方法来配置消息代理的相关参数，使用registerStompEndpoints方法来注册Stomp协议的WebSocket端点。
Websocket学习（@EnableWebSocket&@ServerEndpoint&websocket认证&nginx配置WebSocket&gateway配置websocket）
pscool的博客
03-10 5105
WebSocket协议：5分钟从入门到精通 https://www.cnblogs.com/chyingp/p/websocket-deep-in.html WebSocket协议入门介绍 h ttps://www.cnblogs.com/nuccch/p/10947256.html
spring boot websocket 的使用
张小三的博客
07-18 2700
/如果spingboot配置文件中中配置了server.servlet.context-path，则格式为ws//ip接口启动的端口/server.servlet.context-path的名称/webSocketDemo。//连接到WebSocket的url地址。格式为ws//ip接口启动的端口/webSocketDemo。//连接发生错误的回调方法。//连接成功建立的回调方法。//ws连接断开的回调方法。//接收到消息的回调方法。//将消息显示在网页上。...
go-jsonrpc-websocket.rar
05-05
在客户端模块中，使用GO语言、jsonrpc库完成服务端接口调用，接收服务端的通知消息，并完成通知消息的处理。
详解java WebSocket的实现以及Spring WebSocket
08-31
主要介绍了详解java WebSocket的实现以及Spring WebSocket ,具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
java WebSocket的实现以及Spring WebSocket示例代码
08-31
本篇文章主要介绍了java WebSocket的实现以及Spring WebSocket，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
Graphql以及WebSocket入门资料和代码.zip
10-19
Graphql以及WebSocket入门资料和代码
Spring Boot WebSocket 笔记
qq_41725131的博客
12-19 758
Spring Boot WebSocket 笔记一、网页技术发展过程二、WebSocket群聊Demo 本文仓库地址：chat01 一、网页技术发展过程 一开始的网页是静态的html页面，不能进行交互，随后javascript出现，在一定程度上实现了页面的简单交互。不过javascript不能和服务端交互，随后ajax的出现解决了与服务端交互的问题，ajax存在的不足——所有的请求都是由客户端发起的，服务端进行响应，若服务端有最新的消息，则难以发送到客户端去，不过我们一直存在这种实时通讯的需求。 在没有We
基于spring @EnableWebSocket 实现socket通信业务处理优化
H291850336的专栏
04-18 8019
本篇文章针对基于spring @EnableWebSocket 实现socket通信业务处理的处理 在socket通信默认情况下是线程不安全的，当多个线程访问同一个socket实体是将会发生错误，具体看源码当socket发送信息是改变自身状态，当另一个线程发送时会检查状态，当状态不为初始值是将抛出异常， 本人解决思路是将每个socket客户端的信息根据放到单独队列去处理，以实现单线程操作 不...
SpringBoot集成WebSocket--------Spring方式集成（一）
豢龙先生
06-29 4952
二、配置 1、WebSocketConfigurer配置器 2、@EnableWebSocket注解 （1）注解引入一个配置类DelegatingWebSocketConfiguration.class （2）DelegatingWebSocketConfiguration配置类会被容器自动加载，同时会注入容器中所有的WebSocketConfigurer实现到configurers中；同时registerWebSocketHandlers()方法会遍历configurers并回调所有WebSocketC
【websocket】spring boot 集成 websocket 的四种方式
KIWI的专栏
10-23 1698
集成 websocket 的四种方案 1. 原生注解 pom.xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency&gt...
【Spring Cloud】一个配置注解实现 WebSocket 集群方案
黑白法师的博客
06-06 2317
大家应该是再熟悉不过了，如果是单体应用确实不会有什么问题，但是当我们的项目使用微服务架构时，就可能会存在问题
Spring boot 整合WebSocket
weixin_43946028的博客
01-04 539
什么是WebSocket WebSocket 为浏览器和服务器提供了双工异步通信的功能，即浏览器可以向服务器发送信息，反之也成立。 WebSocket 是通过一个 socket 来实现双工异步通信能力的，但直接使用 WebSocket ( 或者 SockJS：WebSocket 协议的模拟，增加了当前浏览器不支持使用 WebSocket 的兼容支持) 协议开发程序显得十分繁琐，所以使用它的子协议 STOMP。 ...
WebSocket简介及与SpringBoot框架的集成
qgnczmnmn的博客
03-17 961
文章目录1. 概述2. WebSocket的诞生的背景、运行机制和抓包分析2.1. Websocket诞生的背景2.2. WebSocket 运行机制2.3. WebSocket抓包分析3. WebSocket 的应用场景、服务端和浏览器的版本要求3.1. 使用websocket的场景3.2. 服务端和浏览器的版本要求4. Spring 内嵌的简单消息代理 和 消息流程图4.1. Simple Broker4.2. 消息流程图5. 在Spring boot中集成websocket，并介绍stomp、sock
创建一个配置类，使用 @EnableWebSocket 注解开启 WebSocket 功能，并实现 WebSocketConfigurer 接口来配置 WebSocket代码
09-18
要创建一个配置类，使用 @EnableWebSocket 注解开启 WebSocket 功能，并实现 WebSocketConfigurer 接口来配置 WebSocket代码，可以按照以下步骤进行操作: 1. 创建一个配置类，并使用 @Configuration 注解标注。在...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值