简介

本项目帮助你在spring-boot中使用Netty来开发WebSocket服务器，并像spring-websocket的注解开发一样简单

源码获取方式：关注转发之后私信回复【源码】即可免费获取

要求

jdk版本为1.8或1.8+

快速开始

添加依赖:

<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; } } } }
打开WebSocket客户端，连接到ws://127.0.0.1:80/ws/xxx

注解

@ServerEndpoint

当ServerEndpointExporter类通过Spring配置进行声明并被使用，它将会去扫描带有@ServerEndpoint注解的类被注解的类将被注册成为一个WebSocket端点所有的配置项都在这个注解的属性中 ( 如:@ServerEndpoint("/ws") )

@BeforeHandshake

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

@OnOpen

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

@OnClose

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

@OnError

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

@OnMessage

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

@OnBinary

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

@OnEvent

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

配置

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

轻量级、高性能的WebSocket框架源码分享

通过application.properties进行配置

所有参数皆可使用${...}占位符获取application.properties中的配置。如下：

首先在@ServerEndpoint注解的属性中使用${...}占位符

@ServerEndpoint(host = " ${ws.host}",port = "$ {ws.port}")public class MyWebSocket { ...}
接下来即可在application.properties中配置

ws.host=0.0.0.0ws.port=80

自定义Favicon

配置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()获取所有端点的地址
当地址不同时(即host不同或port不同)，使用不同的ServerBootstrap实例
当地址相同,路径(path)不同时,使用同一个ServerBootstrap实例
当多个端点服务的port为0时，将使用同一个随机的端口号
当多个端点的port和path相同时，host不能设为"0.0.0.0"，因为"0.0.0.0"意味着绑定所有的host

轻量级、高性能的WebSocket框架 源码分享

简介

要求