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モデルを返すことができます

そのような単純な！

正しい答えを与えることは1つの方法ですが、1つの構成設定で修正できる場合はやりすぎです。

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です。これにより、デフォルトではXMLではなくjsonが返され、発生したエラーも防止されます。Global.asax削除XmlFormatterなどを編集する必要はありません。

'ObjectContent`1タイプは、コンテンツタイプ' application / xml 'の応答本文のシリアル化に失敗しました。charset = 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として使用する2つの方法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の結果を取得するのに十分です（たとえば、フィドラーから）。

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>

基本的には1行追加します

• 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内でシリアライザフォーマッタを定義する必要があります

config.Formatters.Remove（config.Formatters.XmlFormatter）;を追加します。// JSON形式でデータを提供します

config.Formatters.Remove（config.Formatters.JsonFormatter）;を追加します。//データをXML形式で提供します

global.asaxに次の行を追加するだけです。

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

インポート

using System.Data.Entity;

このエラーを受け取ったもう1つのケースは、データベースクエリがnull値を返したが、ユーザー/ビューモデルタイプがnull不可に設定された場合です。たとえば、UserModelフィールドintをint?resolvedに変更します。

これは、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を使用している場合、または既知のタイプのリストに静的に認識されていないタイプを追加する場合は、DatantractResolverの使用を検討してください。たとえば、KnownTypeAttribute属性を使用するか、シリアライザに渡される既知のタイプのリストに追加します。

追加して解決した方法KnownType。

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

これは、この回答に触発されて解決されました。

リファレンス：https : //msdn.microsoft.com/en-us/library/ms730167(v=vs.100).aspx

Visual Studio のデフォルトの形式は " XmlFormat"（config.Formatters.XmlFormatter）であるのに対し、Visual Studio自体は出力をjson形式にする必要があるため、Visual Studio 2017または2019はこれについてはまったく考えられません。

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出力を生成できます。

私の場合、データベースの再作成を解決しました。モデルに変更を加え、パッケージマネージャーコンソールで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;

それが役に立てば幸いです。

私の場合、ナビゲーションプロパティの前に仮想キーワードを削除したときに修正されました。つまり、参照テーブルです。だから私は変わった

public virtual MembershipType MembershipType { get; set; }

に：

public MembershipType MembershipType { get; set; }