Як я можу повернути camelCase JSON, серіалізований JSON.NET, з методів контролера ASP.NET MVC?

Моя проблема полягає в тому, що я хочу повернути дані JSON camelCased (на відміну від стандартного PascalCase) за допомогою ActionResult s методів контролера ASP.NET MVC, серіалізованого JSON.NET .

Як приклад розглянемо наступний клас C #:

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

За замовчуванням, коли повертається екземпляр цього класу з контролера MVC як JSON, він буде серіалізуватися таким чином:

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

Я хотів би, щоб вона була серіалізована (від JSON.NET) у вигляді:

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

Як це зробити?

або, просто кажучи:

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

Наприклад:

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

Я знайшов чудове рішення цієї проблеми в блозі Матса Карлссона . Рішення полягає в написанні підкласу ActionResult, який серіалізує дані за допомогою JSON.NET, налаштовуючи останній на виконання конвенції 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));
    }
}

Потім використовуйте цей клас у своєму методі контролера MVC:

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

Для WebAPI перегляньте це посилання: http://odetocode.com/blogs/scott/archive/2013/03/25/asp-net-webapi-tip-3-camelcasing-json.aspx

В основному додайте цей код до своїх Application_Start:

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

Я думаю, що це проста відповідь, яку ви шукаєте. Це з блогу Шона Уайлдермута :

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

Альтернативою користувальницькому фільтру є створення методу розширення для серіалізації будь-якого об’єкта в 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);
    }
}

Потім зателефонуйте, коли повертаєтесь з дії контролера.

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

Простіше, краще ІМО!

Чому ти цього не зробиш?

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

Простий контролер базового класу

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.

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

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

        return Json(data, settings);
    }

Нижче наведено метод дії, який повертає рядок json (cameCase) шляхом серіалізації масиву об’єктів.

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

Зверніть увагу на екземпляр JsonSerializerSettings, переданий як другий параметр. Ось що змушує верблюда статися.

Мені було так:

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

це простий метод розширення в ядрі MVC, він дасть можливість ToJson () кожному об'єкту у вашому проекті. На мою думку, у проекті MVC більшість об'єктів повинна мати можливість стати json, звичайно, це залежить :)

Ви повинні встановити настройки у файлі "Startup.cs"

Ви також повинні визначити це у значеннях за замовчуванням JsonConvert, це якщо ви хочете пізніше безпосередньо використовувати бібліотеку для серіалізації об'єкта.

    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 у .net core api, або результат IHttpAction, ви можете просто обгорнути свою модель методом Ok (), який буде відповідати випадку на передньому кінці та серіалізувати його для вас. Не потрібно використовувати JsonConvert. :)