iOS でストレージ参照を作成する

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

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

参照を作成する

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

参照は、referenceForURL: メソッドを呼び出して gs://<your-firebase-storage-bucket> という URL 形式で渡すことにより、Firebase アプリの storage サービスから作成することができます。この URL は Firebase console の [Storage] セクションで確認できます。

// Get a reference to the storage service, using the default Firebase App
FIRStorage *storage = [FIRStorage storage];

// Create a storage reference from our storage service
FIRStorageReference *storageRef = [storage referenceForURL:@"gs://<your-firebase-storage-bucket>"];
  

// Get a reference to the storage service, using the default Firebase App
let storage = FIRStorage.storage()

// Create a storage reference from our storage service
let storageRef = storage.referenceForURL("gs://<your-firebase-storage-bucket>")
    

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

// Create a child reference
// imagesRef now points to "images"
FIRStorageReference *imagesRef = [storageRef child:@"images"];

// Child references can also take paths delimited by '/'
// spaceRef now points to "images/space.jpg"
// imagesRef still points to "images"
FIRStorageReference *spaceRef = [storageRef child:@"images/space.jpg"];

// This is equivalent to creating the full reference
FIRStorageReference *spaceRef = [storage referenceForURL:@"gs://<your-firebase-storage-bucket>/images/space.jpg"];
  

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

// Child references can also take paths delimited by '/'
// spaceRef now points to "images/space.jpg"
// imagesRef still points to "images"
let spaceRef = storageRef.child("images/space.jpg")

// This is equivalent to creating the full reference
let spaceRef = storage.referenceForURL("gs://<your-firebase-storage-bucket>/images/space.jpg")
    

参照を使って移動する

parent メソッドや root メソッドを使用してファイル階層を上に移動することもできます。parent は 1 つ上のレベルに移動し、root は最上位に移動します。

// Parent allows us to move to the parent of a reference
// imagesRef now points to 'images'
FIRStorageReference *imagesRef = [spaceRef parent];

// Root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
FIRStorageReference *rootRef = [spaceRef root];
  

// Parent allows us to move to the parent of a reference
// imagesRef now points to 'images'
let imagesRef = spaceRef.parent()

// Root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
let rootRef = spaceRef.root()
    

child、parent、root を複数つなげて参照を返すことができます。例外は root の parent で、これは nil になります。

// References can be chained together multiple times
// earthRef points to "images/earth.jpg"
FIRStorageReference *earthRef = [[spaceRef parent] child:@"earth.jpg"];

// nilRef is nil, since the parent of root is nil
FIRStorageReference *nilRef = [[spaceRef root] parent];
  

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

// nilRef is nil, since the parent of root is nil
var nilRef = 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 where files are stored
spaceRef.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 where files are stored
spaceRef.bucket
    

参照の制約事項

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

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

例

// Points to the root reference
FIRStorageReference *storageRef = [[FIRStorage storage] referenceForURL:@"gs://<your-bucket-name>"];

// Points to "images"
FIRStorageReference *imagesRef = [storageRef child:@"images"];

// Points to "images/space.jpg"
// Note that you can use variables to create child values
NSString *fileName = @"space.jpg";
FIRStorageReference *spaceRef = [imagesRef child:fileName];

// File path is "images/space.jpg"
NSString *path = spaceRef.fullPath

// File name is "space.jpg"
NSString *name = spaceRef.name

// Points to "images"
FIRStorageReference *imagesRef = [spaceRef parent];
  

// Points to the root reference
let storageRef = FIRStorage.storage().referenceForURL("gs://<your-bucket-name>")

// Points to "images"
let imagesRef = storageRef.child("images")

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

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

// File name is "space.jpg"
let name = spaceRef.name

// Points to "images"
let imagesRef = spaceRef.parent()
    

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