程式師世界 >> 編程語言 >> C語言 >> 關於C語言 >> C# 特性（Attribute）入門（一）

C# 特性（Attribute）入門（一）

編輯：關於C語言

# 特性（Attribute）入門（一）

By sadaf alvi 翻譯：cppbug ([email protected])

緒論

特性（Attributes）是一種嶄新的聲明性信息。我們不僅可以通過特性來定義設計層面的信息（例如help file, URL for documentation）以及運行時（run-time）信息（例如使XML與class相聯系），而且我們還可以利用特性建立自描述（self-describing）組件。在這篇教程中，我們將會看到如何建立和添加特性到各種程序實體以及如何在運行時環境中獲取特性信息。

定義

正如MSDN中所描述的那樣-----

“特性是被指定給某一聲明的一則附加的聲明性信息。”

使用預定義（Pre-defined）特性

在C#中，有一個小的預定義特性集合。在學習如何建立我們自己的定制特性（custom attributes）之前，我們先來看看在我們的代碼中如何使用預定義特性。

using System;
public class AnyClass
{
[Obsolete("Don't use Old method, use New method", true)]
static void Old( ) { }

static void New( ) { }

public static void Main( )
{
Old( );
}
}
我們先來看一下上面這個例子，在這個例子中我們使用了Obsolete特性，它標記了一個不應該再被使用的程序實體。第一個參數是一個字符串，它解釋了為什麼該實體是過時的以及應該用什麼實體來代替它。實際上，你可以在這裡寫任何文本。第二個參數告訴編譯器應該把使用這個過時的程序實體當作一種錯誤。它的默認值是false，也就是說編譯器對此會產生一個警告。

當我們嘗試編譯上面這段程序的時候，我們將會得到一個錯誤：

AnyClass.Old()' is obsolete: 'Don't use Old method, use New method'

開發定制特性（custom attributes）

現在讓我們來看看如何開發我們自己的特性。

首先我們要從System.Attribute派生出我們自己的特性類（一個從System.Attribute抽象類繼承而來的類，不管是直接還是間接繼承，都會成為一個特性類。特性類的聲明定義了一種可以被放置在聲明之上新的特性）。

using System;
public class HelpAttribute : Attribute
{
}
不管你是否相信，我們已經建立了一個定制特性，現在我們可以用它來裝飾現有的類就好像上面我們使用Obsolete attribute一樣。

[Help()]
public class AnyClass
{
}
注意：對一個特性類名使用Attribute後綴是一個慣例。然而，當我們把特性添加到一個程序實體，是否包括Attribute後綴是我們的自由。編譯器會首先在System.Attribute的派生類中查找被添加的特性類。如果沒有找到，那麼編譯器會添加Attribute後綴繼續查找。

到目前為止，這個特性還沒有起到什麼作用。下面我們來添加些東西給它使它更有用些。

using System;
public class HelpAttribute : Attribute
{
public HelpAttribute(String Descrition_in)
{
this.description = Description_in;
}
protected String description;
public String Description
{
get
{
return this.description;

}
}
}
[Help("this is a do-nothing class")]
public class AnyClass
{
}
在上面的例子中，我們給HelpAttribute特性類添加了一個屬性並且在後續的部分中我們會在運行時環境中查尋它。