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

[アーティクル]
06/01/2023

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

Redis 出力キャッシュプロバイダーを使用するには、まず対象のキャッシュを構成し、Redis 出力キャッシュプロバイダー NuGet パッケージを使用して ASP.NET アプリケーションを構成します。この記事では、Redis 出力キャッシュプロバイダーを使用するようにアプリケーションを構成する手順について説明します。 Azure Cache for Redis インスタンスを作成および構成する方法の詳細については、キャッシュの作成に関するページを参照してください。

ASP.NET ページ出力をキャッシュに格納する

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 の設定を構成する)」を参照してください。

属性	Type	Default	説明
host	string	"localhost"	Redis サーバーの IP アドレスまたはホスト名
port	正の整数	6379 (TLS/SSL 以外) 6380 (TLS/SSL)	Redis サーバーポート
accessKey	string	""	Redis 認証が有効になっている場合は、Redis サーバーのパスワード。既定では、値は空の文字列です。これは、セッション状態プロバイダーが Redis サーバーに接続するときにパスワードを使用しないことを意味します。 Redis サーバーが Azure Cache for Redis のようなパブリックにアクセス可能なネットワークにある場合は、セキュリティを強化するために必ず Redis 承認を有効にして、安全なパスワードを指定してください。
ssl	boolean	false	Redis サーバーに TLS 経由で接続するかどうか。既定では、Redis が TLS をサポートしていないため、この値は false です。既定で SSL をサポートする Azure Cache for Redis を使用している場合は、セキュリティを強化するためにこの値を必ず true に設定してください。既定では、新しいキャッシュに対して非 TLS ポートは無効になっています。 TLS ではないポートを使用するには、この設定に true を指定します。非 TLS ポートの有効化の詳細については、キャッシュの構成に関する記事の「アクセスポート」セクションを参照してください。
databaseIdNumber	正の整数	0	この属性は、web.config または AppSettings でのみ指定できます。使用する Redis データベースを指定します。
connectionTimeoutInMilliseconds	正の整数	StackExchange.Redis によって提供されます	StackExchange.Redis.ConnectionMultiplexer の作成時に ConnectTimeout を設定するために使用されます。
operationTimeoutInMilliseconds	正の整数	StackExchange.Redis によって提供されます	StackExchange.Redis.ConnectionMultiplexer の作成時に SyncTimeout を設定するために使用されます。
connectionString (有効な StackExchange.Redis 接続文字列)	string	該当なし	AppSettings または web.config へのパラメーター参照、または有効な StackExchange.Redis 接続文字列。この属性は、host、port、accessKey、ssl、およびその他の StackExchange.Redis 属性の値を指定できます。 connectionString の詳細については、「属性に関する注意事項」セクションの「connectionString の設定」を参照してください。
settingsClassName settingsMethodName	string string	該当なし	これらの属性は、web.config または AppSettings でのみ指定できます。これらの属性を使用して、接続文字列を指定します。 settingsClassName は、settingsMethodName で指定されたメソッドを含むアセンブリ修飾クラス名である必要があります。 settingsMethodName で指定するメソッドは、戻り値の型が string の public、static、および void (パラメーターを受け取らない) である必要があります。このメソッドは、実際の接続文字列を返します。
loggingClassName loggingMethodName	string string	該当なし	これらの属性は、web.config または AppSettings でのみ指定できます。これらの属性を使用して、セッション状態/出力キャッシュからのログと StackExchange.Redis からのログを提供することにより、アプリケーションをデバッグします。 loggingClassName は、loggingMethodName で指定されたメソッドを含むアセンブリ修飾クラス名である必要があります。 loggingMethodName で指定するメソッドは、戻り値の型が System.IO.TextWriter の public、static、および void (パラメーターを受け取らない) である必要があります。
applicationName	string	現在のプロセスのモジュール名または "/"	SessionStateProvider のみこの属性は、web.config または AppSettings でのみ指定できます。 Redis Cache で使用するアプリ名プレフィックス。お客様は、異なる目的で同じ Redis Cache を使用できます。セッションキーが競合しないようにするために、アプリケーション名をプレフィックスとして付けることができます。
throwOnError	boolean	true	SessionStateProvider のみこの属性は、web.config または AppSettings でのみ指定できます。エラーが発生したときに例外をスローするかどうか。 throwOnError の詳細については、「属性に関する注意事項」セクションの「throwOnError に関する注意事項」を参照してください。
retryTimeoutInMilliseconds	正の整数	5000	SessionStateProvider のみこの属性は、web.config または AppSettings でのみ指定できます。操作が失敗したときに再試行する時間の長さ。この値が operationTimeoutInMilliseconds より小さい場合、プロバイダーは再試行しません。 retryTimeoutInMilliseconds の詳細については、「属性に関する注意事項」セクションの「retryTimeoutInMilliseconds に関する注意事項」を参照してください。
redisSerializerType	string	該当なし	Microsoft.Web.Redis.Serializer を実装し、値をシリアル化および逆シリアル化するカスタムロジックを含むクラスのアセンブリ修飾型名を指定します。詳細については、「属性に関する注意事項」セクションの「redisSerializerType について」を参照してください。

属性に関する注意事項

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 などの数値に設定すると、セッション操作が失敗したときに、エラーとして扱われるまでに 2000 ミリ秒間、再試行が行われます。セッション状態プロバイダーにこの再試行ロジックを適用させるには、タイムアウトを構成するだけで済みます。最初の再試行は 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 出力キャッシュプロバイダーを使用するように構成されます。

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

次のステップ

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

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