在 ASP.net 核心应用程序的强类型配置类中使用 System.Uri

Question

In our AspNetCore 2.2 app, we make use of strongly typed classes for configuration sections, following the pattern:

public static IServiceCollection AddMyConfigSettings(this IServiceCollection services, IConfiguration configuration)
{
    MyConfigSettings myConfigSettings = new MyConfigSettings();
    configuration.Bind("MyConfig", myConfigSettings);
    services.AddSingleton(myConfigSettings);
    return services;
}

Now the MyConfigSettings class looks like this:

public class MyConfigSettings
{
    #pragma warning disable CA1056 // Uri properties should not be strings      
    public string HostUrl { get; set; }
}

Is there an easy way to use System.Uri instead of System.String as type for HostUrl, so that we don't need to suppress the Roslyn analyzer warning CA1056 ?

Answer 1

Change the property from string to Uri .

public class MyConfigSettings {        
    public Uri HostUrl { get; set; }
}

The bind should take care of the rest.

You can also bind to the object graph like this

public static IServiceCollection AddMyConfigSettings(this IServiceCollection services, IConfiguration configuration) {
    MyConfigSettings myConfigSettings = configuration.GetSection("MyConfig").Get<MyConfigSettings>();
    services.AddSingleton(myConfigSettings);
    return services;
}

ConfigurationBinder.Get<T> binds and returns the specified type. Get<T> is more convenient than using Bind .

The preceeding code shows how to use Get<T> with the your example, which allows the bound instance to be directly assigned to the property.

Reference Configuration in ASP.NET Core: Bind to an object graph