👁 Image
FSharp.Data.JsonProvider.Serializer 1.0.8

FSharp.Data.JsonProvider.Serializer

NuGet package: https://www.nuget.org/packages/FSharp.Data.JsonProvider.Serializer/ This is not an independent package; you still use your current JsonProvider.

This will provide utilities to use the fast System.Text.Json library to serialize the FSharp.Data.JsonProvider items.

• FSharp.Data: https://fsprojects.github.io/FSharp.Data/
• System.Text.Json: https://www.nuget.org/packages/System.Text.Json

Motivation: Serialization speed. Typically, JSON Serialization is used either so that the user is watching a progress-bar, or in a big batch-process.

Current FSharp.Data is using a custom Json-serializer.

We need a compromise having the convenience of F# JsonProvider, but the speed of System.Text.Json.

The idea is to be in-replacement for current functions:

Reading values to type provider (Deserialization)

Current FSharp.Data.JsonProvider:

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

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

Using this library:

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

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

Saving values from type provider (Serialization)

Current FSharp.Data.JsonProvider:

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

let toJson mymodel = mymodel.JsonValue.ToString()

Using this library:

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

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

Besides this, you can continue using your existing JsonProvider implementation as is. Currently, it uses System.Text.Json style of encoding the quote characters, etc. but if you want to customize your serialization more, you can set JsonReaderOptions and JsonWriterOptions as parameters.

Initial Benchmarks

FSharp.Data 6.3, System.Text.Json 8.0

Test-case:

• Read JSON to JsonProvider. (Serialization)
• Verify a property
• Save JSON back to a string. (Deserialization)

Tested with small JSON file, and with Stripe OpenAPI spec file (+5MB of JSON).

BenchmarkDotNet v0.13.10, Windows 11 (10.0.22621.2715/22H2/2022Update/SunValley2) 13th Gen Intel Core i9-13900H, 1 CPU, 20 logical and 14 physical cores

.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

To run the test: dotnet run --project tests\Benchmarks\BenchmarkTests.fsproj --configuration=Release --framework=net8.0

API

FSharp.Data uses internally class called FSharp.Data.JsonValue to model the JSON domain.

From JSON to JsonProvider

• Deserialize: string to FSharp.Data.JsonValue
• DeserializeWith: string and System.Text.Json.JsonReaderOptions to FSharp.Data.JsonValue
• DeserializeBytes: byte array to FSharp.Data.JsonValue
• DeserializeBytesWith: byte array and System.Text.Json.JsonReaderOptions to FSharp.Data.JsonValue

From JsonProvider to JSON

• Serialize: FSharp.Data.JsonValue to string
• SerializeWith: FSharp.Data.JsonValue and System.Text.Json.JsonWriterOptions to string
• SerializeBytes: FSharp.Data.JsonValue to byte array
• SerializeBytesWith: FSharp.Data.JsonValue and System.Text.Json.JsonWriterOptions to byte array

From JsonProvider to JSON, Streaming

With streaming support, you can send JSON-data to output stream record-per-record.

• SerializeStream: destination stream, FSharp.Data.JsonValue
• SerializeStreamWith: destination stream, FSharp.Data.JsonValue and System.Text.Json.JsonWriterOptions

Streaming may maintain the same performance characteristics but reduce memory allocation a bit and provide partially consumable results faster if the JSON is large and the client supports streaming.

.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