ฉันจะคืนค่า camelCase JSON ต่อเนื่องโดย JSON.NET จากวิธีการควบคุม ASP.NET MVC ได้อย่างไร

ปัญหาของฉันที่ฉันต้องการที่จะกลับ camelCased (เมื่อเทียบกับ PascalCase มาตรฐาน) JSON ข้อมูลผ่าน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
};

ผมพบว่าเป็นทางออกที่ดีในการแก้ไขปัญหานี้บนเสื่อ Karlsson ของบล็อก วิธีแก้ปัญหาคือการเขียนคลาสย่อยของ 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();

ฉันคิดว่านี่เป็นคำตอบง่ายๆที่คุณกำลังมองหา มาจากบล็อกของShawn Wildermuth :

// 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");

IMO ง่ายกว่าดีกว่า!

ทำไมคุณไม่ทำเช่นนี้?

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 ส่งผ่านเป็นพารามิเตอร์ที่สอง นั่นคือสิ่งที่ทำให้ camelCase เกิดขึ้น

ฉันทำสิ่งนี้:

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 web api หรือผลลัพธ์ IHttpAction คุณสามารถสรุปโมเดลของคุณด้วยวิธี Ok () ซึ่งจะจับคู่เคสบน front end ของคุณและทำให้มันเป็นอนุกรมสำหรับคุณ ไม่จำเป็นต้องใช้ JsonConvert :)