当前位置 主页 > 网站技术 > 代码类 >

    SpringBoot2.0整合WebSocket代码实例

    栏目:代码类 时间:2019-11-26 18:04

    这篇文章主要介绍了SpringBoot2.0整合WebSocket代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

    之前公司的某个系统为了实现推送技术,所用的技术都是Ajax轮询,这种方式浏览器需要不断的向服务器发出请求,显然这样会浪费很多的带宽等资源,所以研究了下WebSocket,本文将详细介绍下。

    一、什么是WebSocket?

    WebSocket是HTML5开始提供的一种在单个TCP连接上进行全双工通讯的协议,能更好的节省服务器资源和带宽,并且能够更实时地进行通讯。

    WebSocket 使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据,在WebSocket API中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输。

    二、SpringBoot整合WebSocket

    新建一个spring boot项目spring-boot-websocket,按照下面步骤操作。

    pom.xml引入jar包

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-websocket</artifactId>
    </dependency>

    新建WebSocket的配置类

    这个配置类检测带注解@ServerEndpoint的bean并注册它们,配置类代码如下:

    @Configuration
    public class WebSocketConfig {
      /**
       * 给spring容器注入这个ServerEndpointExporter对象
       * 相当于xml:
       * <beans>
       * <bean  class="org.springframework.web.socket.server.standard.ServerEndpointExporter"/>
       * </beans>
       * <p>
       * 检测所有带有@serverEndpoint注解的bean并注册他们。
       *
       * @return
       */
      @Bean
      public ServerEndpointExporter serverEndpointExporter() {
        System.out.println("我被注入了");
        return new ServerEndpointExporter();
      }
    }

    新建WebSocket的处理类

    这个处理类需要使用@ServerEndpoint,这个类里监听连接的建立关闭、消息的接收等,具体代码如下:

    @ServerEndpoint(value = "/ws/asset")
    @Component
    public class WebSocketServer {
    
      @PostConstruct
      public void init() {
        System.out.println("websocket 加载");
      }
      private static Logger log = LoggerFactory.getLogger(WebSocketServer.class);
      private static final AtomicInteger OnlineCount = new AtomicInteger(0);
      // concurrent包的线程安全Set,用来存放每个客户端对应的Session对象。
      private static CopyOnWriteArraySet<Session> SessionSet = new CopyOnWriteArraySet<Session>();
    
    
      /**
       * 连接建立成功调用的方法
       */
      @OnOpen
      public void onOpen(Session session) {
        SessionSet.add(session);
        int cnt = OnlineCount.incrementAndGet(); // 在线数加1
        log.info("有连接加入,当前连接数为:{}", cnt);
        SendMessage(session, "连接成功");
      }
    
      /**
       * 连接关闭调用的方法
       */
      @OnClose
      public void onClose(Session session) {
        SessionSet.remove(session);
        int cnt = OnlineCount.decrementAndGet();
        log.info("有连接关闭,当前连接数为:{}", cnt);
      }
    
      /**
       * 收到客户端消息后调用的方法
       *
       * @param message
       *      客户端发送过来的消息
       */
      @OnMessage
      public void onMessage(String message, Session session) {
        log.info("来自客户端的消息:{}",message);
        SendMessage(session, "收到消息,消息内容:"+message);
    
      }
    
      /**
       * 出现错误
       * @param session
       * @param error
       */
      @OnError
      public void onError(Session session, Throwable error) {
        log.error("发生错误:{},Session ID: {}",error.getMessage(),session.getId());
        error.printStackTrace();
      }
    
      /**
       * 发送消息,实践表明,每次浏览器刷新,session会发生变化。
       * @param session
       * @param message
       */
      public static void SendMessage(Session session, String message) {
        try {
    //      session.getBasicRemote().sendText(String.format("%s (From Server,Session ID=%s)",message,session.getId()));
          session.getBasicRemote().sendText(message);
        } catch (IOException e) {
          log.error("发送消息出错:{}", e.getMessage());
          e.printStackTrace();
        }
      }
    
      /**
       * 群发消息
       * @param message
       * @throws IOException
       */
      public static void BroadCastInfo(String message) throws IOException {
        for (Session session : SessionSet) {
          if(session.isOpen()){
            SendMessage(session, message);
          }
        }
      }
    
      /**
       * 指定Session发送消息
       * @param sessionId
       * @param message
       * @throws IOException
       */
      public static void SendMessage(String message,String sessionId) throws IOException {
        Session session = null;
        for (Session s : SessionSet) {
          if(s.getId().equals(sessionId)){
            session = s;
            break;
          }
        }
        if(session!=null){
          SendMessage(session, message);
        }
        else{
          log.warn("没有找到你指定ID的会话:{}",sessionId);
        }
      }
    }