WebApi 2中EF 6实体Json序列化异常的解决方案咨询

你遇到的问题本质是EF的动态代理类和Json序列化器之间的兼容性问题——EF为了实现延迟加载会生成实体的动态代理子类，默认的Json序列化器（即使是Json.NET）有时候无法正确解析这些代理类的属性，导致只返回了Id这类主键字段。下面给你几个可行的解决方案，按推荐程度排序：

1. 最推荐：使用DTO（数据传输对象） #

这是业界公认的最佳实践，既避免了序列化问题，也能控制返回给调用方的数据结构（不会暴露数据库层面的关联或冗余属性），对其他开发者也更友好。

步骤： #

• 创建与EF实体对应的DTO类，只包含需要对外暴露的属性：

  public class ProductDto
  {
      public int Id { get; set; }
      public string Name { get; set; }
      public decimal Price { get; set; }
      // 只添加你需要返回的字段，不需要包含EF的导航属性（除非你明确要返回关联数据）
  }
  

• 用映射工具（比如AutoMapper）或者手动把EF实体转换成DTO：
  先配置AutoMapper（在WebApiConfig.cs或者专门的映射配置类里）：

  Mapper.Initialize(cfg =>
  {
      cfg.CreateMap<Product, ProductDto>();
      // 如果你有多个实体，依次添加映射规则
  });
  

  然后在WebApi方法中使用：

  public IHttpActionResult GetProducts()
  {
      using (var db = new YourDbContext())
      {
          var products = db.Products.ToList();
          var productDtos = Mapper.Map<List<ProductDto>>(products);
          return Ok(productDtos);
      }
  }
  

2. 关闭EF的动态代理和延迟加载 #

如果暂时不想用DTO，可以直接关闭EF的动态代理生成，让实体以纯POCO的形式被序列化：

在你的DbContext构造函数中添加以下配置：

public class YourDbContext : DbContext
{
    public YourDbContext() : base("YourConnectionString")
    {
        // 关闭动态代理生成
        this.Configuration.ProxyCreationEnabled = false;
        // 关闭延迟加载（避免序列化时触发未加载的导航属性导致循环引用）
        this.Configuration.LazyLoadingEnabled = false;
    }

    // DbSet定义...
}

然后再配合你之前的JsonFormatter配置：

public static void Register(HttpConfiguration config)
{
    // 移除XML格式化器
    config.Formatters.Remove(config.Formatters.XmlFormatter);
    
    var jsonFormatter = config.Formatters.JsonFormatter;
    jsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
    jsonFormatter.SerializerSettings.ContractResolver = new Newtonsoft.Json.Serialization.DefaultContractResolver();
}

这样序列化器就能正确识别实体的所有属性了。

3. 配置Json.NET正确处理EF代理类 #

如果需要保留延迟加载（比如某些场景需要返回关联数据），可以让Json.NET忽略代理类的额外属性，同时正确解析实体的原始属性：

修改WebApiConfig.cs的配置：

public static void Register(HttpConfiguration config)
{
    config.Formatters.Remove(config.Formatters.XmlFormatter);
    
    var jsonFormatter = config.Formatters.JsonFormatter;
    jsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
    // 告诉Json.NET使用实体的原始类型而不是代理类型
    jsonFormatter.SerializerSettings.ContractResolver = new Newtonsoft.Json.Serialization.DefaultContractResolver
    {
        IgnoreSerializableAttribute = true,
        IgnoreSerializableInterface = true
    };
    // 可选：如果需要保留对象引用（避免循环引用的另一种方式）
    jsonFormatter.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.Objects;
}

另外，对于数据库优先生成的实体类，你可以通过部分类添加Json.NET特性，帮助序列化器识别：
比如你的实体是Product，新建一个同名的部分类文件：

[JsonObject(IsReference = true)]
public partial class Product
{
    // 不需要添加任何额外代码，仅用于标记特性
}

为什么之前的配置没生效？ #

你之前的代码可能因为EF动态代理的存在，导致Json.NET只序列化了代理类中暴露的主键属性。关闭代理或者配置ContractResolver让Json.NET解析原始实体类型，就能解决这个问题。

内容的提问来源于stack exchange，提问作者RezaNoei