SpringBoot整合通信会话

最新推荐文章于 2024-04-29 20:54:10 发布

小赵呢

最新推荐文章于 2024-04-29 20:54:10 发布

阅读量2.2k

点赞数

分类专栏： springboot 文章标签： spring boot

本文链接：https://blog.csdn.net/weixin_53227758/article/details/124499291

版权

springboot 专栏收录该内容

19 篇文章 1 订阅

订阅专栏

通信会话

1、websocket

1.1 什么是websocket？

WebSocket协议是基于TCP的一种新的网络协议。它实现了客户端与服务器全双工通信，学过计算机网络都知道，既然是全双工，就说明了服务器可以主动发送信息给客户端。这与我们的推送技术或者是多人在线聊天的功能不谋而合。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-psY8nOLN-1651221586912)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220424162957940.png)]

为什么不使用HTTP 协议呢？这是因为HTTP是单工通信，通信只能由客户端发起，客户端请求一下，服务器处理一下，这就太麻烦了。于是websocket应运而生。

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qAR39ML4-1651221586912)[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-sIHOOaix-1651221768271)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220424163024880.png)]$

下面我们就直接开始使用Springboot开始整合。以下案例都在我自己的电脑上测试成功，你可以根据自己的功能进行修改即可。

现在我们的需求是根据这个特点,实现一个多个人的聊天室

这是我们的项目结构

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wvUs4sp2-1651221586913)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220424172712574.png)]$

1.2 使用步骤

1.引入依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-websocket</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

2.建立配置类

@Configuration
public class WebSocketConfig {

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

3.业务层

因为代码比较多,核心代码为

/**
 * 建立成功连接调用的方法
 */
@OnOpen
public void onOpen(Session session, @PathParam("sid") String sid) {
    this.session = session;
    //如果有重复直接返回
    for (WebSocketServer item : webSocketSet) {
        if (Objects.equals(item.sid, sid)) {
            return;
        }
    }
    webSocketSet.add(this);         //加入set中
    this.sid = sid;
    addOnlineCount();               //在线人数加1
    try {
        sendMessage("conn_success");
        log.info("有新窗口开始监听:" + sid + "当前在线人数为:" + getOnlineCount());
    } catch (IOException e) {
        log.error("websocket IO Exception");
    }
}

/**
 * 收到客户端调用的方法
 */
@OnMessage
public void onMessage(String message, Session session) {
    log.info("来自窗口:" + sid + "的消息" + message);
    //群发消息
    for (WebSocketServer item : webSocketSet) {
        try {
            item.sendMessage("来自窗口:" + sid + "的消息" + message);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

public static void sendInfo(String message) {
    for (WebSocketServer item : webSocketSet) {
        try {
            log.info("推送消息到窗口:" + item.sid + ",推送内容为:" + message);
            item.sendMessage(message);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}

因为我们要建立多人的聊天室,那必须要区分,不同客户端的类型,于是我想到了可以用Web中的路径参数每一个路径参数相当于一个id,之后通过thymeleaf的渲染,使他的路径参数最终变化为WebSocket。

Web类

//页面请求
@GetMapping("/index/{user}")
public String socket(@PathVariable String user, Model model) {
    model.addAttribute("user",user);
    return "index";
}

HTML

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8">
    <title>Java后端WebSocket的Tomcat实现</title>
    <script type="text/javascript" src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
</head>
<body>
<button onclick="create(value)" th:attr="value = ${user}">连接Socket</button>
<br/>
Welcome
<br/><input id="text" type="text"/>

<button onclick="send()">发送消息</button>
<hr/>
<button onclick="closeWebSocket()">关闭WebSocket连接</button>
<hr/>
<div id="message"></div>
</body>
<script type="text/javascript">
    function create(user) {
        //判断当前浏览器是否支持WebSocket
        if ('WebSocket' in window) {
            //改成你的地址
            if (user == null) {
                websocket = new WebSocket("ws://localhost:8080/api/websocket/101");
                init(websocket)
            } else {
                websocket = new WebSocket("ws://localhost:8080/api/websocket/" + user);
                init(websocket)
            }
            setMessageInnerHTML(user + "连接成功");
            return websocket;
        } else {
            alert('当前浏览器 Not support websocket')
        }
    }

    function init(websocket){
        //连接发生错误的回调方法
        websocket.onerror = function () {
            setMessageInnerHTML("WebSocket连接发生错误");
        };

        //连接成功建立的回调方法
        websocket.onopen = function () {
            setMessageInnerHTML("WebSocket连接成功");
        }
        //接收到消息的回调方法
        websocket.onmessage = function (event) {
            console.log(event);
            setMessageInnerHTML(event.data);
        }

        //连接关闭的回调方法
        websocket.onclose = function () {
            setMessageInnerHTML("WebSocket连接关闭");
        }

        //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
        window.onbeforeunload = function () {
            closeWebSocket();
        }
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //关闭WebSocket连接
    function closeWebSocket() {
        websocket.close();
    }

    //发送消息
    function send() {
        var message = document.getElementById('text').value;
        websocket.send('{"msg":"' + message + '"}');
    }
</script>
</html>

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-SXi4RItz-1651221586913)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220424174125326.png)]$

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-L13rU8ke-1651221586913)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220424174111899.png)]$

1.3遇到的问题

首先一开始直接var的websocket之后调用init在create方法外,一直报错找不到websocket,之后定位错误是websocket为非全局函数

2、Session

2.1 前言

概念：服务器端会话技术，在一次会话的多次请求间共享数据，将数据保存在服务器端的对象中。HttpSession

先来说一下一个购物车需求,在用户添加商品到购物车的时候一定要先登录,这个登录状态是用session做的,客户端在购物车中添加一个商品的时候向服务器发送一个请求,创建一个session,之后返回一个当前session对应的id,浏览器存储起来之后每一次更新购物车商品时服务器都会根据请求带的sessionid更新session.

在分布式的环境下session就不适用了,比如,第一个请求在A服务器创建的session而第二个请求分配到了服务器B,那么我们如何解决

2.2 现有问题

1.客户端存储

既然分布式环境中，一个客户端的多个请求可能会落在多个服务器上，那么我们是否可以改不策略，直接将session信息存储在客户端？可以的，服务器将session信息直接存储到cookie中，这样就保证了session的一致性，但是并不推荐这样去做，因为将一些信息存储在cookie中，相当于就把这些信息暴露给了客户端，存在严重的安全隐患。

缺点：

安全性存在问题
cookie对于数据类型及数据大小有所限制

2.session复制

将服务器A的session，复制到服务器B，同样将服务器B的session也复制到服务器A，这样两台服务器的session就一致了。像tomcat等web容器都支持session复制的功能，在同一个局域网内，一台服务器的session会广播给其他服务器。

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-HA06Oc39-1651221586914)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220429113501647.png)]$

缺点：

同一个网段内服务器太多，每个服务器都会去复制session，会造成服务器内存浪费。

3.session黏性

利用Nginx服务器的反向代理，将服务器A和服务器B进行代理，然后采用ip_hash的负载策略，将客户端和服务器进行绑定，也就是说客户端A第一次访问的是服务器B，那么第二次访问也必然是服务器B，这样就不存在session不一致的问题了。

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-DhuXYGrT-1651221586914)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220429113623670.png)]$

缺点：

如果服务器A宕机了，那么客户端A和客户端B的session就会出现丢失。而且这样也就失去了分布式的意义

4.session集中管理

这种方式就是将所有服务器的session进行统一管理，可以使用redis等高性能服务器来集中管理session，而且spring官方提供的spirng-session就是这样处理session的一致性问题。这也是目前企业开发用到的比较多的一种分布式session解决方案。

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rNIcX2P6-1651221586914)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220429113730712.png)]$

2.2 SpringSession实战

Spring提供了处理分布式session的解决方案——Spring Session。Spring Session提供了用于管理用户会话的API和实现。

Spring Session提供了对redis，mongodb，mysql等常用的存储库的支持，Spring Session提供与HttpSession的透明整合，这意味着开发人员可以使用Spring Session支持的实现切换HttpSession实现。还是原来的配方，产生了不一样的味道！

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-FCl0OcpO-1651221586915)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220429114002859.png)]$

Spring Session添加了一个SessionRepositoryFilter的过滤器，用来修改包装请求和响应，包装后的请求为SessionRepositoryRequestWrapper，调用getSession()方法的时候实际上就是调用Spring Session实现了的session。

Spring Session使用非常简单，添加了相关依赖后，直接操作HttpSession就可以实现效果。

第一步导入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-data-redis</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-pool2</artifactId>
</dependency>

第二步配置redis相关信息

spring:
  redis:
    # redis库
    database: 0
    # redis 服务器地址
    host: localhost
    # redis 端口号
    port: 6379
    # redis 密码
    password:
  # session 使用redis存储  
  session:
    store-type: redis

第三步写Controller

@RestController
public class TestController {

    @GetMapping("get")
    public String sessionTest(HttpServletRequest request) {
        HttpSession session = request.getSession();
        ShoppingCart shoppingCart = new ShoppingCart();
        shoppingCart.setShoppingCartName("岚岚的购物车");
        shoppingCart.setCommodityIds(new ArrayList<>());
        session.setAttribute("key", shoppingCart);
        return session.getAttribute("key").toString();
    }

    @GetMapping("getSession")
    public String getSession(HttpServletRequest request){
        HttpSession session = request.getSession();
        return session.getAttribute("key").toString();
    }

    @PostMapping ("addSession")
    public String sessionAdd(@RequestParam(value = "value") Integer value, HttpServletRequest request){
        HttpSession session = request.getSession();
        ShoppingCart shoppingCart = (ShoppingCart) session.getAttribute("key");
        List<Integer> ids = shoppingCart.getCommodityIds();
        ids.add(value);
        shoppingCart.setCommodityIds(ids);
        session.setAttribute("key",shoppingCart);
        return session.getAttribute("key").toString();
    }
}

第四步购物车

@Data
public class ShoppingCart implements Serializable {
    private String ShoppingCartName;
    private List<Integer> CommodityIds;
}

第五步测试

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yjKOPuNg-1651221586915)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220429163351259.png)]$

$(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220429163655815.png)]$

2.3 问题

1.org.springframework.data.redis.serializer.SerializationException: Cannot Serializable。

注意所用到的类要存到redis需要序列化

小赵呢

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot整合通信会话

文章目录通信会话1、websocket1.1 什么是websocket？1.2 使用步骤1.引入依赖2.建立配置类3.业务层Web类HTML1.3遇到的问题2、Session2.1 前言2.2 现有问题1.客户端存储2.session复制3.session黏性4.session集中管理2.2 SpringSession实战第一步导入依赖第二步配置redis相关信息第三步写Controller第四步购物车第五步测试2.3 问题通信会话1、websocket1.1 什么是websocket？WebSoc
复制链接

扫一扫