spring-boot整合websocket
2019-03-26 本文已影响0人
okcdev
WebSocket简介
随着互联网的发展，传统的HTTP协议已经很难满足Web应用日益复杂的需求了。近年来，随着HTML5的诞生，WebSocket协议被提出，它实现了浏览器与服务器的全双工通信，扩展了浏览器与服务端的通信功能，使服务端也能主动向客户端发送数据。
我们知道，传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如 浏览器）主动发起，服务端进行处理后返回response结果，而服务端很难主动向客户端发送数据；这种客户端是主动方，服务端是被动方的传统Web模式。对于信息变化不频繁的Web应用来说造成的麻烦较小，而对于涉及实时信息的Web应用却带来了很大的不便，如带有即时通信、实时数据、订阅推送等功能的应用。在WebSocket规范提出之前，开发人员若要实现这些实时性较强的功能，经常会使用折衷的解决方法：轮询（polling）和Comet技术。其实后者本质上也是一种轮询，只不过有所改进。
轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求，频繁地查询是否有新的数据改动。明显地，这种方法会导致过多不必要的请求，浪费流量和服务器资源。
这两种技术都是基于请求-应答模式，都不算是真正意义上的实时技术；它们的每一次请求、应答，都浪费了一定流量在相同的头部信息上，并且开发复杂度也较大。
伴随着HTML5推出的WebSocket，真正实现了Web的实时通信，使B/S模式具备了C/S模式的实时通信能力。WebSocket的工作流程是这 样的：浏览器通过JavaScript向服务端发出建立WebSocket连接的请求，在WebSocket连接建立成功后，客户端和服务端就可以通过 TCP连接传输数据。因为WebSocket连接本质上是TCP连接，不需要每次传输都带上重复的头部数据，所以它的数据传输量比轮询和Comet技术小 了很多。本文不详细地介绍WebSocket规范，主要介绍下WebSocket在Java Web中的实现。
本文主要介绍了websocket在spring-boot上的搭建原理，已经部分demo的参考。
引入websocket依赖
<dependency>
<groupId>org.springframework.boot
<artifactId>spring-boot-starter-websocket
</dependency>
配置WebSocketConfig
/*
* File: WebSocketConfig.java
* Created By: fengtao.xue@gausscode.com
* Date: 2019-03-20
*/
package cn.feng.dev.websocket.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* @author fengtao.xue
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
WebSocketServer
/*
* File: WebSocketServer.java
* Created By: fengtao.xue@gausscode.com
* Date: 2019-03-21
*/
package cn.gausscode.calo.frontend.rest.websocket;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;
/**
* @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
* 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
* @author fengtao.xue
*/
@ServerEndpoint("/websocket/{userId}")
@Component
public class WebSocketServer {
static Logger logger = LoggerFactory.getLogger(WebSocketServer.class);
//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static final AtomicInteger OnlineCount = new AtomicInteger(0);
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话，可以使用Map来存放，其中Key可以为用户标识
private static ConcurrentHashMap<String, WebSocketServer> webSocketSet = new ConcurrentHashMap<String,WebSocketServer>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session WebSocketsession;
//当前发消息的人员userId
private String userId = "";
/**
* 连接建立成功调用的方法*/
@OnOpen
public void onOpen(@PathParam(value = "userId") String param, Session WebSocketsession, EndpointConfig config) {
userId = param;
//log.info("authKey:{}",authKey);
this.WebSocketsession = WebSocketsession;
webSocketSet.put(param, this);//加入map中
int cnt = OnlineCount.incrementAndGet(); // 在线数加1
logger.info("有连接加入，当前连接数为：{}", cnt);
sendMessage(this.WebSocketsession, "连接成功");
}
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
if (!userId.equals("")){
webSocketSet.remove(userId);//从set中删除
int cnt = OnlineCount.decrementAndGet();
logger.info("有连接关闭，当前连接数为：{}", cnt);
}
}
/**
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息*/
@OnMessage
public void onMessage(String message, Session session) {
logger.info("来自客户端的消息：{}",message);
sendMessage(session, "收到消息，消息内容："+message);
}
/**
*
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
logger.error("发生错误：{}，Session ID： {}",error.getMessage(),session.getId());
error.printStackTrace();
}
/**
* 发送消息，实践表明，每次浏览器刷新，session会发生变化。
* @param message
*/
public void sendMessage(Session session, String message) {
try {
session.getBasicRemote().sendText(String.format("%s (From Server，Session ID=%s)",message,session.getId()));
//session.getBasicRemote().sendText(String.format("%s",message));
} catch (IOException e) {
logger.error("发送消息出错：{}", e.getMessage());
e.printStackTrace();
}
}
/**
* 群发消息
* @param message
* @throws IOException
*/
public void broadCastInfo(String message) {
for (String key : webSocketSet.keySet()) {
Session session = webSocketSet.get(key).WebSocketsession;
if(session != null && session.isOpen() && !userId.equals(key)){
sendMessage(session, message);
}
}
}
/**
* 指定Session发送消息
* @param message
* @throws IOException
*/
public void sendToUser(String userId, String message) {
WebSocketServer webSocketServer = webSocketSet.get(userId);
if ( webSocketServer != null && webSocketServer.WebSocketsession.isOpen()){
sendMessage(webSocketServer.WebSocketsession, message);
}
else{
logger.warn("当前用户不在线：{}",userId);
}
}
}
Controller
/*
* File: Controller.java
* Created By: fengtao.xue@gausscode.com
* Date: 2019-03-20
*/
package cn.feng.dev.websocket.web;
import cn.feng.dev.websocket.service.WebSocketServer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.io.IOException;
/**
* @author fengtao.xue
*/
@RestController
public class Controller {
static Logger logger = LoggerFactory.getLogger(Controller.class);
@Autowired
WebSocketServer webSocketServer;
/**
* 群发消息内容
*
* @param message
* @return
*/
@RequestMapping(value = "/ws/sendAll", method = RequestMethod.GET)
public String sendAllMessage(@RequestParam(required = true) String message) {
try {
webSocketServer.broadCastInfo(message);
} catch (IOException e) {
e.printStackTrace();
}
return "success";
}
/**
* 指定会话ID发消息
*
* @param message 消息内容
* @param userId 连接会话ID
* @return
*/
@RequestMapping(value = "/ws/sendOne", method = RequestMethod.GET)
public String sendOneMessage(@RequestParam(required = true) String message,
@RequestParam(required = true) String userId) {
try {
webSocketServer.sendToUser(userId, message);
} catch (IOException e) {
e.printStackTrace();
}
return "success";
}
}
index.html
<!DOCTYPE html>
<!--
功能：WebSocket使用示例
-->
<html>
<head>
<!--<link href="/webjars/bootstrap/css/bootstrap.min.css" rel="stylesheet">
<link href="/main.css" rel="stylesheet">
<script src="/webjars/jquery/jquery.min.js"></script>-->
<meta charset="UTF-8">
<title>websocket测试</title>
<style type="text/css">
h3,h4{
text-align:center;
}
</style>
</head>
<body>
<h3>WebSocket测试，在<span style="color:red">控制台</span>查看测试信息输出！</h3>
<h4>http://okcdev.cn</h4>
<h4>
[url=/ws/sendOne?message=单发消息内容&id=none]单发消息链接[/url]
[url=/ws/sendAll?message=群发消息内容]群发消息链接[/url]
</h4>
<div class="row">
<div class="col-md-12">
<table id="conversation" class="table table-striped">
<thead>
<tr>
<th>Greetings</th>
</tr>
</thead>
<tbody id="greetings">
</tbody>
</table>
</div>
</div>
<script type="text/javascript">
function setMessageInnerHTML(sendMessage) {
document.getElementById('greetings').innerHTML += sendMessage + '<br/>';
}
var socket;
var userId = 11111111111;
if (typeof (WebSocket) == "undefined") {
console.log("遗憾：您的浏览器不支持WebSocket");
} else {
console.log("恭喜：您的浏览器支持WebSocket");
//实现化WebSocket对象
//指定要连接的服务器地址与端口建立连接
//注意ws、wss使用不同的端口。我使用自签名的证书测试，
//无法使用wss，浏览器打开WebSocket时报错
//ws对应http、wss对应https。
socket = new WebSocket("ws://localhost:8080/websocket/" + userId);
//连接打开事件
socket.onopen = function() {
console.log("Socket 已打开");
//socket.send("消息发送测试(From Client)");
};
//收到消息事件
socket.onmessage = function(msg) {
console.log(msg.data);
setMessageInnerHTML(msg.data);
//$("#greetings").append("<tr><td>" + msg.data + "</td></tr>");
};
//连接关闭事件
socket.onclose = function() {
console.log("Socket已关闭");
};
//发生了错误事件
socket.onerror = function() {
alert("Socket发生了错误");
}
//监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
window.onbeforeunload = function () {
closeWebSocket();
}
//关闭WebSocket连接
function closeWebSocket() {
socket.close();
}
//窗口关闭时，关闭连接
/*window.unload=function() {
socket.close();
};*/
}
</script>
</body>
</html>
工程结构路径
image.png
运行效果
image.png
