ASP.NET MVC denetleyici yöntemlerinden JSON.NET tarafından serileştirilmiş camelCase JSON nasıl dönebilirim?

Benim sorunum, JSON.NET tarafından serileştirilmiş ASP.NET MVC denetleyici yöntemlerinden ActionResult s aracılığıyla camelCased (standart PascalCase aksine) JSON verileri döndürmek istiyor olmasıdır .

Örnek olarak aşağıdaki C # sınıfını göz önünde bulundurun:

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

Varsayılan olarak, bu sınıfın bir örneğini MVC denetleyicisinden JSON olarak döndürürken, aşağıdaki şekilde serileştirilir:

{
  "FirstName": "Joe",
  "LastName": "Public"
}

Ben (JSON.NET tarafından) serileştirmek istiyorum:

{
  "firstName": "Joe",
  "lastName": "Public"
}

Bunu nasıl yaparım?

veya basitçe şunu belirtin:

JsonConvert.SerializeObject(
    <YOUR OBJECT>, 
    new JsonSerializerSettings 
    { 
        ContractResolver = new CamelCasePropertyNamesContractResolver() 
    });

Örneğin:

return new ContentResult
{
    ContentType = "application/json",
    Content = JsonConvert.SerializeObject(new { content = result, rows = dto }, new JsonSerializerSettings { ContractResolver = new CamelCasePropertyNamesContractResolver() }),
    ContentEncoding = Encoding.UTF8
};

Mats Karlsson'un blogunda bu soruna mükemmel bir çözüm buldum . Çözüm, JSON.NET aracılığıyla verileri serileştiren ve ikincisini camelCase kuralını izleyecek şekilde yapılandıran bir ActionResult alt sınıfı yazmaktır:

public class JsonCamelCaseResult : ActionResult
{
    public JsonCamelCaseResult(object data, JsonRequestBehavior jsonRequestBehavior)
    {
        Data = data;
        JsonRequestBehavior = jsonRequestBehavior;
    }

    public Encoding ContentEncoding { get; set; }

    public string ContentType { get; set; }

    public object Data { get; set; }

    public JsonRequestBehavior JsonRequestBehavior { get; set; }

    public override void ExecuteResult(ControllerContext context)
    {
        if (context == null)
        {
            throw new ArgumentNullException("context");
        }
        if (JsonRequestBehavior == JsonRequestBehavior.DenyGet && String.Equals(context.HttpContext.Request.HttpMethod, "GET", StringComparison.OrdinalIgnoreCase))
        {
            throw new InvalidOperationException("This request has been blocked because sensitive information could be disclosed to third party web sites when this is used in a GET request. To allow GET requests, set JsonRequestBehavior to AllowGet.");
        }

        var response = context.HttpContext.Response;

        response.ContentType = !String.IsNullOrEmpty(ContentType) ? ContentType : "application/json";
        if (ContentEncoding != null)
        {
            response.ContentEncoding = ContentEncoding;
        }
        if (Data == null)
            return;

        var jsonSerializerSettings = new JsonSerializerSettings
        {
            ContractResolver = new CamelCasePropertyNamesContractResolver()
        };
        response.Write(JsonConvert.SerializeObject(Data, jsonSerializerSettings));
    }
}

Ardından bu sınıfı MVC denetleyici yönteminizde aşağıdaki gibi kullanın:

public ActionResult GetPerson()
{
    return new JsonCamelCaseResult(new Person { FirstName = "Joe", LastName = "Public" }, JsonRequestBehavior.AllowGet)};
}

WebAPI için şu bağlantıya göz atın : http://odetocode.com/blogs/scott/archive/2013/03/25/asp-net-webapi-tip-3-camelcasing-json.aspx

Temel olarak, bu kodu şu adrese ekleyin Application_Start:

var formatters = GlobalConfiguration.Configuration.Formatters;
var jsonFormatter = formatters.JsonFormatter;
var settings = jsonFormatter.SerializerSettings;
settings.ContractResolver = new CamelCasePropertyNamesContractResolver();

Bence bu aradığınız basit cevap. Bu geliyor Shawn Wildermuth bireyin blogda:

// Add MVC services to the services container.
services.AddMvc()
  .AddJsonOptions(opts =>
  {
    opts.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
  });

Özel filtreye bir alternatif, herhangi bir nesneyi JSON'a serileştirmek için bir uzantı yöntemi oluşturmaktır.

public static class ObjectExtensions
{
    /// <summary>Serializes the object to a JSON string.</summary>
    /// <returns>A JSON string representation of the object.</returns>
    public static string ToJson(this object value)
    {
        var settings = new JsonSerializerSettings
        {
            ContractResolver = new CamelCasePropertyNamesContractResolver(),
            Converters = new List<JsonConverter> { new StringEnumConverter() }
        };

        return JsonConvert.SerializeObject(value, settings);
    }
}

Ardından denetleyici eyleminden dönerken arayın.

return Content(person.ToJson(), "application/json");

Daha basit daha iyi IMO!

Bunu neden yapmıyorsun?

public class CourseController : JsonController
{
    public ActionResult ManageCoursesModel()
    {
        return JsonContent(<somedata>);
    }
}

Basit temel sınıf kontrolörü

public class JsonController : BaseController
{
    protected ContentResult JsonContent(Object data)
    {
        return new ContentResult
        {
            ContentType = "application/json",
             Content = JsonConvert.SerializeObject(data, new JsonSerializerSettings { 
              ContractResolver = new CamelCasePropertyNamesContractResolver() }),
            ContentEncoding = Encoding.UTF8
        };
    }
}

ASP.NET Core MVC'de.

    public IActionResult Foo()
    {
        var data = GetData();

        var settings = new JsonSerializerSettings 
        { 
            ContractResolver = new CamelCasePropertyNamesContractResolver() 
        });

        return Json(data, settings);
    }

Aşağıda, bir nesne dizisini serileştirerek bir json dizesi (cameCase) döndüren bir eylem yöntemidir.

public string GetSerializedCourseVms()
    {
        var courses = new[]
        {
            new CourseVm{Number = "CREA101", Name = "Care of Magical Creatures", Instructor ="Rubeus Hagrid"},
            new CourseVm{Number = "DARK502", Name = "Defence against dark arts", Instructor ="Severus Snape"},
            new CourseVm{Number = "TRAN201", Name = "Transfiguration", Instructor ="Minerva McGonal"}
        };
        var camelCaseFormatter = new JsonSerializerSettings();
        camelCaseFormatter.ContractResolver = new CamelCasePropertyNamesContractResolver();
        return JsonConvert.SerializeObject(courses, camelCaseFormatter);
    }

İkinci parametre olarak iletilen JsonSerializerSettings örneğine dikkat edin. CamelCase'i böyle yapar.

Bunu beğendim:

public static class JsonExtension
{
    public static string ToJson(this object value)
    {
        var settings = new JsonSerializerSettings
        {
            ContractResolver = new CamelCasePropertyNamesContractResolver(),
            NullValueHandling = NullValueHandling.Ignore,
            ReferenceLoopHandling = ReferenceLoopHandling.Serialize
        };
        return JsonConvert.SerializeObject(value, settings);
    }
}

Bu MVC çekirdeğinde basit bir uzatma yöntemi, projenizdeki her nesneye ToJson () yeteneği verecek, Bence bir MVC projesinde, nesnenin çoğu json olma yeteneğine sahip olmalı, tabii ki bağlıdır :)

'Startup.cs' dosyasındaki ayarları ayarlamanız gerekir

Ayrıca JsonConvert'in varsayılan değerlerinde tanımlamanız gerekir, bu daha sonra bir nesneyi serileştirmek için doğrudan kütüphaneyi kullanmak istiyorsanız.

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2)
            .AddJsonOptions(options => {
                options.SerializerSettings.NullValueHandling = NullValueHandling.Ignore;
                options.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
            });
        JsonConvert.DefaultSettings = () => new JsonSerializerSettings
        {
            NullValueHandling = NullValueHandling.Ignore,
            ContractResolver = new CamelCasePropertyNamesContractResolver()
        };
    }

ActionResult'u .net core web api veya IHttpAction sonucuna döndürüyorsanız, modelinizi ön ucunuzdaki durumla eşleşecek ve sizin için serileştirecek bir Ok () yöntemiyle tamamlayabilirsiniz. JsonConvert kullanmaya gerek yok. :)