SpringBoot2.0整合WebSocket代碼實例
這篇文章主要介紹了SpringBoot2.0整合WebSocket代碼實例,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下
之前公司的某個系統(tǒng)為了實現(xiàn)推送技術(shù)，所用的技術(shù)都是Ajax輪詢，這種方式瀏覽器需要不斷的向服務(wù)器發(fā)出請求，顯然這樣會浪費很多的帶寬等資源，所以研究了下WebSocket，本文將詳細(xì)介紹下。
一、什么是WebSocket？
WebSocket是HTML5開始提供的一種在單個TCP連接上進(jìn)行全雙工通訊的協(xié)議，能更好的節(jié)省服務(wù)器資源和帶寬，并且能夠更實時地進(jìn)行通訊。
WebSocket 使得客戶端和服務(wù)器之間的數(shù)據(jù)交換變得更加簡單，允許服務(wù)端主動向客戶端推送數(shù)據(jù)，在WebSocket API中，瀏覽器和服務(wù)器只需要完成一次握手，兩者之間就直接可以創(chuàng)建持久性的連接，并進(jìn)行雙向數(shù)據(jù)傳輸。
二、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對象
* 相當(dāng)于xml：
* <beans>
* <bean id="serverEndpointExporter" 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，這個類里監(jiān)聽連接的建立關(guān)閉、消息的接收等，具體代碼如下：
@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，用來存放每個客戶端對應(yīng)的Session對象。
private static CopyOnWriteArraySet<Session> SessionSet = new CopyOnWriteArraySet<Session>();
/**
* 連接建立成功調(diào)用的方法
*/
@OnOpen
public void onOpen(Session session) {
SessionSet.add(session);
int cnt = OnlineCount.incrementAndGet(); // 在線數(shù)加1
log.info("有連接加入，當(dāng)前連接數(shù)為：{}", cnt);
SendMessage(session, "連接成功");
}
/**
* 連接關(guān)閉調(diào)用的方法
*/
@OnClose
public void onClose(Session session) {
SessionSet.remove(session);
int cnt = OnlineCount.decrementAndGet();
log.info("有連接關(guān)閉，當(dāng)前連接數(shù)為：{}", cnt);
}
/**
* 收到客戶端消息后調(diào)用的方法
*
* @param message
* 客戶端發(fā)送過來的消息
*/
@OnMessage
public void onMessage(String message, Session session) {
log.info("來自客戶端的消息：{}",message);
SendMessage(session, "收到消息，消息內(nèi)容："+message);
}
/**
* 出現(xiàn)錯誤
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
log.error("發(fā)生錯誤：{}，Session ID： {}",error.getMessage(),session.getId());
error.printStackTrace();
}
/**
* 發(fā)送消息，實踐表明，每次瀏覽器刷新，session會發(fā)生變化。
* @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("發(fā)送消息出錯：{}", e.getMessage());
e.printStackTrace();
}
}
/**
* 群發(fā)消息
* @param message
* @throws IOException
*/
public static void BroadCastInfo(String message) throws IOException {
for (Session session : SessionSet) {
if(session.isOpen()){
SendMessage(session, message);
}
}
}
/**
* 指定Session發(fā)送消息
* @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);
}
}
}
新建一個html
目前大部分瀏覽器支持WebSocket，比如Chrome, Mozilla,Opera和Safari，在html頁面進(jìn)行websocket的連接建立、收消息的監(jiān)聽，頁面代碼如下：
<html>
<head>
<meta charset="UTF-8">
<title>websocket測試</title>
<script src="http://libs.baidu.com/jquery/2.0.0/jquery.min.js"></script>
<style type="text/css">
h3,h4{
text-align:center;
}
</style>
</head>
<body>
<h3>WebSocket測試，客戶端接收到的消息如下：</h3>
<textarea id = "messageId" readonly="readonly" cols="150" rows="30" >
</textarea>
<script type="text/javascript">
var socket;
if (typeof (WebSocket) == "undefined") {
console.log("遺憾：您的瀏覽器不支持WebSocket");
} else {
console.log("恭喜：您的瀏覽器支持WebSocket");
//實現(xiàn)化WebSocket對象
//指定要連接的服務(wù)器地址與端口建立連接
//注意ws、wss使用不同的端口。我使用自簽名的證書測試，
//無法使用wss，瀏覽器打開WebSocket時報錯
//ws對應(yīng)http、wss對應(yīng)https。
socket = new WebSocket("ws://localhost:8080/ws/asset");
//連接打開事件
socket.onopen = function() {
console.log("Socket 已打開");
socket.send("消息發(fā)送測試(From Client)");
};
//收到消息事件
socket.onmessage = function(msg) {
$("#messageId").append(msg.data+ "\n");
console.log(msg.data );
};
//連接關(guān)閉事件
socket.onclose = function() {
console.log("Socket已關(guān)閉");
};
//發(fā)生了錯誤事件
socket.onerror = function() {
alert("Socket發(fā)生了錯誤");
}
//窗口關(guān)閉時，關(guān)閉連接
window.unload=function() {
socket.close();
};
}
</script>
</body>
</html>
三、查看運行效果
啟動SpringBoot項目
打開首頁
本地瀏覽器打開首頁http://localhost:8080/，出現(xiàn)WebSocket測試頁面，同時后臺打印連接的日志。
有連接加入，當(dāng)前連接數(shù)為：1,sessionId=0
往客戶端發(fā)送消息
通過上面日志可以看到客戶端連接連接的sessionId，我測試時候sessionId是0，然后瀏覽器訪問下面接口即可往客戶端發(fā)送消息。
//參數(shù)說明： id：sessionID //參數(shù)說明： message：消息內(nèi)容 http://localhost:8080/api/ws/sendOne?id=0&message=你好Java碎碎念
發(fā)送消息動圖
到此SpringBoot整合WebSocket的功能已經(jīng)全部實現(xiàn)，有問題歡迎留言溝通哦！
完整源碼地址： https://github.com/suisui2019/springboot-study
以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
springboot dynamic多數(shù)據(jù)源demo以及常見切換、事務(wù)的問題
這篇文章主要介紹了springboot dynamic多數(shù)據(jù)源demo以及常見切換、事務(wù)的問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-07-07
java request.getHeader("user-agent")獲取瀏覽器信息的方法
這篇文章主要介紹了java request.getHeader("user-agent")獲取瀏覽器信息的方法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-03-03
這篇文章主要為大家詳細(xì)介紹了java文件上傳下載功能實現(xiàn)代碼，具有一定的參考價值，感興趣的朋友可以參考一下2016-06-06
Java 中的 BufferedWriter 介紹_動力節(jié)點Java學(xué)院整理
BufferedWriter 是緩沖字符輸出流。它繼承于Writer。接下來通過本文給大家分享Java 中的 BufferedWriter知識，需要的朋友參考下吧2017-05-05
這篇文章主要介紹了如何通過Java實現(xiàn)一個音頻工具類，可以實現(xiàn)生成一段自定義時長(精確到毫秒)的wav音頻。感興趣的小伙伴可以了解一下2022-01-01
大家好，本篇文章主要講的是Java雙重校驗鎖單例原理，感興趣的同學(xué)趕快來看一看吧，對你有幫助的話記得收藏一下2022-01-01
Apache?Commons?BeanUtils:?JavaBean操作方法
這篇文章主要介紹了Apache?Commons?BeanUtils:?JavaBean操作的藝術(shù),有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-12-12
這篇文章主要介紹了executor包語句處理功能，mybatis中支持三種語句類型，不同語句類型支持的變量符號不同，下文詳細(xì)內(nèi)容，需要的小伙伴可以參考一下2022-02-02
這篇文章主要介紹了SpringBoot中連接多個RabbitMQ的方法詳解,要實現(xiàn) SpringBoot 連接多個 RabbitMQ,只能自定義重寫一些東西,分別配置才可以,下面一起來走一下試試,需要的朋友可以參考下2023-10-10
二叉樹包含了根節(jié)點,孩子節(jié)點,葉節(jié)點,每一個二叉樹只有一個根節(jié)點,每一個結(jié)點最多只有兩個節(jié)點,左子樹的鍵值小于根的鍵值,右子樹的鍵值大于根的鍵值,下面這篇文章主要給大家介紹了關(guān)于如何在Java中實現(xiàn)二叉搜索樹的相關(guān)資料,需要的朋友可以參考下2023-02-02