SpringBoot使用Socket向前端推送消息

个人资源与分享网站:http://xiaocaoshare.com/

1.对webSocket理解
WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工(full-duplex)通信——允许服务器主动发送信息给客户端。
2.使用webSocket好处
HTTP 协议有一个缺陷:通信只能由客户端发起,HTTP 协议做不到服务器主动向客户端推送信息。
3.SpringBoot2.0,在pom.xml加入以下依赖
<dependency>  
           <groupId>org.springframework.boot</groupId>  
           <artifactId>spring-boot-starter-websocket</artifactId>  
 </dependency> 
4.开启webSocket支持
在SpringBoot配置类配置Bean
@Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
5.WebSocketServer
@ServerEndpoint("/websocket")
@Component
@Slf4j
public class WebSocketServer {

    // 静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。
    private static int onlineCount = 0;
    // concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。
    private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();

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

    // 接收sid
    private String sid = "";

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        webSocketSet.add(this); // 加入set中
        addOnlineCount(); // 在线数加1
        log.info("有新连接加入!当前在线人数为:" + getOnlineCount());
        try {
            sendMessage("连接成功");
        } catch (IOException e) {
            log.error("websocket IO异常");
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this); // 从set中删除
        subOnlineCount(); // 在线数减1
        log.info("有一连接关闭!当前在线人数为" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message
     *            客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("来自客户端的消息:" + message);
        // 群发消息
        for (WebSocketServer item : webSocketSet) {
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    /**
     * 
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }

    /**
     * 实现服务器主动推送
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }

    /**
     * 群发自定义消息
     */
    public static void sendInfo(String message) throws IOException {

        for (WebSocketServer item : webSocketSet) {
            try {
                // 这里可以设定只推送给这个sid的,为null则全部推送

                item.sendMessage(message);
            } catch (IOException e) {
                continue;
            }
        }
    }

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

    public static synchronized void addOnlineCount() {
        WebSocketServer.onlineCount++;
    }

    public static synchronized void subOnlineCount() {
        WebSocketServer.onlineCount--;
    }

}

6.消息推送
写个控制器,调用WebSocketServer.sendInfo();
@RestController
public class SendMessageController {

    @RequestMapping("sendInfo")
    public String sendInfo(@RequestParam String msg) {
        try {
            WebSocketServer.sendInfo(msg);
        } catch (Exception e) {
            e.printStackTrace();
            return "信息发送异常!";
        }
        return "发送成功~";
    }
}

7.页面代码
<!DOCTYPE HTML>
  <html>
  <head>
      <title>WebSocket</title>
  </head>
  
  <body>
  <div style="width: 800px;height: 100%; margin: 0px auto;">
      <span style="color: coral; font-size: 22px;"> Welcome WebSocket</span><br/><br/>
     <div id="message">
     </div>
 </div>
 </body>
 
 <script type="text/javascript">
     var websocket = null;
     //判断当前浏览器是否支持WebSocket
     if('WebSocket' in window){
         websocket = new WebSocket("ws://localhost:8002/websocket");
     }else{
         alert('连接失败!!')
     }
 
     //连接发生错误的回调方法
     websocket.onerror = function(){
         setMessageInnerHTML("error");
     };
 
     //连接成功建立的回调方法
     websocket.onopen = function(event){
         setMessageInnerHTML("webSocket 连接成功~");
     }
 
     //接收到消息的回调方法
     websocket.onmessage = function(event){
         setMessageInnerHTML(event.data);
     }
 
     //连接关闭的回调方法
     websocket.onclose = function(){
         setMessageInnerHTML("close");
     }
 
     //监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,
     // 防止连接还没断开就关闭窗口,server端会抛异常。
     window.onbeforeunload = function(){
         websocket.close();
     }
 
     //将消息显示在网页上
     function setMessageInnerHTML(innerHTML){
         document.getElementById('message').innerHTML += innerHTML + '<br/>';
     }
 
     //关闭连接
     function closeWebSocket(){
        websocket.close();
     }
 
   </script>
 </html>

8.测试
1.建立2个连接,就是打开两个窗口,访问http://localhost:8002/websocket.html

2.后台向前端推送消息
新打开一个窗口,访问http://localhost:8002/sendInfo?msg=测试websocket

代码:https://github.com/xiaoyirang/SpringBootDemo

  • 0
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
实现登录的推送,可以借助SpringBootWebSocket技术来完成。下面是整合WebSocket的步骤: 1. 添加依赖 在pom.xml中添加SpringBootWebSocket依赖: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 2. 配置WebSocket 创建WebSocket配置类,并使用@EnableWebSocket注解开启WebSocket支持: ```java @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(chatWebSocketHandler(), "/chat").setAllowedOrigins("*"); } @Bean public WebSocketHandler chatWebSocketHandler() { return new ChatWebSocketHandler(); } } ``` 其中,ChatWebSocketHandler是自己实现的WebSocket处理器,用于处理WebSocket连接和消息的收发。 3. 实现WebSocket处理器 创建ChatWebSocketHandler类,并实现WebSocketHandler接口,重写onOpen、onClose和onMessage方法: ```java public class ChatWebSocketHandler implements WebSocketHandler { private static final List<WebSocketSession> sessions = new CopyOnWriteArrayList<>(); @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { sessions.add(session); session.sendMessage(new TextMessage("Connected")); } @Override public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception { // 处理消息 String username = (String) session.getAttributes().get("username"); String content = message.getPayload().toString(); sendMessage(username, content); } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { sessions.remove(session); session.sendMessage(new TextMessage("Disconnected")); } private void sendMessage(String username, String content) throws IOException { for (WebSocketSession session : sessions) { if (session.isOpen()) { session.sendMessage(new TextMessage(username + ": " + content)); } } } } ``` 该处理器包含一个sessions列表,用于存储所有连接到服务器的WebSocketSession对象。当有新的WebSocket连接时,将WebSocketSession对象添加到sessions列表中,并发送一条“Connected”消息。收到消息时,处理器会解析出发送该消息的用户和消息内容,并调用sendMessage方法将消息发送给所有连接的WebSocketSession对象。 4. 实现登录功能 在登录功能中,当用户输入用户名和密码,系统验证成功后,将用户名存储到WebSocketSession对象中,用于后续发送消息时标识用户身份。在登录成功后,向客户端发送一条“LoginSuccess”消息,客户端收到该消息后,在页面中显示聊天界面。 ```java @Controller public class LoginController { @Autowired private SimpMessagingTemplate messagingTemplate; @PostMapping("/login") public String login(@RequestParam String username, @RequestParam String password, HttpSession session) { // 验证用户名和密码 if (验证成功) { session.setAttribute("username", username); messagingTemplate.convertAndSendToUser(username, "/queue/message", "LoginSuccess"); return "chat"; } else { return "login"; } } } ``` 在ChatWebSocketHandler中,可以通过session.getAttributes().get("username")获取存储在WebSocketSession对象中的用户名,用于标识用户身份。 5. 实现消息推送 在客户端页面中,使用JavaScript连接WebSocket,并监听消息事件。当用户输入聊天内容并点击发送按钮时,将消息发送到服务器,服务器将收到的消息转发给所有连接的WebSocketSession对象,客户端收到消息后,在页面中显示该消息。 ```javascript var socket = new WebSocket('ws://' + window.location.host + '/chat'); socket.onopen = function(event) { // WebSocket连接成功 console.log('WebSocket connected.'); }; socket.onmessage = function(event) { // 收到消息 var message = event.data; if (message === 'LoginSuccess') { // 登录成功,显示聊天界面 $('#login').hide(); $('#chat').show(); } else { // 显示聊天内容 $('#content').append('<p>' + message + '</p>'); } }; $('#send').click(function() { // 发送消息 var content = $('#input').val(); socket.send(content); $('#input').val(''); }); ``` 以上就是使用SpringBoot整合WebSocket实现登录的推送的步骤。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值