Provider di stato sessione ASP.NET per la cache di Azure per Redis

  • Articolo

Cache Redis di Azure include un provider di stato della sessione che consente di archiviare lo stato della sessione in memoria con Cache Redis di Azure anziché in un database di SQL Server. Per usare il provider di stato della sessione di memorizzazione nella cache, configurare innanzitutto la cache e quindi l'applicazione ASP.NET per la cache usando il pacchetto NuGet dello stato della sessione per Cache Redis di Azure. Per le applicazioni core ASP.NET, consultare Gestione delle sessioni e dello stato in ASP.NET Core.

Spesso non è pratico in un'app cloud evitare di archiviare una forma di stato per una sessione utente, ma alcuni approcci influiscono più di altri sulle prestazioni e sulla scalabilità. Se è necessario archiviare lo stato, la soluzione migliore è mantenere piccola la quantità di stato e archiviarla nei cookie. Se non è fattibile, la seconda miglior soluzione è usare lo stato della sessione ASP.NET con un provider per la cache distribuita in memoria. La soluzione peggiore dal punto di vista delle prestazioni e della scalabilità è usare un provider di stato della sessione supportato da un database. Questo articolo fornisce indicazioni sull'uso del provider di stato della sessione ASP.NET per Cache Redis di Azure. Per informazioni sulle altre opzioni dello stato sessione, vedere Opzioni dello stato della sessione ASP.NET.

Archiviare lo stato della sessione ASP.NET nella cache

Per configurare un'applicazione client in Visual Studio con il pacchetto NuGet Azure Cache per Redis Session State, selezionare Gestione pacchetti NuGet e quindi su Console di Gestione pacchetti dal menu Strumenti.

Eseguire questo comando nella finestra Package Manager Console.

Install-Package Microsoft.Web.RedisSessionStateProvider

Importante

Se si sta usando la funzionalità di clustering del livello Premium, è necessario usare RedisSessionStateProvider 2.0.1 o versione successiva. In caso contrario, verrà generata un'eccezione. Il passaggio alla versione 2.0.1 o successive è una modifica che causa un'interruzione.

Il pacchetto NuGet del provider di stato della sessione Redis ha una dipendenza dal pacchetto StackExchange.Redis. Se il pacchetto StackExchange.Redis non è presente nel progetto, viene installato.

Il pacchetto NuGet scarica e aggiunge i riferimenti all'assembly richiesto e aggiunge la sezione seguente al file web.config. Questa sezione contiene la configurazione richiesta dall'applicazione ASP.NET per usare il provider di stato della sessione di Cache Redis di Azure.

<sessionState mode="Custom" customProvider="MySessionStateStore">
  <providers>
    <!-- Either use 'connectionString' OR 'settingsClassName' and 'settingsMethodName' OR use 'host','port','accessKey','ssl','connectionTimeoutInMilliseconds' and 'operationTimeoutInMilliseconds'. -->
    <!-- 'throwOnError','retryTimeoutInMilliseconds','databaseId' and 'applicationName' can be used with both options. -->
    <!--
      <add name="MySessionStateStore" 
        host = "127.0.0.1" [String]
        port = "" [number]
        accessKey = "" [String]
        ssl = "false" [true|false]
        throwOnError = "true" [true|false]
        retryTimeoutInMilliseconds = "5000" [number]
        databaseId = "0" [number]
        applicationName = "" [String]
        connectionTimeoutInMilliseconds = "5000" [number]
        operationTimeoutInMilliseconds = "1000" [number]
        connectionString = "<Valid StackExchange.Redis connection string>" [String]
        settingsClassName = "<Assembly qualified class name that contains settings method specified below. Which basically return 'connectionString' value>" [String]
        settingsMethodName = "<Settings method should be defined in settingsClass. It should be public, static, does not take any parameters and should have a return type of 'String', which is basically 'connectionString' value.>" [String]
        loggingClassName = "<Assembly qualified class name that contains logging method specified below>" [String]
        loggingMethodName = "<Logging method should be defined in loggingClass. It should be public, static, does not take any parameters and should have a return type of System.IO.TextWriter.>" [String]
        redisSerializerType = "<Assembly qualified class name that implements Microsoft.Web.Redis.ISerializer>" [String]
      />
    -->
    <add name="MySessionStateStore" type="Microsoft.Web.Redis.RedisSessionStateProvider"
         host=""
         accessKey=""
         ssl="true" />
  </providers>
</sessionState>

La sezione commentata fornisce un esempio degli attributi e delle impostazioni di esempio per ogni attributo.

Configurare gli attributi con i valori a sinistra del pannello Cache nel portale di Microsoft Azure e configurare gli altri valori come desiderato. Per istruzioni sull'accesso alle proprietà della cache, vedere Configurare le impostazioni di Cache Redis di Azure.

  • host : specificare l'endpoint della cache.
  • porta: usare la porta non TLS/SSL o quella TLS/SSL, a seconda delle impostazioni TLS.
  • accessKey : usare la chiave primaria o secondaria per la cache.
  • ssl: true per proteggere le comunicazioni cache/client con TLS; in caso contrario, false. Assicurarsi di specificare la porta corretta.
    • La porta non TLS è disabilitata per impostazione predefinita per le nuove cache. Per usare la porta TLS, specificare true per questa impostazione. Per ulteriori informazioni sull'abilitazione della porta senza TLS, consultare la sezione Porte di accesso nell'articolo Configurare una cache.
  • throwOnError: impostare su true se si vuole che venga generata un'eccezione in caso di errore durante l'operazione; in caso contrario, scegliere false. È possibile verificare l'eventuale presenza di errori mediante la proprietà statica Microsoft.Web.Redis.RedisSessionStateProvider.LastException. Il valore predefinito è true.
  • retryTimeoutInMilliseconds : le operazioni non riuscite vengono ritentate durante questo intervallo, specificato in millisecondi. Il primo tentativo dopo l'errore avviene dopo 20 millisecondi, mentre i tentativi successivi vengono ripetuti ogni secondo, fino al termine dell'intervallo retryTimeoutInMillisecond. Immediatamente dopo questo intervallo, l'operazione viene ritentata un'ultima volta. Se l'operazione non riesce, l'eccezione viene restituita al chiamante, a seconda dell'impostazione throwOnError. Il valore predefinito è 0 che indica nessun tentativo.
  • databaseId : specifica il database da usare per i dati di output della cache. Se non è specificato alcun valore, verrà usato il valore predefinito 0.
  • applicationName: le chiavi vengono archiviate in Redis come {<Application Name>_<Session ID>}_Data. Questo schema di denominazione consente a più applicazioni di condividere la stessa istanza di Redis. Questo parametro è facoltativo e se non lo si specifica, verrà usato un valore predefinito.
  • connectionTimeoutInMilliseconds: questa impostazione consente di eseguire l'override dell'impostazione connectTimeout nel client StackExchange.Redis. Se non viene specificato alcun valore, verrà usata l'impostazione di connectTimeout predefinita pari a 5000. Per altre informazioni, vedere Modello di configurazione StackExchange.Redis.
  • operationTimeoutInMilliseconds : questa impostazione consente di eseguire l'override dell'impostazione syncTimeout nel client StackExchange.Redis. Se non specificato, viene utilizzata l'impostazione predefinita syncTimeout di 1000. Per altre informazioni, vedere Modello di configurazione StackExchange.Redis.
  • redisSerializerType: questa impostazione consente di specificare la serializzazione personalizzata del contenuto di una sessione che viene inviato a Redis. Il tipo specificato deve implementare Microsoft.Web.Redis.ISerializer e deve dichiarare un costruttore pubblico senza parametri. Per impostazione predefinita, si usa System.Runtime.Serialization.Formatters.Binary.BinaryFormatter.

Per altre informazioni su queste proprietà, vedere il post di blog originale nell' annuncio del provider di stato della sessione ASP.NET per Redis.

Ricordarsi di commentare la sezione del provider di stato della sessione standard InProc nel file web.config.

<!-- <sessionState mode="InProc"
     customProvider="DefaultSessionProvider">
     <providers>
        <add name="DefaultSessionProvider"
              type="System.Web.Providers.DefaultSessionStateProvider,
                    System.Web.Providers, Version=1.0.0.0, Culture=neutral,
                    PublicKeyToken=31bf3856ad364e35"
              connectionStringName="DefaultConnection" />
      </providers>
</sessionState> -->

Dopo l'esecuzione di questi passaggi, l'applicazione è configurata per l'uso del provider di stato della sessione di Cache Redis di Azure. Quando si usa lo stato della sessione nell'applicazione, questo viene archiviato in un'istanza di Cache Redis di Azure.

Importante

I dati archiviati nella cache devono essere serializzabili, diversamente dai dati che possono essere archiviati nel provider di stato della sessione ASP.NET in memoria predefinito. Quando il provider di stato della sessione per Redis viene usato, assicurarsi che i tipi di dati da archiviare nello stato della sessione siano serializzabili.

Opzioni dello stato della sessione ASP.NET

  • Provider di stato della sessione in memoria: questo provider archivia lo stato della sessione in memoria. Il vantaggio di usare questo provider è che è semplice e veloce. Non è tuttavia possibile ridimensionare le app Web se si usa il provider in memoria perché questo non è distribuito.
  • Provider di stato della sessione SQL Server: questo provider archivia lo stato della sessione in SQL Server. Usare questo provider per archiviare lo stato della sessione in una risorsa di archiviazione persistente. È possibile ridimensionare l'app Web, ma l'uso di SQL Server per la sessione influisce sulle prestazioni dell'app Web. È inoltre possibile usare questo provider con una configurazione di OLTP In memoria per migliorare le prestazioni.
  • Provider di stato della sessione in memoria distribuito, ad esempio provider di stato della sessione di Cache Redis di Azure, che offre il meglio di entrambe le soluzioni. L'app Web può avere un provider di stato della sessione semplice, veloce e scalabile. Dal momento che questo provider archivia lo stato della sessione in una cache, l'app deve tenere in considerazione tutte le caratteristiche associate quando comunica con una cache in memoria distribuita, ad esempio in caso di errori di rete temporanei. Per le procedure consigliate sull'uso della cache, consultare Informazioni aggiuntive sulla memorizzazione nella cache in Microsoft Patterns & Practices e Azure Cloud Application Design and Implementation Guidance (Guida alla progettazione e all'implementazione delle applicazioni cloud di Azure).

Per altre informazioni sullo stato della sessione e altre procedure consigliate, vedere Procedure consigliate per lo sviluppo Web (compilazione di app reali per il cloud con Azure).

Provider di stato sessione di terzi

Passaggi successivi

Vedere Provider di cache di output ASP.NET per Cache Redis di Azure.