FSharp.Data.JsonProvider.Serializer 1.0.2

FSharp.Data.JsonProvider.Serializer

NuGet包： https://nuget.net.cn/packages/FSharp.Data.JsonProvider.Serializer/ 此包不是独立包，您仍将使用现有的JsonProvider。

这将提供使用快速System.Text.Json库序列化FSharp.Data.JsonProvider项的实用工具。

• FSharp.Data: https://fsprojects.github.io/FSharp.Data/
• System.Text.Json: https://nuget.net.cn/packages/System.Text.Json

动机：序列化速度。通常JSON序列化用于用户查看进度条或在大批量处理中。

当前FSharp.Data使用自定义Json序列化器。

我们需要一个折衷的方案，既有F# JsonProvider的便利性，又有System.Text.Json的速度。

这个方案的想法是替换当前的函数。

从类型提供程序中读取值（反序列化）

当前FSharp.Data.JsonProvider

type MyJsonType = FSharp.Data.JsonProvider<"""{ "model": "..." } """>

let fromJson (response:string) = MyJsonType.Parse response

使用这个库

type MyJsonType = FSharp.Data.JsonProvider<"""{ "model": "..." } """>

let fromJson (response:string) = MyJsonType.Load (Serializer.Deserialize response)

从类型提供程序中保存值（序列化）

当前FSharp.Data.JsonProvider

type MyJson = FSharp.Data.JsonProvider<"""{ "model": "..." } """>

let toJson mymodel = mymodel.JsonValue.ToString()

使用这个库

type MyJson = FSharp.Data.JsonProvider<"""{ "model": "..." } """>

let toJson mymodel = Serializer.Serialize (mymodel.JsonValue)

除此之外，您仍然可以像以前一样继续使用现有的JsonProvider实现。目前它使用System.Text.Json风格的编码引号字符等，但如果您想进一步自定义序列化，可以将JsonReaderOptions和JsonWriterOptions作为参数设置。

初始基准测试

FSharp.Data 6.3，System.Text.Json 8.0

测试用例

• 将JSON读取到JsonProvider。（序列化）
• 验证一个属性
• 将JSON保存回字符串。（反序列化）

使用了小型JSON文件以及Stripe OpenAPI规范文件（+5MB的JSON）进行了测试。

BenchmarkDotNet v0.13.10，Windows 11（10.0.22621.2715/22H2/2022Update/SunValley2）第13代英特尔酷睿i9-13900H，1个CPU，20个逻辑和14个物理核心

.NET 8.0 : .NET 8.0.0 (8.0.23.53103)，X64 RyuJIT AVX2

.NET Framework 4.8 : .NET Framework 4.8.1 (4.8.9181.0)，X64 RyuJIT VectorSize=256

要运行测试：dotnet run --project tests\Benchmarks\BenchmarkTests.fsproj --configuration=Release --framework=net8.0

API

FSharp.Data使用内部类FSharp.Data.JsonValue来表示JSON域。

从JSON到JsonProvider

• Deserialize：将字符串转换为FSharp.Data.JsonValue
• DeserializeWith：字符串和System.Text.Json.JsonReaderOptions转换为FSharp.Data.JsonValue
• DeserializeBytes：字节数组转换为FSharp.Data.JsonValue
• DeserializeBytesWith：字节数组和System.Text.Json.JsonReaderOptions转换为FSharp.Data.JsonValue

从JsonProvider到JSON

• Serialize：FSharp.Data.JsonValue转换为字符串
• SerializeWith：FSharp.Data.JsonValue和System.Text.Json.JsonWriterOptions转换为字符串
• SerializeBytes：FSharp.Data.JsonValue转换为字节数组
• SerializeBytesWith：FSharp.Data.JsonValue和System.Text.Json.JsonWriterOptions转换为字节数组

从JsonProvider到JSON，流式传输

有了流支持，您可以将JSON数据记录逐记录地发送到输出流。

• SerializeStream：目标流，FSharp.Data.JsonValue
• SerializeStreamWith：目标流，FSharp.Data.JsonValue和System.Text.Json.JsonWriterOptions

流可能保持与相同的表现特性，但略微减少内存分配，并更快提供部分可消费的结果，如果JSON文件很大且客户端支持流。

.NET 8.0 : .NET 8.0.0 (8.0.23.53103)，X64 RyuJIT AVX2

.NET Framework 4.8 : .NET Framework 4.8.1 (4.8.9181.0)，X64 RyuJIT VectorSize=256