LA CONFIGURAZIONE IN ASP.NET CORE MVC

LA CONFIGURAZIONE IN ASP.NET CORE MVC

ACCEDERE AI VALORI DI CONFIGURAZIONE CON IL SERVIZIO ICONFIGURATION

La configurazione è un servizio che ci consentirà di tenere i parametri di funzionamento dell’applicazione al di fuori del codice C#. Li terremo in un file JSON senza essere costretti a ricompilare l’applicazione dopo una modifica. In questo modo se l’applicazione l’abbiamo venduta a un cliente potrà modificare la configurazione senza conoscere il funzionamento interno. Creiamo un file appsettings.json, l’applicazione è già predisposta a leggere i valori da questo file, ovviamente se presente. Ecco il codice per ottenere la ConnectionString al database. Nota come sia stato configurato nel costruttore il servizio IConfiguration.

USARE UNA CONFIGURAZIONE FORTEMENTE TIPIZZATA CON IL SERVIZIO IOPTIONSMONITOR<T>

Abbiamo visto che per ottenere una connectionString abbiamo dovuto fornire dei parametri di tipo stringa in GetSection(…) e GetValue<T>(…). Ora l’abbiamo detto più volte quando abbiamo a che fare con delle stringhe possiamo fare errori di digitazione. Vediamo come accedere in maniera fortemente tipizzata al file appsettings.json. Creiamo una nuova classe nel folder Options ConnectionStringsOptions.cs. Ora andiamo a registrare questa classe nel file Startup.cs. Ecco una slide riepilogativa.

FONTI DI CONFIGURAZIONE

I valori di configurazione non sono tutti uguali perché alcuni hanno requisiti di sensibilità diversa. Ad esempio, il numero di corsi per pagina non è un’informazione sensibile, mentre invece una ConnectionString a SQLServer potrebbe contenere informazioni sensibili, come lo User Name, la password e l’indirizzo ip del server. Per evitare di divulgare queste informazioni ASP.NET Core ci mette a disposizione diverse fonti di configurazione.

La fonte meno prioritaria può essere sovrascritta da una fonte a priorità maggiore. Se voglio ridefinire il valore PerPage in appsettings.development.json e scrivo il valore 20 questo sovrascriverà il valore 10 impostato in appsettings.json perché la priorità della fonte di configurazione è maggiore.

ALTRE FONTI DI CONFIGURAZIONE

Vediamo gli user secrets che vengono tenuti lontani dal progetto. Se ad esempio io e il mio collega abbiamo bisogno di lavorare con ConnectionString differenti fino a che siamo in sviluppo possiamo usare questa fonte di configurazione.

IL SERVIZIO DI CONFIGURAZIONE

La maggior parte delle applicazioni è abbastanza flessibile da ammettere una configurazione. Ad esempio, la stringa di connessione al database o il numero di corsi da visualizzare nell’elenco sono valori di configurazione che dovremmo tenere in una fonte esterna all’applicazione, come un file di testo. In questo modo, il nostro committente potrà modificare liberamente tali valori secondo le sue necessità, senza dover chiedere a noi sviluppatori di apportare modifiche al codice C# o di ricompilare l’applicazione.

ASP.NET Core può avvalersi di varie fonti di configurazione esterne all’applicazione, come ad esempio il file appsettings.json, in cui possiamo inserire valori di configurazione organizzati su più sezioni annidate.

In questo esempio, nella sezione ConnectionStrings si trova la chiave Default a cui è stato assegnato il valore Data Source=Data/MyCourse.db che rappresenta una stringa di connessione al database.

1. {
2. “ConnectionStrings”: {
3.   “Default”: “Data Source=Data/MyCourse.db”
4. }
5. }

Per leggere il valore dall’applicazione, riceviamo il servizio IConfiguration dal costruttore di un componente qualsiasi, compresa la classe Startup. Nel seguente esempio leggiamo il valore dal nostro servizio infrastrutturale SqliteDatabaseAccessor.

1. public class SqliteDatabaseAccessor : IDatabaseAccessor
2. {
3. private readonly IConfiguration configuration;
5. //Ricevo il servizio dal costruttore
6. public SqliteDatabaseAccessor(IConfiguration configuration)
7. {
8.   //Conservo il riferimento al servizio su un campo privato…
9. this.configuration = configuration;
10. }
12. public async Task QueryAsync(FormattableString formattableQuery)
13. {
14.   //…e da qui leggiamo il valore della chiave “Default” della sezione “ConnectionStrings”
15.   string connectionString = configuration.GetValue(“ConnectionStrings:Default”);
17.   //Oppure, dato che si tratta di un valore di tipo string potremmo scrivere più brevemente
18.   //string connectionString = configuration[“ConnectionStrings:Default”];
19.          
20.   //O ancora, dato che il valore si trova nella sezione “ConnectionStrings”:
21.   //string connectionString = configuration.GetConnectionString(“Default”);
23.   //TODO: Qui usiamo connectionString per collegarci al database
24.    
25. }
26. }

IL SERVIZIO IOPTIONSMONITOR<T>

Come abbiamo visto in questo esempio, al servizio IConfiguration dobbiamo fornire il percorso della chiave di configurazione, come ConnectionStrings:Default, in cui è stato usato il carattere : come separatore di nomi.

Questa tecnica può prestarsi a errori di digitazione che scopriremmo solo a runtime e perciò, per renderci più produttivi, ASP.NET Core offre anche un altro servizio chiamato IOptionsMonitor<T> che ci permette di accedere ai valori di configurazione in maniera fortemente tipizzata, così che ogni eventuale errore venga segnalato all’atto della compilazione.

Andiamo dunque a riscrivere l’esempio precedente come segue:

1. public class SqliteDatabaseAccessor : IDatabaseAccessor
2. {
3. private readonly IOptionsMonitor<ConnectionStringsOptions> options;
5. //Ricevo il servizio dal costruttore
6. public SqliteDatabaseAccessor(IOptionsMonitor<ConnectionStringsOptions> options)
7. {
8.   //Conservo il riferimento al servizio su un campo privato…
9. this.options = options;
10. }
12. public async Task QueryAsync(FormattableString formattableQuery)
13. {
14.   //…e da qui leggiamo la proprietà Default dell’oggetto di tipo ConnectionStringsOptions
15.   string connectionString = options.CurrentValue.Default;
17.   //TODO: Qui usiamo connectionString per collegarci al database
18.    
19. }
20. }

Nell’esempio che abbiamo appena visto, la ConnectionStringsOptions è una classe che dobbiamo creare noi e che possiamo chiamare come vogliamo. È importante che contenga delle proprietà aventi lo stesso nome di quelle trovate nella sezione di configurazione ConnectionStrings. Ecco un esempio di tale classe.

1. public class ConnectionStringsOptions
2. {
3. //Possiede una proprietà Default di tipo string, proprio come nell’appsettings.json
4. public string Default { get; set; }
5. }

Per finire, dobbiamo istruire ASP.NET Core che deve riversare i valori di configurazione trovati nella sezione ConnectionStrings all’interno di un’istanza della nostra classe ConnectionStringsOptions. Andiamo dunque ad aggiungere la seguente riga di codice nel metodo ConfigureServices della classe Startup.

1. //Qui usiamo il metodo GetSection del servizio IConfiguration
2. //per ottenere il riferimento alla sezione ConnectionStrings
3. service.Configure<ConnectionStringsOptions>(Configuration.GetSection(“ConnectionStrings”));

LE FONTI DI CONFIGURAZIONE

Il file appsettings.json è solo una delle fonti di configurazione di cui possiamo avvalerci. ASP.NET Core è già predisposto per sfruttarne altre; eccole in ordine di priorità.

• appsettings.NomeAmbiente.json, un file json in cui inseriamo la configurazione specifica che l’applicazione userà solo quando viene eseguita in un particolare ambiente (es. Development, Production, Staging, …);
• User secrets, che sono ideali per impostare una configurazione personalizzata per la nostra macchina di sviluppo. Dato che i valori non entrano nel repository GIT, ciascuno sviluppatore che collabora al progetto può avere la sua personalissima configurazione senza influenzare gli altri. Si impostano con il comando dotnet user-secrets set “Sezione:Chiave” “Valore”;
• Variabili ambiente, sono utili quando vogliamo impostare dei valori di configurazione che contengono informazioni sensibili, come username, password, chiavi API e così via. Proprio come gli user secrets, anche in questo caso i valori non entreranno nel repository GIT e perciò resteranno al sicuro sulla macchina che esegue l’applicazione. Ricorda: usa il doppio underscore __ anziché : come separatore di nomi nell’indicare il nome della variabile d’ambiente;
• Parametri da riga di comando, è la fonte più prioritaria e che perciò può ridefinire i valori impostati nelle precedenti fonti. Semplicemente, bisogna fornire i valori all’avvio dell’applicazione con il comando dotnet run –Sezione:Chiave=”Valore” oppure, se siamo già in produzione, dotnet MyCourse.dll –Sezione:Chiave=”Valore”;

Alcune fonti, come quelle basate su file di testo, sono aggiornabili a caldo. Vuol dire che, ad esempio, possiamo modificare un valore nel file appsettings.json senza che sia poi necessario riavviare l’applicazione. Il valore aggiornato verrà immediatamente reso disponibile dai servizi IConfiguration e IOptionsMonitor.

ESTENDERE IL SERVIZIO DI CONFIGURAZIONE

ASP.NET Core è molto estendibile e perciò supporta anche altre fonti di configurazione, addirittura create dallo sviluppatore. Se aggiungiamo il metodo ConfigureAppConfiguration nel punto in cui viene creato il web host, nella classe Program, possiamo personalizzare sia le fonti che il loro ordine di priorità.

1. public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
2. CreateDefaultBuilder(args)
3.   .ConfigureAppConfiguration((context, builder) => {
4.      //Qui impostiamo le fonti di configurazione o ne cambiamo l’ordine di priorità
5.   })
6. .UseStartup();

LINK AL CODICE SU GITHUB

GITHUB

Scaricare il codice della sezione12 o clonare il repository GITHUB per avere a disposizione tutte le sezioni nel tuo editor preferito.