condizionale serializzazione/deserializzazione di proprietà dell'oggetto con json.net

Question

Ho uno scenario con una classe definita come sotto:

class MyObject 
{ 
    public DataDictionary MyObjectData { get; set; } 

    public bool ShouldSerializeMyObjectData() { return true; } 
    public bool ShouldDeserializeMyObjectData() { return false; } 
} 

Quando si tenta di serializzare/deserializzare quella classe con JSON.net, esso prende il ShouldSerialize in considerazione, ma non lo ShouldDeserialize.

Secondo la documentazione, entrambi dovrebbero funzionare nello stesso modo in cui credo. C'è qualcosa di particolare che dovrei sapere? Più in generale, come devo gestire gli scenari in cui desidero serializzare una proprietà ma non deserializzarla?

Sto usando Json.NET 8.0 se questo è importante.

Grazie per il vostro aiuto.

Answer 1

La risposta breve alla tua domanda è, il controllo automatico per ShouldDeserialize{PropertyName}() non è attualmente implementato anche se ShouldSerialize{PropertyName}() è. Segue una risposta più lunga e una soluzione alternativa.

La classe JsonProperty viene utilizzata internamente da Json.NET per definire un contratto per come associare una proprietà JSON a un membro .NET o un parametro del costruttore. Dispone di due proprietà di predicato, ShouldSerialize e ShouldDeserialize che, quando non sono nulle, impediscono la serializzazione e la deserializzazione di una proprietà, rispettivamente. L'inizializzazione di ogni JsonProperty è il lavoro di ContractResolver. Per ogni proprietà {PropertyName}, il numero default contract resolver di Json.NET verifica automaticamente la presenza di un metodo public bool ShouldSerialize{PropertyName}(). Se esiste un tale metodo, aggiunge una chiamata nel predicato ShouldSerialize, sopprimendo in tal modo la serializzazione quando il metodo restituisce false. Ciò è stato implementato perché il controllo della serializzazione delle proprietà tramite un metodo ShouldSerialize{PropertyName}() è un modello standard supportato da, ad esempio, XmlSerializer. Per ulteriori informazioni sullo scenario, vedere il relativo Json.NET release notes.

Ad esempio, nella seguente classe, la serializzazione di MyObjectData sarà soppressa a meno che MyObjectData.Count > 0:

class MyObject 
{ 
    public DataDictionary MyObjectData { get; set; } 

    public bool ShouldSerializeMyObjectData() { return MyObjectData != null && MyObjectData.Count > 0; } 
} 

JsonProperty.ShouldDeserialize, tuttavia, non è mai impostato dal resolver contratto predefinito. Ciò potrebbe essere dovuto al fatto che non esiste un modello standard per la deserializzazione equivalente a ShouldSerialize{PropertyName}() e quindi Newtonsoft non ha mai avuto alcuna richiesta per implementare tale modello. Tuttavia, come hai notato, esiste un'infrastruttura per supportare tale modello e quindi le applicazioni possono creare custom contract resolvers che fa proprio questo. In realtà, Json.NET ha un esempio di tale resolver contratto in proprio test suite:

public class ShouldDeserializeContractResolver : DefaultContractResolver 
{ 
    public static new readonly ShouldDeserializeContractResolver Instance = new ShouldDeserializeContractResolver(); 

    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization) 
    { 
     JsonProperty property = base.CreateProperty(member, memberSerialization); 

     MethodInfo shouldDeserializeMethodInfo = member.DeclaringType.GetMethod("ShouldDeserialize" + member.Name); 

     if (shouldDeserializeMethodInfo != null) 
     { 
      property.ShouldDeserialize = o => { return (bool)shouldDeserializeMethodInfo.Invoke(o, null); }; 
     } 

     return property; 
    } 
} 

public class ShouldDeserializeTestClass 
{ 
    [JsonExtensionData] 
    public IDictionary<string, JToken> ExtensionData { get; set; } 

    public bool HasName { get; set; } 
    public string Name { get; set; } 

    public bool ShouldDeserializeName() 
    { 
     return HasName; 
    } 
} 

Se si vuole sopprimere condizionalmente deserializzazione di proprietà anche se presenti in JSON, si potrebbe considerare l'utilizzo (e caching) questo risolutore di contratto.