Circular reference detected exception while serializing object to JSON

by

Option 1 (recommended)

Try turning off Proxy object creation on your DbContext.

DbContext.Configuration.ProxyCreationEnabled = false;

Typically this scenario is because the application is using POCO objects (Either T4 Generated or Code-First). The problem arises when Entity Framework wants to track changes in your object which is not built into POCO objects. To resolve this, EF creates proxy objects which lack the attributes in the POCO objects, and aren’t serializable.

The reasons why I recommend this approach; using a website means that you probably don’t need change tracking (stateful) on Entity Framework objects, it free’s up memory and cpu because change tracking is disabled and it will work consistantly on all your objects the same way.

Option 2

Use a serializer (like JSON.Net which is already included in ASP.Net 4) that allows customization to serialize the object(s).

The reasons I do not recommend this approach is that eventually custom object serialization logic will be need to serial proxy objects as other objects types. This means you have a dependency on logic to deliver a result downstream. Changing the object means changing logic, and in an ASP.Net MVC project (any version) instead of only changing a View you have some thing else to change that is not readily known outside of whoever wrote the logic first.

Option 3 (Entity Framework 5.x +)

Use .AsNoTracking() which will disable the proxy objects on the specific query. If you need to use change tracking, this allows a nice intermediate solution to solution #1.

More Related Contents:

  1. EF 4.1 – Code First – JSON Circular Reference Serialization Error
  2. JSON.NET Error Self referencing loop detected for type
  3. Cannot deserialize the JSON array (e.g. [1,2,3]) into type ‘ ‘ because type requires JSON object (e.g. {“name”:”value”}) to deserialize correctly
  4. Getting ServiceStack to retain type information
  5. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  6. Json.net serialize/deserialize derived types?
  7. How to ignore JsonProperty(PropertyName = “someName”) when serializing json?
  8. Json.Net: Serialize/Deserialize property as a value, not as an object
  9. How to serialize/deserialize a custom collection with additional properties using Json.Net
  10. Deserializing JSON to abstract class
  11. Not ableTo Serialize Dictionary with Complex key using Json.net
  12. How to deserialize a JSON property that can be two different data types using Json.NET
  13. Custom Deserialization using Json.NET
  14. How can I serialize and deserialize a type with a string member that contains “raw” JSON, without escaping the JSON in the process
  15. No connection string named ‘MyEntities’ could be found in the application config file
  16. Force JSON.NET to include milliseconds when serializing DateTime (even if ms component is zero)
  17. Proper JSON serialization in MVC 4
  18. How to use default serialization in a custom System.Text.Json JsonConverter?
  19. C# automatic property deserialization of JSON
  20. Enable Migrations with Context in Separate Assembly?
  21. How to generate and auto increment Id with Entity Framework
  22. Ignoring a field during .NET JSON serialization; similar to [XmlIgnore]?
  23. Serializing an interface/abstract object using NewtonSoft.JSON
  24. object to deserialize has a C# keyword
  25. Json.NET: Deserializing nested dictionaries
  26. JSonNet boolean serialization
  27. JSONResult to String
  28. Serializing dictionaries with JavaScriptSerializer
  29. How to globally set default options for System.Text.Json.JsonSerializer?
  30. NewtonSoft.Json Serialize and Deserialize class with property of type IEnumerable

Leave a Comment