本文主要参考官方文档：https://spring.io/guides/gs/messaging-stomp-websocket/
演示效果：
第一步：新建一个springboot项目
使用Spring Initializr创建springboot项目，地址：https://start.spring.io/
第二步：导入第一步创建的springboot项目至eclipse
第三步：添加WebSocket依赖
<!-- web 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 热启动依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
<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.0.2</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>stomp-websocket</artifactId>
<version>2.3.3</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>bootstrap</artifactId>
<version>3.3.7</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>jquery</artifactId>
<version>3.1.0</version>
</dependency>webjars包，是将web资源库（如jqury， bootstrap等）打包成jar包共maven项目调用的jar包，参考地址：https://www.webjars.org/，如采用前后端分离项目，则可不引用该依赖。 html引用前端框架是，引用的js根目录为/webjars，如：
<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>
第四步：编写WebSocket配置类
新建WebSocketConfig类，实现WebSocketMessageBrokerConfigurer，覆写registerStompEndpoints和configureMessageBroker两个方法。
/**
* WebSocket配置类，实现WebSocketMessageBrokerConfigurer
* @author Lenovo
*
*/
@Configuration
@EnableWebSocketMessageBroker
public class WebsocketConfig implements WebSocketMessageBrokerConfigurer {
/**
* 注册端点
* setAllowedOrigins非必须，*表示允许任何 域名连接
*/
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
registry.addEndpoint("/endpoint-websocket").setAllowedOrigins("*").withSockJS();
}
/**
* enableSimpleBroker配置订阅服务端前缀
* setApplicationDestinationPrefixes 配置客户端发送前缀
*/
@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {
registry.enableSimpleBroker("/topic", "/chat");
registry.setApplicationDestinationPrefixes("/app");
}
}
第五步：创建消息对象InMessage
public class InMessage {
private String from;
private String to;
private String content;
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone="GMT+8")
private Date time;
/* getter、setter方法略 */
第六步：控制层接口
@MessageMapping("/hello") //响应前端发送链接为"/app/hello"的消息
@SendTo("/topic/greetings") //返回消息链接，前端订阅该链接的端口都能收到该消息
public InMessage greeting(InMessage message){
message.setTime(new Date());
System.out.println("from:" + message.getFrom() + ", to:" + message.getTo() +
", content:" + message.getContent() + ", time:" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(message.getTime()));
return message;
}
@MessageMapping("/hello")，类似与@RequestMapping， 专门用于websocket的消息响应，在WebSocketCofig类配置了客户端发送前缀 ，去掉前缀后则在该方法中响应；
@SendTo("/topic/greetings")， 标志返回的消息发送路径，只要前端订阅了该接口，则可接收到响应的消息对象。
第七步：前端html和js
1、static/index.html
<!DOCTYPE html>
<html>
<head>
<title>Hello WebSocket</title>
<link href="/webjars/bootstrap/css/bootstrap.min.css" rel="stylesheet">
<!-- <link href="/main.css" rel="stylesheet"> -->
<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>
<noscript>
<h2 style="color: #ff0000">
Seems your browser doesn't support Javascript! Websocket relies on Javascript being enabled. Please enable
Javascript and reload this page!</h2>
</noscript>
<div id="main-content" class="container">
<div class="row">
<div class="col-md-4">
<form class="form-inline">
<div class="form-group">
<label for="connect">WebSocket connection:</label>
<button id="connect" class="btn btn-default" type="submit">Connect</button>
<button id="disconnect" class="btn btn-default" type="submit" disabled="disabled">Disconnect
</button>
</div>
</form>
</div>
<div class="col-md-8">
<form class="form-inline">
<div class="form-group">
<label for="name">Name:</label>
<input type="text" id="name" class="form-control" placeholder="Your name here...">
<label for="content">Content:</label>
<input type="text" id="content" class="form-control" placeholder="Your send content" />
</div>
<button id="send" class="btn btn-default" type="submit">Send</button>
</form>
</div>
</div>
<div class="row">
<div class="col-md-12">
<table id="conversation" class="table table-striped">
<thead>
<tr>
<th>Greetings</th>
</tr>
<tr><th>From</th><th>Content</th><th>Time</th></tr>
</thead>
<tbody id="greetings">
</tbody>
</table>
</div>
</div>
</div>
</body>
</html>
2、static/app.js
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('/endpoint-websocket');
stompClient = Stomp.over(socket);
stompClient.connect({}, function (frame) {
setConnected(true);
console.log('Connected: ' + frame);
stompClient.subscribe('/topic/greetings', function (greeting) {
console.log(greeting);
showGreeting(JSON.parse(greeting.body));
});
});
}
function disconnect() {
if (stompClient !== null) {
stompClient.disconnect();
}
setConnected(false);
console.log("Disconnected");
}
function sendName() {
stompClient.send("/app/hello", {}, JSON.stringify({'from': $("#name").val(), 'content':$("#content").val()}));
}
function showGreeting(message) {
$("#greetings").append("<tr><td>" + message.from + "</td><td>" + message.content + "</td><td>" + message.time + "</td></tr>");
}
$(function () {
$("form").on('submit', function (e) {
e.preventDefault();
});
$( "#connect" ).click(function() { connect(); });
$( "#disconnect" ).click(function() { disconnect(); });
$( "#send" ).click(function() { sendName(); });
});
1643
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
