springboot整合websocket最基礎入門使用教程詳解

項目最終的文件結構

1 添加maven依賴

 <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.12</version>
</dependency>

2 編寫配置類 WebSocketConfig

package cn.huawei.socket_test_1.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
 
@Component
public class WebSocketConfig {
 
  /**
   * ServerEndpointExporter 作用
   *
   * 這個Bean會自動註冊使用@ServerEndpoint註解聲明的websocket endpoint
   *
   * @return
   */
  @Bean
  public ServerEndpointExporter serverEndpointExporter() {
    return new ServerEndpointExporter();
  }
}

3 編寫核心業務類 WebSocket

package cn.huawei.socket_test_1.websock;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
 
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.ConcurrentHashMap;
 
/**
 * @ServerEndpoint 註解的作用
 *
 * @ServerEndpoint 註解是一個類層次的註解,它的功能主要是將目前的類定義成一個websocket服務器端,
 * 註解的值將被用於監聽用戶連接的終端訪問URL地址,客戶端可以通過這個URL來連接到WebSocket服務器端
 */
 
@Slf4j
@Component
@ServerEndpoint("/websocket/{name}")
public class WebSocket {
 
  /**
   * 與某個客戶端的連接對話,需要通過它來給客戶端發送消息
   */
  private Session session;
 
  /**
   * 標識當前連接客戶端的用戶名
   */
  private String name;
 
  /**
   * 用於存所有的連接服務的客戶端,這個對象存儲是安全的
   * 註意這裡的kv,設計的很巧妙,v剛好是本類 WebSocket (用來存放每個客戶端對應的MyWebSocket對象)
   */
  private static ConcurrentHashMap<String,WebSocket> webSocketSet = new ConcurrentHashMap<>();
 
 
  /**
   * 連接建立成功調用的方法
   * session為與某個客戶端的連接會話,需要通過它來給客戶端發送數據
   */
  @OnOpen
  public void OnOpen(Session session, @PathParam(value = "name") String name){
    log.info("----------------------------------");
    this.session = session;
    this.name = name;
    // name是用來表示唯一客戶端,如果需要指定發送,需要指定發送通過name來區分
    webSocketSet.put(name,this);
    log.info("[WebSocket] 連接成功,當前連接人數為:={}",webSocketSet.size());
    log.info("----------------------------------");
    log.info("");
 
    GroupSending(name+" 來瞭");
  }
 
  /**
   * 連接關閉調用的方法
   */
  @OnClose
  public void OnClose(){
    webSocketSet.remove(this.name);
    log.info("[WebSocket] 退出成功,當前連接人數為:={}",webSocketSet.size());
 
    GroupSending(name+" 走瞭");
  }
 
  /**
   * 收到客戶端消息後調用的方法
   */
  @OnMessage
  public void OnMessage(String message_str){
    log.info("[WebSocket] 收到消息:{}",message_str);
    //判斷是否需要指定發送,具體規則自定義
    //message_str的格式 TOUSER:user2;message:aaaaaaaaaaaaaaaaaa;
    if(message_str.indexOf("TOUSER") == 0){
      //取出 name和message的值
      String[] split = message_str.split(";");
      String[] split1 = split[0].split(":");
      String[] split2 = split[1].split(":");
      String name = split1[1];
      String message = split2[1];
      //指定發送
      AppointSending(name,message);
    }else{
      //群發
      GroupSending(message_str);
    }
  }
 
  /**
   * 發生錯誤時調用
   * @param session
   * @param error
   */
  @OnError
  public void onError(Session session, Throwable error){
    log.info("發生錯誤");
    error.printStackTrace();
  }
 
  /**
   * 群發
   * @param message
   */
  public void GroupSending(String message){
    for (String name : webSocketSet.keySet()){
      try {
        webSocketSet.get(name).session.getBasicRemote().sendText(message);
      }catch (Exception e){
        e.printStackTrace();
      }
    }
  }
 
  /**
   * 指定發送
   * @param name
   * @param message
   */
  public void AppointSending(String name,String message){
    try {
      webSocketSet.get(name).session.getBasicRemote().sendText(message);
    }catch (Exception e){
      e.printStackTrace();
    }
  }
}

4 因前端不熟悉,所以使用 http://coolaf.com/tool/chattest 在線測試
因代碼中 @ServerEndpoint(“/websocket/{name}”) 是這樣定義的,所以 通過下面的方式連接上去,測試群發和指定發送

因java代碼中這樣定義的消息,可以指定發送某個人,測試

到此這篇關於springboot整合websocket最基礎入門使用教程詳解的文章就介紹到這瞭,更多相關springboot整合websocket入門內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!