This commit is contained in:
Redkale
18
net.html
18
net.html
@@ -175,19 +175,13 @@
|
||||
<p id="net_ws"> <b> WebSokcet 服务</b> </p>
|
||||
<p> WebSokcet协议遵循<a href="http://tools.ietf.org/html/rfc645" target="_blank">IETF RFC 6455</a>，其接口并不符合Java EE中的WebSocket的接口规范。<br/>
|
||||
一个WebSocket连接对应一个WebSocket实体，即一个WebSocket会绑定一个TCP连接。且有两种模式:<br/>
|
||||
1) 普通模式: 协议上符合HTML5规范, 其流程顺序如下:<br/>
|
||||
协议上符合HTML5规范, 其流程顺序如下:<br/>
|
||||
1.1 onOpen 若返回null，视为WebSocket的连接不合法，强制关闭WebSocket连接；通常用于判断登录态。<br/>
|
||||
1.2 createUserid 若返回null，视为WebSocket的连接不合法，强制关闭WebSocket连接；通常用于判断用户权限是否符合。<br/>
|
||||
1.3 onConnected WebSocket成功连接后在准备接收数据前回调此方法。<br/>
|
||||
1.4 onMessage/onFragment+ WebSocket接收到消息后回调此消息类方法。<br/>
|
||||
1.5 onClose WebSocket被关闭后回调此方法。<br/>
|
||||
此模式下 以上方法都应该被重载。<br/>
|
||||
<br/>
|
||||
2) 原始二进制模式: 此模式有别于HTML5规范，可以视为原始的TCP连接。通常用于音频视频通讯场景。其流程顺序如下:<br/>
|
||||
2.1 onOpen 如果方法返回null，视为WebSocket的连接不合法，强制关闭WebSocket连接；通常用于判断登录态。<br/>
|
||||
2.2 createUserid 若返回null，视为WebSocket的连接不合法，强制关闭WebSocket连接；通常用于判断用户权限是否符合。<br/>
|
||||
2.3 onRead WebSocket成功连接后回调此方法， 由此方法处理原始的TCP连接， 同时业务代码去控制WebSocket的关闭。<br/>
|
||||
此模式下 以上方法都应该被重载。<br/>
|
||||
</p>
|
||||
<p> 实现一个WebSocket服务需要继承 org.redkale.net.http.WebSocketServlet，以下是一个简单的聊天范例：</p>
|
||||
<div class="highlight"><pre><span></span><span class="nd">@WebServlet</span><span class="o">(</span><span class="s">"/ws/chat"</span><span class="o">)</span>
|
||||
@@ -700,10 +694,10 @@
|
||||
<span class="kd">public</span> <span class="n">CompletableFuture</span><span class="o"><</span><span class="n">Integer</span><span class="o">></span> <span class="nf">send</span><span class="o">(</span><span class="n">Object</span> <span class="n">message</span><span class="o">,</span> <span class="kt">boolean</span> <span class="n">last</span><span class="o">);</span>
|
||||
|
||||
<span class="c1">//给自身发送消息, 消息类型是JavaBean对象 返回结果0表示成功，非0表示错误码</span>
|
||||
<span class="kd">public</span> <span class="n">CompletableFuture</span><span class="o"><</span><span class="n">Integer</span><span class="o">></span> <span class="nf">send</span><span class="o">(</span><span class="n">JsonConvert</span> <span class="n">convert</span><span class="o">,</span> <span class="n">Object</span> <span class="n">message</span><span class="o">);</span>
|
||||
<span class="kd">public</span> <span class="n">CompletableFuture</span><span class="o"><</span><span class="n">Integer</span><span class="o">></span> <span class="nf">send</span><span class="o">(</span><span class="n">Convert</span> <span class="n">convert</span><span class="o">,</span> <span class="n">Object</span> <span class="n">message</span><span class="o">);</span>
|
||||
|
||||
<span class="c1">//给自身发送消息, 消息类型是JavaBean对象 返回结果0表示成功，非0表示错误码</span>
|
||||
<span class="kd">public</span> <span class="n">CompletableFuture</span><span class="o"><</span><span class="n">Integer</span><span class="o">></span> <span class="nf">send</span><span class="o">(</span><span class="n">JsonConvert</span> <span class="n">convert</span><span class="o">,</span> <span class="n">Object</span> <span class="n">message</span><span class="o">,</span> <span class="kt">boolean</span> <span class="n">last</span><span class="o">);</span>
|
||||
<span class="kd">public</span> <span class="n">CompletableFuture</span><span class="o"><</span><span class="n">Integer</span><span class="o">></span> <span class="nf">send</span><span class="o">(</span><span class="n">Convert</span> <span class="n">convert</span><span class="o">,</span> <span class="n">Object</span> <span class="n">message</span><span class="o">,</span> <span class="kt">boolean</span> <span class="n">last</span><span class="o">);</span>
|
||||
|
||||
<span class="c1">//给指定userid的WebSocket节点发送 二进制消息/文本消息/JavaBean对象消息 返回结果0表示成功，非0表示错误码</span>
|
||||
<span class="kd">public</span> <span class="n">CompletableFuture</span><span class="o"><</span><span class="n">Integer</span><span class="o">></span> <span class="nf">sendMessage</span><span class="o">(</span><span class="n">Object</span> <span class="n">message</span><span class="o">,</span> <span class="n">G</span><span class="o">...</span> <span class="n">userids</span><span class="o">);</span>
|
||||
@@ -752,9 +746,6 @@
|
||||
<span class="c1">//创建userid， null表示异常， 必须实现该方法</span>
|
||||
<span class="kd">protected</span> <span class="kd">abstract</span> <span class="n">G</span> <span class="nf">createUserid</span><span class="o">();</span>
|
||||
|
||||
<span class="c1">//标记为@WebSocketBinary才需要重写此方法</span>
|
||||
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onRead</span><span class="o">(</span><span class="n">AsyncConnection</span> <span class="n">channel</span><span class="o">);</span>
|
||||
|
||||
<span class="c1">//WebSokcet连接成功后的回调方法</span>
|
||||
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onConnected</span><span class="o">();</span>
|
||||
|
||||
@@ -767,6 +758,9 @@
|
||||
<span class="c1">//接收到消息的回调方法</span>
|
||||
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onMessage</span><span class="o">(</span><span class="n">T</span> <span class="n">message</span><span class="o">,</span> <span class="kt">boolean</span> <span class="n">last</span><span class="o">);</span>
|
||||
|
||||
<span class="c1">//接收到文本消息的回调方法</span>
|
||||
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onMessage</span><span class="o">(</span><span class="n">String</span> <span class="n">message</span><span class="o">,</span> <span class="kt">boolean</span> <span class="n">last</span><span class="o">);</span>
|
||||
|
||||
<span class="c1">//接收到二进制消息的回调方法</span>
|
||||
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onMessage</span><span class="o">(</span><span class="kt">byte</span><span class="o">[]</span> <span class="n">bytes</span><span class="o">,</span> <span class="kt">boolean</span> <span class="n">last</span><span class="o">);</span>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user