MVC JsonResult для сериализации CamelCase

Я пытаюсь вернуть свое действие JsonResult, где все его свойства находятся в camelCase.

У меня простая модель:

public class MyModel
{
    public int SomeInteger { get; set; }

    public string SomeString { get; set; }
}

И простое действие контроллера:

public JsonResult Index()
    {
        MyModel model = new MyModel();
        model.SomeInteger = 1;
        model.SomeString = "SomeString";

        return Json(model, JsonRequestBehavior.AllowGet);
    }

Вызов этого метода действий теперь возвращает JsonResult, содержащий следующие данные:

{"SomeInteger":1,"SomeString":"SomeString"}

Для моих целей мне нужно, чтобы действие возвращало данные в camelCase, так или иначе:

{"SomeInteger":1,"SomeString":"SomeString"}

Есть ли элегантный способ сделать это?

Я искал возможные решения здесь и нашел MVC3 JSON Serialization: как управлять именами свойств?, где они устанавливали определения DataMember для каждого свойства модели, но я действительно не хочу этого делать.

Также я нашел ссылку, в которой говорится, что можно решить именно такую проблему: http://www.asp.net/web-api/overview/formats-and-model-binding/json-and-xml-serialization#json_camelcasing. В нем говорится:

Чтобы написать имена свойств JSON с корпусом верблюда, не изменяя модель данных, установите CamelCasePropertyNamesContractResolver в сериализаторе:

var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();

Одна запись в этом блоге http://frankapi.wordpress.com/2012/09/09/going-camelcase-in-asp-net-mvc-web-api/ также упоминает это решение и заявляет, что вы можете просто добавить его в RouteConfig.RegisterRoutes, чтобы исправить эту проблему. Я попробовал, но я не мог заставить его работать.

Вы, ребята, знаете, где я делаю что-то неправильно?

Ответ 1

Функции Json контроллера - это просто обертки для создания JsonResults:

protected internal JsonResult Json(object data)
{
    return Json(data, null /* contentType */, null /* contentEncoding */, JsonRequestBehavior.DenyGet);
}

protected internal JsonResult Json(object data, string contentType)
{
    return Json(data, contentType, null /* contentEncoding */, JsonRequestBehavior.DenyGet);
}

protected internal virtual JsonResult Json(object data, string contentType, Encoding contentEncoding)
{
    return Json(data, contentType, contentEncoding, JsonRequestBehavior.DenyGet);
}

protected internal JsonResult Json(object data, JsonRequestBehavior behavior)
{
    return Json(data, null /* contentType */, null /* contentEncoding */, behavior);
}

protected internal JsonResult Json(object data, string contentType, JsonRequestBehavior behavior)
{
    return Json(data, contentType, null /* contentEncoding */, behavior);
}

protected internal virtual JsonResult Json(object data, string contentType, Encoding contentEncoding, JsonRequestBehavior behavior)
{
    return new JsonResult
    {
        Data = data,
        ContentType = contentType,
        ContentEncoding = contentEncoding,
        JsonRequestBehavior = behavior
    };
}

JsonResult внутренне использует JavaScriptSerializer, поэтому у вас нет контроля над процессом сериализации:

public class JsonResult : ActionResult
{
    public JsonResult()
    {
        JsonRequestBehavior = JsonRequestBehavior.DenyGet;
    }

    public Encoding ContentEncoding { get; set; }

    public string ContentType { get; set; }

    public object Data { get; set; }

    public JsonRequestBehavior JsonRequestBehavior { get; set; }

    /// <summary>
    /// When set MaxJsonLength passed to the JavaScriptSerializer.
    /// </summary>
    public int? MaxJsonLength { get; set; }

    /// <summary>
    /// When set RecursionLimit passed to the JavaScriptSerializer.
    /// </summary>
    public int? RecursionLimit { 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(MvcResources.JsonRequest_GetNotAllowed);
        }

        HttpResponseBase response = context.HttpContext.Response;

        if (!String.IsNullOrEmpty(ContentType))
        {
            response.ContentType = ContentType;
        }
        else
        {
            response.ContentType = "application/json";
        }
        if (ContentEncoding != null)
        {
            response.ContentEncoding = ContentEncoding;
        }
        if (Data != null)
        {
            JavaScriptSerializer serializer = new JavaScriptSerializer();
            if (MaxJsonLength.HasValue)
            {
                serializer.MaxJsonLength = MaxJsonLength.Value;
            }
            if (RecursionLimit.HasValue)
            {
                serializer.RecursionLimit = RecursionLimit.Value;
            }
            response.Write(serializer.Serialize(Data));
        }
    }
}

Вы должны создать свой собственный JsonResult и написать свои собственные функции Json Controller (если вам это нужно/нужно). Вы можете создавать новые или перезаписывать существующие, это зависит от вас. Эта ссылка также может вас заинтересовать.

Ответ 2

Если вы хотите вернуть json-строку из вашего действия, которое придерживается нотации Camelcase, вам нужно создать экземпляр JsonSerializerSettings и передать его в качестве второго параметра метода JsonConvert.SerializeObject(a, b).

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