如何检查.NET Core中是否存在配置节？

Question

如何检查appsettings.json.NET Core中是否存在配置节？

即使一个节不存在，以下代码也将始终返回实例化的实例。

例如

var section = this.Configuration.GetSection<TestSection>("testsection");

Answer 1

从.NET Core 2.0开始，您还可以调用ConfigurationExtensions.Exists扩展方法来检查是否存在某个节。

var section = this.Configuration.GetSection("testsection");
var sectionExists = section.Exists();

由于GetSection(sectionKey) 从不返回null，因此可以安全地调用Exists其返回值。

阅读有关ASP.NET Core中的配置的文档也很有帮助。

Answer 2

在.Net 6中，有一个新的扩展方法：

ConfigurationExtensions.GetRequiredSection()

InvalidOperationException如果没有包含给定键的部分，则抛出此异常。

此外，如果您使用IOptionswith 模式AddOptions<TOptions>()， .Net 6 中还添加了ValidateOnStart()扩展方法，以便能够指定验证应在启动时运行，而不是仅在IOptions解析实例时运行。

通过一些值得怀疑的聪明才智，您可以将其结合起来GetRequiredSection()以确保某个部分确实存在：

// Bind MyOptions, and ensure the section is actually defined.
services.AddOptions<MyOptions>()
    .BindConfiguration(nameof(MyOptions))
    .Validate<IConfiguration>((_, configuration)
        => configuration.GetRequiredSection(nameof(MyOptions)) is not null)
    .ValidateOnStart();

Answer 3

查询 Configuration 的子项并检查是否有名称为“testsection”的子项

var sectionExists = Configuration.GetChildren().Any(item => item.Key == "testsection"));

如果“testsection”存在，这应该返回true，否则返回false。