ASP.NET MVCのJson()から小文字のプロパティ名を強制する


89

次のクラスを考えると、

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

    public string Message { get; set; }
}

私はこれらの1つをコントローラーアクションで返しています。

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

しかし、私のクライアント側のフレームワークは、これらのプロパティが小文字の成功とメッセージであることを期待しています。実際に小文字のプロパティ名を必要とせずに、これを実現する方法は、通常のJson関数呼び出しを考えたことですか?

回答:


130

これを実現する方法は、次の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"
  ]
}

1
このリンクは機能します:james.newtonking.com/json/help/index.html?topic
html

JSON.NETを使用していて、camelCaseではなくsnake_caseが必要な場合は、この要点を確認してください。gist.github.com/crallen/9238178
Niclas Lindqvist

逆シリアル化するにはどうすればよいですか?例 「小さい」から「小さい」へ
2016

1
現代JSON.NETバージョンの場合@NiclasLindqvistは、GET snake_caseにはるかに簡単な方法があります:newtonsoft.com/json/help/html/NamingStrategySnakeCase.htm
セーレンBoisen

16

Web API JavaScriptSerializerを使用している場合、シリアライザーの変更は簡単ですが、残念ながら、MVC自体がJSON.Netを使用するように変更するオプションなしで使用しています。

Jamesの回答Danielの回答は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);
            }
        }
    }
}

10

私のソリューションでは、必要なすべてのプロパティの名前を変更できます。

私はここと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シリアル化するすべてのプロパティにを設定する必要があることに注意してください。


1

古い質問ですが、以下のコードスニペットが他の人に役立つことを願って、

MVC5 Web APIを使用して以下を実行しました。

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

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

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

0

この設定を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;
         }; 
         //....
     }
}
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.