如何返回由ASP.NET MVC控制器方法JSON.NET序列化的camelCase JSON？

Question

我的問題是，我希望通過ActionResult從ASP.NET MVC控制器方法返回camelCased（而不是標準PascalCase）JSON數據，由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" 
} 

如何我要這樣做嗎？

Answer 1

我在Mats Karlsson的blog上發現了一個很好的解決方案。解決的辦法是寫的ActionResult的子類，經由JSON.NET串行化數據，配置後者遵循駝峯約定：

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

：

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的控制器方法如下使用這個類

Answer 2

，或者簡單地說：

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

Answer 3

下面是一個操作方法，它通過序列化一個對象數組來返回一個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實例作爲第二個參數傳遞。這就是駱駝發生的原因。

Answer 4

對於的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(); 

Answer 5

我認爲這是你正在尋找簡單的答案。這是一個從Shawn Wildermuth的博客：

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

Answer 6

到自定義過濾器的替代方案是創建一個擴展方法序列化任何對象以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"); 

Answer 7

在ASP.NET Core MVC中。

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

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

     return Json(data, settings); 
    }