Làm thế nào liệt kê tất cả các lớp với thuộc tính lớp tùy chỉnh?

Câu hỏi dựa trên ví dụ MSDN .

Giả sử chúng ta có một số lớp C # với HelpAttribution trong ứng dụng máy tính để bàn độc lập. Có thể liệt kê tất cả các lớp với thuộc tính như vậy? Liệu nó có ý nghĩa để nhận ra các lớp học theo cách này? Thuộc tính tùy chỉnh sẽ được sử dụng để liệt kê các tùy chọn menu có thể, chọn mục sẽ đưa đến phiên bản màn hình của lớp đó. Số lượng lớp học / vật phẩm sẽ tăng chậm, nhưng theo cách này chúng ta có thể tránh việc liệt kê tất cả chúng ở nơi khác, tôi nghĩ vậy.

Chắc chắn rồi. Sử dụng sự phản chiếu:

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

Chà, bạn sẽ phải liệt kê tất cả các lớp trong tất cả các hội đồng được tải vào miền ứng dụng hiện tại. Để làm điều đó, bạn sẽ gọi GetAssembliesphương thức trên AppDomainví dụ cho miền ứng dụng hiện tại.

Từ đó, bạn sẽ gọi GetExportedTypes(nếu bạn chỉ muốn các loại công khai) hoặc GetTypestrên mỗi loại Assemblyđể có được các loại có trong hội đồng.

Sau đó, bạn sẽ gọi GetCustomAttributesphương thức mở rộng trên mỗi Typephiên bản, chuyển loại thuộc tính bạn muốn tìm.

Bạn có thể sử dụng LINQ để đơn giản hóa việc này cho bạn:

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

Truy vấn trên sẽ giúp bạn từng loại với thuộc tính của bạn được áp dụng cho nó, cùng với thể hiện của (các) thuộc tính được gán cho nó.

Lưu ý rằng nếu bạn có một số lượng lớn các hội đồng được tải vào miền ứng dụng của bạn, thì thao tác đó có thể tốn kém. Bạn có thể sử dụng Parallel LINQ để giảm thời gian hoạt động, như vậy:

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

Lọc nó trên một cụ thể Assemblylà đơn giản:

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

Và nếu hội đồng có số lượng lớn các loại trong đó, thì bạn có thể sử dụng lại 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>() };

Câu trả lời khác tham khảo GetCustomAttribut . Thêm cái này làm ví dụ về việc sử dụng IsDefined

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

Như đã nêu, phản ánh là con đường để đi. Nếu bạn định gọi nó thường xuyên, tôi khuyên bạn nên lưu trữ kết quả, vì sự phản chiếu, đặc biệt là liệt kê qua mỗi lớp, có thể khá chậm.

Đây là một đoạn mã của tôi chạy qua tất cả các loại trong tất cả các cụm được tải:

// 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.
        }
    }
}

Đây là một cải tiến hiệu suất trên đầu trang của giải pháp được chấp nhận. Lặp lại mặc dù tất cả các lớp có thể chậm vì có rất nhiều. Đôi khi bạn có thể lọc ra toàn bộ lắp ráp mà không cần nhìn vào bất kỳ loại nào.

Ví dụ: nếu bạn đang tìm kiếm một thuộc tính mà bạn tự khai báo, bạn không mong đợi bất kỳ tệp DLL hệ thống nào có chứa bất kỳ loại nào với thuộc tính đó. Thuộc tính Association.GlobalAss lanhCache là một cách nhanh chóng để kiểm tra các DLL hệ thống. Khi tôi thử điều này trên một chương trình thực tế, tôi thấy tôi có thể bỏ qua 30.101 loại và tôi chỉ phải kiểm tra 1.983 loại.

Một cách khác để lọc là sử dụng hội.ReferencedAssemblies. Có lẽ nếu bạn muốn các lớp có thuộc tính cụ thể và thuộc tính đó được xác định trong một hội đồng cụ thể, thì bạn chỉ quan tâm đến tập hợp đó và các tập hợp khác tham chiếu đến nó. Trong các thử nghiệm của tôi, điều này giúp nhiều hơn một chút so với việc kiểm tra thuộc tính GlobalAssuggingCache.

Tôi kết hợp cả hai thứ này và nhận được nó thậm chí còn nhanh hơn. Mã dưới đây bao gồm cả hai bộ lọc.

        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)

Trong trường hợp giới hạn Portable .NET , đoạn mã sau sẽ hoạt động:

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

hoặc cho một số lượng lớn các hội đồng sử dụng dựa trên trạng thái vòng lặp 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;
                }
            }
        }
    }

Chúng tôi có thể cải thiện câu trả lời của Andrew và chuyển đổi toàn bộ nội dung thành một truy vấn LINQ.

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