Xamarin.Android でのファイルストレージとアクセス

[アーティクル]
04/28/2024

Android アプリの一般的な要件として、ファイルの操作があります。たとえば、画像の保存、ドキュメントのダウンロード、他のプログラムと共有するためのデータのエクスポートなどです。 Android (Linux ベース) は、ファイルストレージ用の領域を提供することで、これをサポートしています。 Android は、次の 2 種類のストレージにファイルシステムをグループ化します。

内部ストレージ - これは、アプリケーションまたはオペレーティングシステムからのみアクセスできるファイルシステム部分です。
外部ストレージ - これは、すべてのアプリ、ユーザー、および場合によっては他のデバイスからアクセスできるファイルを格納するためのパーティションです。一部のデバイスでは、外部ストレージをリムーバブル (SD カードなど) にすることができます。

これらのグループ化は概念的なものであり、必ずしもデバイス上の単一のパーティションまたはディレクトリを参照するわけではありません。 Android デバイスは、常に内部ストレージと外部ストレージのパーティションを提供します。特定のデバイスに、外部ストレージと見なされる複数のパーティションがある可能性があります。パーティションに関係なく、ファイルの読み取り、書き込み、または作成のための API は同じものです。 Xamarin Android アプリケーションがファイルアクセスに使用する場合がある API の 2 つのセットがあります。

NET API (Mono によって提供され、Xamarin Android によってラップされる) - これらの API には、Xamarin. Essentials によって提供されるファイルシステムヘルパーが含まれています。 .NET API は、最適なプラットフォーム間の互換性を提供し、このガイドではこれらの API に焦点を当てます。
ネイティブ Java ファイルアクセス API (Java によって提供され、Xamarin Android によってラップされる) - Java は、ファイルの読み取りと書き込み用の独自の API を提供します。これらは .NET API に代わるものとして完全に許容されますが、Android に固有のものであり、クロスプラットフォーム用のアプリには適していません。

ファイルの読み取りと書き込みは、Xamarin.Android でも他の .NET アプリケーションとほぼ同じです。 Xamarin.Android アプリでは、操作するファイルへのパスが決定された後、ファイルアクセスに標準の .NET イディオムが使用されます。内部ストレージと外部ストレージへの実際のパスは、デバイスによって、または Android のバージョンによって異なる場合があるため、ファイルへのパスをハードコーディングしないことをお勧めします。代わりに、Xamarin.Android API を使用してファイルへのパスを決定します。そのように、ファイルの読み取りと書き込みを行う .NET API では、内部ストレージと外部ストレージのファイルへのパスを決定するのに役立つ、ネイティブの Android API が公開されています。

ファイルへのアクセスに関連する API について説明する前に、内部ストレージおよび外部ストレージに関する詳細を理解しておくことが重要です。これについては、次のセクションで説明します。

内部ストレージおよび外部ストレージ

概念上、内部ストレージと外部ストレージは非常によく似ています。どちらの場所にも、Xamarin Android アプリでファイルを保存することができます。この類似性は、アプリが内部ストレージと外部ストレージのどちらを使用する必要があるかが明確ではないため、Android に慣れていない開発者にとって混乱する可能性があります。

内部ストレージとは、Android がオペレーティングシステム、APK、および個々のアプリに割り当てる非揮発性メモリを指します。この領域には、オペレーティングシステムまたはアプリ以外ではアクセスできません。 Android では、各アプリの内部ストレージパーティションにディレクトリが割り当てられます。アプリがアンインストールされると、そのディレクトリ内の内部ストレージに保持されているすべてのファイルも削除されます。内部ストレージは、アプリからしかアクセスできず、他のアプリと共有されない、またはアプリがアンインストールされた後の値がほとんどないファイルに最適です。 Android 6.0 以降では、Android 6.0 の自動バックアップ機能を使用して、Google によって内部ストレージ上のファイルが自動的にバックアップされる場合があります。内部ストレージの欠点は次のとおりです。

ファイルを共有できません。
アプリをアンインストールしても、ファイルは削除されません。
内部ストレージで使用可能な領域が制限されることがあります。

外部ストレージとは、内部ストレージではなく、アプリから排他的にアクセスできないファイルストレージのことです。外部ストレージの主な目的は、アプリ間で共有されるファイルや、大きすぎて内部ストレージに収まらないファイルを配置する場所を提供することです。外部ストレージの利点は、通常、ファイルの領域が内部ストレージよりもはるかに多くなることです。ただし、外部ストレージは常にデバイス上に存在するとは限りません。また、アクセスするには、ユーザーからの特別なアクセス許可が必要になる場合があります。

Note

複数のユーザーをサポートするデバイスの場合、Android は内部および外部の両方のストレージに独自のディレクトリを提供します。このディレクトリは、デバイス上の他のユーザーにはアクセスできません。この分離は、内部ストレージまたは外部ストレージ上のファイルへのパスをハードコーディングしない限り、アプリには表示されません。

経験則として、Xamarin Android アプリでは、適切であれば内部ストレージにファイルを保存することをお勧めします。また、ファイルを他のアプリと共有する必要があり、その容量が非常に大きい場合、またはアプリがアンインストールされた場合でもそのファイルを保持する必要がある場合は、外部ストレージを利用することをお勧めします。たとえば、構成ファイルは、それを作成するアプリ以外は重要ではないため、内部ストレージに最適です。これに対して、写真は外部ストレージの候補として適しています。これらは非常に大きな容量となる可能性があり、多くの場合、アプリがアンインストールされた場合でも、ユーザーはそれらを共有したりアクセスしたりする場合があります。

このガイドでは、内部ストレージに焦点を当てます。 Xamarin Android アプリケーションで外部ストレージを使用する方法の詳細については、ガイド「外部ストレージ」を参照してください。

内部ストレージの操作

アプリケーションの内部ストレージディレクトリはオペレーティングシステムによって決定され、Android.Content.Context.FilesDir プロパティによって Android アプリに公開されます。これにより、Android がアプリ専用に割り当てたディレクトリを表す Java.IO.File オブジェクトが返されます。たとえば、パッケージ名が com.companyname であるアプリなどです。内部ストレージディレクトリは次のようになる場合があります。

/data/user/0/com.companyname/files

このドキュメントでは、内部ストレージディレクトリを INTERNAL_STORAGE と呼びます。

重要

内部ストレージディレクトリへの正確なパスは、デバイスにより、および Android のバージョンにより、異なる場合があります。このため、アプリでは、この内部ファイルストレージディレクトリへのパスをハードコーディングしてはならず、代わりに System.Environment.GetFolderPath() などの Xamarin.Android API を使用する必要があります。

コード共有を最大化するには、Xamarin Android アプリ (または Xamarin Android を対象とする Xamarin.Forms アプリ) で System.Environment.GetFolderPath() メソッドを使用する必要があります。 Xamarin Android では、このメソッドは Android.Content.Context.FilesDir と同じ場所にあるディレクトリの文字列を返します。このメソッドは、列挙型の System.Environment.SpecialFolder を受け取ります。これは、オペレーティングシステムによって使用される特殊なフォルダーのパスを表す列挙された定数のセットを識別するために使用されます。すべての System.Environment.SpecialFolder 値が、Xamarin. Android 上の有効なディレクトリにマップされるとは限りません。次の表では、System.Environment.SpecialFolder の特定の値に対して想定できるパスについて説明します。

System.Environment.SpecialFolder	Path
`ApplicationData`	INTERNAL_STORAGE/.config
`Desktop`	INTERNAL_STORAGE/デスクトップ
`LocalApplicationData`	INTERNAL_STORAGE/.local/share
`MyDocuments`	*INTERNAL_STORAGE*
`MyMusic`	INTERNAL_STORAGE/ミュージック
`MyPictures`	INTERNAL_STORAGE/ピクチャ
`MyVideos`	INTERNAL_STORAGE/ビデオ
`Personal`	*INTERNAL_STORAGE*
`Fonts`	INTERNAL_STORAGE/.fonts
`Templates`	INTERNAL_STORAGE/Templates
`CommonApplicationData`	/usr/share
`CommonApplicationData`	/usr/share

内部ストレージでのファイルの読み取りまたは書き込み

ファイルへの書き込み用の任意の C# API は十分です。必要なのは、アプリケーションに割り当てられているディレクトリ内のファイルへのパスを取得することだけです。メインスレッドをブロックするファイルアクセスに関連する可能性のある問題を最小限に抑えるために、非同期バージョンの .NET API を使用することを強くお勧めします。

このコードスニペットは、アプリケーションの内部ストレージディレクトリに UTF-8 テキストファイルに整数を書き込む例の 1 つです。

public async Task SaveCountAsync(int count)
{
    var backingFile = Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.Personal), "count.txt");
    using (var writer = File.CreateText(backingFile))
    {
        await writer.WriteLineAsync(count.ToString());
    }
}

次のコードスニペットは、テキストファイルに格納されていた整数値を読み取るための 1 つの方法を提供します。

public async Task<int> ReadCountAsync()
{
    var backingFile = Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.Personal), "count.txt");

    if (backingFile == null || !File.Exists(backingFile))
    {
        return 0;
    }

    var count = 0;
    using (var reader = new StreamReader(backingFile, true))
    {
        string line;
        while ((line = await reader.ReadLineAsync()) != null)
        {
            if (int.TryParse(line, out var newcount))
            {
                count = newcount;
            }
        }
    }

    return count;
}

Xamarin.Essentials の使用 - ファイルシステムヘルパー

Xamarin. Essentials は、クロスプラットフォームの互換性のあるコードを記述するための API のセットです。ファイルシステムヘルパーは、アプリケーションのキャッシュとデータディレクトリを簡単に検索できるようにする一連のヘルパーを含むクラスです。このコードスニペットは、アプリの内部ストレージディレクトリとキャッシュディレクトリを検索する方法の例を示しています。

// Get the path to a file on internal storage
var backingFile = Path.Combine(Xamarin.Essentials.FileSystem.AppDataDirectory, "count.txt");

// Get the path to a file in the cache directory
var cacheFile = Path.Combine(Xamarin.Essentials.FileSystem.CacheDirectory, "count.txt");

`MediaStore` からファイルを非表示にする

MediaStore は、Android デバイス上のメディアファイル (ビデオ、音楽、イメージ) に関するメタデータを収集する Android コンポーネントです。その目的は、デバイス上のすべての Android アプリでこれらのファイルを簡単に共有することです。

プライベートファイルは、共有可能なメディアとして表示されません。たとえば、アプリが画像を非公開の外部ストレージに保存する場合、そのファイルはメディアスキャナー (MediaStore) で取得されません。

パブリックファイルは MediaStoreによって取得されます。 0 バイトファイル名 のディレクトリ。NOMEDIA は MediaStore によってスキャンされません。

Xamarin.Android でのファイルストレージとアクセス

内部ストレージおよび外部ストレージ

内部ストレージの操作

内部ストレージでのファイルの読み取りまたは書き込み

Xamarin.Essentials の使用 - ファイル システム ヘルパー

MediaStore からファイルを非表示にする

関連リンク

その他のリソース

Xamarin.Essentials の使用 - ファイルシステムヘルパー

`MediaStore` からファイルを非表示にする