【.NET Core】特性(Attribute)详解

简介: 【.NET Core】特性(Attribute)详解

一、概述

公共语言运行时添加类的关键描述性声明(称为特性),以便批注编程元素(如类型、字段、方法和属性)。编译运行时的代码时,它将被转换为中间语言(MSIL),并和编译器生成的元数据一起放置在可移植可执行文件内。特性使得将额外的描述信息放到可使用运行时反射服务提取的元数据中。当你声明派生自System.Attribute 的特殊类的实例时,编译器会创建特性。


在.NET内置了很多特性,这些特性描述数据序列化、指定用于强制安全性的特性并限制通过实时(JIT)编译器进行优化,来对代码进行调优。

二、编写自定义属性

2.1 自定义特性的主要步骤

  1. 应用AttributeUsageAttribute
  2. 声明特性类
  3. 声明构造函数
  4. 声明属性

2.2 应用AttributeUsageAttribute

自定义属性声明以System.AttributeUsageAttribute属性开头,定义特性类的一些主要特性。

AttributeUsageAttribute包含下列三个成员,它们对创建自定义属性非常重要:AttributeTargetsInheitedAllowMultiple

AttributeTargets 成员
成员 说明
All 32767 属性可以应用于任何应用程序元素。
Assembly 1 属性可应用于程序集。
Class 4 属性可应用于类。
Constructor 32 属性可应用于构造函数。
Delegate 4096 属性可应用于委托。
Enum 16 属性可应用于枚举。
Event 512 属性可应用于事件。
Field 256 属性可应用于字段。

1717415183498.png

Inherited属性

AttributeUsageAttribute.Inherited属性指明要对其应用属性的类的派生类能否继承此属性。此属性使用true(默认值)或false标志。

public class MyAttribute : Attribute
{
    //...
}
[AttributeUsage(AttributeTargets.Method, Inherited = false)]
public class YourAttribute : Attribute
{
    //...
}
AllowMultiple属性

AttributeUsageAttribute.AllowMultiple属性指明元素能否包含属性的多个实例。如果设置为true,则允许多个实例。如设置为false(默认值),那么只允许一个实例。

/// <summary>
/// AllowMultiple =false 不允许多个属性
/// </summary>
[AttributeUsage(AttributeTargets.Method,AllowMultiple =false)]
public class MyAttribute:Attribute
{
    ///方法体
}
/// <summary>
/// AllowMultiple =false 允许多个属性
/// </summary>
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public class MultipleMyAttribute : Attribute 
{
    ///方法体
}

当应用这些特性的多个实例时,MyAttribute会生成编译器错误吗。以下代码示例显示MultipleMyAttribute的有效以及MyAttribute无效用法:

public class AttributeService
{
    // This produces an error.
    // Duplicates are not allowed.
    [MyAttribute()]
    [MyAttribute()]
    public void Get() {}
    // This is valid.
    [MultipleMy]
    [MultipleMy]
    public void Update() { }
}

如果AllowMultiple属性和Inherited属性都设置为true,从另一个类继承的类可以继承一个属性,并具有在同一个子类中应用相同属性的另一个实例。如果AllowMultiple设置为false,则父类中的所有特性的值将被子类中一特性的新实例覆盖。


三、声明特性类

应用AttributeUsageAttribute以后,开始定义属性的细节。特性类的声明类似与传统类的声明。如以下代码所示:

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class,AllowMultiple =false)]
public class MyAttribute:Attribute
{
    ///
}

此特性定义说明了以下几点:

  • 特性类必须声明为公共类。
  • 按照约定,特性类的名称以单词Attribute结束。官方虽然没有要求,但是扔建议执行此约定以保证可读性。应用特性时,可以选择是否包含单词Attribute
  • 所有特性类必须直接或间接从System.Attribute类继承。

四、声明构造函数特性类

和传统类类似,特性是通过构造函数初始化的。下面的代码段阐明了典型的特性构造函数。此公共构造函数采用一个参数,并设置一个等于其值的成员变量。

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class,AllowMultiple =false)]
public class MyAttribute:Attribute
{
    private string myValue;
    public MyAttribute(string myValue)
    {
        this.myValue = myValue;
    }
}

可以重载此构造函数以适应值的各种组合。如果你还未自定义特性类定义了属性,则在初始化该特性时可以使用命名参数和定位参数的组合。通常情况下,将所有必须的参数定义为定位参数,将所有可选的参数定义为命名参数。在这种情况下,没有必需的参数就无法初始化属性。其他所有参数都是可选参数。


五、声明属性的特性类

如果你想要定义一个命名参数,或者提供一种简单的方法来返回由特性存储的值,请声明属性。应将特性的属性声明为公共实例,此公告实体包含将返回的数据类型的描述。定义将保存属性值的变量,并将此变量与get和set方法相关联。

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class,AllowMultiple =false)]
public class MyAttribute:Attribute
{
    public string AttributeName 
    {
        get; 
        set;
    } 
}

六、自定义特性示例

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class,AllowMultiple =false)]
public class MyAttribute:Attribute
{
    private string author;
    private DateTime data;
    private string version;
    public MyAttribute(string author, DateTime data)
    {
        this.author = author;
        this.data = data;
    }

    public virtual string Author 
    {
         get { return author; }
    }

    public virtual DateTime Data 
    {
        get { return data; }
    }

    public string Version 
    {
       get { return version; }
       set { version = value; }
    }
}

可以采用以下任意一种方法,调用自定义特性:

public class AttributeService
{
    [MyAttribute("AuthorName","2023-12-18 15:14:01")]
    public void Get(){}
    [MyAttribute("Author2","2023-12-18 16:14:49",Version="v1.0")]
    public void Update() { }     
}

七、总结

特性提供声明式编程能力,但是它们是一种元数据形式的代码,本身并不执行任何操作。可以通过反射来调用特性完成操作。

下一章将详解如何使用反射调用特性。

目录
相关文章
|
4月前
|
开发框架 .NET C#
ASP.NET Core Blazor 路由配置和导航
大家好,我是码农刚子。本文系统介绍Blazor单页应用的路由机制,涵盖基础配置、路由参数、编程式导航及高级功能。通过@page指令定义路由,支持参数约束、可选参数与通配符捕获,结合NavigationManager实现页面跳转与参数传递,并演示用户管理、产品展示等典型场景,全面掌握Blazor路由从入门到实战的完整方案。
391 6
|
开发框架 .NET 开发者
简化 ASP.NET Core 依赖注入(DI)注册-Scrutor
Scrutor 是一个简化 ASP.NET Core 应用程序中依赖注入(DI)注册过程的开源库,支持自动扫描和注册服务。通过简单的配置,开发者可以轻松地从指定程序集中筛选、注册服务,并设置其生命周期,同时支持服务装饰等高级功能。适用于大型项目,提高代码的可维护性和简洁性。仓库地址:&lt;https://github.com/khellang/Scrutor&gt;
382 5
|
11月前
|
开发框架 .NET API
.NET 10首个预览版发布:重大改进与新特性概览!
.NET 10首个预览版发布:重大改进与新特性概览!
408 3
.NET 10首个预览版发布:重大改进与新特性概览!
|
开发框架 .NET C#
在 ASP.NET Core 中创建 gRPC 客户端和服务器
本文介绍了如何使用 gRPC 框架搭建一个简单的“Hello World”示例。首先创建了一个名为 GrpcDemo 的解决方案,其中包含一个 gRPC 服务端项目 GrpcServer 和一个客户端项目 GrpcClient。服务端通过定义 `greeter.proto` 文件中的服务和消息类型,实现了一个简单的问候服务 `GreeterService`。客户端则通过 gRPC 客户端库连接到服务端并调用其 `SayHello` 方法,展示了 gRPC 在 C# 中的基本使用方法。
328 5
在 ASP.NET Core 中创建 gRPC 客户端和服务器
|
12月前
|
人工智能 机器人
D1net阅闻 | 谷歌DeepMind研究发现LLM新特性
D1net阅闻 | 谷歌DeepMind研究发现LLM新特性
|
开发框架 算法 中间件
ASP.NET Core 中的速率限制中间件
在ASP.NET Core中,速率限制中间件用于控制客户端请求速率,防止服务器过载并提高安全性。通过`AddRateLimiter`注册服务,并配置不同策略如固定窗口、滑动窗口、令牌桶和并发限制。这些策略可在全局、控制器或动作级别应用,支持自定义响应处理。使用中间件`UseRateLimiter`启用限流功能,并可通过属性禁用特定控制器或动作的限流。这有助于有效保护API免受滥用和过载。 欢迎关注我的公众号:Net分享 (239字符)
331 1
|
开发框架 缓存 .NET
GraphQL 与 ASP.NET Core 集成:从入门到精通
本文详细介绍了如何在ASP.NET Core中集成GraphQL,包括安装必要的NuGet包、创建GraphQL Schema、配置GraphQL服务等步骤。同时,文章还探讨了常见问题及其解决方法,如处理复杂查询、错误处理、性能优化和实现认证授权等,旨在帮助开发者构建灵活且高效的API。
395 3
|
自然语言处理 物联网 图形学
.NET 技术凭借其独特的优势和特性,为开发者们提供了一种高效、可靠且富有创造力的开发体验
本文深入探讨了.NET技术的独特优势及其在多个领域的应用,包括企业级应用、Web应用、桌面应用、移动应用和游戏开发。通过强大的工具集、高效的代码管理、跨平台支持及稳定的性能,.NET为开发者提供了高效、可靠的开发体验,并面对技术更新和竞争压力,不断创新发展。
710 7
|
开发框架 .NET C#
.NET 技术凭借高效开发环境、强大框架支持及跨平台特性,在软件开发中占据重要地位
.NET 技术凭借高效开发环境、强大框架支持及跨平台特性,在软件开发中占据重要地位。从企业应用到电子商务,再到移动开发,.NET 均展现出卓越性能,助力开发者提升效率与项目质量,推动行业持续发展。
394 4
|
JSON C# 开发者
C#语言新特性深度剖析:提升你的.NET开发效率
【10月更文挑战第15天】C#语言凭借其强大的功能和易用性深受开发者喜爱。随着.NET平台的演进,C#不断引入新特性,如C# 7.0的模式匹配和C# 8.0的异步流,显著提升了开发效率和代码可维护性。本文将深入探讨这些新特性,助力开发者在.NET开发中更高效地利用它们。
243 1