1、什么是websocket？
WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工(full-duplex)通信--允许服务器主动发送信息给客户端。
WebSocket通信协议于2011年被IETF定为标准RFC 6455，并被RFC7936所补充规范。简单的说，WebSocket协议之前，双工通信是通过不停发送HTTP请求，从服务器拉取更新来实现，这导致了效率低下。WebSocket解决了这个问题
百度百科:websocket
2、实例(后台部分)
1、新建一个模块，添加pom依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.8.0.RELEASE</version>
</dependency>
-
项目结构如图所示
项目结构
- Websocketconfig类
package com.boot.websocket.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* WebSocket的配置类
* 开启了WebSocket支持
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
- Websocketserver类:
package com.boot.websocket.config;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
//客户端向服务器端建立WebSocket连接的url
@ServerEndpoint("/websocket")
@Component
public class WebSocketServer {
//静态变量，用来记录当前在线连接数,可选
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象，必须
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet
= new CopyOnWriteArraySet<WebSocketServer>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据,必须
private Session session;
/**
* 连接建立成功调用的方法
*/
@OnOpen
public void onOpen(Session session) {
this.session = session;
webSocketSet.add(this); //将客户端加入set中
addOnlineCount(); //在线数加1
System.out.println("有新窗口开始监听,当前在线人数为"
+ getOnlineCount());
try {
sendMessage("连接成功");
} catch (IOException e) {
System.out.println("WebSocket 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 (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* @param session
* @param error
*/
@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);
}
/**
* 群发自定义消息
*/
public static void sendInfo(String message) throws IOException {
System.out.println("推送消息内容:" + message);
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
continue;
}
}
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
WebSocketServer.onlineCount++;
}
public static synchronized void subOnlineCount() {
WebSocketServer.onlineCount--;
}
}
- controller类
package com.boot.websocket.controller;
import com.boot.websocket.config.WebSocketServer;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.IOException;
@RestController
public class WebSocketController {
//推送数据接口
@GetMapping("/socket/push")
public String pushMsg(String message) {
try {
WebSocketServer.sendInfo(message);
} catch (IOException e) {
e.printStackTrace();
}
return "success";
}
}
3.前端部分
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>websocket示例</title>
<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
<script src="https://cdn.bootcss.com/vue/2.4.2/vue.min.js"></script>
</head>
<style type="text/css">
.container {
position: absolute;
bottom: 100px;
right: 30px;
border: 1px solid #eee;
width: 250px;
height: 100px;
}
</style>
<body>
<div id="app">
<div class="container" v-show="follow">
<h3>消息显示</h3>
<ul>
<li v-for="(message, index) in messages" :key="index">
{{message}}
</li>
</ul>
</div>
<hr>
<h3>发送消息 </h3>
<input type="text" v-model="sendMsg" />
<button type="button" @click="send">发送</button>
</div>
<script type="text/javascript">
var socket;
var app = new Vue({
el: '#app',
data: {
messages: [],
sendMsg: '',
follow: false,
},
created: function() {
var _this = this;
//创建WebSocket对象，指定要连接的服务器地址和端口，建立连接
socket = new WebSocket("ws://10.40.250.164:8080/websocket");
//打开连接
socket.onopen = function() {
console.log("Socket已打开");
};
//获得服务端推送的消息
socket.onmessage = function(msg) {
console.log(msg.data);
_this.messages.push(msg.data);
console.log(_this.messages);
};
//关闭连接
socket.onclose = function() {
console.log("Socket已关闭");
};
//发送错误
socket.onerror = function() {
alert("Socket发生了错误");
}
},
watch: {
// 如果 `messages` 发生改变，这个函数就会运行
messages: function(newMsg, oldMsg) {
this.messages = newMsg;
},
},
methods: {
send: function() {
if(sendMess)
socket.send(this.sendMsg);
this.follow = true;
alert('发送成功！')
}
}
})
</script>
</body>
</html>
-
运行截图
运行截图
网友评论