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接口中的泛型类型保持一致。