Как внедрить или использовать IConfiguration в функции Azure V3 с внедрением зависимостей при настройке службы

9

Обычно в проекте .NET Core я создаю класс boostrap для настройки моей службы вместе с командами регистрации DI. Обычно это метод расширения, в IServiceCollectionкотором я могу вызвать такой метод, .AddCosmosDbServiceи все необходимое «самодостаточно» в статическом классе, содержащем этот метод. Ключ , однако, что метод получает IConfigurationот Startupкласса.

В прошлом я работал с DI в функциях Azure, но еще не сталкивался с этим конкретным требованием.

Я использую IConfigurationдля привязки к конкретному классу свойства, совпадающие с настройками как из моего, local.settings.jsonтак и из параметров приложения dev / production, когда функция развернута в Azure.

CosmosDbClientSettings.cs

/// <summary>
/// Holds configuration settings from local.settings.json or application configuration
/// </summary>    
public class CosmosDbClientSettings
{
    public string CosmosDbDatabaseName { get; set; }
    public string CosmosDbCollectionName { get; set; }
    public string CosmosDbAccount { get; set; }
    public string CosmosDbKey { get; set; }
}

BootstrapCosmosDbClient.cs

public static class BootstrapCosmosDbClient
{
    /// <summary>
    /// Adds a singleton reference for the CosmosDbService with settings obtained by injecting IConfiguration
    /// </summary>
    /// <param name="services"></param>
    /// <param name="configuration"></param>
    /// <returns></returns>
    public static async Task<CosmosDbService> AddCosmosDbServiceAsync(
        this IServiceCollection services,
        IConfiguration configuration)
    {
        CosmosDbClientSettings cosmosDbClientSettings = new CosmosDbClientSettings();
        configuration.Bind(nameof(CosmosDbClientSettings), cosmosDbClientSettings);

        CosmosClientBuilder clientBuilder = new CosmosClientBuilder(cosmosDbClientSettings.CosmosDbAccount, cosmosDbClientSettings.CosmosDbKey);
        CosmosClient client = clientBuilder.WithConnectionModeDirect().Build();
        CosmosDbService cosmosDbService = new CosmosDbService(client, cosmosDbClientSettings.CosmosDbDatabaseName, cosmosDbClientSettings.CosmosDbCollectionName);
        DatabaseResponse database = await client.CreateDatabaseIfNotExistsAsync(cosmosDbClientSettings.CosmosDbDatabaseName);
        await database.Database.CreateContainerIfNotExistsAsync(cosmosDbClientSettings.CosmosDbCollectionName, "/id");

        services.AddSingleton<ICosmosDbService>(cosmosDbService);

        return cosmosDbService;
    }
}

Startup.cs

public class Startup : FunctionsStartup
{

    public override async void Configure(IFunctionsHostBuilder builder)
    {
        builder.Services.AddHttpClient();
        await builder.Services.AddCosmosDbServiceAsync(**need IConfiguration reference**); <--where do I get IConfiguration?
    }
}

Очевидно, что добавление частного поля для IConfigurationin Startup.csне будет работать, так как оно должно быть заполнено чем-то, и я также прочитал, что использование DI для IConfigurationне очень хорошая идея .

Я также попытался использовать шаблон параметров, как описано здесь, и реализован так:

builder.Services.AddOptions<CosmosDbClientSettings>()
    .Configure<IConfiguration>((settings, configuration) => configuration.Bind(settings));

В то время как это будет работать для внедрения IOptions<CosmosDbClientSettings>нестатического класса, я использую статический класс для хранения своей работы по настройке.

Любые предложения о том, как я могу сделать эту работу или возможное решение? Я бы предпочел хранить всю конфигурацию в одном месте (файл начальной загрузки).

Джейсон Бритье
источник

Ответы:

5

Связанный пример плохо разработана (на мой взгляд). Это поощряет тесную связь и смешивание асинхронных и блокирующих вызовов.

IConfigurationпо умолчанию добавляется в коллекцию сервисов как часть запуска, поэтому я бы предложил изменить ваш дизайн, чтобы воспользоваться преимуществами отложенного разрешения зависимостей, чтобы их IConfigurationможно было разрешить с помощью сборки с IServiceProviderиспользованием фабричного делегата.

public static class BootstrapCosmosDbClient {

    private static event EventHandler initializeDatabase = delegate { };

    public static IServiceCollection AddCosmosDbService(this IServiceCollection services) {

        Func<IServiceProvider, ICosmosDbService> factory = (sp) => {
            //resolve configuration
            IConfiguration configuration = sp.GetService<IConfiguration>();
            //and get the configured settings (Microsoft.Extensions.Configuration.Binder.dll)
            CosmosDbClientSettings cosmosDbClientSettings = configuration.Get<CosmosDbClientSettings>();
            string databaseName = cosmosDbClientSettings.CosmosDbDatabaseName;
            string containerName = cosmosDbClientSettings.CosmosDbCollectionName;
            string account = cosmosDbClientSettings.CosmosDbAccount;
            string key = cosmosDbClientSettings.CosmosDbKey;

            CosmosClientBuilder clientBuilder = new CosmosClientBuilder(account, key);
            CosmosClient client = clientBuilder.WithConnectionModeDirect().Build();
            CosmosDbService cosmosDbService = new CosmosDbService(client, databaseName, containerName);

            //async event handler
            EventHandler handler = null;
            handler = async (sender, args) => {
                initializeDatabase -= handler; //unsubscribe
                DatabaseResponse database = await client.CreateDatabaseIfNotExistsAsync(databaseName);
                await database.Database.CreateContainerIfNotExistsAsync(containerName, "/id");
            };
            initializeDatabase += handler; //subscribe
            initializeDatabase(null, EventArgs.Empty); //raise the event to initialize db

            return cosmosDbService;
        };
        services.AddSingleton<ICosmosDbService>(factory);
        return service;
    }
}

Обратите внимание на подход, используемый для обхода необходимости использовать async voidв неасинхронном обработчике событий.

Ссылка Async / Await - Лучшие практики в асинхронном программировании .

Так что теперь Configureможно правильно вызывать.

public class Startup : FunctionsStartup {

    public override void Configure(IFunctionsHostBuilder builder) =>
        builder.Services
            .AddHttpClient()
            .AddCosmosDbService();
}
Nkosi
источник
4

Вот пример, который мне удалось взбить; он устанавливает соединение с конфигурацией приложения Azure для централизованного управления конфигурацией и функциями. Следует иметь возможность использовать все функции DI, такие как IConfigurationи IOptions<T>, так же, как и в контроллере ASP.NET Core.

Зависимости NuGet

  • Install-Package Microsoft.Azure.Functions.Extensions
  • Install-Package Microsoft.Extensions.Configuration.AzureAppConfiguration

Startup.cs

[assembly: FunctionsStartup(typeof(Startup))]

public class Startup : FunctionsStartup
{
    public override void Configure(IFunctionsHostBuilder hostBuilder) {
        var serviceProvider = hostBuilder.Services.BuildServiceProvider();
        var configurationRoot = serviceProvider.GetService<IConfiguration>();
        var configurationBuilder = new ConfigurationBuilder();
        var appConfigEndpoint = configuration["AppConfigEndpoint"];

        if (configurationRoot is IConfigurationRoot) {
            configurationBuilder.AddConfiguration(configurationRoot);
        }

        if (!string.IsNullOrEmpty(appConfigEndpoint)) {
            configurationBuilder.AddAzureAppConfiguration(appConfigOptions => {
                // possible to run this locally if refactored to use ClientSecretCredential or DefaultAzureCredential
                appConfigOptions.Connect(new Uri(appConfigEndpoint), new ManagedIdentityCredential());
            });
        }

        var configuration = configurationBuilder.Build();

        hostBuilder.Services.Replace(ServiceDescriptor.Singleton(typeof(IConfiguration), configuration));

        // Do more stuff with Configuration here...
    }
}

public sealed class HelloFunction
{
    private IConfiguration Configuration { get; }

    public HelloFunction(IConfiguration configuration) {
        Configuration = configuration;
    }

    [FunctionName("HelloFunction")]
    public void Run([TimerTrigger("0 */1 * * * *")]TimerInfo myTimer, ILogger log) {
        log.LogInformation($"Timer Trigger Fired: 'Hello {Configuration["Message"]}!'");
    }
}
Kittoes0124
источник
При таком подходе у меня возникает проблема, что host.jsonпараметры не используются, в частности,routePrefix
Андрей
1
@Andrii Интересно, мне придется провести небольшое исследование и отредактировать свой пост, если будет найдено решение; спасибо огромное за головы!
Kittoes0124