链式配置中的空字符串会覆盖先前提供程序中的值

从 .NET 11 开始,通过使用 AddConfiguration 添加的配置会将空字符串视为存在的值。 因此,空字符串会覆盖之前在外层配置中注册的提供程序的值,而不是允许之前的这些值继续生效。

此变更延续了 .NET 10 中通过配置中保留的 Null 值确立的空值与 null 配置值之间的区别。 链式配置对 null 的处理保持不变。

引入的版本

.NET 11 RC 1

以前的行为

ChainedConfigurationProvider.TryGet 将空字符串报告为“未找到”。 因此,链接配置中的空值未替代早期提供程序提供的值:

using System;
using System.Collections.Generic;
using Microsoft.Extensions.Configuration;

IConfiguration inner = new ConfigurationBuilder()
    .AddInMemoryCollection(new Dictionary<string, string?>
    {
        ["Endpoint"] = "",
    })
    .Build();

IConfiguration configuration = new ConfigurationBuilder()
    .AddInMemoryCollection(new Dictionary<string, string?>
    {
        ["Endpoint"] = "https://example.com",
    })
    .AddConfiguration(inner)
    .Build();

Console.WriteLine($"Endpoint: '{configuration["Endpoint"]}'");

在.NET 11 之前,输出为:

Endpoint: 'https://example.com'

如果没有先前的值,则读取该键时返回 null,并且唯一值为链式空字符串的节被视为不存在。

新行为

从 .NET 11 开始,ChainedConfigurationProvider.TryGet会将空字符串报告为已找到。 使用前面的示例时,来自 inner 的空值将替代前面的值,输出为:

Endpoint: ''

一个值为空字符串的节现在被视为存在。 绑定还会观察空值而不是早期提供程序的值。 例如,将空字符串绑定到整数属性中之前的数值时会引发 InvalidOperationException,该行为与直接添加的提供程序提供空值时一致。

在包装的 IConfiguration 中,null 值仍被视为不存在,因为 IConfiguration 索引器无法区分值为 null 的键与缺失的键。

破坏性变更的类型

此更改为行为更改。

更改原因

空字符串是有效的配置值。 将其视为缺失会使链式配置与直接添加的配置提供程序不一致,并阻止应用程序通过用空字符串重写它来有意清除或禁用设置。 新行为保留了配置提供程序对空值与缺失值之间的区分。 有关详细信息,请参阅 dotnet/runtime#131480。

如果空字符串旨在覆盖先前的值,则无需执行任何操作。

如果你的应用依赖于链式配置中的空字符串,从而使较早提供程序的值生效,请从链式配置中删除该键,或将其表示为缺失或 null。 将链式值绑定到非字符串类型的应用程序,如果空值对目标类型无效,还应在绑定前验证或规范化空值。 没有兼容性开关可以还原以前的行为。

受影响的 API