1. 項(xiàng)目介紹
- 客戶端頁面index.html可以輸入消息鸥滨，點(diǎn)擊發(fā)送弦叶，通過ws協(xié)議發(fā)送到服務(wù)器端科盛；
- 服務(wù)器端收到客戶端消息后，廣播給各個(gè)客戶端壳快；
- 服務(wù)器端頁面server.html纸巷，可以輸入消息，點(diǎn)擊發(fā)送眶痰，通過ws雙工通信推送給客戶端瘤旨；
- 客戶端有顯示服務(wù)器端廣播消息的區(qū)域。
2. 項(xiàng)目目錄結(jié)構(gòu)
3. 項(xiàng)目代碼分析
3.1 pom.xml文件添加必要依賴
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--WebSocket-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>bootstrap</artifactId>
<version>3.3.7-1</version>
</dependency>
</dependencies>
3.2 .java代碼
- 新建WebSocket 的配置類WebSocketConfig.java
package com.springboot.websocket.websocket.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* WebSocket配置類
*
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
package com.springboot.websocket.websocket.config;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
/**
* WebSocket的服務(wù)端
* 因?yàn)閃ebSocket是類似客戶端服務(wù)端的形式(采用ws協(xié)議)竖伯，
* 那么這里的WebSocketServer其實(shí)就相當(dāng)于一個(gè)ws協(xié)議的Controller
* 直接@ServerEndpoint(“/websocket”)@Component啟用即可存哲，
* 然后在里面實(shí)現(xiàn)@OnOpen,@onClose,@onMessage等方法
*/
@ServerEndpoint("/websocket")
@Component
public class WebSocketServer {
//靜態(tài)變量因宇，用來記錄當(dāng)前在線連接數(shù)。應(yīng)該把它設(shè)計(jì)成線程安全的祟偷∮鸬眨可選的
private static int onlineCount = 0;
//concurrent包的線程安全Set，用來存放每個(gè)客戶端對(duì)應(yīng)的MyWebSocket對(duì)象肩袍。必須要有的
private static CopyOnWriteArraySet<WebSocketServer>
webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
//與某個(gè)客戶端的連接會(huì)話杭棵，需要通過它來給客戶端發(fā)送數(shù)據(jù)，必須
private Session session;
/**
* 連接建立成功調(diào)用的方法
*/
@OnOpen
public void onOpen(Session session) {
this.session = session;
webSocketSet.add(this); //加入set中
addOnlineCount(); //在線數(shù)加1
//一旦連接成功后就在控制臺(tái)打印信息
System.out.println("有新窗口開始監(jiān)聽,當(dāng)前在線人數(shù)為" + getOnlineCount());
try {
//往客戶端發(fā)送消息
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) {
//message 是從客戶端發(fā)送過來的消息魂爪，并在控制臺(tái)打印
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ā)生錯(cuò)誤");
error.printStackTrace();
}
/**
* 實(shí)現(xiàn)服務(wù)器主動(dòng)推送
*/
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--;
}
}
- WebSocketController.java 控制層代碼
package com.springboot.websocket.websocket.controller;
import com.springboot.websocket.websocket.config.WebSocketServer;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import java.io.IOException;
/**
* WebSocketController
*/
@Controller
@RequestMapping("/socket")
public class WebSocketController {
/**
* 輸入消息的頁面
* @return
*/
@GetMapping("/send")
public String sendMsg(){
return "server";
}
/**
* 推送數(shù)據(jù)接口
* @Param message
* @return
*/
@RequestMapping("/push")
public String pushMsg(@RequestParam("message")String message) {
try {
WebSocketServer.sendInfo(message);
} catch (IOException e) {
e.printStackTrace();
}
return "server";
}
}
3.3 html頁面代碼
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>WebSocket</title>
</head>
<body>
<h1>WebScoket練習(xí)</h1>
<label>
<input id="msg" type="text" name="message" style="width:215px;" />
<input type="submit" id="btn" />
</label>
<br>
<div>
<ul id="message_show_ul">
</ul>
</div>
<script language="JavaScript">
var send_message = document.getElementById("msg");
var sub_button = document.getElementById("btn");
var show_ul = document.getElementById("message_show_ul");
var socket;
if (typeof(WebSocket) == "undefined") {
console.log("您的瀏覽器不支持WebSocket");
} else {
console.log("您的瀏覽器支持WebSocket");
//實(shí)現(xiàn)化WebSocket對(duì)象，指定要連接的服務(wù)器地址與端口建立連接
socket = new WebSocket("ws://localhost:8088/websocket");
//打開事件
socket.onopen = function () {
console.log("Socket已打開");
sub_button.onclick = function () {
console.log(send_message);
//下面這句話是往服務(wù)器發(fā)送消息
socket.send("這是來自客戶端的消息:" + send_message.value);
};
};
//獲得消息事件艰管，從服務(wù)器獲得消息
socket.onmessage = function (msg) {
var li_eme = document.createElement("li");
li_eme.innerHTML = msg.data;
show_ul.appendChild(li_eme);
//控制臺(tái)打印消息
console.log(msg.data);
//彈出框彈出消息
// alert(msg.data);
};
//關(guān)閉事件
socket.onclose = function () {
console.log("Socket已關(guān)閉");
};
//發(fā)生了錯(cuò)誤事件
socket.onerror = function () {
alert("Socket發(fā)生了錯(cuò)誤");
}
}
</script>
</body>
</html>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>WebSocketServer</title>
</head>
<body>
<h1>服務(wù)器端</h1>
<form id="login" action="/socket/push" method="get">
<label>
<input id="msg" type="text" name="message" style="width:215px;" />
<input type="submit" id="btn"/>
</label>
<br>
</form>
</body>
</html>
