使用選項模式時如何檢查缺少的配置部分？

Question

我有一個簡單的控制器，它使用選項模式從appsettings.json讀取一些配置。 只要appsettings.json配置正確，它就可以正常工作。 但是，如果appsettings.json中缺少我的配置部分怎么辦？ 我希望得到一個Exception或null ，但我得到了一個具有默認值的MySettings對象（即MyProperty為null ）。

我的控制器.cs

public class MyController : Controller
{
    private readonly string value;

    public MyController(IOptions<MySettings> options)
    {
        // Can I validate the `options` object here?
        this.value = options.Value.MyProperty;
    }

    [HttpGet("api/data")]
    public ActionResult<string> GetValue()
    {
        return this.Ok(this.value);
    }
}

我的設置.cs

public class MySettings
{
    public string MyProperty { get; set; }
}

Startup.cs（只顯示相關代碼）

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // Tried this:
        services.Configure<MySettings>(Configuration.GetSection("MySettings"));

        // Tried this too:
        services.Configure<MySettings>(options => Configuration.GetSection("MySettings").Bind(options));
    }
}

應用設置.json

{
  "MySettings": {
    "MyProperty": "hello world"
  }
}

Answer 1

您可以通過以下方式強制執行它：

1. 向模型添加數據注釋

public class MySettings
{
    [Required]
    public string MyProperty { get; set; }
}

2. Bind調用后調用ValidateDataAnnotations

services
   .Configure<MySettings>(options => Configuration
     .GetSection("MySettings")
     .Bind(options))
     .ValidateDataAnnotations();

3. 將屬性訪問包裝在一個 try catch 中，除了OptionsValidationException

try
{
   this.value = options.Value.MyProperty;
}
catch(OptionsValidationException ex)
{
   //handle the validation exception
}

Answer 2

我在這個 SO answer上找到了一種可能的解決方案。

添加一個擴展方法來驗證：

public static class ConfigurationExtensions
{
    public static T GetValid<T>(this IConfiguration configuration)
    {
        var config = configuration.Get<T>();

        try
        {
            Validator.ValidateObject(config, new ValidationContext(config), true);
        }
        catch(Exception e)
        {
            throw new NotSupportedException("Invalid Configuration", e);
        }

        return config;
    }
}

使用該擴展方法在 Startup.cs 中驗證和注冊實例：

var settings = Configuration.GetSection("MySettings").GetValid<MySettings>();
services.AddSingleton(settings);

更改控制器構造函數以直接接受MySettings對象（而不是IOptions<MySettings> ）：

public MyController(MySettings options)
{
    this.value = options.MyProperty;
}

這種方法的另一個很好的結果是它消除了我們對IOptions的依賴，這稍微簡化了控制器。