如何为asp.net core添加protobuf支持详解
前言
在一些性能要求很高的应用中，使用protocolbuffer序列化，优于Json。而且protocolbuffer向后兼容的能力比较好。
由于Asp.netcore采用了全新的MiddleWare方式，因此使用protobuf序列化，只需要使用Protobuf-net修饰需要序列化的对象，并在MVC初始化的时候增加相应的Formatter就可以了。
没时间解释了，快上车。
通过NuGet获取Zaabee.AspNetCoreProtobuf
Install-PackageZaabee.AspNetCoreProtobuf
在Startup.cs文件中修改ConfigureServices方法
publicvoidConfigureServices(IServiceCollectionservices)
{
services.AddMvc(options=>{options.AddProtobufSupport();});
}
搞掂……这时候你就可以通过application/x-protobuf的content-type来让asp.netcore使用protobuf来进行序列化/反序列化。
测试代码
在asp.netcore项目中添加以下DTO
[ProtoContract]
publicclassTestDto
{
[ProtoMember(1)]publicGuidId{get;set;}
[ProtoMember(2)]publicstringName{get;set;}
[ProtoMember(3)]publicDateTimeCreateTime{get;set;}
[ProtoMember(4)]publicListKids{get;set;}
[ProtoMember(5)]publiclongTag{get;set;}
[ProtoMember(6)]publicTestEnumEnum{get;set;}
}
publicenumTestEnum
{
Apple,
Banana,
Pear
}
新建一个XUnit项目，通过Nuget引用Microsoft.AspNetCore.TestHost，建立一个测试类
publicclassAspNetCoreProtobufTest
{
privatereadonlyTestServer_server;
privatereadonlyHttpClient_client;
publicAspNetCoreProtobufTest()
{
_server=newTestServer(
newWebHostBuilder()
.UseKestrel()
.UseStartup());
_client=_server.CreateClient();
}
[Fact]
publicvoidTest()
{
//HTTPPostwithProtobufResponseBody
_client.DefaultRequestHeaders.Accept.Add(newMediaTypeWithQualityHeaderValue("application/x-protobuf"));
vardtos=GetDtos();
varstream=newMemoryStream();
ProtoBuf.Serializer.Serialize(stream,dtos);
HttpContenthttpContent=newStreamContent(stream);
//HTTPPOSTwithProtobufRequestBody
varresponseForPost=_client.PostAsync("api/Values",httpContent);
varresult=ProtoBuf.Serializer.Deserialize>(
responseForPost.Result.Content.ReadAsStreamAsync().Result);
Assert.True(CompareDtos(dtos,result));
}
privatestaticboolCompareDtos(ListlstOne,ListlstTwo)
{
lstOne=lstOne??newList();
lstTwo=lstTwo??newList();
if(lstOne.Count!=lstTwo.Count)returnfalse;
for(vari=0;iGetDtos()
{
returnnewList
{
newTestDto
{
Id=Guid.NewGuid(),
Tag=long.MaxValue,
CreateTime=DateTime.Now,
Name="0",
Enum=TestEnum.Apple,
Kids=newList
{
newTestDto
{
Id=Guid.NewGuid(),
Tag=long.MaxValue-1,
CreateTime=DateTime.Now,
Name="00",
Enum=TestEnum.Banana
},
newTestDto
{
Id=Guid.NewGuid(),
Tag=long.MaxValue-2,
CreateTime=DateTime.Now,
Name="01",
Enum=TestEnum.Pear
}
}
},
newTestDto
{
Id=Guid.NewGuid(),
Tag=long.MaxValue-3,
CreateTime=DateTime.Now,
Name="1",
Enum=TestEnum.Apple,
Kids=newList
{
newTestDto
{
Id=Guid.NewGuid(),
Tag=long.MaxValue-4,
CreateTime=DateTime.Now,
Name="10",
Enum=TestEnum.Banana
},
newTestDto
{
Id=Guid.NewGuid(),
Tag=long.MaxValue-5,
CreateTime=DateTime.Now,
Name="11",
Enum=TestEnum.Pear
}
}
}
};
}
}
为什么要用protobuf？
因为快……在我们这边使用业务数据的测试中，protobuf的序列化/反序列化性能大概是Json.net的三倍，序列化后的体积大概只有Json的二分之一，这可以在相当程度上提高webapi的吞吐性能。
另外就是Json对于浮点数的处理存在精度丢失，因为JS的number类型的安全整数是53位。当我们使用雪花算法来提供全局递增ID时会因为精度丢失导致重复主键。而且情况不仅如此，由于同样原因传递DateTime类型也会因为毫秒不一致导致时间匹配错误。一般的解决方法是使用字符串传递，不过这毕竟属于偏方并没有从根源上解决问题，因此我们还是直接使用protobuf来处理。
protobuf的缺点
DTO层必须引用protobuf-net来添加特性，这在一定程度上导致了代码的侵入。基本上DTO属于POCO，依赖第三方包的话总觉得有点不贞洁……另外就是protobuf序列化后的数据不具有可视化，因此如果是使用消息队列或者请求监控的地方，就要综合考虑protobuf是否适合使用场景。
原理
asp.netcore是基于中间件方式来实现，其自带默认的JsonFormater（基于Json.net），asp.netcore会根据contenttype来选择对应的Formater来处理对象的序列化，当中包括InputFormatter（反序列化）和OutputFormatter（序列化）。因此除了protobuf，我们还可以添加或者替换其它的序列化方式，例如使用Jil来代替Json.net来提高Json性能。
以上实现以及Demo和测试的源代码已放到GitHub上。
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对毛票票的支持。