# websocket-spring-boot-starter

**Repository Path**: east-moan-east/websocket-spring-boot-starter

## Basic Information

- **Project Name**: websocket-spring-boot-starter
- **Description**: 一个参照Stomp协议的简易的WebSocket
支持使用@WsController、@WsMapping将WebSocket消息转发处理
支持使用@SendTo将返回结果返回给相应用户
支持握手拦截器、消息拦截器、全局消息异常处理器、自定义消息转换器、事件监听
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2023-11-15
- **Last Updated**: 2023-11-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h2 align="center">WebSocket-Spring-Boot-Starter</h2>

<p align="center">
    <a target="_blank" href="https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html">
		<img src="https://img.shields.io/badge/JDK-17-green.svg" alt="jdk-17" />
	</a>
    <a target="_blank" href="https://spring.io/">
        <img src="https://img.shields.io/badge/SpringBoot-v3-blue.svg" alt="spring-boot-3">
    </a>    
    <a target="_blank" href="https://github.com/TooTallNate/Java-WebSocket">
        <img src="https://img.shields.io/badge/Java_WebSocket-1.5.3-yellow.svg" alt="Java-WebSocket_1.5.3">
    </a>
</p>


## 特征

#### 1、轻量
> 整个框架只依赖 Java-WebSocket、jackson-databind、spring-boot-autoconfigure，再无其他任何第三方依赖。

#### 2、多功能
> 框架支持 消息映射、类型转换、数据绑定、异常处理、拦截器等。

## 开始

**编写方法**
```java
@WsMapping("/user")
@WsController
public class WsUserController {

    @Data
    public static class User {
        private Long id;
        private String name;
        private Integer age;
    }

    @WsMapping("/save")
    @SendTo
    public User saveUser(@WsParam("user") User user) {
        System.out.println(user);
        // ...saveUser
        return user;
    }
}
```

**传递数据**
```json
{
    "path": "/user/save",
    "data": {
        "user": {
            "id":"24534523452343", 
            "name": "dongadong", 
            "age": 12
        }
    }
}
```