SpringBoot的WebSocket實(shí)現(xiàn)單聊群聊

更新時(shí)間：2021年02月25日 17:24:48 作者：皮皮大蝦

這篇文章主要為大家詳細(xì)介紹了SpringBoot的WebSocket實(shí)現(xiàn)單聊群聊，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

本文實(shí)例為大家分享了SpringBoot的WebSocket實(shí)現(xiàn)單聊群聊，供大家參考，具體內(nèi)容如下

說(shuō)在開頭

在HTTP協(xié)議中，所有的請(qǐng)求都是由客戶端發(fā)送給服務(wù)端，然后服務(wù)端發(fā)送請(qǐng)求
要實(shí)現(xiàn)服務(wù)器向客戶端推送消息有幾種methods:

1、輪詢

大量無(wú)效請(qǐng)求，浪費(fèi)資源

2、長(zhǎng)輪詢

有新數(shù)據(jù)再推送，但這會(huì)導(dǎo)致連接超時(shí)，有一定隱患

3、Applet和Flash

過(guò)時(shí)，安全隱患，兼容性不好

消息群發(fā)

創(chuàng)建新項(xiàng)目:

添加依賴：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-websocket</artifactId>
 </dependency>
 <dependency>
  <groupId>org.webjars</groupId>
  <artifactId>sockjs-client</artifactId>
  <version>1.1.2</version>
 </dependency>
 <dependency>
  <groupId>org.webjars</groupId>
  <artifactId>jquery</artifactId>
  <version>3.3.1</version>
 </dependency>
 <dependency>
  <groupId>org.webjars</groupId>
  <artifactId>stomp-websocket</artifactId>
  <version>2.3.3</version>
 </dependency>
 <dependency>
  <groupId>org.webjars</groupId>
  <artifactId>webjars-locator-core</artifactId>
</dependency>

創(chuàng)建WebSocket配置類:WebSocketConfig

@Configuration
@EnableWebSocketMessageBroker//注解開啟webSocket消息代理
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
 /**
 * 配置webSocket代理類
 * @param registry
 */
 @Override
 public void configureMessageBroker(MessageBrokerRegistry registry) {
 registry.enableSimpleBroker("/topic"); //代理消息的前綴
 registry.setApplicationDestinationPrefixes("/app");  //處理消息的方法前綴
 }
 @Override
 public void registerStompEndpoints(StompEndpointRegistry registry) {
 registry.addEndpoint("/chat").withSockJS();  //定義一個(gè)/chat前綴的endpioint,用來(lái)連接
 }
}

創(chuàng)建Bean

/**
 * 群消息類
 */
public class Message {
 private String name;
 private String content;
//省略getter& setter
}

定義controller的方法:

/**
 * MessageMapping接受前端發(fā)來(lái)的信息
 * SendTo 發(fā)送給信息WebSocket消息代理，進(jìn)行廣播
 * @param message 頁(yè)面發(fā)來(lái)的json數(shù)據(jù)封裝成自定義Bean
 * @return 返回的數(shù)據(jù)交給WebSocket進(jìn)行廣播
 * @throws Exception
 */
 @MessageMapping("/hello")
 @SendTo("/topic/greetings")
 public Message greeting(Message message) throws Exception {
 return message;
 }

<html lang="en">
<head>
 <meta charset="UTF-8">
 <title>Title</title>
 <script src="/webjars/jquery/jquery.min.js"></script>
 <script src="/webjars/sockjs-client/sockjs.min.js"></script>
 <script src="/webjars/stomp-websocket/stomp.min.js"></script>
 <script>
 var stompClient = null;
 //點(diǎn)擊連接以后的頁(yè)面改變
 function setConnected(connection) {
  $("#connect").prop("disable",connection);
  $("#disconnect").prop("disable",!connection);
  if (connection) {
  $("#conversation").show();
  $("#chat").show();

  } else {
  $("#conversation").hide();
  $("#chat").hide();
  }
  $("#greetings").html("");
 }
 //點(diǎn)擊連接按鈕建立連接
 function connect() {
  //如果用戶名為空直接跳出
  if (!$("#name").val()) {
  return;
  }
  //創(chuàng)建SockJs實(shí)例,建立連接
  var sockJS = new SockJS("/chat");
  //創(chuàng)建stomp實(shí)例進(jìn)行發(fā)送連接
  stompClient = Stomp.over(sockJS);
  stompClient.connect({}, function (frame) {
  setConnected(true);
  //訂閱服務(wù)端發(fā)來(lái)的信息
  stompClient.subscribe("/topic/greetings", function (greeting) {
   //將消息轉(zhuǎn)化為json格式，調(diào)用方法展示
   showGreeting(JSON.parse(greeting.body));
  });
  });
 }
 //斷開連接
 function disconnect() {
  if (stompClient !== null) {
  stompClient.disconnect();
  }
  setConnected(false);
 }
 //發(fā)送信息
 function sendName() {
  stompClient.send("/app/hello",{},JSON.stringify({'name': $("#name").val() , 'content': $("#content").val()}));
 }
 //展示聊天房間
 function showGreeting(message) {
  $("#greetings").append("<div>"+message.name + ":" + message.content + "</div>");
 }
 $(function () {
  $("#connect").click(function () {
  connect();
  });
  $("#disconnect").click(function () {
  disconnect();
  });
  $("#send").click(function () {
  sendName();
  })
 })
 </script>
</head>
<body>
<div>
 <label for="name">用戶名</label>
 <input type="text" id="name" placeholder="請(qǐng)輸入用戶名">
</div>
<div>
 <button id="connect" type="button">連接</button>
 <button id="disconnect" type="button">斷開連接</button>
</div>
<div id="chat" style="display: none;">
 <div>
 <label for="name"></label>
 <input type="text" id="content" placeholder="聊天內(nèi)容">
 </div>
 <button id="send" type="button">發(fā)送</button>
 <div id="greetings">
 <div id="conversation" style="display: none;">群聊進(jìn)行中</div>
 </div>
</div>
</body>
</html>

私聊

既然是私聊，就要有對(duì)象目標(biāo)，也是用戶，可以用SpringSecurity引入
所以添加額外依賴：

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-security</artifactId>
</dependency>

配置SpringSecurity

@Configuration
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
 @Bean
 PasswordEncoder passwordEncoder(){
 return new BCryptPasswordEncoder();
 }
 @Override
 protected void configure(AuthenticationManagerBuilder auth) throws Exception {
 auth.inMemoryAuthentication()
  .withUser("panlijie").roles("admin").password("$2a$10$5Pf0KhCdnrpMxP5aRrHvMOsvV2fvfWJqk0SEDa9vQ8OWwV8emLFhi")
  .and()
  .withUser("suyanxia").roles("user").password("$2a$10$5Pf0KhCdnrpMxP5aRrHvMOsvV2fvfWJqk0SEDa9vQ8OWwV8emLFhi");
 }
 @Override
 protected void configure(HttpSecurity http) throws Exception {
 http.authorizeRequests()
  .anyRequest().authenticated()
  .and()
  .formLogin()
  .permitAll();
 }
}

在原來(lái)的WebSocketConfig配置類中修改：也就是多了一個(gè)代理消息前綴:"/queue"

@Configuration
@EnableWebSocketMessageBroker//注解開啟webSocket消息代理
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
 /**
 * 配置webSocket代理類
 * @param registry
 */
 @Override
 public void configureMessageBroker(MessageBrokerRegistry registry) {
 registry.enableSimpleBroker("/topic","/queue"); //代理消息的前綴
 registry.setApplicationDestinationPrefixes("/app");  //處理消息的方法前綴
 }
 @Override
 public void registerStompEndpoints(StompEndpointRegistry registry) {
 registry.addEndpoint("/chat").withSockJS();  //定義一個(gè)/chat前綴的endpioint,用來(lái)連接
 }
}

創(chuàng)建Bean:

public class Chat {
 private String to;
 private String from;
 private String content;
//省略getter& setter
}

添加controller方法：

 /**
 * 點(diǎn)對(duì)點(diǎn)發(fā)送信息
 * @param principal 當(dāng)前用戶的信息
 * @param chat 發(fā)送的信息
 */
 @MessageMapping("chat")
 public void chat(Principal principal, Chat chat) {
 //獲取當(dāng)前對(duì)象設(shè)置為信息源
 String from = principal.getName();
 chat.setFrom(from);
 //調(diào)用convertAndSendToUser("用戶名","路徑","內(nèi)容");
 simpMessagingTemplate.convertAndSendToUser(chat.getTo(), "/queue/chat", chat);
 }

創(chuàng)建頁(yè)面：

<html lang="en">
<head>
 <meta charset="UTF-8">
 <title>Title</title>
 <script src="/webjars/jquery/jquery.min.js"></script>
 <script src="/webjars/sockjs-client/sockjs.min.js"></script>
 <script src="/webjars/stomp-websocket/stomp.min.js"></script>
 <script>
 var stompClient = null;
 function connect() {
  var socket = new SockJS("/chat");
  stompClient = Stomp.over(socket);
  stompClient.connect({}, function (frame) {
  stompClient.subscribe('/user/queue/chat', function (chat) {
   showGreeting(JSON.parse(chat.body));
  });
  });
 }
 function sendMsg() {
  stompClient.send("/app/chat",{},JSON.stringify({'content' : $("#content").val(), 'to': $("#to").val()}));
 }
 function showGreeting(message) {
  $("#chatsContent").append("<div>" + message.from + ":" + message.content + "</div>");
 }
 $(function () {
  connect();
  $("#send").click(function () {
  sendMsg();
  });
 });
 </script>
</head>
<body>
<div id="chat">
 <div id="chatsContent">
 </div>
 <div>
 請(qǐng)輸入聊天內(nèi)容
 <input type="text" id="content" placeholder="聊天內(nèi)容">
 <input type="text" id="to" placeholder="目標(biāo)用戶">
 <button type="button" id="send">發(fā)送</button>
 </div>
</div>
</body>
</html>

暫結(jié)！

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: