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
うーん。問題は、基本クラスからではなくインターフェイスから属性を継承することに関するものであることに気づきました。
Rune Grimstad

では、インターフェイスに属性を設定する理由はありますか?
Ryan Penfold 2013年

5
@ライアン-確かに:インターフェースを説明するため。たとえば、サービス契約。
マークグラベル

3
Marc(および@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
とてもいいです、私は今、これの短いバージョンを個人的に使用しています:private static IEnumerable <T> GetCustomAttributesInlusionBaseInterfaces <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>(); }
Simon D.

1
@SimonD .:そして、リファクタリングされたソリューションはより高速です。
mynkow

1
@SimonDこれはコメントではなく、答える価値がありました。
Nick N.

置き換えない何らかの理由があるApplyに建てられてForEachからMicrosoft.Practices.ObjectBuilder2
ジェイコブビール

29

これに関するBrad Wilsonの記事:インターフェース属性!=クラス属性

要約すると、クラスはインターフェースから継承せず、それらを実装します。つまり、属性は自動的に実装の一部にはなりません。

属性を継承する必要がある場合は、インターフェースではなく抽象基本クラスを使用してください。


実装しているインターフェースが複数ある場合はどうなりますか?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

編集:これは、メンバーのインターフェイスからの属性の継承(プロパティを含む)をカバーしています。型の定義については、上記の簡単な答えがあります。私はこれをイライラする制限であることがわかり、解決策を共有したかったので、これを投稿しました:)

インターフェイスは多重継承であり、型システムでは継承として動作します。この種のものに正当な理由はありません。リフレクションは少し面倒です。ナンセンスを説明するコメントを追加しました。

(これはたまたま私が現在行っているプロジェクトで使用しているため、.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;
    }
}

Barebones 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のリファクタリング機能を使用して、クラスのインターフェイスを抽出できます。部分クラスにそのインターフェースを実装させます。

次に、クラスオブジェクトの「Type」オブジェクトを取得し、TypeオブジェクトでgetPropertiesを使用してプロパティ情報からカスタム属性を取得します。クラスプロパティにはインターフェイスプロパティのカスタム属性がアタッチ/継承されていなかったため、これはクラスオブジェクトにカスタム属性を与えません。

次に、上記で取得したクラスのTypeオブジェクトでGetInterface(NameOfImplemetedInterfaceByclass)を呼び出します。これにより、インターフェースの「タイプ」オブジェクトが提供されます。実装されたインターフェースの名前を知る必要があります。Typeオブジェクトからプロパティ情報を取得し、インターフェイスのプロパティにカスタム属性がアタッチされている場合、プロパティ情報はカスタム属性リストを提供します。実装クラスは、インターフェースのプロパティの実装を提供している必要があります。インターフェイスオブジェクトのプロパティ情報のリスト内でクラスオブジェクトの特定のプロパティ名を照合して、カスタム属性リストを取得します。

これは機能します。


0

私の回答は遅れており、特定のケースに固有のものですが、いくつかのアイデアを追加したいと思います。他の回答で示唆されているように、リフレクションまたは他の方法がそれを行います。

私の場合、エンティティフレームワークコアプロジェクトの特定の要件(同時実行性チェック属性)を満たすために、すべてのモデルでプロパティ(タイムスタンプ)が必要でした。すべてのクラスプロパティの上に[]を追加することもできます(実装されたモデルが機能しないIModelインターフェイスに追加しました)。しかし、私はこれらの場合に役立つFluent 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; });

同様に、何百ものクラス/モデルで同じプロパティ名に属性を追加する必要がある場合は、組み込みまたはカスタムの属性リゾルバーにFluent APIメソッドを使用できます。EF(コアとEF6の両方)の流暢なAPIは、舞台裏でリフレクションを使用する場合がありますが、労力を節約できます:)

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.