C# AttributeUsage

最新推荐文章于 2024-05-24 17:39:14 发布
最新推荐文章于 2024-05-24 17:39:14 发布
阅读量714 收藏 2
点赞数
分类专栏： C# 文章标签： AttributeUsage C# Attribute C# 属性
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liqiangeastsun/article/details/129317865
版权

C# AttributeUsage

预定义特性 AttributeUsage 描述了如何使用一个自定义特性类。它规定了特性可应用到的项目的类型。

规定该特性的语法如下：

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

validon：自定义特性的对象，可以是类、方法、属性等对象（默认值是 AttributeTargets.All）AttributeTargets 所有类型如下 可以使用 或运算符 |
AttributeTargets.All = AttributeTargets.Assembly | AttributeTargets.Module 等所有组合

    [Flags]
    public enum AttributeTargets
    {
        Assembly = 1,
        Module = 2,
        Class = 4,
        Struct = 8,
        Enum = 16,
        Constructor = 32,
        Method = 64,
        Property = 128,
        Field = 256,
        Event = 512,
        Interface = 1024,
        Parameter = 2048,
        Delegate = 4096,
        ReturnValue = 8192,
        GenericParameter = 16384,
        All = 32767
    }

AllowMultiple：是否允许被多次使用（默认值为false：单用的）
Inherited：是否可被派生类继承（默认值为false：不能）

定义如下

using System;

// 定义一个 NpcAttribute，
// AttributeTargets.Class标记为类Class 使用
// AllowMultiple = true 可以多次使用
// Inherited = true 可以被继承/派生子类
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public class NpcAttribute : Attribute
{
    public NpcAttribute()
    {
    }
}

使用如下

// 标记 NpcClass 类使用 NpcAttribute 属性
[Npc]
public class NpcClass
{
}

NpcClassExtend  继承 NpcClass
public class NpcClassExtend : NpcClass
{
}

标记了属性，如何使用、获取如下

private void NpcTest()
    {
        // 实例一个对象
        NpcClass npcClass = new NpcClass();

        // 获取对象类型
        Type t = npcClass.GetType();
        // 打印类型名
        Debug.LogError("t.Name:" + t.Name);

        // 获取 typeof(NpcAttribute) 属性， true 包含继承的
        object[] objAttrs = t.GetCustomAttributes(typeof(NpcAttribute), true);
        if (null != objAttrs && objAttrs.Length > 0)
        {
            for (int i = 0; i < objAttrs.Length; ++i)
            {
                object temp = objAttrs[i];
                // 类型转换
                NpcAttribute npcAttribute = temp as NpcAttribute;
                // 获取类型
                Debug.LogError("NpcClass 获取到 NpcAttribute:" + npcAttribute.ToString());
            }
        }
        else
        {
            Debug.LogError("NpcClass 未找到 NpcAttribute");
        }

        // 上面执行打印结果
        // t.Name:NpcClass
        // NpcClass 获取到 NpcAttribute:NpcAttribute
    }

    private void NpcExtendTest()
    {
        // 实例一个对象
        NpcClassExtend npcClassExtend = new NpcClassExtend();

        // 获取对象类型
        Type t = npcClassExtend.GetType();

        // 打印类型名
        Debug.LogError("t.Name:" + t.Name);

        // 获取 typeof(NpcAttribute) 属性， true 包含继承的
        object[] objAttrs = t.GetCustomAttributes(typeof(NpcAttribute), false);
        if (null != objAttrs && objAttrs.Length > 0)
        {
            for (int i = 0; i < objAttrs.Length; ++i)
            {
                object temp = objAttrs[i];
                // 类型转换
                NpcAttribute npcAttribute = temp as NpcAttribute;
                // 获取类型
                Debug.LogError("NpcClassExtend 获取到 NpcAttribute:" + npcAttribute.ToString());
            }
        }
        else
        {
            Debug.LogError("NpcClassExtend 未找到 NpcAttribute");
        }

        // 上面执行打印结果
        // t.Name:NpcClassExtend
        // NpcClassExtend 获取到 NpcAttribute:NpcAttribute

        // 如果上面代码修改，第二个参数 inherit 为 false
        // object[] objAttrs = t.GetCustomAttributes(typeof(NpcAttribute), false);
        // 执行打印结果
        // t.Name:NpcClassExtend
        // NpcClassExtend 未找到 NpcAttribute
        // 因为 NpcClass 标记了[Npc]，NpcClassExtend 继承了 NpcClass
        // 获取时如果函数 GetCustomAttributes(Type attributeType, bool inherit)中 inherit 赋值为 false
        // 则 NpcClassExtend 无法获取到 NpcAttribute 属性
    }

修改

// Inherited = false 不允许派生、继承
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false)]
public class NpcAttribute : Attribute
{
    public NpcAttribute()
    {
    }
}

下面获取的 objAttrs 中是获取不到 NpcAttribute 的

 // 实例一个对象
        NpcClassExtend npcClassExtend = new NpcClassExtend();

        // 获取对象类型
        Type t = npcClassExtend.GetType();

        // 打印类型名
        Debug.LogError("t.Name:" + t.Name);

        // 获取 typeof(NpcAttribute) 属性， true 包含继承的
        object[] objAttrs = t.GetCustomAttributes(typeof(NpcAttribute), true);

AllowMultiple = true 作用，允许多次使用，代码如下

[Npc]
[Npc]
[Npc]
public class NpcClass
{

}

    private void NpcTest()
    {
        // 实例一个对象
        NpcClass npcClass = new NpcClass();

        // 获取对象类型
        Type t = npcClass.GetType();
        // 打印类型名
        Debug.LogError("t.Name:" + t.Name);

        // 获取 typeof(NpcAttribute) 属性， true 包含继承的
        object[] objAttrs = t.GetCustomAttributes(typeof(NpcAttribute), true);
        if (null != objAttrs && objAttrs.Length > 0)
        {
            for (int i = 0; i < objAttrs.Length; ++i)
            {
                object temp = objAttrs[i];
                // 类型转换
                NpcAttribute npcAttribute = temp as NpcAttribute;
                // 获取类型
                Debug.LogError("NpcClass 获取到 NpcAttribute:" + npcAttribute.ToString());
            }
        }
        else
        {
            Debug.LogError("NpcClass 未找到 NpcAttribute");
        }

        // 上面执行打印结果
        // t.Name:NpcClass
        // NpcClass 获取到 NpcAttribute:NpcAttribute
        // NpcClass 获取到 NpcAttribute:NpcAttribute
        // NpcClass 获取到 NpcAttribute:NpcAttribute
    }

上面代码打印了三行 NpcClass 获取到 NpcAttribute:NpcAttribute，是因为NpcClass使用了三次标记[Npc]

修改代码，将 AllowMultiple 赋值为 false

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public class NpcAttribute : Attribute
{
    public NpcAttribute()
    {
    }
}

则 NpcClass 报错，多次使用了 Npc 属性
Assets\Script\NpcClass.cs(6,2): error CS0579: Duplicate ‘Npc’ attribute

定义可传参数的属性，修改代码如下

using System;

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public class NpcAttribute : Attribute
{
    private string _descript;
    public NpcAttribute(string descript)
    {
        _descript = descript;
    }

    public string Descript
    {
        get { return _descript; }
    }
}

[Npc("Npc 添加一次 ")]
[Npc("Npc 添加二次 ")]
[Npc("Npc 添加三次 ")]
public class NpcClass
{
}

public class NpcClassExtend : NpcClass
{

}

    private void NpcTest()
    {
        // 实例一个对象
        NpcClass npcClass = new NpcClass();

        // 获取对象类型
        Type t = npcClass.GetType();
        // 打印类型名
        Debug.LogError("t.Name:" + t.Name);

        // 获取 typeof(NpcAttribute) 属性， true 包含继承的
        object[] objAttrs = t.GetCustomAttributes(typeof(NpcAttribute), true);
        if (null != objAttrs && objAttrs.Length > 0)
        {
            for (int i = 0; i < objAttrs.Length; ++i)
            {
                object temp = objAttrs[i];
                // 类型转换
                NpcAttribute npcAttribute = temp as NpcAttribute;
                // 获取类型
                Debug.LogError("NpcClass 获取到 NpcAttribute:" + npcAttribute.ToString() + "   " + npcAttribute.Descript);
            }
        }
        else
        {
            Debug.LogError("NpcClass 未找到 NpcAttribute");
        }

        // 上面执行打印结果
        // t.Name:NpcClass
        // NpcClass 获取到 NpcAttribute:NpcAttribute   Npc 添加一次 
        // NpcClass 获取到 NpcAttribute:NpcAttribute   Npc 添加二次 
        // NpcClass 获取到 NpcAttribute:NpcAttribute   Npc 添加三次 
    }

    private void NpcExtendTest()
    {
        // 实例一个对象
        NpcClassExtend npcClassExtend = new NpcClassExtend();

        // 获取对象类型
        Type t = npcClassExtend.GetType();

        // 打印类型名
        Debug.LogError("t.Name:" + t.Name);

        // 获取 typeof(NpcAttribute) 属性， true 包含继承的
        object[] objAttrs = t.GetCustomAttributes(typeof(NpcAttribute), true);
        if (null != objAttrs && objAttrs.Length > 0)
        {
            for (int i = 0; i < objAttrs.Length; ++i)
            {
                object temp = objAttrs[i];
                // 类型转换
                NpcAttribute npcAttribute = temp as NpcAttribute;
                // 获取类型
                Debug.LogError("NpcClassExtend 获取到 NpcAttribute:" + npcAttribute.ToString() + "   " + npcAttribute.Descript);
            }
        }
        else
        {
            Debug.LogError("NpcClassExtend 未找到 NpcAttribute");
        }

        // 上面执行打印结果
        // t.Name:NpcClassExtend
        // NpcClassExtend 获取到 NpcAttribute:NpcAttribute   Npc 添加一次 
        // NpcClassExtend 获取到 NpcAttribute:NpcAttribute   Npc 添加二次 
        // NpcClassExtend 获取到 NpcAttribute:NpcAttribute   Npc 添加三次 
    }
[奋斗不止]
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
C# Attribute
随便积累点东西
11-01 5629
Attribute的基本概念 经常有朋友问，Attribute是什么？它有什么用？好像没有这个东东程序也能运行。实际上在.Net中，Attribute是一个非常重要的组成部分，为了帮助大家理解和掌握Attribute，以及它的使用方法，特地收集了几个Attribute使用的例子，提供给大家参考。 在具体的演示之前，我想先大致介绍一下Attribute。我们知道在类的成员中有prop
C#总览
weixin_43912806的博客
08-09 142
面向对象特性 统一的类型系统 类型 共同的基类 类和接口 class interface 属性方法和事件 唯一的函数成员：方法 方法包含属性和事件 函数式编程 函数可以看作值：委托 类型安全 C#类型 静态类型 动态类型 强类型 CLR .NET核心是CLR CLR和语言无关，所以C#是一种托管代码，先会被编译成托管代码（IL），CLR再将其转换成机器代...
C# 特性（Attribute）
weixin_43055166的博客
11-27 438
特性（Attribute）是用于在运行时传递程序中各种元素（比如类、方法、结构、枚举、组件等）的行为信息的声明性标签。您可以通过使用特性向程序添加声明性信息。一个声明性标签是通过放置在它所应用的元素前面的方括号（[ ]）来描述的。 特性（Attribute）用于添加元数据，如编译器指令和注释、描述、方法、类等其他信息。.Net 框架提供了两种类型的特性：预定义特性和自定义特性。 规定特性（Attribute） 规定特性（Attribute）的语法如下： [attribute(positional_param
C#的自定义属性AttributeUsage用法
星河队长
04-21 1879
// 描述如何使用一个自定义特性 SomethingAttribute [AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = true)] //********自定义特性SomethingAttribute**************// public cl...
C# 特性(Attribute)超详细教程
最新发布
明明明的博客
05-24 2417
C# 特性(Attribute)超详细教程
【C#学习笔记】：自定义特性 Custom Attribute
chenshulove的专栏
10-07 1441
C#中的自定义特性（Attribute）是一种扩展元数据并向代码元素添加附加信息的方法。它们允许你将自定义元数据附加到类、方法、属性、字段等。C#中有一些内置特性，可以用来向代码元素添加元数据。例如，[Serializable]特性可用于将类标记为可序列化。您也可以创建自己的自定义特性来添加元数据或配置运行时行为。自定义特性在增强代码的功能和行为方面起着至关重要的作用。它们提供了一种灵活的机制，用于添加描述性信息、配置运行时行为和启用运行时反射。
C#高级--特性详解
热门推荐
李宥的博客
08-02 1万+
C#高级–特性详解 一、什么是特性 1、特性定义 **特性（Attribute）**是用于在运行时传递程序中各种元素（比如类、方法、结构、枚举、组件等）的行为信息的声明性标签。您可以通过使用特性向程序添加声明性信息。一个声明性标签是通过放置在它所应用的元素前面的方括号（[ ]）来描述的。 特性（Attribute）用于添加元数据，如编译器指令和注释、描述、方法、类等其他信息。.Net 框架提供了两种类型的特性：预定义特性和自定义特性。 2、特性的语法 特性（Attribute）的名称和值是在方括号内规定的，
C# AttributeUsage的使用
zpllfm的博客
01-06 535
　　C# AttributeUsage的使用是如何的呢？首先让我们来了解一下什么是AttributeUsage类它是另外一个预定义特性类，AttributeUsage类的作用就是帮助我们控制定制特性的使用。其实AttributeUsage类就是描述了一个定制特性如和被使用。 　　C# AttributeUsage的使用要明白： 　　AttributeUsage有三个属性，我们可以把它放...
C#AttributeUsage使用案例详解.docx
06-21
下面是 C#AttributeUsage 的使用案例详解。 首先，让我们了解一下 AttributeUsage 类。它是一个预定义的特性类，用于描述一个定制特性如何和被使用。AttributeUsage 类有三个属性：ValidOn、AllowMultiple 和 ...
AOPBILLING_C#_
09-29
[AttributeUsage(AttributeTargets.Method)] public class BillingAttribute : Attribute { } ``` 2. **动态代理（Dynamic Proxy）**：.NET框架提供了`System.Reflection.Emit`和`Castle.DynamicProxy`库等工具，...
C#命名管道实现以及扩展
01-31
[AttributeUsage(AttributeTargets.Method)] public class PipeMethodAttribute : Attribute { public string MethodName { get; } public PipeMethod(string methodName) { this.MethodName = methodName; } }...
c#语言规范
04-28
[AttributeUsage(AttributeTargets.Class)] public class VersionAttribute : Attribute { public string Version { get; } public VersionAttribute(string version) { Version = version; } } [Version(...
c#特性（Attribute）简单示例
12-13
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] public class MyCustomAttribute : Attribute { public string Description { get; set; } public MyCustomAttribute(string description) { ...
C# 特性（Attribute）总结
明月清风@的博客
06-15 4494
特性的作用就是对程序中所标记元素的另加描述和限限制。就像生活中的坐火车的车票一样，对该行程进行了进一步描述（如哪个站，目的地，出发时间等），同时也对描述信息进行了限制（如你错过发车时间就不能上车），出现任何差错都会视为异常。
自定义特性
qq_31975127的博客
01-07 483
1.指定AttributeUsage特性 特性（attribute）类本身用一个特性——System.AttributeUsage特性来标记。AttributeUsage主要用于标识自定义特性可以应用到哪些类型的程序元素上。这些信息由它的第一参数给出，改参数是必选的，其类型是枚举类型的AttributeTargets。 AttributeTargets枚举的成员如下： All,Assembl...
C# 特性详解（Attribute）
codingriver的博客
10-26 5506
今天整理关于特性的资料，之前都忘了，今天整理一下 参考《C#高级编程》第10版 0X01 特性（Attribute） 特性定义 特性不会影响编译过程，因为编译器不能识别它们，但这些特性在应用于程序元素时，可以在编译好的程序集中用作元数据 上面这句话是书上说的，但不太认可，如果通过反射来使用特性呢 这里假设某个类上使用了特性如下： [Test] class BBB { ...
（C#学习）Attribute：AttributeUsage和反射
ZJ_____W的博客
03-15 490
Attribute（特性） Attribute类将预定义的系统信息或用户定义的自定义信息与目标元素关联起来。 目标元素可以是程序集、类、构造函数、委托、枚举、事件、字段、接口、方法、可移植的可执行文件模块、参数、属性、返回值、结构或其他属性。 Attribute是C#的一种语言特性，用于为各种实体（Class,field,property）附加一些说明性信息，并且可以在运行时环境中检索这些信息（通过反射方式）。 1.AttributeUsage AttributeUsage是Attribute的Attrib
C#入门（13）：特性Attribute
琅嬛福地
11-16 349
C# 特性（Attributes）是用于在运行时为程序元素（如类、方法、属性等）添加声明性信息的一种方式。这些信息可以在程序运行时通过反射（Reflection）访问。特性可以用来控制程序行为、添加元数据或者影响程序的运行时行为。
C# OnActionExecuting 跳过
06-06
在 C# 中，可以通过在 ActionFilterAttribute 中重写 OnActionExecuting 方法来实现在执行 Action 之前对请求进行拦截和处理。如果需要跳过该方法的执行，可以使用 SkipActionFilterAttribute 属性来标记该方法，如下所示： ``` [AttributeUsage(AttributeTargets.Method, AllowMultiple = true)] public class MyActionFilterAttribute : ActionFilterAttribute { public override void OnActionExecuting(ActionExecutingContext context) { var skipFilter = context.ActionDescriptor.EndpointMetadata.OfType<SkipActionFilterAttribute>().Any(); if (!skipFilter) { // 执行自定义逻辑 } } } [AttributeUsage(AttributeTargets.Method)] public class SkipActionFilterAttribute : Attribute { } ``` 在上述代码中，MyActionFilterAttribute 继承了 ActionFilterAttribute，并重写了 OnActionExecuting 方法。在方法中，首先获取 SkipActionFilterAttribute 属性是否存在，如果存在，则跳过该方法的执行，否则执行自定义逻辑。 使用 SkipActionFilterAttribute 属性可以灵活控制方法的执行，方便开发者根据实际情况进行自定义处理。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值