.NET Core CSharp 中級篇2-8 特性標籤

WarrenRyan發表於2019-09-08
CSharp

.NET Core CSharp 中級篇2-8

本節內容為特性標籤

簡介

標籤Attribute是一個非常重要的技術，你可以使用Attribute技術最佳化精簡你的程式碼。特性標籤可以運用在程式集，模組，型別（類，結構，列舉，介面，委託），欄位，方法（含構造），方法，引數，方法返回值，屬性（property)，Attribute中。它的用法也是靈活多變，本文就標籤的用法做一個簡單的介紹。

Attribute特性標籤

規定特性Attribute

特性標籤用一對中括號括起來，並且標記在需要使用標籤的地方的上部分，如：

[Table("People")]
class People
{
}

被標記上標籤的任何屬性、方法等，都會進入標籤所在的類中進行處理。而你的標籤中的括號，其實是呼叫它的構造方法。

特性標籤有點類似我們的預定義宏一樣，不過它更多的是用於擴充被標記的程式碼一些限定用法或者說明。

預定義特性Attribute

.NET框架提供了三種預定義特性：

  • AttributeUsage
  • Conditional
  • Obsolete

AttributeUsage

如果你需要實現一個自定義的Attribute，你需要新建一個類並繼承Attribute類，並且你需要使用AttributeUsage標籤對你的Attribute進行限制，其中AttributeUsage可以傳入三個引數，其中：

  • 引數 validon 規定特性可被放置的語言元素。它是列舉器 AttributeTargets 的值的組合。預設值是 AttributeTargets.All。
  • 引數 allowmultiple（可選的）為該特性的 AllowMultiple 屬性（property）提供一個布林值。如果為 true，則該特性是多用的。預設值是 false（單用的）。也就是說在同一個屬性、類、函式等多次使用該標籤
  • 引數 inherited（可選的）為該特性的 Inherited 屬性（property）提供一個布林值。如果為 true，則該特性可被派生類繼承。預設值是 false（不被繼承）。

Obsolete

這個預定義特性標記了不應被使用的程式實體。它可以讓您通知編譯器丟棄某個特定的目標元素。例如，當一個新方法被用在一個類中，但是您仍然想要保持類中的舊方法，您可以透過顯示一個應該使用新方法，而不是舊方法的訊息，來把它標記為 obsolete（過時的）。

  • obsolete有一個兩個引數的建構函式，其中
    引數 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();
   }
}

因為指定了iserror屬性為true，因此上述程式在編譯的時候將會報錯，錯誤提示是我們指定的message。

如果你指定iserror為false，那麼上述程式碼能夠透過編譯和執行，但是會出現警告提醒。

Conditional

這個預定義特性標記了一個條件方法，其執行依賴於指定的預處理識別符號。

它會引起方法呼叫的條件編譯，取決於指定的值，比如 Debug 或 Trace。例如，當除錯程式碼時顯示變數的值。

規定該特性的語法如下：

[Conditional(
   conditionalSymbol
)]
//例如：
[Conditional("DEBUG")]

需要注意：

  • 條件方法必須是類宣告或結構宣告中的方法。如果在介面宣告中的方法上指定Conditional屬性，將出現編譯時錯誤。
  • 條件方法必須具有返回型別。
  • 不能用override修飾符標記條件方法。但是，可以用virtual修飾符標記條件方法。此類方法的重寫方法隱含為有條件的方法，而且不能用Conditional屬性顯式標記。
  • 條件方法不能是介面方法的實現。否則將發生編譯時錯誤。
  • 如果條件方法用在“委託建立表示式”中，也會發生編譯時錯誤

建立一個自定義的Attribute

講完了我們一些基礎內容，我們進行講解我們的一些運用，這裡會略微涉及到我們下一講中的反射，但並不是很深入。

構造一個TestAttribute

// 描述如何使用一個自定義特性 
[AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = true)]    
//自定義特性
public class TestAttribute : Attribute    {
    private string name; // 名字
    private string date; // 日期
    public string Name {
        get { return name; }
        set { name = value; }
    }
    public string Date    {
        get { return date; }
        set { date = value; }
    }
    public TestAttribute(string name)    {
        this.name = name;
        this.name = name;
    }
}

例項化

[Test("Amy", Date = "2018-06-18")]
[Test("Jack", Date = "2018-06-18")]
class Test{}

提取標籤中標記的值

Type t = typeof(Test);
var value = t.GetCustomAttributes(typeof(TestAttribute),true);
foreach(TestAttribute each in value)
{
    Console.WriteLine("Name:{0}", each.Name);
    Console.WriteLine("Data:{0}",each.Data);
}

如果我的文章幫助了您，請您在github .NETCoreGuide專案幫我點一個star，在部落格園中點一個關注和推薦。

Github

BiliBili主頁

WarrenRyan'sBlog

部落格園

相關文章