C#技术栈入门到精通系列3——特性Attribute

阅读目录

1、介绍

2、特性使用

3、自定义特性

　　3.1、自定义无参特性

　　3.2、自定义有参特性

　　3.3、特性类修饰AttributeUsage

4、特性应用案例

5、参考

返回系列文章目录 

1、介绍

　　官方介绍：使用特性，可以有效地将元数据或声明性信息与代码（程序集、类型、方法、属性等）相关联。 将特性与程序实体相关联后，可以在运行时使用 反射 这项技术查询特性。我个人的理解，特性就是给程序（可以是程序集、类、接口、方法、属性等等）标注一些信息，在使用的时候用反射来读取区分，进行特殊处理，使程序去耦合。可以简单理解为，特性是用来标记一种功能，在另一个地方实现这种功能。使用的时候在一个地方用[]来标注，另一个地方反射读取进行特殊处理，例如MVC、ORM、IOC容器等很多地方都是使用特性来实现。

2、特性使用

　　这里我们使用官方的Obsolete特性来介绍怎么使用的。Obsolete特性是标注一个方法已经过时了，不推荐使用。创建一个类TestClassOne，代码如下

// TestClassOne.cs
using System;

namespace Demo02_Attribute
{
    public class TestClassOne
    {
        [Obsolete]
        public void TestMethodOne(string msg)
        {
            Console.WriteLine($"TestClassOne.TestMethodOne( {msg} )");
        }
        public void TestMethodTwo(string msg)
        {
            Console.WriteLine($"TestClassOne.TestMethodTwo( {msg} )");
        }
    }
}

如果你创建TestClassOne类的实例，去调用被Obsolete特性标记的TestMethodOne方法的时候，这个调用的下面会有波浪线提示这个方法是被弃用的。

// 使用特性
namespace Demo02_Attribute
{
    class Program
    {
        static void Main(string[] args)
        {
            TestClassOne testClassOne = new TestClassOne();
            testClassOne.TestMethodOne("轻轻河边草、悠悠天不老");
            testClassOne.TestMethodTwo("野火烧不尽、风雨吹不倒");
            Console.ReadKey();
        }
    }
}

3、自定义特性

　　自定义特性分三步：编写特性类，标记特性，用反射读取特性处理。

3.1、自定义无参特性

// 创建自定义特性类
using System;

namespace Demo03_Attribute
{
    public class CustomOneAttribute: Attribute
    {
    }
}

// 标记使用特性
namespace Demo03_Attribute
{
    [CustomOneAttribute] //可以简写[CustomOne]
    public class Student
    {
        [CustomOne]
        public string Name { get; set; }
        public int Age { get; set; }
        [CustomOne]
        public void Sing()
        {
        }
        public void Say()
        {
        }
    }
}

// 使用反射读取被特性标记的类、方法、属性
using System;

namespace Demo03_Attribute
{
    class Program
    {
        static void Main(string[] args)
        {
            Student student = new Student();
            var type = student.GetType();
            //看看类是否被特性标记
            if(type.IsDefined(typeof(CustomOneAttribute),true))
            {
                //拿去被标记的特性
                var attributeArr = type.GetCustomAttributes(typeof(CustomOneAttribute), true);
                foreach (var attr in attributeArr)
                {
                    //attr就是每个标记的自定义特性CustomOneAttribute
                    
                }

            }

            //遍历查找被自定义特性标记的方法
            foreach (var method in type.GetMethods())
            {
                if (method.IsDefined(typeof(CustomOneAttribute), true))
                {
                    //method就是被自定义特性标记的
                    var attributeArr = method.GetCustomAttributes(typeof(CustomOneAttribute), true);
                    foreach (var attr in attributeArr)
                    {
                        //attr就是每个标记的自定义特性CustomOneAttribute

                    }
                }
            }

            //遍历查找被自定义特性标记的属性
            foreach (var prop in type.GetProperties())
            {
                if (prop.IsDefined(typeof(CustomOneAttribute), true))
                {
                    //prop就是被自定义特性标记的
                    var attributeArr = prop.GetCustomAttributes(typeof(CustomOneAttribute), true);
                    foreach (var attr in attributeArr)
                    {
                        //attr就是每个标记的自定义特性CustomOneAttribute

                    }
                }
            }

            Console.ReadKey();
        }
    }
}

3.2、自定义有参特性

　　向上面这样标记一个特性，通过反射去读取，然后找出来编写附件功能，这样太单一（一个特性只能标记一种），我们还可以把参数保存在特性类中，这样即使标记了同一种特性，也可以根据参数不同而差异化处理。例如下面。

// 创建有参数特性
using System;
namespace Demo03_Attribute
{
    public class CustomTwoAttribute:Attribute
    {
        public int age;
        private string _name;
        public CustomTwoAttribute(string name)
        {
            this._name = name;
        }
    }
}

// 标记使用特性
namespace Demo03_Attribute
{
    public class Animal
    {
        [CustomTwoAttribute("甜美",age = 7)]
        public void Jump()
        {
        }
    }
}

// 使用反射把特性属性读出来
using System;

namespace Demo03_Attribute
{
    class Program
    {
        static void Main(string[] args)
        {
            Animal animal = new Animal();
            var type = animal.GetType();
            foreach (var method in type.GetMethods())
            {
                if (method.IsDefined(typeof(CustomTwoAttribute), true))
                {
                    //method就是被自定义特性标记的
                    var attributeArr = method.GetCustomAttributes(typeof(CustomTwoAttribute), true);
                    foreach (var attr in attributeArr)
                    {
                        //attr就是每个标记的自定义特性CustomTwoAttribute
                        CustomTwoAttribute customTwoAttribute = (CustomTwoAttribute)attr;
                        
                    }
                }
            }

            Console.ReadKey();
        }
    }
}

3.3、特性类修饰AttributeUsage

　　有的场合，我们定义的特性只能给特定的对象用，比如类、方法、属性这样分类的，这个时候，我们就需要限制自定义特性使用的环境，这个时候就需要使用 AttributeUsage 来标记自定义特性了。 

例如：[AttributeUsage(AttributeTargets.Class, Inherited = true, AllowMultiple = true)]   //这个特性只能标记在类上面，具有继承性，允许同时标记多次

// 特性修饰
using System;
namespace Demo03_Attribute
{
    //AttributeTargets指定这个特性能修饰程序的哪部分
    //Inherited指定这个特性子类也被继承
    //AllowMultiple允许重复修饰
    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property, Inherited = true, AllowMultiple = true)]
    public class CustomThreeAttribute:Attribute
    {
    }
}

4、特性应用案例

　　看了上面的内容你肯定会感觉空洞乏味，不知所云，是不是向问一句，有没有实际的案例举一个呢。现在举个简单的案例，比如有的时候，我们后台定义枚举类型来定义员工的职位（general manager, director, manager, supervisor, employee），前台显示的时候，需要显示一些更具有亲和力的称呼（总经理、总监、经理、主管、员工）

// 定义job特性
using System;

namespace Demo03_Attribute
{
    [AttributeUsage(AttributeTargets.Field)]
    public class JobAttribute: Attribute
    {
        private string _job;
        public string Job {
            get { return _job; }
        }
        public JobAttribute(string job)
        {
            this._job = job;
        }
    }
}

// 后台枚举类中标记Job特性
namespace Demo03_Attribute
{
    public enum EnumJob
    {
        [Job("总经理")]
        GeneralManager,
        [Job("总监")]
        Director,
        [Job("经理")]
        Manager,
        [Job("主管")]
        Supervisor,
        [Job("员工")]
        Employee
    }
}

// 新建特性扩展，用来转换
namespace Demo03_Attribute
{
    public class AttributeExtend
    {
        public static string GetJob(EnumJob value)
        {
            var type = value.GetType();
            var field = type.GetField(value.ToString());
            if (field.IsDefined(typeof(JobAttribute), true)){
                JobAttribute jobAttribute = (JobAttribute)field.GetCustomAttribute(typeof(JobAttribute), true);
                return jobAttribute.Job;
            }
            return value.ToString();
        }
    }
}

// 前台获取
var job = EnumJob.Employee;
var jobName = AttributeExtend.GetJob(job);
Console.WriteLine($"{job}：{jobName}");

5、参考

特性 (C#)  https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/concepts/attributes/

创建自定义特性 (C#)  https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/concepts/attributes/creating-custom-attributes

编写自定义特性  https://docs.microsoft.com/zh-cn/dotnet/standard/attributes/writing-custom-attributes

使用反射访问特性 (C#)  https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/concepts/attributes/accessing-attributes-by-using-reflection

检索存储在特性中的信息  https://docs.microsoft.com/zh-cn/dotnet/standard/attributes/retrieving-information-stored-in-attributes

利用特性扩展元数据  https://docs.microsoft.com/zh-cn/dotnet/standard/attributes/

C# 保留的特性：Conditional, Obsolete, AttributeUsage  https://docs.microsoft.com/zh-cn/dotnet/csharp/language-reference/attributes/general

C# 保留的特性：跟踪调用方信息  https://docs.microsoft.com/zh-cn/dotnet/csharp/language-reference/attributes/caller-information