0

0

C#如何自定义Attribute C#特性编程入门指南

畫卷琴夢

畫卷琴夢

发布时间:2026-02-07 08:50:03

|

861人浏览过

|

来源于php中文网

原创

自定义Attribute是C#中通过继承Attribute类并用AttributeUsage控制适用范围,实现元数据标注与运行时反射的关键机制;支持构造函数传参、属性赋值,并可通过反射读取以驱动权限控制、版本路由等自动化逻辑。

c#如何自定义attribute c#特性编程入门指南

自定义 Attribute 是 C# 中实现元数据标注和运行时反射的关键能力,它让代码具备“自我描述”能力,常用于权限控制、序列化配置、日志记录、API 文档生成等场景。核心在于继承 Attribute 类,并合理使用 AttributeUsage 控制其适用范围。

一、定义一个基础自定义特性

只需新建一个类,继承 Attribute,并用 [AttributeUsage] 明确它能标记哪些程序元素(如类、方法、属性等):

  • [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)] —— 表示该特性可应用于类或方法,不允许重复添加,且子类可继承
  • 构造函数通常用于必填参数(位置参数),属性用于可选参数(命名参数)

示例:

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public class ApiVersionAttribute : Attribute
{
    public ApiVersionAttribute(string version) => Version = version;
    public string Version { get; }
    public bool IsDeprecated { get; set; } = false;
}

二、在代码中应用特性

直接写在目标成员上方,支持位置参数(构造函数传入)和命名参数(属性赋值):

  • [ApiVersion("v2.1")] → 调用带参构造
  • [ApiVersion("v3.0", IsDeprecated = true)] → 构造 + 属性赋值
  • 可同时标注多个不同特性,也可(若 AllowMultiple=true)重复标注同一特性

例如:

剪小映
剪小映

记录美好智能成片,AI智能视频剪辑

下载
[ApiVersion("v2.1")]
public class UserController { }

[ApiVersion("v3.0", IsDeprecated = true)] public void GetUsers() { }

三、在运行时读取特性信息

借助 GetCustomAttributeGetCustomAttributes 方法,配合反射使用:

  • 获取类上的特性:typeof(UserController).GetCustomAttribute()
  • 获取方法上的特性:typeof(UserController).GetMethod("GetUsers").GetCustomAttribute()
  • 检查是否存在:Attribute.IsDefined(typeof(UserController), typeof(ApiVersionAttribute))

典型用法(比如 API 版本路由前检查):

var attr = method.GetCustomAttribute();
if (attr != null && attr.IsDeprecated)
{
    throw new NotSupportedException($"API {method.Name} is deprecated.");
}

四、进阶技巧与注意事项

  • 特性类的字段/属性必须是 public,且类型限于:基本类型、string、Type、其他 Attribute、以上类型的数组
  • 避免在特性中放复杂逻辑或耗时操作——特性本质是静态元数据,应在使用处(如中间件、AOP 拦截器)处理业务
  • 若需编译期校验(如要求某特性必须存在),可用 Source Generator 或 Roslyn 分析器扩展
  • 注意 Inherited = false 时,子类不会继承父类上的特性(对虚方法重写也适用)

基本上就这些。自定义 Attribute 不复杂但容易忽略细节,关键是想清楚“谁来用它”和“什么时候读它”。写好之后,搭配反射或框架扩展点(如 ASP.NET Core 的 IAuthorizationFilterIActionFilter),就能解锁大量自动化能力。

相关文章

编程速学教程(入门课程)
编程速学教程(入门课程)

编程怎么学习?编程怎么入门?编程在哪学?编程怎么学才快?不用担心,这里为大家提供了编程速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

179

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

222

2025.12.18

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

606

2023.08.02

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

606

2023.08.02

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

606

2023.08.02

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

534

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

17

2025.12.06

attributeusage
attributeusage

attributeusage是是C#中用于指定自定义属性的有效目标的类。通过使用AttributeUsage,可以控制自定义属性在何处可以应用,以便更好地管理和利用元数据,有助于提高代码的可读性和可维护性,使开发人员能够更好地理解和使用代码中的属性。本专题为大家提供attributeusage相关的各种文章、以及下载和课程。

248

2023.07.13

Golang处理数据库错误教程合集
Golang处理数据库错误教程合集

本专题整合了Golang数据库错误处理方法、技巧、管理策略相关内容,阅读专题下面的文章了解更多详细内容。

2

2026.02.06

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 3.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.4万人学习

Kotlin 教程
Kotlin 教程

共23课时 | 3.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号