章节索引 :

上个小节我们已经可以成功付款,并且后端项目的Web方法接收到了付款成功的通知,罚款记录的状态从“未付款”变成了“已付款”。这节课我们要给SpringBoot配置上WebSocket,这样将来才可以推送付款成功的结果给前端页面。

图片描述

一、缓存WebSocket连接

WebSocket类似于Servlet,需要我们声明一些生命周期函数,而且这些函数还都不是我们能主动调用的。

@ServerEndpoint(value = "/mysocket")
@Component
public class MyWebSockertService{
    @OnOpen
    public void onOpen(Session session) {
        //创建WebSocket连接时候执行
    }

    @OnClose
    public void onClose(Session session) {
        //管理WebSocket连接时候执行
    }

    @OnMessage
    public void onMessage(String message, Session session) {
       //接收消息时候执行
    }

    @OnError
    public void onError(Session session, Throwable error) {
        //发生错误时候执行
    }
    
}

向客户端发送消息,需要使用Session对象。但是这些生命周期函数都由于客户端某种操作,而触发执行的。如果客户端不触发操作,那么后端是无法主动给客户端发送消息的。所以我们要把Session对象缓存起来。需要的时候,我们提取缓存的Session,主动向客户端发送消息。

因为后端的WebSocket服务类是多例的,所以我们想要全局共享缓存,要么用Redis,要么声明静态的HashMap对象。如果选用Redis,那么保存Session对象要用到序列化,会消耗一定的时间,所以不建议使用。如果全局共享使用HashMap,又会存在并发读写的问题,最终我们选择ConcurrentHashMap类。

二、配置WebSocket

com.example.emos.api.config包中创建WebSocketConfig.java类,用于给SpringBoot添加WebSocket功能。

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

创建com.example.emos.api.websocket包,定义WebSocketService.java类,用于负责处理WebSocket连接。这个类是多例的,每次有客户端用WebSocket连接这个类,Spring就会创建一个新的WebSocketService对象,所以大家不用担心线程安全的问题。

因为WebSocket是长连接协议,它完全异于Http协议,所以我们不能用处理Http请求和响应的想法去看待WebSocket连接。例如我们在Http协议上很轻松可以传递Cookie数据,但是WebSocket不支持Cookie,所以我们要自己把Token字符串上传给服务端,然后服务端不能用StpUtil.getUserIdAsInt()获取到UserId,我们要自己从Token字符串中提取UserId出来。

在WebSocket中,我们要约定跟客户端传递数据的格式。为了能让数据看起来格式规整,我采用传递JSON字符串的方式。

参数 含义 例子
opt 操作行为 ping
token 令牌字符串 eyJzb2Z0d2FyZV9pZCI6IjROUkIxLTBYWkFCWkk5RTYtNVNNM1IiLCJjbGll
其他参数 其他参数 (略)
@Slf4j
@ServerEndpoint(value = "/socket")
@Component
public class WebSocketService {

    //用于保存WebSocket连接对象
    public static ConcurrentHashMap<String, Session> sessionMap = new ConcurrentHashMap<>();

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(Session session) {
        Map map = session.getUserProperties();
        if (map.containsKey("userId")) {
            String userId = MapUtil.getStr(map, "userId");
            sessionMap.remove(userId);
        }
    }

    /**
     * 接收消息
     *
     * @param message
     * @param session
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        //把字符串转换成JSON
        JSONObject json = JSONUtil.parseObj(message);
        String opt = json.getStr("opt");
        if("ping".equals(opt)){
            return;
        }
        //从JSON中取出Token
        String token = json.getStr("token");
        //从Token取出userId
        String userId = StpUtil.stpLogic.getLoginIdByToken(token).toString();
        
        //取出Session绑定的属性
        Map map = session.getUserProperties();
        //如果没有userId属性,就给Session绑定userId属性,关闭连接的时候会用到
        if (!map.containsKey("userId")) {
            map.put("userId", userId);
        }
        //把Session缓存起来
        if (sessionMap.containsKey(userId)) {
            //替换缓存中的Session
            sessionMap.replace(userId, session);
        } else {
            //向缓存添加Session
            sessionMap.put(userId, session);
        }
        sendInfo("ok",userId);
        
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误", error);
    }
    
    /**
     * 发送消息给客户端
     */
    public static void sendInfo(String message, String userId) {
        if (StrUtil.isNotBlank(userId) && sessionMap.containsKey(userId)) {
            //从缓存中查找到Session对象
            Session session = sessionMap.get(userId);
            //发送消息
            sendMessage(message, session);
        }
    }

    /**
     * 封装发送消息给客户端
     */
    private static void sendMessage(String message, Session session) {
        try {
            session.getBasicRemote().sendText(message);
        } catch (Exception e) {
            log.error("执行异常", e);
        }
    }
}
第一章 搭建开发环境
1-1 导学 1-2 搭建开发环境 1-3 MacOS环境的程序安装 1-4 本课程学习方法介绍 1-5 本章总结
第二章 运行项目工程
2-1 本章介绍 2-2 运行工作流项目 2-3 运行后端SpringBoot项目 2-4 运行移动端和前端项目 2-5 前后端项目分析 2-6 前端页面布局设计 2-7 本章总结
第三章 用户管理模块
3-1 本章介绍 3-2 用户登陆系统的流程说明 3-3 编写用户登陆程序(后端) 3-4 编写用户登陆程序(前端) 3-5 修改密码和退出登陆(后端) 3-6 修改密码和退出登陆(前端) 3-7 查询用户分页数据(后端) 3-8 查询用户分页数据(前端) 3-9 添加新用户(后端) 3-10 添加新用户(前端) 3-11 修改用户信息(后端) 3-12 修改用户信息(前端) 3-13 删除非管理员帐户(后端) 3-14 删除非管理员帐户(前端) 3-15 本章总结
第四章 角色管理
4-1 本章介绍 4-2 查询角色分页数据(后端) 4-3 查询角色分页数据(前端) 4-4 添加新角色(后端) 4-5 添加新角色(前端) 4-6 修改角色信息(后端) 4-7 修改角色信息(前端) 4-8 删除非内置角色(后端) 4-9 删除非内置角色(前端) 4-10 本章总结
第五章 部门管理
5-1 本章介绍 5-2 查询部门分页数据(后端) 5-3 查询部门分页数据(前端) 5-4 添加新部门(后端) 5-5 添加新部门(前端) 5-6 修改部门信息(后端) 5-7 修改部门信息(前端) 5-8 删除无用户的部门(后端) 5-9 删除无用户的部门(前端) 5-10 本章总结
第六章 会议室管理
6-1 本章介绍 6-2 查询会议室分页数据(后端) 6-3 查询会议室分页数据(前端) 6-4 添加新会议室(后端) 6-5 添加新会议室(前端) 6-6 修改会议室信息(后端) 6-7 修改会议室信息(前端) 6-8 删除空闲的会议室(后端) 6-9 删除空闲会议室(前端) 6-10 本章总结
第七章 线下会议管理
7-1 本章介绍 7-2 线下会议日程表(持久层) 7-3 线下会议日程表(业务层&Web层) 7-4 分析线下会议日程表前端设计 7-5 线下会议日程表(前端) 7-6 分析会议申请的执行流程 7-7 用异步线程开启线下会议审批流程 7-8 创建线下会议申请(后端) 7-9 创建线下会议申请(前端) 7-10 线下会议周日历(后端) 7-11 线下会议周日历(前端) 7-12 周日历弹窗浏览会议详情(前端) 7-13 删除线下会议申请(后端) 7-14 删除线下会议申请(前端) 7-15 本章总结 附-1 查询线上会议分页数据(后端) 附-2 查询线上会议分页数据(前端) 附-3 申请线上会议(前端) 附-4 删除线上会议申请(前端)
第八章 会议审批
8-1 章节介绍 8-2 查询会议申请分页数据(后端) 8-3 查询会议申请分页数据(前端) 8-4 查询审批任务详情信息(后端) 8-5 查询审批任务详情信息(前端) 8-6 加载BPMN实时进度图 8-7 审批会议申请(后端) 8-8 审批会议申请(前端) 8-9 本章总结
第九章 TRTC在线视频会议
9-1 本章介绍 9-2 获取用户签名和视频会议室RoomID 9-3 查询参会人,生成视频墙(后端) 9-4 生成视频会议室视频墙(前端) 9-5 如何创建TRTC视频推流 9-6 推送本地视频流,订阅远端视频流 9-7 实现入会签到功能 9-8 实时更新上线参会人列表 9-9 动态显示参会人语音强弱 9-10 挂断TRTC,退出视频会议 9-11 大屏显示某个远端视频 9-12 本地屏幕共享,广播推流 9-13 本章总结
第十章 罚款管理
10-1 本章介绍 10-2 查询罚款分页数据(后端) 10-3 查询罚款分页数据(前端) 10-4 添加新罚款记录(后端) 10-5 添加新罚款记录(前端) 10-6 修改罚款单(后端) 10-7 修改罚款单(前端) 10-8 删除罚款单(后端) 10-9 删除罚款单(前端) 10-10 了解微信Native支付罚款流程 10-11 设置内网穿透,用于接收付款结果 10-12 创建支付订单(持久层&业务层) 10-13 创建支付订单(Web层) 10-14 创建支付订单(前端) 10-15 接收付款结果(后端) 10-16 配置SpringBoot支持WebSo 10-17 推送付款结果 10-18 接收付款结果(前端) 10-19 主动查询付款结果(后端) 10-20 主动查询付款结果(前端) 10-21 本章总结 附-1 查询图表数据(后端) 附-2 显示图表数据(前端)
第十一章 罚款类型管理
11-1 本章介绍 11-2 查询罚款类别分页数据(后端) 11-3 查询罚款类别分页数据(前端) 11-4 添加新罚款类型(后端) 11-5 添加新罚款类型(前端) 11-6 修改罚款类型信息(后端) 11-7 修改罚款类型信息(前端) 11-8 删除罚款类型记录(后端) 11-9 删除罚款类型记录(前端) 11-10 本章总结
第十二章 请假管理
12-1 本章介绍 12-2 查询请假分页数据(后端) 12-3 查询请假分页数据(前端) 12-4 用异步线程开启请假审批 12-5 我要请假(后端) 12-6 我要请假(前端) 12-7 用异步线程关闭请假审批工作流实例 12-8 删除请假申请(后端) 12-9 删除请假申请(前端) 12-10 审批员工请假 12-11 生成请假单(后端) 12-12 生成请假单(前端) 12-13 封装腾讯云存储服务 12-14 执行请假归档(后端) 12-15 上传归档文件(前端) 12-16 执行请假归档(前端) 12-17 本章总结
第十三章 报销管理
13-1 本章介绍 13-2 查询报销分页数据(后端) 13-3 查询报销分页数据(前端) 13-4 用异步线程开启报销审批 13-5 创建报销申请(后端) 13-6 创建报销申请(前端) 13-7 生成PDF报销单(后端) 13-8 生成PDF报销单(前端) 13-9 审批报销申请 13-10 删除报销申请(后端) 13-11 删除报销申请(前端) 13-12 本章总结
第十四章 部署Emos项目
14-1 本章介绍 14-2 选购云主机 14-3 安装Docker环境 14-4 Docker中安装程序 14-5 在Docker中部署Java项目 14-6 在Docker中部署前端项目 14-7 本章总结 附录1 为云主机配置域名
第十五章 扩展功能
15-1 微信扫码登陆(后端生成二维码图片) 15-2 微信扫码登陆(前端加载二维码) 15-3 微信扫码登陆(微信小程序) 15-4 NFC扫码功能简介 15-5 NFC扫码识别
第十六章 员工离职
16-1 员工离职(一) 16-2 员工离职(二) 16-3 调试员工离职功能
第十七章 工作流
17-1 Activiti简介 17-2 创建工作流项目 17-3 BPMN入门 17-4 任务审批 16-5 会议审批工作流(一) 16-6 会议审批工作流(二) 16-7 审批工作流
附录
附录1 创建SpringBoot项目 附录2 集成常用工具库 附录3 整合权限验证与授权 附录4 允许跨域请求 附录5 封装全局异常 附录6 全局处理异常 附录7 开启Java异步执行 附录8 抵御XSS攻击 附录9 创建分页数据封装类