自定义特性是继承Attribute的类,用于添加元数据并结合反射在运行时读取。1. 定义时使用[AttributeUsage]指定目标、是否允许多次使用及继承性;2. 应用时以[特性名]标记类、方法等;3. 通过反射获取特性实例并处理。典型场景包括日志监控、权限验证、序列化控制、MVC路由过滤、数据校验和AOP编程。命名建议以”Attribute”结尾,使用时可省略后缀,构造函数传必填参数,属性设可选值,保持特性轻量不可变,合理配置AttributeUsage。

在 C# 中,自定义特性(Custom Attribute) 是一种允许你在代码中添加元数据的机制。这些元数据可以在运行时通过反射读取,用于控制程序行为、标记类或方法用途、实现 AOP(面向切面编程)、序列化控制等场景。
一、如何定义自定义特性
自定义特性本质上是一个继承自 System.Attribute 的类。你可以通过以下步骤创建:
1. 创建特性类
使用 [AttributeUsage] 指定该特性可以应用的目标(如类、方法、属性等):
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]public class LogActionAttribute : Attribute{ public string Description { get; set; } public bool Enabled { get; set; }public LogActionAttribute(string description){ Description = description; Enabled = true;}
}
AttributeTargets:指定能应用此特性的程序元素,比如 Class、Method、Property 等。AllowMultiple:是否允许多次应用于同一目标。Inherited:是否被派生类或重写成员继承。
2. 应用自定义特性
将特性添加到类、方法或其他支持的目标上:
[LogAction("用户登录操作", Enabled = true)]public class LoginService{ [LogAction("验证用户名密码")] public bool ValidateUser(string username, string password) { return !string.IsNullOrEmpty(username); }}
3. 在运行时读取特性信息(使用反射)
通过反射获取类型或成员上的特性,并进行相应处理:
var method = typeof(LoginService).GetMethod("ValidateUser");var attr = method.GetCustomAttribute();if (attr != null && attr.Enabled){Console.WriteLine($"正在执行: {attr.Description}");}
二、自定义特性的典型使用场景
1. 日志与监控
标记需要记录日志的方法或服务,配合拦截机制自动输出调用信息。
2. 权限验证
例如定义 [RequireRole("Admin")] 特性,在进入方法前检查用户角色。
3. 序列化控制
像 JSON 或 XML 序列化库常用 [JsonProperty]、[XmlIgnore] 这类特性来控制字段行为。
4. MVC/WebAPI 中的路由和过滤器
ASP.NET Core 大量使用特性,如 [HttpGet]、[Authorize]、[ValidateAntiForgeryToken]。
5. 配置验证
为模型添加数据注解特性,如 [Required]、[StringLength(100)],用于输入校验。
6. AOP 编程(结合 IoC 容器或动态代理)
在方法执行前后插入逻辑,比如性能监控、事务管理等。
三、命名约定与最佳实践
特性类名通常以 "Attribute" 结尾,但使用时可省略该后缀(如 [LogAction] 实际对应 LogActionAttribute)。构造函数参数是必需参数,属性用于可选配置。避免在特性中包含复杂逻辑或状态,应保持轻量且不可变。合理设置 AttributeUsage,防止误用。
基本上就这些。自定义特性 + 反射是构建灵活框架的重要手段,掌握它能让你写出更具扩展性的代码。
以上就是C#怎么自定义特性 C# Attribute的定义和使用场景的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1441817.html
微信扫一扫
支付宝扫一扫