Примусово застосовувати малі імена властивостей від Json () в ASP.NET MVC

Question 1

Враховуючи наступний клас,

public class Result
{      
    public bool Success { get; set; }

    public string Message { get; set; }
}

Я повертаю одне з них у дії контролера таким чином,

return Json(new Result() { Success = true, Message = "test"})

Однак мій фреймворк на стороні клієнта очікує, що ці властивості будуть нижчими і успішними. Без того, що насправді не потрібно мати назви нижчих регістрів, це спосіб досягти цієї думки, як звичайний виклик функції Json?

Question 2

Шляхом досягнення цього є реалізація користувацького, JsonResultяк тут: Створення користувацького ValueType та серіалізація за допомогою користувацького JsonResult (оригінальне посилання мертве) .

І використовуйте альтернативний серіалізатор, такий як JSON.NET , який підтримує подібну поведінку, наприклад:

Product product = new Product
{
  ExpiryDate = new DateTime(2010, 12, 20, 18, 1, 0, DateTimeKind.Utc),
  Name = "Widget",
  Price = 9.99m,
  Sizes = new[] {"Small", "Medium", "Large"}
};

string json = 
  JsonConvert.SerializeObject(
    product,
    Formatting.Indented,
    new JsonSerializerSettings 
    { 
      ContractResolver = new CamelCasePropertyNamesContractResolver() 
    }
);

Призводить до

{
  "name": "Widget",
  "expiryDate": "\/Date(1292868060000)\/",
  "price": 9.99,
  "sizes": [
    "Small",
    "Medium",
    "Large"
  ]
}

Question 3

Зміна серіалізатора проста, якщо ви використовуєте веб-API, але, на жаль, сам MVC використовує JavaScriptSerializerбез можливості змінити це для використання JSON.Net.

Відповідь Джеймса і відповідь Даніеля дати вам гнучкість JSON.Net , але означає , що всюди , де ви зазвичай робите , return Json(obj)ви повинні змінити до return new JsonNetResult(obj)або аналогічний , який , якщо у вас є великий проект може виявитися проблемою, а також не дуже гнучким , якщо Ви передумаєте про серіалізатор, який хочете використовувати.

Я вирішив піти по ActionFilterмаршруту. Наведений нижче код дозволяє виконувати будь-які дії, використовуючи JsonResultта просто застосовуючи до нього атрибут, щоб використовувати JSON.Net (із малими властивостями):

[JsonNetFilter]
[HttpPost]
public ActionResult SomeJson()
{
    return Json(new { Hello = "world" });
}

// outputs: { "hello": "world" }

Ви навіть можете налаштувати це на автоматичне застосування до всіх дій (лише з незначним натисканням продуктивності isперевірки):

FilterConfig.cs

// ...
filters.Add(new JsonNetFilterAttribute());

Кодекс

public class JsonNetFilterAttribute : ActionFilterAttribute
{
    public override void OnActionExecuted(ActionExecutedContext filterContext)
    {
        if (filterContext.Result is JsonResult == false)
            return;

        filterContext.Result = new CustomJsonResult((JsonResult)filterContext.Result);
    }

    private class CustomJsonResult : JsonResult
    {
        public CustomJsonResult(JsonResult jsonResult)
        {
            this.ContentEncoding = jsonResult.ContentEncoding;
            this.ContentType = jsonResult.ContentType;
            this.Data = jsonResult.Data;
            this.JsonRequestBehavior = jsonResult.JsonRequestBehavior;
            this.MaxJsonLength = jsonResult.MaxJsonLength;
            this.RecursionLimit = jsonResult.RecursionLimit;
        }

        public override void ExecuteResult(ControllerContext context)
        {
            if (context == null)
                throw new ArgumentNullException("context");

            if (this.JsonRequestBehavior == JsonRequestBehavior.DenyGet
                && String.Equals(context.HttpContext.Request.HttpMethod, "GET", StringComparison.OrdinalIgnoreCase))
                throw new InvalidOperationException("GET not allowed! Change JsonRequestBehavior to AllowGet.");

            var response = context.HttpContext.Response;

            response.ContentType = String.IsNullOrEmpty(this.ContentType) ? "application/json" : this.ContentType;

            if (this.ContentEncoding != null)
                response.ContentEncoding = this.ContentEncoding;

            if (this.Data != null)
            {
                var json = JsonConvert.SerializeObject(
                    this.Data,
                    new JsonSerializerSettings
                        {
                            ContractResolver = new CamelCasePropertyNamesContractResolver()
                        });

                response.Write(json);
            }
        }
    }
}

Question 4

За допомогою мого рішення ви можете перейменувати кожну властивість, яку хочете.

Я знайшов частину рішення тут і на SO

public class JsonNetResult : ActionResult
    {
        public Encoding ContentEncoding { get; set; }
        public string ContentType { get; set; }
        public object Data { get; set; }

        public JsonSerializerSettings SerializerSettings { get; set; }
        public Formatting Formatting { get; set; }

        public JsonNetResult(object data, Formatting formatting)
            : this(data)
        {
            Formatting = formatting;
        }

        public JsonNetResult(object data):this()
        {
            Data = data;
        }

        public JsonNetResult()
        {
            Formatting = Formatting.None;
            SerializerSettings = new JsonSerializerSettings();
        }

        public override void ExecuteResult(ControllerContext context)
        {
            if (context == null)
                throw new ArgumentNullException("context");
            var response = context.HttpContext.Response;
            response.ContentType = !string.IsNullOrEmpty(ContentType)
              ? ContentType
              : "application/json";
            if (ContentEncoding != null)
                response.ContentEncoding = ContentEncoding;

            if (Data == null) return;

            var writer = new JsonTextWriter(response.Output) { Formatting = Formatting };
            var serializer = JsonSerializer.Create(SerializerSettings);
            serializer.Serialize(writer, Data);
            writer.Flush();
        }
    }

Так що в своєму контролері я можу це зробити

        return new JsonNetResult(result);

У своїй моделі я тепер можу мати:

    [JsonProperty(PropertyName = "n")]
    public string Name { get; set; }

Зверніть увагу, що зараз вам потрібно встановити JsonPropertyAttribute для кожного властивості, яке потрібно серіалізувати.

Question 5

Хоча це старе питання, сподіваємось, що нижче фрагмент коду буде корисним для інших,

Я робив нижче з веб-API MVC5.

public JsonResult<Response> Post(Request request)
    {
        var response = new Response();

        //YOUR LOGIC IN THE METHOD
        //.......
        //.......

        return Json<Response>(response, new JsonSerializerSettings() { ContractResolver = new CamelCasePropertyNamesContractResolver() });
    }

Question 6

Ви можете додати це налаштування Global.asax, і воно буде працювати всюди.

public class Global : HttpApplication
{   
    void Application_Start(object sender, EventArgs e)
    {
        //....
         JsonConvert.DefaultSettings = () =>
         {
             var settings = new JsonSerializerSettings
             {
                 ContractResolver = new CamelCasePropertyNamesContractResolver(),
                 PreserveReferencesHandling = PreserveReferencesHandling.None,
                 Formatting = Formatting.None
             };

             return settings;
         }; 
         //....
     }
}