Converting IConfigurationSection to IOptions

user_195965 0
Viewed 7076

The Options pattern allowed me to create options objects containing values from configuration, as described here: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/options

I need the values for one option object within an IDesignTimeDbContextFactory implementation, to be used by EF when creating the models. (The values in that config section will be used for data seeding, and so I added IOptions to the DB Context constructor.)

As I have no access to IServiceCollection (since it's design time - like when running "dotnet ef migrations add", I need to have another way to convert an IConfigurationSection (representing the section I'm interested in) to my custom Options class.

May I know how I can do this without dependency injection?

asp.net-core-2.0 entity-framework-core asp.net-core c#
4 Answers

You can use the Bind(Configuration, object) extension method to perform manual binding of any object. Here's an example:

var myCustomOptions = new MyCustomOptions();
myConfigurationSection.Bind(myCustomOptions);

// Use myCustomOptions directly.

To wrap this in an IOptions<T>, use Options.Create:

IOptions<MyCustomOptions> myOptions = Options.Create(myCustomOptions);
user_26300780

you can also use

config.Get<MyCustomOptions>()

This is an extension method from Microsoft.Extensions.Configuration namespace. I see it in Assembly Microsoft.Extensions.Configuration.Binder, Version=3.1.9.0. Perhaps, it exists in earlier versions also. That would give you the Settings object itself. then you can wrap it into IOptions as Krik showed in another answer.

user_17603290

I guess you need Bind method:

var config = new ConfigurationBuilder()...Build();
var myOptions = new MyOptions();
config.GetSection("MyOptions").Bind(myOptions);
user_4602980

ServiceCollectionContainerBuilderExtensions makes this work in the SoapCore

The part from my application worked out like that:

            services.AddSingleton<IRESAdapterService>(new RESAdapterService(
                new XController(
                    services.BuildServiceProvider().GetRequiredService<IOptions<XApiSettingsFromJsonClass>>(),
                    _xLogger
                    )));

Also usable in the integrity unittests

user_9142840
Related