C#对象扩展方法：提升对象操作的灵活性与效率

news2025/6/7 5:04:42

C#对象扩展方法：提升对象操作的灵活性与效率

在C#编程中，我们经常需要对对象进行各种操作，如获取对象属性信息、转换对象格式、复制对象等。通过扩展方法，我们可以为现有类型添加新的功能，而无需修改原始类型的代码。下面介绍的ObjectExtensions静态类，就通过扩展方法为object类型提供了一系列实用功能。

public static class ObjectExtensions
{
    public static Dictionary<string, string> GetPropertiesAndDescriptions(this object o)
    {
        return o.GetType().GetProperties()
            .Select(p => (p.Name, (p.GetCustomAttribute(typeof(DescriptionAttribute)) as DescriptionAttribute).Description))
            .ToDictionary(p => p.Name, p => p.Description);
    }

    public static Dictionary<string, object> GetDescriptionsAndValues(this object o)
    {
        return o.GetType().GetProperties().ToDictionary(
            f => (f.GetCustomAttribute(typeof(DescriptionAttribute)) as DescriptionAttribute).Description,
            f => f.GetValue(o)
        );
    }

    public static List<string> GetDescriptions(this object o)
    {
        return o.GetType().GetProperties()
            .Select(p => (p.GetCustomAttribute(typeof(DescriptionAttribute)) as DescriptionAttribute).Description)
            .ToList();
    }

    public static List<string> GetDisplayNames(this object o)
    {
        return o.GetType().GetProperties()
            .Select(p => (p.GetCustomAttribute(typeof(DisplayNameAttribute)) as DisplayNameAttribute).DisplayName)
            .ToList();
    }

    public static Dictionary<string, object> ToDictionary(this object o)
    {
        return o.GetType()
            .GetProperties()
            .Select(p => (p.Name, Value: p.GetValue(o)))
            .ToDictionary(p => p.Name, p => p.Value);
    }

    public static T Clone<T>(this T o) where T : new()
    {
        return JsonConvert.DeserializeObject<T>(JsonConvert.SerializeObject(o));
    }
}

一、代码解析

这个扩展类提供了六个实用方法，下面逐一解析：

1. `GetPropertiesAndDescriptions`方法

该方法通过反射获取对象属性的名称和描述信息（使用DescriptionAttribute特性标记），返回一个字典，键为属性名，值为属性描述。这在需要显示属性友好名称的场景中非常有用。

2. `GetDescriptionsAndValues`方法

此方法返回一个字典，键为属性的描述信息，值为属性的当前值。这在需要以描述信息作为标识来获取属性值的场景中很实用。

3. `GetDescriptions`方法

该方法返回对象所有属性的描述信息列表，忽略属性名和值，适用于只需要属性描述的场景。

4. `GetDisplayNames`方法

与GetDescriptions类似，但获取的是DisplayNameAttribute特性标记的显示名称，通常用于UI显示。

5. `ToDictionary`方法

将对象的所有属性名和对应值转换为字典，这在需要将对象动态转换为键值对集合的场景中非常有用，比如序列化或动态数据处理。

6. `Clone`方法

通过JSON序列化和反序列化实现对象的深拷贝。这种方法适用于大多数对象，但需要注意性能开销和循环引用问题。

二、使用示例

下面是这些扩展方法的使用示例，假设我们有一个Person类：

public class Person
{
    [Description("姓名")]
    [DisplayName("用户姓名")]
    public string Name { get; set; }

    [Description("年龄")]
    [DisplayName("用户年龄")]
    public int Age { get; set; }

    [Description("邮箱")]
    [DisplayName("电子邮箱")]
    public string Email { get; set; }
}

1. 获取属性描述和值

var person = new Person { Name = "张三", Age = 30, Email = "zhangsan@example.com" };

// 获取属性名和描述的字典
var propertiesAndDescriptions = person.GetPropertiesAndDescriptions();
// 输出: { "Name": "姓名", "Age": "年龄", "Email": "邮箱" }

// 获取描述和值的字典
var descriptionsAndValues = person.GetDescriptionsAndValues();
// 输出: { "姓名": "张三", "年龄": 30, "邮箱": "zhangsan@example.com" }

// 获取描述列表
var descriptions = person.GetDescriptions();
// 输出: [ "姓名", "年龄", "邮箱" ]

// 获取显示名称列表
var displayNames = person.GetDisplayNames();
// 输出: [ "用户姓名", "用户年龄", "电子邮箱" ]

2. 对象转字典和克隆

// 对象转字典
var dictionary = person.ToDictionary();
// 输出: { "Name": "张三", "Age": 30, "Email": "zhangsan@example.com" }

// 对象克隆
var clonedPerson = person.Clone();
// clonedPerson 是 person 的深拷贝