netty websocket spring boot starter下载netty websocket spring boot starter源代码下载

netty websocket spring boot starter

Ai源码

1.0.0

下载

Netty-Websocket-Spring-boot-Starter

中文文档（中国文档）

关于

Netty-websocket-spring-boot-starter将通过在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.12.0</ version >
	</ dependency >

Annotate @ServerEndpoint在端点类上，和Annotate @BeforeHandshake ， @OnOpen ，@Onclose， @OnClose ，@onmessage， @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 (! "ok" . equals ( req )){
            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

在Spring配置中声明ServerEndpointExporter ，它将扫描使用ServerEndpoint注释的Websocket端点。用ServerEndpoint注释的豆类将注册为Websocket端点。所有配置都在此注释中（例如@ServerEndpoint("/ws") ）

@BeforeHandShake

当接受连接时，将调用@BeforeHandshake注释的方法
注入该方法的类是：会话，httpheaders ...

@Onopen

完成WebSocket连接完成后，将调用@OnOpen注释的方法
注入该方法的类是：会话，httpheaders ...

@onclose

当Websocket连接关闭时，用@OnClose注释的方法将被称为“注入该方法”的类：session：session

@Onerror

当websocket连接投掷时，用@OnError注释的方法将被称为将其注入该方法的类：session，可抛出

@OnMessage

当Websocket连接收到消息时，将称为@OnMessage注释的方法将被调用到该方法的类别：session，string

@Onbinary

当Websocket连接接收到二进制文件时，用@OnBinary注释的方法将被称为该方法的类，该类别为：session，byte []

@Onevent

当Websocket连接收到Netty的事件时，用@OnEvent注释的方法将被称为类别，将其注入该方法：Session，Object

配置

所有配置均在@ServerEndpoint的属性中配置

财产	默认	描述
小路	“/”	websocket的路径可以被别名以达到`value`
主持人	“ 0.0.0.0”	Websocket的主持人。 `"0.0.0.0"`是指所有本地地址
港口	80	Websocket端口。如果端口等于0，则将使用随机和可用端口（获取端口多端点）
BOSSLOOPGROUPTHREADS	0	Bosseventloopgroup中的线程数字
WorkerloopGroupThreads	0	工作中的线程数字
UseCompressionHandler	错误的	是否添加WebSocketServerCompressionHandler到管道
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	真的	与netty中的`ChannelOption.TCP_NODELAY`相同
ChildOptionsokeEpalive	错误的	与netty中的`ChannelOption.SO_KEEPALIVE`相同
Childoptionsolinger	-1	与netty中的`ChannelOption.SO_LINGER`相同
ChildOptionallowHalfmusosure	错误的	与netty中的`ChannelOption.ALLOW_HALF_CLOSURE`
ReaderIdletimesseconds	0	与`IdleStateHandler`中的`readerIdleTimeSeconds`相同，并在不是0时添加`IdleStateHandler`到`pipeline`
Writeridletimeseconds	0	与`IdleStateHandler`中的`writerIdleTimeSeconds`相同，并在不是0时添加`IdleStateHandler`到`pipeline`中
Allidletimeseconds	0	与`IdleStateHandler`中的`allIdleTimeSeconds`相同，并在不是0时添加`IdleStateHandler`将管道添加到`pipeline`中
MaxFramePayLoadLength	65536	最大允许的框架有效载荷长度。
USEEVENTEXECUTORGROUP	真的	是否使用另一个线程池执行时必的同步业务逻辑
EventExecutorGroupThreads	16	Bosseventloopgroup中的线程数字
sslkeypassword	”（平均未设置）	与spring-boot中的`server.ssl.key-password`相同
sslkeystore	”（平均未设置）	与Spring-Boot中的`server.ssl.key-store`相同
SSLKeyStorePassword	”（平均未设置）	与spring-boot中的`server.ssl.key-store-password`相同
SSLKeyStoreType	”（平均未设置）	与spring-boot中的`server.ssl.key-store-type`相同
ssltruststore	”（平均未设置）	与Spring-boot中的`server.ssl.trust-store`相同
sslTrustStorePassword	”（平均未设置）	与Spring-boot中的`server.ssl.trust-store-password`相同
ssltrustStoreType	”（平均未设置）	与spring-boot中的`server.ssl.trust-store-type`相同
紧身果皮	{}（均值未设置）	与`@CrossOrigin#origins`相同
CorsallowCreDentials	”（平均未设置）	与`@CrossOrigin#allowCredentials`

通过application.properties进行配置

您可以使用${...}占位符获得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

配置favicon favicon.ico方式与spring-boot.favicon.ico相同。

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

自定义错误页面

配置favicon的方式与spring-boot.you可以添加到/public/error Forment的文件。错误页面的名称应为确切的状态代码或串联蒙版。示例如下：

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