如何在使用 Json.NET 進行 JSON 序列化期間覆寫 JsonProperty 屬性？

使用Json.NET進行JSON序列化時覆寫JsonPropertyAttribute

在使用ASP.Net MVC和Json.Net進行JSON序列化的場景中，利用[JsonProperty(PropertyName = "shortName")] 屬性來最佳化有效負載大小非常有效。當接收方是另一個.Net應用程式或服務時，這種方法非常有用，因為反序列化使用原始屬性名稱重新組裝物件層次結構，同時最小化有效負載大小。

但是，當客戶端是透過瀏覽器存取的JavaScript或Ajax應用程式時，就會出現問題。客戶端接收具有縮短屬性名稱的JSON，這會妨礙最佳使用。本文探討如何以程式設計方式在JSON序列化期間繞過[JsonProperty(PropertyName = "shortName")] 屬性。

為此，使用自訂契約解析器是最佳解決方案。以下是實現：

<code class="language-csharp">public class LongNameContractResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        // 使用基类生成具有简短名称的JsonProperty
        IList<JsonProperty> properties = base.CreateProperties(type, memberSerialization);

        // 将简短名称替换为原始属性名称
        foreach (JsonProperty property in properties)
        {
            property.PropertyName = property.UnderlyingName;
        }

        return properties;
    }
}</code>

透過整合自訂解析器，您可以輕鬆控制序列化行為。其有效性如下圖所示：

<code class="language-csharp">public class Program
{
    public static void Main(string[] args)
    {
        Foo foo = new Foo
        {
            CustomerName = "Bubba Gump Shrimp Company",
            CustomerNumber = "BG60938"
        };

        Console.WriteLine("--- 使用JsonProperty名称 ---");
        Console.WriteLine(Serialize(foo, false));
        Console.WriteLine();
        Console.WriteLine("--- 忽略JsonProperty名称 ---");
        Console.WriteLine(Serialize(foo, true));
    }

    public static string Serialize(object obj, bool useLongNames)
    {
        JsonSerializerSettings settings = new JsonSerializerSettings();
        settings.Formatting = Formatting.Indented;
        if (useLongNames)
        {
            settings.ContractResolver = new LongNameContractResolver();
        }

        return JsonConvert.SerializeObject(obj, settings);
    }
}</code>

輸出：

<code class="language-json">--- 使用JsonProperty名称 ---
{
  "cust-num": "BG60938",
  "cust-name": "Bubba Gump Shrimp Company"
}

--- 忽略JsonProperty名称 ---
{
  "CustomerNumber": "BG60938",
  "CustomerName": "Bubba Gump Shrimp Company"
}</code>

以上是如何在使用 Json.NET 進行 JSON 序列化期間覆寫 JsonProperty 屬性？的詳細內容。更多資訊請關注PHP中文網其他相關文章！