碼上快樂

相關內容    簡體    繁體

Spring WebSocket教程（一）

本文轉載自   查看原文   2016-06-17 09:40   2260    webSocket

學習背景

很久以前就知道WebSocket，但那時不論是瀏覽器還是開發技術對它的支持都還很少。但是，Spring4突然發布，讓我眼前一亮，Spring4直接支持WebSocket。
對於Spring我還是很喜歡的，它讓Java Web開發相當的有藝術感，這次支持的WebSocket又特別的和我的胃口，所以馬上就去學習了。

前提

本文的內容，是建立在懂J2EE編程，使用過Spring，聽說過WebSocket上的，如果前面的3點大家不太明白，可以先去補補知識。
WebSocket還不是很普遍，對服務器和瀏覽器都有要求，不過使用了下面的一些技術，可以將瀏覽器的要求降低，但是服務器容器的要求還是比較高的，具體哪些服務器容易支持了WebSocket可以百度一下。

第一步：配置Spring

如果你跟我一樣采用的Maven，那么只需要將下面的幾個依賴，加入到pom.xml文件就可以了：
[html]  view plain  copy
 
  1. <properties>  
  2.     <spring.version>4.0.0.RELEASE</spring.version>  
  3. </properties>  
  4.   
  5. <dependencies>  
  6.     <!--spring MVC-->  
  7.     <dependency>  
  8.         <groupId>org.springframework</groupId>  
  9.         <artifactId>spring-core</artifactId>  
  10.         <version>${spring.version}</version>  
  11.     </dependency>  
  12.   
  13.     <dependency>  
  14.         <groupId>org.springframework</groupId>  
  15.         <artifactId>spring-web</artifactId>  
  16.         <version>${spring.version}</version>  
  17.     </dependency>  
  18.   
  19.     <dependency>  
  20.         <groupId>org.springframework</groupId>  
  21.         <artifactId>spring-webmvc</artifactId>  
  22.         <version>${spring.version}</version>  
  23.     </dependency>  
  24.   
  25.     <!-- jstl -->  
  26.     <dependency>  
  27.         <groupId>jstl</groupId>  
  28.         <artifactId>jstl</artifactId>  
  29.         <version>1.2</version>  
  30.     </dependency>  
  31.   
  32.     <!--spring測試框架-->  
  33.     <dependency>  
  34.         <groupId>org.springframework</groupId>  
  35.         <artifactId>spring-test</artifactId>  
  36.         <version>${spring.version}</version>  
  37.         <scope>test</scope>  
  38.     </dependency>  
  39.   
  40.     <!--spring數據庫操作庫-->  
  41.     <dependency>  
  42.         <groupId>org.springframework</groupId>  
  43.         <artifactId>spring-jdbc</artifactId>  
  44.         <version>${spring.version}</version>  
  45.     </dependency>  
  46.   
  47.     <dependency>  
  48.         <groupId>junit</groupId>  
  49.         <artifactId>junit</artifactId>  
  50.         <version>4.8.2</version>  
  51.         <scope>test</scope>  
  52.     </dependency>  
  53.   
  54.     <!--spring websocket庫-->  
  55.     <dependency>  
  56.         <groupId>org.springframework</groupId>  
  57.         <artifactId>spring-websocket</artifactId>  
  58.         <version>${spring.version}</version>  
  59.     </dependency>  
  60.     <dependency>  
  61.         <groupId>org.springframework</groupId>  
  62.         <artifactId>spring-messaging</artifactId>  
  63.         <version>${spring.version}</version>  
  64.     </dependency>  
  65.   
  66.     <!--jackson用於json操作-->  
  67.     <dependency>  
  68.         <groupId>com.fasterxml.jackson.core</groupId>  
  69.         <artifactId>jackson-databind</artifactId>  
  70.         <version>2.3.0</version>  
  71.     </dependency>  
  72.   
  73.     <dependency>  
  74.         <groupId>commons-fileupload</groupId>  
  75.         <artifactId>commons-fileupload</artifactId>  
  76.         <version>1.2.2</version>  
  77.     </dependency>  
  78.     <dependency>  
  79.         <groupId>commons-io</groupId>  
  80.         <artifactId>commons-io</artifactId>  
  81.         <version>2.2</version>  
  82.     </dependency>  
  83.     <!--使用阿里的連接池-->  
  84.     <dependency>  
  85.         <groupId>com.alibaba</groupId>  
  86.         <artifactId>druid</artifactId>  
  87.         <version>1.0.4</version>  
  88.     </dependency>  
  89.     <!--mysql connector-->  
  90.     <dependency>  
  91.         <groupId>mysql</groupId>  
  92.         <artifactId>mysql-connector-java</artifactId>  
  93.         <version>5.1.29</version>  
  94.     </dependency>  
  95.   
  96. </dependencies>  

Spring的配置我就不一一貼出來了，可以去github看，地址我會貼在下面。

第二步：配置WebSocket

我采用的是使用Configurer類和 Annotation來進行WebSocket配置。
首先要創建一個類，繼承WebSocketMessageBrokerConfigurer，並且在類上加上annotation：@Configuration和@EnableWebSocketMessageBroker。這樣，Spring就會將這個類當做配置類，並且打開WebSocket。
[java]  view plain  copy
 
  1. @Configuration  
  2. @EnableWebSocketMessageBroker  
  3. public class WebSocketConfig implements WebSocketMessageBrokerConfigurer{  
  4.     @Override  
  5.     public void registerStompEndpoints(StompEndpointRegistry registry) {  
  6.         //添加這個Endpoint，這樣在網頁中就可以通過websocket連接上服務了  
  7.         registry.addEndpoint("/coordination").withSockJS();  
  8.     }  
  9.   
  10.     @Override  
  11.     public void configureMessageBroker(MessageBrokerRegistry config) {  
  12.         System.out.println("服務器啟動成功");  
  13.         //這里設置的simple broker是指可以訂閱的地址，也就是服務器可以發送的地址  
  14.         /** 
  15.          * userChat 用於用戶聊天 
  16.          */  
  17.         config.enableSimpleBroker("/userChat");  
  18.         config.setApplicationDestinationPrefixes("/app");  
  19.     }  
  20.   
  21.     @Override  
  22.     public void configureClientInboundChannel(ChannelRegistration channelRegistration) {  
  23.     }  
  24.   
  25.     @Override  
  26.     public void configureClientOutboundChannel(ChannelRegistration channelRegistration) {  
  27.     }  
  28. }  

可以看到，在類中必須實現這四個方法。暫且只需要用到前兩個，所以我來介紹一下，前兩個方法中代碼的意義。
第一個方法，是registerStompEndpoints，大意就是注冊消息連接點（我自己的理解），所以我們進行了連接點的注冊：
[java]  view plain  copy
 
  1. registry.addEndpoint("/coordination").withSockJS();  
我們加了一個叫coordination的連接點，在網頁上我們就可以通過這個鏈接來和服務器的WebSocket連接了。但是后面還有一句withSockJs，這是什么呢？SockJs是一個WebSocket的通信js庫，Spring對這個js庫進行了后台的自動支持，也就是說，我們如果使用SockJs，那么我們就不需要對后台進行更多的配置，只需要加上這一句就可以了。
第二個方法，configureMessageBroker，大意是設置消息代理，也就是頁面上用js來訂閱的地址，也是我們服務器往WebSocket端接收js端發送消息的地址。
[java]  view plain  copy
 
  1. config.enableSimpleBroker("/userChat");  
  2. config.setApplicationDestinationPrefixes("/app");  
首先，定義了一個連接點叫userChat，從名字可以看的出，最后我會做一個聊天的例子。然后，設置了一個應用程序訪問地址的前綴，目的估計是為了和其他的普通請求區分開吧。也就是說，網頁上要發送消息到服務器上的地址是/app/userChat。
說了這么多地址，估計大家都繞暈了，因為項目的整個雛形還沒有出來，所以很混亂。所以接下來就配置js端。

第三步：配置Browser端

說了這么多地址，估計大家都繞暈了，因為項目的整個雛形還沒有出來，所以很混亂。所以接下來就配置js端。
首先我們要使用兩個js庫，一個是之前說過的SockJs，一個是stomp，這是一種通信協議，暫時不介紹它，只需要知道是一種更方便更安全的發送消息的庫就行了。
需要連接服務端的WebSocket：
[javascript]  view plain  copy
 
  1. var socket = new SockJS('/coordination');  
  2. var stompClient = Stomp.over(socket);  
  3. stompClient.connect('', '', function (frame) {});  
沒錯，就只需要兩句話。有了這三句話，我們就已經可以連接上了服務器。
使用SockJs還有一個好處，那就是對瀏覽器進行兼容，如果是IE11以下等對WebSocket支持不好的瀏覽器，SockJs會自動的將WebSocket降級到輪詢（這個不知道的可以去百度一下），之前也說了，Spring對SockJs也進行了支持，也就是說，如果之前加了withSockJs那句代碼，那么服務器也會自動的降級為輪詢。（怎么樣，是不是很興奮，Spring這個特性太讓人舒服了）
但是連接上了服務器，卻沒有進行任何的操作，所以下一步，我們要在服務器端撰寫響應和數據處理代碼，在Browser端撰寫消息發送和接收代碼。當然，這是下一篇的內容了。

結語

這是我的畢業設計，我的畢業設計是一個在線協同備課系統，其中包含了聊天這個小功能，所以使用它來講解一下Spring WebSocket的使用。
我將代碼放到了 github上，有興趣的朋友可以去看看代碼，因為涉及到了很多協同操作，所以代碼比較復雜，如果僅僅想了解Spring WebSocket的朋友，還是等我的下一篇文章吧。 大笑
github地址：https://github.com/xjyaikj/OnlinePreparation
 
轉自 http://blog.csdn.net/xjyzxx/article/details/24182677


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 Spring WebSocket教程（二） Spring-WebSocket 教程 Spring WebFlux 基礎教程：WebSocket 使用 WebSocket 教程 WebSocket 詳解教程 WebSocket 詳解教程 (掃盲)WebSocket 教程 spring boot集成Websocket spring-websocket的搭建 Spring消息之WebSocket
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM