当前位置： 移动技术网 > IT编程>开发语言>Java > 通过实例讲解springboot整合WebSocket

通过实例讲解springboot整合WebSocket

2019年07月19日  | 移动技术网IT编程  | 我要评论

一、背景

我们都知道 http 协议只能浏览器单方面向服务器发起请求获得响应，服务器不能主动向浏览器推送消息。想要实现浏览器的主动推送有两种主流实现方式：

  • 轮询：缺点很多，但是实现简单
  • websocket：在浏览器和服务器之间建立 tcp 连接，实现全双工通信

springboot 使用 websocket 有两种方式，一种是实现简单的 websocket，另外一种是实现stomp协议。这一篇实现简单的 websocket，stomp 下一篇在讲。

注意：如下都是针对使用 springboot 内置容器

二、实现

1、依赖引入

要使用 websocket 关键是@serverendpoint这个注解，该注解是 javaee 标准中的注解,tomcat7 及以上已经实现了,如果使用传统方法将 war 包部署到 tomcat 中，只需要引入如下 javaee 标准依赖即可：

<dependency>
<groupid>javax</groupid>
<artifactid>javaee-api</artifactid>
<version>7.0</version>
<scope>provided</scope>
</dependency>

如使用 springboot 内置容器,无需引入，springboot 已经做了包含。我们只需引入如下依赖即可：

<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-websocket</artifactid>
<version>1.5.3.release</version>
<type>pom</type>
</dependency>

2、注入 bean

首先注入一个serverendpointexporterbean,该 bean 会自动注册使用@serverendpoint 注解申明的 websocket endpoint。代码如下：

@configuration
public class websocketconfig {
@bean
public serverendpointexporter serverendpointexporter(){
return new serverendpointexporter();
}
}

3、申明 endpoint

建立mywebsocket.java类，在该类中处理 websocket 逻辑

@serverendpoint(value = "/websocket") //接受websocket请求路径
@component //注册到spring容器中
public class mywebsocket {
//保存所有在线socket连接
private static map<string,mywebsocket> websocketmap = new linkedhashmap<>();
//记录当前在线数目
private static int count=0;
//当前连接（每个websocket连入都会创建一个mywebsocket实例
private session session;
private logger log = loggerfactory.getlogger(this.getclass());
//处理连接建立
@onopen
public void onopen(session session){
this.session=session;
websocketmap.put(session.getid(),this);
addcount();
log.info("新的连接加入：{}",session.getid());
}
//接受消息
@onmessage
public void onmessage(string message,session session){
log.info("收到客户端{}消息：{}",session.getid(),message);
try{
this.sendmessage("收到消息："+message);
}catch (exception e){
e.printstacktrace();
}
}
//处理错误
@onerror
public void onerror(throwable error,session session){
log.info("发生错误{},{}",session.getid(),error.getmessage());
}
//处理连接关闭
@onclose
public void onclose(){
websocketmap.remove(this.session.getid());
reducecount();
log.info("连接关闭:{}",this.session.getid());
}
//群发消息
//发送消息
public void sendmessage(string message) throws ioexception {
this.session.getbasicremote().sendtext(message);
}
//广播消息
public static void broadcast(){
mywebsocket.websocketmap.foreach((k,v)->{
try{
v.sendmessage("这是一条测试广播");
}catch (exception e){
}
});
}
//获取在线连接数目
public static int getcount(){
return count;
}
//操作count，使用synchronized确保线程安全
public static synchronized void addcount(){
mywebsocket.count++;
}
public static synchronized void reducecount(){
mywebsocket.count--;
}
}

4、客户的实现

客户端使用 h5 原生 websocket，部分浏览器可能不支持。代码如下：

<html>
<head>
<title>websocket测试</title>
<meta charset="utf-8" />
</head>
<body>
<button onclick="sendmessage()">测试</button>
<script>
let socket = new websocket("ws://localhost:8080/websocket");
socket.onerror = err => {
console.log(err);
};
socket.onopen = event => {
console.log(event);
};
socket.onmessage = mess => {
console.log(mess);
};
socket.onclose = () => {
console.log("连接关闭");
};
function sendmessage() {
if (socket.readystate === 1) socket.send("这是一个测试数据");
else alert("尚未建立websocket连接");
}
</script>
</body>
</html>

三、测试

建立一个 controller 测试群发，代码如下：

@restcontroller
public class homecontroller {
@getmapping("/broadcast")
public void broadcast(){
mywebsocket.broadcast();
}
}

然后打开上面的 html，可以看到浏览器和服务器都输出连接成功的信息：

浏览器：
event {istrusted: true, type: "open", target: websocket, currenttarget: websocket, eventphase: 2, …}
服务端：
2018-08-01 14:05:34.727 info 12708 --- [nio-8080-exec-1] com.fxb.h5websocket.mywebsocket : 新的连接加入：0

点击测试按钮，可在服务端看到如下输出：

2018-08-01 15:00:34.644 info 12708 --- [nio-8080-exec-6] com.fxb.h5websocket.mywebsocket : 收到客户端2消息：这是一个测试数据

再次打开 html 页面，这样就有两个 websocket 客户端，然后在浏览器访问localhost:8080/broadcast测试群发功能,每个客户端都会输出如下信息：

messageevent {istrusted: true, data: "这是一条测试广播", origin: "ws://localhost:8080", lasteventid: "", source: null, …}

源码可在 github 上下载

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持移动技术网。

您可能感兴趣的文章:

如对本文有疑问， 点击进行留言回复！！

相关文章:

验证码：
最近更新的文章
大家感兴趣的文章
移动技术网