Отримайте значення властивості з рядка, використовуючи відображення в C #


928

Я намагаюся здійснити перетворення даних, використовуючи приклад Reflection 1 у своєму коді.

У GetSourceValueфункції є комутатор, який порівнює різні типи, але я хочу видалити ці типи та властивості та GetSourceValueотримати значення властивості, використовуючи лише один рядок як параметр. Я хочу передати клас та властивість у рядок та вирішити значення властивості.

Чи можливо це?

1 Версія веб-архіву оригінальної публікації в блозі

Відповіді:


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

Звичайно, ви хочете додати валідацію та інше, але в цьому суть.


8
Приємно і просто! Я хотів би зробити це загальним:public static T GetPropertyValue<T>(object obj, string propName) { return (T)obj.GetType().GetProperty(propName).GetValue(obj, null); }
Охад Шнайдер

2
Оптимізацією можна видалити ризик нульового винятку, як це: " src.GetType().GetProperty(propName)?.GetValue(src, null);";).
shA.t

8
@ shA.t: Я думаю, це погана ідея. Як ви відрізняєте нульове значення існуючої властивості або взагалі немає властивості? Я набагато скоріше відразу зрозумію, що надсилаю неправильне ім’я власності. Це не виробничий код, але кращим вдосконаленням було б кинути більш конкретний виняток (наприклад, перевірити на null GetPropertyі кинути PropertyNotFoundExceptionчи щось, якщо null.)
Ред С.

210

Як щодо щось подібне:

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

Це дозволить вам спуститися до властивостей за допомогою однієї рядка, як це:

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

Ви можете використовувати ці методи як статичні методи або розширення.


3
@FredJand радий, що ти натрапив на нього! Це завжди дивно, коли з’являються ці старі пости. Це було трохи невиразно, тому я додав трохи тексту, щоб пояснити це. Я також перейшов на використання цих методів як методів розширення і додав форму дженерики, тому я додав її тут.
jheddings

Чому нульовий охоронець в передній частині, а не вище?
Сантос

4
@Santhos, оскільки 'obj' переосмислюється в тілі петлі передбачення, він перевіряється під час кожної ітерації.
jheddings

Корисно, але в крайньому випадку, якщо одне з вкладених властивостей може бути приховано (використовуючи "новий" модифікатор), воно викине виняток для пошуку повторюваних властивостей. Було б акуратніше відслідковувати останній тип властивості та використовувати PropertyInfo.PropertyTypeзамість obj.GetType()вкладених властивостей, як і доступ до власності на вкладеній власності.
Нуллій

Ви можете використовувати nameofвираз від C # 6 так: nameof(TimeOfDay.Minutes)у параметрі імені під час виклику функції, щоб позбутися магічних рядків і додати безпеку часу компіляції цим викликам.
Жни

74

Додати до будь-якого 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; }
}

Потім ви можете використовувати як:

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

@EduardoCuomo: Чи можна використовувати роздуми з цим, щоб вам не потрібно було знати, які члени класу мають?
Наша людина в бананах

Чи можливо це зробити, якщо "Бар" був об'єктом?
big_water

@big_water the SetValueі GetValueпрацює з методами Object. Якщо вам потрібно працювати з певним типом, вам слід GetValueнадати результат та надати значення, яке йому присвоїтиSetValue
Едуардо Куомо

Вибачте @OurManinBananas, я не можу зрозуміти ваше запитання. Що ти хочеш робити?
Едуардо Куомо

Як називається метод цього типу ..?
Сахан Чінтхака

45

Що про використання CallByNameв Microsoft.VisualBasicпросторі імен ( Microsoft.VisualBasic.dll)? Він використовує відображення для отримання властивостей, полів і методів звичайних об'єктів, COM-об'єктів і навіть динамічних об'єктів.

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

і потім

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

5
Цікава пропозиція, подальша перевірка показала, що вона може обробляти як поля, так і властивості, COM-об’єкти, і навіть може керувати правильно динамічним зв'язуванням !
IllidanS4 хоче, щоб Моніка повернулася

Я отримую помилку: Публічний член "MyPropertyName" типу "MyType" не знайдено.
vldmrrdjcc

30

Чудова відповідь джеддінга. Я хотів би вдосконалити його, дозволяючи посилатись на агреговані масиви або колекції об'єктів, щоб властивістьName могло бути властивістю1.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;
    }

як щодо списку списків, до якого звертається MasterList [0] [1]?
Джессі Адам

як Array -> як object [] також призводить до виключення Nullreference. Що працює для мене (не найефективніший метод), це передавати unknownCollection в IEnumerable і ніж використовувати ToArray () в результаті. скрипка
Jeroen

14

Якщо я використовую код від Ед С. Я отримую

'ReflectionExtensions.GetProperty (Тип, рядок)' недоступний через рівень захисту

Здається, що GetProperty()це недоступно у Xamarin.Forms. TargetFrameworkProfileє Profile7в моїй бібліотеці портативних класів (.NET Framework 4.5, Windows 8, ASP.NET Core 1.0, Xamarin.Android, Xamarin.iOS, Xamarin.iOS Classic).

Тепер я знайшов робоче рішення:

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

Джерело


4
Просто крихітне можливе поліпшення. Замініть IF та наступне повернення на: return property? .GetValue (джерело);
Томіно

11

Щодо обговорення вкладених властивостей, ви можете уникнути всіх рефлексійних матеріалів, якщо використовувати DataBinder.Eval Method (Object, String)наведене нижче:

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

Звичайно, вам потрібно буде додати посилання на System.Webзбірку, але це, мабуть, не велика справа.


8

Метод виклику змінився в .NET Standard (станом на 1.6). Також ми можемо використовувати нульовий умовний оператор C # 6.

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

1
за використання? operator
blfuentes

4

Використання PropertyInfo простору імен System.Reflection . Роздум збирається просто чудово, незалежно від того, до якої власності ми намагаємося отримати доступ. Помилка з'явиться під час виконання.

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

Це добре працює, щоб отримати властивість Location об'єкта

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

Ми отримаємо місце розташування: {X = 71, Y = 27} Ми також можемо повернути розташування.X або location.Y тим же способом.


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

Це спосіб отримати всі властивості з їх значеннями у списку.


Навіщо це робити: type.GetProperty(pi.Name)коли це == до змінної pi?
weston

Якщо ви використовуєте c # 6.0, позбудьтесь ifі зробіть selfValue?.ToString()інакше позбавлення ifта використанняselfValue==null?null:selfValue.ToString()
weston

Також список List<KeyValuePair<дивних, використовуйте словникDictionary<string, string>
weston

3

Наступний код є рекурсивним методом для відображення всієї ієрархії всіх імен і значень властивостей, що містяться в екземплярі об'єкта. Цей метод використовує GetPropertyValue()у цій темі спрощену версію відповіді AlexD . Завдяки цій темі обговорення я зміг зрозуміти, як це зробити!

Наприклад, я використовую цей метод, щоб показати вибух або скидання всіх властивостей у WebServiceвідповідь, викликаючи метод таким чином:

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

Наведений нижче метод ідеально підходить для мене:

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

Щоб отримати значення властивості:

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

Щоб встановити значення властивості:

t1["prop1"] = value;

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

2

Ось ще один спосіб знайти вкладене властивість, яке не потребує рядку, щоб повідомити вам про вкладений шлях. Кредит Ед С. за метод єдиної власності.

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

Можливо, буде краще перевірити, чи Type.GetPropertyповертається null замість виклику GetValueта NullReferenceExceptionкинув s у циклі.
Груо

2

Ви ніколи не згадуєте, який об’єкт перевіряєте, і оскільки ви відкидаєте ті, на які посилається певний об'єкт, я вважаю, що ви маєте на увазі статичний.

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

Зауважте, що я позначив об'єкт, який перевіряється, локальною змінною obj. nullозначає статичний, інакше встановіть його на те, що ви хочете. Також зауважте, що GetEntryAssembly()це один з небагатьох доступних методів отримання «запущеної» збірки, можливо, ви захочете пограти з нею, якщо вам важко завантажувати тип.


2

Погляньте на бібліотеку Heleonix.Reflection . Ви можете отримати / встановити / викликати членів за допомогою шляхів або створити геттер / сеттер (лямбда, складений у делегата), що швидше, ніж відображення. Наприклад:

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

Або створіть один раз getter і кешуйте для повторного використання (це більш ефективно, але може викинути NullReferenceException, якщо проміжний член недійсний):

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

Або якщо ви хочете створити List<Action<object, object>>різні користувачі, просто вкажіть базові типи для компільованих делегатів (перетворення типів буде додано в компільовані лямбда):

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

1
ніколи не використовуйте сторонні конверти, якщо ви можете реалізувати його у власному коді в розумний час у 5-10 рядках.
Артем Г

1

коротший шлях ....

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 і AlexD написали чудові відповіді про те, як розв’язати рядки властивостей. Мені хотілося б кинути шахту в суміш, оскільки я написав виділену бібліотеку саме для цієї мети.

Основний клас Pather.CSharp - цеResolver. За замовчуванням він може вирішувати властивості, масиви та записи словника.

Так, наприклад, якщо у вас є такий предмет

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

і хочете отримати Property2, ви можете зробити це так:

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

Це найосновніший приклад шляхів, які він може вирішити. Якщо ви хочете побачити, що він ще може, або як ви можете розширити його, просто перейдіть на його сторінку Github .


0

Ось моє рішення. Він також працює з COM-об'єктами і дозволяє отримати доступ до елементів колекції / масиву з 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

Ось що я отримав на основі інших відповідей. Трохи надмірності набути такої специфіки при обробці помилок.

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);
}
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.