.NET Core CSharp 中级篇2-8 特性标签
.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,在博客园中点一个关注和推荐。
- asp.net core新特性之TagHelper标签助手
- .NET Core CSharp 中级篇 2-2 List,ArrayList和Dictionary
- .NET Core CSharp 中级篇 2-1 装箱与拆箱
- asp.net core新特性(1):TagHelper
- .NET Core CSharp初级篇 1-5 接口、枚举、抽象
- Asp.Net Core-Authorize 特性
- .NET Core CSharp初级篇 1-6 类的多态与继承
- Windows CE.NET Core OS 特性详解(三)----通讯服务及网络
- ASP.NET Core Web服务器 Kestrel和Http.sys 特性详解
- Windows CE.NET Core OS 特性详解(一)----应用程序和服务开发
- asp.net Core1.1版本生成超链接/a链接标签的方式
- NET Core TagHelper实现分页标签
- ASP.NET Core 中文文档 第四章 MVC(3.6.2 )自定义标签辅助类(Tag Helpers)
- ASP.NET Core教程【三】实体字段属性、链接标签、并发数据异常、文件上传及读取
- ASP.NET Core 2.0 特性介绍和使用指南
- ImageSharp .NET Core跨平台图形处理库
- ASP.NET Core Web服务器 Kestrel和Http.sys 特性详解
- 在ASP.NET Core中实现自定义验证特性(Custom Validation Attribute)
- ImageSharp .NET Core跨平台图形处理库
- ASP.NET MVC Core的TagHelper (高级特性)