.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,在博客园中点一个关注和推荐。