Greetings |
---|
基于socket通信,spring
也有自己的socket通信服務(wù):websocket
,這次就介紹如何在spring項(xiàng)目中使用websocket
進(jìn)行通信交互。
成都創(chuàng)新互聯(lián)公司主要從事成都網(wǎng)站建設(shè)、成都網(wǎng)站制作、網(wǎng)頁(yè)設(shè)計(jì)、企業(yè)做網(wǎng)站、公司建網(wǎng)站等業(yè)務(wù)。立足成都服務(wù)盤州,10余年網(wǎng)站建設(shè)經(jīng)驗(yàn),價(jià)格優(yōu)惠、服務(wù)專業(yè),歡迎來(lái)電咨詢建站服務(wù):18982081108
后臺(tái):spring boot;前臺(tái):angularjs
后臺(tái)建立服務(wù)
首先我們先建立起后臺(tái)的服務(wù),以實(shí)現(xiàn)進(jìn)行socket連接。
1.引入websocket依賴
建立好一個(gè)maven項(xiàng)目之后,我們需要在xml
中引入websocket
的相關(guān) 依賴:
org.springframework.boot spring-boot-starter-websocket org.webjars webjars-locator-core org.webjars sockjs-client 1.0.2 org.webjars stomp-websocket 2.3.3 org.webjars bootstrap 3.3.7 org.webjars jquery 3.1.0
2.配置類
引入依賴后,就需要我們進(jìn)行配置類的編寫:
public class WebSocketConfig {}
這個(gè)類需要實(shí)現(xiàn)一個(gè)接口,來(lái)幫助我們進(jìn)行socket
的連接,并接受發(fā)送過(guò)來(lái)的消息。比如下面這樣:
package com.mengyunzhi.SpringMvcStudy.config; import org.springframework.context.annotation.Configuration; import org.springframework.messaging.simp.config.MessageBrokerRegistry; import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker; import org.springframework.web.socket.config.annotation.StompEndpointRegistry; import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer; @Configuration @EnableWebSocketMessageBroker public class WebSocketConfig implements WebSocketMessageBrokerConfigurer { @Override public void configureMessageBroker(MessageBrokerRegistry config) { config.enableSimpleBroker("/topic"); config.setApplicationDestinationPrefixes("/server"); } @Override public void registerStompEndpoints(StompEndpointRegistry registry) { //注冊(cè)STOMP協(xié)議節(jié)點(diǎn),同時(shí)指定使用SockJS協(xié)議 registry .addEndpoint("/websocket-server") .setAllowedOrigins("*") .withSockJS(); } }
通常的配置我就不在這里解釋了,值得一提的是,我們使用了@EnableWebSocketMessageBroker
這個(gè)注解,從字面上我們不難猜出,它表示支持websocket
提供的消息代理。
然后我們實(shí)現(xiàn)configureMessageBroker()
方法,來(lái)配置消息代理。在這個(gè)方法中,我們先調(diào)用enableSimpleBroker()
來(lái)創(chuàng)建一個(gè)基于內(nèi)存的消息代理,他表示以/topic
為前綴的消息將發(fā)送回客戶端。接著設(shè)置一個(gè)請(qǐng)求路由前綴,它綁定了@MessageMapping
(這個(gè)后面會(huì)用到)注解,表示以/server
為前綴的消息,會(huì)發(fā)送到服務(wù)器端。
最后實(shí)現(xiàn)了registerStompEndpoints()
方法,用來(lái)注冊(cè)/websocket-server
端點(diǎn)來(lái)建立服務(wù)器。
3.控制器
這時(shí)我們要建立一個(gè)供前臺(tái)訪問(wèn)的接口來(lái)發(fā)送消息。
@MessageMapping("/hello") @SendTo("/topic/greetings") public Greeting greeting(HelloMessage message) throws Exception { Thread.sleep(1000); // simulated delay return new Greeting("Hello, " + HtmlUtils.htmlEscape(message.getName()) + "!"); }
其中@MessageMapping
注解就是我們前面提到的,前臺(tái)會(huì)將消息發(fā)送到/server/hello
這里。
然后還有一個(gè)@SendTo
注解,它表示服務(wù)器返回給前臺(tái)的消息,會(huì)發(fā)送到/topic/greeting
這里。
前臺(tái)客戶端
服務(wù)器部分建立好后,接著我們就要去建立客戶端部分
1.客戶端界面
Hello WebSocket
Greetings
這部分沒(méi)什么說(shuō)的,主要就是其中引的連個(gè)js文件:
這兩個(gè)文件幫助我們利用sockjs
和stomp
實(shí)現(xiàn)客戶端。
創(chuàng)建邏輯
var stompClient = null; function setConnected(connected) { $("#connect").prop("disabled", connected); $("#disconnect").prop("disabled", !connected); if (connected) { $("#conversation").show(); } else { $("#conversation").hide(); } $("#greetings").html(""); } function connect() { var socket = new SockJS('/websocket-server'); 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() { stompClient.send("/server/hello", {}, JSON.stringify({'name': $("#name").val()})); } function showGreeting(message) { $("#greetings").append(""); } $(function () { $("form").on('submit', function (e) { e.preventDefault(); }); $( "#connect" ).click(function() { connect(); }); $( "#disconnect" ).click(function() { disconnect(); }); $( "#send" ).click(function() { sendName(); }); }); " + message + "
這個(gè)文件主要注意connect()
和sendName()
這兩個(gè)方法。
最后實(shí)現(xiàn)的效果如下:
官方文檔:
https://spring.io/guides/gs/messaging-stomp-websocket/
https://docs.spring.io/spring-boot/docs/1.5.17.RELEASE/reference/htmlsingle/#boot-features-websockets
https://docs.spring.io/spring/docs/4.3.20.RELEASE/spring-framework-reference/htmlsingle/#websocket
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持創(chuàng)新互聯(lián)。