# websocket-spring-boot-starter

**Repository Path**: dingwen-gitee/websocket-spring-boot-starter

## Basic Information

- **Project Name**: websocket-spring-boot-starter
- **Description**: 支持认证的WebSocket场景启动器
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-10-16
- **Last Updated**: 2025-06-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: treasure

## README

###  WebSocket场景启动器

> 支持认证的WebSocket场景启动器

#### 核心功能
+ 认证
+ 客户端服务端双向心跳检测
+ 分布式的全局订阅通道
+ ISendMsgCall:  发送消息回调拓展点
+ IReceiveMsgCall: 接收消息回调拓展点

####  使用

#####  引入依赖

```xml
        <!--WebSocket场景启动器-->
        <dependency>
            <groupId>top.dingwen.io</groupId>
            <artifactId>websocket-spring-boot-starter</artifactId>
            <version>1.0.0</version>
        </dependency>

```


####  配置项

```yml
# Websocket场景配置文件
dingwen:
  treasure:
    # 电子邮件
    websocket:
      # 是否开启
      enabled: true
      # 是否开启默认API
      defaultApiEnabled: true
      # 是否开启认证
      auth: false
      path: "/websocket"
      allowedOrigins: "*"
```

### 概览
<table>
    <tr>
       <td><img src="img/ws01.png"></td>
       <td><img src="img/ws02.png"></td>
    </tr>
</table>