.NET Core 8.0 配置绑定行为变更：字典类型现在会包含空键值-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00109/article/details/148549439

.NET Core 8.0 配置绑定行为变更：字典类型现在会包含空键值

docs This repository contains .NET Documentation. 项目地址: https://gitcode.com/gh_mirrors/docs2/docs

引言

在.NET应用程序开发中，配置绑定是一个常用的功能，它允许开发者将配置文件中的内容直接映射到强类型的对象模型上。在.NET 8中，微软对配置绑定到字典类型时的行为做出了一个重要变更，这个变更可能会影响现有应用程序的行为。

变更概述

在.NET 8之前，当配置绑定到字典类型时，如果配置中存在没有对应值的键（空键），这些键会被跳过，不会添加到字典中。从.NET 8 Preview 5开始，这种行为发生了变化：现在这些空键会被添加到字典中，并使用类型的默认值进行初始化。

变更详情

旧行为（.NET 7及更早版本）

考虑以下JSON配置示例：

{
    "Queues": {
        "q1": {
            "V": 1
        },
        "q2": {
            "V": 2
        },
        "q3": {
        }
    }
}

当这个配置绑定到以下类时：

public class QueueConfig
{
    public Dictionary<string, QueueValue> Queues { get; set; } = new();
}

public class QueueValue
{
    public int V { get; set; }
}

在.NET 7及更早版本中，绑定后的字典只包含q1和q2，q3会被忽略：

q1: 1
q2: 2

新行为（.NET 8及以后版本）

在.NET 8中，同样的配置绑定会产生不同的结果：

q1: 1
q2: 2
q3: 0  // 注意：q3现在被添加了，值为int的默认值0

变更原因

这个变更是基于用户反馈做出的。主要考虑如下：

一致性：确保配置中的所有键都能在字典中找到，避免"部分存在"的情况
可预测性：开发者可以确信配置中声明的所有键都会出现在字典中
简化逻辑：不需要额外检查键是否存在，减少了条件判断代码

影响范围

这个变更会影响所有使用以下API进行配置绑定的场景：

Microsoft.Extensions.Configuration.ConfigurationBinder类
IConfigurationRoot的扩展方法
OptionsConfigurationServiceCollectionExtensions中的相关方法

迁移建议

如果你的应用程序依赖于旧行为，需要进行以下调整：

代码审查：检查所有字典配置绑定的代码，确认是否依赖空键被忽略的行为
逻辑调整：如果新行为不符合预期，可以：
- 修改配置，移除空键
- 在绑定后手动过滤掉值为默认值的项
测试验证：确保变更后的行为不会破坏现有功能

示例解决方案

如果需要在.NET 8中保持旧行为，可以在绑定后添加过滤逻辑：

var options = new QueueConfig();
configuration.Bind(options);

// 过滤掉值为默认值的项
options.Queues = options.Queues
    .Where(kvp => kvp.Value != default)
    .ToDictionary(kvp => kvp.Key, kvp => kvp.Value);