如何编写泛型方法从Dictionary<string, object>提取不同类型值

问题背景 #

需要编写一个通用方法，从IDictionary<string, object>类型的Headers集合中，根据输入的key获取对应值并自动转换为指定类型（如int、string、datetime等）。原代码出现编译错误：'value' is a variable but its used like a type，同时需要将获取到的值赋值给模型的属性。

原错误代码：

public T GetValueForKeyFromHeader<T> (string key)
{
 object value = null;
 var hasValue = Headers?.TryGetValue(key, out value!); //IDictionary<string, object>
 return (T)Convert.ChangeType(typeof(value), typeof(T)); 
// 错误行：typeof(value)是获取变量类型，而Convert.ChangeType需要传入要转换的对象实例
}

Headers集合示例：

"apiKeyId": "guid"
"CorrelationId": 333
"test": "hello world"

目标模型属性赋值：

public string Test{get;set;} = GetValueForKeyFromHeader("test");
public int CorrelationId{get;set;} = GetValueForKeyFromHeader("CorrelationId");
public string ApiKeyId {get;set;} = GetValueForKeyFromHeader("api_key_id");

错误原因 #

错误出在Convert.ChangeType(typeof(value), typeof(T))这一行：

• typeof(value)是获取变量value的类型（即typeof(object)），而Convert.ChangeType的第一个参数需要传入要转换的对象实例，而不是类型。

另外原代码还存在两个潜在问题：

1. 未处理Headers为null的情况
2. 未处理未找到对应key的情况
3. 属性初始化器无法直接调用实例方法（C#语法限制）

修正后的代码 #

1. 通用取值转换方法 #

public T GetValueForKeyFromHeader<T>(string key)
{
    // 处理Headers为null的情况
    if (Headers == null)
        return default(T);
    
    if (Headers.TryGetValue(key, out var value))
    {
        // 如果类型已经匹配，直接返回，避免多余转换
        if (value is T typedValue)
            return typedValue;
        
        try
        {
            // 传入对象实例value，而非类型
            return (T)Convert.ChangeType(value, typeof(T));
        }
        catch (InvalidCastException)
        {
            // 转换失败时的处理，可根据需求改为抛异常
            return default(T);
        }
    }
    
    // 未找到对应key时返回类型默认值
    return default(T);
}

2. 模型属性赋值修正 #

由于C#不允许在属性初始化器中调用实例方法，需改为在构造函数中赋值：

public class YourModel
{
    public string Test { get; set; }
    public int CorrelationId { get; set; }
    public string ApiKeyId { get; set; }

    // 假设Headers是模型类的成员或可访问的数据源
    private IDictionary<string, object> Headers { get; }

    public YourModel(IDictionary<string, object> headers)
    {
        Headers = headers;
        // 在构造函数中完成赋值
        Test = GetValueForKeyFromHeader<string>("test");
        CorrelationId = GetValueForKeyFromHeader<int>("CorrelationId");
        ApiKeyId = GetValueForKeyFromHeader<string>("api_key_id");
    }

    private T GetValueForKeyFromHeader<T>(string key)
    {
        if (Headers == null)
            return default(T);
        
        if (Headers.TryGetValue(key, out var value))
        {
            if (value is T typedValue)
                return typedValue;
            
            try
            {
                return (T)Convert.ChangeType(value, typeof(T));
            }
            catch (InvalidCastException)
            {
                return default(T);
            }
        }
        
        return default(T);
    }
}

额外说明 #

• 如果需要严格校验转换失败的情况，可以将return default(T)改为抛出自定义异常，确保数据正确性
• 对于DateTime等特殊类型，Convert.ChangeType可以自动处理字符串到DateTime的转换，但要注意字符串格式符合要求

内容的提问来源于stack exchange，提问作者lonelydev101