Чи може клас C # успадковувати атрибути з його інтерфейсу?


114

Здається, це означає «ні». Що прикро.

[AttributeUsage(AttributeTargets.Interface | AttributeTargets.Class,
 AllowMultiple = true, Inherited = true)]
public class CustomDescriptionAttribute : Attribute
{
    public string Description { get; private set; }

    public CustomDescriptionAttribute(string description)
    {
        Description = description;
    }
}

[CustomDescription("IProjectController")]
public interface IProjectController
{
    void Create(string projectName);
}

internal class ProjectController : IProjectController
{
    public void Create(string projectName)
    {
    }
}

[TestFixture]
public class CustomDescriptionAttributeTests
{
    [Test]
    public void ProjectController_ShouldHaveCustomDescriptionAttribute()
    {
        Type type = typeof(ProjectController);
        object[] attributes = type.GetCustomAttributes(
            typeof(CustomDescriptionAttribute),
            true);

        // NUnit.Framework.AssertionException:   Expected: 1   But was:  0
        Assert.AreEqual(1, attributes.Length);
    }
}

Чи може клас успадкувати атрибути з інтерфейсу? Або я тут лаю неправильне дерево?

Відповіді:


73

Ні. Щоразу, коли реалізується інтерфейс або переосмислюються члени у похідному класі, вам потрібно повторно оголосити атрибути.

Якщо ви дбаєте лише про ComponentModel (не пряме відображення), є спосіб ([AttributeProvider] ) запропонувати атрибути з існуючого типу (щоб уникнути дублювання), але він дійсний лише для використання властивостей та індексатора.

Як приклад:

using System;
using System.ComponentModel;
class Foo {
    [AttributeProvider(typeof(IListSource))]
    public object Bar { get; set; }

    static void Main() {
        var bar = TypeDescriptor.GetProperties(typeof(Foo))["Bar"];
        foreach (Attribute attrib in bar.Attributes) {
            Console.WriteLine(attrib);
        }
    }
}

Виходи:

System.SerializableAttribute
System.ComponentModel.AttributeProviderAttribute
System.ComponentModel.EditorAttribute
System.Runtime.InteropServices.ComVisibleAttribute
System.Runtime.InteropServices.ClassInterfaceAttribute
System.ComponentModel.TypeConverterAttribute
System.ComponentModel.MergablePropertyAttribute

Ви впевнені в цьому? Метод MemberInfo.GetCustomAttributes бере аргумент, який вказує, чи слід шукати дерево спадкування.
Rune Grimstad

3
Хм. Я щойно помітив, що питання стосується спадкування атрибутів з інтерфейсу, а не від базового класу.
Руна Грімстад

Чи є тоді причина розміщувати атрибути на інтерфейсах?
Ryan Penfold

5
@Ryan - впевнений: для опису інтерфейсу. Наприклад, договори на обслуговування.
Marc Gravell

3
Марк (і @Rune): Так, OP стосувався інтерфейсів. Але перше речення вашої відповіді може бути заплутаним: "... або переосмислені члени у похідному класі ..." - це не обов'язково вірно. Ви можете мати спадкові атрибути свого класу з його базового класу. Ви не можете цього робити лише з інтерфейсами. Дивіться також: stackoverflow.com/questions/12106566 / ...
chiccodoro

39

Ви можете визначити корисний метод розширення ...

Type type = typeof(ProjectController);
var attributes = type.GetCustomAttributes<CustomDescriptionAttribute>( true );

Ось метод розширення:

/// <summary>Searches and returns attributes. The inheritance chain is not used to find the attributes.</summary>
/// <typeparam name="T">The type of attribute to search for.</typeparam>
/// <param name="type">The type which is searched for the attributes.</param>
/// <returns>Returns all attributes.</returns>
public static T[] GetCustomAttributes<T>( this Type type ) where T : Attribute
{
  return GetCustomAttributes( type, typeof( T ), false ).Select( arg => (T)arg ).ToArray();
}

/// <summary>Searches and returns attributes.</summary>
/// <typeparam name="T">The type of attribute to search for.</typeparam>
/// <param name="type">The type which is searched for the attributes.</param>
/// <param name="inherit">Specifies whether to search this member's inheritance chain to find the attributes. Interfaces will be searched, too.</param>
/// <returns>Returns all attributes.</returns>
public static T[] GetCustomAttributes<T>( this Type type, bool inherit ) where T : Attribute
{
  return GetCustomAttributes( type, typeof( T ), inherit ).Select( arg => (T)arg ).ToArray();
}

/// <summary>Private helper for searching attributes.</summary>
/// <param name="type">The type which is searched for the attribute.</param>
/// <param name="attributeType">The type of attribute to search for.</param>
/// <param name="inherit">Specifies whether to search this member's inheritance chain to find the attribute. Interfaces will be searched, too.</param>
/// <returns>An array that contains all the custom attributes, or an array with zero elements if no attributes are defined.</returns>
private static object[] GetCustomAttributes( Type type, Type attributeType, bool inherit )
{
  if( !inherit )
  {
    return type.GetCustomAttributes( attributeType, false );
  }

  var attributeCollection = new Collection<object>();
  var baseType = type;

  do
  {
    baseType.GetCustomAttributes( attributeType, true ).Apply( attributeCollection.Add );
    baseType = baseType.BaseType;
  }
  while( baseType != null );

  foreach( var interfaceType in type.GetInterfaces() )
  {
    GetCustomAttributes( interfaceType, attributeType, true ).Apply( attributeCollection.Add );
  }

  var attributeArray = new object[attributeCollection.Count];
  attributeCollection.CopyTo( attributeArray, 0 );
  return attributeArray;
}

/// <summary>Applies a function to every element of the list.</summary>
private static void Apply<T>( this IEnumerable<T> enumerable, Action<T> function )
{
  foreach( var item in enumerable )
  {
    function.Invoke( item );
  }
}

Оновлення:

Ось більш коротка версія, запропонована SimonD у коментарі:

private static IEnumerable<T> GetCustomAttributesIncludingBaseInterfaces<T>(this Type type)
{
  var attributeType = typeof(T);
  return type.GetCustomAttributes(attributeType, true).
    Union(type.GetInterfaces().
    SelectMany(interfaceType => interfaceType.GetCustomAttributes(attributeType, true))).
    Distinct().Cast<T>();
}

1
Це отримує лише атрибути рівня типу, а не властивості, поля чи члени, правда?
Маслоу

22
дуже добре, я особисто використовую більш коротку версію цього, зараз: приватний статичний IEnumerable <T> GetCustomAttributesIncludingBaseInterfaces <T> (тип цього типу) {var attributeType = typeof (T); return type.GetCustomAttributes (attributeType, true) .Union (type.GetInterfaces (). SelectMany (interfaceType => interfaceType.GetCustomAttributes (attributeType, true))). Distinct (). Cast <T> (); }
Саймон Д.

1
@SimonD. І ваше відновлене рішення швидше.
mynkow

1
@SimonD на це варто було відповісти замість коментаря.
Нік Н.

Чи є якісь причини не замінити Applyвбудований ForEachзMicrosoft.Practices.ObjectBuilder2
Джейкоб Брюер

29

Стаття Бреда Вілсона про це: Атрибути інтерфейсу! = Атрибути класу

Підводячи підсумок: класи не успадковують інтерфейси, вони реалізують їх. Це означає, що атрибути не є автоматично частиною реалізації.

Якщо вам потрібно успадкувати атрибути, використовуйте абстрактний базовий клас, а не інтерфейс.


Що робити, якщо у вас є кілька інтерфейсів, які ви реалізуєте? Ви не можете просто змінити ці інтерфейси в абстрактні класи, оскільки C # не вистачає в категорії множинного успадкування.
Енді

10

Хоча клас C # не успадковує атрибути зі своїх інтерфейсів, є корисна альтернатива при прив'язці моделей в ASP.NET MVC3.

Якщо ви визначите, що модель перегляду є інтерфейсом, а не конкретним типом, то вигляд і зв'язувач моделі застосовуватимуть атрибути (наприклад, [Required]або [DisplayName("Foo")]з інтерфейсу під час надання та перевірки моделі:

public interface IModel {
    [Required]
    [DisplayName("Foo Bar")]
    string FooBar { get; set; }
} 

public class Model : IModel {
    public string FooBar { get; set; }
}

Тоді у вікні:

@* Note use of interface type for the view model *@
@model IModel 

@* This control will receive the attributes from the interface *@
@Html.EditorFor(m => m.FooBar)

4

Це більше для людей, які хочуть отримати атрибути з властивостей, які можуть існувати на реалізованому інтерфейсі. Оскільки ці атрибути не входять до класу, це дасть вам доступ до них. Зауважте, у мене простий клас контейнерів, який дає вам доступ до PropertyInfo - тому що для цього я був потрібний. Рубайте, як вам потрібно. Це добре спрацювало для мене.

public static class CustomAttributeExtractorExtensions
{
    /// <summary>
    /// Extraction of property attributes as well as attributes on implemented interfaces.
    /// This will walk up recursive to collect any interface attribute as well as their parent interfaces.
    /// </summary>
    /// <typeparam name="TAttributeType"></typeparam>
    /// <param name="typeToReflect"></param>
    /// <returns></returns>
    public static List<PropertyAttributeContainer<TAttributeType>> GetPropertyAttributesFromType<TAttributeType>(this Type typeToReflect)
        where TAttributeType : Attribute
    {
        var list = new List<PropertyAttributeContainer<TAttributeType>>();

        // Loop over the direct property members
        var properties = typeToReflect.GetProperties();

        foreach (var propertyInfo in properties)
        {
            // Get the attributes as well as from the inherited classes (true)
            var attributes = propertyInfo.GetCustomAttributes<TAttributeType>(true).ToList();
            if (!attributes.Any()) continue;

            list.AddRange(attributes.Select(attr => new PropertyAttributeContainer<TAttributeType>(attr, propertyInfo)));
        }

        // Look at the type interface declarations and extract from that type.
        var interfaces = typeToReflect.GetInterfaces();

        foreach (var @interface in interfaces)
        {
            list.AddRange(@interface.GetPropertyAttributesFromType<TAttributeType>());
        }

        return list;

    }

    /// <summary>
    /// Simple container for the Property and Attribute used. Handy if you want refrence to the original property.
    /// </summary>
    /// <typeparam name="TAttributeType"></typeparam>
    public class PropertyAttributeContainer<TAttributeType>
    {
        internal PropertyAttributeContainer(TAttributeType attribute, PropertyInfo property)
        {
            Property = property;
            Attribute = attribute;
        }

        public PropertyInfo Property { get; private set; }

        public TAttributeType Attribute { get; private set; }
    }
}

0

EDIT: це стосується успадковуючих атрибутів з інтерфейсів членів (включаючи властивості). Вище наведені прості відповіді для визначення типів. Я щойно опублікував це, бо вважав, що це дратує обмеження і хотів поділитися рішенням :)

Інтерфейси є багаторазовим успадкуванням і ведуть себе як спадкування в системі типів. Немає вагомих причин для подібних матеріалів. Рефлексія - трохи хокей. Я додав коментарі для пояснення дурниць.

(Це .NET 3.5, тому що це просто так, що використовується проектом, який я зараз роблю.)

// in later .NETs, you can cache reflection extensions using a static generic class and
// a ConcurrentDictionary. E.g.
//public static class Attributes<T> where T : Attribute
//{
//    private static readonly ConcurrentDictionary<MemberInfo, IReadOnlyCollection<T>> _cache =
//        new ConcurrentDictionary<MemberInfo, IReadOnlyCollection<T>>();
//
//    public static IReadOnlyCollection<T> Get(MemberInfo member)
//    {
//        return _cache.GetOrAdd(member, GetImpl, Enumerable.Empty<T>().ToArray());
//    }
//    //GetImpl as per code below except that recursive steps re-enter via the cache
//}

public static List<T> GetAttributes<T>(this MemberInfo member) where T : Attribute
{
    // determine whether to inherit based on the AttributeUsage
    // you could add a bool parameter if you like but I think it defeats the purpose of the usage
    var usage = typeof(T).GetCustomAttributes(typeof(AttributeUsageAttribute), true)
        .Cast<AttributeUsageAttribute>()
        .FirstOrDefault();
    var inherit = usage != null && usage.Inherited;

    return (
        inherit
            ? GetAttributesRecurse<T>(member)
            : member.GetCustomAttributes(typeof (T), false).Cast<T>()
        )
        .Distinct()  // interfaces mean duplicates are a thing
        // note: attribute equivalence needs to be overridden. The default is not great.
        .ToList();
}

private static IEnumerable<T> GetAttributesRecurse<T>(MemberInfo member) where T : Attribute
{
    // must use Attribute.GetCustomAttribute rather than MemberInfo.GetCustomAttribute as the latter
    // won't retrieve inherited attributes from base *classes*
    foreach (T attribute in Attribute.GetCustomAttributes(member, typeof (T), true))
        yield return attribute;

    // The most reliable target in the interface map is the property get method.
    // If you have set-only properties, you'll need to handle that case. I generally just ignore that
    // case because it doesn't make sense to me.
    PropertyInfo property;
    var target = (property = member as PropertyInfo) != null ? property.GetGetMethod() : member;

    foreach (var @interface in member.DeclaringType.GetInterfaces())
    {
        // The interface map is two aligned arrays; TargetMethods and InterfaceMethods.
        var map = member.DeclaringType.GetInterfaceMap(@interface);
        var memberIndex = Array.IndexOf(map.TargetMethods, target); // see target above
        if (memberIndex < 0) continue;

        // To recurse, we still need to hit the property on the parent interface.
        // Why don't we just use the get method from the start? Because GetCustomAttributes won't work.
        var interfaceMethod = property != null
            // name of property get method is get_<property name>
            // so name of parent property is substring(4) of that - this is reliable IME
            ? @interface.GetProperty(map.InterfaceMethods[memberIndex].Name.Substring(4))
            : (MemberInfo) map.InterfaceMethods[memberIndex];

        // Continuation is the word to google if you don't understand this
        foreach (var attribute in interfaceMethod.GetAttributes<T>())
            yield return attribute;
    }
}

Тест на боребони NUnit

[TestFixture]
public class GetAttributesTest
{
    [AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = true)]
    private sealed class A : Attribute
    {
        // default equality for Attributes is apparently semantic
        public override bool Equals(object obj)
        {
            return ReferenceEquals(this, obj);
        }

        public override int GetHashCode()
        {
            return base.GetHashCode();
        }
    }

    [AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = false)]
    private sealed class ANotInherited : Attribute { }

    public interface Top
    {
        [A, ANotInherited]
        void M();

        [A, ANotInherited]
        int P { get; }
    }

    public interface Middle : Top { }

    private abstract class Base
    {
        [A, ANotInherited]
        public abstract void M();

        [A, ANotInherited]
        public abstract int P { get; }
    }

    private class Bottom : Base, Middle
    {
        [A, ANotInherited]
        public override void M()
        {
            throw new NotImplementedException();
        }

        [A, ANotInherited]
        public override int P { get { return 42; } }
    }

    [Test]
    public void GetsAllInheritedAttributesOnMethods()
    {
        var attributes = typeof (Bottom).GetMethod("M").GetAttributes<A>();
        attributes.Should()
            .HaveCount(3, "there are 3 inherited copies in the class heirarchy and A is inherited");
    }

    [Test]
    public void DoesntGetNonInheritedAttributesOnMethods()
    {
        var attributes = typeof (Bottom).GetMethod("M").GetAttributes<ANotInherited>();
        attributes.Should()
            .HaveCount(1, "it shouldn't get copies of the attribute from base classes for a non-inherited attribute");
    }

    [Test]
    public void GetsAllInheritedAttributesOnProperties()
    {
        var attributes = typeof(Bottom).GetProperty("P").GetAttributes<A>();
        attributes.Should()
            .HaveCount(3, "there are 3 inherited copies in the class heirarchy and A is inherited");
    }

    [Test]
    public void DoesntGetNonInheritedAttributesOnProperties()
    {
        var attributes = typeof(Bottom).GetProperty("P").GetAttributes<ANotInherited>();
        attributes.Should()
            .HaveCount(1, "it shouldn't get copies of the attribute from base classes for a non-inherited attribute");
    }
}

0

Додайте інтерфейс із властивостями, які мають атрибути / власні атрибути, приєднані до тих самих властивостей, що й клас. Ми можемо витягти інтерфейс класу за допомогою функції рефактора Visual studio. Мати частковий клас реалізувати цей інтерфейс.

Тепер отримайте об’єкт "Тип" об'єкта класу та отримайте власні атрибути з інформації про властивості, використовуючи getProperties для об'єкта Type. Це не дасть користувацькі атрибути об’єкту класу, оскільки властивості класу не мали власні атрибути інтерфейсу додані / успадковані.

Тепер зателефонуйте GetInterface (NameOfImplemetedInterfaceByclass) на об'єкт типу класу, отриманий вище. Це забезпечить об’єкт "Тип" інтерфейсу. ми повинні знати ім'я реалізованого інтерфейсу. Від об'єкта Type отримайте інформацію про властивості, і якщо у властивості інтерфейсу додані будь-які власні атрибути, то інформація про властивості надасть спеціальний список атрибутів. Клас реалізації повинен забезпечити реалізацію властивостей інтерфейсу. Зіставте відповідне ім’я властивості класу в списку інформації про властивості інтерфейсу, щоб отримати список спеціальних атрибутів.

Це спрацює.


0

Хоча моя відповідь пізня і конкретна для певного випадку, я хотів би додати кілька ідей. Як пропонується в інших відповідях, Рефлексія чи інші методи це зробили б.

У моєму випадку властивість (часова мітка) була потрібна у всіх моделях, щоб відповідати певній вимозі (атрибут перевірки сумісності) у базовому проекті Entity Framework. Ми могли або додати [] вище всіх властивостей класу (додавання в інтерфейсі IModel, які моделі реалізовані, не працювали). Але я заощадив час завдяки API Fluent, який корисний у цих випадках. В умовах безперебійного API я можу перевірити конкретну назву властивості у всіх моделях та встановити IsConcurrencyToken () в 1 рядок !!

var props = from e in modelBuilder.Model.GetEntityTypes()
            from p in e.GetProperties()
            select p;
props.Where(p => p.PropertyInfo.Name == "ModifiedTime").ToList().ForEach(p => { p.IsConcurrencyToken = true; });

Так само, якщо вам потрібен будь-який атрибут до того ж імені властивості у 100-х класах / моделях, ми можемо використовувати вільні методи api для вбудованого або спеціального розв’язувача атрибутів. Хоча EF (як основний, так і EF6) вільний api може використовувати відображення за кадром, ми можемо заощадити зусилля :)

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