Cloud Storage for Firebase を使用すると、Firebase が提供および管理するCloud Storageバケットにファイルをすばやく簡単にアップロードできます。
参照を作成する
ファイルをアップロードするには、まずファイルをアップロードする Cloud Storage 内の場所へのCloud Storage 参照を作成します。
Cloud Storage バケットのルートに子パスを追加することで、参照を作成できます。
迅速
// Create a root reference let storageRef = storage.reference() // Create a reference to "mountains.jpg" let mountainsRef = storageRef.child("mountains.jpg") // Create a reference to 'images/mountains.jpg' let mountainImagesRef = storageRef.child("images/mountains.jpg") // While the file names are the same, the references point to different files mountainsRef.name == mountainImagesRef.name // true mountainsRef.fullPath == mountainImagesRef.fullPath // false
Objective-C
// Create a root reference FIRStorageReference *storageRef = [storage reference]; // Create a reference to "mountains.jpg" FIRStorageReference *mountainsRef = [storageRef child:@"mountains.jpg"]; // Create a reference to 'images/mountains.jpg' FIRStorageReference *mountainImagesRef = [storageRef child:@"images/mountains.jpg"]; // While the file names are the same, the references point to different files [mountainsRef.name isEqualToString:mountainImagesRef.name]; // true [mountainsRef.fullPath isEqualToString:mountainImagesRef.fullPath]; // false
Cloud Storage バケットのルートへの参照を使用してデータをアップロードすることはできません。参照は子 URL を指している必要があります。
ファイルのアップロード
参照を取得したら、次の 2 つの方法で Cloud Storage にファイルをアップロードできます。
- メモリ内のデータからアップロード
- デバイス上のファイルを表す URL からのアップロード
メモリ内のデータからアップロード
putData:metadata:completion:
メソッドは、Cloud Storage にファイルをアップロードする最も簡単な方法です。 putData:metadata:completion:
NSData オブジェクトを受け取り、アップロードの管理とステータスの監視に使用できるFIRStorageUploadTask
を返します。
迅速
// Data in memory let data = Data() // Create a reference to the file you want to upload let riversRef = storageRef.child("images/rivers.jpg") // Upload the file to the path "images/rivers.jpg" let uploadTask = riversRef.putData(data, metadata: nil) { (metadata, error) in guard let metadata = metadata else { // Uh-oh, an error occurred! return } // Metadata contains file metadata such as size, content-type. let size = metadata.size // You can also access to download URL after upload. riversRef.downloadURL { (url, error) in guard let downloadURL = url else { // Uh-oh, an error occurred! return } } }
Objective-C
// Data in memory NSData *data = [NSData dataWithContentsOfFile:@"rivers.jpg"]; // Create a reference to the file you want to upload FIRStorageReference *riversRef = [storageRef child:@"images/rivers.jpg"]; // Upload the file to the path "images/rivers.jpg" FIRStorageUploadTask *uploadTask = [riversRef putData:data metadata:nil completion:^(FIRStorageMetadata *metadata, NSError *error) { if (error != nil) { // Uh-oh, an error occurred! } else { // Metadata contains file metadata such as size, content-type, and download URL. int size = metadata.size; // You can also access to download URL after upload. [riversRef downloadURLWithCompletion:^(NSURL * _Nullable URL, NSError * _Nullable error) { if (error != nil) { // Uh-oh, an error occurred! } else { NSURL *downloadURL = URL; } }]; } }];
ローカルファイルからアップロード
putFile:metadata:completion:
メソッドを使用して、カメラからの写真やビデオなど、デバイス上のローカル ファイルをアップロードできます。 putFile:metadata:completion:
NSURL
を受け取り、アップロードを管理し、そのステータスを監視するために使用できるFIRStorageUploadTask
を返します。
迅速
// File located on disk let localFile = URL(string: "path/to/image")! // Create a reference to the file you want to upload let riversRef = storageRef.child("images/rivers.jpg") // Upload the file to the path "images/rivers.jpg" let uploadTask = riversRef.putFile(from: localFile, metadata: nil) { metadata, error in guard let metadata = metadata else { // Uh-oh, an error occurred! return } // Metadata contains file metadata such as size, content-type. let size = metadata.size // You can also access to download URL after upload. riversRef.downloadURL { (url, error) in guard let downloadURL = url else { // Uh-oh, an error occurred! return } } }
Objective-C
// File located on disk NSURL *localFile = [NSURL URLWithString:@"path/to/image"]; // Create a reference to the file you want to upload FIRStorageReference *riversRef = [storageRef child:@"images/rivers.jpg"]; // Upload the file to the path "images/rivers.jpg" FIRStorageUploadTask *uploadTask = [riversRef putFile:localFile metadata:nil completion:^(FIRStorageMetadata *metadata, NSError *error) { if (error != nil) { // Uh-oh, an error occurred! } else { // Metadata contains file metadata such as size, content-type, and download URL. int size = metadata.size; // You can also access to download URL after upload. [riversRef downloadURLWithCompletion:^(NSURL * _Nullable URL, NSError * _Nullable error) { if (error != nil) { // Uh-oh, an error occurred! } else { NSURL *downloadURL = URL; } }]; } }];
アップロードを積極的に管理したい場合は、完了ハンドラーを使用するのではなく、 putData:
またはputFile:
メソッドを使用してアップロード タスクを監視できます。詳細については、アップロードの管理を参照してください。
ファイル メタデータの追加
ファイルをアップロードするときにメタデータを含めることもできます。このメタデータには、 name
、 size
、 contentType
(一般に MIME タイプと呼ばれる) などの一般的なファイル メタデータ プロパティが含まれています。 putFile:
メソッドは、 NSURL
ファイル名拡張子からコンテンツ タイプを自動的に推測しますが、メタデータでcontentType
を指定することにより、自動検出されたタイプをオーバーライドできます。 contentType
を指定せず、Cloud Storage がファイル拡張子からデフォルトを推測できない場合、Cloud Storage はapplication/octet-stream
を使用します。ファイル メタデータの詳細については、 「ファイル メタデータの使用」セクションを参照してください。
迅速
// Create storage reference let mountainsRef = storageRef.child("images/mountains.jpg") // Create file metadata including the content type let metadata = StorageMetadata() metadata.contentType = "image/jpeg" // Upload data and metadata mountainsRef.putData(data, metadata: metadata) // Upload file and metadata mountainsRef.putFile(from: localFile, metadata: metadata)
Objective-C
// Create storage reference FIRStorageReference *mountainsRef = [storageRef child:@"images/mountains.jpg"]; // Create file metadata including the content type FIRStorageMetadata *metadata = [[FIRStorageMetadata alloc] init]; metadata.contentType = @"image/jpeg"; // Upload data and metadata FIRStorageUploadTask *uploadTask = [mountainsRef putData:data metadata:metadata]; // Upload file and metadata uploadTask = [mountainsRef putFile:localFile metadata:metadata];
アップロードの管理
アップロードの開始に加えて、 pause
、 resume
、およびcancel
メソッドを使用して、アップロードを一時停止、再開、およびキャンセルできます。これらのメソッドは、 pause
、 resume
、およびcancel
イベントを発生させます。アップロードをキャンセルすると、アップロードがキャンセルされたことを示すエラーでアップロードが失敗します。
迅速
// Start uploading a file let uploadTask = storageRef.putFile(from: localFile) // Pause the upload uploadTask.pause() // Resume the upload uploadTask.resume() // Cancel the upload uploadTask.cancel()
Objective-C
// Start uploading a file FIRStorageUploadTask *uploadTask = [storageRef putFile:localFile]; // Pause the upload [uploadTask pause]; // Resume the upload [uploadTask resume]; // Cancel the upload [uploadTask cancel];
アップロードの進行状況を監視する
アップロードの進行状況を監視するために、オブザーバーをFIRStorageUploadTask
にアタッチできます。オブザーバーを追加すると、オブザーバーを削除するために使用できるFIRStorageHandle
が返されます。
迅速
// Add a progress observer to an upload task let observer = uploadTask.observe(.progress) { snapshot in // A progress event occured }
Objective-C
// Add a progress observer to an upload task FIRStorageHandle observer = [uploadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) { // A progress event occurred }];
これらのオブザーバーは、 FIRStorageTaskStatus
イベントに追加できます。
FIRStorageTaskStatus イベント | 典型的な使用法 |
---|---|
FIRStorageTaskStatusResume | このイベントは、タスクがアップロードを開始または再開したときに発生し、多くの場合、 FIRStorageTaskStatusPause イベントと組み合わせて使用されます。 |
FIRStorageTaskStatusProgress | このイベントは、データが Cloud Storage にアップロードされるたびに発生し、アップロードの進行状況インジケーターを設定するために使用できます。 |
FIRStorageTaskStatusPause | このイベントは、アップロードが一時停止されるたびに発生し、多くの場合、 FIRStorageTaskStatusResume イベントと組み合わせて使用されます。 |
FIRStorageTaskStatusSuccess | このイベントは、アップロードが正常に完了したときに発生します。 |
FIRStorageTaskStatusFailure | このイベントは、アップロードが失敗したときに発生します。エラーを調べて、失敗の理由を判別してください。 |
イベントが発生すると、 FIRStorageTaskSnapshot
オブジェクトが返されます。このスナップショットは、イベント発生時のタスクの不変ビューです。このオブジェクトには、次のプロパティが含まれています。
財産 | タイプ | 説明 |
---|---|---|
progress | NSProgress | アップロードの進行状況を含むNSProgress オブジェクト。 |
error | NSError | アップロード中に発生したエラー (ある場合)。 |
metadata | FIRStorageMetadata | アップロード中、アップロード中のメタデータが含まれます。 FIRTaskStatusSuccess イベントの後、アップロードされたファイルのメタデータが含まれます。 |
task | FIRStorageUploadTask | これはタスクのスナップショットであり、タスクの管理 ( pause 、 resume 、 cancel ) に使用できます。 |
reference | FIRStorageReference | このタスクの参照元。 |
オブザーバーを個別に、ステータスごとに、またはすべてを削除することによって削除することもできます。
迅速
// Create a task listener handle let observer = uploadTask.observe(.progress) { snapshot in // A progress event occurred } // Remove an individual observer uploadTask.removeObserver(withHandle: observer) // Remove all observers of a particular status uploadTask.removeAllObservers(for: .progress) // Remove all observers uploadTask.removeAllObservers()
Objective-C
// Create a task listener handle FIRStorageHandle observer = [uploadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) { // A progress event occurred }]; // Remove an individual observer [uploadTask removeObserverWithHandle:observer]; // Remove all observers of a particular status [uploadTask removeAllObserversForStatus:FIRStorageTaskStatusProgress]; // Remove all observers [uploadTask removeAllObservers];
メモリ リークを防ぐために、 FIRStorageTaskStatusSuccess
またはFIRStorageTaskStatusFailure
が発生した後、すべてのオブザーバーが削除されます。
エラー処理
ローカル ファイルが存在しない、ユーザーが目的のファイルをアップロードする権限を持っていないなど、アップロード時にエラーが発生する理由はいくつかあります。エラーの詳細については、ドキュメントの「エラーの処理」セクションを参照してください。
完全な例
進行状況の監視とエラー処理を使用したアップロードの完全な例を以下に示します。
迅速
// Local file you want to upload let localFile = URL(string: "path/to/image")! // Create the file metadata let metadata = StorageMetadata() metadata.contentType = "image/jpeg" // Upload file and metadata to the object 'images/mountains.jpg' let uploadTask = storageRef.putFile(from: localFile, metadata: metadata) // Listen for state changes, errors, and completion of the upload. uploadTask.observe(.resume) { snapshot in // Upload resumed, also fires when the upload starts } uploadTask.observe(.pause) { snapshot in // Upload paused } uploadTask.observe(.progress) { snapshot in // Upload reported progress let percentComplete = 100.0 * Double(snapshot.progress!.completedUnitCount) / Double(snapshot.progress!.totalUnitCount) } uploadTask.observe(.success) { snapshot in // Upload completed successfully } uploadTask.observe(.failure) { snapshot in if let error = snapshot.error as? NSError { switch (StorageErrorCode(rawValue: error.code)!) { case .objectNotFound: // File doesn't exist break case .unauthorized: // User doesn't have permission to access file break case .cancelled: // User canceled the upload break /* ... */ case .unknown: // Unknown error occurred, inspect the server response break default: // A separate error occurred. This is a good place to retry the upload. break } } }
Objective-C
// Local file you want to upload NSURL *localFile = [NSURL URLWithString:@"path/to/image"]; // Create the file metadata FIRStorageMetadata *metadata = [[FIRStorageMetadata alloc] init]; metadata.contentType = @"image/jpeg"; // Upload file and metadata to the object 'images/mountains.jpg' FIRStorageUploadTask *uploadTask = [storageRef putFile:localFile metadata:metadata]; // Listen for state changes, errors, and completion of the upload. [uploadTask observeStatus:FIRStorageTaskStatusResume handler:^(FIRStorageTaskSnapshot *snapshot) { // Upload resumed, also fires when the upload starts }]; [uploadTask observeStatus:FIRStorageTaskStatusPause handler:^(FIRStorageTaskSnapshot *snapshot) { // Upload paused }]; [uploadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) { // Upload reported progress double percentComplete = 100.0 * (snapshot.progress.completedUnitCount) / (snapshot.progress.totalUnitCount); }]; [uploadTask observeStatus:FIRStorageTaskStatusSuccess handler:^(FIRStorageTaskSnapshot *snapshot) { // Upload completed successfully }]; // Errors only occur in the "Failure" case [uploadTask observeStatus:FIRStorageTaskStatusFailure handler:^(FIRStorageTaskSnapshot *snapshot) { if (snapshot.error != nil) { switch (snapshot.error.code) { case FIRStorageErrorCodeObjectNotFound: // File doesn't exist break; case FIRStorageErrorCodeUnauthorized: // User doesn't have permission to access file break; case FIRStorageErrorCodeCancelled: // User canceled the upload break; /* ... */ case FIRStorageErrorCodeUnknown: // Unknown error occurred, inspect the server response break; } } }];
ファイルをアップロードしたら、Cloud Storage からファイルをダウンロードする方法を学びましょう。