C#的Attribute如何为代码添加元数据？-C#.Net教程-PHP中文网

C#的Attribute如何为代码添加元数据？

月夜之吻

发布： 2025-08-26 08:59:01

原创

125人浏览过

创建自定义attribute需定义继承自system.attribute的类，并通过attributeusage指定目标元素及是否允许多次应用；1. 定义attribute类时继承attribute基类并设置适用目标；2. 使用方括号将attribute应用于类、方法等代码元素；3. 通过反射在运行时使用attribute.getcustomattribute等方法读取attribute信息；4. 实际应用包括序列化、验证、依赖注入、orm映射等场景；5. attribute本身元数据存储开销小，但频繁反射读取可能影响性能，建议通过缓存优化。

C#的Attribute如何为代码添加元数据？

C#的Attribute本质上是一种为代码元素（类、方法、属性等）附加元数据的机制。它们允许你在代码中嵌入信息，这些信息可以在编译时或运行时被读取和使用，从而实现各种各样的功能，比如序列化、验证、代码生成等等。

Attribute为代码添加元数据，通过将预定义的或自定义的Attribute应用到代码元素上实现。编译器会将这些Attribute信息存储在程序集的元数据中，之后可以通过反射在运行时访问这些信息。

Attribute的使用方式是在代码元素前使用方括号

[]

登录后复制

将Attribute名称括起来。例如，

[Serializable]

登录后复制

Attribute用于标记一个类可以被序列化。

如何创建自定义Attribute？

创建自定义Attribute需要定义一个继承自

System.Attribute

登录后复制

类的类。你可以指定Attribute可以应用到哪些代码元素上，以及是否允许多次应用。

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = false)]
public class MyCustomAttribute : Attribute
{
    public string Description { get; set; }

    public MyCustomAttribute(string description)
    {
        Description = description;
    }
}

登录后复制

这个例子定义了一个名为

MyCustomAttribute

登录后复制

的Attribute，它只能应用于类和结构体，且不允许重复应用。它还有一个名为

Description

登录后复制

的属性，可以通过构造函数设置。

如何使用自定义Attribute？

使用自定义Attribute非常简单，只需要将它应用到目标代码元素上即可。

[MyCustomAttribute("This is a sample class.")]
public class SampleClass
{
    // Class members
}

登录后复制

在这个例子中，

MyCustomAttribute

登录后复制

被应用到了

SampleClass

登录后复制

上，并传递了一个描述字符串。

如何在运行时读取Attribute信息？

可以使用反射在运行时读取Attribute信息。

System.Reflection

登录后复制

命名空间提供了访问程序集元数据的能力，包括Attribute信息。

Type type = typeof(SampleClass);
MyCustomAttribute attribute = (MyCustomAttribute)Attribute.GetCustomAttribute(type, typeof(MyCustomAttribute));

if (attribute != null)
{
    Console.WriteLine(attribute.Description); // 输出 "This is a sample class."
}

登录后复制

这段代码首先获取

SampleClass

登录后复制

的类型，然后使用

Attribute.GetCustomAttribute

登录后复制

方法获取应用到该类型的

MyCustomAttribute

登录后复制

实例。如果找到了Attribute，就可以访问它的属性。

Attribute在实际开发中的应用场景有哪些？

Attribute在实际开发中有很多应用场景，例如：

序列化和反序列化： 使用
```
[Serializable]
```
登录后复制
登录后复制
和相关Attribute控制对象的序列化过程。
验证： 使用自定义Attribute进行数据验证，例如检查字符串长度或范围。
依赖注入： 使用Attribute标记需要注入的依赖项。
代码生成： 使用Attribute指导代码生成工具生成代码。
ORM框架： 很多ORM框架使用Attribute来映射类和数据库表。

举个例子，假设你正在开发一个数据验证框架，你可以创建一个自定义Attribute来标记需要验证的属性：

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
public class RequiredAttribute : Attribute
{
    public string ErrorMessage { get; set; }

    public RequiredAttribute(string errorMessage)
    {
        ErrorMessage = errorMessage;
    }
}

登录后复制

然后，你可以将这个Attribute应用到类的属性上：

public class User
{
    [Required("Name is required.")]
    public string Name { get; set; }

    public string Email { get; set; }
}

登录后复制

最后，你可以编写一个验证器来检查属性是否满足Attribute的要求：

public class Validator
{
    public static List<string> Validate(object obj)
    {
        List<string> errors = new List<string>();
        Type type = obj.GetType();

        foreach (var property in type.GetProperties())
        {
            RequiredAttribute attribute = (RequiredAttribute)Attribute.GetCustomAttribute(property, typeof(RequiredAttribute));
            if (attribute != null)
            {
                object value = property.GetValue(obj);
                if (value == null || string.IsNullOrEmpty(value.ToString()))
                {
                    errors.Add(attribute.ErrorMessage);
                }
            }
        }

        return errors;
    }
}

登录后复制

这个验证器会遍历对象的所有属性，检查是否应用了

RequiredAttribute

登录后复制

。如果应用了，并且属性的值为空，就会将错误信息添加到错误列表中。

Attribute的性能影响？

Attribute本身对性能的影响很小，因为它们只是存储在元数据中的信息。然而，在运行时读取Attribute信息可能会有性能开销，特别是当需要频繁读取大量Attribute时。

在设计Attribute时，需要权衡其带来的便利性和性能开销。如果只需要在编译时使用Attribute信息，那么性能影响可以忽略不计。如果需要在运行时频繁读取Attribute信息，可以考虑使用缓存或其他优化技术来减少性能开销。例如，可以将Attribute信息缓存到静态字典中，避免每次都使用反射读取。

以上就是C#的Attribute如何为代码添加元数据？的详细内容，更多请关注php中文网其它相关文章！