SuperSocket 2.0學習03：實現你的PipelineFilter

官方學習資料：實現你的PipelineFilter。

本文開發環境：Win10 + VS2019 + .NetCore 3.1 + SuperSocket 2.0.0-beta.8。

Gitee：SuperSocketV2Sample。

1、創建項目

使用VS2019創建.NET Core控制台程序，選擇.Net Core 3.1，通過NuGet引入SuperSocket(2.0.0-beta.8)。

2、添加配置文件

在項目根目錄添加appsettings.json配置文件，並設置其文件屬性為“如果較新則復制”。配置文件內容不再贅述。

3、PipelineFilter 

using SuperSocket.ProtoBase;

namespace SuperSocketV2Sample.PipelineFilter.Server
{
    public class MyPackage : IKeyedPackageInfo<short>
    {
        public short Key { get; set; }
        public byte[] Body { get; set; }
    }
}

using System.Buffers;
using SuperSocket.ProtoBase;

namespace SuperSocketV2Sample.PipelineFilter.Server
{
    public class MyPipelineFilter : FixedHeaderPipelineFilter<MyPackage>
    {
        /// +-------+---+----------------------+
        /// |request| l |                      |
        /// | type  | e |     request body     |
        /// |  (2)  | n |                      |
        /// |       |(2)|                      |
        /// +-------+---+----------------------+

        private const int HeaderSize = 4; //Header總長度

        private const int HeaderLenOffset = 2; //長度offset

        public MyPipelineFilter()
            : base(HeaderSize) //包頭大小是4字節，所以將4傳入基類構造方法
        {

        }

        //從數據包的頭部返回包體的大小
        protected override int GetBodyLengthFromHeader(ref ReadOnlySequence<byte> buffer)
        {
            var reader = new SequenceReader<byte>(buffer);
            reader.Advance(HeaderLenOffset); //跳過前2個字節
            reader.TryReadBigEndian(out short len); //以大端方式讀取short類型數據
            return len;
        }

        protected override MyPackage DecodePackage(ref ReadOnlySequence<byte> buffer)
        {
            var reader = new SequenceReader<byte>(buffer);
            reader.TryReadBigEndian(out short packageKey);

            var body = buffer.Slice(HeaderSize).ToArray();
            return new MyPackage
            {
                Key = packageKey,
                Body = body
            };
        }
    }
}

4、測試代碼

using System.Threading.Tasks;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using SuperSocket;
using SuperSocketV2Sample.PipelineFilter.Server;

namespace SuperSocketV2Sample.PipelineFilter
{
    class Program
    {
        static async Task Main()
        {
            //創建宿主：用Package的類型和PipelineFilter的類型創建SuperSocket宿主。
            var host = SuperSocketHostBuilder.Create<MyPackage, MyPipelineFilter>()
                //配置日志
                .ConfigureLogging((hostCtx, loggingBuilder) =>
                {
                    loggingBuilder.AddConsole();
                })
                .Build();
            await host.RunAsync();
        }
    }
}

5、注意事項

要使用上述的MyPackage類型實現按字節接收數據，需要對其實現IKeyedPackageInfo接口，因為在運行時IAsyncCommand類需要實現IKeyedPackageInfo接口的類型作為泛型參數，從而在Command類上添加的Command屬性才會有意義，例如：

[Command(Key = (short) 100)]
public class MyCommand : IAsyncCommand<MyPackage>

此外，IAsyncCommand類型中Command屬性中的Key值類型，需要和IKeyedPackageInfo接口中的泛型類型保持一致。