チュートリアル: WPF アプリケーション内のアプリケーションデータのキャッシュ

[アーティクル]
05/04/2023

キャッシュを使用すると、メモリにデータを格納して高速にアクセスできます。アプリケーションからそのデータに再アクセスするときに、元のソースからではなく、キャッシュからデータを取得できます。そのため、パフォーマンスとスケーラビリティが向上します。また、データソースが一時的に使用できない場合でも、キャッシュのデータを使用できます。

.NET Framework には、.NET Framework アプリケーションでキャッシュを使用できるようになるクラスが用意されています。これらのクラスは System.Runtime.Caching 名前空間にあります。

注意

System.Runtime.Caching 名前空間は、.NET Framework 4 で新しく追加されました。この名前空間により、すべての .NET Framework アプリケーションでキャッシュを使用できるようになります。 .NET Framework の以前のバージョンでは、キャッシュは System.Web 名前空間でのみ使用可能だったため、ASP.NET クラスへの依存が必要でした。

このチュートリアルでは、Windows Presentation Foundation (WPF) アプリケーションの一部として .NET Framework で使用できるキャッシュ機能を使用する方法を示します。このチュートリアルでは、テキストファイルのコンテンツをキャッシュします。

このチュートリアルでは、以下のタスクを行います。

WPF アプリケーションプロジェクトを作成する。
.NET Framework 4 への参照を追加する。
キャッシュを初期化する。
テキストファイルのコンテンツを含むキャッシュエントリを追加する。
キャッシュエントリの削除ポリシーを指定する。
キャッシュされたファイルのパスを監視し、監視対象の項目に対する変更についてキャッシュインスタンスに通知する。

必須コンポーネント

このチュートリアルを完了するための要件は次のとおりです。

Visual Studio 2010。
少量のテキストを含むテキストファイル (テキストファイルのコンテンツをメッセージボックスに表示します)。このチュートリアルで示すコードは、次のファイルで作業していることを前提としています。

c:\cache\cacheText.txt

ただし、任意のテキストファイルを使用して、このチュートリアルのコードに小さな変更を加えることができます。

WPF アプリケーションプロジェクトを作成する

まず、WPF アプリケーションプロジェクトを作成します。

WPF アプリケーションを作成するには

Visual Studio を起動します。
[ファイル] メニューの [新規作成] をポイントし、 [新しいプロジェクト] をクリックします。

[新しいプロジェクト] ダイアログボックスが表示されます。
[インストール済みのテンプレート] で使用するプログラミング言語を選択します ( [Visual Basic] または [Visual C#] )。
[新しいプロジェクト] ダイアログボックスで [WPF アプリケーション] を選択します。

注意

WPF アプリケーション テンプレートが表示されない場合は、WPF をサポートする .NET Framework のバージョンをターゲットにしていることを確認します。 [新しいプロジェクト] ダイアログボックスで、一覧から [.NET Framework 4] を選択します。
[プロジェクト名] テキストボックスにプロジェクトの名前を入力します。たとえば、「WPFCaching」と入力できます。
[ソリューションのディレクトリを作成] チェックボックスをオンにします。
[OK] をクリックします。

WPF デザイナーが [デザイン] ビューで開き、MainWindow.xaml ファイルが表示されます。 Visual Studio によってマイプロジェクト フォルダー、Application.xaml ファイル、および MainWindow.xaml ファイルが作成されます。

.NET Framework のターゲット設定とキャッシュアセンブリへの参照の追加

既定で、WPF アプリケーションでは .NET Framework 4 クライアントプロファイルをターゲットとしています。 WPF アプリケーションで System.Runtime.Caching 名前空間を使用するには、アプリケーションで (.NET Framework 4 クライアントプロファイルではなく).NET Framework 4 をターゲットとし、名前空間への参照を含める必要があります。

そのため、次の手順は、.NET Framework のターゲットを変更し、System.Runtime.Caching 名前空間への参照を追加することです。

注意

.NET Framework のターゲットを変更する手順は、Visual Basic プロジェクトと Visual C# プロジェクトとで異なります。

Visual Basic でターゲットの .NET Framework を変更するには

ソリューションエクスプローラーで、プロジェクト名を右クリックし、 [プロパティ] をクリックします。

アプリケーションの [プロパティ] ウィンドウが表示されます。
[コンパイル] タブをクリックします。
ウィンドウの下部にある [詳細コンパイルオプション] をクリックします。

[コンパイラの詳細設定] ダイアログボックスが表示されます。
[ターゲットフレームワーク (すべての構成)] 一覧で [.NET Framework 4] を選択します ([.NET Framework 4 Client Profile] は選択しないでください)。
[OK] をクリックします。

[ターゲットフレームワークの変更] ダイアログボックスが表示されます。
[ターゲットフレームワークの変更] ダイアログボックスで [はい] をクリックします。

プロジェクトが閉じられ、再び開かれます。
次の手順に従って、キャッシュアセンブリへの参照を追加します。
1. ソリューションエクスプローラーで、プロジェクトの名前を右クリックし、 [参照の追加] をクリックします。
2. [.NET] タブを選択し、System.Runtime.Caching を選択し、 [OK] をクリックします。

Visual C# プロジェクトでターゲットの .NET Framework を変更するには

ソリューションエクスプローラーでプロジェクト名を右クリックし、 [プロパティ] をクリックします。

アプリケーションの [プロパティ] ウィンドウが表示されます。
[アプリケーション] タブをクリックします。
[ターゲットフレームワーク] 一覧で [.NET Framework 4] を選択します ( [.NET Framework 4 Client Profile] は選択しないでください)。
次の手順に従って、キャッシュアセンブリへの参照を追加します。
1. [参照] フォルダーを右クリックし、 [参照の追加] をクリックします。
2. [.NET] タブを選択し、System.Runtime.Caching を選択し、 [OK] をクリックします。

WPF ウィンドウへのボタンの追加

次に、ボタンコントロールを追加し、ボタンの Click イベントのイベントハンドラーを作成します。後でコードを追加して、ボタンをクリックするとテキストファイルのコンテンツがキャッシュされ、表示されるようにします。

ボタンコントロールを追加するには

ソリューションエクスプローラーで MainWindow.xaml ファイルをダブルクリックして開きます。
[ツールボックス] の [コモン WPF コントロール] で、Button コントロールを MainWindow ウィンドウにドラッグします。
[プロパティ] ウィンドウで、Button コントロールの Content プロパティを [Get Cache](キャッシュの取得) に設定します。

キャッシュの初期化とエントリのキャッシュ

次に、次のタスクを実行するコードを追加します。

キャッシュクラスのインスタンスを作成します。つまり、新しい MemoryCache オブジェクトをインスタンス化します。
キャッシュで HostFileChangeMonitor オブジェクトを使用してテキストファイルの変更を監視するように指定します。
テキストファイルを読み取り、そのコンテンツをキャッシュエントリとしてキャッシュします。
キャッシュされたテキストファイルのコンテンツを表示します。

キャッシュオブジェクトを作成するには

MainWindow.xaml.cs ファイルまたは MainWindow.Xaml.vb ファイルにイベントハンドラーを作成するために、追加したボタンをダブルクリックします。
ファイルの先頭 (クラス宣言の前) に、次の Imports (Visual Basic) または using (C#) ステートメントを追加します。
```
using System.Runtime.Caching;
using System.IO;
```
```
Imports System.Runtime.Caching
Imports System.IO
```
イベントハンドラーで、次のコードを追加してキャッシュオブジェクトをインスタンス化します。
```
ObjectCache cache = MemoryCache.Default;
```
```
Dim cache As ObjectCache = MemoryCache.Default
```
ObjectCache クラスは、メモリ内オブジェクトキャッシュを提供する組み込みクラスです。

次のコードを追加して、filecontents というキャッシュエントリのコンテンツを読み取ります。

Dim fileContents As String = TryCast(cache("filecontents"), String)

string fileContents = cache["filecontents"] as string;

次のコードを追加して、filecontents というキャッシュエントリが存在するかどうかを確認します。
```
If fileContents Is Nothing Then

End If
```
```
if (fileContents == null)
{

}
```
指定したキャッシュエントリが存在しない場合は、テキストファイルを読み取り、それをキャッシュエントリとしてキャッシュに追加する必要があります。
if/then ブロックで、次のコードを追加して、キャッシュエントリが 10 秒後に期限切れになることを指定する新しい CacheItemPolicy オブジェクトを作成します。
```
Dim policy As New CacheItemPolicy()
policy.AbsoluteExpiration = DateTimeOffset.Now.AddSeconds(10.0)
```
```
CacheItemPolicy policy = new CacheItemPolicy();
policy.AbsoluteExpiration = DateTimeOffset.Now.AddSeconds(10.0);
```
削除または有効期限の情報が提供されていない場合、既定値は InfiniteAbsoluteExpiration です。これは、キャッシュエントリが絶対時間のみに基づいて期限切れになることはないことを意味します。代わりに、メモリが不足している場合にのみ、キャッシュエントリが期限切れになります。ベストプラクティスとして、絶対またはスライド式の有効期限を常に明示的に指定することをお勧めします。
if/then ブロック内で、前の手順で追加したコードの後に、次のコードを追加し、監視するファイルパスのコレクションを作成し、テキストファイルのパスをコレクションに追加します。
```
Dim filePaths As New List(Of String)()
filePaths.Add("c:\cache\cacheText.txt")
```
```
List<string> filePaths = new List<string>();
filePaths.Add("c:\\cache\\cacheText.txt");
```
注意

使用するテキストファイルが c:\cache\cacheText.txt でない場合は、使用するテキストファイルのパスを指定します。
前の手順で追加したコードの後に、次のコードを追加し、新しい HostFileChangeMonitor オブジェクトをキャッシュエントリの変更モニターのコレクションに追加します。
```
policy.ChangeMonitors.Add(New HostFileChangeMonitor(filePaths))
```
```
policy.ChangeMonitors.Add(new HostFileChangeMonitor(filePaths));
```
HostFileChangeMonitor オブジェクトを使用すると、テキストファイルのパスを監視し、変更が発生した場合はキャッシュに通知することができます。この例では、ファイルのコンテンツが変更されると、キャッシュエントリが期限切れになります。
前の手順で追加したコードの後に次のコードを追加し、テキストファイルのコンテンツを読み取ります。
```
fileContents = File.ReadAllText("c:\cache\cacheText.txt") & vbCrLf & DateTime.Now.ToString()
```
```
fileContents = File.ReadAllText("c:\\cache\\cacheText.txt") + "\n" + DateTime.Now;
```
日付と時刻のタイムスタンプが追加されるので、キャッシュエントリの有効期限がいつ切れるかを確認できます。
前の手順で追加したコードの後に次のコードを追加し、ファイルのコンテンツを CacheItem インスタンスとしてキャッシュオブジェクトに挿入します。
```
cache.Set("filecontents", fileContents, policy)
```
```
cache.Set("filecontents", fileContents, policy);
```
前の手順で作成した CacheItemPolicy オブジェクトをパラメーターとして渡すことにより、キャッシュエントリを削除する方法に関する情報を指定します。
if/then ブロックの後に次のコードを追加し、キャッシュされたファイルのコンテンツをメッセージボックスに表示します。
```
MessageBox.Show(fileContents)
```
```
MessageBox.Show(fileContents);
```
[ビルド] メニューで、 [WPFCaching のビルド] をクリックしてプロジェクトをビルドします。

WPF アプリケーションでのキャッシュのテスト

これで、アプリケーションをテストすることができます。

WPF アプリケーションでキャッシュをテストするには

Ctrl キーを押しながら F5 キーを押してアプリケーションを実行します。

MainWindow ウィンドウが表示されます。
[Get Cache](キャッシュの取得) をクリックします。

テキストファイルからキャッシュされたコンテンツがメッセージボックスに表示されます。ファイルのタイムスタンプに注意してください。
メッセージボックスを閉じ、 [Get Cache](キャッシュの取得) をクリックします。

タイムスタンプは変更されません。これは、キャッシュされたコンテンツが表示されることを示します。
10 秒以上待ってから、 [Get Cache](キャッシュの取得) をクリックします。

今回は、新しいタイムスタンプが表示されます。これは、ポリシーによってキャッシュエントリの有効期限が切れ、新しいキャッシュされたコンテンツが表示されることを示しています。
テキストエディターで、作成したテキストファイルを開きます。まだ変更を加えないでください。
メッセージボックスを閉じ、 [Get Cache](キャッシュの取得) をクリックします。

タイムスタンプに再び注目してください。
テキストファイルに変更を加え、ファイルを保存します。
メッセージボックスを閉じ、 [Get Cache](キャッシュの取得) をクリックします。

このメッセージボックスには、テキストファイルの更新されたコンテンツと新しいタイムスタンプが含まれています。これは、絶対タイムアウト期間が経過していなくても、ファイルを変更した直後にホストファイル変更モニターによってキャッシュエントリが削除されたことを示しています。

注意

削除時間を 20 秒以上に増やして、ファイルに変更を加える時間を増やすことができます。

コード例

このチュートリアルを完了すると、作成したプロジェクトのコードは次の例のようになります。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;
using System.Runtime.Caching;
using System.IO;

namespace WPFCaching
{
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, RoutedEventArgs e)
        {

            ObjectCache cache = MemoryCache.Default;
            string fileContents = cache["filecontents"] as string;

            if (fileContents == null)
            {
                CacheItemPolicy policy = new CacheItemPolicy();
                policy.AbsoluteExpiration =
                    DateTimeOffset.Now.AddSeconds(10.0);

                List<string> filePaths = new List<string>();
                filePaths.Add("c:\\cache\\cacheText.txt");

                policy.ChangeMonitors.Add(new
                    HostFileChangeMonitor(filePaths));

                // Fetch the file contents.
                fileContents = File.ReadAllText("c:\\cache\\cacheText.txt") + "\n" + DateTime.Now.ToString();

                cache.Set("filecontents", fileContents, policy);
            }
            MessageBox.Show(fileContents);
        }
    }
}

Imports System.Runtime.Caching
Imports System.IO

Class MainWindow

    Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs) Handles Button1.Click
        Dim cache As ObjectCache = MemoryCache.Default
        Dim fileContents As String = TryCast(cache("filecontents"), _
            String)

        If fileContents Is Nothing Then
            Dim policy As New CacheItemPolicy()
            policy.AbsoluteExpiration = _
                DateTimeOffset.Now.AddSeconds(10.0)
            Dim filePaths As New List(Of String)()
            filePaths.Add("c:\cache\cacheText.txt")
            policy.ChangeMonitors.Add(New  _
                HostFileChangeMonitor(filePaths))

            ' Fetch the file contents.
            fileContents = File.ReadAllText("c:\cache\cacheText.txt") & vbCrLf & DateTime.Now.ToString()
            cache.Set("filecontents", fileContents, policy)
        End If
        MessageBox.Show(fileContents)
    End Sub
End Class

チュートリアル: WPF アプリケーション内のアプリケーションデータのキャッシュ

必須コンポーネント

WPF アプリケーションプロジェクトを作成する

WPF アプリケーションを作成するには

.NET Framework のターゲット設定とキャッシュアセンブリへの参照の追加

Visual Basic でターゲットの .NET Framework を変更するには

Visual C# プロジェクトでターゲットの .NET Framework を変更するには

WPF ウィンドウへのボタンの追加

ボタンコントロールを追加するには

キャッシュの初期化とエントリのキャッシュ

キャッシュオブジェクトを作成するには

WPF アプリケーションでのキャッシュのテスト

WPF アプリケーションでキャッシュをテストするには

コード例

関連項目

フィードバック

その他のリソース

チュートリアル: WPF アプリケーション内のアプリケーション データのキャッシュ

必須コンポーネント

WPF アプリケーション プロジェクトを作成する

WPF アプリケーションを作成するには

.NET Framework のターゲット設定とキャッシュ アセンブリへの参照の追加

Visual Basic でターゲットの .NET Framework を変更するには

Visual C# プロジェクトでターゲットの .NET Framework を変更するには

WPF ウィンドウへのボタンの追加

ボタン コントロールを追加するには

キャッシュの初期化とエントリのキャッシュ

キャッシュ オブジェクトを作成するには

WPF アプリケーションでのキャッシュのテスト

WPF アプリケーションでキャッシュをテストするには

コード例

関連項目

フィードバック

その他のリソース

チュートリアル: WPF アプリケーション内のアプリケーションデータのキャッシュ

WPF アプリケーションプロジェクトを作成する

.NET Framework のターゲット設定とキャッシュアセンブリへの参照の追加

ボタンコントロールを追加するには

キャッシュオブジェクトを作成するには