Getting ServiceStack to retain type information

by

Inheritance in DTOs is a bad idea – DTO’s should be as self-describing as possible and by using inheritance clients effectively have no idea what the service ultimately returns. Which is why your DTO classes will fail to de/serialize properly in most ‘standards-based’ serializers.

There’s no good reason for having interfaces in DTO’s (and very few reasons to have them on POCO models), it’s a cargo cult habit of using interfaces to reduce coupling in application code that’s being thoughtlessly leaked into DTOs. But across process boundaries, interfaces only adds coupling (it’s only reduced in code) since the consumer has no idea what concrete type to deserialize into so it has to emit serialization-specific implementation hints that now embeds C# concerns on the wire (so now even C# namespaces will break serialization) and now constrains your response to be used by a particular serializer. Leaking C# concerns on the wire violates one of the core goal of services for enabling interoperability.

As there is no concept of ‘type info’ in the JSON spec, in order for inheritance to work in JSON Serializers they need to emit proprietary extensions to the JSON wireformat to include this type info – which now couples your JSON payload to a specific JSON serializer implementation.

ServiceStack’s JsonSerializer stores this type info in the __type property and since it can considerably bloat the payload, will only emit this type information for types that need it, i.e. Interfaces, late-bound object types or abstract classes.

With that said the solution would be to change Animal to either be an Interface or an abstract class, the recommendation however is not to use inheritance in DTOs.

More Related Contents:

  1. Deserialize JSON into C# dynamic object?
  2. How do I turn a C# object into a JSON string in .NET?
  3. How to deserialize an array of values with a fixed schema to a strongly typed data class?
  4. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  5. How to serialize/deserialize a custom collection with additional properties using Json.Net
  6. Custom Deserialization using Json.NET
  7. C# automatic property deserialization of JSON
  8. Cannot deserialize JSON array into type – Json.NET
  9. How to apply indenting serialization only to some properties?
  10. Ignoring a field during .NET JSON serialization; similar to [XmlIgnore]?
  11. Ignoring null fields in Json.net
  12. Can JavaScriptSerializer exclude properties with null/default values?
  13. How to serialize or deserialize a JSON Object to a certain depth in C#?
  14. Deserializing JSON into an object with Json.NET
  15. Remove empty string properties from json serialized object
  16. How to Convert JSON object to Custom C# object?
  17. Does Json.NET cache types’ serialization information?
  18. JavaScriptSerializer.Deserialize – how to change field names
  19. Serializing private member data
  20. dotnet core System.Text.Json unescape unicode string
  21. How to deserialize a JSON property that can be two different data types using Json.NET
  22. Json.NET custom serialization with JsonConverter – how to get the “default” behavior
  23. Error Deserializing Xml to Object – xmlns=” was not expected
  24. DataTable to JSON [duplicate]
  25. Is DataContract attributes required for WCF
  26. Convert DataTable to JSON with key per row
  27. Why are all the collections in my POCO are null when deserializing some valid json with the .NET Newtonsoft.Json component
  28. Deserialize specific enum into system.enum in Json.Net
  29. How do I get formatted and indented JSON in .NET using C#?
  30. Parsing field name with a colon in JSON

Leave a Comment