C# 特性(Attribute)入门教程
绪论
特性(Attributes)是一种崭新的声明性信息。我们不仅可以通过特性来定义设计层面的信息(例如help file, URL for documentation)以及运行时(run-time)信息(例如使XML与class相联系),而且我们还可以利用特性建立自描述(self-describing)组件。在这篇教程中,我们将会看到如何建立和添加特性到各种程序实体以及如何在运行时环境中获取特性信息。
定义
正如MSDN中所描述的那样-----“特性是被指定给某一声明的一则附加的声明性信息。”
使用预定义(Pre-defined)特性
在C#中,有一个小的预定义特性集合。在学习如何建立我们自己的定制特性(custom attributes)之前,我们先来看看在我们的代码中如何使用预定义特性。
2
3public class AnyClass
4{
5[Obsolete("Don't use Old method, use New method", true)]
6static void Old( ) { }
7
8static void New( ) { }
9
10public static void Main( )
11{
12 Old( );
13}
14}
我们先来看一下上面这个例子,在这个例子中我们使用了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后缀继续查找。
到目前为止,这个特性还没有起到什么作用。下面我们来添加些东西给它使它更有用些。
2public class HelpAttribute : Attribute
3{
4public HelpAttribute(String Descrition_in)
5{
6this.description = Description_in;
7}
8protected String description;
9public String Description
10{
11get
12{
13return this.description;
14
15}
16}
17}
18[Help("this is a do-nothing class")]
19public class AnyClass
20{
21}
在上面的例子中,我们给HelpAttribute特性类添加了一个属性并且在后续的部分中我们会在运行时环境中查寻它。
定义或控制特性的使用
AttributeUsage类是另外一个预定义特性类,它帮助我们控制我们自己的定制特性的使用。它描述了一个定制特性如和被使用。
AttributeUsage有三个属性,我们可以把它放置在定制属性前面。第一个属性是:
ValidOn
通过这个属性,我们能够定义定制特性应该在何种程序实体前放置。一个属性可以被放置的所有程序实体在AttributeTargets enumerator中列出。通过OR操作我们可以把若干个AttributeTargets值组合起来。
AllowMultiple
这个属性标记了我们的定制特性能否被重复放置在同一个程序实体前多次。
Inherited
我们可以使用这个属性来控制定制特性的继承规则。它标记了我们的特性能否被继承。
下面让我们来做一些实际的东西。我们将会在刚才的Help特性前放置AttributeUsage特性以期待在它的帮助下控制Help特性的使用。
2[AttributeUsage(AttributeTargets.Class), AllowMultiple = false,
3Inherited = false ]
4public class HelpAttribute : Attribute
5{
6public HelpAttribute(String Description_in)
7{
8this.description = Description_in;
9}
10protected String description;
11public String Description
12{
13get
14{
15return this.description;
16}
17}
18}
先让我们来看一下AttributeTargets.Class。它规定了Help特性只能被放在class的前面。这也就意味着下面的代码将会产生错误:
2public class AnyClass
3{
4[Help("this is a do-nothing method")] //error
5public void AnyMethod()
6{
7}
8}
编译器报告错误如下:
AnyClass.cs: Attribute 'Help' is not valid on this declaration type.
It is valid on 'class' declarations only.
我们可以使用AttributeTargets.All来允许Help特性被放置在任何程序实体前。可能的值是:
Assembly,Module,Class,Struct,Enum,Constructor,Method,Property,Field,Event,Interface,
Parameter,Delegate。
All = Assembly | Module | Class | Struct | Enum | Constructor | Method | Property | Field | Event | Interface | Parameter | Delegate,
ClassMembers = Class | Struct | Enum | Constructor | Method | Property | Field | Event | Delegate | Interface )
下面考虑一下AllowMultiple = false。它规定了特性不能被重复放置多次。
2[Help("it contains a do-nothing method")]
3public class AnyClass
4{
5[Help("this is a do-nothing method")] //error
6public void AnyMethod()
7{
8}
9}
10
11
它产生了一个编译期错误。
AnyClass.cs: Duplicate 'Help' attribute
Ok,现在我们来讨论一下最后的这个属性。Inherited, 表明当特性被放置在一个基类上时,它能否被派生类所继承。
2public class Base
3{
4}
5
6public class Derive : Base
7{
8}
这里会有四种可能的组合:
2
3 [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false ]
4
5 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true ]
6
7 [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true ]
第一种情况:
如果我们查询(Query)(稍后我们会看到如何在运行期查询一个类的特性)Derive类,我们将会发现Help特性并不存在,因为inherited属性被设置为false。
第二种情况:
和第一种情况相同,因为inherited也被设置为false。
第三种情况:
为了解释第三种和第四种情况,我们先来给派生类添加点代码:
2public class Base
3{
4}
5[Help("DeriveClass")]
6public class Derive : Base
7{
8}
现在我们来查询一下Help特性,我们只能得到派生类的属性,因为inherited被设置为true,但是AllowMultiple却被设置为false。因此基类的Help特性被派生类Help特性覆盖了。
第四种情况:
在这里,我们将会发现派生类既有基类的Help特性,也有自己的Help特性,因为AllowMultiple被设置为true。
转载于:https://www.cnblogs.com/net66/archive/2005/07/25/199944.html
C# 特性(Attribute)入门教程相关推荐
- 2021年最新整理, C++ 学习资料,含C++ 11 / 14 / 17 / 20 / 23 新特性、入门教程、推荐书籍、优质文章、学习笔记、教学视频等
- mysql query browswer_MySQL数据库新特性之存储过程入门教程
MySQL数据库新特性之存储过程入门教程 在MySQL 5中,终于引入了存储过程这一新特性,这将大大增强MYSQL的数据库处理能力.在本文中将指导读者快速掌握MySQL 5的存储过程的基本知识,带领用 ...
- ASP.NET CORE 入门教程(附源码)
ASP.NET CORE 入门教程 第一课 基本概念 基本概念 Asp.Net Core Mvc是.NET Core平台下的一种Web应用开发框架 符合Web应用特点 .NET Core跨平台解决方案 ...
- ArcGIS Runtime SDK for Windows Phone 入门教程
ArcGIS Runtime SDK for Windows Phone 入门教程 基本概念 Windows Phone平台介绍 Windows Phone是微软发布的一款手机操作系统,它将微软旗下的 ...
- Python基础入门教程:Day21-30/Web前端概述
Python基础入门教程:Web前端概述 说明:本文使用的部分插图来自 Jon Duckett 先生的*HTML and CSS: Design and Build Websites*一书,这是一本非 ...
- Visual C++/MFC入门教程
Visual C++/MFC入门教程 VC开发指南 1.1 如何学好VC 这个问题很多朋友都问过我,当然流汗是必须的,但同时如果按照某种思路进行有计划的学习就会起到更好的效果.万事开头难,为了帮助朋友 ...
- Objective-C 30分钟入门教程
Objective-C 30分钟入门教程 我第一次看OC觉得这个语言的语法有些怪异,为什么充满了@符号,[]符号,函数调用没有()这个,但是面向对象的高级语言也不外乎类,接口,多态,封装,继承等概念. ...
- python爬虫入门教程--优雅的HTTP库requests(二)
requests 实现了 HTTP 协议中绝大部分功能,它提供的功能包括 Keep-Alive.连接池.Cookie持久化.内容自动解压.HTTP代理.SSL认证等很多特性,下面这篇文章主要给大家介绍 ...
- php入门时间,php入门教程(二十一) php日期与时间函数
本节内容: php日期与时间函数 PHP提供了很多的处理日期和时间的函数,包括time().date().mktime().checkdate().microtime().strtotime()等,详 ...
- Netty入门教程——认识Netty
什么是Netty? Netty 是一个利用 Java 的高级网络的能力,隐藏其背后的复杂性而提供一个易于使用的 API 的客户端/服务器框架. Netty 是一个广泛使用的 Java 网络编程框架(N ...
最新文章
- OpenCV+python:直方图的应用(二)
- delphi的几个特别关键字 object absolute
- WPF-003 popup实现下拉列表的问题
- Java堆空间,本机堆和内存问题
- Android 实现指纹识别demo
- 小学计算机集体备课,小学信息技术集体备课.doc
- [翻译]基于ASP.NET的NumericTextBox控件[Carol]
- VC学习笔记:简单绘图
- [轉]PHP执行MYSQL存储过程报错:Commands out of sync; you can't run this command now 问题的解决...
- 怎么在win10服务器上搭建网站,win10怎么搭建web服务器 win10搭建web服务器的方法...
- 用友NC 用户名登录设置步骤
- 上偏续关系哈斯图_[离散]哈斯图偏序集--最好理解版本
- 闪来币SunlightCoin源码编译运行
- html背景渲染原理(body透明渐变)
- 中英文标点符号切换的组合键_电脑键盘常用组合键(快捷键)之——Ctrl键组合...
- configure 中常见的几个命令
- 小猫爪:i.MX RT1050学习笔记7-Power Supply
- 程序人生 | 从导游转行测试工程师:人总在期盼一个改变自己的机会
- 重磅!发表在人工智能顶刊(TPAMI)上的一篇文章表示脑电与计算机视觉的交叉存在缺陷和盲点...
- kali Linux 介绍
热门文章
- ASP.NETAPI跨域设置(超简易)
- 前端性能优化—将CSS文件放在顶部
- 用mysqlbinlog查看row格式的事件
- Python 卡方检验、克雷姆值
- DataUml Design 教程6-DataUML Design 1.1版本号正式公布(支持PD数据模型)
- warning: rpmts_HdrFromFdno: Header V3 DSA signature: NOKEY, key ID
- Windows Azure 安全最佳实践 - 第 1 部分:深度解析挑战防御对策
- 将js文件打包进dll 方法3
- NiosII中Flash的使用(转)
- ajax请求获取服务器数据,jquery.ajax发布从app引擎服务器获取数据的请求