¿Puedo especificar una ruta en un atributo para asignar una propiedad en mi clase a una propiedad secundaria en mi JSON?

Hay un código (que no puedo cambiar) que usa el DeserializeObject de DeserializeObject(strJSONData) para tomar datos de una solicitud web y convertirlos en un objeto de clase (puedo cambiar la clase). Al decorar mis propiedades de clase con [DataMember(Name = "raw_property_name")] puedo asignar los datos JSON sin procesar a la propiedad correcta en mi clase. ¿Hay alguna manera de asignar la propiedad secundaria de un objeto complejo JSON a una propiedad simple? Aquí hay un ejemplo:

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

No me importa el rest del objeto de la imagen excepto la URL, por lo que no quiero configurar un objeto complejo en mi clase C #. Realmente solo quiero algo como:

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

es posible?

Bueno, si solo necesita una sola propiedad adicional, un enfoque simple es analizar su JSON a JObject , usar ToObject() para completar su clase desde JObject , y luego usar SelectToken() para obtener la propiedad adicional.

Entonces, suponiendo que tu clase se viera algo como esto:

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

Podrías hacer esto:

 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


Si prefiere una solución más sofisticada, puede crear un JsonConverter personalizado para permitir que el atributo JsonProperty comporte como usted lo describe. El convertidor necesitaría operar a nivel de clase y usar una reflexión combinada con la técnica anterior para poblar todas las propiedades. Esto es lo que podría verse en el código:

 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(); } } 

Para demostrar, supongamos que el JSON ahora se ve así:

 { "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" } } 

… y está interesado en la película favorita de la persona (título y año) y el color favorito, además de la información de antes. En primer lugar, marque su clase objective con un atributo [JsonConverter] para asociarlo con el convertidor personalizado, luego use los atributos [JsonProperty] en cada propiedad, especificando la ruta de propiedad deseada (sensible a las mayúsculas y minúsculas) como el nombre. Las propiedades de destino tampoco tienen que ser primitivas: puede usar una clase hija como hice aquí con Movie (y observe que no se requiere una clase de Favorites intermedia).

 [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 todos los atributos en su lugar, puede deserializar como es normal y debería “funcionar”:

 Person p = JsonConvert.DeserializeObject(json); 

Fiddle: https://dotnetfiddle.net/Ljw32O

La respuesta marcada no está completa al 100% ya que ignora cualquier IContractResolver que pueda registrarse como CamelCasePropertyNamesContractResolver, etc.

Además, devolver false para puede convertir evitará otros casos de usuarios, así que lo cambié para return objectType.GetCustomAttributes(true).OfType().Any();

Aquí está la versión actualizada: https://dotnetfiddle.net/F8C8U8

También JsonProperty la necesidad de establecer un JsonProperty en una propiedad como se ilustra en el enlace.

Si por alguna razón el enlace de arriba muere o explota, también incluyo el siguiente código:

 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); } } 

En vez de hacer

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

Tu tienes que hacer

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

De lo contrario, tenemos un

No se pudo determinar el tipo de objeto JSON para el tipo …

excepción

Si alguien necesita usar JsonPathConverter de @BrianRogers también con la opción WriteJson , aquí hay una solución (que solo funciona para rutas con puntos ):

Elimine la propiedad CanWrite para que vuelva a ser true de manera predeterminada.

Reemplace el código de WriteJson por lo siguiente:

 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); } 

Como dije antes, esto solo funciona para rutas que contienen puntos . Dado eso, debe agregar el siguiente código a ReadJson para evitar otros casos:

 [...] 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); [...]