主頁 > .NET開發 > C#-特性(Attribute)

C#-特性(Attribute)

2020-09-09 22:39:34 .NET開發

概念

特性是一種允許我們向程式的程式集添加元資料的語言結構,它是用于保存程式結構資訊的某種特殊型別的類,
可以通過使用特性向程式添加宣告性資訊,一個宣告性標簽是通過放置在它所應用的元素前面的方括號([ ])來描述的,
MSDN解釋為:特性提供功能強大的方法,用以將元資料或宣告資訊與代碼(程式集、型別、方法、屬性等)相關聯,特性與程式物體關聯后,即可在運行時使用名為“反射”的技術查詢特性,
特性(Attribute)用于添加元資料,如編譯器指令和注釋、描述、方法、類等其他資訊,.Net 框架提供了兩種型別的特性:預定義特性和自定義特性,
特性具有以下屬性:

  • 特性可向程式中添加元資料,元資料是有關在程式中定義的型別的資訊,所有的 .NET 程式集都包含指定的一組元資料,這些元資料描述在程式集中定義的型別和型別成員,可以添加自定義特性,以指定所需的任何附加資訊,
  • 可以將一個或多個特性應用到整個程式集、模塊或較小的程式元素(如類和屬性),
  • 特性可以與方法和屬性相同的方式接受引數,
  • 程式可以使用反射檢查自己的元資料或其他程式內的元資料,

使用特性

特性的目的是告訴編譯器把程式結構的某組元資料嵌入程式集,它可以放置在幾乎所有的宣告中(但特定的屬性可能限制在其上有效的宣告型別),
在 C# 中,特性的指定方法為:將括在方括號中的特性名置于其應用到的物體的宣告上方,
例如:

[System.Serializable]
public class SampleClass
{
    // 運行陳述句
}

一個宣告中可以放置多個特性,有兩種寫法,第一種是將獨立的特性片段互相疊在一起,第二種是使用一個特性片段,特性之間使用逗號分割,

[System.Serializable]
[MyAttribute("par1","par2")]  // 獨立的特性片段
public class SampleClass
{
    // 運行陳述句
}

[MyAttribute("par1","par2"), System.Serializable]  // 逗號分割使用
public class SampleClass
{
    // 運行陳述句
}

對于某些特性可以對給定物體進行指定多次,例如 ConditionalAttribute :

[Conditional("DEBUG"), Conditional("TEST1")]
void TraceMethod()
{
    // 運行陳述句
}

 

特性目標

特性的目標是應用該特性的物體,例如,特性可以應用于類、特定方法或整個程式集,默認情況下,特性應用于它后面的元素,但是,您也可以顯式標識要將特性應用于方法還是它的引數或回傳值,
語法:

[target : attribute-list]

預定義特性

.Net 框架提供了三種預定義特性:AttributeUsage、Conditional、Obsolete,

AttributeUsage

AttributeUsage 描述了如何使用一個自定義特性類,它規定了特性可應用到的專案的型別,
語法:

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

 

引數說明:

  • validon: 規定特性可被放置的語言元素,它是列舉器 AttributeTargets 的值的組合,默認值是 AttributeTargets.All,
  • allowmultiple:可選的引數,為該特性的 AllowMultiple 屬性(property)提供一個布林值,如果為 true,則該特性是多用的,默認值是 false(單用的),
  • inherited:可選的引數,為該特性的 Inherited 屬性(property)提供一個布林值,如果為 true,則該特性可被派生類繼承,默認值是 false(不被繼承),

示例:

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

這個預定義特性標記了一個條件方法,其執行依賴于它頂的預處理識別符號,
它會引起方法呼叫的條件編譯,取決于指定的值,比如 Debug 或 Trace,例如,當除錯代碼時顯示變數的值,
語法:

[Conditional(
   conditionalSymbol
)]

 

示例:

using System;
using System.Diagnostics;

namespace C_Pro
{
    public class Myclass
    {
        [Conditional("DEBUG")]
        public static void Msg(string msg)
        {
            Console.WriteLine(msg);
        }
    }
    public class Test
    {
        static void Main()
        {
            Myclass.Msg("debug in Main.");
            Console.WriteLine("Done.");
            Console.ReadKey();
        }
    }
}

以debug模式進行運行:

debug in Main.
Done.

Obsolete

這個預定義特性標記了不應被使用的程式物體,它可以讓您通知編譯器丟棄某個特定的目標元素,
語法:

[Obsolete(
   message,
   iserror
)]  

引數說明:

  • message:是一個字串,描述專案為什么過時的原因以及該替代使用什么,
  • iserror:是一個布林值,如果該值為 true,編譯器應把該專案的使用當作一個錯誤,默認值是 false(編譯器生成一個警告),

示例:

using System;

namespace C_Pro
{

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

    }
}

運行后結果:

Main.cs(20,4): error CS0619: `C_Pro.MyClass.OldMethod()' is obsolete: `Don't use OldMethod, use NewMethod instead'
Main.cs(21,4): warning CS0618: `C_Pro.MyClass.NewMethod()' is obsolete: `Don't use OldMethod, use NewMethod instead'
Compilation failed: 1 error(s), 1 warnings

如果在 VS 中可以直接看到 OldMethod() 會報錯提示:

自定義特性

宣告特性和宣告其他類是一樣的,只是所有的特性都派生自System.Attribute,
根據約定,所有特性名稱都以單詞“Attribute”結束,以便將它們與“.NET Framework”中的其他項區分,但是,在代碼中使用特性時,不需要指定 attribute 后綴,
例如定義一個MyAttributeAttribute,由 System.Attribute 派生而來,因此是自定義特性類,

public class MyAttributeAttribute : System.Attribute
{
        public string product;
        public string Description;

        public MyAttributeAttribute(string product)
        {
            this.product = product;
            Description = "";
        }
}

特性也有建構式,和其他類一樣,每個特性至少有一個公共建構式,如果沒有宣告建構式,編譯器則會產生一個隱式、公共且無參的建構式,
建構式的引數是自定義特性的定位引數,例如上面的示例中 product 是定位引數,Description 是命名引數,任何公共的讀寫欄位或屬性都是命名引數,
定義完成后使用特性:

[Author("P. Pro", Description = "Description")]
class SampleClass
{
    // 執行陳述句
}

特性與注釋的區別

注釋是對程式源代碼的一種說明,主要目的是給人看的,在程式被編譯的時候會被編譯器所丟棄,因此,它絲毫不會影響到程式的執行,

Attribute是程式代碼的一部分,它不但不會被編譯器丟棄,而且還會被編譯器編譯行程式集(Assembly)的元資料(Metadata)里,在程式運行的時候,隨時可以從元資料(元資料:.NET中元資料是指程式集中的命名空間、類、方法、屬性等資訊,這些資訊是可以通過Reflection讀取出來的,)中提取提取出這些附加資訊,并以之決策程式的運行,

 

轉載請註明出處,本文鏈接:https://www.uj5u.com/net/36.html

標籤:C#

上一篇:Linq 下的擴展方法太少了,您期待的 MoreLinq 來啦

下一篇:C# 讀取CSV 使用 LumenWorks.Framework.IO

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • WebAPI簡介

    Web體系結構: 有三個核心:資源(resource),URL(統一資源識別符號)和表示 他們的關系是這樣的:一個資源由一個URL進行標識,HTTP客戶端使用URL定位資源,表示是從資源回傳資料,媒體型別是資源回傳的資料格式。 接下來我們說下HTTP. HTTP協議的系統是一種無狀態的方式,使用請求/ ......

    uj5u.com 2020-09-09 22:07:47 more
  • asp.net core 3.1 入口:Program.cs中的Main函式

    本文分析Program.cs 中Main()函式中代碼的運行順序分析asp.net core程式的啟動,重點不是剖析原始碼,而是理清程式開始時執行的順序。到呼叫了哪些實體,哪些法方。asp.net core 3.1 的程式入口在專案Program.cs檔案里,如下。ususing System; us ......

    uj5u.com 2020-09-09 22:07:49 more
  • asp.net網站作為websocket服務端的應用該如何寫

    最近被websocket的一個問題困擾了很久,有一個需求是在web網站中搭建websocket服務。客戶端通過網頁與服務器建立連接,然后服務器根據ip給客戶端網頁發送資訊。 其實,這個需求并不難,只是剛開始對websocket的內容不太了解。上網搜索了一下,有通過asp.net core 實作的、有 ......

    uj5u.com 2020-09-09 22:08:02 more
  • ASP.NET 開源匯入匯出庫Magicodes.IE Docker中使用

    Magicodes.IE在Docker中使用 更新歷史 2019.02.13 【Nuget】版本更新到2.0.2 【匯入】修復單列匯入的Bug,單元測驗“OneColumnImporter_Test”。問題見(https://github.com/dotnetcore/Magicodes.IE/is ......

    uj5u.com 2020-09-09 22:08:05 more
  • 在webform中使用ajax

    如果你用過Asp.net webform, 說明你也算是.NET 開發的老兵了。WEBform應該是2011 2013左右,當時還用visual studio 2005、 visual studio 2008。后來基本都用的是MVC。 如果是新開發的專案,估計沒人會用webform技術。但是有些舊版 ......

    uj5u.com 2020-09-09 22:08:50 more
  • iis添加asp.net網站,訪問提示:由于擴展配置問題而無法提供您請求的

    今天在iis服務器配置asp.net網站,遇到一個問題,記錄一下: 問題:由于擴展配置問題而無法提供您請求的頁面。如果該頁面是腳本,請添加處理程式。如果應下載檔案,請添加 MIME 映射。 WindowServer2012服務器,添加角色安裝完.netframework和iis之后,運行aspx頁面 ......

    uj5u.com 2020-09-09 22:10:00 more
  • WebAPI-處理架構

    帶著問題去思考,大家好! 問題1:HTTP請求和回傳相應的HTTP回應資訊之間發生了什么? 1:首先是最底層,托管層,位于WebAPI和底層HTTP堆疊之間 2:其次是 訊息處理程式管道層,這里比如日志和快取。OWIN的參考是將訊息處理程式管道的一些功能下移到堆疊下端的OWIN中間件了。 3:控制器處理 ......

    uj5u.com 2020-09-09 22:11:13 more
  • 微信門戶開發框架-使用指導說明書

    微信門戶應用管理系統,采用基于 MVC + Bootstrap + Ajax + Enterprise Library的技術路線,界面層采用Boostrap + Metronic組合的前端框架,資料訪問層支持Oracle、SQLServer、MySQL、PostgreSQL等資料庫。框架以MVC5,... ......

    uj5u.com 2020-09-09 22:15:18 more
  • WebAPI-HTTP編程模型

    帶著問題去思考,大家好!它是什么?它包含什么?它能干什么? 訊息 HTTP編程模型的核心就是訊息抽象,表示為:HttPRequestMessage,HttpResponseMessage.用于客戶端和服務端之間交換請求和回應訊息。 HttpMethod類包含了一組靜態屬性: private stat ......

    uj5u.com 2020-09-09 22:15:23 more
  • 部署WebApi隨筆

    一、跨域 NuGet參考Microsoft.AspNet.WebApi.Cors WebApiConfig.cs中配置: // Web API 配置和服務 config.EnableCors(new EnableCorsAttribute("*", "*", "*")); 二、清除默認回傳XML格式 ......

    uj5u.com 2020-09-09 22:15:48 more
最新发布
  • C#多執行緒學習(二) 如何操縱一個執行緒

    <a href="https://www.cnblogs.com/x-zhi/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2943582/20220801082530.png" alt="" /></...

    uj5u.com 2023-04-19 09:17:20 more
  • C#多執行緒學習(二) 如何操縱一個執行緒

    C#多執行緒學習(二) 如何操縱一個執行緒 執行緒學習第一篇:C#多執行緒學習(一) 多執行緒的相關概念 下面我們就動手來創建一個執行緒,使用Thread類創建執行緒時,只需提供執行緒入口即可。(執行緒入口使程式知道該讓這個執行緒干什么事) 在C#中,執行緒入口是通過ThreadStart代理(delegate)來提供的 ......

    uj5u.com 2023-04-19 09:16:49 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    <a href="https://www.cnblogs.com/huangxincheng/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/214741/20200614104537.png" alt="" /&g...

    uj5u.com 2023-04-18 08:39:04 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    一:背景 1. 講故事 前段時間協助訓練營里的一位朋友分析了一個程式卡死的問題,回過頭來看這個案例比較經典,這篇稍微整理一下供后來者少踩坑吧。 二:WinDbg 分析 1. 為什么會卡死 因為是表單程式,理所當然就是看主執行緒此時正在做什么? 可以用 ~0s ; k 看一下便知。 0:000> k # ......

    uj5u.com 2023-04-18 08:33:10 more
  • SignalR, No Connection with that ID,IIS

    <a href="https://www.cnblogs.com/smartstar/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/u36196.jpg" alt="" /></a>...

    uj5u.com 2023-03-30 17:21:52 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:15:33 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:13:31 more
  • C#遍歷指定檔案夾中所有檔案的3種方法

    <a href="https://www.cnblogs.com/xbhp/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/957602/20230310105611.png" alt="" /></a&...

    uj5u.com 2023-03-27 14:46:55 more
  • C#/VB.NET:如何將PDF轉為PDF/A

    <a href="https://www.cnblogs.com/Carina-baby/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2859233/20220427162558.png" alt="" />...

    uj5u.com 2023-03-27 14:46:35 more
  • 武裝你的WEBAPI-OData聚合查詢

    <a href="https://www.cnblogs.com/podolski/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/616093/20140323000327.png" alt="" /><...

    uj5u.com 2023-03-27 14:46:16 more