Obtenga el valor de propiedad de la cadena usando la reflexión en C #


928

Estoy tratando de implementar la transformación de datos usando el ejemplo Reflection 1 en mi código.

La GetSourceValuefunción tiene un interruptor que compara varios tipos, pero quiero eliminar estos tipos y propiedades y GetSourceValueobtener el valor de la propiedad usando solo una sola cadena como parámetro. Quiero pasar una clase y propiedad en la cadena y resolver el valor de la propiedad.

es posible?

1 versión de archivo web de la publicación de blog original

Respuestas:


1793
 public static object GetPropValue(object src, string propName)
 {
     return src.GetType().GetProperty(propName).GetValue(src, null);
 }

Por supuesto, querrás agregar validación y otras cosas, pero eso es lo esencial.


8
Agradable y simple! Sin embargo, lo haría genérico:public static T GetPropertyValue<T>(object obj, string propName) { return (T)obj.GetType().GetProperty(propName).GetValue(obj, null); }
Ohad Schneider

2
Una optimización puede eliminar el riesgo de una excepción nula como esta: " src.GetType().GetProperty(propName)?.GetValue(src, null);";).
shA.t

8
@ shA.t: Creo que es una mala idea. ¿Cómo diferencia entre un valor nulo de una propiedad existente o ninguna propiedad? Prefiero saber de inmediato que estaba enviando un mal nombre de propiedad. Este no es un código de producción, pero una mejor mejora sería lanzar una excepción más específica (por ejemplo, verificar nulo GetPropertyy lanzar PropertyNotFoundExceptiono algo si es nulo.)
Ed S.

210

Qué tal algo como esto:

public static Object GetPropValue(this Object obj, String name) {
    foreach (String part in name.Split('.')) {
        if (obj == null) { return null; }

        Type type = obj.GetType();
        PropertyInfo info = type.GetProperty(part);
        if (info == null) { return null; }

        obj = info.GetValue(obj, null);
    }
    return obj;
}

public static T GetPropValue<T>(this Object obj, String name) {
    Object retval = GetPropValue(obj, name);
    if (retval == null) { return default(T); }

    // throws InvalidCastException if types are incompatible
    return (T) retval;
}

Esto le permitirá descender a propiedades usando una sola cadena, como esta:

DateTime now = DateTime.Now;
int min = GetPropValue<int>(now, "TimeOfDay.Minutes");
int hrs = now.GetPropValue<int>("TimeOfDay.Hours");

Puede usar estos métodos como métodos estáticos o extensiones.


3
@FredJand me alegro de que te hayas topado con eso. Siempre es sorprendente cuando aparecen estas viejas publicaciones. Era un poco vago, así que agregué un poco de texto para explicarlo. También cambié a usarlos como métodos de extensión y agregué un formulario genérico, así que lo agregué aquí.
jheddings

¿Por qué está el guardia nulo en el foreach y no arriba?
Santhos

44
@Santhos ya que 'obj' se redefine en el cuerpo del bucle foreach, se verifica durante cada iteración.
jheddings

Es útil, pero en el caso de que una de las propiedades anidadas pueda estar oculta (usando el modificador 'nuevo'), arrojará una excepción para encontrar propiedades duplicadas. Sería mejor hacer un seguimiento del último tipo de propiedad y usarlo en PropertyInfo.PropertyTypelugar de obj.GetType()propiedades anidadas, al igual que acceder a la propiedad en una propiedad anidada.
Nullius

Puede usar la nameofexpresión a partir de C # 6 de esta manera: nameof(TimeOfDay.Minutes)en el parámetro de nombre al llamar a la función para eliminar cadenas mágicas y agregar seguridad de tiempo de compilación a estas llamadas.
Coseche

74

Añadir a cualquiera Class:

public class Foo
{
    public object this[string propertyName]
    {
        get { return this.GetType().GetProperty(propertyName).GetValue(this, null); }
        set { this.GetType().GetProperty(propertyName).SetValue(this, value, null); }
    }

    public string Bar { get; set; }
}

Entonces, puedes usarlo como:

Foo f = new Foo();
// Set
f["Bar"] = "asdf";
// Get
string s = (string)f["Bar"];

@EduardoCuomo: ¿Es posible usar la reflexión con esto para que no necesite saber qué miembros tiene la clase?
Nuestro hombre en plátanos

¿Es posible hacer esto si "Bar" fuera un objeto?
big_water

@big_water los métodos SetValuey GetValuefuncionan con Object. Si necesita trabajar con un tipo específico, debe emitir el resultado GetValuey emitir el valor para asignarloSetValue
Eduardo Cuomo

Lo siento @OurManinBananas, no puedo entender tu pregunta. ¿Qué quieres hacer?
Eduardo Cuomo el

¿Cuál es el nombre de este tipo de métodos ..?
Sahan Chinthaka

45

¿Qué pasa con el uso CallByNamedel Microsoft.VisualBasicespacio de nombres ( Microsoft.VisualBasic.dll)? Utiliza la reflexión para obtener propiedades, campos y métodos de objetos normales, objetos COM e incluso objetos dinámicos.

using Microsoft.VisualBasic;
using Microsoft.VisualBasic.CompilerServices;

y entonces

Versioned.CallByName(this, "method/function/prop name", CallType.Get).ToString();

55
Sugerencia interesante, una inspección adicional demostró que puede manejar tanto campos como propiedades, objetos COM, ¡ e incluso puede manejar correctamente el enlace dinámico !
IllidanS4 quiere que Monica regrese el

Recibo un error: no se encontró el miembro público 'MyPropertyName' en el tipo 'MyType'.
vldmrrdjcc

30

Gran respuesta de jheddings. Me gustaría mejorarlo permitiendo la referencia de matrices agregadas o colecciones de objetos, para que propertyName pueda ser property1.property2 [X] .property3:

    public static object GetPropertyValue(object srcobj, string propertyName)
    {
        if (srcobj == null)
            return null;

        object obj = srcobj;

        // Split property name to parts (propertyName could be hierarchical, like obj.subobj.subobj.property
        string[] propertyNameParts = propertyName.Split('.');

        foreach (string propertyNamePart in propertyNameParts)
        {
            if (obj == null)    return null;

            // propertyNamePart could contain reference to specific 
            // element (by index) inside a collection
            if (!propertyNamePart.Contains("["))
            {
                PropertyInfo pi = obj.GetType().GetProperty(propertyNamePart);
                if (pi == null) return null;
                obj = pi.GetValue(obj, null);
            }
            else
            {   // propertyNamePart is areference to specific element 
                // (by index) inside a collection
                // like AggregatedCollection[123]
                //   get collection name and element index
                int indexStart = propertyNamePart.IndexOf("[")+1;
                string collectionPropertyName = propertyNamePart.Substring(0, indexStart-1);
                int collectionElementIndex = Int32.Parse(propertyNamePart.Substring(indexStart, propertyNamePart.Length-indexStart-1));
                //   get collection object
                PropertyInfo pi = obj.GetType().GetProperty(collectionPropertyName);
                if (pi == null) return null;
                object unknownCollection = pi.GetValue(obj, null);
                //   try to process the collection as array
                if (unknownCollection.GetType().IsArray)
                {
                    object[] collectionAsArray = unknownCollection as object[];
                    obj = collectionAsArray[collectionElementIndex];
                }
                else
                {
                    //   try to process the collection as IList
                    System.Collections.IList collectionAsList = unknownCollection as System.Collections.IList;
                    if (collectionAsList != null)
                    {
                        obj = collectionAsList[collectionElementIndex];
                    }
                    else
                    {
                        // ??? Unsupported collection type
                    }
                }
            }
        }

        return obj;
    }

¿Qué pasa con una lista de listas a las que accede MasterList [0] [1]?
Jesse Adam

como matriz -> como objeto [] también da como resultado una excepción de referencia nula. Lo que funciona para mí (no es el método más eficiente) es lanzar unknownCollection a IEnumerable y luego usar ToArray () en el resultado. violín
Jeroen Jonkman

14

Si uso el código de Ed S. obtengo

'ReflectionExtensions.GetProperty (Type, string)' es inaccesible debido a su nivel de protección

Parece que GetProperty()no está disponible en Xamarin.Forms. TargetFrameworkProfileesProfile7 en mi Biblioteca de clases portátil (.NET Framework 4.5, Windows 8, ASP.NET Core 1.0, Xamarin.Android, Xamarin.iOS, Xamarin.iOS Classic).

Ahora encontré una solución de trabajo:

using System.Linq;
using System.Reflection;

public static object GetPropValue(object source, string propertyName)
{
    var property = source.GetType().GetRuntimeProperties().FirstOrDefault(p => string.Equals(p.Name, propertyName, StringComparison.OrdinalIgnoreCase));
    return property?.GetValue(source);
}

Fuente


44
Solo una pequeña mejora posible. Reemplace IF y el próximo retorno por: return property? .GetValue (source);
Tomino

11

Sobre la discusión de las propiedades anidadas, puede evitar todo el material de reflexión si usa lo DataBinder.Eval Method (Object, String)siguiente:

var value = DataBinder.Eval(DateTime.Now, "TimeOfDay.Hours");

Por supuesto, necesitará agregar una referencia al System.Webensamblaje, pero esto probablemente no sea gran cosa.


8

El método para llamar ha cambiado en .NET Standard (a partir de 1.6). También podemos usar el operador condicional nulo de C # 6.

using System.Reflection; 
public static object GetPropValue(object src, string propName)
{
    return src.GetType().GetRuntimeProperty(propName)?.GetValue(src);
}

1
para usar el? operator
blfuentes

4

Usando PropertyInfo del espacio de nombres System.Reflection . Reflection compila perfectamente sin importar a qué propiedad intentemos acceder. El error aparecerá durante el tiempo de ejecución.

    public static object GetObjProperty(object obj, string property)
    {
        Type t = obj.GetType();
        PropertyInfo p = t.GetProperty("Location");
        Point location = (Point)p.GetValue(obj, null);
        return location;
    }

Funciona bien para obtener la propiedad Ubicación de un objeto

Label1.Text = GetObjProperty(button1, "Location").ToString();

Obtendremos la ubicación: {X = 71, Y = 27} También podemos devolver location.X o location.Y de la misma manera.


4
public static List<KeyValuePair<string, string>> GetProperties(object item) //where T : class
    {
        var result = new List<KeyValuePair<string, string>>();
        if (item != null)
        {
            var type = item.GetType();
            var properties = type.GetProperties(BindingFlags.Public | BindingFlags.Instance);
            foreach (var pi in properties)
            {
                var selfValue = type.GetProperty(pi.Name).GetValue(item, null);
                if (selfValue != null)
                {
                    result.Add(new KeyValuePair<string, string>(pi.Name, selfValue.ToString()));
                }
                else
                {
                    result.Add(new KeyValuePair<string, string>(pi.Name, null));
                }
            }
        }
        return result;
    }

Esta es una forma de obtener todas las propiedades con sus valores en una Lista.


¿Por qué están haciendo esto: type.GetProperty(pi.Name)cuando eso es == para la variable pi?
weston

Si está utilizando c # 6.0, deshágase ify hágalo selfValue?.ToString()De lo contrario, deshágase ify useselfValue==null?null:selfValue.ToString()
weston

También una lista de List<KeyValuePair<es extraño, use un diccionarioDictionary<string, string>
weston

3

El siguiente código es un método recursivo para mostrar la jerarquía completa de todos los nombres y valores de propiedades contenidos en la instancia de un objeto. Este método utiliza una versión simplificada de la GetPropertyValue()respuesta de AlexD anterior en este hilo. Gracias a este hilo de discusión, ¡pude descubrir cómo hacer esto!

Por ejemplo, uso este método para mostrar una explosión o volcado de todas las propiedades en una WebServicerespuesta llamando al método de la siguiente manera:

PropertyValues_byRecursion("Response", response, false);

public static object GetPropertyValue(object srcObj, string propertyName)
{
  if (srcObj == null) 
  {
    return null; 
  }
  PropertyInfo pi = srcObj.GetType().GetProperty(propertyName.Replace("[]", ""));
  if (pi == null)
  {
    return null;
  }
  return pi.GetValue(srcObj);
}

public static void PropertyValues_byRecursion(string parentPath, object parentObj, bool showNullValues)
{
  /// Processes all of the objects contained in the parent object.
  ///   If an object has a Property Value, then the value is written to the Console
  ///   Else if the object is a container, then this method is called recursively
  ///       using the current path and current object as parameters

  // Note:  If you do not want to see null values, set showNullValues = false

  foreach (PropertyInfo pi in parentObj.GetType().GetTypeInfo().GetProperties())
  {
    // Build the current object property's namespace path.  
    // Recursion extends this to be the property's full namespace path.
    string currentPath = parentPath + "." + pi.Name;

    // Get the selected property's value as an object
    object myPropertyValue = GetPropertyValue(parentObj, pi.Name);
    if (myPropertyValue == null)
    {
      // Instance of Property does not exist
      if (showNullValues)
      {
        Console.WriteLine(currentPath + " = null");
        // Note: If you are replacing these Console.Write... methods callback methods,
        //       consider passing DBNull.Value instead of null in any method object parameters.
      }
    }
    else if (myPropertyValue.GetType().IsArray)
    {
      // myPropertyValue is an object instance of an Array of business objects.
      // Initialize an array index variable so we can show NamespacePath[idx] in the results.
      int idx = 0;
      foreach (object business in (Array)myPropertyValue)
      {
        if (business == null)
        {
          // Instance of Property does not exist
          // Not sure if this is possible in this context.
          if (showNullValues)
          {
            Console.WriteLine(currentPath  + "[" + idx.ToString() + "]" + " = null");
          }
        }
        else if (business.GetType().IsArray)
        {
          // myPropertyValue[idx] is another Array!
          // Let recursion process it.
          PropertyValues_byRecursion(currentPath + "[" + idx.ToString() + "]", business, showNullValues);
        }
        else if (business.GetType().IsSealed)
        {
          // Display the Full Property Path and its Value
          Console.WriteLine(currentPath + "[" + idx.ToString() + "] = " + business.ToString());
        }
        else
        {
          // Unsealed Type Properties can contain child objects.
          // Recurse into my property value object to process its properties and child objects.
          PropertyValues_byRecursion(currentPath + "[" + idx.ToString() + "]", business, showNullValues);
        }
        idx++;
      }
    }
    else if (myPropertyValue.GetType().IsSealed)
    {
      // myPropertyValue is a simple value
      Console.WriteLine(currentPath + " = " + myPropertyValue.ToString());
    }
    else
    {
      // Unsealed Type Properties can contain child objects.
      // Recurse into my property value object to process its properties and child objects.
      PropertyValues_byRecursion(currentPath, myPropertyValue, showNullValues);
    }
  }
}

3
public static TValue GetFieldValue<TValue>(this object instance, string name)
{
    var type = instance.GetType(); 
    var field = type.GetFields(BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance).FirstOrDefault(e => typeof(TValue).IsAssignableFrom(e.FieldType) && e.Name == name);
    return (TValue)field?.GetValue(instance);
}

public static TValue GetPropertyValue<TValue>(this object instance, string name)
{
    var type = instance.GetType();
    var field = type.GetProperties(BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance).FirstOrDefault(e => typeof(TValue).IsAssignableFrom(e.PropertyType) && e.Name == name);
    return (TValue)field?.GetValue(instance);
}

3
public class YourClass
{
    //Add below line in your class
    public object this[string propertyName] => GetType().GetProperty(propertyName)?.GetValue(this, null);
    public string SampleProperty { get; set; }
}

//And you can get value of any property like this.
var value = YourClass["SampleProperty"];

3

El siguiente método funciona perfecto para mí:

class MyClass {
    public string prop1 { set; get; }

    public object this[string propertyName]
    {
        get { return this.GetType().GetProperty(propertyName).GetValue(this, null); }
        set { this.GetType().GetProperty(propertyName).SetValue(this, value, null); }
    }
}

Para obtener el valor de la propiedad:

MyClass t1 = new MyClass();
...
string value = t1["prop1"].ToString();

Para establecer el valor de la propiedad:

t1["prop1"] = value;

2
Dim NewHandle As YourType = CType(Microsoft.VisualBasic.CallByName(ObjectThatContainsYourVariable, "YourVariableName", CallType), YourType)

2

Aquí hay otra forma de encontrar una propiedad anidada que no requiera que la cadena le indique la ruta de anidación. Crédito a Ed S. por el método de propiedad única.

    public static T FindNestedPropertyValue<T, N>(N model, string propName) {
        T retVal = default(T);
        bool found = false;

        PropertyInfo[] properties = typeof(N).GetProperties();

        foreach (PropertyInfo property in properties) {
            var currentProperty = property.GetValue(model, null);

            if (!found) {
                try {
                    retVal = GetPropValue<T>(currentProperty, propName);
                    found = true;
                } catch { }
            }
        }

        if (!found) {
            throw new Exception("Unable to find property: " + propName);
        }

        return retVal;
    }

        public static T GetPropValue<T>(object srcObject, string propName) {
        return (T)srcObject.GetType().GetProperty(propName).GetValue(srcObject, null);
    }

Puede ser mejor verificar si Type.GetPropertyregresa en null lugar de llamar GetValuey haber sido NullReferenceExceptionlanzado en un bucle.
Groo

2

Nunca mencionas qué objeto estás inspeccionando, y dado que estás rechazando los que hacen referencia a un objeto dado, supondré que te refieres a uno estático.

using System.Reflection;
public object GetPropValue(string prop)
{
    int splitPoint = prop.LastIndexOf('.');
    Type type = Assembly.GetEntryAssembly().GetType(prop.Substring(0, splitPoint));
    object obj = null;
    return type.GetProperty(prop.Substring(splitPoint + 1)).GetValue(obj, null);
}

Tenga en cuenta que marqué el objeto que se está inspeccionando con la variable local obj. nullsignifica estático; de lo contrario, configúrelo como desee. También tenga en cuenta que este GetEntryAssembly()es uno de los pocos métodos disponibles para obtener el ensamblaje "en ejecución", es posible que desee jugar con él si tiene dificultades para cargar el tipo.


2

Echa un vistazo a la biblioteca Heleonix.Reflection . Puede obtener / establecer / invocar miembros por rutas, o crear un captador / definidor (lambda compilado en un delegado) que es más rápido que la reflexión. Por ejemplo:

var success = Reflector.Get(DateTime.Now, null, "Date.Year", out int value);

O cree un captador una vez y guarde en caché para su reutilización (esto es más eficiente pero podría arrojar NullReferenceException si un miembro intermedio es nulo):

var getter = Reflector.CreateGetter<DateTime, int>("Date.Year", typeof(DateTime));
getter(DateTime.Now);

O si desea crear uno List<Action<object, object>>de los diferentes captadores, simplemente especifique los tipos base para los delegados compilados (las conversiones de tipos se agregarán a las lambdas compiladas):

var getter = Reflector.CreateGetter<object, object>("Date.Year", typeof(DateTime));
getter(DateTime.Now);

1
nunca use libs de terceros, si puede implementarlo en su propio código en un tiempo razonable en 5-10 líneas.
Artem G

1

camino más corto ...

var a = new Test { Id = 1 , Name = "A" , date = DateTime.Now};
var b = new Test { Id = 1 , Name = "AXXX", date = DateTime.Now };

var compare = string.Join("",a.GetType().GetProperties().Select(x => x.GetValue(a)).ToArray())==
              string.Join("",b.GetType().GetProperties().Select(x => x.GetValue(b)).ToArray());

1

jheddings y AlexD escribieron excelentes respuestas sobre cómo resolver cadenas de propiedades. Me gustaría echar el mío en la mezcla, ya que escribí una biblioteca dedicada exactamente para ese propósito.

La clase principal de Pather.CSharp esResolver. Por defecto, puede resolver propiedades, matrices y entradas de diccionario.

Entonces, por ejemplo, si tienes un objeto como este

var o = new { Property1 = new { Property2 = "value" } };

y quieres conseguirlo Property2, puedes hacerlo así:

IResolver resolver = new Resolver();
var path = "Property1.Property2";
object result = r.Resolve(o, path); 
//=> "value"

Este es el ejemplo más básico de los caminos que puede resolver. Si desea ver qué más puede hacer, o cómo puede extenderlo, simplemente diríjase a su página de Github .


0

Aquí está mi solución. Funciona también con objetos COM y permite acceder a elementos de colección / matriz desde objetos COM.

public static object GetPropValue(this object obj, string name)
{
    foreach (string part in name.Split('.'))
    {
        if (obj == null) { return null; }

        Type type = obj.GetType();
        if (type.Name == "__ComObject")
        {
            if (part.Contains('['))
            {
                string partWithoundIndex = part;
                int index = ParseIndexFromPropertyName(ref partWithoundIndex);
                obj = Versioned.CallByName(obj, partWithoundIndex, CallType.Get, index);
            }
            else
            {
                obj = Versioned.CallByName(obj, part, CallType.Get);
            }
        }
        else
        {
            PropertyInfo info = type.GetProperty(part);
            if (info == null) { return null; }
            obj = info.GetValue(obj, null);
        }
    }
    return obj;
}

private static int ParseIndexFromPropertyName(ref string name)
{
    int index = -1;
    int s = name.IndexOf('[') + 1;
    int e = name.IndexOf(']');
    if (e < s)
    {
        throw new ArgumentException();
    }
    string tmp = name.Substring(s, e - s);
    index = Convert.ToInt32(tmp);
    name = name.Substring(0, s - 1);
    return index;
}

0

Esto es lo que obtuve en base a otras respuestas. Un poco exagerado en ser tan específico con el manejo de errores.

public static T GetPropertyValue<T>(object sourceInstance, string targetPropertyName, bool throwExceptionIfNotExists = false)
{
    string errorMsg = null;

    try
    {
        if (sourceInstance == null || string.IsNullOrWhiteSpace(targetPropertyName))
        {
            errorMsg = $"Source object is null or property name is null or whitespace. '{targetPropertyName}'";
            Log.Warn(errorMsg);

            if (throwExceptionIfNotExists)
                throw new ArgumentException(errorMsg);
            else
                return default(T);
        }

        Type returnType = typeof(T);
        Type sourceType = sourceInstance.GetType();

        PropertyInfo propertyInfo = sourceType.GetProperty(targetPropertyName, returnType);
        if (propertyInfo == null)
        {
            errorMsg = $"Property name '{targetPropertyName}' of type '{returnType}' not found for source object of type '{sourceType}'";
            Log.Warn(errorMsg);

            if (throwExceptionIfNotExists)
                throw new ArgumentException(errorMsg);
            else
                return default(T);
        }

        return (T)propertyInfo.GetValue(sourceInstance, null);
    }
    catch(Exception ex)
    {
        errorMsg = $"Problem getting property name '{targetPropertyName}' from source instance.";
        Log.Error(errorMsg, ex);

        if (throwExceptionIfNotExists)
            throw;
    }

    return default(T);
}
Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.