クイックスタート: .NET アプリで Azure Cache for Redis を使用する

[アーティクル]
10/17/2024

このクイックスタートでは、Azure 内の任意のアプリケーションからアクセスできるセキュリティで保護された専用キャッシュにアクセスするために、Azure Cache for Redis を .NET アプリに組み込みます。具体的には、.NET コンソールアプリで StackExchange.Redis クライアントと C# コードを使用します。

この記事では、サンプルアプリのコードを変更して、Azure Cache for Redis に接続する動作アプリを作成する方法について説明します。

すぐにコードに移動したい場合は、GitHub 上の .NET クイックスタートサンプルを参照してください。

前提条件

Azure サブスクリプション。無料で作成できます
Visual Studio 2019
.NET Framework 4 以降が、StackExchange.Redis クライアントで必要です。

キャッシュの作成

キャッシュを作成するには、Azure portal にサインインします。ポータルのメニューで、[リソースの作成] を選びます。
[作業の開始] ペインの検索バーに「Azure Cache for Redis」と入力します。検索結果で Azure Cache for Redis を見つけて、[作成] を選びます。

[新しい Redis Cache] ペインの [基本] タブで、以下のキャッシュの設定を構成します。

設定	アクション	説明
サブスクリプション	Azure サブスクリプションを選択します。	Azure Cache for Redis の新しいインスタンスの作成に使うサブスクリプション。
リソースグループ	リソースグループを選択するか、 [新規作成] を選択し、新しいリソースグループの名前を入力します。	キャッシュや他のリソースを作成するリソースグループの名前。すべてのアプリリソースを 1 つのリソースグループに配置することで、それらをまとめて簡単に管理または削除できます。
DNS 名	一意の名前を入力します。	キャッシュ名は、数字、英字、ハイフンのみを含む 1 から 63 文字の文字列とする必要があります。名前の先頭と末尾には数字または文字を使用する必要があり、連続するハイフンを含めることはできません。キャッシュインスタンスの "ホスト名" は `\<DNS name>.redis.cache.windows.net` です。
場所	場所を選択します。	キャッシュを使う他のサービスに近い Azure リージョン。
キャッシュ SKU	SKU を選びます。	SKU によって、キャッシュに利用できるサイズ、パフォーマンス、機能のパラメーターが決まります。詳細については、Azure Cache for Redis の概要に関するページを参照してください。
キャッシュサイズ	キャッシュサイズを選びます。	詳細については、Azure Cache for Redis の概要に関するページを参照してください。

[ネットワーク] タブを選ぶか、[次へ: ネットワーク] を選びます。
[ネットワーク] タブで、キャッシュに使う接続方法を選びます。
[詳細] タブを選ぶか、[次へ: 詳細] を選びます。
[詳細] ペインで、以下の情報に基づいて認証方法を確認または選択します。
- 既定では、新しい Basic、Standard、または Premium キャッシュでは、Microsoft Entra 認証が有効になり、アクセスキー認証が無効になります。
- Basic または Standard キャッシュの場合は、非 TLS ポートを選択できます。
- Standard および Premium キャッシュの場合は、可用性ゾーンを有効にすることを選択できます。キャッシュの作成後に可用性ゾーンを無効にすることはできません。
- Premium キャッシュを利用する場合は、非 TLS ポート、クラスタリング、マネージド ID、データ永続化の設定を構成します。
重要

最適なセキュリティのため、可能であれば、キャッシュに対する要求を認可するのに Microsoft Entra ID とマネージド ID を使うことをお勧めします。 Microsoft Entra ID とマネージド ID を使う認可は、共有アクセスキーの認可より、セキュリティと使いやすさの点で優れています。キャッシュでのマネージド ID の使用について詳しくは、キャッシュ認証への Microsoft Entra ID の使用に関する記事をご覧ください。
(省略可能) [タグ] タブを選ぶか、[次へ: タグ] を選びます。
(省略可能) キャッシュリソースを分類する場合は、[タグ] タブでタグの名前と値を入力します。
[確認および作成] ボタンを選択します。

[確認と作成] タブでは、Azure によって構成が自動的に検証されます。
緑色の検証に成功のメッセージが表示された後、 [作成] を選択します。

新しいキャッシュのデプロイは数分で完了します。デプロイの進行状況は、Azure Cache for Redis の [概要] ペインで監視できます。 [状態] に [実行中] と表示されたら、キャッシュを使用できます。

ホスト名、ポート、アクセスキーを取得する

キャッシュクライアントが Azure Cache for Redis サーバーに接続するには、キャッシュのホスト名、ポート、アクセスキーが必要です。一部のクライアントでは、これらの項目が少し異なる名前で呼ばれている場合があります。ホスト名、ポート、キーは Azure portal で取得できます。

キャッシュのアクセスキーを取得するには:
1. Azure portal で、キャッシュに移動します。
2. サービスメニューの [設定] で、[認証] を選びます。
3. [認証] ペインで、[アクセスキー] タブを選びます。
4. アクセスキーの値をコピーするには、キーフィールドの [コピー] アイコンを選びます。
キャッシュのホスト名とポートを取得するには:
1. Azure portal で、キャッシュに移動します。
2. サービスメニューで、[概要] を選びます。
3. [基本] の [ホスト名] で、[コピー] アイコンを選んでホスト名の値をコピーします。ホスト名の値の形式は <DNS name>.redis.cache.windows.net です。
4. [ポート] で、[コピー] アイコンを選んでポートの値をコピーします。

コンピューター上に CacheSecrets.config というファイルを作成します。これを *C:\AppSecrets* フォルダーに配置します。
CacheSecrets.config ファイルを編集し、次の内容を追加します。
```
<appSettings>
    <add key="CacheConnection" value="<host-name>,abortConnect=false,ssl=true,allowAdmin=true,password=<access-key>"/>
</appSettings>
```
- <host-name> は実際のキャッシュホスト名に置き換えます。
- <access-key> は、実際のキャッシュのプライマリキーに置き換えます。
ファイルを保存します。

キャッシュクライアントを構成する

このセクションでは、.NET に StackExchange.Redis クライアントを使用するようにコンソールアプリを準備します。

Visual Studio で、 [ツール]>[NuGet パッケージマネージャー]>[パッケージマネージャーコンソール] の順に選択します。 [パッケージマネージャーコンソール] ウィンドウで、次のコマンドを実行します。
```
Install-Package StackExchange.Redis
```
インストールが完了すると、StackExchange.Redis キャッシュクライアントをプロジェクトで使用できるようになります。

シークレットキャッシュへ接続する

Visual Studio で App.config ファイルを開き、CacheSecrets.config ファイルを参照する appSettings file 属性が含まれていることを確認します。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.2" />
    </startup>

    <appSettings file="C:\AppSecrets\CacheSecrets.config"></appSettings>
</configuration>

資格情報は、ソースコードに保存しないでください。このサンプルを単純にするために、外部のシークレット構成ファイルを使用します。実際には Azure Key Vault と証明書を使用することをお勧めします。

RedisConnection を使用してキャッシュに接続する

キャッシュへの接続は RedisConnection クラスによって管理されます。まず、Program.cs の次のステートメントで接続を作成します。

     _redisConnection = await RedisConnection.InitializeAsync(connectionString: ConfigurationManager.AppSettings["CacheConnection"].ToString());

CacheConnection アプリ設定の値は、Azure portal からパスワードパラメーターとしてキャッシュ接続文字列を参照するために使用されます。

RedisConnection.cs では、StackExchange.Redis 名前空間は、RedisConnection クラスに必須の using ステートメントとして表示されます。

using StackExchange.Redis;

RedisConnection クラスコードにより、キャッシュへの正常な接続が常に確保されます。この接続は、StackExchange.Redis の ConnectionMultiplexer インスタンスによって管理されます。接続が失われ、自動的に再接続できない場合は、RedisConnection クラスによって再び接続が作成されます。

詳細については、StackExchange.Redis および StackExchange.Redis GitHub リポジトリのコードを参照してください。

キャッシュコマンドを実行する

Program.cs には、以下のコンソールアプリケーション用の Program クラス内の RunRedisCommandsAsync メソッドのコードが存在します。

private static async Task RunRedisCommandsAsync(string prefix)
    {
        // Simple PING command
        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache command: PING");
        RedisResult pingResult = await _redisConnection.BasicRetryAsync(async (db) => await db.ExecuteAsync("PING"));
        Console.WriteLine($"{prefix}: Cache response: {pingResult}");

        // Simple get and put of integral data types into the cache
        string key = "Message";
        string value = "Hello! The cache is working from a .NET console app!";

        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache command: GET {key} via StringGetAsync()");
        RedisValue getMessageResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringGetAsync(key));
        Console.WriteLine($"{prefix}: Cache response: {getMessageResult}");

        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache command: SET {key} \"{value}\" via StringSetAsync()");
        bool stringSetResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringSetAsync(key, value));
        Console.WriteLine($"{prefix}: Cache response: {stringSetResult}");

        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache command: GET {key} via StringGetAsync()");
        getMessageResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringGetAsync(key));
        Console.WriteLine($"{prefix}: Cache response: {getMessageResult}");

        // Store serialized object to cache
        Employee e007 = new Employee("007", "Davide Columbo", 100);
        stringSetResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringSetAsync("e007", JsonSerializer.Serialize(e007)));
        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache response from storing serialized Employee object: {stringSetResult}");

        // Retrieve serialized object from cache
        getMessageResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringGetAsync("e007"));
        Employee e007FromCache = JsonSerializer.Deserialize<Employee>(getMessageResult);
        Console.WriteLine($"{prefix}: Deserialized Employee .NET object:{Environment.NewLine}");
        Console.WriteLine($"{prefix}: Employee.Name : {e007FromCache.Name}");
        Console.WriteLine($"{prefix}: Employee.Id   : {e007FromCache.Id}");
        Console.WriteLine($"{prefix}: Employee.Age  : {e007FromCache.Age}{Environment.NewLine}");
    }

キャッシュ項目の格納と取得には、StringSetAsync および StringGetAsyncメソッドを使用します。

この例では、Message キーが値に設定されていることを確認できます。アプリは、そのキャッシュ値を更新しました。また、アプリは PING およびコマンドも実行しました。

キャッシュ内で .NET オブジェクトを使用する

Redis サーバーでは、ほとんどのデータが文字列として保存されますが、これらの文字列には、さまざまなデータ型を格納することができます。シリアル化したバイナリデータもその 1 つで、.NET のオブジェクトをキャッシュに保存する際に使用することができます。

Azure Cache for Redis は、.NET オブジェクトとプリミティブデータ型の両方をキャッシュできますが、.NET オブジェクトをキャッシュするためには、それをあらかじめシリアル化しておく必要があります。

この .NET オブジェクトのシリアル化は、アプリケーション開発者の責任です。シリアライザーの選択には、ある程度の柔軟性があります。

オブジェクトをシリアル化する簡単な方法の 1 つが、JsonConvert のシリアル化メソッドを System.text.Json で使用することです。

Visual Studio で System.text.Json 名前空間を追加します。

[ツール]>[NuGet パッケージマネージャー]>[パッケージマネージャーコンソール]*の順に選択します。
次に、[パッケージマネージャーコンソール] ウィンドウで、次のコマンドを実行します。
```
Install-Package system.text.json
```

シリアル化オブジェクトの取得および設定方法もサンプルで示すことができるように、次の Employee クラスが Program.cs で定義されています。

class Employee
{
    public string Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }

    public Employee(string employeeId, string name, int age)
    {
        Id = employeeId;
        Name = name;
        Age = age;
    }
}

サンプルを実行する

コンソールアプリをビルドして実行し、.NET オブジェクトのシリアル化をテストするには、Ctrl + F5 キーを選択します。

完了したコンソールアプリを示すスクリーンショット。

リソースをクリーンアップする

この記事で作成したリソースを引き続き使用する場合は、リソースグループを保持します。

それ以外の場合、リソースに関連する課金が行われないようにするために、リソースの使用が終了したら、作成した Azure リソースグループを削除して構いません。

警告

リソースグループを削除すると、元に戻すことができません。リソースグループを削除すると、そのリソースグループ内のすべてのリソースは完全に削除されます。間違ったリソースグループやリソースをうっかり削除しないようにしてください。保持したいリソースを含む既存のリソースグループ内にリソースを作成した場合は、リソースグループを削除するのではなく、各リソースを個別に削除できます。

リソースグループを削除する

Azure portal にサインインし、 [リソースグループ] を選択します。
削除するリソースグループを選びます。

多数のリソースグループがある場合は、[任意フィールドのフィルター] に、この記事を完了するために作成したリソースグループの名前を入力します。検索結果の一覧で、リソースグループを選びます。
[リソースグループの削除] を選択します。
[リソースグループの削除] ペインで、リソースグループの名前を入力して確認した後、[削除] を選びます。

しばらくすると、リソースグループとそのリソースのすべてが削除されます。

次の方法で共有

クイックスタート: .NET アプリで Azure Cache for Redis を使用する

前提条件

キャッシュの作成

ホスト名、ポート、アクセスキーを取得する

キャッシュクライアントを構成する

シークレットキャッシュへ接続する

RedisConnection を使用してキャッシュに接続する

キャッシュコマンドを実行する

キャッシュ内で .NET オブジェクトを使用する

サンプルを実行する

リソースをクリーンアップする

リソースグループを削除する

フィードバック

その他のリソース

次の方法で共有

クイックスタート: .NET アプリで Azure Cache for Redis を使用する

GitHub のコードにスキップする

前提条件

キャッシュの作成

ホスト名、ポート、アクセス キーを取得する

キャッシュ クライアントを構成する

シークレット キャッシュへ接続する

RedisConnection を使用してキャッシュに接続する

キャッシュ コマンドを実行する

キャッシュ内で .NET オブジェクトを使用する

サンプルを実行する

リソースをクリーンアップする

リソース グループを削除する

関連するコンテンツ

フィードバック

その他のリソース

ホスト名、ポート、アクセスキーを取得する

キャッシュクライアントを構成する

シークレットキャッシュへ接続する

キャッシュコマンドを実行する

リソースグループを削除する