Flutter で Cloud Storage 参照を作成する

ファイルは Cloud Storage バケットに保存されます。このバケット内のファイルは、ローカル ハードディスク上のファイル システムや Firebase Realtime Database 内のデータと同様の階層構造で表されます。アプリからファイルにアクセスするには、そのファイルへの参照を作成します。作成した参照を使うと、データのアップロードやダウンロード、メタデータの取得や更新、ファイルの削除などを行うことができます。参照は特定のファイルまたは階層内の上位ノードをポイントします。

Firebase Realtime Database を使用したことがある場合は、これらのパスになじみがあると思いますが、ファイルデータの格納場所は Realtime Database ではなく Cloud Storage になります。

参照を作成する

ファイルのアップロード、ダウンロード、削除や、ファイルのメタデータの取得、更新を行うには、参照を作成します。参照はクラウド内のファイルへのポインタと考えることができます。参照は軽量なので、必要なだけいくつでも作成でき、複数のオペレーションで再利用することもできます。

FirebaseStorage シングルトン インスタンスを使用して ref() メソッドを呼び出し、参照を作成します。

final storageRef = FirebaseStorage.instance.ref();

次に、既存の参照で child() メソッドを使用することにより、ツリーの下位（"images/space.jpg" など）への参照を作成できます。

// Create a child reference
// imagesRef now points to "images"
final imagesRef = storageRef.child("images");

// Child references can also take paths
// spaceRef now points to "images/space.jpg
// imagesRef still points to "images"
final spaceRef = storageRef.child("images/space.jpg");

parent プロパティと root プロパティを使用して、ファイル階層を上に移動することもできます。parent は 1 つ上のレベルに移動し、root は最上位に移動します。

// parent allows us to move our reference to a parent node
// imagesRef2 now points to 'images'
final imagesRef2 = spaceRef.parent;

// root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
final rootRef = spaceRef.root;

それぞれが参照であるため、child()、parent、root は複数回連結できます。ただし、root.parent へのアクセスは null になります。

// References can be chained together multiple times
// earthRef points to 'images/earth.jpg'
final earthRef = spaceRef.parent?.child("earth.jpg");

// nullRef is null, since the parent of root is null
final nullRef = spaceRef.root.parent;

参照のプロパティ

fullPath、name、bucket プロパティを使用して参照を調べ、参照がポイントしているファイルの詳細を知ることができます。これらのプロパティは、ファイルの完全なパス、名前、バケットを取得します。

// Reference's path is: "images/space.jpg"
// This is analogous to a file path on disk
spaceRef.fullPath;

// Reference's name is the last segment of the full path: "space.jpg"
// This is analogous to the file name
spaceRef.name;

// Reference's bucket is the name of the storage bucket that the files are stored in
spaceRef.bucket;

参照の制約事項

参照のパスと名前には、有効な Unicode 文字を任意の順序で含めることができますが、次のような一定の制約があります。

  1. UTF-8 でエンコードする場合は、reference.fullPath の全体の長さを 1～1,024 バイトにする必要があります。
  2. 改行またはラインフィード文字は使用できません。
  3. #、[、]、*、? は使用しないでください。これらの文字は、Firebase Realtime Database や gsutil などの他のツールではうまく機能しません。

例

// Points to the root reference
final storageRef = FirebaseStorage.instance.ref();

// Points to "images"
Reference? imagesRef = storageRef.child("images");

// Points to "images/space.jpg"
// Note that you can use variables to create child values
final fileName = "space.jpg";
final spaceRef = imagesRef.child(fileName);

// File path is "images/space.jpg"
final path = spaceRef.fullPath;

// File name is "space.jpg"
final name = spaceRef.name;

// Points to "images"
imagesRef = spaceRef.parent;

次に、Cloud Storage にファイルをアップロードする方法を学習しましょう。