【小笔记】基于SpringBoot使用WebSocket进行前后端通信

yue_hu

已于 2023-02-16 09:53:27 修改

阅读量2.2k

点赞数 2

分类专栏：框架小笔记前端文章标签： websocket spring boot java

于 2022-08-05 17:09:59 首次发布

本文链接：https://blog.csdn.net/yue_hu/article/details/126181498

版权

小笔记同时被 3 个专栏收录

23 篇文章 0 订阅

订阅专栏

框架

6 篇文章 0 订阅

订阅专栏

前端

3 篇文章 0 订阅

订阅专栏

前言

前端向后端发送消息请求相应的接口就可以了。但是有些场景：比如聊天室互相发送消息或者进度条跟踪。如果仅靠前端主动发起通信获得消息的话就需要不断的轮询后端获得最新数据。这种方式会造成带宽等资源的浪费（因为请求http请求可能包含较长的请求头，而真正有用的可能只是其中的一小部分），而且还会增加后端的压力。如果后端能主动向前端推送消息就能很简单的解决这个问题。

一种比较新的技术去做轮询的效果是Comet。这种技术虽然可以双向通信，但依然需要反复发出请求。而且在Comet中，普遍采用的长链接，也会消耗服务器资源。
在这种情况下，HTML5定义了WebSocket协议，能更好的节省服务器资源和带宽，并且能够更实时地进行通讯。
WebSocket是一种在单个TCP连接上进行全双工通信的协议，WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket
API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。 - 百度百科[WebSocket]

使用

后端

1：引入依赖
springboot集成了WebSocket模块，直接以下引入依赖即可：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

2：启用WebSocket
创建配置类启用WebSocket支持,用@Configuration和@Bean纳入spring

@Configuration
public class WebSocketConfig {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

2：定义接口

@Component
// ServerEndpoint就是一个url,和Controller的@RequestMapping差不多
@ServerEndpoint("/ws/test/{id}")
public class WebSocketServer {


    /*-----------------注入Bean:start---------------*/
    /**注入bean的方式，因为spring管理的都是单例。WebSocket不是单例,所以要用这种方式注入Bean,直接将@Resource放到属性上注入会报错*/
    // 定义成静态的一次注入大家就都能访问到了
    // 注意，这个不是必须的，只是说如果你有注入的操作的话可以通过这个方式来做注入
    private static TestResourceBean bean;
    @Resource
    public void setTestResourceBean(TestResourceBean bean) {
        WebSocketServer.bean = bean;
    }
    /*-----------------注入Bean:end---------------*/


    /**与某个客户端的连接会话，需要通过它来给客户端发送数据,
     * 也可以通过session().close();主动关闭连接
     * */
    private Session session;

    /**
     * 业务标识,用的到的话就加，用不到就不要
     */
    private String id;

    /**
     * 一个Map,其实就是一个容器，用来让你找到对应的session。
     * 你可以用任何方式实现，只要能满足你的业务就行。比如我不需要指定发送的话甚至可以直接定义为List
     * 定义为static是因为大家都要访问这个容器，要数据共通。或者你把这个容器放在另外一个类里面维护也行
     */
    public static Map<String, WebSocketServer> socketServerMap = new ConcurrentHashMap<>();

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("id") String id) {
        this.session = session;
        this.id = id;
        socketServerMap.put(id,this);
    }

    /**
     * 连接关闭,调用的方法。用isEnd做懒模式的结束
     */
    @OnClose
    public void onClose() {
        // 如果你用容器保存了实例，那么在关闭时记得移除，不然就内存溢出了
        socketServerMap.remove(this.id);
        /*...*/
    }

    /**
     * 错误回调
     */
    @OnError
    public void onError(Session session, Throwable error) {
        /*...*/
    }

    public Session getSession() {
        return this.session;
    }

    /**
     * 服务器主动推送消息，你可以把这个方法写成静态的，然后入参加一个id,这样就能通过静态方法定向推送消息：注意不要把session定义成静态哦，而是把容器定义为静态
     */
    public void sendMessage(String message) {
        try {
            this.session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

}

前端

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>websocket使用</title>
</head>
<script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.js"></script>
<script>
    var socket;
    function openSocket() {
        if(typeof(WebSocket) == "undefined") {
            console.log("您的浏览器不支持WebSocket");
        }else{
            console.log("您的浏览器支持WebSocket");
            //指定要连接的服务器地址与端口
            var socketUrl="http://localhost:8888/ws/test/2";
			// 替换为ws,这里url直接写ws也是一样的
            socketUrl=socketUrl.replace("https","wss").replace("http","ws");
            console.log(socketUrl);
            if(socket!=null){
                socket.close();
                socket=null;
            }
			// 实例化WebSocket对象，建立连接
            socket = new WebSocket(socketUrl);
            //打开事件
            socket.onopen = function() {
                console.log("websocket已打开");
            };
            //获得消息事件
            socket.onmessage = function(msg) {
                console.log(msg.data);
                //消息进入后的处理逻辑
            };
            //关闭事件
            socket.onclose = function() {
                console.log("websocket已关闭");
            };
            //发生了错误事件
            socket.onerror = function() {
                console.log("websocket发生了错误");
            }
        }
    }
    function sendMessage() {
        if(typeof(WebSocket) == "undefined") {
            console.log("您的浏览器不支持WebSocket");
        }else {
            console.log("您的浏览器支持WebSocket");
            socket.send('这是一条测试消息');
        }
    }
</script>
<body>
<div><a onclick="openSocket()">连接socket</a></div>
<div><a onclick="sendMessage()">发送消息</a></div>
</body>
</html>

现在就能使用WebSocket进行前后端通信了。

运维-nginx

如果请求通过nginx做负载均衡，那么通过上述工作会发现还是连接不上，这是因为websocket监听的是端口，经过nginx转发后就失效了，此时需要在nginx上配置反向代理。



#下面这一块表示的是：
#如果 $http_upgrade 不为 '' (空)，则 $connection_upgrade 为 upgrade 。
#如果 $http_upgrade 为 '' (空)，则 $connection_upgrade 为 close。
map $http_upgrade $connection_upgrade {
        default upgrade;
        ''      close;
    }



#这一块表示的是 nginx负载均衡，就是你想提供websocket服务的列表
upstream websocket {    
	server ip1:port1;
	server ip2:port2;
}



#如果这台nginx负责多个server,记得要放到对应的那个里面

server {

	# 这里会有listen,server_name之类的，
    # /websocket/是指你要识别的链接，websocket这个字母你可以自定义
    # http://websocket;就是指向上面你配置的服务器，websocket也可以自定义，和上面upstream 对的上就行
location /websocket/ {
  proxy_pass http://websocket;
  proxy_http_version 1.1;
  proxy_set_header Upgrade $http_upgrade;
  proxy_set_header Connection $connection_upgrade;
}

}

这一块可以看官方文档：WebSocket proxying
这些配好就可以访问了。访问时注意，你的域名要和你的配置所在的server对应上。
同时如果是https访问则需要用wss,如果是http则需要用ws。之前已经在前端工作这一块写出了：

socketUrl=socketUrl.replace("https","wss").replace("http","ws");

配了nginx依然连接失败

配了nginx依然失败的话，那就需要注意你的域名是不是配置了CDN，因为如果配置了CDN，那你的请求会先打到CDN上，想要解决换一个没有配置CDN的域名即可。

维持

websocket具有超时时间，如果在超时时间内没有消息发送，webscoket就会断开连接。因此就需要心跳来保持连接。对于websocket来说，心跳并不是websocket提供的机制。心跳需要自己完成，简单的说就是前端或者后端自己在超时时间内以固定频率进行消息交互重置超时时间保持连接。

参考资料：
SpringBoot2.0集成WebSocket，实现后台向前端推送信息
 Nginx配置WebSocket

yue_hu

关注

2
点赞
踩
17

收藏

觉得还不错? 一键收藏
打赏
0
评论
【小笔记】基于SpringBoot使用WebSocket进行前后端通信

前端向后端发送消息请求相应的接口就可以了。但是有些场景：比如聊天室互相发送消息或者进度条跟踪。如果仅靠前端主动发起通信获得消息的话就需要不断的轮询后端获得最新数据。这种方式会造成带宽等资源的浪费（因为请求http请求可能包含较长的请求头，而真正有用的可能只是其中的一小部分），而且还会增加后端的压力。如果后端能主动向前端推送消息就能很简单的解决这个问题。一种比较新的技术去做轮询的效果是Comet。这种技术虽然可以双向通信，但依然需要反复发出请求。而且在Comet中，普遍采用的长链接，也会消耗服务器资源。...
复制链接

扫一扫