springmvc(18)使用WebSocket 和 STOMP 实现消息功能
生活随笔
收集整理的這篇文章主要介紹了
springmvc(18)使用WebSocket 和 STOMP 实现消息功能
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
【0】README
1）本文旨在 介紹如何 利用 WebSocket 和 STOMP 實現消息功能；
2）要知道， WebSocket 是發送和接收消息的 底層API，而SockJS 是在 WebSocket 之上的 API；最后 STOMP（面向消息的簡單文本協議）是基于 SockJS 的高級API
（干貨——簡而言之，WebSocket 是底層協議，SockJS 是WebSocket 的備選方案，也是 底層協議，而 STOMP 是基于 WebSocket（SockJS） 的上層協議）
3）broker==經紀人，代理；
4）當然，你可以直接跳轉到 STOMP 知識（章節【3】）；
【1】WebSocket 1）intro：WebSocket 協議提供了 通過一個套接字實現全雙工通信的功能。也能夠實現 web ?瀏覽器 和 server 間的 異步通信， 全雙工意味著 server 與 瀏覽器間 可以發送和接收消息。
【1.1】使用 spring 的低層級 WebSocket API 1）intro：為了在 spring 中 使用較低層級的 API 來處理消息。有如下方案： scheme1）我們必須編寫一個實現 WebSocketHandler: public interface WebSocketHandler { void afterConnectionEstablished(WebSocketSession session) throws Exception; void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception; void handleTransportError(WebSocketSession session,Throwable exception) throws Exception; void afterConnectionClosed(WebSocketSession session,CloseStatus closeStatus) throws Exception; boolean supportsPartialMessages(); } scheme2）當然，我們也可以擴展 AbstractWebSocketHandler（更加簡單一點）； // you can also extends TextWebSocketHandler public class ChatTextHandler extends AbstractWebSocketHandler {// handle text msg.@Overrideprotected void handleTextMessage(WebSocketSession session,TextMessage message) throws Exception {session.sendMessage(new TextMessage("hello world."));} } 對以上代碼的分析（Analysis）： 當然了，我們還可以重載其他三個方法：? ?? handleBinaryMessage() handlePongMessage() handleTextMessage() scheme3）也可以擴展 TextWebSocketHandler（文本 WebSocket 處理器）， 不在擴展AbstractWebSocketHandler?，?TextWebSocketHandler 繼承?AbstractWebSocketHandler?；
2）你可能會關系建立和關閉連接感興趣?？梢灾剌d afterConnectionEstablished() and afterConnectionClosed(): // 當新連接建立的時候，被調用; public void afterConnectionEstablished(WebSocketSession session) throws Exception { logger.info("Connection established"); } // 當連接關閉時被調用； @Override public void afterConnectionClosed( WebSocketSession session, CloseStatus status) throws Exception { logger.info("Connection closed. Status: " + status); } 3）現在已經有了 message handler 類了，下面對其進行配置，配置到 springmvc 的運行環境中。 @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer{@Overridepublic void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {registry.addHandler(getTextHandler(), "/websocket/p2ptext");} // 將 ChatTextHandler 處理器 映射到 /websocket/p2ptext 路徑下.@Beanpublic ChatTextHandler getTextHandler() {return new ChatTextHandler();} } 對上述代碼的分析（Analysis）：registerWebSocketHandlers方法 是注冊消息處理器的關鍵： 通過 調用?WebSocketHandlerRegistry?.addHandler() 方法 來注冊信息處理器； Attention）server 端的 WebSocket 配置完畢，下面配置客戶端；
4）WebSocket 客戶端配置 4.1）client 發送 一個文本到 server，他監聽來自 server 的文本消息。下面代碼 展示了 利用 js 開啟一個原始的 WebSocket 并使用它來發送消息給server； 4.2）代碼如下： <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%> <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%><html lang="zh-CN"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- 上述3個meta標簽*必須*放在最前面，任何其他內容都*必須*跟隨其后！ --> <title>web socket</title><link href="<c:url value="/"/>bootstrap/css/bootstrap.min.css" rel="stylesheet"><!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> <script src="<c:url value="/"/>bootstrap/jquery/jquery.min.js"></script> <!-- Include all compiled plugins (below), or include individual files as needed --> <script src="<c:url value="/"/>bootstrap/js/bootstrap.min.js"></script><script type="text/javascript"> $(document).ready(function() { websocket_client(); });function websocket_client() { var hostaddr = window.location.host + "<c:url value='/websocket/p2ptext' />"; var url = 'ws://' + hostaddr; var sock = new WebSocket(url);// 以下的 open(), onmessage(), onclose() // 對應到 ChatTextHandler 的 // afterConnectionEstablished(), handleTextMessage(), afterConnectionClosed();sock.open = function() { alert("open successfully."); sayMarco(); };sock.onmessage = function(e) { alert("onmessage"); alert(e); };sock.onclose = function() { alert("close"); };function sayMarco() { sock.send("this is the websocket client."); } } </script> </head><body> <div id="websocket"> websocket div. </div> </body> </html> error）這樣配置后， WebSocket 無法正常運行；
【2】應對不支持 WebSocket 的場景（引入 SockJS） 1）problem+solutions： 1.1）problem：許多瀏覽器不支持 WebSocket 協議； 1.2）solutions：?SockJS 是 WebSocket 技術的一種模擬。SockJS 會 盡可能對應 WebSocket API，但如果 WebSocket 技術 不可用的話，就會選擇另外的 通信方式協議；
2）SockJS 會優先選擇 WebSocket 協議，但是如果 WebSocket協議不可用的話，他就會從如下 方案中挑選最優可行方案： XHR streaming XDR streaming iFrame event source iFrame HTML file XHR polling XDR polling iFrame XHR polling JSONP polling 3）如何在 server 端配置 SockJS ：添加?withSockJS() 方法； // 將 ChatTextHandler 映射到 /chat/text 路徑下.@Overridepublic void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {registry.addHandler(getTextHandler(), "/websocket/p2ptext").withSockJS(); // withSockJS() 方法聲明我們想要使用 SockJS 功能，如果WebSocket不可用的話，會使用 SockJS；}4）客戶端配置 SockJS， 想要確保 加載了 SockJS 客戶端； 4.1）具體做法是 依賴于 JavaScript 模塊加載器（如 require.js or curl.js） 還是簡單使用 <script> 標簽加載 JavaScript 庫。最簡單的方法是 使用 <script> 標簽從 SockJS CDN 中進行加載，如下所示： <script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script> Attention）用 WebJars 解析 Web資源（可選，有興趣的童鞋可以嘗試下） A1）在springmvc 配置中搭建一個 資源處理器，讓它負責解析路徑以 "webjars/**" 開頭的請求，這也是 WebJars 的標準路徑： @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars/"); } A2）在這個資源處理器 準備就緒后，我們可以在 web 頁面中使用 如下的 <script> 標簽加載 SockJS 庫； <script src="sockjs.min.js}"> </script> 5）處理加載 SockJS 客戶端庫以外，還要修改 兩行代碼： var url = 'p2ptext'; var sock = new SockJS(url); 對以上代碼的分析（Analysis）：? A1）SockJS 所處理的URL 是 "http://" 或 "https://" 模式，而不是 "ws://" or ?"wss://" ； A2）其他的函數如 onopen, onmessage, and ?onclose ，SockJS 客戶端與 WebSocket 一樣；
6）SockJS 為 WebSocket 提供了 備選方案。但無論哪種場景，對于實際應用來說，這種通信形式層級過低。下面看一下如何 在 WebSocket 之上使用 STOMP協議，來為瀏覽器 和 server間的 通信增加適當的消息語義；（干貨——引入 STOMP—— Simple Text Oriented Message Protocol——面向消息的簡單文本協議）
【3】使用 STOMP消息 1）intro： 如何理解 STOMP 與 WebSocket 的關系： 1.1）假設 HTTP 協議 并不存在，只能使用 TCP 套接字來 編寫 web 應用，你可能認為這是一件瘋狂的 事情； 1.2）不過 幸好，我們有 HTTP協議，它解決了 web 瀏覽器發起請求以及 web 服務器響應請求的細節； 1.3）直接使用 WebSocket（SockJS） 就很類似于 使用 TCP 套接字來編寫 web 應用；因為沒有高層協議，因此就需要我們定義應用間所發送消息的語義，還需要確保 連接的兩端都能遵循這些語義； 1.4）同 HTTP 在 TCP 套接字上添加 請求-響應 模型層一樣，STOMP 在 WebSocket 之上提供了一個基于 幀的線路格式層，用來定義消息語義；（干貨——STOMP 在 WebSocket 之上提供了一個基于 幀的線路格式層，用來定義消息語義） 2）STOMP 幀：該幀由命令，一個或多個 頭信息 以及 負載所組成。如下就是發送 數據的一個 STOMP幀：（干貨——引入了 STOMP幀格式） SEND destination:/app/marco content-length:20{\"message\":\"Marco!\"} 對以上代碼的分析（Analysis）：
A1）SEND：STOMP命令，表明會發送一些內容； A2）destination：頭信息，用來表示消息發送到哪里； A3）content-length：頭信息，用來表示 負載內容的 大小； A4）空行： A5）幀內容（負載）內容：
3）STOMP幀 信息 最有意思的是 destination頭信息了：?它表明 STOMP 是一個消息協議，類似于 JMS 或 AMQP。消息會發送到 某個 目的地，這個 目的地實際上可能真的 有消息代理作為 支撐。另一方面，消息處理器 也可以監聽這些目的地，接收所發送過來的消息；
【3.1】啟用STOMP 消息功能 1）intro：spring 的消息功能是基于消息代理構建的，因此我們必須要配置一個 消息代理 和 其他的一些消息目的地；（干貨——spring 的消息功能是基于消息代理構建的） 2）如下代碼展現了 如何通過 java配置 啟用基于代理的的web 消息功能； （干貨——@EnableWebSocketMessageBroker 注解的作用： 能夠在 WebSocket 上啟用 STOMP）
package com.spring.spittr.web;import org.springframework.context.annotation.Configuration; import org.springframework.messaging.handler.annotation.MessageMapping; import org.springframework.messaging.simp.config.MessageBrokerRegistry; import org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer; import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker; import org.springframework.web.socket.config.annotation.StompEndpointRegistry;@Configuration @EnableWebSocketMessageBroker public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {@Overridepublic void configureMessageBroker(MessageBrokerRegistry config) {config.enableSimpleBroker("/topic", "/queue");config.setApplicationDestinationPrefixes("/app");// 應用程序以 /app 為前綴，而 代理目的地以 /topic 為前綴.// js.url = "/spring13/app/hello" -> @MessageMapping("/hello") 注釋的方法.}@Overridepublic void registerStompEndpoints(StompEndpointRegistry registry) {registry.addEndpoint("/hello").withSockJS();// 在網頁上我們就可以通過這個鏈接 /server/hello ==<c:url value='/hello'></span> 來和服務器的WebSocket連接} } 對以上代碼的分析（Analysis）： A1）EnableWebSocketMessageBroker注解表明： 這個配置類不僅配置了 WebSocket，還配置了 基于代理的 STOMP 消息； A2）它重載了?registerStompEndpoints() 方法：將 "/hello" 路徑 注冊為 STOMP 端點。這個路徑與之前發送和接收消息的目的路徑有所不同， 這是一個端點，客戶端在訂閱或發布消息 到目的地址前，要連接該端點，即 用戶發送請求 url='/server/hello' 與 STOMP server 進行連接，之后再轉發到 訂閱url；（server== name of your springmvc project ）（干貨——端點的作用——客戶端在訂閱或發布消息 到目的地址前，要連接該端點） A3）它重載了 configureMessageBroker() 方法：配置了一個 簡單的消息代理。如果不重載，默認case下，會自動配置一個簡單的 內存消息代理，用來處理 "/topic" 為前綴的消息。但經過重載后，消息代理將會處理前綴為 "/topic" and "/queue" 消息。 A4）之外：發送應用程序的消息將會帶有 "/app" 前綴，下圖展現了 這個配置中的 消息流；
對上述處理step的分析（Analysis）： A1）應用程序的目的地 以 "/app" 為前綴，而代理的目的地以 "/topic" 和 "/queue" 作為前綴； A2）以應用程序為目的地的消息將會直接路由到 帶有 @MessageMapping 注解的控制器方法中；(干貨——?@MessageMapping的作用) A3）而發送到 代理上的消息，包括 @MessageMapping注解方法的返回值所形成的消息，將會路由到 代理上，并最終發送到 訂閱這些目的地客戶端； （干貨——client 連接地址和 發送地址是不同的，以本例為例，前者是/server/hello, 后者是/server/app/XX，先連接后發送）
【3.1.1】啟用 STOMP 代理中繼 1）intro：在生成環境下，可能會希望使用 真正支持 STOMP 的代理來支持 WebSocket 消息，如RabbitMQ 或 ActiveMQ。這樣的代理提供了可擴展性和健壯性更好的消息功能，當然，他們也支持 STOMP 命令； 2）如何 使用 STOMP 代理來替換內存代理，代碼如下： @Overridepublic void configureMessageBroker(MessageBrokerRegistry registry) {// 啟用了 STOMP 代理中繼功能，并將其代理目的地前綴設置為 /topic and /queue .registry.enableStompBrokerRelay("/queue", "/topic").setRelayPort(62623);registry.setApplicationDestinationPrefixes("/app"); // 應用程序目的地.} 對以上代碼的分析（Analysis）：（干貨——STOMP代理前綴和 應用程序前綴的意義） A1）方法第一行啟用了 STOMP 代理中繼功能： 并將其目的地前綴設置為 "/topic" or "/queue" ；spring就能知道 所有目的地前綴為 "/topic" or "/queue" 的消息都會發送到 STOMP 代理中； A2）方法第二行設置了 應用的前綴為 "app"：所有目的地以 "/app" 打頭的消息（發送消息url not 連接url）都會路由到 帶有 @MessageMapping 注解的方法中，而不會發布到 代理隊列或主題中； 3）下圖闡述了 代理中繼如何 應用于 spring 的 STOMP 消息處理之中。與 上圖的 關鍵區別在于： 這里不再模擬STOMP 代理的功能，而是由 代理中繼將消息傳送到一個 真正的消息代理來進行處理；
Attention） A1）enableStompBrokerRelay() and setApplicationDestinationPrefixes() 方法都可以接收變長 參數； A2）默認情況下： STOMP 代理中繼會假設 代理監聽 localhost 的61613 端口，并且 client 的 username 和password 均為 guest。當然你也可以自行定義； @Override public void configureMessageBroker(MessageBrokerRegistry registry) { registry.enableStompBrokerRelay("/topic", "/queue") .setRelayHost("rabbit.someotherserver") .setRelayPort(62623) .setClientLogin("marcopolo") .setClientPasscode("letmein01"); registry.setApplicationDestinationPrefixes("/app", "/foo"); } // setXXX()方法 是可選的 【3.2】 處理來自客戶端的 STOMP 消息 1）借助 @MessageMapping 注解能夠 在 控制器中處理 STOMP 消息
package com.spring.spittr.web;import org.springframework.messaging.handler.annotation.MessageMapping; import org.springframework.messaging.handler.annotation.SendTo; import org.springframework.stereotype.Controller;import com.spring.pojo.Greeting; import com.spring.pojo.HelloMessage;@Controller public class GreetingController {@MessageMapping("/hello")@SendTo("/topic/greetings")public Greeting greeting(HelloMessage message) throws Exception {System.out.println("receiving " + message.getName());System.out.println("connecting successfully.");return new Greeting("Hello, " + message.getName() + "!");} }對以上代碼的分析（Analysis）： A1）@MessageMapping注解：表示?handleShout()方法能夠處理 指定目的地上到達的消息； A2）這個目的地（消息發送目的地url）就是 "/server/app/hello"，其中 "/app" 是 隱含的 ,"/server" 是 springmvc 項目名稱；
2）因為我們現在處理的 不是 HTTP，所以無法使用 spring 的 HttpMessageConverter 實現 將負載轉換為Shout 對象。Spring 4.0 提供了幾個消息轉換器如下：（Attention， 如果是傳輸json數據的話，定要添加 Jackson jar 包到你的springmvc 項目中，不然連接不會成功的）
【3.2.1】處理訂閱（@SubscribeMapping注解） 1）@SubscribeMapping注解 的方法：當收到 STOMP 訂閱消息的時候，帶有 @SubscribeMapping 注解 的方法將會觸發；其也是通過 AnnotationMethodMessageHandler 來接收消息的； 2）@SubscribeMapping注解的應用場景：實現 請求-回應模式。在請求-回應模式中，客戶端訂閱一個目的地，然后預期在這個目的地上 獲得一個一次性的 響應；（干貨——引入了@SubsribeMapping注解實現 請求-回應模式） 2.1）看個荔枝： @SubscribeMapping({"/marco"}) public Shout handleSubscription() { Shout outgoing = new Shout(); outgoing.setMessage("Polo!"); return outgoing; } 對以上代碼的分析（Analysis）： A1）@SubscribeMapping注解 的方法來處理 對 "/app/macro" 目的地訂閱（與 @MessageMapping類似，"/app" 是隱含的 ）； A2）請求-回應模式與 HTTP GET 的全球-響應模式差不多： 關鍵區別在于， HTTP GET 請求是同步的，而訂閱的全球-回應模式是異步的，這樣客戶端能夠在回應可用時再去處理，而不必等待；（干貨——HTTP GET 請求是同步的，而訂閱的請求-回應模式是異步的）
【3.2.2】編寫 JavaScript 客戶端 1）intro：借助 STOMP 庫，通過 JavaScript發送消息
<script type="text/javascript">var stompClient = null;function setConnected(connected) {document.getElementById('connect').disabled = connected;document.getElementById('disconnect').disabled = !connected;document.getElementById('conversationDiv').style.visibility = connected ? 'visible' : 'hidden';document.getElementById('response').innerHTML = '';}function connect() {var socket = new SockJS("<c:url value='/hello'/>");stompClient = Stomp.over(socket);stompClient.connect({}, function(frame) {setConnected(true);console.log('Connected: ' + frame);stompClient.subscribe('/topic/greetings', function(greeting){showGreeting(JSON.parse(greeting.body).content);});});}function disconnect() {if (stompClient != null) {stompClient.disconnect();}setConnected(false);console.log("Disconnected");}function sendName() {var name = document.getElementById('name').value;stompClient.send("/app/hello", {}, JSON.stringify({ 'name': name }));}function showGreeting(message) {var response = document.getElementById('response');var p = document.createElement('p');p.style.wordWrap = 'break-word';p.appendChild(document.createTextNode(message));response.appendChild(p);}</script> 對以上代碼的 分析（Analysis）：?以上代碼連接“/hello” 端點并發送 ”name“； 2）stompClient.send("/app/hello", {}, JSON.stringify({'name':name}))： 第一個參數：json 負載消息發送的 目的地； 第二個參數：是一個頭信息的Map，它會包含在 STOMP 幀中；第三個參數：負載消息； （干貨—— stomp client 連接地址 和 發送地址不一樣的，連接地址為 <c:url value='/hello'/> ==localhost:8080/springmvc_project_name/hello , 而 發送地址為 '/app/hello'，這里要當心）
downloading these files below from?https://github.com/pacosonTang/SpringInAction/tree/master/spring18 <script src="<c:url value="/resources/sockjs-1.1.1.js" />"></script><script src="<c:url value="/resources/stomp.js" />"></script> //this line.function connect() {var socket = new SockJS("<c:url value='/hello'/>");stompClient = Stomp.over(socket);stompClient.connect({}, function(frame) {setConnected(true);console.log('Connected: ' + frame);stompClient.subscribe('/topic/greetings', function(greeting){showGreeting(JSON.parse(greeting.body).content);});stompClient.subscribe('/app/macro',function(greeting){alert(JSON.parse(greeting.body).content);showGreeting(JSON.parse(greeting.body).content);});});}function sendName() {var name = document.getElementById('name').value;stompClient.send("/app/hello", {}, JSON.stringify({ 'name': name }));}package com.spring.spittr.web;import org.springframework.beans.factory.annotation.Autowired; import org.springframework.messaging.handler.annotation.MessageMapping; import org.springframework.messaging.handler.annotation.SendTo; import org.springframework.messaging.simp.SimpMessageSendingOperations; import org.springframework.messaging.simp.SimpMessagingTemplate; import org.springframework.messaging.simp.annotation.SubscribeMapping; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestParam;import com.spring.pojo.Greeting; import com.spring.pojo.HelloMessage;@Controller public class GreetingController {// @MessageMapping defines the sending addr for client.// 消息發送地址: /server/app/hello@MessageMapping("/hello")@SendTo("/topic/greetings")public Greeting greeting(HelloMessage message) throws Exception {System.out.println("receiving " + message.getName());System.out.println("connecting successfully.");return new Greeting("Hello, " + message.getName() + "!");}@SubscribeMapping("/macro")public Greeting handleSubscription() {System.out.println("this is the @SubscribeMapping('/marco')");Greeting greeting = new Greeting("i am a msg from SubscribeMapping('/macro').");return greeting;}/*@MessageMapping("/feed")@SendTo("/topic/feed")public Greeting greetingForFeed(HelloMessage message) throws Exception {System.out.println("receiving " + message.getName());System.out.println("connecting successfully.");return new Greeting("i am /topic/feed, hello " + message.getName() + "!");}*/// private SimpMessagingTemplate template;// SimpMessagingTemplate implements SimpMessageSendingOperations. private SimpMessageSendingOperations template;@Autowiredpublic GreetingController(SimpMessageSendingOperations template) {this.template = template;}@RequestMapping(path="/feed", method=RequestMethod.POST)public void greet(@RequestParam String greeting) {String text = "you said just now " + greeting;this.template.convertAndSend("/topic/feed", text);} }package com.spring.spittr.web;import org.springframework.context.annotation.Configuration; import org.springframework.messaging.handler.annotation.MessageMapping; import org.springframework.messaging.simp.config.MessageBrokerRegistry; import org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer; import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker; import org.springframework.web.socket.config.annotation.StompEndpointRegistry;@Configuration @EnableWebSocketMessageBroker public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {@Overridepublic void configureMessageBroker(MessageBrokerRegistry config) {config.enableSimpleBroker("/topic", "/queue");config.setApplicationDestinationPrefixes("/app");// 應用程序以 /app 為前綴，而 代理目的地以 /topic 為前綴.// js.url = "/spring13/app/hello" -> @MessageMapping("/hello") 注釋的方法.}@Overridepublic void registerStompEndpoints(StompEndpointRegistry registry) {registry.addEndpoint("/hello").withSockJS();// 在網頁上我們就可以通過這個鏈接 /server/hello 來和服務器的WebSocket連接} } package com.spring.spittr.web;import java.io.IOException;import org.springframework.context.MessageSource; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; import org.springframework.context.support.ResourceBundleMessageSource; import org.springframework.core.io.FileSystemResource; import org.springframework.web.multipart.MultipartResolver; import org.springframework.web.multipart.commons.CommonsMultipartResolver; import org.springframework.web.servlet.ViewResolver; import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter; import org.springframework.web.servlet.view.InternalResourceViewResolver; import org.springframework.web.servlet.view.tiles3.TilesConfigurer; import org.springframework.web.servlet.view.tiles3.TilesViewResolver;@Configuration @ComponentScan(basePackages = { "com.spring.spittr.web" }) @EnableWebMvc @Import({WebSocketConfig.class}) public class WebConfig extends WebMvcConfigurerAdapter {@Beanpublic TilesConfigurer tilesConfigurer() {TilesConfigurer tiles = new TilesConfigurer();tiles.setDefinitions(new String[] { "/WEB-INF/layout/tiles.xml" });tiles.setCheckRefresh(true);return tiles;}// config processing for static resources.@Overridepublic void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {configurer.enable();}// InternalResourceViewResolver @Beanpublic ViewResolver viewResolver1() {TilesViewResolver resolver = new TilesViewResolver();return resolver;}@Beanpublic ViewResolver viewResolver2() {InternalResourceViewResolver resolver = new InternalResourceViewResolver();resolver.setPrefix("/WEB-INF/views/");resolver.setSuffix(".jsp");resolver.setExposeContextBeansAsAttributes(true);resolver.setViewClass(org.springframework.web.servlet.view.JstlView.class);return resolver;}@Beanpublic MessageSource messageSource() {ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();messageSource.setBasename("messages"); return messageSource;}@Beanpublic MultipartResolver multipartResolver() throws IOException {CommonsMultipartResolver multipartResolver = new CommonsMultipartResolver();multipartResolver.setUploadTempDir(new FileSystemResource("/WEB-INF/tmp/spittr/uploads"));multipartResolver.setMaxUploadSize(2097152);multipartResolver.setMaxInMemorySize(0);return multipartResolver;} } 【3.3】發送消息到客戶端 1）intro：spring提供了兩種 發送數據到 client 的方法： method1）作為處理消息 或處理訂閱的附帶結果； method2）使用消息模板；
【3.3.1】在處理消息后，發送消息（server 對 client 請求的 響應消息） 1）intro：如果你想要在接收消息的時候，在響應中發送一條消息，修改方法簽名 不是void 類型即可， 如下：
@MessageMapping("/hello")@SendTo("/topic/greetings") //highlight line.public Greeting greeting(HelloMessage message) throws Exception {System.out.println("receiving " + message.getName());System.out.println("connecting successfully.");return new Greeting("Hello, " + message.getName() + "!");}對以上代碼的分析（Analysis）：返回的對象將會進行轉換（通過消息轉換器） 并放到 STOMP 幀的負載中，然后發送給消息代理（消息代理分為 STOMP代理中繼 和 內存消息代理）； 2）默認情況下：幀所發往的目的地會與 觸發 處理器方法的目的地相同。所以返回的對象 會寫入到 STOMP 幀的負載中，并發布到 "/topic/stomp" 目的地。不過，可以通過 @SendTo 注解，重載目的地；（干貨——注解?@SendTo 注解的作用）
代碼同上。
對以上代碼的分析（Analysis）：消息將會發布到 /topic/hello， 所有訂閱這個主題的應用都會收到這條消息；
3）@SubscriptionMapping 注解標注的方式也能發送一條消息，作為訂閱的回應。 3.1）看個荔枝： 通過為 控制器添加如下的方法，當客戶端訂閱的時候，將會發送一條 shout 信息： @SubscribeMapping("/macro") // defined in Controller. attention for addr '/macro' in server.public Greeting handleSubscription() {System.out.println("this is the @SubscribeMapping('/marco')");Greeting greeting = new Greeting("i am a msg from SubscribeMapping('/macro').");return greeting;} function connect() {var socket = new SockJS("<c:url value='/hello'/>");stompClient = Stomp.over(socket);stompClient.connect({}, function(frame) {setConnected(true);console.log('Connected: ' + frame);stompClient.subscribe('/topic/greetings', function(greeting){showGreeting(JSON.parse(greeting.body).content);});// starting line.stompClient.subscribe('/app/macro',function(greeting){alert(JSON.parse(greeting.body).content);showGreeting(JSON.parse(greeting.body).content);}); // ending line. attention for addr '/app/macro' in client.});} 對以上代碼的分析（Analysis）：? A0）這個SubscribeMapping annotation標記的方法，是在訂閱的時候調用的，也就是說，基本是只執行一次的方法，client 調用定義在server 的 該 Annotation 標注的方法，它就會返回結果，不過經過代理。 A1）這里的?@SubscribeMapping 注解表明當 客戶端訂閱 "/app/macro" 主題的時候（"/app"是應用目的地的前綴，注意，這里沒有加springmvc 項目名稱前綴）， 將會調用?handleSubscription 方法。它所返回的shout 對象 將會進行轉換 并發送回client； A2）SubscribeMapping注解的區別在于： 這里的 Shout 消息將會直接發送給 client，不用經過 消息代理；但，如果為方法添加 @SendTo 注解的話，那么 消息將會發送到指定的目的地，這樣就會經過代理；（干貨——SubscribeMapping注解返回的消息直接發送到 client，不經過代理，而 @SendTo 注解的路徑，就會經過代理，然后再發送到 目的地）
【3.3.2】 在應用的任意地方發送消息 1）intro：spring 的 SimpMessagingTemplate 能夠在應用的任何地方發送消息，不必以接收一條消息為 前提； 2）看個荔枝： 讓首頁訂閱一個 STOMP主題，在 Spittle 創建的時候，該主題能夠收到 Spittle 更新時的 feed； 2.1）JavaScript 代碼： <script> var sock = new SockJS('spittr'); var stomp = Stomp.over(sock); stomp.connect('guest', 'guest', function(frame) { console.log('Connected'); stomp.subscribe("/topic/spittlefeed", handleSpittle); // highlight. }); function handleSpittle(incoming) { var spittle = JSON.parse(incoming.body); console.log('Received: ', spittle); var source = $("#spittle-template").html(); var template = Handlebars.compile(source); var spittleHtml = template(spittle); $('.spittleList').prepend(spittleHtml); } </script> 對以上代碼的分析（Analysis）：?在連接到 STMOP 代理后，我們訂閱了 "/topic/spittlefeed" 主題，并指定當消息到達的是，由?handleSpittle()函數來處理 Spittle 更新。 2.2） server 端代碼：使用 SimpMessagingTemplate 將所有新創建的 Spittle 以消息的形式發布到 "/topic/feed" 主題上； @Service public class SpittleFeedServiceImpl implements SpittleFeedService { private SimpMessageSendingOperations messaging; @Autowired public SpittleFeedServiceImpl( SimpMessageSendingOperations messaging) { // 注入消息模板. this.messaging = messaging; } public void broadcastSpittle(Spittle spittle) { messaging.convertAndSend("/topic/spittlefeed", spittle); // 發送消息. } } 對以上代碼的分析（Analysis）：? A1）配置 spring 支持 stomp 的一個附帶功能是 在spring應用上下文中已經包含了 Simple A2）在發布消息給 STOMP 主題的時候，所有訂閱該主題的客戶端都會收到消息。但有的時候，我們希望將消息發送給指定用戶；
【4】 為目標用戶發送消息 1）intro：在使用 srping 和 STOMP 消息功能的時候，有三種方式來利用認證用戶： way1）@MessageMapping and @SubscribeMapping 注解標注的方法 能夠使用 Principal 來獲取認證用戶； way2）@MessageMapping, @SubscribeMapping, and @MessageException 方法返回的值能夠以 消息的形式發送給 認證用戶； way3）SimpMessagingTemplate 能夠發送消息給特定用戶；
【4.1】在控制器中處理用戶的 消息 1）看個荔枝： 編寫一個控制器方法，根據傳入的消息創建新的Spittle 對象，并發送一個回應，表明 對象創建成功；（這種 REST也可以實現，不過它是同步的，而這里是異步的）； 1.1）代碼如下：它會處理傳入的消息并將其存儲我 Spittle： @MessageMapping("/spittle") @SendToUser("/queue/notifications") public Notification handleSpittle( Principal principal, SpittleForm form) { Spittle spittle = new Spittle( principal.getName(), form.getText(), new Date()); spittleRepo.save(spittle); return new Notification("Saved Spittle"); } 1.2）該方法最后返回一個 新的 Notificatino，表明對象保存成功； 1.3）該方法使用了?@MessageMapping("/spittle") 注解，所以當有發往 "/app/spittle" 目的地的消息 到達時，該方法就會觸發；如果用戶已經認證的話，將會根據 STOMP 幀上的頭信息得到 Principal 對象； 1.4）@SendToUser注解： 指定了 Notification 要發送的 目的地?"/queue/notifications"； 1.5）表明上，?"/queue/notifications" 并不會與 特定用戶相關聯，但因為 這里使用的是?@SendToUser注解， 而不是?@SendTo，所以 就會發生更多的事情了； 2）看一下針對 控制器方法發布的 Notificatino 對象的目的地，客戶端該如何進行訂閱。 2.1）看個荔枝：考慮如下的 JavaScript代碼，它訂閱了一個 用戶特定的 目的地： stomp.subscribe("/user/queue/notifications", handleNotifications); 對以上代碼的分析（Analysis）：這個目的地使用了 "/user" 作為前綴，在內部，以"/user" 為前綴的消息將會通過 UserDestinationMessageHandler 進行處理，而不是 AnnotationMethodMessageHandler 或 ?SimpleBrokerMessageHandler or StompBrokerRelayMessageHandler，如下圖所示：
Attention）UserDestinationMessageHandler?的主要任務： 是 將用戶消息重新路由到 某個用戶獨有的目的地上。 在處理訂閱的時候，它會將目標地址中的 "/user" 前綴去掉，并基于用戶 的會話添加一個后綴。如，對 ?"/user/queue/notifications" 的訂閱最后可能路由到 名為 "/queue/notifacations-user65a4sdfa" 目的地上；
【4.2】為指定用戶發送消息 1）intro：SimpMessagingTemplate還提供了 convertAndSendToUser() 方法，該方法能夠讓 我們給特定用戶發送消息； 2）我們在 web 應用上添加一個特性： 當其他用戶提交的 Spittle 提到某個用戶時，將會提醒該用戶（干貨——這難道不是 微博的 @ 功能嗎） 2.1）看個荔枝：如果Spittle 文本中包含 "@tangrong"，那么我們就應該發送一條消息給 使用?tangrong 用戶名登錄的client，代碼實例如下： @Service public class SpittleFeedServiceImpl implements SpittleFeedService { private SimpMessagingTemplate messaging; // 實現用戶提及功能的正則表達式 private Pattern pattern = Pattern.compile("\\@(\\S+)"); @Autowired public SpittleFeedServiceImpl(SimpMessagingTemplate messaging) { this.messaging = messaging; } public void broadcastSpittle(Spittle spittle) { messaging.convertAndSend("/topic/spittlefeed", spittle); Matcher matcher = pattern.matcher(spittle.getMessage()); if (matcher.find()) { String username = matcher.group(1); // 發送提醒給用戶. messaging.convertAndSendToUser( username, "/queue/notifications", new Notification("You just got mentioned!")); } } } 【5】處理消息異常 1）intro：我們也可以在 控制器方法上添加 @MessageExceptionHandler 注解，讓它來處理 @MessageMapping 方法所拋出的異常； 2）看個荔枝：它會處理 消息方法所拋出的異常； @MessageExceptionHandler public void handleExceptions(Throwable t) { logger.error("Error handling message: " + t.getMessage()); } 3）我們也可以以 參數的形式聲明它所能處理的異常； @MessageExceptionHandler(SpittleException.class) // highlight line. public void handleExceptions(Throwable t) { logger.error("Error handling message: " + t.getMessage()); } // 或者： @MessageExceptionHandler( {SpittleException.class, DatabaseException.class}) // highlight line. public void handleExceptions(Throwable t) { logger.error("Error handling message: " + t.getMessage()); } 4）該方法還可以回應一個錯誤： @MessageExceptionHandler(SpittleException.class) @SendToUser("/queue/errors") public SpittleException handleExceptions(SpittleException e) { logger.error("Error handling message: " + e.getMessage()); return e; } // 如果拋出 SpittleException 的話，將會記錄這個異常，并將其返回. // 而 UserDestinationMessageHandler 會重新路由這個消息到特定用戶所對應的 唯一路徑；
【1】WebSocket 1）intro：WebSocket 協議提供了 通過一個套接字實現全雙工通信的功能。也能夠實現 web ?瀏覽器 和 server 間的 異步通信， 全雙工意味著 server 與 瀏覽器間 可以發送和接收消息。
【1.1】使用 spring 的低層級 WebSocket API 1）intro：為了在 spring 中 使用較低層級的 API 來處理消息。有如下方案： scheme1）我們必須編寫一個實現 WebSocketHandler: public interface WebSocketHandler { void afterConnectionEstablished(WebSocketSession session) throws Exception; void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception; void handleTransportError(WebSocketSession session,Throwable exception) throws Exception; void afterConnectionClosed(WebSocketSession session,CloseStatus closeStatus) throws Exception; boolean supportsPartialMessages(); } scheme2）當然，我們也可以擴展 AbstractWebSocketHandler（更加簡單一點）； // you can also extends TextWebSocketHandler public class ChatTextHandler extends AbstractWebSocketHandler {// handle text msg.@Overrideprotected void handleTextMessage(WebSocketSession session,TextMessage message) throws Exception {session.sendMessage(new TextMessage("hello world."));} } 對以上代碼的分析（Analysis）： 當然了，我們還可以重載其他三個方法：? ?? handleBinaryMessage() handlePongMessage() handleTextMessage() scheme3）也可以擴展 TextWebSocketHandler（文本 WebSocket 處理器）， 不在擴展AbstractWebSocketHandler?，?TextWebSocketHandler 繼承?AbstractWebSocketHandler?；
2）你可能會關系建立和關閉連接感興趣?？梢灾剌d afterConnectionEstablished() and afterConnectionClosed(): // 當新連接建立的時候，被調用; public void afterConnectionEstablished(WebSocketSession session) throws Exception { logger.info("Connection established"); } // 當連接關閉時被調用； @Override public void afterConnectionClosed( WebSocketSession session, CloseStatus status) throws Exception { logger.info("Connection closed. Status: " + status); } 3）現在已經有了 message handler 類了，下面對其進行配置，配置到 springmvc 的運行環境中。 @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer{@Overridepublic void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {registry.addHandler(getTextHandler(), "/websocket/p2ptext");} // 將 ChatTextHandler 處理器 映射到 /websocket/p2ptext 路徑下.@Beanpublic ChatTextHandler getTextHandler() {return new ChatTextHandler();} } 對上述代碼的分析（Analysis）：registerWebSocketHandlers方法 是注冊消息處理器的關鍵： 通過 調用?WebSocketHandlerRegistry?.addHandler() 方法 來注冊信息處理器； Attention）server 端的 WebSocket 配置完畢，下面配置客戶端；
4）WebSocket 客戶端配置 4.1）client 發送 一個文本到 server，他監聽來自 server 的文本消息。下面代碼 展示了 利用 js 開啟一個原始的 WebSocket 并使用它來發送消息給server； 4.2）代碼如下： <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%> <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%><html lang="zh-CN"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- 上述3個meta標簽*必須*放在最前面，任何其他內容都*必須*跟隨其后！ --> <title>web socket</title><link href="<c:url value="/"/>bootstrap/css/bootstrap.min.css" rel="stylesheet"><!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> <script src="<c:url value="/"/>bootstrap/jquery/jquery.min.js"></script> <!-- Include all compiled plugins (below), or include individual files as needed --> <script src="<c:url value="/"/>bootstrap/js/bootstrap.min.js"></script><script type="text/javascript"> $(document).ready(function() { websocket_client(); });function websocket_client() { var hostaddr = window.location.host + "<c:url value='/websocket/p2ptext' />"; var url = 'ws://' + hostaddr; var sock = new WebSocket(url);// 以下的 open(), onmessage(), onclose() // 對應到 ChatTextHandler 的 // afterConnectionEstablished(), handleTextMessage(), afterConnectionClosed();sock.open = function() { alert("open successfully."); sayMarco(); };sock.onmessage = function(e) { alert("onmessage"); alert(e); };sock.onclose = function() { alert("close"); };function sayMarco() { sock.send("this is the websocket client."); } } </script> </head><body> <div id="websocket"> websocket div. </div> </body> </html> error）這樣配置后， WebSocket 無法正常運行；
【2】應對不支持 WebSocket 的場景（引入 SockJS） 1）problem+solutions： 1.1）problem：許多瀏覽器不支持 WebSocket 協議； 1.2）solutions：?SockJS 是 WebSocket 技術的一種模擬。SockJS 會 盡可能對應 WebSocket API，但如果 WebSocket 技術 不可用的話，就會選擇另外的 通信方式協議；
2）SockJS 會優先選擇 WebSocket 協議，但是如果 WebSocket協議不可用的話，他就會從如下 方案中挑選最優可行方案： XHR streaming XDR streaming iFrame event source iFrame HTML file XHR polling XDR polling iFrame XHR polling JSONP polling 3）如何在 server 端配置 SockJS ：添加?withSockJS() 方法； // 將 ChatTextHandler 映射到 /chat/text 路徑下.@Overridepublic void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {registry.addHandler(getTextHandler(), "/websocket/p2ptext").withSockJS(); // withSockJS() 方法聲明我們想要使用 SockJS 功能，如果WebSocket不可用的話，會使用 SockJS；}4）客戶端配置 SockJS， 想要確保 加載了 SockJS 客戶端； 4.1）具體做法是 依賴于 JavaScript 模塊加載器（如 require.js or curl.js） 還是簡單使用 <script> 標簽加載 JavaScript 庫。最簡單的方法是 使用 <script> 標簽從 SockJS CDN 中進行加載，如下所示： <script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script> Attention）用 WebJars 解析 Web資源（可選，有興趣的童鞋可以嘗試下） A1）在springmvc 配置中搭建一個 資源處理器，讓它負責解析路徑以 "webjars/**" 開頭的請求，這也是 WebJars 的標準路徑： @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars/"); } A2）在這個資源處理器 準備就緒后，我們可以在 web 頁面中使用 如下的 <script> 標簽加載 SockJS 庫； <script src="sockjs.min.js}"> </script> 5）處理加載 SockJS 客戶端庫以外，還要修改 兩行代碼： var url = 'p2ptext'; var sock = new SockJS(url); 對以上代碼的分析（Analysis）：? A1）SockJS 所處理的URL 是 "http://" 或 "https://" 模式，而不是 "ws://" or ?"wss://" ； A2）其他的函數如 onopen, onmessage, and ?onclose ，SockJS 客戶端與 WebSocket 一樣；
6）SockJS 為 WebSocket 提供了 備選方案。但無論哪種場景，對于實際應用來說，這種通信形式層級過低。下面看一下如何 在 WebSocket 之上使用 STOMP協議，來為瀏覽器 和 server間的 通信增加適當的消息語義；（干貨——引入 STOMP—— Simple Text Oriented Message Protocol——面向消息的簡單文本協議）
【3】使用 STOMP消息 1）intro： 如何理解 STOMP 與 WebSocket 的關系： 1.1）假設 HTTP 協議 并不存在，只能使用 TCP 套接字來 編寫 web 應用，你可能認為這是一件瘋狂的 事情； 1.2）不過 幸好，我們有 HTTP協議，它解決了 web 瀏覽器發起請求以及 web 服務器響應請求的細節； 1.3）直接使用 WebSocket（SockJS） 就很類似于 使用 TCP 套接字來編寫 web 應用；因為沒有高層協議，因此就需要我們定義應用間所發送消息的語義，還需要確保 連接的兩端都能遵循這些語義； 1.4）同 HTTP 在 TCP 套接字上添加 請求-響應 模型層一樣，STOMP 在 WebSocket 之上提供了一個基于 幀的線路格式層，用來定義消息語義；（干貨——STOMP 在 WebSocket 之上提供了一個基于 幀的線路格式層，用來定義消息語義） 2）STOMP 幀：該幀由命令，一個或多個 頭信息 以及 負載所組成。如下就是發送 數據的一個 STOMP幀：（干貨——引入了 STOMP幀格式） SEND destination:/app/marco content-length:20{\"message\":\"Marco!\"} 對以上代碼的分析（Analysis）：
A1）SEND：STOMP命令，表明會發送一些內容； A2）destination：頭信息，用來表示消息發送到哪里； A3）content-length：頭信息，用來表示 負載內容的 大小； A4）空行： A5）幀內容（負載）內容：
3）STOMP幀 信息 最有意思的是 destination頭信息了：?它表明 STOMP 是一個消息協議，類似于 JMS 或 AMQP。消息會發送到 某個 目的地，這個 目的地實際上可能真的 有消息代理作為 支撐。另一方面，消息處理器 也可以監聽這些目的地，接收所發送過來的消息；
【3.1】啟用STOMP 消息功能 1）intro：spring 的消息功能是基于消息代理構建的，因此我們必須要配置一個 消息代理 和 其他的一些消息目的地；（干貨——spring 的消息功能是基于消息代理構建的） 2）如下代碼展現了 如何通過 java配置 啟用基于代理的的web 消息功能； （干貨——@EnableWebSocketMessageBroker 注解的作用： 能夠在 WebSocket 上啟用 STOMP）
package com.spring.spittr.web;import org.springframework.context.annotation.Configuration; import org.springframework.messaging.handler.annotation.MessageMapping; import org.springframework.messaging.simp.config.MessageBrokerRegistry; import org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer; import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker; import org.springframework.web.socket.config.annotation.StompEndpointRegistry;@Configuration @EnableWebSocketMessageBroker public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {@Overridepublic void configureMessageBroker(MessageBrokerRegistry config) {config.enableSimpleBroker("/topic", "/queue");config.setApplicationDestinationPrefixes("/app");// 應用程序以 /app 為前綴，而 代理目的地以 /topic 為前綴.// js.url = "/spring13/app/hello" -> @MessageMapping("/hello") 注釋的方法.}@Overridepublic void registerStompEndpoints(StompEndpointRegistry registry) {registry.addEndpoint("/hello").withSockJS();// 在網頁上我們就可以通過這個鏈接 /server/hello ==<c:url value='/hello'></span> 來和服務器的WebSocket連接} } 對以上代碼的分析（Analysis）： A1）EnableWebSocketMessageBroker注解表明： 這個配置類不僅配置了 WebSocket，還配置了 基于代理的 STOMP 消息； A2）它重載了?registerStompEndpoints() 方法：將 "/hello" 路徑 注冊為 STOMP 端點。這個路徑與之前發送和接收消息的目的路徑有所不同， 這是一個端點，客戶端在訂閱或發布消息 到目的地址前，要連接該端點，即 用戶發送請求 url='/server/hello' 與 STOMP server 進行連接，之后再轉發到 訂閱url；（server== name of your springmvc project ）（干貨——端點的作用——客戶端在訂閱或發布消息 到目的地址前，要連接該端點） A3）它重載了 configureMessageBroker() 方法：配置了一個 簡單的消息代理。如果不重載，默認case下，會自動配置一個簡單的 內存消息代理，用來處理 "/topic" 為前綴的消息。但經過重載后，消息代理將會處理前綴為 "/topic" and "/queue" 消息。 A4）之外：發送應用程序的消息將會帶有 "/app" 前綴，下圖展現了 這個配置中的 消息流；
對上述處理step的分析（Analysis）： A1）應用程序的目的地 以 "/app" 為前綴，而代理的目的地以 "/topic" 和 "/queue" 作為前綴； A2）以應用程序為目的地的消息將會直接路由到 帶有 @MessageMapping 注解的控制器方法中；(干貨——?@MessageMapping的作用) A3）而發送到 代理上的消息，包括 @MessageMapping注解方法的返回值所形成的消息，將會路由到 代理上，并最終發送到 訂閱這些目的地客戶端； （干貨——client 連接地址和 發送地址是不同的，以本例為例，前者是/server/hello, 后者是/server/app/XX，先連接后發送）
【3.1.1】啟用 STOMP 代理中繼 1）intro：在生成環境下，可能會希望使用 真正支持 STOMP 的代理來支持 WebSocket 消息，如RabbitMQ 或 ActiveMQ。這樣的代理提供了可擴展性和健壯性更好的消息功能，當然，他們也支持 STOMP 命令； 2）如何 使用 STOMP 代理來替換內存代理，代碼如下： @Overridepublic void configureMessageBroker(MessageBrokerRegistry registry) {// 啟用了 STOMP 代理中繼功能，并將其代理目的地前綴設置為 /topic and /queue .registry.enableStompBrokerRelay("/queue", "/topic").setRelayPort(62623);registry.setApplicationDestinationPrefixes("/app"); // 應用程序目的地.} 對以上代碼的分析（Analysis）：（干貨——STOMP代理前綴和 應用程序前綴的意義） A1）方法第一行啟用了 STOMP 代理中繼功能： 并將其目的地前綴設置為 "/topic" or "/queue" ；spring就能知道 所有目的地前綴為 "/topic" or "/queue" 的消息都會發送到 STOMP 代理中； A2）方法第二行設置了 應用的前綴為 "app"：所有目的地以 "/app" 打頭的消息（發送消息url not 連接url）都會路由到 帶有 @MessageMapping 注解的方法中，而不會發布到 代理隊列或主題中； 3）下圖闡述了 代理中繼如何 應用于 spring 的 STOMP 消息處理之中。與 上圖的 關鍵區別在于： 這里不再模擬STOMP 代理的功能，而是由 代理中繼將消息傳送到一個 真正的消息代理來進行處理；
Attention） A1）enableStompBrokerRelay() and setApplicationDestinationPrefixes() 方法都可以接收變長 參數； A2）默認情況下： STOMP 代理中繼會假設 代理監聽 localhost 的61613 端口，并且 client 的 username 和password 均為 guest。當然你也可以自行定義； @Override public void configureMessageBroker(MessageBrokerRegistry registry) { registry.enableStompBrokerRelay("/topic", "/queue") .setRelayHost("rabbit.someotherserver") .setRelayPort(62623) .setClientLogin("marcopolo") .setClientPasscode("letmein01"); registry.setApplicationDestinationPrefixes("/app", "/foo"); } // setXXX()方法 是可選的 【3.2】 處理來自客戶端的 STOMP 消息 1）借助 @MessageMapping 注解能夠 在 控制器中處理 STOMP 消息
package com.spring.spittr.web;import org.springframework.messaging.handler.annotation.MessageMapping; import org.springframework.messaging.handler.annotation.SendTo; import org.springframework.stereotype.Controller;import com.spring.pojo.Greeting; import com.spring.pojo.HelloMessage;@Controller public class GreetingController {@MessageMapping("/hello")@SendTo("/topic/greetings")public Greeting greeting(HelloMessage message) throws Exception {System.out.println("receiving " + message.getName());System.out.println("connecting successfully.");return new Greeting("Hello, " + message.getName() + "!");} }對以上代碼的分析（Analysis）： A1）@MessageMapping注解：表示?handleShout()方法能夠處理 指定目的地上到達的消息； A2）這個目的地（消息發送目的地url）就是 "/server/app/hello"，其中 "/app" 是 隱含的 ,"/server" 是 springmvc 項目名稱；
2）因為我們現在處理的 不是 HTTP，所以無法使用 spring 的 HttpMessageConverter 實現 將負載轉換為Shout 對象。Spring 4.0 提供了幾個消息轉換器如下：（Attention， 如果是傳輸json數據的話，定要添加 Jackson jar 包到你的springmvc 項目中，不然連接不會成功的）
【3.2.1】處理訂閱（@SubscribeMapping注解） 1）@SubscribeMapping注解 的方法：當收到 STOMP 訂閱消息的時候，帶有 @SubscribeMapping 注解 的方法將會觸發；其也是通過 AnnotationMethodMessageHandler 來接收消息的； 2）@SubscribeMapping注解的應用場景：實現 請求-回應模式。在請求-回應模式中，客戶端訂閱一個目的地，然后預期在這個目的地上 獲得一個一次性的 響應；（干貨——引入了@SubsribeMapping注解實現 請求-回應模式） 2.1）看個荔枝： @SubscribeMapping({"/marco"}) public Shout handleSubscription() { Shout outgoing = new Shout(); outgoing.setMessage("Polo!"); return outgoing; } 對以上代碼的分析（Analysis）： A1）@SubscribeMapping注解 的方法來處理 對 "/app/macro" 目的地訂閱（與 @MessageMapping類似，"/app" 是隱含的 ）； A2）請求-回應模式與 HTTP GET 的全球-響應模式差不多： 關鍵區別在于， HTTP GET 請求是同步的，而訂閱的全球-回應模式是異步的，這樣客戶端能夠在回應可用時再去處理，而不必等待；（干貨——HTTP GET 請求是同步的，而訂閱的請求-回應模式是異步的）
【3.2.2】編寫 JavaScript 客戶端 1）intro：借助 STOMP 庫，通過 JavaScript發送消息
<script type="text/javascript">var stompClient = null;function setConnected(connected) {document.getElementById('connect').disabled = connected;document.getElementById('disconnect').disabled = !connected;document.getElementById('conversationDiv').style.visibility = connected ? 'visible' : 'hidden';document.getElementById('response').innerHTML = '';}function connect() {var socket = new SockJS("<c:url value='/hello'/>");stompClient = Stomp.over(socket);stompClient.connect({}, function(frame) {setConnected(true);console.log('Connected: ' + frame);stompClient.subscribe('/topic/greetings', function(greeting){showGreeting(JSON.parse(greeting.body).content);});});}function disconnect() {if (stompClient != null) {stompClient.disconnect();}setConnected(false);console.log("Disconnected");}function sendName() {var name = document.getElementById('name').value;stompClient.send("/app/hello", {}, JSON.stringify({ 'name': name }));}function showGreeting(message) {var response = document.getElementById('response');var p = document.createElement('p');p.style.wordWrap = 'break-word';p.appendChild(document.createTextNode(message));response.appendChild(p);}</script> 對以上代碼的 分析（Analysis）：?以上代碼連接“/hello” 端點并發送 ”name“； 2）stompClient.send("/app/hello", {}, JSON.stringify({'name':name}))： 第一個參數：json 負載消息發送的 目的地； 第二個參數：是一個頭信息的Map，它會包含在 STOMP 幀中；第三個參數：負載消息； （干貨—— stomp client 連接地址 和 發送地址不一樣的，連接地址為 <c:url value='/hello'/> ==localhost:8080/springmvc_project_name/hello , 而 發送地址為 '/app/hello'，這里要當心）
downloading these files below from?https://github.com/pacosonTang/SpringInAction/tree/master/spring18 <script src="<c:url value="/resources/sockjs-1.1.1.js" />"></script><script src="<c:url value="/resources/stomp.js" />"></script> //this line.function connect() {var socket = new SockJS("<c:url value='/hello'/>");stompClient = Stomp.over(socket);stompClient.connect({}, function(frame) {setConnected(true);console.log('Connected: ' + frame);stompClient.subscribe('/topic/greetings', function(greeting){showGreeting(JSON.parse(greeting.body).content);});stompClient.subscribe('/app/macro',function(greeting){alert(JSON.parse(greeting.body).content);showGreeting(JSON.parse(greeting.body).content);});});}function sendName() {var name = document.getElementById('name').value;stompClient.send("/app/hello", {}, JSON.stringify({ 'name': name }));}package com.spring.spittr.web;import org.springframework.beans.factory.annotation.Autowired; import org.springframework.messaging.handler.annotation.MessageMapping; import org.springframework.messaging.handler.annotation.SendTo; import org.springframework.messaging.simp.SimpMessageSendingOperations; import org.springframework.messaging.simp.SimpMessagingTemplate; import org.springframework.messaging.simp.annotation.SubscribeMapping; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestParam;import com.spring.pojo.Greeting; import com.spring.pojo.HelloMessage;@Controller public class GreetingController {// @MessageMapping defines the sending addr for client.// 消息發送地址: /server/app/hello@MessageMapping("/hello")@SendTo("/topic/greetings")public Greeting greeting(HelloMessage message) throws Exception {System.out.println("receiving " + message.getName());System.out.println("connecting successfully.");return new Greeting("Hello, " + message.getName() + "!");}@SubscribeMapping("/macro")public Greeting handleSubscription() {System.out.println("this is the @SubscribeMapping('/marco')");Greeting greeting = new Greeting("i am a msg from SubscribeMapping('/macro').");return greeting;}/*@MessageMapping("/feed")@SendTo("/topic/feed")public Greeting greetingForFeed(HelloMessage message) throws Exception {System.out.println("receiving " + message.getName());System.out.println("connecting successfully.");return new Greeting("i am /topic/feed, hello " + message.getName() + "!");}*/// private SimpMessagingTemplate template;// SimpMessagingTemplate implements SimpMessageSendingOperations. private SimpMessageSendingOperations template;@Autowiredpublic GreetingController(SimpMessageSendingOperations template) {this.template = template;}@RequestMapping(path="/feed", method=RequestMethod.POST)public void greet(@RequestParam String greeting) {String text = "you said just now " + greeting;this.template.convertAndSend("/topic/feed", text);} }package com.spring.spittr.web;import org.springframework.context.annotation.Configuration; import org.springframework.messaging.handler.annotation.MessageMapping; import org.springframework.messaging.simp.config.MessageBrokerRegistry; import org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer; import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker; import org.springframework.web.socket.config.annotation.StompEndpointRegistry;@Configuration @EnableWebSocketMessageBroker public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {@Overridepublic void configureMessageBroker(MessageBrokerRegistry config) {config.enableSimpleBroker("/topic", "/queue");config.setApplicationDestinationPrefixes("/app");// 應用程序以 /app 為前綴，而 代理目的地以 /topic 為前綴.// js.url = "/spring13/app/hello" -> @MessageMapping("/hello") 注釋的方法.}@Overridepublic void registerStompEndpoints(StompEndpointRegistry registry) {registry.addEndpoint("/hello").withSockJS();// 在網頁上我們就可以通過這個鏈接 /server/hello 來和服務器的WebSocket連接} } package com.spring.spittr.web;import java.io.IOException;import org.springframework.context.MessageSource; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; import org.springframework.context.support.ResourceBundleMessageSource; import org.springframework.core.io.FileSystemResource; import org.springframework.web.multipart.MultipartResolver; import org.springframework.web.multipart.commons.CommonsMultipartResolver; import org.springframework.web.servlet.ViewResolver; import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter; import org.springframework.web.servlet.view.InternalResourceViewResolver; import org.springframework.web.servlet.view.tiles3.TilesConfigurer; import org.springframework.web.servlet.view.tiles3.TilesViewResolver;@Configuration @ComponentScan(basePackages = { "com.spring.spittr.web" }) @EnableWebMvc @Import({WebSocketConfig.class}) public class WebConfig extends WebMvcConfigurerAdapter {@Beanpublic TilesConfigurer tilesConfigurer() {TilesConfigurer tiles = new TilesConfigurer();tiles.setDefinitions(new String[] { "/WEB-INF/layout/tiles.xml" });tiles.setCheckRefresh(true);return tiles;}// config processing for static resources.@Overridepublic void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {configurer.enable();}// InternalResourceViewResolver @Beanpublic ViewResolver viewResolver1() {TilesViewResolver resolver = new TilesViewResolver();return resolver;}@Beanpublic ViewResolver viewResolver2() {InternalResourceViewResolver resolver = new InternalResourceViewResolver();resolver.setPrefix("/WEB-INF/views/");resolver.setSuffix(".jsp");resolver.setExposeContextBeansAsAttributes(true);resolver.setViewClass(org.springframework.web.servlet.view.JstlView.class);return resolver;}@Beanpublic MessageSource messageSource() {ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();messageSource.setBasename("messages"); return messageSource;}@Beanpublic MultipartResolver multipartResolver() throws IOException {CommonsMultipartResolver multipartResolver = new CommonsMultipartResolver();multipartResolver.setUploadTempDir(new FileSystemResource("/WEB-INF/tmp/spittr/uploads"));multipartResolver.setMaxUploadSize(2097152);multipartResolver.setMaxInMemorySize(0);return multipartResolver;} } 【3.3】發送消息到客戶端 1）intro：spring提供了兩種 發送數據到 client 的方法： method1）作為處理消息 或處理訂閱的附帶結果； method2）使用消息模板；
【3.3.1】在處理消息后，發送消息（server 對 client 請求的 響應消息） 1）intro：如果你想要在接收消息的時候，在響應中發送一條消息，修改方法簽名 不是void 類型即可， 如下：
@MessageMapping("/hello")@SendTo("/topic/greetings") //highlight line.public Greeting greeting(HelloMessage message) throws Exception {System.out.println("receiving " + message.getName());System.out.println("connecting successfully.");return new Greeting("Hello, " + message.getName() + "!");}對以上代碼的分析（Analysis）：返回的對象將會進行轉換（通過消息轉換器） 并放到 STOMP 幀的負載中，然后發送給消息代理（消息代理分為 STOMP代理中繼 和 內存消息代理）； 2）默認情況下：幀所發往的目的地會與 觸發 處理器方法的目的地相同。所以返回的對象 會寫入到 STOMP 幀的負載中，并發布到 "/topic/stomp" 目的地。不過，可以通過 @SendTo 注解，重載目的地；（干貨——注解?@SendTo 注解的作用）
代碼同上。
對以上代碼的分析（Analysis）：消息將會發布到 /topic/hello， 所有訂閱這個主題的應用都會收到這條消息；
3）@SubscriptionMapping 注解標注的方式也能發送一條消息，作為訂閱的回應。 3.1）看個荔枝： 通過為 控制器添加如下的方法，當客戶端訂閱的時候，將會發送一條 shout 信息： @SubscribeMapping("/macro") // defined in Controller. attention for addr '/macro' in server.public Greeting handleSubscription() {System.out.println("this is the @SubscribeMapping('/marco')");Greeting greeting = new Greeting("i am a msg from SubscribeMapping('/macro').");return greeting;} function connect() {var socket = new SockJS("<c:url value='/hello'/>");stompClient = Stomp.over(socket);stompClient.connect({}, function(frame) {setConnected(true);console.log('Connected: ' + frame);stompClient.subscribe('/topic/greetings', function(greeting){showGreeting(JSON.parse(greeting.body).content);});// starting line.stompClient.subscribe('/app/macro',function(greeting){alert(JSON.parse(greeting.body).content);showGreeting(JSON.parse(greeting.body).content);}); // ending line. attention for addr '/app/macro' in client.});} 對以上代碼的分析（Analysis）：? A0）這個SubscribeMapping annotation標記的方法，是在訂閱的時候調用的，也就是說，基本是只執行一次的方法，client 調用定義在server 的 該 Annotation 標注的方法，它就會返回結果，不過經過代理。 A1）這里的?@SubscribeMapping 注解表明當 客戶端訂閱 "/app/macro" 主題的時候（"/app"是應用目的地的前綴，注意，這里沒有加springmvc 項目名稱前綴）， 將會調用?handleSubscription 方法。它所返回的shout 對象 將會進行轉換 并發送回client； A2）SubscribeMapping注解的區別在于： 這里的 Shout 消息將會直接發送給 client，不用經過 消息代理；但，如果為方法添加 @SendTo 注解的話，那么 消息將會發送到指定的目的地，這樣就會經過代理；（干貨——SubscribeMapping注解返回的消息直接發送到 client，不經過代理，而 @SendTo 注解的路徑，就會經過代理，然后再發送到 目的地）
【3.3.2】 在應用的任意地方發送消息 1）intro：spring 的 SimpMessagingTemplate 能夠在應用的任何地方發送消息，不必以接收一條消息為 前提； 2）看個荔枝： 讓首頁訂閱一個 STOMP主題，在 Spittle 創建的時候，該主題能夠收到 Spittle 更新時的 feed； 2.1）JavaScript 代碼： <script> var sock = new SockJS('spittr'); var stomp = Stomp.over(sock); stomp.connect('guest', 'guest', function(frame) { console.log('Connected'); stomp.subscribe("/topic/spittlefeed", handleSpittle); // highlight. }); function handleSpittle(incoming) { var spittle = JSON.parse(incoming.body); console.log('Received: ', spittle); var source = $("#spittle-template").html(); var template = Handlebars.compile(source); var spittleHtml = template(spittle); $('.spittleList').prepend(spittleHtml); } </script> 對以上代碼的分析（Analysis）：?在連接到 STMOP 代理后，我們訂閱了 "/topic/spittlefeed" 主題，并指定當消息到達的是，由?handleSpittle()函數來處理 Spittle 更新。 2.2） server 端代碼：使用 SimpMessagingTemplate 將所有新創建的 Spittle 以消息的形式發布到 "/topic/feed" 主題上； @Service public class SpittleFeedServiceImpl implements SpittleFeedService { private SimpMessageSendingOperations messaging; @Autowired public SpittleFeedServiceImpl( SimpMessageSendingOperations messaging) { // 注入消息模板. this.messaging = messaging; } public void broadcastSpittle(Spittle spittle) { messaging.convertAndSend("/topic/spittlefeed", spittle); // 發送消息. } } 對以上代碼的分析（Analysis）：? A1）配置 spring 支持 stomp 的一個附帶功能是 在spring應用上下文中已經包含了 Simple A2）在發布消息給 STOMP 主題的時候，所有訂閱該主題的客戶端都會收到消息。但有的時候，我們希望將消息發送給指定用戶；
【4】 為目標用戶發送消息 1）intro：在使用 srping 和 STOMP 消息功能的時候，有三種方式來利用認證用戶： way1）@MessageMapping and @SubscribeMapping 注解標注的方法 能夠使用 Principal 來獲取認證用戶； way2）@MessageMapping, @SubscribeMapping, and @MessageException 方法返回的值能夠以 消息的形式發送給 認證用戶； way3）SimpMessagingTemplate 能夠發送消息給特定用戶；
【4.1】在控制器中處理用戶的 消息 1）看個荔枝： 編寫一個控制器方法，根據傳入的消息創建新的Spittle 對象，并發送一個回應，表明 對象創建成功；（這種 REST也可以實現，不過它是同步的，而這里是異步的）； 1.1）代碼如下：它會處理傳入的消息并將其存儲我 Spittle： @MessageMapping("/spittle") @SendToUser("/queue/notifications") public Notification handleSpittle( Principal principal, SpittleForm form) { Spittle spittle = new Spittle( principal.getName(), form.getText(), new Date()); spittleRepo.save(spittle); return new Notification("Saved Spittle"); } 1.2）該方法最后返回一個 新的 Notificatino，表明對象保存成功； 1.3）該方法使用了?@MessageMapping("/spittle") 注解，所以當有發往 "/app/spittle" 目的地的消息 到達時，該方法就會觸發；如果用戶已經認證的話，將會根據 STOMP 幀上的頭信息得到 Principal 對象； 1.4）@SendToUser注解： 指定了 Notification 要發送的 目的地?"/queue/notifications"； 1.5）表明上，?"/queue/notifications" 并不會與 特定用戶相關聯，但因為 這里使用的是?@SendToUser注解， 而不是?@SendTo，所以 就會發生更多的事情了； 2）看一下針對 控制器方法發布的 Notificatino 對象的目的地，客戶端該如何進行訂閱。 2.1）看個荔枝：考慮如下的 JavaScript代碼，它訂閱了一個 用戶特定的 目的地： stomp.subscribe("/user/queue/notifications", handleNotifications); 對以上代碼的分析（Analysis）：這個目的地使用了 "/user" 作為前綴，在內部，以"/user" 為前綴的消息將會通過 UserDestinationMessageHandler 進行處理，而不是 AnnotationMethodMessageHandler 或 ?SimpleBrokerMessageHandler or StompBrokerRelayMessageHandler，如下圖所示：
Attention）UserDestinationMessageHandler?的主要任務： 是 將用戶消息重新路由到 某個用戶獨有的目的地上。 在處理訂閱的時候，它會將目標地址中的 "/user" 前綴去掉，并基于用戶 的會話添加一個后綴。如，對 ?"/user/queue/notifications" 的訂閱最后可能路由到 名為 "/queue/notifacations-user65a4sdfa" 目的地上；
【4.2】為指定用戶發送消息 1）intro：SimpMessagingTemplate還提供了 convertAndSendToUser() 方法，該方法能夠讓 我們給特定用戶發送消息； 2）我們在 web 應用上添加一個特性： 當其他用戶提交的 Spittle 提到某個用戶時，將會提醒該用戶（干貨——這難道不是 微博的 @ 功能嗎） 2.1）看個荔枝：如果Spittle 文本中包含 "@tangrong"，那么我們就應該發送一條消息給 使用?tangrong 用戶名登錄的client，代碼實例如下： @Service public class SpittleFeedServiceImpl implements SpittleFeedService { private SimpMessagingTemplate messaging; // 實現用戶提及功能的正則表達式 private Pattern pattern = Pattern.compile("\\@(\\S+)"); @Autowired public SpittleFeedServiceImpl(SimpMessagingTemplate messaging) { this.messaging = messaging; } public void broadcastSpittle(Spittle spittle) { messaging.convertAndSend("/topic/spittlefeed", spittle); Matcher matcher = pattern.matcher(spittle.getMessage()); if (matcher.find()) { String username = matcher.group(1); // 發送提醒給用戶. messaging.convertAndSendToUser( username, "/queue/notifications", new Notification("You just got mentioned!")); } } } 【5】處理消息異常 1）intro：我們也可以在 控制器方法上添加 @MessageExceptionHandler 注解，讓它來處理 @MessageMapping 方法所拋出的異常； 2）看個荔枝：它會處理 消息方法所拋出的異常； @MessageExceptionHandler public void handleExceptions(Throwable t) { logger.error("Error handling message: " + t.getMessage()); } 3）我們也可以以 參數的形式聲明它所能處理的異常； @MessageExceptionHandler(SpittleException.class) // highlight line. public void handleExceptions(Throwable t) { logger.error("Error handling message: " + t.getMessage()); } // 或者： @MessageExceptionHandler( {SpittleException.class, DatabaseException.class}) // highlight line. public void handleExceptions(Throwable t) { logger.error("Error handling message: " + t.getMessage()); } 4）該方法還可以回應一個錯誤： @MessageExceptionHandler(SpittleException.class) @SendToUser("/queue/errors") public SpittleException handleExceptions(SpittleException e) { logger.error("Error handling message: " + e.getMessage()); return e; } // 如果拋出 SpittleException 的話，將會記錄這個異常，并將其返回. // 而 UserDestinationMessageHandler 會重新路由這個消息到特定用戶所對應的 唯一路徑；
總結
以上是生活随笔為你收集整理的springmvc(18)使用WebSocket 和 STOMP 实现消息功能的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 鲁迅哪里人原籍是什么地方的（鲁迅先生的家
- 下一篇： springmvc(17)异步消息简介（