代码拉取完成，页面将自动刷新
同步操作将从 Yeauty/netty-websocket-spring-boot-starter 强制同步，此操作会覆盖自 Fork 仓库以来所做的任何修改，且无法恢复！！！
确定后同步将在后台操作，完成时将刷新页面，请耐心等待。
本项目帮助你在spring-boot中使用Netty来开发WebSocket服务器，并像spring-websocket的注解开发一样简单
<dependency>
<groupId>org.yeauty</groupId>
<artifactId>netty-websocket-spring-boot-starter</artifactId>
<version>0.9.5</version>
</dependency>
@ServerEndpoint注解，并在相应的方法上加上@BeforeHandshake、@OnOpen、@OnClose、@OnError、@OnMessage、@OnBinary、@OnEvent注解，样例如下：@ServerEndpoint(path = "/ws/{arg}")
public class MyWebSocket {
@BeforeHandshake
public void handshake(Session session, HttpHeaders headers, @RequestParam String req, @RequestParam MultiValueMap reqMap, @PathVariable String arg, @PathVariable Map pathMap){
session.setSubprotocols("stomp");
if (!req.equals("ok")){
System.out.println("Authentication failed!");
session.close();
}
}
@OnOpen
public void onOpen(Session session, HttpHeaders headers, @RequestParam String req, @RequestParam MultiValueMap reqMap, @PathVariable String arg, @PathVariable Map pathMap){
System.out.println("new connection");
System.out.println(req);
}
@OnClose
public void onClose(Session session) throws IOException {
System.out.println("one connection closed");
}
@OnError
public void onError(Session session, Throwable throwable) {
throwable.printStackTrace();
}
@OnMessage
public void onMessage(Session session, String message) {
System.out.println(message);
session.sendText("Hello Netty!");
}
@OnBinary
public void onBinary(Session session, byte[] bytes) {
for (byte b : bytes) {
System.out.println(b);
}
session.sendBinary(bytes);
}
@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("read idle");
break;
case WRITER_IDLE:
System.out.println("write idle");
break;
case ALL_IDLE:
System.out.println("all idle");
break;
default:
break;
}
}
}
}
ws://127.0.0.1:80/ws/xxx
当ServerEndpointExporter类通过Spring配置进行声明并被使用，它将会去扫描带有@ServerEndpoint注解的类 被注解的类将被注册成为一个WebSocket端点 所有的配置项都在这个注解的属性中 ( 如:
@ServerEndpoint("/ws"))
当有新的连接进入时，对该方法进行回调 注入参数的类型:Session、HttpHeaders...
当有新的WebSocket连接完成时，对该方法进行回调 注入参数的类型:Session、HttpHeaders...
当有WebSocket连接关闭时，对该方法进行回调 注入参数的类型:Session
当有WebSocket抛出异常时，对该方法进行回调 注入参数的类型:Session、Throwable
当接收到字符串消息时，对该方法进行回调 注入参数的类型:Session、String
当接收到二进制消息时，对该方法进行回调 注入参数的类型:Session、byte[]
当接收到Netty的事件时，对该方法进行回调 注入参数的类型:Session、Object
所有的配置项都在这个注解的属性中
| 属性 | 默认值 | 说明 |
|---|---|---|
| path | "/" | WebSocket的path,也可以用value来设置 |
| host | "0.0.0.0" | WebSocket的host,"0.0.0.0"即是所有本地地址 |
| port | 80 | WebSocket绑定端口号。如果为0，则使用随机端口(端口获取可见 多端点服务) |
| bossLoopGroupThreads | 0 | bossEventLoopGroup的线程数 |
| workerLoopGroupThreads | 0 | workerEventLoopGroup的线程数 |
| useCompressionHandler | false | 是否添加WebSocketServerCompressionHandler到pipeline |
| 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
|
| maxFramePayloadLength | 65536 | 最大允许帧载荷长度 |
所有参数皆可使用
${...}占位符获取application.properties中的配置。如下：
@ServerEndpoint注解的属性中使用${...}占位符@ServerEndpoint(host = "${ws.host}",port = "${ws.port}")
public class MyWebSocket {
...
}
application.properties中配置ws.host=0.0.0.0
ws.port=80
配置favicon的方式与spring-boot中完全一致。只需将favicon.ico文件放到classpath的根目录下即可。如下:
src/
+- main/
+- java/
| + <source code>
+- resources/
+- favicon.ico
配置自定义错误页面的方式与spring-boot中完全一致。你可以添加一个 /public/error 目录，错误页面将会是该目录下的静态页面，错误页面的文件名必须是准确的错误状态或者是一串掩码,如下：
src/
+- main/
+- java/
| + <source code>
+- resources/
+- public/
+- error/
| +- 404.html
| +- 5xx.html
+- <other public assets>
@ServerEndpoint、@Component注解即可ServerEndpointExporter.getInetSocketAddressSet()获取所有端点的地址ServerBootstrap实例ServerBootstrap实例"0.0.0.0"，因为"0.0.0.0"意味着绑定所有的host@PathVariable支持RESTful风格中获取参数@RequestParam实现请求中query的获取参数@RequestParam MultiValueMap代替@BeforeHandshake 注解，可在握手之前对连接进行关闭@BeforeHandshake事件中可设置子协议@Component
Netty版本到 4.1.44.Final
@RequestParam MultiValueMap时获取的对象为nullNetty版本到 4.1.45.Final
ServerEndpointExporter对象@BeforeHandshake时会出现空指针异常@BeforeHandshake时 OnOpen中的Session为null.OnError事件中的Throwable为null.此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。