WebSocket简介
Spring Boot对WebSocket提供了非常友好的支持，可以方便开发者在项目中快速集成WebSocket功能
添加依赖:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> <dependency> <groupId>org.webjars</groupId> <artifactId>webjars-locator-core</artifactId> </dependency> <dependency> <groupId>org.webjars</groupId> <artifactId>sockjs-client</artifactId> <version>1.1.2</version> </dependency> <dependency> <groupId>org.webjars</groupId> <artifactId>stomp-websocket</artifactId> <version>2.3.3</version> </dependency> <dependency> <groupId>org.webjars</groupId> <artifactId>jquery</artifactId> <version>3.3.1</version> </dependency>
spring-boot-starter-websocket依赖是Web Socket相关依赖，
其他的都是前端库，使用jar包的形式对这些前端库进行统一管理，使用webjar添加到项目中的前端库，在Spring Boot项目中已经默认添加了静态资源过滤，因此可以直接使用。
配置WebSocket:
Spring框架提供了基于WebSocket的STOMP支持，STOMP是一个简单的可互操作的协议，通常被用于通过中间服务器在客户端之间进行异步消息传递。WebSocket配置如下：
// 自定义类WebSocketConfig继承自WebSocketMessageBrokerConfigurer进行WebSocket配置
@Configuration
@EnableWebSocketMessageBroker // 开启WebSocket消息代理
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
@Override
public void configureMessageBroker(MessageBrokerRegistry config) {
/*
* 表示设置消息代理的前缀，即如果消息的前缀是“/topic”，就会将消息转发给消息代理（broker），再由消息代理将消息广播给当前连接的客户端。
*/
config.enableSimpleBroker("/topic", "/queue");
/*
* 表示配置一个或多个前缀，通过这些前缀过滤出需要被注解方法处理的消息
* 例如，前缀为“/app”的destination可以通过@MessageMapping注解的方法处理，
* 而其他destination（例如“/ topic”“/ queue”）将被直接交给broker处理。
*/
config.setApplicationDestinationPrefixes("/app");
}
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
/*
* 表示定义一个前缀为“/chat”的endPoint，并开启sockjs支持，
* sockjs可以解决浏览器对WebSocket的兼容性问题，
* 客户端将通过这里配置的URL来建立WebSocket连接。
*/
registry.addEndpoint("/chat").withSockJS();
}
}
定义Controller:
定义一个Controller用来实现对消息的处理，代码如下
@Controller
public class GreetingController {
@Autowired
SimpMessagingTemplate messagingTemplate;
@MessageMapping("/hello") // 用来接收“/app/hello”路径发送来的消息 在注解方法中对消息进行处理后，再将消息转发到@SendTo定义的路径上
@SendTo("/topic/greetings") // @SendTo路径是一个前缀为“/topic”的路径，因此该消息将被交给消息代理broker，再由broker进行广播。
public Message greeting(Message message) {
return message;
}
@MessageMapping("/chat")
public void chat(Principal principal, Chat chat) {
String from = principal.getName();
chat.setFrom(from);
messagingTemplate.convertAndSendToUser(chat.getTo(), "/queue/chat", chat);
}
}
构建聊天页面:
在resources/static目录下创建chat.html页面作为聊天页面，代码如下
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<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 src="/app.js"></script>
</head>
<body>
<div>
<label for="name">请输入用户名：</label>
<input type="text" id="name" placeholder="用户名">
</div>
<div>
<button id="connect" type="button">连接</button>
<button id="disconnect" type="button" disabled="disabled">断开连接</button>
</div>
<div id="chat" style="display: none;">
<div>
<label for="name">请输入聊天内容：</label>
<input type="text" id="content" placeholder="聊天内容">
</div>
<button id="send" type="button">发送</button>
<div id="greetings">
<div id="conversation" style="display: none">群聊进行中...</div>
</div>
</div>
</body>
</html>
app.js是一个自定义JS，代码如下
var stompClient = null;
function setConnected(connected) {
$("#connect").prop("disabled", connected);
$("#disconnect").prop("disabled", !connected);
if (connected) {
$("#conversation").show();
$("#chat").show();
} else {
$("#conversation").hide();
$("#chat").hide();
}
$("#greetings").html("");
}
/**
* connect方法表示建立一个WebSocket连接
*/
function connect() {
// 在建立WebSocket连接时，用户必须先输入用户名，然后才能建立连接
if (!$("#name").val()) {
return;
}
var socket = new SockJS('/chat');// 首先使用SockJS建立连接
stompClient = Stomp.over(socket); // 然后创建一个STOMP实例发起连接请求
stompClient.connect({}, function (frame) {
setConnected(true);// 在连接成功的回调方法中，首先调用setConnected(true);方法进行页面的设置
//然后调用STOMP中的subscribe方法订阅服务端发送回来的消息，
stompClient.subscribe('/topic/greetings', function (greeting) {
showGreeting(JSON.parse(greeting.body));// 并将服务端发送来的消息展示出来（使用showGreeting方法）。
});
});
}
function disconnect() {
if (stompClient !== null) {
// 调用STOMP中的disconnect方法可以断开一个WebSocket连接。
stompClient.disconnect();
}
setConnected(false);
}
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();
});
});
测试:
接下来启动Spring Boot项目进行测试，在浏览器中输入http://localhost:8081/chat.html
文章来源: Spring Boot+Vue全栈开发实战 - 11.3 Spring Boot整合WebSocket