Azure Cache for Redis の ASP.NET 出力キャッシュ プロバイダー

Redis 出力キャッシュ プロバイダーは、出力キャッシュ データ用のプロセス外ストレージ メカニズムです。 このデータは、完全な HTTP 応答専用です (ページ出力キャッシュ)。 プロバイダーは、ASP.NET 4 で導入された新しい出力キャッシュ プロバイダー拡張機能ポイントに接続します。

ASP.NET Core アプリケーションについては、.NET 8 の Redis を使用した ASP.NET コアでの出力キャッシュに関するページを参照してください。

Redis 出力キャッシュ プロバイダーを使用するには、まず対象のキャッシュを構成し、Redis 出力キャッシュ プロバイダー NuGet パッケージを使用して ASP.NET アプリケーションを構成します。 この記事では、Redis 出力キャッシュ プロバイダーを使用するようにアプリケーションを構成する手順について説明します。

Redis に ASP.NET コア ページ出力を格納する

完全な機能仕様については、ASP.NET コア出力キャッシュを参照してください。

使用方法を示すサンプル アプリケーションについては、「Redis 出力キャッシュと Azure OpenAI を備えた .NET 8 Web アプリケーション」を参照してください。

ASP.NET ページ出力を Redis に格納する

Visual Studio で Azure Cache for Redis Session State NuGet パッケージを使用してクライアント アプリケーションを構成するには、 [ツール] メニューで [NuGet パッケージ マネージャー] 、 [パッケージ マネージャー コンソール] の順に選択します。

[Package Manager Console] ウィンドウで、次のコマンドを実行します。

Install-Package Microsoft.Web.RedisOutputCacheProvider

Redis 出力キャッシュ プロバイダー NuGet パッケージは、StackExchange.Redis パッケージに依存します。 StackExchange.Redis パッケージは、プロジェクト内に存在しなければインストールされます。 Redis Output Cache Provider NuGet パッケージについて詳しくは、RedisOutputCacheProvider NuGet ページを参照してください。

NuGet パッケージがダウンロードされ、必要なアセンブリ参照が追加されて、次のセクションが web.config ファイルに追加されます。 このセクションには、Redis 出力キャッシュ プロバイダーを使うために ASP.NET アプリケーションに必要な構成が含まれます。

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

Microsoft Azure portal のキャッシュの値を使用して、最初の列の属性を構成します。 また、必要に応じて他の値を構成します。 キャッシュのプロパティにアクセスする方法については、「Configure Azure Cache for Redis settings (Azure Cache for Redis の設定を構成する)」を参照してください。

属性に関する注意事項

connectionString の設定

connectionString の値は、AppSettings から実際の接続文字列 (そのような文字列が AppSettings に存在する場合) をフェッチするためのキーとして使用されます。 AppSettings 内に見つからない場合、connectionString の値は、web.config ConnectionString セクション (そのセクションが存在する場合) から実際の接続文字列をフェッチするためのキーとして使用されます。 接続文字列が AppSettings または web.config ConnectionString セクションに存在しない場合は、StackExchange.Redis.ConnectionMultiplexer の作成時に、connectionString のリテラル値が接続文字列として使用されます。

次の例は、connectionString の使用方法を示しています。

例 1

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

web.config では、実際の値の代わりにキーをパラメーター値として使用します。

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

例 2

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

web.config では、実際の値の代わりにキーをパラメーター値として使用します。

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

例 3

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

throwOnError に関する注意事項

現在、セッション操作中にエラーが発生した場合、セッション状態プロバイダーは例外をスローします。 例外をスローすると、アプリケーションがシャットダウンされます。

この動作は、既存の ASP.NET セッション状態プロバイダー ユーザーの期待をサポートしながら、例外にも対処できるように変更されています。 既定の動作では、エラーが発生すると引き続き例外がスローされます。これは他の ASP.NET セッション状態プロバイダーと同じです。 既存のコードは、以前と同じように動作するはずです。

throwOnError を false に設定すると、エラーが発生したときに例外をスローするのではなく、何も行われずに失敗します。 エラーが発生したかどうかを確認し、発生した場合に例外を確認するには、静的プロパティ Microsoft.Web.Redis.RedisSessionStateProvider.LastException を調べてください。

retryTimeoutInMilliseconds に関する注意事項

retryTimeoutInMilliseconds 設定では、ネットワーク障害などのためにセッション操作が失敗したときに再試行する必要がある場合の処理を簡略化するために、いくつかのロジックが用意されています。 また、retryTimeoutInMilliseconds 設定では、再試行のタイムアウトを制御したり、再試行を完全にオプトアウトしたりできます。

retryTimeoutInMilliseconds を 2000 などの数値に設定すると、セッション操作が失敗したときに、エラーとして扱われるまでに 2,000 ミリ秒間、再試行が行われます。 セッション状態プロバイダーにこの再試行ロジックを適用させるには、タイムアウトを構成するだけで済みます。 最初の再試行は 20 ミリ秒後に行われますが、ネットワーク障害が発生したときには、ほとんどの場合、これで十分です。 その後、タイムアウトするまで、1 秒ごとに再試行されます。タイムアウトの直後に、タイムアウトを (最大でも) 1 秒短縮することがないように、もう一度試行されます。

再試行が不要と思われる場合、または再試行ロジックを自分で処理する場合は、retryTimeoutInMilliseconds を 0 に設定します。 たとえば、Redis サーバーをアプリケーションと同じマシンで実行している場合は、再試行が必要ないことがあります。

redisSerializerType について

Redis に値を格納するためのシリアル化は、既定ではバイナリ形式で行われます。この形式は、BinaryFormatter クラスによって提供されます。 Microsoft.Web.Redis.ISerializer を実装し、値をシリアル化および逆シリアル化するカスタム ロジックを持つクラスのアセンブリ修飾型名を指定するには、redisSerializerType を使用します。 例として、JSON.NET を使用した JSON シリアライザー クラスを次に示します。

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

このクラスが MyCompanyDll という名前のアセンブリで定義されているとすると、それを使用するようにパラメーター redisSerializerType を設定できます。

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

出力キャッシュ ディレクティブ

出力をキャッシュする各ページに、OutputCache ディレクティブを追加します。

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

前の例では、キャッシュされたページ データが 60 秒間キャッシュに保持され、パラメーターの組み合わせごとに異なるバージョンのページがキャッシュされます。 OutputCache ディレクティブの詳細については、「@OutputCache」を参照してください。

これらの手順の実行後、アプリケーションは Redis 出力キャッシュ プロバイダーを使用するように構成されます。

サードパーティ出力キャッシュ プロバイダー

• NCache
• Apache Ignite

関連するコンテンツ

「ASP.NET Session State Provider for Azure Cache for Redis (Azure Cache for Redis の ASP.NET セッション状態プロバイダー)」を参照してください。