栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

详解spring boot Websocket使用笔记

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

详解spring boot Websocket使用笔记

本文只作为个人笔记,大部分代码是引用其他人的文章的。

在springboot项目中使用websocket做推送,虽然挺简单的,但初学也踩过几个坑,特此记录。

使用websocket有两种方式:1是使用sockjs,2是使用h5的标准。使用Html5标准自然更方便简单,所以记录的是配合h5的使用方法。

1、pom

核心是@ServerEndpoint这个注解。这个注解是Javaee标准里的注解,tomcat7以上已经对其进行了实现,如果是用传统方法使用tomcat发布项目,只要在pom文件中引入javaee标准即可使用。

  
   javax
   javaee-api
   7.0
   provided
  

但使用springboot的内置tomcat时,就不需要引入javaee-api了,spring-boot已经包含了。使用springboot的websocket功能首先引入springboot组件。

    
      org.springframework.boot
      spring-boot-starter-websocket
      1.3.5.RELEASE
    

顺便说一句,springboot的高级组件会自动引用基础的组件,像spring-boot-starter-websocket就引入了spring-boot-starter-web和spring-boot-starter,所以不要重复引入。

2、使用@ServerEndpoint创立websocket endpoint

首先要注入ServerEndpointExporter,这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint。要注意,如果使用独立的servlet容器,而不是直接使用springboot的内置容器,就不要注入ServerEndpointExporter,因为它将由容器自己提供和管理。

@Configuration
public class WebSocketConfig {
  @Bean
  public ServerEndpointExporter serverEndpointExporter() {
    return new ServerEndpointExporter();
  }

}

接下来就是写websocket的具体实现类,很简单,直接上代码:

@ServerEndpoint(value = "/websocket")
@Component
public class MyWebSocket {
  //静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。
  private static int onlineCount = 0;

  //concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。
  private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet();

  //与某个客户端的连接会话,需要通过它来给客户端发送数据
  private Session session;

  
  @onOpen
  public void onOpen(Session session) {
    this.session = session;
    webSocketSet.add(this);   //加入set中
    addonlineCount();      //在线数加1
    System.out.println("有新连接加入!当前在线人数为" + getonlineCount());
    try {
      sendMessage(CommonConstant.CURRENT_WANGING_NUMBER.toString());
    } catch (IOException e) {
      System.out.println("IO异常");
    }
  }

  
  @onClose
  public void onClose() {
    webSocketSet.remove(this); //从set中删除
    subonlineCount();      //在线数减1
    System.out.println("有一连接关闭!当前在线人数为" + getonlineCount());
  }

  
  @onMessage
  public void onMessage(String message, Session session) {
    System.out.println("来自客户端的消息:" + message);

    //群发消息
    for (MyWebSocket item : webSocketSet) {
      try {
 item.sendMessage(message);
      } catch (IOException e) {
 e.printStackTrace();
      }
    }
  }

  
  public static void sendInfo(String message) throws IOException {
    for (MyWebSocket item : webSocketSet) {
      try {
 item.sendMessage(message);
      } catch (IOException e) {
 continue;
      }
    }
  }

  public static synchronized int getonlineCount() {
    return onlineCount;
  }

  public static synchronized void addonlineCount() {
    MyWebSocket.onlineCount++;
  }

  public static synchronized void subonlineCount() {
    MyWebSocket.onlineCount--;
  }
}

使用springboot的唯一区别是要@Component声明下,而使用独立容器是由容器自己管理websocket的,但在springboot中连容器都是spring管理的。

虽然@Component默认是单例模式的,但springboot还是会为每个websocket连接初始化一个bean,所以可以用一个静态set保存起来。

3、前端代码




  My WebSocket



Welcome

4、总结

springboot已经做了深度的集成和优化,要注意是否添加了不需要的依赖、配置或声明。由于很多讲解组件使用的文章是和spring集成的,会有一些配置,在使用springboot时,由于springboot已经有了自己的配置,再这些配置有可能导致各种各样的异常。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持考高分网。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/147215.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号