BeetleX之Websocket服务使用

        BeetleX.FastHttpApi不仅是一个Webapi服务组件，它同时也是一个Websocket服务组件。由于BeetleX.FastHttpApi的实现是直接支持Websocket Upgrade操作，所以当启动服务后是HTTP还是Websocket完全取决于请求方；其原理和aspcore一样，同一个服务端口即是Webapi也是Websocket.

定义服务

        构建Websocket服务需要引用BeetleX.FastHttpApi组件，然后定义相关HttpApiServer启动即可。

static void Main(string[] args)
{
    HttpApiServer server = new HttpApiServer();
    server.Options.SetDebug();
    server.Options.Port = 80;
    server.Options.LogLevel = EventArgs.LogType.Info;
    server.Options.LogToConsole = true;
    server.WebSocketReceive = (r, e) =>
    {
        DataBuffer<byte> data = (DataBuffer<byte>)e.Frame.Body;
        string message = Encoding.UTF8.GetString(data.Data, data.Offset, data.Length);
        Console.WriteLine();
        var result = e.CreateFrame($"hello {message} {DateTime.Now}");
        e.Sesson.Send(result);


    };
    server.Open();
    System.Threading.Thread.Sleep(-1);
}

可以通过绑定WebSocketReceive事件来接管Websocket请求处理，以上代码是获取接收的数据然后返回一个对应的hello信息。

Web访问

        定义好服务后就可以通过页面创建Websocket对象进行访问.

    <div id="app">
        <div>
            <input type="text" v-model="message" />
            <button @click="doSend">发送</button>
        </div>
        <div>
            <p v-for="item in items">{{item}}</p>
        </div>
    </div>
    <script>
        var page = new Vue({
            el: '#app',
            data: {
                items: [],
                websocket: null,
                message: '',
                wsUri: "ws://localhost/",
            },
            methods: {
                onOpen(evt) {
                    this.items.push('CONNECTED');
                },
                onClose(evt) {
                    this.items.push('DISCONNECTED');
                },
                onMessage(evt) {
                    this.items.push('Receive:' + evt.data);
                },
                onError(evt) {
                    this.items.push('Error:' + evt.data);
                },
                doSend() {
                    this.items.push('Send:' + this.message);
                    websocket.send(this.message);
                },
                onConnect() {
                    websocket = new WebSocket(this.wsUri);
                    websocket.onopen =  (evt) =>{ this.onOpen(evt) };
                    websocket.onclose =  (evt) =>{ this.onClose(evt) };
                    websocket.onmessage =  (evt)=> { this.onMessage(evt) };
                    websocket.onerror =  (evt) =>{ this.onError(evt) };
                }
            },
            mounted() {
                this.onConnect();
            }
        });
</script>

消息序列化

        在处理Websocket消息的时候往往需要处理不同的情况，组件提供一个默认的实现，其接收数据是DataBuffer<byte> 结构；而返回如果是string直接输出，当是对象的时候就直接Json序列化输出。组件通过IDataFrameSerializer接口来规范这个行为，默认实现如下:

        public virtual object FrameDeserialize(DataFrame data, PipeStream stream)
        {
            DataBuffer<byte> buffer = new DataBuffer<byte>((int)data.Length);
            stream.Read(buffer.Data, 0, buffer.Length);
            return buffer;
        }
        
        private System.Collections.Concurrent.ConcurrentQueue<byte[]> mBuffers = new System.Collections.Concurrent.ConcurrentQueue<byte[]>();


        public virtual ArraySegment<byte> FrameSerialize(DataFrame data, object body)
        {
            byte[] result;
            if (!mBuffers.TryDequeue(out result))
            {
                result = new byte[this.Options.MaxBodyLength];
            }
            string value;
            if (body is string)
            {
                value = (string)body;
                int length = Options.Encoding.GetBytes(value, 0, value.Length, result, 0);
                return new ArraySegment<byte>(result, 0, length);
            }
            else
            {
                value = Newtonsoft.Json.JsonConvert.SerializeObject(body);
                int length = Options.Encoding.GetBytes(value, 0, value.Length, result, 0);
                return new ArraySegment<byte>(result, 0, length);
            }
        }


        public virtual void FrameRecovery(byte[] buffer)
        {
            mBuffers.Enqueue(buffer);
        }

可以根据实际应用需要继承HttpApiServer重写以上几个方法，如果不想继承则实现IDataFrameSerializer接口，设置到HttpApiServer.FrameSerializer属性上。

下载示例

链接：

https://pan.baidu.com/s/1Zuph6VdjewcX6Gc9y5amOA

提取码：

ny4u

【BeetleX通讯框架代码详解】
【WebApi示例扩展】
BeetleX

开源跨平台通讯框架(支持TLS)
轻松实现高性能:tcp、http、websocket、redis、rpc和网关等服务应用

https://beetlex.io

如果你想了解某方面的知识或文章可以把想法发送到

henryfan@msn.com|admin@beetlex.io