ASP.NET Utdatacacheprovider för Azure Cache for Redis

Redis-utdatacacheprovidern är en processbaserad lagringsmekanism för utdatacachedata. Dessa data är specifikt för fullständiga HTTP-svar (cachelagring av sidutdata). Providern ansluts till den nya utdatacacheproviderns utökningspunkt som introducerades i ASP.NET 4. Mer ASP.NET Core program finns i Cachelagring av svar i ASP.NET Core.

Om du vill använda Redis-utdatacacheprovidern konfigurerar du först din cache och konfigurerar sedan ditt ASP.NET-program med Hjälp av NuGet-paketet Redis Output Cache Provider. Den här artikeln innehåller råd om hur du konfigurerar ditt program för att använda Redis-utdatacacheprovidern. Mer information om hur du skapar och konfigurerar en Azure Cache for Redis-instans finns i Skapa en cache.

Lagra ASP.NET sidutdata i cacheminnet

Om du vill konfigurera ett klientprogram i Visual Studio med hjälp Azure Cache for Redis NuGet-paketet Sessionstillstånd väljer du NuGet Package Manager, Package Manager Console på menyn Verktyg.

Kör följande kommando från fönstret Package Manager Console.

Install-Package Microsoft.Web.RedisOutputCacheProvider

NuGet-paketet för Redis-utdatacacheprovidern är beroende av StackExchange.Redis-paketet. Om StackExchange.Redis-paketet inte finns i projektet installeras det. Mer information om NuGet-paketet Redis Output Cache Provider finns på NuGet-sidan RedisOutputCacheProvider.

NuGet-paketet laddar ned och lägger till nödvändiga sammansättningsreferenser och lägger till följande avsnitt i din web.config fil. Det här avsnittet innehåller den konfiguration som krävs för ASP.NET att använda Redis-utdatacacheprovidern.

<caching>
  <outputCache defaultProvider="MyRedisOutputCache">
    <providers>
      <add name="MyRedisOutputCache" type="Microsoft.Web.Redis.RedisOutputCacheProvider"
           host=""
           accessKey=""
           ssl="true" />
    </providers>
  </outputCache>
</caching>

Konfigurera attributen till vänster med värden från cachen i Microsoft Azure portalen. Konfigurera även de andra värdena som du vill använda. Anvisningar om hur du kommer åt dina cacheegenskaper finns i Konfigurera Azure Cache for Redis inställningar.

Attributanteckningar

Ange connectionString

Värdet för connectionString används som nyckel för att hämta den faktiska anslutningssträngen från AppSettings, om en sådan sträng finns i AppSettings. Om det inte finns i AppSettings används värdet för connectionString som nyckel för att hämta den faktiska anslutningssträngen från web.config ConnectionString om det avsnittet finns. Om anslutningssträngen inte finns i AppSettings eller avsnittet web.config ConnectionString används literalvärdet för connectionString som anslutningssträng när du skapar StackExchange.Redis.ConnectionMultiplexer.

I följande exempel visas hur connectionString används.

Exempel 1

<connectionStrings>
    <add name="MyRedisConnectionString" connectionString="mycache.redis.cache.windows.net:6380,password=actual access key,ssl=True,abortConnect=False" />
</connectionStrings>

I web.config använder du nyckeln ovan som parametervärde i stället för det faktiska värdet.

<sessionState mode="Custom" customProvider="MySessionStateStore">
    <providers>
        <add type = "Microsoft.Web.Redis.RedisSessionStateProvide"
             name = "MySessionStateStore"
             connectionString = "MyRedisConnectionString"/>
    </providers>
</sessionState>

Exempel 2

<appSettings>
    <add key="MyRedisConnectionString" value="mycache.redis.cache.windows.net:6380,password=actual access key,ssl=True,abortConnect=False" />
</appSettings>

I web.config använder du nyckeln ovan som parametervärde i stället för det faktiska värdet.

<sessionState mode="Custom" customProvider="MySessionStateStore">
    <providers>
        <add type = "Microsoft.Web.Redis.RedisSessionStateProvide"
             name = "MySessionStateStore"
             connectionString = "MyRedisConnectionString"/>
    </providers>
</sessionState>

Exempel 3

<sessionState mode="Custom" customProvider="MySessionStateStore">
    <providers>
        <add type = "Microsoft.Web.Redis.RedisSessionStateProvide"
             name = "MySessionStateStore"
             connectionString = "mycache.redis.cache.windows.net:6380,password=actual access key,ssl=True,abortConnect=False"/>
    </providers>
</sessionState>

Kommentarer om throwOnError

Om ett fel inträffar under en sessionsåtgärd utlöste för närvarande sessionstillståndsprovidern ett undantag. Om undantaget utlösts stängs programmet av.

Det här beteendet har ändrats på ett sätt som stöder förväntningarna på befintliga ASP.NET användare av sessionstillståndsprovidern samtidigt som du kan agera på undantag. Standardbeteendet kastar fortfarande ett undantag när ett fel inträffar, i enlighet med andra ASP.NET sessionstillståndsproviders. Befintlig kod bör fungera på samma sätt som tidigare.

Om du anger throwOnError till false misslyckas den tyst i stället för att utlösa ett undantag när ett fel inträffar. Om du vill se om det uppstod ett fel och i så fall identifiera undantaget kontrollerar du den statiska egenskapen Microsoft.Web.Redis.RedisSessionStateProvider.LastException.

Information om retryTimeoutIn Milliseconds

Inställningen retryTimeoutIn Milliseconds innehåller logik för att förenkla fallet där en sessionsåtgärd ska försöka igen vid fel på grund av ett nätverksfel eller något annat. Med inställningen retryTimeoutIn Milliseconds kan du också styra tidsgränsen för återförsök eller helt välja bort återförsök.

Om du ställer in retryTimeoutIn Milliseconds till ett tal, till exempel 2000, försöker en sessionsåtgärd igen i 2 000 millisekunder innan den behandlas som ett fel. Om du vill att sessionstillståndsprovidern ska tillämpa den här logiken för omförsök konfigurerar du bara tidsgränsen. Det första återförsöket sker efter 20 millisekunder, vilket är tillräckligt i de flesta fall när ett nätverksfel inträffar. Därefter försöker den igen varje sekund tills den får sin tids slut. Direkt efter tidsgränsen försöker den igen en gång till för att se till att tidsgränsen inte klipps ut med (högst) en sekund.

Om du inte tror att du behöver göra ett nytt försök eller om du vill hantera logiken för omförsök själv anger du retryTimeoutIn Milliseconds till 0. Du kanske till exempel inte vill försöka igen när du kör Redis-servern på samma dator som ditt program.

Om redisSerializerType

Serialiseringen för att lagra värdena på Redis görs som standard i binärt format, som tillhandahålls av klassen BinaryFormatter. Använd redisSerializerType för att ange det sammansättningskvalificerade typnamnet för en klass som implementerar Microsoft.Web.Redis.ISerializer och har den anpassade logiken för att serialisera och deserialisera värdena. Här är till exempel en Json-serialiserarklass med hjälp av JSON.NET:

namespace MyCompany.Redis
{
    public class JsonSerializer : ISerializer
    {
        private static JsonSerializerSettings _settings = new JsonSerializerSettings() { TypeNameHandling = TypeNameHandling.All };

        public byte[] Serialize(object data)
        {
            return Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(data, _settings));
        }

        public object Deserialize(byte[] data)
        {
            if (data == null)
            {
                return null;
            }
            return JsonConvert.DeserializeObject(Encoding.UTF8.GetString(data), _settings);
        }
    }
}

Förutsatt att den här klassen definieras i en sammansättning med namnet MyCompanyDll kan du ange parametern redisSerializerType så att den används:

<sessionState mode="Custom" customProvider="MySessionStateStore">
    <providers>
        <add type = "Microsoft.Web.Redis.RedisSessionStateProvider"
             name = "MySessionStateStore"
             redisSerializerType = "MyCompany.Redis.JsonSerializer,MyCompanyDll"
             ... />
    </providers>
</sessionState>

Direktiv för utdatacache

Lägg till ett OutputCache-direktiv på varje sida som du vill cachelagra utdata för.

<%@ OutputCache Duration="60" VaryByParam="*" %>

I föregående exempel finns cachelagrade siddata kvar i cacheminnet i 60 sekunder och en annan version av sidan cachelagras för varje parameterkombination. Mer information om OutputCache-direktivet finns i @OutputCache .

När du har gjort de här stegen konfigureras programmet för att använda Redis-cacheprovidern för utdata.

Leverantörer av utdatacache från tredje part

• NCache
• Apache Ignite

Nästa steg

Kolla in providern ASP.NET sessionstillstånd för att Azure Cache for Redis.