Jak mogę zwrócić camelCase JSON zserializowany przez JSON.NET z metod kontrolera ASP.NET MVC?

Mój problem polega na tym, że chcę zwrócić dane JSON camelCased (w przeciwieństwie do standardowej PascalCase) za pośrednictwem ActionResult s z metod kontrolera ASP.NET MVC, serializowanych przez JSON.NET .

Jako przykład rozważ następującą klasę C #:

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

Domyślnie, zwracając instancję tej klasy z kontrolera MVC jako JSON, zostanie ona serializowana w następujący sposób:

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

Chciałbym, aby został zserializowany (przez JSON.NET) jako:

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

Jak mam to zrobic?

lub po prostu:

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

Na przykład:

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

Znalazłem doskonałe rozwiązanie tego problemu na blogu Matsa Karlssona . Rozwiązaniem jest napisanie podklasy ActionResult, która serializuje dane za pośrednictwem JSON.NET, konfigurując tę ​​ostatnią zgodnie z konwencją camelCase:

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

Następnie użyj tej klasy w następujący sposób w metodzie kontrolera MVC:

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

W przypadku interfejsu WebAPI sprawdź ten link: http://odetocode.com/blogs/scott/archive/2013/03/25/asp-net-webapi-tip-3-camelcasing-json.aspx

Zasadniczo dodaj ten kod do Application_Start:

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

Myślę, że jest to prosta odpowiedź, której szukasz. Pochodzi z bloga Shawn Wildermuth :

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

Alternatywą dla niestandardowego filtra jest utworzenie metody rozszerzenia do serializacji dowolnego obiektu do JSON.

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

Następnie wywołaj go po powrocie z akcji kontrolera.

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

Prostsze jest lepsze IMO!

Dlaczego tego nie robisz?

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

Prosty kontroler klasy bazowej

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

W ASP.NET Core MVC.

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

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

        return Json(data, settings);
    }

Poniżej znajduje się metoda akcji, która zwraca ciąg json (cameCase) poprzez serializację tablicy obiektów.

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

Uwaga: instancja JsonSerializerSettings przekazana jako drugi parametr. Właśnie dlatego tak się stało.

Podobało mi się to:

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

ta prosta metoda rozszerzenia w rdzeniu MVC, da ToJson () możliwość każdemu obiektowi w twoim projekcie. Moim zdaniem w projekcie MVC większość obiektów powinna mieć możliwość zostania jsonem, oczywiście to zależy :)

Musisz ustawić ustawienia w pliku „Startup.cs”

Musisz także zdefiniować go w domyślnych wartościach JsonConvert, to jest, jeśli później chcesz bezpośrednio użyć biblioteki do serializacji obiektu.

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

Jeśli zwracasz ActionResult w interfejsie API .NET Core lub wynik IHttpAction, możesz po prostu zawinąć swój model w metodę Ok (), która dopasuje obudowę do twojego interfejsu i serializuje go dla Ciebie. Nie musisz używać JsonConvert. :)