Repository files navigation

中文文档 (Chinese Docs)

netty-websocket-spring-boot-starter will help you develop WebSocket server by using Netty in spring-boot,it is easy to develop by using annotation like spring-websocket

• jdk version 17

• add Dependencies:

<dependency><groupId>org.yeauty</groupId><artifactId>netty-websocket-spring-boot-starter</artifactId><version>0.13.0</version></dependency>

• annotate@ServerEndpoint on endpoint class，and annotate@BeforeHandshake,@OnOpen,@OnClose,@OnError,@OnMessage,@OnBinary,@OnEvent on the method. e.g.

@ServerEndpoint(path ="/ws/{arg}")publicclassMyWebSocket {@BeforeHandshakepublicvoidhandshake(Sessionsession,HttpHeadersheaders,@RequestParamStringreq,@RequestParamMultiValueMapreqMap,@PathVariableStringarg,@PathVariableMappathMap){session.setSubprotocols("stomp");if (!"ok".equals(req)){System.out.println("Authentication failed!");session.close();        }    }@OnOpenpublicvoidonOpen(Sessionsession,HttpHeadersheaders,@RequestParamStringreq,@RequestParamMultiValueMapreqMap,@PathVariableStringarg,@PathVariableMappathMap){System.out.println("new connection");System.out.println(req);    }@OnClosepublicvoidonClose(Sessionsession)throwsIOException {System.out.println("one connection closed");     }@OnErrorpublicvoidonError(Sessionsession,Throwablethrowable) {throwable.printStackTrace();    }@OnMessagepublicvoidonMessage(Sessionsession,Stringmessage) {System.out.println(message);session.sendText("Hello Netty!");    }@OnBinarypublicvoidonBinary(Sessionsession,byte[]bytes) {for (byteb :bytes) {System.out.println(b);        }session.sendBinary(bytes);     }@OnEventpublicvoidonEvent(Sessionsession,Objectevt) {if (evtinstanceofIdleStateEvent) {IdleStateEventidleStateEvent = (IdleStateEvent)evt;switch (idleStateEvent.state()) {caseREADER_IDLE:System.out.println("read idle");break;caseWRITER_IDLE:System.out.println("write idle");break;caseALL_IDLE:System.out.println("all idle");break;default:break;            }        }    }}

• use Websocket client to connectws://127.0.0.1:80/ws/xxx

declaringServerEndpointExporter in Spring configuration,it will scan for WebSocket endpoints that be annotated withServerEndpoint .beans that be annotated withServerEndpoint will be registered as a WebSocket endpoint.allconfigurations are inside this annotation ( e.g.@ServerEndpoint("/ws") )

when there is a connection accepted,the method annotated with@BeforeHandshake will be called
classes which be injected to the method are:Session,HttpHeaders...

when there is a WebSocket connection completed,the method annotated with@OnOpen will be called
classes which be injected to the method are:Session,HttpHeaders...

when a WebSocket connection closed,the method annotated with@OnClose will be calledclasses which be injected to the method are:Session

when a WebSocket connection throw Throwable, the method annotated with@OnError will be calledclasses which be injected to the method are:Session,Throwable

when a WebSocket connection received a message,the method annotated with@OnMessage will be calledclasses which be injected to the method are:Session,String

when a WebSocket connection received the binary,the method annotated with@OnBinary will be calledclasses which be injected to the method are:Session,byte[]

when a WebSocket connection received the event of Netty,the method annotated with@OnEvent will be calledclasses which be injected to the method are:Session,Object

all configurations are configured in@ServerEndpoint's property

You can get the configurate ofapplication.properties by using${...} placeholders. for example：

• first,use${...} in@ServerEndpoint

@ServerEndpoint(host ="${ws.host}",port ="${ws.port}")publicclassMyWebSocket {    ...}

• then configurate inapplication.properties

ws.host=0.0.0.0ws.port=80

The way of configure favicon is the same as spring-boot.Iffavicon.ico is presented in the root of the classpath,it will be automatically used as the favicon of the application.the example is following:

src/  +- main/      +- java/      |   + <source code>      +- resources/          +- favicon.ico

The way of configure favicon is the same as spring-boot.you can add a file to an/public/errorfolder.The name of the error page should be the exact status code or a series mask.the example is following:

src/  +- main/      +- java/      |   + <source code>      +- resources/          +- public/              +- error/              |   +- 404.html              |   +- 5xx.html              +- <other public assets>

• base onQuick-Start,use annotation@ServerEndpoint and@Component in classes which hope to become a endpoint.
• you can get all socket addresses inServerEndpointExporter.getInetSocketAddressSet().
• when there are different addresses(different host or different port) in WebSocket,they will use differentServerBootstrap instance.
• when the addresses are the same,but path is different,they will use the sameServerBootstrap instance.
• when multiple port of endpoint is 0 ,they will use the same random port
• when multiple port of endpoint is the same as the path,host can't be set as "0.0.0.0",because it means it binds all of the addresses

• Auto-Configuration

• Support RESTful by@PathVariable
• Get param by@RequestParam from query
• RemoveParameterMap ,instead of@RequestParam MultiValueMap
• Add@BeforeHandshake annotation，you can close the connect before handshake
• Set sub-protocol in@BeforeHandshake event
• Remove the@Component on endpoint class
• UpdateNetty version to4.1.44.Final

• Bug fixed : it was null when using@RequestParam MultiValueMap to get value
• UpdateNetty version to4.1.45.Final

• There are compatibility version under 0.8.0 that can configure theServerEndpointExporter manully

• Bug fixed ：when there is no@BeforeHandshake , NullPointerException will appear

• Bug fixed ：when there is no@BeforeHandshake ,Session inOnOpen is null

• Bug fixed ：Throwable inOnError event is null

• Modified the default value ofbossLoopGroupThreads to 1
• Supports configuringuseEventExecutorGroup to run synchronous and time-consuming business logic in EventExecutorGroup, so that the I/O thread is not blocked by a time-consuming task
• SSL supported
• CORS supported
• UpdateNetty version to4.1.49.Final

• When theServerEndpoint class is proxied by CGLIB (as with AOP enhancement), it still works

• @enableWebSocket adds thescanBasePackages attribute
• @serverEndpoint no longer depends on@Component
• UpdateNetty version to4.1.67.Final

• Fixed the issue where WebSocket compression was not working.
• Upgraded support for Spring Boot 3.
• Included the client'sSec-WebSocket-Protocol in the response header.
• When closing the connection, sends abye command first instead of directly closing.
• UpdatedNetty version to4.1.118.Final.