# netty-websocket-server

**Repository Path**: ssp198/netty-websocket-server

## Basic Information

- **Project Name**: netty-websocket-server
- **Description**: 一个基于Netty的通用websocket server端程序。
基于Netty的socket通信程序可设计出清晰的线程模型，利用Netty中ChannelHandler在初始化时可绑定线程组的机制，可以自然而然地实现IO事件处理与核心业务逻辑处理线程池隔离。
同时，本程序运用Spring IOC机制，实现websocketEndpoint的收集及dispatcher请求分发器功能。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 1
- **Created**: 2022-07-03
- **Last Updated**: 2023-10-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Netty, WebSocket, Java, SpringBoot

## README

### A demo of netty based WebSocket Server.
```
一个基于Netty的通用websocket server端程序。
基于Netty的socket通信程序可设计出清晰的线程模型，利用Netty中ChannelHandler在初始化时可绑定线程组的机制，
可以自然而然地实现IO事件处理与核心业务逻辑处理线程池隔离。
同时，本程序运用Spring IOC机制，实现对WebsocketEndpoint对外接口处理器的收集及dispatcher请求分发器功能。
```
#### 实现功能

* [x] 通用启动类：WebSocketNettyServer
* [x] 模板方法：资源接口顶层模板类 ResourceProcessor
* [x] 资源池：资源接口可集中注册配置，资源接口的创建及注册到资源池的操作注解（WebSocketEndpoint）配置化（利用Spring IOC bean注入机制）
* [x] 资源请求分发器——ResourceDispatcher：识别客户端请求并分发至对应后置handler资源处理器
* [x] websocket I/O操作与业务逻辑处理操作线程池隔离：利用Netty中handler可绑定线程的机制，将业务逻辑处理器绑定到专门的业务线程池里，即可实现两者线程池隔离

#### websocket通道建立流程

* 1）client：HTTP[Connection:Upgrade, Upgrade:websocket] ---> server
* 2）server：HTTP[101 Switching Protocols] ---> client，通道建立
* 3）client：WebSocket[Text] <---> server：WebSocket[Text]，通信开始
* 4）client: TCP[Keep-Alive] ---> server:TCP[Keep-Alive ACK]，客户端主动发起TCP层面链接保活

#### 立即使用
接口声明
```java
import lombok.extern.slf4j.Slf4j;import netty.websocket.resource.ResourceProcessor;
import io.netty.channel.Channel;
import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;

@WebSocketEndpoint("/ws/home")
@Slf4j
public class WsHomeResourceProcessor implements ResourceProcessor<String> {
    @Override
    public void handle(Channel client, String msg) {
        log.debug("client[{}] ---> processor:{}", client.id(), msg);
        sendText(client, "ack:" + msg);
    }

    @Override
    public void sendText(Channel client, String text) {
        log.debug("processor ---> client[{}]:{}", client.id(), text);
        client.writeAndFlush(new TextWebSocketFrame(text));
    }
}
```
启动监听
```java
import netty.websocket.resource.ResourceDispatcher;
import netty.websocket.server.WebSocketNettyServer;

@Service
public class WebSocketServerBootstrap {
    @Resource
    private ResourceDispatcher resourceDispatcher;

    @PostConstruct
    public void startWebSocketServer()  {
        WebSocketNettyServer.createServer(6680, resourceDispatcher).start();
    }
}
```
接口访问
```javascript
var ws = new WebSocket("ws://127.0.0.1:6680/ws/home")

ws.onmessage = function(msg) {
    console.log("--->rev:" + msg.data)
}
ws.send("I'm client 001!")
```
输出打印
```shell script
---server---
#server: client[abcdef] ---> processor:I'm client 001!

---client---
#client: --->rev:ack I'm client 001!
```
```
websocket通道的建立过程包含由HTTP协议消息切换为WebSocket协议消息过程，
服务端要对客户端第一次发起的HTTP#Upgrade协议升级请求回复HTTP#Switching Protocols协议切换响应，
响应完成后通道即建立。
在WebSocket中由客户端实现了TCP层面的链接保活机制，链接保活由客户端维护完成，
客户端通过定时发送TCP#Keepalive包，服务端响应TCP#Keepalive ACK包来实现链路保活。（抓包可验证）
```
#### 依赖：Netty + Spring Boot