JSON Serializer object with internal properties

by

Mark the internal properties to be serialized with the [JsonProperty] attribute:

public class Foo
{
    [JsonProperty]
    internal int num1 { get; set; }
    [JsonProperty]
    internal double num2 { get; set; }

    public string Description { get; set; }

    public override string ToString()
    {
        if (!string.IsNullOrEmpty(Description))
            return Description;

        return base.ToString();
    }
}

And then later, to test:

Foo f = new Foo();
f.Description = "Foo Example";
f.num1 = 101;
f.num2 = 202;
JsonSerializerSettings settings = new JsonSerializerSettings() { TypeNameHandling = TypeNameHandling.All };

var jsonOutput = JsonConvert.SerializeObject(f, Formatting.Indented, settings);

Console.WriteLine(jsonOutput);

I get the following output:

{
  "$type": "Tile.JsonInternalPropertySerialization.Foo, Tile",
  "num1": 101,
  "num2": 202.0,
  "Description": "Foo Example"
}

(Where “Tile.JsonInternalPropertySerialization” and “Tile” are namespace and assembly names I am using).

As an aside, when using TypeNameHandling, do take note of this caution from the Newtonsoft docs:

TypeNameHandling should be used with caution when your application deserializes JSON from an external source. Incoming types should be validated with a custom SerializationBinder when deserializing with a value other than None.

For a discussion of why this may be necessary, see TypeNameHandling caution in Newtonsoft Json and and External json vulnerable because of Json.Net TypeNameHandling auto?.

More Related Contents:

  1. How do I turn a C# object into a JSON string in .NET?
  2. How to deserialize an array of values with a fixed schema to a strongly typed data class?
  3. Getting ServiceStack to retain type information
  4. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  5. How do I get formatted JSON in .NET using C#?
  6. Casting interfaces for deserialization in JSON.NET
  7. A circular reference was detected while serializing an object of type ‘SubSonic.Schema .DatabaseColumn’.
  8. dotnet core System.Text.Json unescape unicode string
  9. Json.NET serialize object with root name
  10. Custom Deserialization using Json.NET
  11. How to turn off or handle camelCasing in JSON response ASP.NET Core?
  12. how to convert NameValueCollection to JSON string?
  13. C# automatic property deserialization of JSON
  14. Send JSON via POST in C# and Receive the JSON returned?
  15. Can I LINQ a JSON?
  16. Cannot deserialize JSON array into type – Json.NET
  17. How to apply indenting serialization only to some properties?
  18. Ignoring a field during .NET JSON serialization; similar to [XmlIgnore]?
  19. What is the simplest C# function to parse a JSON string into an object? [closed]
  20. Deserialize json in a “TryParse” way
  21. Deserialize json object with dynamic items in C#
  22. How can I merge two JObject? [duplicate]
  23. Can JavaScriptSerializer exclude properties with null/default values?
  24. How do I get formatted and indented JSON in .NET using C#?
  25. How to serialize or deserialize a JSON Object to a certain depth in C#?
  26. How do I transform appsettings.json in a .NET Core MVC project?
  27. Deserializing JSON into an object with Json.NET
  28. Remove empty string properties from json serialized object
  29. Client configuration to consume WCF JSON web service
  30. Parsing field name with a colon in JSON

Leave a Comment