Gagal untuk membuat serial respon di Web API dengan Json

Saya bekerja dengan ASP.NET MVC 5 Web Api. Saya ingin berkonsultasi dengan semua pengguna saya.

Saya menulis api/usersdan saya menerima ini:

"Jenis 'ObjectContent`1' gagal membuat serial isi respons untuk jenis konten 'application / json; charset = utf-8'"

Di WebApiConfig, saya sudah menambahkan baris ini:

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

Tapi tetap tidak berhasil.

Fungsi saya untuk mengembalikan data adalah ini:

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

Ketika datang untuk mengembalikan data kembali ke konsumen dari Web Api (atau layanan web lainnya dalam hal ini), saya sangat menyarankan untuk tidak mengirimkan kembali entitas yang berasal dari database. Jauh lebih andal dan mudah dipelihara untuk menggunakan Model di mana Anda memiliki kendali atas seperti apa datanya dan bukan database. Dengan begitu, Anda tidak perlu terlalu banyak mengutak-atik pemformat di WebApiConfig. Anda bisa membuat UserModel yang memiliki Model turunan sebagai properti dan menyingkirkan loop referensi di objek yang dikembalikan. Itu membuat pembuat serial lebih bahagia.

Selain itu, tidak perlu menghapus pemformat atau jenis media yang didukung biasanya jika Anda hanya menentukan header "Menerima" dalam permintaan. Bermain-main dengan barang-barang itu terkadang bisa membuat segalanya lebih membingungkan.

Contoh:

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

Jika Anda bekerja dengan EF, selain menambahkan kode di bawah ini di Global.asax

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

Jangan lupa untuk mengimpor

using System.Data.Entity;

Kemudian Anda dapat mengembalikan Model EF Anda sendiri

Sederhana seperti itu!

Memberikan jawaban yang benar adalah salah satu cara untuk pergi, namun itu berlebihan ketika Anda dapat memperbaikinya dengan satu pengaturan konfigurasi.

Lebih baik menggunakannya di konstruktor dbcontext

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

Kesalahan API Web Asp.Net: Jenis 'ObjectContent`1' gagal untuk membuat serial tubuh tanggapan untuk jenis konten 'application / xml; charset = utf-8 '

Tambahkan kode ini di global.asaxbawah pada Application_Start:

Perbarui dari .Ignoremenjadi .Serialize. Ini harus berhasil.

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();
    }
}

Saya tidak suka kode ini:

foreach(var user in db.Users)

Sebagai alternatif, seseorang mungkin melakukan sesuatu seperti ini, yang berhasil untuk saya:

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

                         });

return listOfUsers.ToList();

Namun, saya akhirnya menggunakan solusi Lucas Roselli.

Pembaruan: Disederhanakan dengan mengembalikan objek anonim:

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

return listOfUsers.ToList();

Saya menyelesaikannya menggunakan kode ini ke file WebApiConfig.cs

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

Ada juga skenario ini yang menghasilkan kesalahan yang sama:

Dalam kasus pengembalian menjadi List<dynamic>metode api web

Contoh:

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; }
}

Jadi, untuk skenario ini gunakan [DiketahuiTipeAttribute] di kelas kembalian (semuanya) seperti ini:

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

Ini berhasil untuk saya!

Menambahkan ini ke Application_Start()metode Global.asaxfile Anda akan menyelesaikan masalah

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

METODE 2: [Tidak disarankan]
Jika Anda bekerja dengan EntityFramework, Anda dapat menonaktifkan proxy di konstruktor kelas DbContext Anda. CATATAN: kode ini akan dihapus jika Anda memperbarui model

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

Favorit pribadi saya: Cukup tambahkan kode di bawah ini ke App_Start/WebApiConfig.cs. Ini akan mengembalikan json sebagai ganti XML secara default dan juga mencegah kesalahan yang Anda alami. Tidak perlu mengedit Global.asaxuntuk menghapus XmlFormatterdll.

Jenis 'ObjectContent`1' gagal membuat serial tubuh respons untuk jenis konten 'application / xml; charset = utf-8

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

Gunakan AutoMapper ...

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

Gunakan namespace berikut:

using System.Web.OData;

Dari pada :

using System.Web.Http.OData;

Itu berhasil untuk saya

Tambahkan baris di bawah ini

this.Configuration.ProxyCreationEnabled = false;

Dua cara untuk digunakan ProxyCreationEnabledsebagai false.

1. Tambahkan ke dalam DBContextConstructor

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

ATAU

2. Tambahkan garis di dalam Getmetode

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

Solusi yang berhasil untuk saya:

1. Gunakan [DataContract]untuk kelas dan [DataMember]atribut untuk setiap properti yang akan dibuat serial. Ini cukup untuk mendapatkan hasil Json (misalnya dari fiddler).

2. Untuk mendapatkan serialisasi xml, tulis Global.asaxkode ini:

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

3. Baca artikel ini, ini membantu saya untuk memahami serialisasi: https://www.asp.net/web-api/overview/formats-and-model-binding/json-and-xml-serialization

Untuk menambah jawaban jensendp:

Saya akan meneruskan entitas ke model yang dibuat pengguna dan menggunakan nilai dari entitas itu untuk mengatur nilai dalam model yang baru Anda buat. Sebagai contoh:

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;
   }
}

Kemudian ubah jenis pengembalian Anda menjadi: IEnumerable<UserInformation>

Saya pada dasarnya menambahkan satu baris yang mana mereka

• entity.Configuration.ProxyCreationEnabled = false;

ke 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);
            }
        }
    }
}

Gunakan [Serializable] untuk kelas:

Contoh:

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

Itu berhasil untuk saya!

Anda harus menentukan Serializer Formatter dalam WebApiConfig.cs yang tersedia di App_Start Folder seperti

Menambahkan config.Formatters.Remove (config.Formatters.XmlFormatter); // yang akan memberi Anda data dalam Format JSON

Menambahkan config.Formatters.Remove (config.Formatters.JsonFormatter); // yang akan memberi Anda data dalam Format XML

Letakkan saja baris berikut di global.asax:

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

Impor

using System.Data.Entity;

Kasus lain di mana saya menerima kesalahan ini adalah ketika kueri database saya mengembalikan nilai nol tetapi jenis model pengguna / tampilan saya ditetapkan sebagai non-nullable. Misalnya, mengubah bidang UserModel saya dari intmenjadi int?terselesaikan.

Ini juga terjadi jika Jenis-Tanggapan tidak bersifat publik! Saya mengembalikan kelas internal ketika saya menggunakan Visual Studio untuk menghasilkan saya tipe.

internal class --> public class

Meskipun semua jawaban di atas benar, Anda mungkin perlu memeriksa InnerException> ExceptionMessage .

Jika tertulis sesuatu seperti ini " Instance ObjectContext telah dibuang dan tidak dapat lagi digunakan untuk operasi yang memerlukan koneksi. ". Ini bisa menjadi masalah karena perilaku default EF.

Dengan menetapkan LazyLoadingEnabled = false di konstruktor DbContext Anda akan melakukan triknya.

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

Untuk bacaan yang lebih detail tentang perilaku EagerLoading dan LazyLoading dari EF lihat Artikel MSDN ini .

Dalam kasus saya, saya memiliki pesan kesalahan serupa:

Jenis 'ObjectContent`1' gagal membuat serial tubuh respons untuk jenis konten 'application / xml; charset = utf-8 '.

Tetapi ketika saya menggali lebih dalam, masalahnya adalah:

Ketik 'name.SomeSubRootType' dengan nama kontrak data 'SomeSubRootType: //schemas.datacontract.org/2004/07/WhatEverService' tidak diharapkan. Pertimbangkan untuk menggunakan DataContractResolver jika Anda menggunakan DataContractSerializer atau menambahkan tipe apa pun yang tidak dikenal secara statis ke daftar tipe yang dikenal - misalnya, dengan menggunakan atribut DiketahuiTipeAttribute atau dengan menambahkannya ke daftar tipe yang diketahui yang diteruskan ke serializer.

Cara saya menyelesaikannya dengan menambahkan KnownType.

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

Ini dipecahkan terinspirasi dari jawaban ini .

Referensi: https://msdn.microsoft.com/en-us/library/ms730167(v=vs.100).aspx

Visual Studio 2017 atau 2019 sama sekali tidak bijaksana dalam hal ini, karena Visual Studio sendiri membutuhkan output dalam format json , sedangkan format default Visual Studio adalah " XmlFormat" (config.Formatters.XmlFormatter) .

Visual Studio harus melakukan ini secara otomatis alih-alih memberi pengembang begitu banyak masalah.

Untuk memperbaiki masalah ini, buka file WebApiConfig.cs , dan tambahkan

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

setelah " config.MapHttpAttributeRoutes (); " di metode Register (HttpConfiguration config) . Ini akan memungkinkan proyek Anda menghasilkan keluaran json.

Dalam kasus saya, saya memecahkan pembuatan ulang database. Saya membuat beberapa perubahan dalam model dan meluncurkan Update-Database di Package Manager Console. Saya mendapat Error berikut:

"Pernyataan ALTER TABLE berkonflik dengan batasan FOREIGN KEY" FK_dbo.Activities_dbo.Projects_ProjectId ". Konflik terjadi dalam database" TrackEmAllContext-20190530144302 ", tabel" dbo.Projects ", kolom 'Id'."

Dalam kasus: Jika menambahkan kode ke WebApiConfig.cs atau Global.asax.cs tidak berhasil untuk Anda:

.ToList();

Tambahkan fungsi .ToList ().

Saya mencoba setiap solusi tetapi yang berikut berhasil untuk saya:

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

Saya harap, ini membantu.

dalam kasus saya, itu diperbaiki ketika saya menghapus kata kunci virtual sebelum properti navigasi saya, maksud saya tabel referensi. jadi saya berubah

public virtual MembershipType MembershipType { get; set; }

untuk:

public MembershipType MembershipType { get; set; }