Posso specificare un percorso in un attributo per mappare una proprietà della mia class a una proprietà child nel mio JSON?

Esiste un codice (che non posso modificare) che utilizza DeserializeObject(strJSONData) per prelevare i dati da una richiesta Web e convertirli in un object di class (posso modificare la class). [DataMember(Name = "raw_property_name")] proprietà della mia class con [DataMember(Name = "raw_property_name")] Posso mappare i dati JSON non [DataMember(Name = "raw_property_name")] alla proprietà corretta della mia class. Esiste un modo per mappare la proprietà child di un object complesso JSON a una proprietà semplice? Ecco un esempio:

 { "picture": { "id": 123456, "data": { "type": "jpg", "url": "http://www.someplace.com/mypicture.jpg" } } } 

Non mi interessa nulla del resto dell’object immagine eccetto URL, quindi non voglio impostare un object complesso nella mia class C #. Voglio solo qualcosa del tipo:

 [DataMember(Name = "picture.data.url")] public string ProfilePicture { get; set; } 

È ansible?

Bene, se hai solo bisogno di una singola proprietà aggiuntiva, un approccio semplice è quello di analizzare il tuo JSON in un JObject , usare ToObject() per popolare la tua class da JObject e quindi usare SelectToken() per SelectToken() la proprietà extra.

Quindi, assumendo che la tua class assomigli a qualcosa del genere:

 class Person { [JsonProperty("name")] public string Name { get; set; } [JsonProperty("age")] public string Age { get; set; } public string ProfilePicture { get; set; } } 

Potresti fare questo:

 string json = @" { ""name"" : ""Joe Shmoe"", ""age"" : 26, ""picture"": { ""id"": 123456, ""data"": { ""type"": ""jpg"", ""url"": ""http://www.someplace.com/mypicture.jpg"" } } }"; JObject jo = JObject.Parse(json); Person p = jo.ToObject(); p.ProfilePicture = (string)jo.SelectToken("picture.data.url"); 

Fiddle: https://dotnetfiddle.net/7gnJCK


Se si preferisce una soluzione più sofisticata, è ansible creare un JsonConverter personalizzato per abilitare l’attributo JsonProperty a comportarsi come descritto. Il convertitore dovrebbe operare a livello di class e utilizzare una riflessione combinata con la tecnica sopra per popolare tutte le proprietà. Ecco come potrebbe apparire nel codice:

 class JsonPathConverter : JsonConverter { public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) { JObject jo = JObject.Load(reader); object targetObj = Activator.CreateInstance(objectType); foreach (PropertyInfo prop in objectType.GetProperties() .Where(p => p.CanRead && p.CanWrite)) { JsonPropertyAttribute att = prop.GetCustomAttributes(true) .OfType() .FirstOrDefault(); string jsonPath = (att != null ? att.PropertyName : prop.Name); JToken token = jo.SelectToken(jsonPath); if (token != null && token.Type != JTokenType.Null) { object value = token.ToObject(prop.PropertyType, serializer); prop.SetValue(targetObj, value, null); } } return targetObj; } public override bool CanConvert(Type objectType) { // CanConvert is not called when [JsonConverter] attribute is used return false; } public override bool CanWrite { get { return false; } } public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { throw new NotImplementedException(); } } 

Per dimostrare, assumiamo che il JSON ora assomigli al seguente:

 { "name": "Joe Shmoe", "age": 26, "picture": { "id": 123456, "data": { "type": "jpg", "url": "http://www.someplace.com/mypicture.jpg" } }, "favorites": { "movie": { "title": "The Godfather", "starring": "Marlon Brando", "year": 1972 }, "color": "purple" } } 

… e ti interessa il film preferito della persona (titolo e anno) e il colore preferito oltre alle informazioni di prima. Per prima cosa contrassegnare la class di destinazione con un attributo [JsonConverter] per associarlo al convertitore personalizzato, quindi utilizzare gli attributi [JsonProperty] su ogni proprietà, specificando il percorso della proprietà desiderato (distinzione tra maiuscole e minuscole) come nome. Le proprietà di destinazione non devono necessariamente essere primitive: è ansible utilizzare una class figlio come quella che ho fatto qui con Movie (e notare che non è richiesta alcuna class di interlocutori Favorites ).

 [JsonConverter(typeof(JsonPathConverter))] class Person { [JsonProperty("name")] public string Name { get; set; } [JsonProperty("age")] public int Age { get; set; } [JsonProperty("picture.data.url")] public string ProfilePicture { get; set; } [JsonProperty("favorites.movie")] public Movie FavoriteMovie { get; set; } [JsonProperty("favorites.color")] public string FavoriteColor { get; set; } } // Don't need to mark up these properties because they are covered by the // property paths in the Person class class Movie { public string Title { get; set; } public int Year { get; set; } } 

Con tutti gli attributi in atto, puoi semplicemente deserializzare come normale e dovrebbe “funzionare”:

 Person p = JsonConvert.DeserializeObject(json); 

Fiddle: https://dotnetfiddle.net/Ljw32O

La risposta contrassegnata non è completa al 100% in quanto ignora qualsiasi IContractResolver che può essere registrato come CamelCasePropertyNamesContractResolver ecc.

Anche restituire false per la conversione può impedire altri casi utente, quindi l’ho modificato per return objectType.GetCustomAttributes(true).OfType().Any();

Ecco la versione aggiornata: https://dotnetfiddle.net/F8C8U8

Ho anche rimosso la necessità di impostare JsonProperty su una proprietà come illustrato nel link.

Se per qualche motivo il link sopra muore o esplode, includo anche il seguente codice:

 public class JsonPathConverter : JsonConverter { ///  public override object ReadJson( JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) { JObject jo = JObject.Load(reader); object targetObj = Activator.CreateInstance(objectType); foreach (PropertyInfo prop in objectType.GetProperties().Where(p => p.CanRead && p.CanWrite)) { JsonPropertyAttribute att = prop.GetCustomAttributes(true) .OfType() .FirstOrDefault(); string jsonPath = att != null ? att.PropertyName : prop.Name; if (serializer.ContractResolver is DefaultContractResolver) { var resolver = (DefaultContractResolver)serializer.ContractResolver; jsonPath = resolver.GetResolvedPropertyName(jsonPath); } if (!Regex.IsMatch(jsonPath, @"^[a-zA-Z0-9_.-]+$")) { throw new InvalidOperationException($"JProperties of JsonPathConverter can have only letters, numbers, underscores, hiffens and dots but name was ${jsonPath}."); // Array operations not permitted } JToken token = jo.SelectToken(jsonPath); if (token != null && token.Type != JTokenType.Null) { object value = token.ToObject(prop.PropertyType, serializer); prop.SetValue(targetObj, value, null); } } return targetObj; } ///  public override bool CanConvert(Type objectType) { // CanConvert is not called when [JsonConverter] attribute is used return objectType.GetCustomAttributes(true).OfType().Any(); } ///  public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { var properties = value.GetType().GetRuntimeProperties().Where(p => p.CanRead && p.CanWrite); JObject main = new JObject(); foreach (PropertyInfo prop in properties) { JsonPropertyAttribute att = prop.GetCustomAttributes(true) .OfType() .FirstOrDefault(); string jsonPath = att != null ? att.PropertyName : prop.Name; if (serializer.ContractResolver is DefaultContractResolver) { var resolver = (DefaultContractResolver)serializer.ContractResolver; jsonPath = resolver.GetResolvedPropertyName(jsonPath); } var nesting = jsonPath.Split('.'); JObject lastLevel = main; for (int i = 0; i < nesting.Length; i++) { if (i == nesting.Length - 1) { lastLevel[nesting[i]] = new JValue(prop.GetValue(value)); } else { if (lastLevel[nesting[i]] == null) { lastLevel[nesting[i]] = new JObject(); } lastLevel = (JObject)lastLevel[nesting[i]]; } } } serializer.Serialize(writer, main); } } 

È necessario farlo

 lastLevel [nesting [i]] = new JValue(prop.GetValue (value)); 

Devi fare

 lastLevel[nesting[i]] = JValue.FromObject(jValue); 

Altrimenti abbiamo un

Imansible determinare il tipo di object JSON per tipo …

eccezione

Se qualcuno ha bisogno di usare JsonPathConverter di @BrianRogers anche con l’opzione WriteJson , ecco una soluzione (che funziona solo per i percorsi con punti solo ):

Rimuovere la proprietà CanWrite in modo che diventi nuovamente true per impostazione predefinita.

Sostituisci il codice WriteJson nel modo seguente:

 public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { var properties = value.GetType().GetRuntimeProperties ().Where(p => p.CanRead && p.CanWrite); JObject main = new JObject (); foreach (PropertyInfo prop in properties) { JsonPropertyAttribute att = prop.GetCustomAttributes(true) .OfType() .FirstOrDefault(); string jsonPath = (att != null ? att.PropertyName : prop.Name); var nesting=jsonPath.Split(new[] { '.' }); JObject lastLevel = main; for (int i = 0; i < nesting.Length; i++) { if (i == nesting.Length - 1) { lastLevel [nesting [i]] = new JValue(prop.GetValue (value)); } else { if (lastLevel [nesting [i]] == null) { lastLevel [nesting [i]] = new JObject (); } lastLevel = (JObject)lastLevel [nesting [i]]; } } } serializer.Serialize (writer, main); } 

Come ho detto sopra, questo funziona solo per i percorsi che contengono punti . ReadJson questo, è necessario aggiungere il seguente codice a ReadJson per evitare altri casi:

 [...] string jsonPath = (att != null ? att.PropertyName : prop.Name); if (!Regex.IsMatch(jsonPath, @"^[a-zA-Z0-9_.-]+$")) { throw new InvalidOperationException("JProperties of JsonPathConverter can have only letters, numbers, underscores, hiffens and dots."); //Array operations not permitted } JToken token = jo.SelectToken(jsonPath); [...]