重庆分公司,新征程启航
为企业提供网站建设、域名注册、服务器等服务
今天就跟大家聊聊有关springboot中怎么整合WebSocket,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。
网站建设哪家好,找创新互联建站!专注于网页设计、网站建设、微信开发、小程序开发、集团企业网站建设等服务项目。为回馈新老客户创新互联还提供了昂昂溪免费建站欢迎大家使用!
1、依赖引入
要使用 websocket 关键是@ServerEndpoint这个注解,该注解是 javaee 标准中的注解,tomcat7 及以上已经实现了,如果使用传统方法将 war 包部署到 tomcat 中,只需要引入如下 javaee 标准依赖即可:
javax javaee-api 7.0 provided
如使用 springboot 内置容器,无需引入,springboot 已经做了包含。我们只需引入如下依赖即可:
org.springframework.boot spring-boot-starter-websocket 1.5.3.RELEASE pom
2、注入 Bean
首先注入一个ServerEndpointExporterBean,该 Bean 会自动注册使用@ServerEndpoint 注解申明的 websocket endpoint。代码如下:
@Configuration public class WebSocketConfig { @Bean public ServerEndpointExporter serverEndpointExporter(){ return new ServerEndpointExporter(); } }
3、申明 endpoint
建立MyWebSocket.java类,在该类中处理 websocket 逻辑
@ServerEndpoint(value = "/websocket") //接受websocket请求路径 @Component //注册到spring容器中 public class MyWebSocket { //保存所有在线socket连接 private static MapwebSocketMap = new LinkedHashMap<>(); //记录当前在线数目 private static int count=0; //当前连接(每个websocket连入都会创建一个MyWebSocket实例 private Session session; private Logger log = LoggerFactory.getLogger(this.getClass()); //处理连接建立 @OnOpen public void onOpen(Session session){ this.session=session; webSocketMap.put(session.getId(),this); addCount(); log.info("新的连接加入:{}",session.getId()); } //接受消息 @OnMessage public void onMessage(String message,Session session){ log.info("收到客户端{}消息:{}",session.getId(),message); try{ this.sendMessage("收到消息:"+message); }catch (Exception e){ e.printStackTrace(); } } //处理错误 @OnError public void onError(Throwable error,Session session){ log.info("发生错误{},{}",session.getId(),error.getMessage()); } //处理连接关闭 @OnClose public void onClose(){ webSocketMap.remove(this.session.getId()); reduceCount(); log.info("连接关闭:{}",this.session.getId()); } //群发消息 //发送消息 public void sendMessage(String message) throws IOException { this.session.getBasicRemote().sendText(message); } //广播消息 public static void broadcast(){ MyWebSocket.webSocketMap.forEach((k,v)->{ try{ v.sendMessage("这是一条测试广播"); }catch (Exception e){ } }); } //获取在线连接数目 public static int getCount(){ return count; } //操作count,使用synchronized确保线程安全 public static synchronized void addCount(){ MyWebSocket.count++; } public static synchronized void reduceCount(){ MyWebSocket.count--; } }
4、客户的实现
客户端使用 h6 原生 websocket,部分浏览器可能不支持。代码如下:
websocket测试
三、测试
建立一个 controller 测试群发,代码如下:
@RestController public class HomeController { @GetMapping("/broadcast") public void broadcast(){ MyWebSocket.broadcast(); } }
然后打开上面的 html,可以看到浏览器和服务器都输出连接成功的信息:
浏览器: Event {isTrusted: true, type: "open", target: WebSocket, currentTarget: WebSocket, eventPhase: 2, …} 服务端: 2018-08-01 14:05:34.727 INFO 12708 --- [nio-8080-exec-1] com.fxb.h6websocket.MyWebSocket : 新的连接加入:0
点击测试按钮,可在服务端看到如下输出:
2018-08-01 15:00:34.644 INFO 12708 --- [nio-8080-exec-6] com.fxb.h6websocket.MyWebSocket : 收到客户端2消息:这是一个测试数据
再次打开 html 页面,这样就有两个 websocket 客户端,然后在浏览器访问localhost:8080/broadcast测试群发功能,每个客户端都会输出如下信息:
MessageEvent {isTrusted: true, data: "这是一条测试广播", origin: "ws://localhost:8080", lastEventId: "", source: null, …}
看完上述内容,你们对springboot中怎么整合WebSocket有进一步的了解吗?如果还想了解更多知识或者相关内容,请关注创新互联行业资讯频道,感谢大家的支持。