Прочитайте значение атрибута метода

Question

Мне нужно иметь возможность прочитать значение моего атрибута из моего метода, как я могу это сделать?

[MyAttribute("Hello World")]
public void MyMethod()
{
    // Need to read the MyAttribute attribute and get its value
}

Answer 1

Вам необходимо вызвать функцию GetCustomAttributes для объекта MethodBase.
Самый простой способ получить объект MethodBase - вызвать MethodBase.GetCurrentMethod,(Обратите внимание, что вы должны добавить [MethodImpl(MethodImplOptions.NoInlining)])

Например:

MethodBase method = MethodBase.GetCurrentMethod();
MyAttribute attr = (MyAttribute)method.GetCustomAttributes(typeof(MyAttribute), true)[0] ;
string value = attr.Value;    //Assumes that MyAttribute has a property called Value

Вы также можете получить MethodBase вручную, например так: (Это будет быстрее)

MethodBase method = typeof(MyClass).GetMethod("MyMethod");

Answer 2

[MyAttribute("Hello World")]
public int MyMethod()
{
var myAttribute = GetType().GetMethod("MyMethod").GetCustomAttributes(true).OfType<MyAttribute>().FirstOrDefault();
}

Answer 3

Доступные ответы в основном устарели.

Это текущая лучшая практика:

class MyClass
{

  [MyAttribute("Hello World")]
  public void MyMethod()
  {
    var method = typeof(MyClass).GetRuntimeMethod(nameof(MyClass.MyMethod), new Type[]{});
    var attribute = method.GetCustomAttribute<MyAttribute>();
  }
}

Это не требует кастинга и довольно безопасно для использования.

Вы также можете использовать .GetCustomAttributes<T>, чтобы получить все атрибуты одного типа.

Answer 4

В случае, если вы реализуете настройки, такие как @Mikael Engver, упомянутые выше, и допускаете многократное использование. Вот что вы можете сделать, чтобы получить список всех значений атрибутов.

[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public class TestCase : Attribute
{
    public TestCase(string value)
    {
        Id = value;
    }

    public string Id { get; }        
}   

public static IEnumerable<string> AutomatedTests()
{
    var assembly = typeof(Reports).GetTypeInfo().Assembly;

    var methodInfos = assembly.GetTypes().SelectMany(m => m.GetMethods())
        .Where(x => x.GetCustomAttributes(typeof(TestCase), false).Length > 0);

    foreach (var methodInfo in methodInfos)
    {
        var ids = methodInfo.GetCustomAttributes<TestCase>().Select(x => x.Id);
        yield return $"{string.Join(", ", ids)} - {methodInfo.Name}"; // handle cases when one test is mapped to multiple test cases.
    }
}

Answer 5

Если вы сохраняете значение атрибута по умолчанию в свойстве (Name в моем примере) при создании, тогда вы можете использовать статический вспомогательный метод атрибута:

using System;
using System.Linq;

public class Helper
{
    public static TValue GetMethodAttributeValue<TAttribute, TValue>(Action action, Func<TAttribute, TValue> valueSelector) where TAttribute : Attribute
    {
        var methodInfo = action.Method;
        var attr = methodInfo.GetCustomAttributes(typeof(TAttribute), true).FirstOrDefault() as TAttribute;
        return attr != null ? valueSelector(attr) : default(TValue);
    }
}

Использование:

var name = Helper.GetMethodAttributeValue<MyAttribute, string>(MyMethod, x => x.Name);

Мое решение основано на том, что значение по умолчанию устанавливается при построении атрибута, например:

internal class MyAttribute : Attribute
{
    public string Name { get; set; }

    public MyAttribute(string name)
    {
        Name = name;
    }
}