ฉันจะอ่านแอตทริบิวต์บนคลาสที่รันไทม์ได้อย่างไร


107

ฉันกำลังพยายามสร้างวิธีการทั่วไปที่จะอ่านแอตทริบิวต์ในคลาสและส่งคืนค่านั้นที่รันไทม์ ฉันจะทำอย่างไร

หมายเหตุ: แอตทริบิวต์ DomainName เป็นของคลาส DomainNameAttribute

[DomainName("MyTable")]
Public class MyClass : DomainBase
{}

สิ่งที่ฉันพยายามสร้าง:

//This should return "MyTable"
String DomainNameValue = GetDomainName<MyClass>();

1
ลิงก์ Microsoft อย่างเป็นทางการ: msdn.microsoft.com/en-us/library/71s1zwct.aspx
Mahesh

2
คำถามข้อพิสูจน์ที่สำคัญวิธีรับทุกประเภทในการประกอบด้วยแอตทริบิวต์ที่กำหนดเองstackoverflow.com/questions/2656189/…
Chris Marisic

คำตอบ:


237
public string GetDomainName<T>()
{
    var dnAttribute = typeof(T).GetCustomAttributes(
        typeof(DomainNameAttribute), true
    ).FirstOrDefault() as DomainNameAttribute;
    if (dnAttribute != null)
    {
        return dnAttribute.Name;
    }
    return null;
}

อัพเดท:

วิธีนี้สามารถสรุปเพิ่มเติมเพื่อใช้กับแอตทริบิวต์ใด ๆ :

public static class AttributeExtensions
{
    public static TValue GetAttributeValue<TAttribute, TValue>(
        this Type type, 
        Func<TAttribute, TValue> valueSelector) 
        where TAttribute : Attribute
    {
        var att = type.GetCustomAttributes(
            typeof(TAttribute), true
        ).FirstOrDefault() as TAttribute;
        if (att != null)
        {
            return valueSelector(att);
        }
        return default(TValue);
    }
}

และใช้สิ่งนี้:

string name = typeof(MyClass)
    .GetAttributeValue((DomainNameAttribute dna) => dna.Name);

6
ขอบคุณสำหรับความขยันในการตอบคำถาม!
Zaffiro

1
วิธีการขยายนี้สามารถอธิบายได้ทั่วไปเพิ่มเติมโดยการขยาย MemberInfo คลาสพื้นฐานของ Type และสมาชิกทั้งหมดหรืออย่างน้อยที่สุด - ส่วนใหญ่ การทำเช่นนี้จะเปิดขึ้นเพื่ออนุญาตให้อ่านแอตทริบิวต์จาก Properties, Fields และแม้แต่ Events
M.Babcock

4
ซับซ้อนเกินไป ไม่จำเป็นต้องใช้แลมด้าเพื่อเลือกค่าแอตทริบิวต์ ถ้าคุณเขียนแลมด้าได้เพียงพอคุณก็รู้เพียงพอที่จะเข้าถึงฟิลด์
Darrel Lee

ฉันจะขยายแนวทางนี้เพื่อให้const Filedอยู่ในคลาสคงที่ได้อย่างไร
Amir

51

มีส่วนขยายให้ทำอยู่แล้ว

namespace System.Reflection
{
    // Summary:
    //     Contains static methods for retrieving custom attributes.
    public static class CustomAttributeExtensions
    {
        public static T GetCustomAttribute<T>(this MemberInfo element, bool inherit) where T : Attribute;
    }
}

ดังนั้น:

var attr = typeof(MyClass).GetCustomAttribute<DomainNameAttribute>(false);
return attr != null ? attr.DomainName : "";

1
จริง. แต่เฉพาะ. NET 4.5 และใหม่กว่า ฉันยังคงพัฒนารหัสห้องสมุดซึ่งฉันไม่สามารถใช้วิธีนี้ได้ :(
andreas

15
System.Reflection.MemberInfo info = typeof(MyClass);
object[] attributes = info.GetCustomAttributes(true);

for (int i = 0; i < attributes.Length; i++)
{
    if (attributes[i] is DomainNameAttribute)
    {
        System.Console.WriteLine(((DomainNameAttribute) attributes[i]).Name);
    }   
}

5
และ +1 สำหรับการไม่ใช้ "var" ดังนั้นจึงเป็นเรื่องง่ายที่จะเข้าใจวิธีการทำงาน
RenniePet

มันไม่ได้รวบรวม แต่ "System.Reflection.MemberInfo info = typeof (MyClass) .GetTypeInfo ();" ทำ
Marcel James

4

ฉันใช้คำตอบของ Darin Dimitrov เพื่อสร้างส่วนขยายทั่วไปเพื่อรับแอตทริบิวต์สมาชิกสำหรับสมาชิกใด ๆ ในคลาส (แทนที่จะเป็นแอตทริบิวต์สำหรับคลาส) ฉันโพสต์ไว้ที่นี่เพราะคนอื่นอาจเห็นว่ามีประโยชน์:

public static class AttributeExtensions
{
    /// <summary>
    /// Returns the value of a member attribute for any member in a class.
    ///     (a member is a Field, Property, Method, etc...)    
    /// <remarks>
    /// If there is more than one member of the same name in the class, it will return the first one (this applies to overloaded methods)
    /// </remarks>
    /// <example>
    /// Read System.ComponentModel Description Attribute from method 'MyMethodName' in class 'MyClass': 
    ///     var Attribute = typeof(MyClass).GetAttribute("MyMethodName", (DescriptionAttribute d) => d.Description);
    /// </example>
    /// <param name="type">The class that contains the member as a type</param>
    /// <param name="MemberName">Name of the member in the class</param>
    /// <param name="valueSelector">Attribute type and property to get (will return first instance if there are multiple attributes of the same type)</param>
    /// <param name="inherit">true to search this member's inheritance chain to find the attributes; otherwise, false. This parameter is ignored for properties and events</param>
    /// </summary>    
    public static TValue GetAttribute<TAttribute, TValue>(this Type type, string MemberName, Func<TAttribute, TValue> valueSelector, bool inherit = false) where TAttribute : Attribute
    {
        var att = type.GetMember(MemberName).FirstOrDefault().GetCustomAttributes(typeof(TAttribute), inherit).FirstOrDefault() as TAttribute;
        if (att != null)
        {
            return valueSelector(att);
        }
        return default(TValue);
    }
}

ตัวอย่างการใช้งาน:

//Read System.ComponentModel Description Attribute from method 'MyMethodName' in class 'MyClass'
var Attribute = typeof(MyClass).GetAttribute("MyMethodName", (DescriptionAttribute d) => d.Description);

การสืบทอดใช้ไม่ได้กับคุณสมบัติที่ได้รับ - ดังนั้นคุณจะต้องเรียกวิธีการคงที่แยกต่างหาก (System.Attribute.GetCustomAttributes) stackoverflow.com/a/7175762/184910
murraybiscuit

3

โซลูชันแรกของ Darin Dimitrov เวอร์ชันที่เรียบง่าย:

public string GetDomainName<T>()
{
    var dnAttribute = typeof(T).GetCustomAttribute<DomainNameAttribute>(true);
    if (dnAttribute != null)
    {
        return dnAttribute.Name;
    }
    return null;
}

0
' Simplified Generic version. 
Shared Function GetAttribute(Of TAttribute)(info As MemberInfo) As TAttribute
    Return info.GetCustomAttributes(GetType(TAttribute), _
                                    False).FirstOrDefault()
End Function

' Example usage over PropertyInfo
Dim fieldAttr = GetAttribute(Of DataObjectFieldAttribute)(pInfo)
If fieldAttr IsNot Nothing AndAlso fieldAttr.PrimaryKey Then
    keys.Add(pInfo.Name)
End If

อาจเป็นเรื่องง่ายที่จะใช้เนื้อหาของฟังก์ชันทั่วไปแบบอินไลน์ มันไม่สมเหตุสมผลสำหรับฉันที่จะทำให้ฟังก์ชันทั่วไปเหนือประเภท MyClass

string DomainName = GetAttribute<DomainNameAttribute>(typeof(MyClass)).Name
// null reference exception if MyClass doesn't have the attribute.

0

ในกรณีที่ใครก็ตามต้องการผลลัพธ์ที่เป็นโมฆะและเพื่อให้สิ่งนี้ใช้ได้กับ Enums, PropertyInfo และคลาสนี่คือวิธีที่ฉันแก้ไข นี่คือการปรับเปลี่ยนโซลูชันที่ปรับปรุงแล้วของ Darin Dimitrov

public static object GetAttributeValue<TAttribute, TValue>(this object val, Func<TAttribute, TValue> valueSelector) where TAttribute : Attribute
{
    try
    {
        Type t = val.GetType();
        TAttribute attr;
        if (t.IsEnum && t.GetField(val.ToString()).GetCustomAttributes(typeof(TAttribute), true).FirstOrDefault() is TAttribute att)
        {
            // Applies to Enum values
            attr = att;
        }
        else if (val is PropertyInfo pi && pi.GetCustomAttributes(typeof(TAttribute), true).FirstOrDefault() is TAttribute piAtt)
        {
            // Applies to Properties in a Class
            attr = piAtt;
        }
        else
        {
            // Applies to classes
            attr = (TAttribute)t.GetCustomAttributes(typeof(TAttribute), false).FirstOrDefault();
        }
        return valueSelector(attr);
    }
    catch
    {
        return null;
    }
}

ตัวอย่างการใช้งาน:

// Class
SettingsEnum.SettingGroup settingGroup = (SettingsEnum.SettingGroup)(this.GetAttributeValue((SettingGroupAttribute attr) => attr.Value) as SettingsEnum.SettingGroup?);

// Enum
DescriptionAttribute desc = settingGroup.GetAttributeValue((DescriptionAttribute attr) => attr) as DescriptionAttribute;

// PropertyInfo       
foreach (PropertyInfo pi in this.GetType().GetProperties())
{
    string setting = ((SettingsEnum.SettingName)(pi.GetAttributeValue((SettingNameAttribute attr) => attr.Value) as SettingsEnum.SettingName?)).ToString();
}

0

จากนั้นเขียนโค้ดจำนวนมากเพียงทำสิ่งนี้:

{         
   dynamic tableNameAttribute = typeof(T).CustomAttributes.FirstOrDefault().ToString();
   dynamic tableName = tableNameAttribute.Substring(tableNameAttribute.LastIndexOf('.'), tableNameAttribute.LastIndexOf('\\'));    
}

0

เมื่อคุณมีวิธีการลบล้างที่มีชื่อเดียวกันให้ใช้ตัวช่วยด้านล่าง

public static TValue GetControllerMethodAttributeValue<T, TT, TAttribute, TValue>(this T type, Expression<Func<T, TT>> exp, Func<TAttribute, TValue> valueSelector) where TAttribute : Attribute
        {
            var memberExpression = exp?.Body as MethodCallExpression;

            if (memberExpression.Method.GetCustomAttributes(typeof(TAttribute), false).FirstOrDefault() is TAttribute attr && valueSelector != null)
            {
                return valueSelector(attr);
            }

            return default(TValue);
        }

การใช้งาน: var someController = SomeController ใหม่ (บางพารามิเตอร์); var str = typeof (SomeController) .GetControllerMethodAttributeValue (x => someController.SomeMethod (It.IsAny ()), (RouteAttribute routeAttribute) => routeAttribute.Template);

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.