CODEWITHSUNDEEP
c#json.net
Brian Reischl
Brian Reischl

Reputation: 7356

Is the Json.NET JsonSerializer threadsafe?

I'm trying to reduce the amount of garbage my web service generates, and I noticed that we're creating a new Json.NET JsonSerializer instance for each request. It is not the most lightweight object ever, so I'm wondering if I can just create a single instance and reuse it for all requests. Primarily this requires that it be threadsafe during serialization and deserialization.

The documentation doesn't say whether it's threadsafe or not.

Inspecting the code it appears that the serialization and deserialization methods are threadsafe, as long as you don't change any settings on the object at the same time. However, it's a complex class so I'm not 100% sure of my analysis.

Has anyone tried reusing instances of JsonSerializer and had it work or not? Are there any known problems with reusing it?

Upvotes: 48

Views: 14003

Answers (5)

user2291296
user2291296

Reputation: 354

No. It is not threadsafe. Even in 2024 and with version 13.0.3 it sometimes throws something like this:

Newtonsoft.Json.JsonSerializationException: Error writing object reference for 'maxkpd.app.api.DM.drParam'. Path 'result.Params[18]'. ---> System.ArgumentException: A different value already has the Id '83302'.

Corresponding issue: https://github.com/JamesNK/Newtonsoft.Json/issues/1452

Upvotes: 0

Todd Menier
Todd Menier

Reputation: 39289

I noticed that we're creating a new Json.NET JsonSerializer instance for each request. It is not the most lightweight object ever...

Maybe not "ever", but I suspect it's a very inexpensive object to create, because the library itself does this routinely, such as the static and oft-used JsonConvert.SerializeObject method, which is defined like this:

public static string SerializeObject(object value, Type type, JsonSerializerSettings settings)
{
    JsonSerializer jsonSerializer = JsonSerializer.CreateDefault(settings);

    return SerializeObjectInternal(value, type, jsonSerializer);
}

Given the maturity and popularity of the library, I suspect that if JsonSerializer was even a little expensive to create, some effort would have been made to cache them in these static methods. So although it's thread safe, I still think that unless it's the most extreme of circumstances you're going to be fine creating them on demand.

Upvotes: 1

TylerBrinkley
TylerBrinkley

Reputation: 1126

If you don't use references, JsonSerializer is thread-safe. There are however a few issues when using references in a multi-threaded context.

First, there is a bug in the default ReferenceResolver that may cause duplicate reference id's to be used. See the GitHub issue here.

Secondly, when reusing a JsonSerializer the default ReferenceResolver is stateful so that if you use references your reference ids will continue to increment with each serialization call you make instead of starting at 1 for each. I created a GitHub issue to address this problem here.

Upvotes: 8

James Newton-King
James Newton-King

Reputation: 49032

Inspecting the code it appears that the serialization and deserialization methods are threadsafe, as long as you don't change any settings on the object at the same time.

Correct, JsonSerializer is threadsafe.

No state is shared while serializing but if you change a setting on the JsonSerializer while in the middle of serializing an object then those will automatically be used.

Upvotes: 58

Joe Enos
Joe Enos

Reputation: 40383

According to the Feature Comparison on the Newtonsoft site, it is thread safe, as are DataContractJsonSerializer and JavaScriptSerializer.

enter image description here

Upvotes: 16

Related Questions