springboot項目中使用websocket做推送（簡單記錄一下）

使用websocket有兩種方式：1是使用sockjs，2是使用h5的標準。使用Html5標準自然更方便簡單，所以記錄的是配合h5的使用方法。

1、pom

核心是@ServerEndpoint這個註解。這個註解是Javaee標準裡的註解，tomcat7以上已經對其進行了實現，如果是用傳統方法使用tomcat發佈項目，只要在pom文件中引入javaee標準即可使用。

 
 javax
 javaee-api
 7.0
 provided
 

但使用springboot的內置tomcat時，就不需要引入javaee-api了，spring-boot已經包含了。使用springboot的websocket功能首先引入springboot組件。

 
 org.springframework.boot
 spring-boot-starter-websocket 

 1.3.5.RELEASE
 

順便說一句，springboot的高級組件會自動引用基礎的組件，像spring-boot-starter-websocket就引入了spring-boot-starter-web和spring-boot-starter，所以不要重複引入。

2、使用@ServerEndpoint創立websocket endpoint

首先要注入ServerEndpointExporter，這個bean會自動註冊使用了@ServerEndpoint註解聲明的Websocket endpoint。要注意，如果使用獨立的servlet容器，而不是直接使用springboot的內置容器，就不要注入ServerEndpointExporter，因為它將由容器自己提供和管理。

@Configuration
public class WebSocketConfig {
 @Bean
 public ServerEndpointExporter serverEndpointExporter() {
 return new ServerEndpointExporter();
 }
}

接下來就是寫websocket的具體實現類，很簡單，直接上代碼：

@ServerEndpoint(value = "/websocket")
@Component
public class MyWebSocket {
 //靜態變量，用來記錄當前在線連接數。應該把它設計成線程安全的。
 private static int onlineCount = 0;
 //concurrent包的線程安全Set，用來存放每個客戶端對應的MyWebSocket對象。
 private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet 
();
 //與某個客戶端的連接會話，需要通過它來給客戶端發送數據
 private Session session;
 /**
 * 連接建立成功調用的方法*/
 @OnOpen
 public void onOpen(Session session) {
 this.session = session;
 webSocketSet.add(this); //加入set中
 addOnlineCount(); //在線數加1
 System.out.println("有新連接加入！當前在線人數為" + getOnlineCount());
 try {
 sendMessage(CommonConstant.CURRENT_WANGING_NUMBER.toString());
 } catch (IOException e) {
 System.out.println("IO異常");
 }
 }
 /**
 * 連接關閉調用的方法
 */
 @OnClose
 public void onClose() {
 webSocketSet.remove(this); //從set中刪除
 subOnlineCount(); //在線數減1
 System.out.println("有一連接關閉！當前在線人數為" + getOnlineCount());
 }
 /**
 * 收到客戶端消息後調用的方法
 *
 * @param message 客戶端發送過來的消息*/
 @OnMessage
 public void onMessage(String message, Session session) {
 System.out.println("來自客戶端的消息:" + message);
 //群發消息
 for (MyWebSocket item : webSocketSet) {
 try {
 item.sendMessage(message);
 } catch (IOException e) { 

 e.printStackTrace();
 }
 }
 }
 /**
 * 發生錯誤時調用
 @OnError
 public void onError(Session session, Throwable error) {
 System.out.println("發生錯誤");
 error.printStackTrace();
 }
 public void sendMessage(String message) throws IOException {
 this.session.getBasicRemote().sendText(message);
 //this.session.getAsyncRemote().sendText(message);
 }
 /**
 * 群發自定義消息
 * */
 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的唯一區別是要@Component聲明下，而使用獨立容器是由容器自己管理websocket的，但在springboot中連容器都是spring管理的。

雖然@Component默認是單例模式的，但springboot還是會為每個websocket連接初始化一個bean，所以可以用一個靜態set保存起來。

3、前端代碼

 


Welcome

Send Close

4、總結

springboot已經做了深度的集成和優化，要注意是否添加了不需要的依賴、配置或聲明。由於很多講解組件使用的文章是和spring集成的，會有一些配置，在使用springboot時，由於springboot已經有了自己的配置，再這些配置有可能導致各種各樣的異常。

閱讀更多 程序員界的彭于晏 的文章

關鍵字: HTML5 推送 技術