C#教學 » C#屬性

C#屬性

屬性是一個宣告性的標籤，用於向執行時傳遞有關程式中各種元素(如類，方法，結構，列舉器，程式集等)的行為的資訊。可以通過使用屬性將宣告性資訊新增到程式。宣告式標籤由放置在其所用元素上方的方括號([])表示。

屬性用於向程式新增後設資料，如編譯器指令和其他資訊，如注釋，描述，方法和類。.Net框架提供了兩種型別的屬性：預定義屬性和自定義構建的屬性。

指定屬性

用於指定屬性的語法如下：

[attribute(positional_parameters, name_parameter = value, ...)]
element

屬性名稱及其值在方括號內，在應用該屬性的元素之前指定。位置引數指定必要資訊，名稱引數指定可選資訊。

預定義屬性

.Net框架提供了三個預定義的屬性：

  • AttributeUsage
  • Conditional
  • Obsolete

預定義屬性:AttributeUsage

預定義屬性AttributeUsage描述了如何使用自定義屬性類。它指定可以應用該屬性的專案的型別。

用於指定此屬性的語法如下：

[AttributeUsage(
   validon,
   AllowMultiple=allowmultiple,
   Inherited=inherited
)]

其中，

  • 引數validon指定可以放置屬性的語言元素。它是列舉器AttributeTargets的值的組合。預設值為AttributeTargets.All。
  • 引數allowmultiple(可選)為此屬性的AllowMultiple屬性提供了一個布林值。 如果些值為:true，則表示屬性是多次使用。預設值為false，表示一次性使用。
  • 引數inherited(可選)為此屬性的Inherited屬性提供了一個布林值。 如果此引數值為：true，則屬性由派生類繼承。 它預設值為false(不繼承)。

例如，

[AttributeUsage(AttributeTargets.Class |
AttributeTargets.Constructor |
AttributeTargets.Field |
AttributeTargets.Method |
AttributeTargets.Property, 
AllowMultiple = true)]

預定義屬性:Conditional

此預定義屬性標記一個條件方法，其執行取決於指定的預處理識別符號。

它使方法呼叫條件編譯，具體取決於指定的值，如：偵錯(Debug)或跟蹤(Trace)。 例如，它在偵錯程式碼時顯示變數的值。

用於指定此屬性的語法如下：

[Conditional(
   conditionalSymbol
)]

例如，

[Conditional("DEBUG")]

以下範例演示了該屬性：

#define DEBUG
using System;
using System.Diagnostics;

public class Myclass
{
   [Conditional("DEBUG")]
   public static void Message(string msg)
   {
      Console.WriteLine(msg);
   }
}

class Test
{
   static void function1()
   {
      Myclass.Message("In Function 1.");
      function2();
   }
   static void function2()
   {
      Myclass.Message("In Function 2.");
   }

   public static void Main()
   {
      Myclass.Message("In Main function.");
      function1();
      Console.ReadKey();
   }
}

當上述程式碼被編譯並執行時，它產生以下結果：

In Main function
In Function 1
In Function 2

預定義屬性: Obsolete

此預定義屬性標記不應該使用的程式實體。它能夠通知編譯器丟棄特定的目標元素。 例如，當一個類中正在使用一個新方法，並且如果仍然希望在類中保留舊方法時，可以通過顯示新方法而不是舊方法來顯示訊息來將其標記為過時。

用於指定此屬性的語法如下：

[Obsolete(
   message
)]
[Obsolete(
   message,
   iserror
)]

其中，

  • 引數 - message是一個字串，描述專案過時的原因以及使用的替代方法。
  • 引數 - iserror，是一個布林值。 如果值為true，則編譯器應將該專案的使用視為錯誤。預設值為false，編譯器生成警告。

範例程式如下：

using System;

public class MyClass
{
   [Obsolete("Don't use OldMethod, use NewMethod instead", true)]
   static void OldMethod()
   {
      Console.WriteLine("It is the old method");
   }
   static void NewMethod()
   {
      Console.WriteLine("It is the new method"); 
   }
   public static void Main()
   {
      OldMethod();
   }
}

當嘗試編譯程式時，編譯器會提供一條錯誤訊息：

Don't use OldMethod, use NewMethod instead

建立自定義屬性

.Net框架允許建立可用於儲存宣告性資訊的自定義屬性，並可在執行時檢索。該資訊可以根據設計標準和應用需要與任何目標元素相關。

建立和使用自定義屬性涉及四個步驟：

  • 宣告一個自定義屬性
  • 構造自定義屬性
  • 將自定義屬性應用於目標程式元素
  • 通過反射存取屬性

最後一步是編寫一個簡單的程式來讀取後設資料以找到各種標記。後設資料是用於描述其他資料的資料或資訊。程式可在執行時存取屬性的反射。這將在下一章討論。

宣告自定義屬性

應該從System.Attribute類派生一個新的自定義屬性。 例如，

//a custom attribute BugFix to be assigned to a class and its members
[AttributeUsage(AttributeTargets.Class |
AttributeTargets.Constructor |
AttributeTargets.Field |
AttributeTargets.Method |
AttributeTargets.Property,
AllowMultiple = true)]

public class DeBugInfo : System.Attribute

在上面的程式碼中，宣告了一個名稱為DeBugInfo的自定義屬性。

構造自定義屬性

下面來構建一個名稱為DeBugInfo的自定義屬性，它儲存通過偵錯任何程式獲得的資訊。它儲存以下資訊：

  • 錯誤程式碼編號
  • 識別錯誤的開發人員的名稱
  • 程式碼上次審查日期
  • 用於儲存開發人員言論的字串訊息

DeBugInfo類有三個私有屬性用於儲存前三個資訊和一個用於儲存訊息的公共屬性。 因此，錯誤編號，開發人員名稱和審查日期是DeBugInfo類的位置引數，並且訊息是可選的或命名的引數。

每個屬性必須至少有一個建構函式。位置引數應通過建構函式傳遞。以下程式碼顯示DeBugInfo類：

//a custom attribute BugFix to be assigned to a class and its members
[AttributeUsage(AttributeTargets.Class |
AttributeTargets.Constructor |
AttributeTargets.Field |
AttributeTargets.Method |
AttributeTargets.Property,
AllowMultiple = true)]

public class DeBugInfo : System.Attribute
{
   private int bugNo;
   private string developer;
   private string lastReview;
   public string message;

   public DeBugInfo(int bg, string dev, string d)
   {
      this.bugNo = bg;
      this.developer = dev;
      this.lastReview = d;
   }

   public int BugNo
   {
      get
      {
         return bugNo;
      }
   }

   public string Developer
   {
      get
      {
         return developer;
      }
   }

   public string LastReview
   {
      get
      {
         return lastReview;
      }
   }

   public string Message
   {
      get
      {
         return message;
      }
      set
      {
         message = value;
      }
   }
}

應用自定義屬性

該屬性是通過放置在目標之前來應用：

[DeBugInfo(45, "Maxsu", "12/8/2018", Message = "Return type mismatch")]
[DeBugInfo(49, "Sukyda", "10/10/2018", Message = "Unused variable")]
class Rectangle
{
   //member variables
   protected double length;
   protected double width;
   public Rectangle(double l, double w)
   {
      length = l;
      width = w;
   }
   [DeBugInfo(55, "Maxsu", "19/10/2018", Message = "Return type mismatch")]

   public double GetArea()
   {
      return length * width;
   }
   [DeBugInfo(56, "Maxsu", "19/10/2018")]

   public void Display()
   {
      Console.WriteLine("Length: {0}", length);
      Console.WriteLine("Width: {0}", width);
      Console.WriteLine("Area: {0}", GetArea());
   }
}

在下一章中，使用Reflection類物件檢索屬性資訊。