无法使用Json序列化Web API中的响应

我正在使用ASP.NET MVC 5 Web Api。我想咨询所有用户。

我写了api/users，我收到了：

“'ObjectContent`1'类型未能序列化内容类型'application / json; charset = utf-8'的响应主体”

在WebApiConfig中，我已经添加了以下几行：

HttpConfiguration config = new HttpConfiguration();
config.Formatters.XmlFormatter.SupportedMediaTypes.Remove(appXmlType);
config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore; 

但这仍然行不通。

我的返回数据函数是这样的：

public IEnumerable<User> GetAll()
{
    using (Database db = new Database())
    {
        return db.Users.ToList();
    }
}

当涉及从Web Api（或其他任何Web服务）将数据返回给使用者时，我强烈建议不要回传来自数据库的实体。使用模型，您可以控制数据的外观而不是数据库，这是更加可靠和可维护的。这样，您就不必在WebApiConfig中花太多时间去处理格式化程序了。您可以只创建一个具有子模型作为属性的UserModel，并摆脱返回对象中的引用循环。这使串行器更加快乐。

另外，如果仅在请求中指定“ Accepts”标头，则通常不必删除格式化程序或受支持的媒体类型。玩弄这些东西有时会使事情变得更加混乱。

例：

public class UserModel {
    public string Name {get;set;}
    public string Age {get;set;}
    // Other properties here that do not reference another UserModel class.
}

如果您使用的是EF，除了在Global.asax上添加以下代码外

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings
    .ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
GlobalConfiguration.Configuration.Formatters
    .Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);          

不要忘记导入

using System.Data.Entity;

然后，您可以返回自己的EF模型

就那么简单！

给出正确的答案是一种解决方法，但是如果您可以通过一个配置设置来解决它，那就太过分了。

最好在dbcontext构造函数中使用它

public DbContext() // dbcontext constructor
            : base("name=ConnectionStringNameFromWebConfig")
{
     this.Configuration.LazyLoadingEnabled = false;
     this.Configuration.ProxyCreationEnabled = false;
}

Asp.Net Web API错误：“ ObjectContent`1”类型未能序列化内容类型“ application / xml”的响应主体；charset = utf-8'

将此代码添加到global.asax以下位置Application_Start：

从更新.Ignore到.Serialize。它必须工作。

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Serialize;
            GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);

public class UserController : ApiController
{

   Database db = new Database();

   // construction
   public UserController()
   {
      // Add the following code
      // problem will be solved
      db.Configuration.ProxyCreationEnabled = false;
   }

   public IEnumerable<User> GetAll()
    {
            return db.Users.ToList();
    }
}

我不喜欢此代码：

foreach(var user in db.Users)

另一种选择是，可以执行以下操作，这对我有用：

var listOfUsers = db.Users.Select(r => new UserModel
                         {
                             userModel.FirstName = r.FirstName;
                             userModel.LastName = r.LastName;

                         });

return listOfUsers.ToList();

但是，我最终使用了Lucas Roselli的解决方案。

更新：通过返回匿名对象进行简化：

var listOfUsers = db.Users.Select(r => new 
                         {
                             FirstName = r.FirstName;
                             LastName = r.LastName;
                         });

return listOfUsers.ToList();

我使用此代码将其解析为WebApiConfig.cs文件

var json = config.Formatters.JsonFormatter;
json.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.Objects; 
config.Formatters.Remove(config.Formatters.XmlFormatter);

还有这种情况会产生相同的错误：

如果返回的是List<dynamic>Web API方法

例：

public HttpResponseMessage Get()
{
    var item = new List<dynamic> { new TestClass { Name = "Ale", Age = 30 } };

    return Request.CreateResponse(HttpStatusCode.OK, item);
}

public class TestClass
{
    public string Name { get; set; }
    public int Age { get; set; }
}

因此，对于这种情况，请在返回类（全部）中使用[KnownTypeAttribute]，如下所示：

[KnownTypeAttribute(typeof(TestClass))]
public class TestClass
{
    public string Name { get; set; }
    public int Age { get; set; }
}

这对我有用！

将其添加到您Application_Start()的Global.asax文件方法中应该可以解决问题

protected void Application_Start()
{
    GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings
        .ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
    GlobalConfiguration.Configuration.Formatters
        .Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter); 
// ...
}

方法2：[不推荐]
如果使用EntityFramework，则可以在DbContext类构造函数中禁用代理。注意：如果您更新模型，此代码将被删除

public class MyDbContext : DbContext
{
  public MyDbContext()
  {
    this.Configuration.ProxyCreationEnabled = false;
  }
}

我个人最喜欢的：只需将以下代码添加到中App_Start/WebApiConfig.cs。默认情况下，这将返回json而不是XML，还可以防止出现错误。无需编辑Global.asax删除XmlFormatter等。

“ ObjectContent`1”类型未能序列化内容类型“ application / xml”的响应主体；字符集= utf-8

config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));

使用AutoMapper ...

public IEnumerable<User> GetAll()
    {
        using (Database db = new Database())
        {
            var users = AutoMapper.Mapper.DynamicMap<List<User>>(db.Users);
            return users;
        }
    }

使用以下名称空间：

using System.Web.OData;

代替 ：

using System.Web.Http.OData;

对我有用

添加以下行

this.Configuration.ProxyCreationEnabled = false;

两种使用ProxyCreationEnabled方式false。

1. 将其添加到DBContext构造函数中

   public ProductEntities() : base("name=ProductEntities")
   {
       this.Configuration.ProxyCreationEnabled = false;
   }

要么

2. 在Get方法内部添加行

   public IEnumerable<Brand_Details> Get()
   {
       using (ProductEntities obj = new ProductEntities())
       {
           this.Configuration.ProxyCreationEnabled = false;
           return obj.Brand_Details.ToList();
       }
   }

对我有用的解决方案：

1. 使用[DataContract]类和[DataMember]属性，每个属性序列化。这足以获得Json结果（例如，来自fiddler）。

2. 要获得xml序列化，请编写Global.asax以下代码：

   var xml = GlobalConfiguration.Configuration.Formatters.XmlFormatter; xml.UseXmlSerializer = true;

3. 阅读本文，它有助于我理解序列化：https : //www.asp.net/web-api/overview/formats-and-model-binding/json-and-xml-serialization

要添加到jensendp的答案中：

我会将实体传递给用户创建的模型，并使用该实体中的值来设置新创建的模型中的值。例如：

public class UserInformation {
   public string Name { get; set; }
   public int Age { get; set; }

   public UserInformation(UserEntity user) {
      this.Name = user.name;
      this.Age = user.age;
   }
}

然后将您的退货类型更改为： IEnumerable<UserInformation>

我基本上添加一行

• Entity.Configuration.ProxyCreationEnabled = false;

到UsersController.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
using UserDataAccess;

namespace SBPMS.Controllers
{
    public class UsersController : ApiController
    {


        public IEnumerable<User> Get() {
            using (SBPMSystemEntities entities = new SBPMSystemEntities()) {
                entities.Configuration.ProxyCreationEnabled = false;
                return entities.Users.ToList();
            }
        }
        public User Get(int id) {
            using (SBPMSystemEntities entities = new SBPMSystemEntities()) {
                entities.Configuration.ProxyCreationEnabled = false;
                return entities.Users.FirstOrDefault(e => e.user_ID == id);
            }
        }
    }
}

使用[Serializable]上课：

例：

[Serializable]
public class UserModel {
    public string Name {get;set;}
    public string Age {get;set;}
}

它为我工作！

您将必须在App_Start文件夹中可用的WebApiConfig.cs中定义Serializer Formatter，例如

添加config.Formatters.Remove（config.Formatters.XmlFormatter）; //将为您提供JSON格式的数据

添加config.Formatters.Remove（config.Formatters.JsonFormatter）; //这将为您提供XML格式的数据

我收到此错误的另一种情况是，当数据库查询返回空值，但我的用户/视图模型类型设置为不可为空时。例如，将我的UserModel字段从更改int为int?。

当Response-Type不是公开的时，也会发生这种情况！当我使用Visual Studio生成类型时，我返回了一个内部类。

internal class --> public class

尽管以上所有答案都是正确的，但您可能需要检查InnerException> ExceptionMessage。

如果它说这样的话：“ ObjectContext实例已被处置，不能再用于需要连接的操作。 ”。由于EF的默认行为，这可能是一个问题。

通过在DbContext构造函数中分配LazyLoadingEnabled = false可以解决问题。

public class MyDbContext : DbContext
{
  public MyDbContext()
  {
    this.Configuration.LazyLoadingEnabled = false;
  }
}

有关EF的EagerLoading和LazyLoading行为的详细阅读，请参阅此MSDN文章。

就我而言，我有类似的错误消息：

“ ObjectContent`1”类型未能序列化内容类型“ application / xml”的响应主体；charset = utf-8'。

但是，当我深入研究时，问题是：

键入“ name.SomeSubRootType”和数据协定名称为“ SomeSubRootType：//schemas.datacontract.org/2004/07/WhatEverService”是不正确的。如果您正在使用DataContractSerializer或将任何不是静态已知的类型添加到已知类型的列表中，请考虑使用DataContractResolver-例如，通过使用KnownTypeAttribute属性或将它们添加到传递给序列化程序的已知类型的列表中。

我通过添加解决的方式KnownType。

[KnownType(typeof(SomeSubRootType))]
public partial class SomeRootStructureType

这个答案启发了这个问题。

参考：https : //msdn.microsoft.com/zh-cn/library/ms730167(v=vs.100).aspx

Visual Studio 2017或2019对此完全没有考虑，因为Visual Studio本身要求输出为json格式，而Visual Studio的默认格式为“ XmlFormat”（config.Formatters.XmlFormatter）。

Visual Studio应该自动执行此操作，而不是给开发人员带来太多麻烦。

若要更正此问题，请转到WebApiConfig.cs文件，然后添加

var json = config.Formatters.JsonFormatter; json.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.Objects; config.Formatters.Remove（config.Formatters.XmlFormatter）;

在Register（HttpConfiguration config）方法中的“ config.MapHttpAttributeRoutes（）; ”之后。这将使您的项目产生json输出。

就我而言，我解决了重新创建数据库的问题。我对模型进行了一些更改，并在Package Manager控制台中启动Update-Database，但出现以下错误：

“ ALTER TABLE语句与FOREIGN KEY约束“ FK_dbo.Activities_dbo.Projects_ProjectId”发生冲突。该冲突发生在数据库“ TrackEmAllContext-20190530144302”的表“ dbo.Projects”的“ Id”列中。”

如果发生以下情况：如果向WebApiConfig.cs或Global.asax.cs添加代码对您不起作用：

.ToList();

添加.ToList（）函数。

我尝试了所有解决方案，但以下方法为我工作：

var allShops = context.shops.Where(s => s.city_id == id)**.ToList()**;
return allShops;

希望对您有所帮助。

就我而言，它是在导航属性之前删除virtual关键字（即参考表）时修复的。所以我改变了

public virtual MembershipType MembershipType { get; set; }

至：

public MembershipType MembershipType { get; set; }

只需在global.asax中添加以下几行：

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;  
GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);

进口

using System.Data.Entity;