UWP でファイルのプロパティにすばやくアクセスする

  • [アーティクル]

ライブラリからファイルとそのプロパティの一覧をすばやく収集し、アプリでそれらのプロパティを使用する方法について説明します。  

前提条件

  • ユニバーサル Windows プラットフォーム (UWP) アプリ向けの非同期プログラミングC# または Visual Basic での非同期アプリの作成方法については、「C# または Visual Basic での非同期 API の呼び出し」をご覧ください。 C++ での非同期アプリの作成方法については、「C++ での非同期プログラミング」をご覧ください。 
  • ライブラリへのアクセス許可 これらの例のコードでは picturesLibrary 機能が必要ですが、ご利用のファイルの場所によっては別の機能が必要な場合や、機能をまったく必要としない場合もあります。 詳しくは、「ファイル アクセス許可」をご覧ください。 
  • シンプルなファイルの列挙 この例では、QueryOptions を使用して、高度な列挙プロパティをいくつか設定します。 小さいディレクトリを対象としてファイルの簡単な一覧を取得する方法について詳しくは、「ファイルとフォルダーの列挙と照会」をご覧ください。 

使用方法

多くのアプリでは、ファイルのグループのプロパティを一覧表示する必要がありますが、常にファイルと直接やり取りする必要はありません。 たとえば、音楽アプリは一度に 1 つのファイルを再生します (開きます) が、アプリで曲のキューを表示したり、ユーザーが再生可能なファイルを選択したりする場合には、フォルダー内にあるすべてのファイルのプロパティが必要になります。

このページで紹介する例は、すべてのファイルのメタデータを変更するアプリや、プロパティを読み取ることができない場合に、生成されるすべての StorageFiles とやり取りするアプリには使用しないでください。 詳しくは、「ファイルとフォルダーの列挙と照会」をご覧ください。 

ある場所に保存されているすべての画像を列挙する

この例では、以下を行います。

  • QueryOptions オブジェクトを作成して、アプリではできるだけ早くファイルを列挙する必要があることを指定します。
  • StorageFile オブジェクトをアプリにページングすることにより、ファイル プロパティをフェッチします。 ファイルをページングすることで、アプリによるメモリの使用量を削減し、認識可能な応答性を向上させることができます。

クエリの作成

クエリを作成するには、QueryOptions オブジェクトを使用して、アプリでは特定の種類の画像ファイルだけを列挙する必要があることを指定し、Windows 情報保護 (System.Security.EncryptionOwners) によって保護されているファイルを除外します。 

QueryOptions.SetPropertyPrefetch を使用して、アプリがアクセサリするプロパティを設定することが重要です。 アプリがプリフェッチされていないプロパティにアクセスすると、重大なパフォーマンス ペナルティが発生します。

IndexerOption.OnlyUseIndexerAndOptimzeForIndexedProperties を設定して、結果をできるだけ早く返すこと、および SetPropertyPrefetch で指定したプロパティのみを含めることをシステムに通知します。

ページングして結果を生成する

画像ライブラリには数十万または数百万のファイルが保存されている場合があり、GetFilesAsync を呼び出すことによって、コンピューターに過剰な負荷がかかる可能性があります。これは、画像ごとに StorageFile が作成されるためです。 これを解決するには、一度に一定数の StorageFiles を作成し、それらを処理して UI を作成してから、メモリを解放します。 

この例では、StorageFileQueryResult.GetFilesAsync(UInt32 StartIndex, UInt32 maxNumberOfItems) を使用して、一度に 100 個のファイルのみをフェッチして、こうした問題に対処しています。 この処理の次にアプリでファイルが処理され、その後で OS がメモリーを解放できるようにしています。 この方法では、アプリの最大メモリが制限され、システムは応答性を維持します。 もちろん、実施するシナリオで返されるファイルの数は調整する必要がありますが、すべてのユーザーに対して応答性の高いエクスペリエンスを確保するために、一度にフェッチするファイルの数は 500 未満にすることをお勧めします。

例  

StorageFolder folderToEnumerate = KnownFolders.PicturesLibrary; 
// Check if the folder is indexed before doing anything. 
IndexedState folderIndexedState = await folderToEnumerate.GetIndexedStateAsync(); 
if (folderIndexedState == IndexedState.NotIndexed || folderIndexedState == IndexedState.Unknown) 
{ 
    // Only possible in indexed directories.  
    return; 
} 
 
QueryOptions picturesQuery = new QueryOptions() 
{ 
    FolderDepth = FolderDepth.Deep, 
    // Filter out all files that have WIP enabled
    ApplicationSearchFilter = "System.Security.EncryptionOwners:[]", 
    IndexerOption = IndexerOption.OnlyUseIndexerAndOptimizeForIndexedProperties 
}; 

picturesQuery.FileTypeFilter.Add(".jpg"); 
string[] otherProperties = new string[] 
{ 
    SystemProperties.GPS.LatitudeDecimal, 
    SystemProperties.GPS.LongitudeDecimal 
}; 
 
picturesQuery.SetPropertyPrefetch(PropertyPrefetchOptions.BasicProperties | PropertyPrefetchOptions.ImageProperties, 
                                    otherProperties); 
SortEntry sortOrder = new SortEntry() 
{ 
    AscendingOrder = true, 
    PropertyName = "System.FileName" // FileName property is used as an example. Any property can be used here.  
}; 
picturesQuery.SortOrder.Add(sortOrder); 
 
// Create the query and get the results 
uint index = 0; 
const uint stepSize = 100; 
if (!folderToEnumerate.AreQueryOptionsSupported(picturesQuery)) 
{ 
    log("Querying for a sort order is not supported in this location"); 
    picturesQuery.SortOrder.Clear(); 
} 
StorageFileQueryResult queryResult = folderToEnumerate.CreateFileQueryWithOptions(picturesQuery); 
IReadOnlyList<StorageFile> images = await queryResult.GetFilesAsync(index, stepSize); 
while (images.Count != 0 || index < 10000) 
{ 
    foreach (StorageFile file in images) 
    { 
        // With the OnlyUseIndexerAndOptimizeForIndexedProperties set, this won't  
        // be async. It will run synchronously. 
        var imageProps = await file.Properties.GetImagePropertiesAsync(); 
 
        // Build the UI 
        log(String.Format("{0} at {1}, {2}", 
                    file.Path, 
                    imageProps.Latitude, 
                    imageProps.Longitude)); 
    } 
    index += stepSize; 
    images = await queryResult.GetFilesAsync(index, stepSize); 
} 

結果

結果として生成される StorageFile ファイルには要求したプロパティのみが含まれますが、他の IndexerOptions と比較して、10 倍速く結果が返されます。 アプリでは、クエリにまだ含まれていないプロパティへのアクセスを要求できますが、ファイルを開き、それらのプロパティを取得するとパフォーマンス ペナルティが発生します。  

フォルダーをライブラリに追加する

アプリでは、StorageLibrary.RequestAddFolderAsync を使用して、ファイルの場所をインデックスに追加するよう、ユーザーに対して要求することができます。 場所が追加されると、自動的にインデックスが作成されます。アプリはこの方法を使用してファイルを列挙することができます。  

関連項目

QueryOptions API リファレンス
ファイルとフォルダーの列挙と照会
ファイル アクセス許可