1. 依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
2. 配置
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* 创建ServerEndpointExporter对象,通过它可以定义WebSocket服务器的端点
* 这样客户端就能请求服务器的端点了
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
3. 端点
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import org.springframework.stereotype.Component;
@Component
@ServerEndpoint("/websocket/allen")
public class Socket {
/*websocket 客户端会话 通过Session 向客户端发送数据*/
private Session session;
/*线程安全set 存放每个客户端处理消息的对象*/
private static CopyOnWriteArraySet<Socket> webSocketSet = new CopyOnWriteArraySet();
/*websocket 连接建立成功后进行调用*/
@OnOpen
public void onOpen(Session session) {
this.session = session;
webSocketSet.add(this);
System.out.println("websocket 有新的链接"+webSocketSet.size());
}
/*websocket 链接关闭调用的方法*/
@OnClose
public void onClose() {
webSocketSet.remove(this);
}
/*收到客户端消息后调用的方法 message是收到客户端的消息*/
@OnMessage
public void onMessage(String message) throws IOException{
for(Socket socket : webSocketSet){
//给客户端发消息
socket.session.getBasicRemote().sendText("#################" + message);
}
}
/*websocket 发生错误时进行调用*/
@OnError
public void onError(Session session,Throwable error){
error.printStackTrace();
}
public void sendMessage(String message) throws IOException {
for (Socket socket : webSocketSet) {
socket.session.getBasicRemote().sendText(message);
}
}
public Session getSession() {
return session;
}
public void setSession(Session session) {
this.session = session;
}
}
4. 测试
服务器给客户端发消息
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.IOException;
@RestController
@RequestMapping("/socket")
public class SocketTestController {
@Autowired
private Socket socket;
@GetMapping("/{message}")
public void sendMessage(@PathVariable("message") String message) throws IOException {
//给所有的客户端都发送消息
socket.sendMessage("这个是controller 发送的消息:"+message);
}
}
网页的服务器给客户端发消息
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h2>通过controller 进行发送消息</h2>
<input type="text" id="sendMessage"><button οnclick="controllerSend()">发送</button>
</body>
<script language="JavaScript">
function controllerSend(){
var sendIput = document.getElementById("sendMessage");
var sendMessage = sendIput.value;
if(sendMessage.trim() == ""){
alert("请输入发送消息!")
return;
}
//创建异步对象
var xhr = new XMLHttpRequest();
//设置请求的类型及url
xhr.open('get', 'http://localhost:8080/socket/'+sendMessage );
//发送请求
xhr.send();
xhr.onreadystatechange = function () {
// 这步为判断服务器是否正确响应
if (xhr.readyState == 4 && xhr.status == 200) {
console.log(xhr.responseText);
}
};
}
</script>
</html>
客户端给服务器发消息
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>socket demo</title>
</head>
<body>
<h2>学说话的tom 猫</h2>
<div><label>消息内容:</label>
<p id="serverMessage"></p></div>
<div><label>我对自己说:</label><input id="sendMessage" type="text"/>
<button onclick="sendAB()">发送
</button>
</div>
<script type="text/javascript">
//客户端给服务端发消息
var websocket = null;
if ('WebSocket' in window) {
// websocket = new WebSocket('ws://localhost:8080/websocket');
websocket = new WebSocket("ws://localhost:8080/websocket/allen")
} else {
alert("该游览器不知此WebSocket");
}
//websocket 链接成功后进行触发
websocket.onopen = function (event) {
console.log("建立链接。。。。");
}
//websocket 链接关闭的进行触发
websocket.onclose = function (event) {
console.log("关闭链接。。。。");
}
//接收到消息的进行触发
websocket.onmessage = function (event) {
var serverMessage = document.getElementById("serverMessage");
serverMessage.innerHTML = event.data;
console.log("收到消息");
}
//连接发生错误的进行触发
websocket.onerror = function (evt) {
console.log("WebSocketError!");
}
//当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
window.onbeforeunload = function () {
websocket.close();
}
//关闭websocket连接
function closeWebSocket() {
websocket.close();
}
//发送消息
function sendAB() {
var sendIput = document.getElementById("sendMessage");
var sendMessage = sendIput.value;
if (sendMessage.trim() == "") {
alert("请输入发送消息!")
return;
}
websocket.send(sendMessage);
}
</script>
</body>
</html>
ps
1. 注意中英文输入法,如果你赋值的话
2.@EnableWebSocket 没有使用,自寻查找使用此注解的方式