使用SuperSocket的FixedHeaderReceiveFilter進行通訊

前幾個月有個專案需要和其他裝置通訊,需要用到TCP和UDP通訊.本來開始也是用的C#原生態socket通訊庫,但是後來發現了一個”我不想說他名字坑爹庫”,經過測試,用起來還挺順手,就直接把這個”我不想說他名字坑爹庫”引入了專案中.還把使用方法寫在了部落格園,測試demo還上傳了程式碼(通訊庫並沒有原始碼,只有dll檔案).

結果,大約三個月後,有人給我留言,說他下載了”我不想說他名字坑爹庫”的demo原始碼,並且引入了專案中,但是要收費,已經過期,他們的專案已經掛了.開始我還不信((當時我在出差,其實我自己專案中的這個坑爹庫也過期了),一直以為”我不想說他名字坑爹庫”是免費的,是他們專案中的其他庫出問題了,後來發現,這個庫確實要收費的,並且還價格不菲.我簡直*****了.

幸好我們的專案還沒上線,不然真的要死翹翹了,丟人要丟到外國去了.不過下載我原始碼的兄弟就真的對不起了.我在這裡真誠的為你們感到sorry.

後來嘛,就只能換噻,好在程式碼框架還行,通訊和業務耦合度很低,換通訊框架很容易.在這個開源大行其道的世界,遇到收費的庫,我也是無語.再後來,就找到SuperSocket了,開源的,老闆再也不擔心軟體過期了.

這個文章就不介紹SuperSocket的其他東西了,只寫FixedHeaderReceiveFilter通訊例子.

 

需求:一個tcp服務端,多個tcp客戶端,客戶端可向服務端傳送訊息,服務端向連線的每個客戶端廣播訊息.

 

1.定義訊息格式

要傳送的訊息格式直接給出來:

Public class SuperSocketMessage
    {
        public byte[] Start;//4個位元組
        public ushort Type;//2個位元組, 1表示文字訊息,2表示圖片訊息,其他表示未知,不能解析
        public int Len;//4個位元組
        public string Message;//文字資訊
        public byte[] Tail;//訊息結尾

        public SuperSocketMessage()
        {
            Start = new byte[] { 0xFF, 0xFF, 0xFF, 0xFF };
            Tail = new byte[] { 0x1F, 0x1F, 0x1F, 0x1F };
        }

        public byte[] ToBytes()
        {
            List<byte> list = new List<byte>();
            list.AddRange(Start);
            var t = BitConverter.GetBytes(Type);
            list.AddRange(t);

            var t3 = System.Text.Encoding.UTF8.GetBytes(Message);
            var t2 = BitConverter.GetBytes(t3.Length);//注意,這裡不是Message.Length,而是Message轉化成位元組陣列後的Lenght

            list.AddRange(t2);
            list.AddRange(t3);

            return list.ToArray();
        }
}

請記住以下幾個數字或資訊:

1. 訊息頭部包含三個元素:開始,型別和訊息body的長度
2. 從第六個位元組開始表示長度
3. 表示長度位元組數是4個位元組
4. Body的長度不要搞混,不是Message的字串長度,而是Message轉換位元組陣列後的長度,除錯的時候,開始用了Message的字串長度,給我造成了幾個小時的浪費.
5. 以上資訊請和下面的MyReceiveFilter類中的引數對照看.

2.建立一個tcp客戶端

1.新建一個控制檯程式TcpClientTest,這裡為了測試的客觀性,直接使用C#的TcpClient作為客戶端.

2.新增Class: MyTcpClient.cs

class MyTcpClient
    {
        private System.Net.Sockets.TcpClient tcpClient;
        public MyTcpClient(string ip, int port)
        {

            tcpClient = new System.Net.Sockets.TcpClient(ip, port);
            byte[] recData = new byte[1024];
            Action a = new Action(() =>
            {
                while (true)
                {
                    tcpClient.Client.Receive(recData);
                    var msg = System.Text.Encoding.UTF8.GetString(recData);
                    Console.WriteLine(msg);
                }
            });
            a.BeginInvoke(null, null);

        }

        public void Send(string message)
        {
            var data = System.Text.Encoding.UTF8.GetBytes(message);
            tcpClient.Client.Send(data);
        }
        public void Send(byte[] message)
        {
            tcpClient.Client.Send(message);
        }
}

3.Main函式:

static void Main(string[] args)
        {
            MyTcpClient c = new MyTcpClient("127.0.0.1", 2020);
            SuperSocketMessage.SSMessage msg = new SuperSocketMessage.SSMessage();
            while (true)
            {
                string m = Console.ReadLine();
                msg.Type = 1;
                msg.Message = m;
                c.Send(msg.ToBytes());
            }
        }

客戶端實現控制檯輸入任意字串後,封裝成訊息報文,發給服務端;同時,開啟一個執行緒,接收服務端的訊息.這裡客服端就沒有按照標準來解析了.直接定義緩衝區1024.

3.SuperSocket作為服務端

1. 新建控制檯程式SuperSocketServer
2. 使用nuget工具安裝SuperSocket和SuperSocket.Engine庫
3. 實現3個類: Filter,Session和Server

Filter類如下:

 public class MyReceiveFilter : FixedHeaderReceiveFilter<BinaryRequestInfo>
    {

        public MyReceiveFilter()
            : base(10)//訊息頭部長度
        {        }
        /// <summary>
        /// 
        /// </summary>
        /// <param name="header">*byte[] header * 快取的資料，這個並不是單純只包含協議頭的資料,有時候tcp協議長度為409600,很多</param>
        /// <param name="offset">頭部資料從 快取的資料 中開始的索引,一般為0.(tcp協議有可能從405504之類的一個很大資料開始)</param>
        /// <param name="length">這個length和base(10)中的引數相等</param>
        /// <returns></returns>
        protected override int GetBodyLengthFromHeader(byte[] header, int offset, int length)
        {
            return GetBodyLengthFromHeader(header, offset, length, 6, 4);//6表示第幾個位元組開始表示長度.4:由於是int來表示長度,int佔用4個位元組
        }
        protected override BinaryRequestInfo ResolveRequestInfo(ArraySegment<byte> header, byte[] bodyBuffer, int offset, int length)
        {

            byte[] body = new byte[length];
            Array.Copy(bodyBuffer, offset, body, 0, length);

            Int16 type = BitConverter.ToInt16(header.ToArray(), 4);

            BinaryRequestInfo r = new BinaryRequestInfo(type.ToString(), body);
            return r;

            //以下的程式碼,不解析body,全部返給上一層
            //byte[] h = header.ToArray();
            //byte[] full = new byte[h.Count()+length];
            //Array.Copy(h, full, h.Count());
            //Array.Copy(body, 0, full, h.Count(), body.Length );
            //BinaryRequestInfo r = new BinaryRequestInfo("",full);
            //return r;

        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="header">需要解析的資料</param>
        /// <param name="offset">頭部資料從header中開始的索引,一般為0,也可能不是0</param>
        /// <param name="length">這個length和base(10)中的引數相等</param>
        /// <param name="lenStartIndex">表示長度的位元組從第幾個開始</param>
        /// <param name="lenBytesCount">幾個位元組來表示長度:4個位元組=int,2個位元組=int16,1個位元組=byte</param>
        /// <returns></returns>
        private int GetBodyLengthFromHeader(byte[] header, int offset, int length, int lenStartIndex, int lenBytesCount)
        {
            var headerData = new byte[lenBytesCount];
            Array.Copy(header, offset + lenStartIndex, headerData, 0, lenBytesCount);//
            if (lenBytesCount == 1)
            {
                int i = headerData[0];
                return i;
            }
            else if (lenBytesCount == 2)
            {
                int i = BitConverter.ToInt16(headerData, 0);
                return i;
            }
            else //  if (lenBytesCount == 4)
            {
                int i = BitConverter.ToInt32(headerData, 0);
                return i;
            }
        }
}

Server和Session類如下:

public class MyServer : AppServer<MySession, BinaryRequestInfo>
    {
        public MyServer()
            : base(new DefaultReceiveFilterFactory<MyReceiveFilter, BinaryRequestInfo>()) //使用預設的接受過濾器工廠 (DefaultReceiveFilterFactory)
        {
        }
    }

    public class MySession : AppSession<MySession, BinaryRequestInfo>
    {
    }

BinaryRequestInfo實現了 IRequestInfo介面,這個介面就一個key,貌似SuperSocket的所有資料都是實現這個介面

     4.Main函式關鍵程式碼:

配置:

MyServer appServer = new MyServer();
            var se = new SuperSocket.SocketBase.Config.ServerConfig();
            se.TextEncoding = "Unicode";// System.Text.Encoding.
            se.TextEncoding = "gbk";// System.Text.Encoding.
            se.Ip = "127.0.0.1";
            se.Port = 2020;
            se.Mode = SocketMode.Tcp;

註冊,啟動:

if (!appServer.Setup(se)) //Setup with listening port
            {
                Console.WriteLine("Failed to setup!");
                Console.ReadKey();
                return;
            }
            Console.WriteLine();
            //Try to start the appServer
            if (!appServer.Start())
            {
                Console.WriteLine("Failed to start!");
                Console.ReadKey();
                return;
            }

註冊事件:

appServer.NewSessionConnected += appServer_NewSessionConnected;
appServer.SessionClosed += appServer_SessionClosed;
appServer.NewRequestReceived += XXXXXXXXXXXXXXXXXXX

解析方法:

static void appServer_NewRequestReceived(MySession session, BinaryRequestInfo requestInfo)
        {
            string key = requestInfo.Key;
            switch (key)
            {
                case "1":
                    Console.WriteLine("Get message from " + session.RemoteEndPoint.ToString() + ":" + System.Text.Encoding.UTF8.GetString(requestInfo.Body));
                    break;
                case "2":
                    Console.WriteLine("Get image");
                    break;
                default:
                    Console.WriteLine("Get unknown message.");
                    break;
            }
        }

好.完成.截圖如下:

附原始碼下載地址:https://download.csdn.net/download/hanghangz/11236794

專案中用nuget下載packages中的內容沒有上傳,檔案太大了,自己去nuget吧.