13518219792
本文只作為個人筆記，大部分代碼是引用其他人的文章的。
成都創(chuàng)新互聯(lián)-成都網(wǎng)站建設(shè)公司，專注網(wǎng)站建設(shè)、成都網(wǎng)站建設(shè)、網(wǎng)站營銷推廣，域名注冊，虛擬空間，成都網(wǎng)站托管有關(guān)企業(yè)網(wǎng)站制作方案、改版、費(fèi)用等問題，請聯(lián)系成都創(chuàng)新互聯(lián)。
在springboot項(xiàng)目中使用websocket做推送，雖然挺簡單的，但初學(xué)也踩過幾個坑，特此記錄。
使用websocket有兩種方式：1是使用sockjs，2是使用h6的標(biāo)準(zhǔn)。使用Html5標(biāo)準(zhǔn)自然更方便簡單，所以記錄的是配合h6的使用方法。
1、pom
核心是@ServerEndpoint這個注解。這個注解是Javaee標(biāo)準(zhǔn)里的注解，tomcat7以上已經(jīng)對其進(jìn)行了實(shí)現(xiàn)，如果是用傳統(tǒng)方法使用tomcat發(fā)布項(xiàng)目，只要在pom文件中引入javaee標(biāo)準(zhǔn)即可使用。
javax javaee-api 7.0 provided
但使用springboot的內(nèi)置tomcat時，就不需要引入javaee-api了，spring-boot已經(jīng)包含了。使用springboot的websocket功能首先引入springboot組件。
org.springframework.boot spring-boot-starter-websocket 1.3.5.RELEASE
順便說一句，springboot的高級組件會自動引用基礎(chǔ)的組件，像spring-boot-starter-websocket就引入了spring-boot-starter-web和spring-boot-starter，所以不要重復(fù)引入。
2、使用@ServerEndpoint創(chuàng)立websocket endpoint
首先要注入ServerEndpointExporter，這個bean會自動注冊使用了@ServerEndpoint注解聲明的Websocket endpoint。要注意，如果使用獨(dú)立的servlet容器，而不是直接使用springboot的內(nèi)置容器，就不要注入ServerEndpointExporter，因?yàn)樗鼘⒂扇萜髯约禾峁┖凸芾怼?/p>
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
接下來就是寫websocket的具體實(shí)現(xiàn)類，很簡單，直接上代碼：
@ServerEndpoint(value = "/websocket")
@Component
public class MyWebSocket {
//靜態(tài)變量，用來記錄當(dāng)前在線連接數(shù)。應(yīng)該把它設(shè)計成線程安全的。
private static int onlineCount = 0;
//concurrent包的線程安全Set，用來存放每個客戶端對應(yīng)的MyWebSocket對象。
private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet();
//與某個客戶端的連接會話，需要通過它來給客戶端發(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("有新連接加入！當(dāng)前在線人數(shù)為" + getOnlineCount());
try {
sendMessage(CommonConstant.CURRENT_WANGING_NUMBER.toString());
} catch (IOException e) {
System.out.println("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 (MyWebSocket item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* 發(fā)生錯誤時調(diào)用
@OnError
public void onError(Session session, Throwable error) {
System.out.println("發(fā)生錯誤");
error.printStackTrace();
}
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
//this.session.getAsyncRemote().sendText(message);
}
/**
* 群發(fā)自定義消息
* */
public static void sendInfo(String message) throws IOException {
for (MyWebSocket item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
continue;
}
}
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
MyWebSocket.onlineCount++;
}
public static synchronized void subOnlineCount() {
MyWebSocket.onlineCount--;
}
}
使用springboot的唯一區(qū)別是要@Component聲明下，而使用獨(dú)立容器是由容器自己管理websocket的，但在springboot中連容器都是spring管理的。
雖然@Component默認(rèn)是單例模式的，但springboot還是會為每個websocket連接初始化一個bean，所以可以用一個靜態(tài)set保存起來。
3、前端代碼
My WebSocket Welcome
4、總結(jié)
springboot已經(jīng)做了深度的集成和優(yōu)化，要注意是否添加了不需要的依賴、配置或聲明。由于很多講解組件使用的文章是和spring集成的，會有一些配置，在使用springboot時，由于springboot已經(jīng)有了自己的配置，再這些配置有可能導(dǎo)致各種各樣的異常。
以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持創(chuàng)新互聯(lián)。
