https://github.com/onevroad/net-websocket-spring-boot
Easy to use websocket
https://github.com/onevroad/net-websocket-spring-boot
java netty spring-boot websocket
Last synced: 11 months ago
JSON representation
Easy to use websocket
- Host: GitHub
- URL: https://github.com/onevroad/net-websocket-spring-boot
- Owner: onevroad
- License: apache-2.0
- Created: 2019-05-21T01:15:08.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-24T08:35:16.000Z (about 3 years ago)
- Last Synced: 2025-07-05T01:41:46.497Z (11 months ago)
- Topics: java, netty, spring-boot, websocket
- Language: Java
- Homepage:
- Size: 158 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# net-websocket-spring-boot-starter [](http://www.apache.org/licenses/LICENSE-2.0.html)
The WebSocket is based on netty. It's easier to use for somebody who want to build a WebSocket in a short time.
Support jdk version 1.8 or 1.8+
[中文文档](https://github.com/onevroad/net-websocket-spring-boot/blob/master/README_cn.md "中文文档")
## Request Data Format
```json
{
"e": "event type",
"t": ["topic name"],
"d": "data"
}
```
- e:event, t:topic, d:data
- support event type：subscribe, message, cancel, heartbeat
- Except for the heartbeat event, the topic is a required param.You can send multiple topics at the same time.
- You can customize the response data format.
## Heartbeat Event
- The server will send a heartbeat event when the client and server have no data interaction within 1 minute. The data format that the server send is like this:
```json
{
"e": "heartbeat",
"d": "ping"
}
```
- If the client receive a heartbeat event, please send a data to the server. The data format is like this:
```json
{
"e": "heartbeat",
"d": "pong"
}
```
- The connection will be disconnected when the server who sent the heartbeat event twice din't receive any response.
## Quick Start
- add maven dependency
```
org.onevroad
net-websocket-spring-boot-starter
0.4.1
```
- You have two choices to handle event, add annotation or implement WebSocketEventHandler or WebSocketCustomizeEventHandler for every topic that you have.
### Add annotation
Add the annotation on the method to handle event.
You can define the topic for every annotation.
The priority of topic is: method annotation topic > class annotation topic
The supporting params is: topic and data. You need add RequestTopic annotation for the topic and add RequestData annotation for the data.
```java
@WebSocketListener("test-annotation")
public class SampleMessageAnnotationEventHandler {
@OnSubscribe("test-annotation-subscribe")
public String onSubscribe(@RequestTopic String topic, @RequestData String data) {
return "subscribe success!";
}
@OnMessage
public String onMessage(@RequestTopic String topic, @RequestData String data) {
return "message received!";
}
@OnCancel("test-annotation-cancel")
public String onCancel(@RequestTopic String topic, @RequestData String data) {
return "cancel success!";
}
}
```
### Implement interface
For the definite topics, you can implement WebSocketEventHandler with the WebsocketListener annotation.
```java
@WebsocketListener("test")
public class SampleMessageEventHandler implements WebSocketEventHandler {
@Override
public String onSubscribe(String topic, String data) {
return "subscribe success!";
}
@Override
public String onMessage(String topic, String data) {
return "message received!";
}
@Override
public String onCancel(String topic, String data) {
return "cancel success!";
}
}
```
For the dynamic topics, you can implement WebSocketCustomizeEventHandler and override the equalsTopic method.
```java
@WebsocketListener
public class SampleMessageCustomizeEventHandler implements WebSocketCustomizeEventHandler {
@Override
public boolean equalsTopic(String topic) {
return "test2".equals(topic);
}
@Override
public String onSubscribe(String topic, String data) {
return "subscribe success!";
}
@Override
public String onMessage(String topic, String data) {
return "message received!";
}
@Override
public String onCancel(String topic, String data) {
return "cancel success!";
}
}
```
- configure the scan package where your implementers are.
```java
@EnableAutoConfiguration
@WebSocketScan(basePackages = {"org.net.websocket.samples.handler"})
public class WebSocketApplication {
public static void main(String[] args) {
new SpringApplicationBuilder(WebSocketApplication.class).run(args);
}
}
```
- configure parameter
```yaml
net:
websocket:
# Listening port
port: 80
# The number of listening threads, default 1 thread
boss-group-threads: 1
# The number of working threads, default 0 is the number of CPU cores
worker-group-threads: 0
# Request path
end-point: /ws
# Retry config
retry:
# Whether to enable the retry
enable: true
# The maximum number of retry times, the default is 3 times
max-retry-time: 3
# Retry interval, unit: milliseconds, default 1000ms
retry-interval: 1000
```
- send message
You can use the method of the WebSocketMessagePublisher class to send your message.
```java
public class SendMessageHandler {
public static void send(String topic, String message) {
WebSocketMessagePublisher.publish(topic, message);
}
}
```