1. 程式人生 > >插上騰飛的翅膀:為asp.net core添加protobuf支持

插上騰飛的翅膀:為asp.net core添加protobuf支持

put 屬於 acc cati ++ 業務 cep ati down

沒時間解釋了,快上車。

通過NuGet獲取Zaabee.AspNetCoreProtobuf

Install-Package Zaabee.AspNetCoreProtobuf

在Startup.cs文件中修改ConfigureServices方法

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(options => { options.AddProtobufSupport(); });
}

搞掂……這時候你就可以通過application/x-protobuf的content-type來讓asp.net core使用protobuf來進行序列化/反序列化。

測試代碼

在asp.net core項目中添加以下DTO

[ProtoContract]
public class TestDto
{
    [ProtoMember(1)] public Guid Id { get; set; }
    [ProtoMember(2)] public string Name { get; set; }
    [ProtoMember(3)] public DateTime CreateTime { get; set; }
    [ProtoMember(4)] public List<TestDto> Kids { get; set; }
    [ProtoMember(5)] public long Tag { get; set; }
    [ProtoMember(6)] public TestEnum Enum { get; set; }
}

public enum TestEnum
{
    Apple,
    Banana,
    Pear
}

新建一個XUnit項目,通過Nuget引用Microsoft.AspNetCore.TestHost,建立一個測試類

public class AspNetCoreProtobufTest
{
    private readonly TestServer _server;
    private readonly HttpClient _client;

    public AspNetCoreProtobufTest()
    {
        _server = new TestServer(
            new WebHostBuilder()
                .UseKestrel()
                .UseStartup<Startup>());
        _client = _server.CreateClient();
    }

    [Fact]
    public void Test()
    {
        // HTTP Post with Protobuf Response Body
        _client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/x-protobuf"));

        var dtos = GetDtos();
        var stream = new MemoryStream();
        ProtoBuf.Serializer.Serialize(stream, dtos);

        HttpContent httpContent = new StreamContent(stream);

        // HTTP POST with Protobuf Request Body
        var responseForPost = _client.PostAsync("api/Values", httpContent);

        var result = ProtoBuf.Serializer.Deserialize<List<TestDto>>(
            responseForPost.Result.Content.ReadAsStreamAsync().Result);

        Assert.True(CompareDtos(dtos,result));
    }

    private static bool CompareDtos(List<TestDto> lstOne, List<TestDto> lstTwo)
    {
        lstOne = lstOne ?? new List<TestDto>();
        lstTwo = lstTwo ?? new List<TestDto>();

        if (lstOne.Count != lstTwo.Count) return false;

        for (var i = 0; i < lstOne.Count; i++)
        {
            var dtoOne = lstOne[i];
            var dtoTwo = lstTwo[i];
            if (dtoOne.Id != dtoTwo.Id || dtoOne.CreateTime != dtoTwo.CreateTime || dtoOne.Enum != dtoTwo.Enum ||
                dtoOne.Name != dtoTwo.Name || dtoOne.Tag != dtoTwo.Tag || !CompareDtos(dtoOne.Kids, dtoTwo.Kids))
                return false;
        }

        return true;
    }

    private static List<TestDto> GetDtos()
    {
        return new List<TestDto>
        {
            new TestDto
            {
                Id = Guid.NewGuid(),
                Tag = long.MaxValue,
                CreateTime = DateTime.Now,
                Name = "0",
                Enum = TestEnum.Apple,
                Kids = new List<TestDto>
                {
                    new TestDto
                    {
                        Id = Guid.NewGuid(),
                        Tag = long.MaxValue - 1,
                        CreateTime = DateTime.Now,
                        Name = "00",
                        Enum = TestEnum.Banana
                    },
                    new TestDto
                    {
                        Id = Guid.NewGuid(),
                        Tag = long.MaxValue - 2,
                        CreateTime = DateTime.Now,
                        Name = "01",
                        Enum = TestEnum.Pear
                    }
                }
            },
            new TestDto
            {
                Id = Guid.NewGuid(),
                Tag = long.MaxValue - 3,
                CreateTime = DateTime.Now,
                Name = "1",
                Enum = TestEnum.Apple,
                Kids = new List<TestDto>
                {
                    new TestDto
                    {
                        Id = Guid.NewGuid(),
                        Tag = long.MaxValue - 4,
                        CreateTime = DateTime.Now,
                        Name = "10",
                 https://i.cnblogs.com/EditCategories.aspx?catid=1       Enum = TestEnum.Banana
                    },
                    new TestDto
                    {
                        Id = Guid.NewGuid(),
                        Tag = long.MaxValue - 5,
                        CreateTime = DateTime.Now,
                        Name = "11",
                        Enum = TestEnum.Pear
                    }
                }
            }
        };
    }
}

為什麽要用protobuf?

因為快……在我們這邊使用業務數據的測試中,protobuf的序列化/反序列化性能大概是Json.net的三倍,序列化後的體積大概只有Json的二分之一,這可以在相當程度上提高webapi的吞吐性能。

protobuf的缺點

DTO層必須引用protobuf-net來添加特性,這在一定程度上導致了代碼的侵入。基本上DTO屬於POCO,依賴第三方包的話總覺得有點不貞潔……另外就是protobuf序列化後的數據不具有可視化,因此如果是使用消息隊列或者請求監控的地方,就要綜合考慮protobuf是否適合使用場景。

原理

asp.net core是基於中間件方式來實現,其自帶默認的JsonFormater(基於Json.net),asp.net core會根據content type來選擇對應的Formater來處理對象的序列化,當中包括InputFormatter(反序列化)和OutputFormatter(序列化)。因此除了protobuf,我們還可以添加或者替換其它的序列化方式,例如使用Jil來代替Json.net來提高Json性能。

以上實現以及Demo和測試的源代碼已放到GitHub上。

最後給大家拜個晚年,祝大家新年快樂~

插上騰飛的翅膀:為asp.net core添加protobuf支持