Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/hwywl/netty-websocket-spring-boot

netty-websocket之路
https://github.com/hwywl/netty-websocket-spring-boot
netty websocket
Last synced: about 1 month ago
JSON representation
netty-websocket之路
Host: GitHub
URL: https://github.com/hwywl/netty-websocket-spring-boot
Owner: HWYWL
License: apache-2.0
Created: 2018-10-07T13:07:56.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-05-16T17:14:59.000Z (9 months ago)
Last Synced: 2024-11-10T19:41:21.469Z (3 months ago)
Topics: netty, websocket
Language: Java
Size: 89.8 KB
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # netty-websocket-spring-boot

netty-websocket之路

### 说明

- jdk版本为1.8或1.8+

- spring-boot版本为2.0.0.RELEASE或以上

### 快速开始

- 添加依赖:

```xml

	

		org.yeauty

		netty-websocket-spring-boot-starter

		0.7.2

	

```

- new一个`ServerEndpointExporter`对象，交给Spring容器，表示要开启WebSocket功能，样例如下:

```java

@Configuration

public class WebSocketConfig {

    @Bean

    public ServerEndpointExporter serverEndpointExporter() {

        return new ServerEndpointExporter();

    }

}

```

- 在端点类上加上`@ServerEndpoint`、`@Component`注解，并在相应的方法上加上`@OnOpen`、`@OnClose`、`@OnError`、`@OnMessage`、`@OnBinary`、`OnEvent`注解，样例如下：

```java

@ServerEndpoint

@Component

public class WebSocketOneService {

    /**

     * 当有新的WebSocket连接进入时，对该方法进行回调 注入参数的类型:Session、HttpHeaders

     * @param session

     * @param headers

     * @throws IOException

     */

    @OnOpen

    public void onOpen(Session session, HttpHeaders headers) throws IOException {

        System.out.println("新的WebSocket连接进入一号");

    }

    /**

     * 当有WebSocket连接关闭时，对该方法进行回调 注入参数的类型:Session

     * @param session

     * @throws IOException

     */

    @OnClose

    public void onClose(Session session) throws IOException {

        System.out.println("一号WebSocket连接关闭");

    }

    /**

     * 当有WebSocket抛出异常时，对该方法进行回调 注入参数的类型:Session、Throwable

     * @param session

     * @param throwable

     */

    @OnError

    public void onError(Session session, Throwable throwable) {

        throwable.printStackTrace();

    }

    /**

     * 当接收到字符串消息时，对该方法进行回调 注入参数的类型:Session、String

     * @param session

     * @param message

     */

    @OnMessage

    public void OnMessage(Session session, String message) {

        System.out.println(message);

        session.sendText("Hello Netty! ---> " + message);

    }

    /**

     * 当接收到二进制消息时，对该方法进行回调 注入参数的类型:Session、byte[]

     * @param session

     * @param bytes

     */

    @OnBinary

    public void OnBinary(Session session, byte[] bytes) {

        for (byte b : bytes) {

            System.out.println(b);

        }

        session.sendBinary(bytes);

    }

    /**

     * 当接收到Netty的事件时，对该方法进行回调 注入参数的类型:Session、Object

     * @param session

     * @param evt

     */

    @OnEvent

    public void onEvent(Session session, Object evt) {

        if (evt instanceof IdleStateEvent) {

            IdleStateEvent idleStateEvent = (IdleStateEvent) evt;

            switch (idleStateEvent.state()) {

                case READER_IDLE:

                    System.out.println("一号读操作空闲");

                    break;

                case WRITER_IDLE:

                    System.out.println("一号写操作空闲");

                    break;

                case ALL_IDLE:

                    System.out.println("一号所有操作空闲");

                    break;

                default:

                    break;

            }

        }

    }

}

```

- 打开WebSocket客户端，连接到`ws://127.0.0.1:80`

### 注解

###### @ServerEndpoint 

> 当ServerEndpointExporter类通过Spring配置进行声明并被使用，它将会去扫描带有@ServerEndpoint注解的类

> 被注解的类将被注册成为一个WebSocket端点

> 所有的[配置项](#%E9%85%8D%E7%BD%AE)都在这个注解的属性中 ( 如:`@ServerEndpoint("/ws")` )

###### @OnOpen 

> 当有新的WebSocket连接进入时，对该方法进行回调

> 注入参数的类型:Session、HttpHeaders

###### @OnClose

> 当有WebSocket连接关闭时，对该方法进行回调

> 注入参数的类型:Session

###### @OnError

> 当有WebSocket抛出异常时，对该方法进行回调

> 注入参数的类型:Session、Throwable

###### @OnMessage

> 当接收到字符串消息时，对该方法进行回调

> 注入参数的类型:Session、String

###### @OnBinary

> 当接收到二进制消息时，对该方法进行回调

> 注入参数的类型:Session、byte[]

###### @OnEvent

> 当接收到Netty的事件时，对该方法进行回调

> 注入参数的类型:Session、Object

### 配置

> 所有的配置项都在这个注解的属性中

| 属性  | 默认值 | 说明 

|---|---|---

|path|"/"|WebSocket的path,也可以用`value`来设置

|host|"0.0.0.0"|WebSocket的host,`"0.0.0.0"`即是所有本地地址

|port|80|WebSocket绑定端口号。如果为0，则使用随机端口(端口获取可见 [多端点服务](#%E5%A4%9A%E7%AB%AF%E7%82%B9%E6%9C%8D%E5%8A%A1))

|prefix|""|当不为空时，即是使用application.properties进行配置，详情在 [通过application.properties进行配置](#%E9%80%9A%E8%BF%87APPLICATION.PROPERTIES%E8%BF%9B%E8%A1%8C%E9%85%8D%E7%BD%AE)

|optionConnectTimeoutMillis|30000|与Netty的`ChannelOption.CONNECT_TIMEOUT_MILLIS`一致

|optionSoBacklog|128|与Netty的`ChannelOption.SO_BACKLOG`一致

|childOptionWriteSpinCount|16|与Netty的`ChannelOption.WRITE_SPIN_COUNT`一致

|childOptionWriteBufferHighWaterMark|64*1024|与Netty的`ChannelOption.WRITE_BUFFER_HIGH_WATER_MARK`一致,但实际上是使用`ChannelOption.WRITE_BUFFER_WATER_MARK`

|childOptionWriteBufferLowWaterMark|32*1024|与Netty的`ChannelOption.WRITE_BUFFER_LOW_WATER_MARK`一致,但实际上是使用 `ChannelOption.WRITE_BUFFER_WATER_MARK`

|childOptionSoRcvbuf|-1(即未设置)|与Netty的`ChannelOption.SO_RCVBUF`一致

|childOptionSoSndbuf|-1(即未设置)|与Netty的`ChannelOption.SO_SNDBUF`一致

|childOptionTcpNodelay|true|与Netty的`ChannelOption.TCP_NODELAY`一致

|childOptionSoKeepalive|false|与Netty的`ChannelOption.SO_KEEPALIVE`一致

|childOptionSoLinger|-1|与Netty的`ChannelOption.SO_LINGER`一致

|childOptionAllowHalfClosure|false|与Netty的`ChannelOption.ALLOW_HALF_CLOSURE`一致

|readerIdleTimeSeconds|0|与`IdleStateHandler`中的`readerIdleTimeSeconds`一致，并且当它不为0时，将在`pipeline`中添加`IdleStateHandler`

|writerIdleTimeSeconds|0|与`IdleStateHandler`中的`writerIdleTimeSeconds`一致，并且当它不为0时，将在`pipeline`中添加`IdleStateHandler`

|allIdleTimeSeconds|0|与`IdleStateHandler`中的`allIdleTimeSeconds`一致，并且当它不为0时，将在`pipeline`中添加`IdleStateHandler`

### 通过application.properties进行配置

> 对注解中的`prefix`进行设置后，即可在`application.properties`中进行配置。如下：

- 首先在ServerEndpoint注解中设置prefix的值

```java

@ServerEndpoint(prefix = "netty.websocket.one.service")

@Component

public class WebSocketOneService {

    ...

}

```

- 接下来即可在`application.properties`中配置

```

	# websocket一号配置

	netty.websocket.one.service.host=0.0.0.0

	netty.websocket.one.service.path=/

	netty.websocket.one.service.port=80

	

	# websocket二号配置

	netty.websocket.tow.service.host=0.0.0.0

	netty.websocket.tow.service.path=/

	netty.websocket.tow.service.port=8088

```

> `application.properties`中的key与注解`@ServerEndpoint`中属性的对应关系如下:

| 注解中的属性 | 配置文件中的key | 例子

|---|---|---

|path|{prefix}.path|netty-websocket.path

|host|{prefix}.host|netty-websocket.host

|port|{prefix}.port|netty-websocket.port

|optionConnectTimeoutMillis|{prefix}.option.connect-timeout-millis|netty-websocket.option.connect-timeout-millis

|optionSoBacklog|{prefix}.option.so-backlog|netty-websocket.option.so-backlog

|childOptionWriteSpinCount|{prefix}.child-option.write-spin-count|netty-websocket.child-option.write-spin-count

|childOptionWriteBufferHighWaterMark|{prefix}.child-option.write-buffer-high-water-mark|netty-websocket.child-option.write-buffer-high-water-mark

|childOptionWriteBufferLowWaterMark|{prefix}.child-option.write-buffer-low-water-mark|netty-websocket.child-option.write-buffer-low-water-mark

|childOptionSoRcvbuf|{prefix}.child-option.so-rcvbuf|netty-websocket.child-option.so-rcvbuf

|childOptionSoSndbuf|{prefix}.child-option.so-sndbuf|netty-websocket.child-option.so-sndbuf

|childOptionTcpNodelay|{prefix}.child-option.tcp-nodelay|netty-websocket.child-option.tcp-nodelay

|childOptionSoKeepalive|{prefix}.child-option.so-keepalive|netty-websocket.child-option.so-keepalive

|childOptionSoLinger|{prefix}.child-option.so-linger|netty-websocket.child-option.so-linger

|childOptionAllowHalfClosure|{prefix}.child-option.allow-half-closure|netty-websocket.child-option.allow-half-closure

|readerIdleTimeSeconds|{prefix}.reader-idle-time-seconds|netty-websocket.reader-idle-time-seconds

|writerIdleTimeSeconds|{prefix}.writer-idle-time-seconds|netty-websocket.writer-idle-time-seconds

|allIdleTimeSeconds|{prefix}.all-idle-time-seconds|netty-websocket.all-idle-time-seconds

### 自定义Favicon

配置favicon的方式与spring-boot中完全一致。只需将`favicon.ico`文件放到classpath的根目录下即可。如下:

```

src/

  +- main/

    +- java/

    |   + 

    +- resources/

        +- favicon.ico

```

### 自定义错误页面

配置自定义错误页面的方式与spring-boot中完全一致。你可以添加一个 `/public/error` 目录，错误页面将会是该目录下的静态页面，错误页面的文件名必须是准确的错误状态或者是一串掩码,如下：

```

src/

  +- main/

    +- java/

    |   + 

    +- resources/

        +- public/

            +- error/

            |   +- 404.html

            |   +- 5xx.html

            +- 

```  

### 多端点服务

- 在[快速启动](#%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B)的基础上，在多个需要成为端点的类上使用`@ServerEndpoint`、`@Component`注解即可

- 可通过`ServerEndpointExporter.getInetSocketAddressSet()`获取所有端点的地址

- 当地址不同时(即host不同或port不同)，使用不同的`ServerBootstrap`实例

- 当地址相同,路径(path)不同时,使用同一个`ServerBootstrap`实例

- 当多个端点服务的port为0时，将使用同一个随机的端口号

- 当多个端点的port和path相同时，host不能设为`"0.0.0.0"`，因为`"0.0.0.0"`意味着绑定所有的host

### 效果展示

通过两个端点服务提供两个socket连接

第一个：ws://127.0.0.1:8088

![](https://i.imgur.com/yzRSfr1.jpg)

第二个：ws://127.0.0.1:80

![](https://i.imgur.com/r90vH0z.jpg)

### 感谢

谢谢这位大佬提供如此简单的开发框架：[Yeauty](https://gitee.com/Yeauty/netty-websocket-spring-boot-starter)

### 问题建议

- 联系我的邮箱：[email protected]

- 我的博客：http://www.hwy.ac.cn

- GitHub：https://github.com/HWYWL