Jak wstrzykiwać lub używać IConfiguracji w funkcji Azure V3 z funkcją wstrzykiwania zależności podczas konfigurowania usługi


9

Zwykle w projekcie .NET Core stworzyłbym klasę „boostrap”, aby skonfigurować moją usługę wraz z poleceniami rejestracji DI. Zazwyczaj jest to metoda rozszerzenia, w IServiceCollectionktórej mogę wywołać metodę podobną .AddCosmosDbServicei wszystko, co niezbędne, jest „samodzielne” w klasie statycznej zawierającej tę metodę. Kluczem jest jednak, że metoda pobiera IConfigurationz Startupklasy.

Pracowałem z DI w Azure Functions w przeszłości, ale jeszcze nie spotkałem się z tym konkretnym wymaganiem.

Używam IConfigurationdo powiązania z konkretną klasą z właściwościami dopasowującymi ustawienia zarówno mojego, local.settings.jsonjak i ustawień aplikacji deweloperskiej / produkcyjnej, gdy funkcja jest wdrażana na platformie 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?
    }
}

Oczywiście dodanie prywatnego pola dla IConfigurationw Startup.csnie będzie działać, ponieważ musi być wypełnione czymś, a także przeczytałem, że używanie DI dla IConfigurationnie jest dobrym pomysłem .

Próbowałem również użyć wzorca opcji, jak opisano tutaj i zaimplementowałem jako taki:

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

Chociaż działałoby to w celu wstrzyknięcia IOptions<CosmosDbClientSettings>do klasy niestatycznej, używam klasy statycznej do wstrzymania mojej pracy konfiguracyjnej.

Wszelkie sugestie na temat tego, jak mogę to zrobić lub możliwe obejście? Wolałbym zachować całą konfigurację w jednym miejscu (plik bootstrap).

Odpowiedzi:


5

Związane przykładem jest źle zaprojektowane (moim zdaniem). Zachęca do ścisłego łączenia i miksowania asynchronicznego oczekiwania i blokowania połączeń.

IConfigurationjest domyślnie dodawany do kolekcji usług w ramach uruchamiania, dlatego sugerowałbym zmianę projektu, aby skorzystać z odroczonego rozwiązania zależności, aby IConfigurationmożna je było rozwiązać za pomocą wbudowanegoIServiceProvider przy użyciu delegata fabrycznego.

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;
    }
}

Zwróć uwagę na podejście zastosowane w celu obejścia konieczności używania async void w niesynchronicznej procedurze obsługi zdarzeń.

Odniesienie Async / Await - najlepsze praktyki w programowaniu asynchronicznym .

Więc teraz Configuremożna poprawnie wywołać.

public class Startup : FunctionsStartup {

    public override void Configure(IFunctionsHostBuilder builder) =>
        builder.Services
            .AddHttpClient()
            .AddCosmosDbService();
}

4

Oto przykład, który udało mi się pobić; ustanawia połączenie z konfiguracją aplikacji Azure w celu scentralizowanego zarządzania konfiguracją i funkcjami. Powinno być możliwe korzystanie ze wszystkich funkcji DI, takich jak IConfigurationi IOptions<T>, tak jak w kontrolerze ASP.NET Core.

Zależności 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"]}!'");
    }
}

Przy takim podejściu mam problem polegający na tym, że host.jsonparametry nie są używane, w szczególnościroutePrefix
Andrii

1
@Andrii Interesujące, będę musiał zrobić trochę badań i będę edytować mój post, jeśli znajdzie rozwiązanie; dzięki tona za heads-up!
Kittoes0124
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.