.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，在博客園中點一個關注和推薦。