.NET中的属性是什么?

时间:2008-08-21 15:59:40

标签: c# .net glossary .net-attributes

.NET中的属性是什么,它们有什么用处,以及如何创建自己的属性?

11 个答案:

答案 0 :(得分:143)

元数据。有关您的对象/方法/属性的数据。

例如,我可能会声明一个名为:DisplayOrder的属性,因此我可以轻松控制属性应在UI中显示的顺序。然后我可以将它附加到一个类并编写一些GUI组件来提取属性并适当地对UI元素进行排序。

public class DisplayWrapper
{
    private UnderlyingClass underlyingObject;

    public DisplayWrapper(UnderlyingClass u)
    {
        underlyingObject = u;
    }

    [DisplayOrder(1)]
    public int SomeInt
    {
        get
        {
            return underlyingObject .SomeInt;
        }
    }

    [DisplayOrder(2)]
    public DateTime SomeDate
    {
        get
        {
            return underlyingObject .SomeDate;
        }
    }
}

从而确保在使用我的自定义GUI组件时,SomeDate始终显示在SomeDate之前。

但是,您会看到它们在直接编码环境之外最常用。例如,Windows Designer广泛使用它们,因此它知道如何处理自定义对象。像这样使用BrowsableAttribute:

[Browsable(false)]
public SomeCustomType DontShowThisInTheDesigner
{
    get{/*do something*/}
}

告诉设计者不要在设计时在“属性”窗口的可用属性中列出这个。例如。

还可以将它们用于代码生成,预编译操作(如Post-Sharp)或运行时操作(如Reflection.Emit)。 例如,您可以编写一些用于分析的代码,这些代码透明地包装您的代码所做的每一次调用并对其进行计时。您可以通过放置在特定方法上的属性来“选择退出”时间。

public void SomeProfilingMethod(MethodInfo targetMethod, object target, params object[] args)
{
    bool time = true;
    foreach (Attribute a in target.GetCustomAttributes())
    {
        if (a.GetType() is NoTimingAttribute)
        {
            time = false;
            break;
        }
    }
    if (time)
    {
        StopWatch stopWatch = new StopWatch();
        stopWatch.Start();
        targetMethod.Invoke(target, args);
        stopWatch.Stop();
        HandleTimingOutput(targetMethod, stopWatch.Duration);
    }
    else
    {
        targetMethod.Invoke(target, args);
    }
}

声明它们很简单,只需创建一个继承自Attribute的类。

public class DisplayOrderAttribute : Attribute
{
    private int order;

    public DisplayOrderAttribute(int order)
    {
        this.order = order;
    }

    public int Order
    {
        get { return order; }
    }
}

请记住,当您使用该属性时,您可以省略编译器将为您添加的后缀“属性”。

注意:属性本身不做任何事情 - 需要有一些其他代码使用它们。有时代码是为您编写的,但有时您必须自己编写代码。例如,C#编译器关心某些框架并使用某些框架(例如,NUnit在类上查找[TestFixture],在加载程序集时在测试方法上查找[Test])。 因此,在创建自己的自定义属性时,请注意它根本不会影响代码的行为。您需要编写检查属性的其他部分(通过反射)并对其进行操作。

答案 1 :(得分:35)

很多人已经回答,但到目前为止还没有人提到这个......

属性大量用于反射。反思已经很慢了。

非常值得将自定义属性标记为sealed类,以提高其运行时性能。

最好考虑使用放置这样的属性的位置,并通过AttributeUsage将属性(!)属性化来表示这一点。可用属性用法列表可能会让您感到惊讶:

  • 装配
  • 模块
  • STRUCT
  • 枚举
  • 构造
  • 方法
  • 属性
  • 字段
  • 事件
  • 接口
  • 参数
  • 代表
  • 返回值
  • 的GenericParameter
  • 所有

AttributeUsage属性是AttributeUsage属性签名的一部分也很酷。哇因为循环依赖!

[AttributeUsageAttribute(AttributeTargets.Class, Inherited = true)]
public sealed class AttributeUsageAttribute : Attribute

答案 2 :(得分:12)

属性是一种用于标记类的元数据。这通常在WinForms中用于隐藏工具栏中的控件,但可以在您自己的应用程序中实现,以使不同类的实例能够以特定方式运行。

首先创建一个属性:

[AttributeUsage(AttributeTargets.Class, AllowMultiple=false, Inherited=true)]
public class SortOrderAttribute : Attribute
{
    public int SortOrder { get; set; }

    public SortOrderAttribute(int sortOrder)
    {
        this.SortOrder = sortOrder;
    }
}

所有属性类必须具有后缀“属性”才有效 完成此操作后,创建一个使用该属性的类。

[SortOrder(23)]
public class MyClass
{
    public MyClass()
    {
    }
}

现在,您可以通过执行以下操作来检查特定类“SortOrderAttribute(如果有)”:

public class MyInvestigatorClass
{
    public void InvestigateTheAttribute()
    {
        // Get the type object for the class that is using
        // the attribute.
        Type type = typeof(MyClass);

        // Get all custom attributes for the type.
        object[] attributes = type.GetCustomAttributes(
            typeof(SortOrderAttribute), true);

        // Now let's make sure that we got at least one attribute.
        if (attributes != null && attributes.Length > 0)
        {
            // Get the first attribute in the list of custom attributes
            // that is of the type "SortOrderAttribute". This should only
            // be one since we said "AllowMultiple=false".
            SortOrderAttribute attribute = 
                attributes[0] as SortOrderAttribute;

            // Now we can get the sort order for the class "MyClass".
            int sortOrder = attribute.SortOrder;
        }
    }
}

如果您想了解更多相关信息,可以随时查看MSDN,其中有很好的描述 我希望这能帮到你!

答案 3 :(得分:4)

属性是一个类,它包含一些可以应用于代码中对象的功能。要创建一个,请创建一个继承自System.Attribute。

的类

至于他们有什么好处......对他们来说几乎是无限的用途。

http://www.codeproject.com/KB/cs/dotnetattributes.aspx

答案 4 :(得分:4)

属性就像应用于类,方法或程序集的元数据一样。

它们适用于任何数量的东西(调试器可视化,将事物标记为过时,将事物标记为可序列化,列表无穷无尽)。

创建自己的自定义单位很容易。从这里开始:

http://msdn.microsoft.com/en-us/library/sw480ze8(VS.71).aspx

答案 5 :(得分:4)

在我目前正在开发的项目中,有一组各种风格的UI对象和一个编辑器来组装这些对象以创建在主应用程序中使用的页面,有点像DevStudio中的表单设计器。这些对象存在于它们自己的程序集中,每个对象都是从UserControl派生的类,并且具有自定义属性。此属性的定义如下:

[AttributeUsage (AttributeTargets::Class)]
public ref class ControlDescriptionAttribute : Attribute
{
public:
  ControlDescriptionAttribute (String ^name, String ^description) :
    _name (name),
    _description (description)
  {
  }

  property String ^Name
  {
    String ^get () { return _name; }
  }

  property String ^Description
  {
    String ^get () { return _description; }
  }

private:
  String
    ^ _name,
    ^ _description;
};

我将它应用于这样的类:

[ControlDescription ("Pie Chart", "Displays a pie chart")]
public ref class PieControl sealed : UserControl
{
  // stuff
};

这是以前的海报所说的。

要使用该属性,编辑器会有一个包含控件类型的Generic::List <Type>。有一个列表框,用户可以从该列表框中拖放并放到该页面上以创建控件的实例。要填充列表框,我会获得控件的ControlDescriptionAttribute并填写列表中的条目:

// done for each control type
array <Object ^>
  // get all the custom attributes
  ^attributes = controltype->GetCustomAttributes (true);

Type
  // this is the one we're interested in
  ^attributetype = ECMMainPageDisplay::ControlDescriptionAttribute::typeid;

// iterate over the custom attributes
for each (Object ^attribute in attributes)
{
  if (attributetype->IsInstanceOfType (attribute))
  {
    ECMMainPageDisplay::ControlDescriptionAttribute
      ^description = safe_cast <ECMMainPageDisplay::ControlDescriptionAttribute ^> (attribute);

    // get the name and description and create an entry in the list
    ListViewItem
      ^item = gcnew ListViewItem (description->Name);

    item->Tag = controltype->Name;
    item->SubItems->Add (description->Description);

    mcontrols->Items->Add (item);
    break;
  }
}

注意:以上是C ++ / CLI,但转换为C#并不困难 (是的,我知道,C ++ / CLI是令人厌恶的,但它是我必须使用的:-()

您可以将属性放在大多数事物上,并且有各种预定义属性。上面提到的编辑器还在描述属性以及如何编辑它的属性上查找自定义属性。

一旦你掌握了整个想法,你会想知道没有它们你是如何生活的。

答案 6 :(得分:3)

如上所述,属性相对容易创建。该工作的另一部分是创建使用它的代码。在大多数情况下,您将在运行时使用反射来根据属性或其属性的存在来更改行为。在某些情况下,您将检查已编译代码的属性以执行某种静态分析。例如,参数可能被标记为非空,分析工具可以将其用作提示。

使用属性并了解其使用的适当方案是大部分工作。

答案 7 :(得分:3)

属性本质上是您要附加到类型(类,方法,事件,枚举等)的数据位。

这个想法是,在运行时,一些其他类型/框架/工具将查询您的类型以获取属性中的信息并对其进行操作。

因此,例如,Visual Studio可以查询第三方控件上的属性,以确定控件的哪些属性应该在设计时出现在“属性”窗格中。

属性也可以在面向方面编程中用于在运行时根据装饰它们的属性注入/操作对象,并在不影响对象的业务逻辑的情况下向对象添加验证,日志记录等。

答案 8 :(得分:2)

您可以使用自定义属性作为在子类中定义标记值的简单方法,而无需为每个子类反复编写相同的代码。我遇到了一个很好的concise example by John Waters如何在您自己的代码中定义和使用自定义属性。

http://msdn.microsoft.com/en-us/library/aa288454(VS.71).aspx

有一个教程

答案 9 :(得分:2)

要开始创建属性,请打开C#源文件,键入attribute并按[TAB]。它将扩展为新属性的模板。

答案 10 :(得分:1)

属性也常用于面向方面编程。有关此示例,请查看PostSharp项目。