C#怎么获取特性值_C#反射读取类与方法上的Attribute【核心】

云芳同学_8056

云芳同学_8056

2026-04-28

615人浏览

原创

直接调用getcustomattribute()读取类上单个特性最常用但易出错:它只返回首个匹配实例,未找到时返回null;需显式传inherit: true才查继承链,且若特性定义时设inherited = false则无效。

c#怎么获取特性值_c#反射读取类与方法上的attribute【核心】

怎么用 GetCustomAttribute 读取类上的单个特性

直接调用 GetCustomAttribute 是最常用也最容易出错的方式。它只返回第一个匹配类型的特性(不考虑继承),如果没找到就返回 null,不会抛异常。

常见错误是传错类型参数:比如把 MyAttr 写成 typeof(MyAttr) —— 实际上这个方法重载接受的是 Type,但你写 typeof(MyAttr) 没问题;真正容易错的是漏掉 true 参数导致不查基类。

  • 必须显式传 true 才会搜索继承链上的特性(例如基类或接口上标记的)
  • 若特性没加 [AttributeUsage(Inherited = true)],即使传 true 也查不到父类的
  • 方法和类共用同一特性时,别误用 MethodInfo 去查类——得用 typeof(MyClass).GetCustomAttribute<myattr>()</myattr>

示例:

var attr = typeof(MyController).GetCustomAttribute<routeattribute>(true);</routeattribute>
这样才能拿到 [Route("api/values")] 这种在基类上定义的路由。

为什么 GetCustomAttributes 返回数组却常要 FirstOrDefault

GetCustomAttributes 返回 Attribute[],但多数场景其实只关心是否存在、或只取一个实例。直接遍历或索引访问容易崩:空数组、null 元素、类型转换失败都可能发生。

典型踩坑点:attributes[0] as MyAttr —— 如果数组为空会抛 IndexOutOfRangeException;而 as 在类型不匹配时返回 null,但你可能误以为“有值但不是你要的类型”。

  • 优先用泛型版本:GetCustomAttributes<myattr>(true)</myattr>,返回 MyAttr[],类型安全
  • 真要取首个且允许不存在,用 .FirstOrDefault(),比 [0] 安全得多
  • 注意:GetCustomAttributes(true) 和 GetCustomAttributes<t>(true)</t> 行为一致,但后者省去强制转换

示例:

var attrs = methodInfo.GetCustomAttributes<obsoleteattribute>(true);<br>var obsolete = attrs.FirstOrDefault();</obsoleteattribute>

IsDefined 比 GetCustomAttribute 更轻量的判断方式

如果你只关心“有没有这个特性”,不要值本身,就别调 GetCustomAttribute。它内部会实例化特性对象,哪怕你只读一个属性,开销也比 IsDefined 大不少。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

尤其在高频路径(如 MVC 过滤器筛选、API 权限检查)中,这个差异会被放大。而且 IsDefined 不受特性构造函数异常影响——有些特性构造时抛异常,GetCustomAttribute 就挂了,IsDefined 却稳稳返回 false。

  • 参数和 GetCustomAttribute 一样,也要传 true 控制是否查继承链
  • 返回 bool,无异常风险,适合守卫逻辑
  • 不能替代取值操作,只是“存在性快检”

示例:

if (methodInfo.IsDefined(typeof(AllowAnonymousAttribute), true)) { /* 跳过权限校验 */ }

方法参数上的特性为什么总拿不到

因为参数特性不在 MethodInfo 上,而在 ParameterInfo 上。新手常对着 methodInfo.GetCustomAttribute<fromqueryattribute>()</fromqueryattribute> 空转,其实得先拿到参数再查。

另一个坑是:ASP.NET Core 的 [FromQuery]、[FromBody] 这些其实是“元数据标记”,运行时不一定以真实特性形式存在——它们可能被框架在编译期处理或通过其他机制注入,反射查不到是正常现象。

  • 正确路径:methodInfo.GetParameters()[0].GetCustomAttribute<fromrouteattribute>()</fromrouteattribute>
  • 若参数有多个同类型特性(比如自定义的 [ValidateRange(1,100)]),记得用 GetCustomAttributes<t>()</t> 而非单个获取
  • 某些框架(如 gRPC 或 Source Generators)会绕过传统特性机制,此时反射必然失效

示例:

var param = methodInfo.GetParameters().First(p => p.Name == "id");<br>var routeAttr = param.GetCustomAttribute<fromrouteattribute>();</fromrouteattribute>

特性反射看似简单,但类型擦除、继承控制、参数层级、框架干预这四点交织在一起,很容易查到“应该有却为空”。动手前先确认特性是否真的存在于目标元素上,而不是依赖 IDE 提示或文档描述。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

c#

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

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

1032

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

2971

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

885

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2615

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

312

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

389

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

631

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

329

20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习