C#的ExpandoObject如何动态添加属性？

星降

发布时间：2025-08-14 11:06:02

942人浏览过

来源于php中文网

原创

expandoobject 允许在运行时动态添加属性，适用于处理未知结构的数据；1. 可像字典一样添加属性：直接赋值即可；2. 删除属性：通过 idictionary<string, object> 接口的 remove 方法实现；3. 检查属性是否存在：使用 containskey 方法判断；4. 遍历属性：可 foreach 遍历其键值对；它在动态 json 反序列化、简化数据转换、动态配置、测试与原型设计中特别有用；相比强类型对象，优点是灵活性高、易用且无需预定义类，缺点是缺乏类型安全、性能较低、可维护性差；为避免陷阱，应谨慎使用，优先在数据结构不确定时采用，配合单元测试保障正确性，必要时继承 dynamicobject 重写 trygetmember 和 trysetmember 实现自定义逻辑，或实现 idynamicmetaobjectprovider 进行更底层控制。

C#的ExpandoObject如何动态添加属性？

直接来说，C# 的 ExpandoObject 允许你在运行时动态地添加属性，这提供了一种非常灵活的方式来处理未知结构的数据，或者构建动态的模型。

解决方案

ExpandoObject 实际上是一个实现了

IDictionary<string, object>

接口的类。这意味着你可以像操作字典一样操作它的属性。

添加属性：

最简单的方法就是像操作字典一样，直接赋值：

dynamic expando = new ExpandoObject();
expando.Name = "张三";
expando.Age = 30;

Console.WriteLine(expando.Name); // 输出: 张三
Console.WriteLine(expando.Age);  // 输出: 30

删除属性：

由于 ExpandoObject 实现了

IDictionary<string, object>

接口，你可以使用

Remove

方法删除属性：

IDictionary<string, object> expandoDict = expando as IDictionary<string, object>;
expandoDict.Remove("Age");

// 尝试访问 Age 会抛出异常，或者返回 null，取决于你如何处理动态对象的访问
try
{
    Console.WriteLine(expando.Age);
}
catch (RuntimeBinderException ex)
{
    Console.WriteLine("属性不存在"); // 输出: 属性不存在
}

检查属性是否存在：

你可以使用

ContainsKey

方法检查属性是否存在：

if (expandoDict.ContainsKey("Name"))
{
    Console.WriteLine("Name 属性存在"); // 输出: Name 属性存在
}

循环遍历属性：

因为 ExpandoObject 实现了

IDictionary<string, object>

接口，你可以像遍历字典一样遍历它的属性：

foreach (var kvp in expandoDict)
{
    Console.WriteLine($"Key: {kvp.Key}, Value: {kvp.Value}");
}

ExpandoObject 在哪些场景下特别有用？

Sora

Sora是OpenAI发布的一种文生视频AI大模型，可以根据文本指令创建现实和富有想象力的场景。

下载

ExpandoObject 在处理以下场景时非常有用：

动态 JSON 反序列化： 当你需要处理结构未知的 JSON 数据时，可以将 JSON 反序列化为 ExpandoObject，然后动态访问其中的属性，而无需预先定义类结构。这在处理来自外部 API 的数据时尤其有用。

using System.Text.Json;

string jsonString = "{ \"name\": \"李四\", \"city\": \"北京\" }";
dynamic obj = JsonSerializer.Deserialize<ExpandoObject>(jsonString);
Console.WriteLine(obj.name); // 输出: 李四
Console.WriteLine(obj.city); // 输出: 北京

简化数据转换： 如果你需要在不同的数据结构之间进行转换，而又不想创建大量的中间类，可以使用 ExpandoObject 作为桥梁。可以将数据源的属性复制到 ExpandoObject，然后将其传递给需要不同数据结构的组件。
动态配置： 可以利用 ExpandoObject 构建动态配置系统。将配置信息存储在 ExpandoObject 中，允许在运行时修改配置，而无需重新编译代码。
测试和原型设计： 在测试或原型设计阶段，当数据结构尚未完全确定时，可以使用 ExpandoObject 快速创建动态对象，以便进行实验和验证。

ExpandoObject 与强类型对象相比，有哪些优缺点？

优点：

灵活性： 最大的优点就是灵活性。你可以在运行时动态地添加、删除属性，无需预先定义类结构。
易用性： 使用起来非常简单，就像操作字典一样。
无需预定义类： 避免了创建大量 DTO (Data Transfer Object) 类的麻烦。

缺点：

类型安全： 由于是动态类型，编译时无法进行类型检查，容易出现运行时错误。例如，如果尝试访问一个不存在的属性，或者将一个字符串赋值给一个期望数字类型的属性，编译器无法发现这些错误，只能在运行时才能发现。
性能： 动态类型的性能通常不如强类型。每次访问属性都需要进行动态查找，这会带来一定的性能开销。
可维护性： 由于缺乏类型信息，代码的可读性和可维护性可能会降低。如果代码中大量使用 ExpandoObject，可能会使代码难以理解和调试。

如何避免 ExpandoObject 的常见陷阱？

谨慎使用： 虽然 ExpandoObject 提供了很大的灵活性，但不要过度使用。只有在真正需要动态类型的场景下才应该使用它。如果数据结构是已知的，并且不会经常变化，那么应该优先使用强类型对象。
单元测试： 由于 ExpandoObject 缺乏编译时类型检查，因此需要编写大量的单元测试来确保代码的正确性。测试应该覆盖各种可能的场景，包括访问不存在的属性、赋值错误类型的值等等。
使用动态语言特性： C# 的
```
dynamic
```
关键字允许你在编译时绕过类型检查，这使得你可以像在动态语言（如 Python 或 JavaScript）中一样操作对象。但是，这也意味着你需要更加小心，因为编译器不会帮你发现类型错误。
使用
```
TryGetMember
```
和
TrySetMember
方法：如果你需要更精细地控制属性的访问和修改，可以继承
```
DynamicObject
```
类，并重写
```
TryGetMember
```
和
```
TrySetMember
```
方法。这允许你自定义属性的获取和设置逻辑，例如添加验证、类型转换等。

public class MyDynamicObject : DynamicObject
{
    private Dictionary<string, object> _data = new Dictionary<string, object>();

    public override bool TryGetMember(GetMemberBinder binder, out object result)
    {
        string name = binder.Name.ToLower();
        if (_data.ContainsKey(name))
        {
            result = _data[name];
            return true;
        }
        else
        {
            result = null;
            return false;
        }
    }

    public override bool TrySetMember(SetMemberBinder binder, object value)
    {
        string name = binder.Name.ToLower();
        _data[name] = value;
        return true;
    }
}