Configuration strongly typed anche per singleton con IOptionsMonitor in ASP.NET Core

di Marco De Sanctis, in ASP.NET Core,

Negli scorsi script (https://www.aspitalia.com/script/1403/Reagire-Modifiche-Configurazione-ASP.NET-Core.aspx e https://www.aspitalia.com/script/1404/Usare-Option-Pattern-Gestire-Configurazione-ASP.NET-Core.aspx) ci siamo occupati del refresh della configurazione in ASP.NET Core, e abbiamo analizzato sostanzialmente tre differenti opzioni:

  • Iniettare IConfiguration direttamente: questo oggetto (almeno nel setup di default dei progetti ASP.NET Core) monitora il file appsettings.json e, nel caso di modifica, ne rilegge il contenuto. In questo modo possiamo essere sicuri di rileggere sempre i valori aggiornati, seppure in maniera non tipizzata e con uso di stringhe;
  • definire un oggetto TOptions che rappresenti la nostra configurazione - o una sua parte - e iniettare IOptions, nel caso non siamo interessati a rileggere i settings se dovessero essere modificati;
  • effettuare gli stessi passaggi del punto precedente, ma questa volta iniettare un'istanza di IOptionsSnapshot in questo modo riceveremo ogni volta i dati aggiornati al momento dell'inizio della richiesta.

Un problema di IOptionsSnapshot è che, per definizione, è registrato come Scoped, e pertanto possiamo utilizzarlo come dipendenza solo per servizi a loro volta Transient o Scoped.

Quando invece abbiamo un servizio Singleton, del quale vogliamo aggiornare i setting se dovessero cambiare, dobbiamo invece sfruttare una terza interfaccia, chiamata IOptionsMonitor.

Immaginiamo allora di avere un servizio MyService che registreremo come Singleton:

public void ConfigureServices(IServiceCollection services)
{
    // ... altro codice qui ...
    services.AddSingleton<MyService>();

    services.Configure<ValueOption>(Configuration.GetSection("option"));
}

Come possiamo notare, abbiamo anche configurato il nostro ValueOption in maniera del tutto analoga a quella degli esempi visti nello script precedente.

Dato che MyService è Singleton, possiamo iniettare un'istanza di ValueOption tramite IOptionsMonitor:

public class MyService
{
    private DateTime _timestamp = DateTime.Now;
    private ValueOption _option;

    public MyService(IOptionsMonitor<ValueOption> option)
    {
        _option = option.CurrentValue;

        option.OnChange(newValue => _option = newValue);
    }

    public string GetString()
    {
        return $"{_timestamp}: {_option.MyStringValue}";
    }
}

Nel servizio abbiamo innanzi tutto salvato il valore corrente di ValueOption al momento della creazione dell'istanza di MyService. Successivamente, abbiamo registrato un handler per l'evento OnChange che, in presenza di una modifica ad appsettings.json, effettuerà il refresh del field _option con i nuovi valori.

Questo è un sistema molto elegante per poter mantenere la configurazione di MyService aggiornata pur continuando ad accedervi in maniera tipizzata.

Un'ultima nota riguarda il fatto che, data la natura asincrona del refresh, questo potrebbe avvenire in ogni momento, anche in concomitanza con l'esecuzione di un metodo. Quindi dobbiamo tenerne conto se accediamo alle option più volte all'interno dello stesso metodo, e vogliamo garantire che abbiano sempre lo stesso valore in quel contesto di esecuzione:

public void DoSomething()
{
    var currentOption = _option;
    DoSomethingWithValue(currentOption.MyStringValue);

    // .. altro codice qui ..

    DoSomethingElseWithValue(currentOption.MyStringValue);
}

Se accedessimo direttamente al field _option, invece, potrebbe accadere che DoSomethingWithValue e DoSomethingElseWithValue leggano diversi valori in presenza di race condition.

Commenti

Visualizza/aggiungi commenti

| Condividi su: Twitter, Facebook, LinkedIn

Per inserire un commento, devi avere un account.

Fai il login e torna a questa pagina, oppure registrati alla nostra community.

Approfondimenti

I più letti di oggi