Efficiently get full json string in JsonConverter.ReadJson()

by

ReadJson() must fully parse the JSON being read so that the JSON is confirmed to be well-formed and the JsonReader is correctly positioned at the end of the current value upon exit. However, it is not necessary to load the entire JSON into an intermediate JObject hierarchy simply to re-convert it to a JSON string. Instead, you may be able to get better performance by using JRaw.Create():

var json = JRaw.Create(reader).ToString();

As can be seen in the reference source, this method streams directly from the incoming JsonReader to a StringWriter – without loading into an intermediate JToken hierarchy and re-serializing – by using JsonWriter.WriteToken(JsonReader):

public static JRaw Create(JsonReader reader)
{
    using (StringWriter sw = new StringWriter(CultureInfo.InvariantCulture))
    using (JsonTextWriter jsonWriter = new JsonTextWriter(sw))
    {
        jsonWriter.WriteToken(reader);

        return new JRaw(sw.ToString());
    }
}

The resulting JRaw simply encapsulates that string in its Value. (Of course, there is no guarantee that the resulting JSON represents an object, only that it represents well-formed JSON.)

Note that JsonTextReader will automatically recognize and parse dates and times in common formats as DateTime objects, and also parse floating point values as double. If you need the “most literal” JSON string you may want to suppress DateTime recognition and/or parse floating point values as decimal. The following extension method, modeled on JRaw.Create(), does the job:

public static string ReadOuterJson(this JsonReader reader, Formatting formatting = Formatting.None, DateParseHandling? dateParseHandling = null, FloatParseHandling? floatParseHandling = null)
{
    // If you would prefer a null JSON value to return an empty string, remove this line:
    if (reader.TokenType == JsonToken.Null)
        return null;
    var oldDateParseHandling = reader.DateParseHandling;
    var oldFloatParseHandling = reader.FloatParseHandling;
    try
    {
        if (dateParseHandling != null)
            reader.DateParseHandling = dateParseHandling.Value;
        if (floatParseHandling != null)
            reader.FloatParseHandling = floatParseHandling.Value;
        using (var sw = new StringWriter(CultureInfo.InvariantCulture))
        using (var jsonWriter = new JsonTextWriter(sw) { Formatting = formatting })
        {
            jsonWriter.WriteToken(reader);
            return sw.ToString();
        }
    }
    finally
    {
        reader.DateParseHandling = oldDateParseHandling;
        reader.FloatParseHandling = oldFloatParseHandling;
    }
}

And then call it like, e.g.:

var json = reader.ReadOuterJson(dateParseHandling: DateParseHandling.None);

For details on why this may be necessary, see:

More Related Contents:

  1. How can I change property names when serializing with Json.net?
  2. Deserializing JSON data to C# using JSON.NET
  3. Parsing JSON using Json.net
  4. Can I specify a path in an attribute to map a property in my class to a child property in my JSON?
  5. How do I get json.net to serialize members of a class deriving from List?
  6. How can I ignore unknown enum values during json deserialization?
  7. “Self Referencing Loop Detected” exception with JSON.Net
  8. How to use class fields with System.Text.Json.JsonSerializer?
  9. Deserialize json array stream one item at a time
  10. How to Deserialize JSON data?
  11. How do I enumerate through a JObject?
  12. How to make JSON.Net serializer to call ToString() when serializing a particular type?
  13. C# JSON.NET convention that follows Ruby property naming conventions?
  14. JSON.net serialize directly from oledbconnection
  15. multiple JsonProperty Name assigned to single property
  16. json.net: specify converter for dictionary keys
  17. JsonValueProviderFactory throws “request too large”
  18. JSON deserialization – Map array indices to properties with JSON.NET
  19. Using JSON.net, how do I prevent serializing properties of a derived class, when used in a base class context?
  20. Json.NET serialize by depth and attribute
  21. JSON.NET cast error when serializing Mongo ObjectId
  22. JsonConvert.Deserializer indexing issues
  23. Checking for empty or null JToken in a JObject
  24. System.Text.Json: Deserialize JSON with automatic casting
  25. Deserialize json that has some property name starting with a number
  26. json net leading zeros (disable base-cast)
  27. How to deserialize a property with a dash (“-”) in its name with NewtonSoft JsonConvert?
  28. Web API: Configure JSON serializer settings on action or controller level
  29. Serializing/Deserializing Dictionary of objects with JSON.NET
  30. SignalR Typenamehandling

Leave a Comment