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

คำถามที่อยู่บนพื้นฐานของMSDN ตัวอย่างเช่น

สมมติว่าเรามี C # บางคลาสที่มี HelpAttribute ในแอปพลิเคชันเดสก์ทอปแบบสแตนด์อโลน เป็นไปได้หรือไม่ที่จะระบุคลาสทั้งหมดที่มีแอ็ตทริบิวต์ดังกล่าว? มันสมเหตุสมผลไหมที่จะจำคลาสด้วยวิธีนี้? แอตทริบิวต์ที่กำหนดเองจะถูกใช้เพื่อแสดงรายการเมนูที่เป็นไปได้การเลือกรายการจะนำไปสู่หน้าจออินสแตนซ์ของคลาสดังกล่าว จำนวนชั้นเรียน / รายการจะเพิ่มขึ้นอย่างช้า ๆ แต่วิธีนี้เราสามารถหลีกเลี่ยงการแจกแจงพวกเขาทั้งหมดที่อื่นฉันคิดว่า

ใช่แล้ว ใช้การสะท้อน:

static IEnumerable<Type> GetTypesWithHelpAttribute(Assembly assembly) {
    foreach(Type type in assembly.GetTypes()) {
        if (type.GetCustomAttributes(typeof(HelpAttribute), true).Length > 0) {
            yield return type;
        }
    }
}

คุณจะต้องระบุคลาสทั้งหมดในชุดประกอบทั้งหมดที่โหลดลงในโดเมนแอปปัจจุบัน ในการทำเช่นนั้นคุณจะต้องเรียกใช้GetAssembliesเมธอดบนAppDomainอินสแตนซ์ของโดเมนแอปปัจจุบัน

จากนั้นคุณจะโทรGetExportedTypes(ถ้าคุณต้องการประเภทสาธารณะ) หรือGetTypesในแต่ละAssemblyประเภทที่จะได้รับประเภทที่มีอยู่ในการชุมนุม

จากนั้นคุณจะเรียกใช้GetCustomAttributesวิธีการขยายในแต่ละTypeอินสแตนซ์ผ่านประเภทของแอททริบิวที่คุณต้องการค้นหา

คุณสามารถใช้ LINQ เพื่อทำให้สิ่งนี้ง่ายขึ้นสำหรับคุณ:

var typesWithMyAttribute =
    from a in AppDomain.CurrentDomain.GetAssemblies()
    from t in a.GetTypes()
    let attributes = t.GetCustomAttributes(typeof(HelpAttribute), true)
    where attributes != null && attributes.Length > 0
    select new { Type = t, Attributes = attributes.Cast<HelpAttribute>() };

ข้อความค้นหาด้านบนจะให้คุณได้รับคุณลักษณะแต่ละประเภทพร้อมกับแอตทริบิวต์ที่คุณใช้พร้อมกับตัวอย่างของแอตทริบิวต์ที่กำหนดไว้

โปรดทราบว่าถ้าคุณมีแอสเซมบลีจำนวนมากโหลดลงในโดเมนแอปพลิเคชันของคุณการดำเนินการนั้นอาจมีราคาแพง คุณสามารถใช้Parallel LINQเพื่อลดเวลาของการดำเนินการเช่น:

var typesWithMyAttribute =
    // Note the AsParallel here, this will parallelize everything after.
    from a in AppDomain.CurrentDomain.GetAssemblies().AsParallel()
    from t in a.GetTypes()
    let attributes = t.GetCustomAttributes(typeof(HelpAttribute), true)
    where attributes != null && attributes.Length > 0
    select new { Type = t, Attributes = attributes.Cast<HelpAttribute>() };

การกรองเฉพาะเจาะจงAssemblyนั้นง่าย:

Assembly assembly = ...;

var typesWithMyAttribute =
    from t in assembly.GetTypes()
    let attributes = t.GetCustomAttributes(typeof(HelpAttribute), true)
    where attributes != null && attributes.Length > 0
    select new { Type = t, Attributes = attributes.Cast<HelpAttribute>() };

และถ้าแอสเซมบลีมีชนิดจำนวนมากอยู่ในนั้นคุณสามารถใช้ Parallel LINQ อีกครั้ง:

Assembly assembly = ...;

var typesWithMyAttribute =
    // Partition on the type list initially.
    from t in assembly.GetTypes().AsParallel()
    let attributes = t.GetCustomAttributes(typeof(HelpAttribute), true)
    where attributes != null && attributes.Length > 0
    select new { Type = t, Attributes = attributes.Cast<HelpAttribute>() };

คำตอบอื่น ๆ อ้างอิงGetCustomAttributes การเพิ่มอันนี้เป็นตัวอย่างของการใช้IsDefined

Assembly assembly = ...
var typesWithHelpAttribute = 
        from type in assembly.GetTypes()
        where type.IsDefined(typeof(HelpAttribute), false)
        select type;

ดังที่ได้กล่าวไปแล้วการสะท้อนกลับเป็นหนทางไป หากคุณกำลังจะเรียกสิ่งนี้บ่อยครั้งฉันขอแนะนำให้แคชผลลัพธ์เป็นอย่างดีเนื่องจากการสะท้อนโดยเฉพาะอย่างยิ่งการแจกแจงผ่านทุกชั้นเรียนนั้นค่อนข้างช้า

นี่เป็นตัวอย่างรหัสของฉันที่ทำงานผ่านทุกประเภทในชุดประกอบที่โหลดทั้งหมด:

// this is making the assumption that all assemblies we need are already loaded.
foreach (Assembly assembly in AppDomain.CurrentDomain.GetAssemblies()) 
{
    foreach (Type type in assembly.GetTypes())
    {
        var attribs = type.GetCustomAttributes(typeof(MyCustomAttribute), false);
        if (attribs != null && attribs.Length > 0)
        {
            // add to a cache.
        }
    }
}

นี่คือการปรับปรุงประสิทธิภาพที่เหนือกว่าโซลูชันที่ได้รับการยอมรับ การทำซ้ำแม้ว่าคลาสทั้งหมดจะช้าเพราะมีจำนวนมาก บางครั้งคุณสามารถกรองแอสเซมบลีทั้งหมดโดยไม่ดูประเภทใด ๆ

ตัวอย่างเช่นหากคุณกำลังมองหาแอททริบิวที่คุณประกาศด้วยตัวคุณเองคุณไม่คาดหวังว่า DLLs ของระบบจะมีประเภทใด ๆ ที่มีแอททริบิวต์นั้นอยู่ กระบวนการ Assembly.GlobalAssemblyCache คุณสมบัติเป็นวิธีที่รวดเร็วในการตรวจสอบ DLLs ระบบ เมื่อฉันลองสิ่งนี้ในโปรแกรมจริงฉันพบว่าฉันสามารถข้ามประเภท 30,101 และฉันต้องตรวจสอบ 1,983 ประเภทเท่านั้น

อีกวิธีในการกรองคือการใช้ Assembly.ReferencedAssemblies สมมุติว่าคุณต้องการคลาสที่มีแอ็ตทริบิวต์เฉพาะและแอ็ตทริบิวต์นั้นถูกกำหนดไว้ในชุดประกอบที่เฉพาะเจาะจงดังนั้นคุณจะสนใจเฉพาะชุดประกอบนั้นและชุดประกอบอื่น ๆ ที่อ้างอิง ในการทดสอบของฉันสิ่งนี้ช่วยได้มากกว่าการตรวจสอบคุณสมบัติ GlobalAssemblyCache เล็กน้อย

ฉันรวมทั้งสองอย่างเข้าด้วยกันและทำให้มันเร็วยิ่งขึ้น รหัสด้านล่างมีตัวกรองทั้งสอง

        string definedIn = typeof(XmlDecoderAttribute).Assembly.GetName().Name;
        foreach (Assembly assembly in AppDomain.CurrentDomain.GetAssemblies())
            // Note that we have to call GetName().Name.  Just GetName() will not work.  The following
            // if statement never ran when I tried to compare the results of GetName().
            if ((!assembly.GlobalAssemblyCache) && ((assembly.GetName().Name == definedIn) || assembly.GetReferencedAssemblies().Any(a => a.Name == definedIn)))
                foreach (Type type in assembly.GetTypes())
                    if (type.GetCustomAttributes(typeof(XmlDecoderAttribute), true).Length > 0)

ในกรณีที่มีข้อ จำกัด Portable .NETรหัสต่อไปนี้ควรใช้งานได้:

    public static IEnumerable<TypeInfo> GetAtributedTypes( Assembly[] assemblies, 
                                                           Type attributeType )
    {
        var typesAttributed =
            from assembly in assemblies
            from type in assembly.DefinedTypes
            where type.IsDefined(attributeType, false)
            select type;
        return typesAttributed;
    }

หรือสำหรับแอสเซมบลีจำนวนมากที่ใช้การวนรอบสถานะyield return:

    public static IEnumerable<TypeInfo> GetAtributedTypes( Assembly[] assemblies, 
                                                           Type attributeType )
    {
        foreach (var assembly in assemblies)
        {
            foreach (var typeInfo in assembly.DefinedTypes)
            {
                if (typeInfo.IsDefined(attributeType, false))
                {
                    yield return typeInfo;
                }
            }
        }
    }

เราสามารถปรับปรุงคำตอบของแอนดรูว์และแปลงข้อมูลทั้งหมดให้เป็นหนึ่งคำสั่ง LINQ

    public static IEnumerable<Type> GetTypesWithHelpAttribute(Assembly assembly)
    {
        return assembly.GetTypes().Where(type => type.GetCustomAttributes(typeof(HelpAttribute), true).Length > 0);
    }