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

springboot整合websocket(1)

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

springboot整合websocket(1)

一、背景

  我们都知道http协议只能浏览器单方面向服务器发起请求获得响应,服务器不能主动向浏览器推送消息。想要实现浏览器的主动推送有两种主流实现方式:

  • 轮询:缺点很多,但是实现简单

  • websocket:在浏览器和服务器之间建立tcp连接,实现全双工通信

  springboot使用websocket有两种方式,一种是实现简单的websocket,另外一种是实现STOMP协议。这一篇实现简单的websocket,STOMP下一篇在讲。

注意:如下都是针对使用springboot内置容器

二、实现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。代码如下:

@Configurationpublic 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 Map webSocketMap = 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、客户的实现

  客户端使用h5原生websocket,部分浏览器可能不支持。代码如下:


    websocket测试
    
    测试
    
三、测试

  建立一个controller测试群发,代码如下:

@RestControllerpublic 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.h5websocket.MyWebSocket          : 新的连接加入:0

点击测试按钮,可在服务端看到如下输出:

2018-08-01 15:00:34.644  INFO 12708 --- [nio-8080-exec-6] com.fxb.h5websocket.MyWebSocket          : 收到客户端2消息:这是一个测试数据

再次打开html页面,这样就有两个websocket客户端,然后在浏览器访问localhost:8080/broadcast测试群发功能,每个客户端都会输出如下信息:

MessageEvent {isTrusted: true, data: "这是一条测试广播", origin: "ws://localhost:8080", lastEventId: "", source: null, …}



  源码可在github上下载,记得点赞,star哦

原文出处:https://www.cnblogs.com/wuyoucao/p/9404255.html

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

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

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