Làm cách nào tôi có thể trả về JSON của camelCase được tuần tự hóa bởi JSON.NET từ các phương thức của bộ điều khiển ASP.NET MVC?

Vấn đề của tôi là tôi muốn trả lại dữ liệu JSON của camelCase (trái ngược với dữ liệu JSON của PascalCase) thông qua các ActionResult từ các phương thức của bộ điều khiển ASP.NET MVC, được tuần tự hóa bởi JSON.NET .

Như một ví dụ, hãy xem xét lớp C # sau:

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

Theo mặc định, khi trả về một thể hiện của lớp này từ bộ điều khiển MVC dưới dạng JSON, nó sẽ được tuần tự hóa theo kiểu sau:

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

Tôi muốn nó được tuần tự hóa (bởi JSON.NET) như:

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

Làm thế nào để tôi làm điều này?

hoặc, chỉ cần đặt:

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

Ví dụ:

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

Tôi tìm thấy một giải pháp tuyệt vời cho vấn đề này trên blog của Mats Karlsson . Giải pháp là viết một lớp con của ActionResult để tuần tự hóa dữ liệu thông qua JSON.NET, định cấu hình lớp sau để tuân theo quy ước 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));
    }
}

Sau đó sử dụng lớp này như sau trong phương thức bộ điều khiển MVC của bạn:

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

Đối với WebAPI , hãy xem liên kết này: http://odetocode.com/bloss/scott/archive/2013/03/25/asp-net-webapi-tip-3-camelcasing-json.aspx

Về cơ bản, thêm mã này vào Application_Start:

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

Tôi nghĩ rằng đây là câu trả lời đơn giản mà bạn đang tìm kiếm. Đó là từ blog của Shawn Wildermuth :

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

Một thay thế cho bộ lọc tùy chỉnh là tạo một phương thức mở rộng để tuần tự hóa bất kỳ đối tượng nào thành 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);
    }
}

Sau đó gọi nó khi trở về từ hành động điều khiển.

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

Đơn giản hơn là IMO!

Tại sao bạn không làm điều này?

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

Bộ điều khiển lớp cơ sở đơn giản

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

Trong ASP.NET Core MVC.

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

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

        return Json(data, settings);
    }

Dưới đây là một phương thức hành động trả về một chuỗi json (cameCase) bằng cách tuần tự hóa một mảng các đối tượng.

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

Lưu ý phiên bản JsonSerializerSinstall được truyền dưới dạng tham số thứ hai. Đó là những gì làm cho lạc đà xảy ra.

Tôi đã làm như thế này:

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

Đây là một phương thức mở rộng đơn giản trong lõi MVC, nó sẽ cung cấp khả năng ToJson () cho mọi đối tượng trong dự án của bạn, theo tôi trong một dự án MVC, hầu hết các đối tượng nên có khả năng trở thành json, tất nhiên nó phụ thuộc :)

Bạn phải đặt cài đặt trong tệp 'Startup.cs'

Bạn cũng phải xác định nó trong các giá trị mặc định của JsonConvert, đây là nếu sau này bạn muốn sử dụng trực tiếp thư viện để tuần tự hóa một đối tượng.

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

Nếu bạn đang trả lại ActionResult trong api web lõi .net hoặc kết quả IHttpAction thì bạn có thể kết thúc mô hình của mình theo phương thức Ok () sẽ khớp với trường hợp trên giao diện người dùng của bạn và nối tiếp nó cho bạn. Không cần sử dụng JsonConvert. :)