介绍

  • 在某个项目中用到了websocket的功能，发现需要配置的东西很多，索性就构建了一个基础的模块
  • 该模块只适用于简单的websocket的快速使用
  • 满足了以下功能
    • 消息发送
    • 频道订阅（无限制）
    • 单个用户不同浏览器session共享
    • Jwt鉴权
      • 2.0.4开始

        引入依赖

        1. <dependency>
        2. <groupId>cn.jdevelops</groupId>
        3. <artifactId>webs-socket-client</artifactId>
        4. <version>2.0.4</version>
        5. </dependency>
        6. <dependency>
        7. <groupId>cn.jdevelops</groupId>
        8. <artifactId>utils-jwt</artifactId>
        9. <version>2.0.4</version>
        10. </dependency>
        11. <dependency>
        12. <groupId>com.alibaba</groupId>
        13. <artifactId>fastjson</artifactId>
        14. <version>1.2.79</version>
        15. </dependency>

        使用

        无需配置，直接看接口示例

接口示例

继承默认接口 **SocketController.java** 自带的两个**Action**

  1. package cn.tannn.websocket.controller;
  3. import cn.jdevelops.websocket.client.controller.SocketController;
  4. import cn.tannn.websocket.service.AlarmWebSocketServer;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RestController;
  9. /**
  10.  * @author tn
  11.  * @ClassName WebSocketController
  12.  * @description websocket接口
  13.  * @date 2020-12-24 15:53
  14.  */
  15. @RestController
  16. @RequestMapping("websocket")
  17. public class WebSocketController implements SocketController {
  19.     @Autowired
  20.     private AlarmWebSocketServer alarmWebSocketServer;
  22.     /**
  23.      * 测试接口是否通畅
  24.      * @return
  25.      */
  26.     @RequestMapping("/test01")
  27.     public String testo01(){
  28.         return "websocket";
  29.     }
  31.      /**
  32.      *  使用 sendInfoByLikeKey 进行模糊匹配用户进行消息发送
  33.      *  匹配  keyPrefix 开头的 websocket 用户 给他们发送消息 （keyPrefix用户1, keyPrefix用户2）
  34.      *  @param keyPrefix 主键前缀
  35.      *  @param message 消息
  36.      */
  37.     @RequestMapping("/sendInfoByLikeKey")
  38.     public String sendInfoByLikeKey(String keyPrefix, String message){
  39.         alarmWebSocketServer.sendInfoByLikeKey(keyPrefix, message);
  40.         return "success";
  41.     }
  43. }

提供一个模糊发送信息服务示例

自定义了一个模糊匹配用户进行消息发送接口 **sendInfoByLikeKey**

service

  1. package cn.tannn.websocket.service;
  3. /**
  4.  * @author tn
  5.  * @ClassName AlarmWebSocketServer
  6.  * @description 自定义消息发送接口
  7.  * @date 2020-12-24 15:58
  8.  */
  9. public interface AlarmWebSocketServer {
  11.     /**
  12.      *  使用 sendInfoByLikeKey 进行模糊匹配用户进行消息发送
  13.      *  匹配  keyPrefix 开头的 websocket 用户 给他们发送消息 （keyPrefix用户1, keyPrefix用户2）
  14.      *  @param keyPrefix 主键前缀
  15.      *  @param message 消息
  16.      */
  17.     public void sendInfoByLikeKey(String keyPrefix, String message);
  18. }

impl

  1. package cn.tannn.websocket.service.impl;
  3. import cn.jdevelops.websocket.core.service.WebSocketServer;
  4. import cn.tannn.websocket.service.AlarmWebSocketServer;
  5. import org.springframework.stereotype.Service;
  7. import javax.annotation.Resource;
  9. /**
  10.  * @author tn
  11.  * @ClassName AlarmWebSocketServerImpl
  12.  * @description 自定义消息发送接口
  13.  * @date 2020-12-24 15:59
  14.  */
  15. @Service
  16. public class AlarmWebSocketServerImpl implements AlarmWebSocketServer {
  18.     @Resource
  19.     private WebSocketServer webSocketServer;
  21.     @Override
  22.     public void sendInfoByLikeKey(String keyPrefix, String message) {
  23. //        匹配  keyPrefix 开头的 websocket 用户 给他们发送消息 （keyPrefix用户1, keyPrefix用户2）
  24.         webSocketServer.sendInfoByLikeKey(keyPrefix,message);
  25.     }
  26. }

调式

WebSocket在线工具

http://www.easyswoole.com/wstool.html

测试接口 < 2.0.4

服务地址

  • ws://127.0.0.1:8080/socket/tanning123

    ws://127.0.0.1:port/context-path/socket/频道名

消息发送

127.0.0.1:8080/websocket/sendInfoByLikeKey?keyPrefix=tanning&message=测试

图文

image.png

鉴权演示 >=2.0.4

  1. 接口集
  2. 示例项目地址

固定了ws地址前缀

ws://127.0.0.1:8080/socket/y/频道名 ws://127.0.0.1:8080/socket/n/频道名

鉴权

ws://127.0.0.1:8080/socket/y/频道名

  1. ws://127.0.0.1:8080/socket/y/tanning123?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpbk5hbWUiOiJ0YW4iLCJzZXgiOiLnlLciLCJleHAiOjE2NDU5Mzg1NDl9.x9rbDLZEHlnboH69wRKZfEuq0brrtODYfJ950PmXjQ0

    不鉴权

    ws://127.0.0.1:8080/socket/n/频道名

  2. ws://127.0.0.1:8080/socket/n/tanning123

示例项目地址

https://github.com/en-o/Jdevelops-Example/tree/main/WebSocket