WebSocket是一種在單個TCP連接上進行全雙工通信的協(xié)議僧家。WebSocket通信協(xié)議于2011年被IETF定為標(biāo)準(zhǔn)RFC 6455，并由RFC7936補充規(guī)范。WebSocket API也被W3C定為標(biāo)準(zhǔn)。
WebSocket使得客戶端和服務(wù)器之間的數(shù)據(jù)交換變得更加簡單，允許服務(wù)端主動向客戶端推送數(shù)據(jù)趋观。在WebSocket API中，瀏覽器和服務(wù)器只需要完成一次握手锋边，兩者之間就直接可以創(chuàng)建持久性的連接皱坛，并進行雙向數(shù)據(jù)傳輸。
- pom.xml添加依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
-
建文件夾
webscoket01.png - WebScoketConfig:WebSocket的配置類,開啟WebSocket支持
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* WebSocket的配置類
* 開啟了WebSocket支持
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
- WebScoketServer:客戶端向服務(wù)器端建立WebSocket連接的url
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
//客戶端向服務(wù)器端建立WebSocket連接的url
@ServerEndpoint("/websocket")
@Component
public class WebSocketServer {
//靜態(tài)變量豆巨，用來記錄當(dāng)前在線連接數(shù),可選
private static int onlineCount = 0;
//concurrent包的線程安全Set剩辟，用來存放每個客戶端對應(yīng)的MyWebSocket對象，必須
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet
= new CopyOnWriteArraySet<WebSocketServer>();
//與某個客戶端的連接會話往扔，需要通過它來給客戶端發(fā)送數(shù)據(jù),必須
private Session session;
/**
* 連接建立成功調(diào)用的方法
*/
@OnOpen
public void onOpen(Session session) {
this.session = session;
webSocketSet.add(this); //將客戶端加入set中
addOnlineCount(); //在線數(shù)加1
System.out.println("有新窗口開始監(jiān)聽,當(dāng)前在線人數(shù)為"
+ getOnlineCount());
try {
sendMessage("連接成功");
} catch (IOException e) {
System.out.println("WebSocket IO異常");
}
}
/**
* 連接關(guān)閉調(diào)用的方法
*/
@OnClose
public void onClose() {
webSocketSet.remove(this); //從set中刪除
subOnlineCount(); //在線數(shù)減1
System.out.println("有連接關(guān)閉贩猎！當(dāng)前在線人數(shù)為" + getOnlineCount());
}
/**
* 收到客戶端消息后調(diào)用的方法
*
* @param message 客戶端發(fā)送過來的消息
*/
@OnMessage
public void onMessage(String message, Session session) {
System.out.println("收到客戶端的信息:" + message);
//群發(fā)消息
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) {
System.out.println("發(fā)生錯誤");
error.printStackTrace();
}
/**
* 實現(xiàn)服務(wù)器主動推送
*/
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
/**
* 群發(fā)自定義消息
*/
public static void sendInfo(String message) throws IOException {
System.out.println("推送消息內(nèi)容:" + message);
for (WebSocketServer item : webSocketSet) {
try {
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--;
}
}
- WebScoketController類
import com.boot.websocket.config.WebSocketServer;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.IOException;
@RestController
public class WebSocketController {
//推送數(shù)據(jù)接口
@GetMapping("/socket/push")
public String pushMsg(String message) {
try {
WebSocketServer.sendInfo(message);
} catch (IOException e) {
e.printStackTrace();
}
return "success";
}
}
- 在Application添加@EnableSwagger2Doc注解
import com.spring4all.swagger.EnableSwagger2Doc;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@EnableSwagger2Doc
@SpringBootApplication
public class SpringBootWebsocketApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootWebsocketApplication.class, args);
}
}
- 前段代碼：
<html>
<head>
<meta charset="utf-8" />
<title>websocket示例</title>
<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
</head>
<body>
<div id="app">
<h3>消息顯示</h3>
<ul>
<li v-for="(message, index) in messages" :key="index">
{{message}}
</li>
</ul>
<hr>
<h3>發(fā)送消息 </h3>
<input type="text" v-model="sendMsg" />
<button type="button" @click="send">發(fā)送</button>
</div>
<script type="text/javascript">
var socket;
var app = new Vue({
el: '#app',
data: {
messages: [],
sendMsg: ''
},
created: function() {
var _this = this;
//創(chuàng)建WebSocket對象，指定要連接的服務(wù)器地址和端口萍膛，建立連接
socket = new WebSocket("ws://192.168.43.4:8080/websocket");
//打開連接
socket.onopen = function() {
console.log("Socket已打開");
};
//獲得服務(wù)端推送的消息
socket.onmessage = function(msg) {
console.log(msg.data);
_this.messages.push(msg.data);
console.log(_this.messages);
};
//關(guān)閉連接
socket.onclose = function() {
console.log("Socket已關(guān)閉");
};
//發(fā)送錯誤
socket.onerror = function() {
alert("Socket發(fā)生了錯誤");
}
},
watch: {
// 如果 `messages` 發(fā)生改變吭服，這個函數(shù)就會運行
messages: function(newMsg, oldMsg) {
this.messages = newMsg;
//新消息彈窗
var n =new Notification('您有新的消息',{
body:newMsg[newMsg.length - 1],
icon:"img/lufei04.jpg"
});
setTimeout(function(){
n.close();
},5000);//5秒自動關(guān)閉
},
},
methods: {
send: function() {
socket.send(this.sendMsg);
}
}
})
</script>
</body>
</html>
-
運行結(jié)果
webscoket02.png
webscoket03.png
