Serialize as NDJSON using Json.NET

by

As Json.NET does not currently have a built-in method to serialize a collection to NDJSON, the simplest answer would be to write to a single TextWriter using a separate JsonTextWriter for each line, setting CloseOutput = false for each:

public static partial class JsonExtensions
{
    public static void ToNewlineDelimitedJson<T>(Stream stream, IEnumerable<T> items)
    {
        // Let caller dispose the underlying stream 
        using (var textWriter = new StreamWriter(stream, new UTF8Encoding(false, true), 1024, true))
        {
            ToNewlineDelimitedJson(textWriter, items);
        }
    }

    public static void ToNewlineDelimitedJson<T>(TextWriter textWriter, IEnumerable<T> items)
    {
        var serializer = JsonSerializer.CreateDefault();

        foreach (var item in items)
        {
            // Formatting.None is the default; I set it here for clarity.
            using (var writer = new JsonTextWriter(textWriter) { Formatting = Formatting.None, CloseOutput = false })
            {
                serializer.Serialize(writer, item);
            }
            // https://web.archive.org/web/20180513150745/http://specs.okfnlabs.org/ndjson/
            // Each JSON text MUST conform to the [RFC7159] standard and MUST be written to the stream followed by the newline character \n (0x0A). 
            // The newline charater MAY be preceeded by a carriage return \r (0x0D). The JSON texts MUST NOT contain newlines or carriage returns.
            textWriter.Write("\n");
        }
    }
}

Sample fiddle.

Since the individual NDJSON lines are likely to be short but the number of lines might be large, this answer suggests a streaming solution to avoid the necessity of allocating a single string larger than 85kb. As explained in Newtonsoft Json.NET Performance Tips, such large strings end up on the large object heap and may subsequently degrade application performance.

More Related Contents:

  1. Cannot deserialize the JSON array (e.g. [1,2,3]) into type ‘ ‘ because type requires JSON object (e.g. {“name”:”value”}) to deserialize correctly
  2. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  3. Json.net serialize/deserialize derived types?
  4. How can I deserialize a child object with dynamic (numeric) key names?
  5. Deserializing JSON when sometimes array and sometimes object
  6. Cannot deserialize the current JSON object (e.g. {“name”:”value”}) into type ‘System.Collections.Generic.List`1
  7. How to ignore JsonProperty(PropertyName = “someName”) when serializing json?
  8. Deserializing JSON when key values are unknown
  9. Deserializing dates with dd/MM/yyyy format using Json.Net
  10. Deserializing JSON with unknown object names
  11. How to convert datatable to json string using json.net?
  12. How do I convert an escaped JSON string within a JSON object?
  13. JToken: Get raw/original JSON value
  14. JContainer, JObject, JToken and Linq confusion
  15. How to convert Json array to list of objects in c#
  16. Custom json serialization for each item in IEnumerable [duplicate]
  17. How do I get a deeply-nested property from JSON string?
  18. JSON.net (de)serialize untyped property
  19. How to apply a general rule for remapping all property names when serializing with Json.NET?
  20. How to return JSon object
  21. Is there a way to ignore get-only properties in Json.NET without using JsonIgnore attributes?
  22. Serializing an interface/abstract object using NewtonSoft.JSON
  23. Best ways to split a string with matching curly braces
  24. JSonNet boolean serialization
  25. How do C# classes deal with dollar signs in JSON?
  26. How to convert c# generic list to json using json.net?
  27. JSON Deserialization – String Is Automatically Converted To Int
  28. Json.net rename properties
  29. Newtonsoft JSON for .net is ignoring jsonproperty tags
  30. How to convert JSON to XML or XML to JSON in C#?

Leave a Comment