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>