webentwicklung-frage-antwort-db.com.de

Kann eine C # -Klasse Attribute von ihrer Schnittstelle erben?

Dies scheint "Nein" zu bedeuten. Welches ist unglücklich.

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

Kann eine Klasse Attribute von einer Schnittstelle erben? Oder belle ich hier den falschen Baum auf?

102
Roger Lipscombe

Nein. Wenn Sie ein Interface implementieren oder Member in einer abgeleiteten Klasse überschreiben, müssen Sie die Attribute erneut deklarieren.

Wenn Sie sich nur für ComponentModel interessieren (nicht für die direkte Reflektion), gibt es eine Möglichkeit ( [AttributeProvider] ), Attribute aus einem vorhandenen Typ vorzuschlagen (um Doppelarbeit zu vermeiden). Dies gilt jedoch nur für die Verwendung von Eigenschaften und Indexern.

Als Beispiel:

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

ausgänge:

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

Sie können eine nützliche Erweiterungsmethode definieren ...

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

Hier ist die Erweiterungsmethode:

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

Update:

Hier ist eine kürzere Version, wie von SimonD in einem Kommentar vorgeschlagen:

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

Ein Artikel von Brad Wilson zu diesem Thema: Schnittstellenattribute! = Klassenattribute

Zusammenfassend: Klassen erben nicht von Schnittstellen, sie implementieren sie. Dies bedeutet, dass die Attribute nicht automatisch Bestandteil der Implementierung sind.

Wenn Sie Attribute erben müssen, verwenden Sie anstelle einer Schnittstelle eine abstrakte Basisklasse.

21
Roger Lipscombe

Während eine C # -Klasse keine Attribute von ihren Schnittstellen erbt, gibt es eine nützliche Alternative beim Binden von Modellen in ASP.NET MVC3. 

Wenn Sie das Modell der Ansicht als Schnittstelle und nicht als konkreten Typ deklarieren, übernehmen die Ansicht und der Modellbinder die Attribute (z. B. [Required] oder [DisplayName("Foo")]) der Schnittstelle, wenn Sie das Modell rendern und validieren:

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

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

Dann in der Ansicht:

@* 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)
10
Peter Gluck

Dies ist mehr für Leute, die Attribute aus Eigenschaften extrahieren möchten, die möglicherweise in einer implementierten Schnittstelle vorhanden sind. Da diese Attribute nicht Teil der Klasse sind, erhalten Sie Zugriff auf diese Attribute. Hinweis: Ich habe eine einfache Containerklasse, mit der Sie auf PropertyInfo zugreifen können. Dafür brauchte ich sie. Zerhacken Sie, wie Sie brauchen. Das hat gut für mich funktioniert.

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

Obwohl meine Antwort zu spät und spezifisch für einen bestimmten Fall ist, möchte ich einige Ideen hinzufügen. Wie in anderen Antworten vorgeschlagen, würde Reflection oder andere Methoden dies tun.

In meinem Fall wurde in allen Modellen eine Eigenschaft (Zeitstempel) benötigt, um bestimmte Anforderungen (Attribut Concurrency Check) in einem Entity Framework-Kernprojekt zu erfüllen. Wir könnten entweder [] vor allem Klasseneigenschaften hinzufügen (in der IModel-Schnittstelle hinzufügen, welche Modelle implementiert sind, hat nicht funktioniert). Aber ich habe durch Fluent API Zeit gespart, was in diesen Fällen hilfreich ist. In der fließenden API kann ich in allen Modellen nach bestimmten Eigenschaftsnamen suchen und in einer Zeile IsConcurrencyToken () festlegen !!

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

Ebenso können wir für eingebaute oder benutzerdefinierte Attributauflösungsmethoden fließende API-Methoden verwenden, wenn Sie ein Attribut benötigen, das in Hunderten von Klassen/Modellen demselben Eigenschaftsnamen hinzugefügt werden soll. Obwohl EF (sowohl Core als auch EF6) fließende APIs hinter den Kulissen reflektieren können, können wir Mühe sparen :)

BEARBEITEN: Dies umfasst das Erben von Attributen von Schnittstellen auf Elementen (einschließlich Eigenschaften). Für Typdefinitionen gibt es oben einfache Antworten. Ich habe dies gerade gepostet, weil ich es als irritierende Einschränkung empfand und eine Lösung teilen wollte :)

Schnittstellen sind Mehrfachvererbung und verhalten sich im Typsystem als Vererbung. Es gibt keinen guten Grund für so etwas. Reflexion ist ein bisschen hokey. Ich habe Kommentare hinzugefügt, um den Unsinn zu erklären.

(Dies ist .NET 3.5, da dies gerade das ist, was das Projekt, das ich gerade mache, ist.)

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

Barebones NUnit-Test

[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
Seth

Fügen Sie eine Schnittstelle mit Eigenschaften hinzu, deren Attribute/benutzerdefinierte Attribute denselben Eigenschaften wie die Klasse zugeordnet sind. Wir können die Schnittstelle der Klasse mithilfe der Visual Studio Refactor-Funktion extrahieren. Bitten Sie eine Teilklasse, diese Schnittstelle zu implementieren.

Holen Sie sich jetzt das "Type" -Objekt des Klassenobjekts und holen Sie sich benutzerdefinierte Attribute aus den Eigenschaftsinformationen mit getProperties on Type -Objekt. Dadurch werden die benutzerdefinierten Attribute für das Klassenobjekt nicht angegeben, da an die Klasseneigenschaften nicht die benutzerdefinierten Attribute der Schnittstelleneigenschaften angefügt/vererbt wurden.

Rufen Sie jetzt GetInterface (NameOfImplemetedInterfaceByclass) für das oben abgerufene Type-Objekt der Klasse auf. Dies liefert das "Type" -Objekt der Schnittstelle. Wir sollten den Namen der implementierten Schnittstelle kennen. Abrufen von Eigenschaftsinformationen vom Typobjekt. Wenn an die Eigenschaft der Schnittstelle benutzerdefinierte Attribute angehängt sind, werden mit den Eigenschaftsinformationen benutzerdefinierte Attributlisten bereitgestellt. Die implementierende Klasse muss die Implementierung der Eigenschaften der Schnittstelle bereitgestellt haben. Passen Sie den spezifischen Eigenschaftsnamen des Klassenobjekts in der Liste der Eigenschaftsinformationen der Schnittstelle an, um die Liste der benutzerdefinierten Attribute abzurufen.

Das wird funktionieren.

0
user11432943