Dateien mit Cloud Storage auf Apple-Plattformen hochladen

Mit Cloud Storage for Firebase können Sie Dateien schnell und einfach in einen von Firebase bereitgestellten und verwalteten Cloud Storage-Bucket hochladen.

Referenz erstellen

Wenn Sie eine Datei hochladen möchten, müssen Sie zuerst eine Cloud Storage-Referenz für den Speicherort in Cloud Storage erstellen, an den Sie die Datei hochladen möchten.

Sie können einen Verweis erstellen, indem Sie untergeordnete Pfade an den Stamm Ihres Cloud Storage-Buckets anhängen:

Swift

// 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

Sie können keine Daten mit einem Verweis auf das Stammverzeichnis Ihres Cloud Storage-Buckets hochladen. Ihr Verweis muss auf eine untergeordnete URL verweisen.

Dateien hochladen

Sobald Sie eine Referenz haben, können Sie Dateien auf zwei Arten in Cloud Storage hochladen:

  1. Aus Daten im Arbeitsspeicher hochladen
  2. Über eine URL hochladen, die eine Datei auf dem Gerät darstellt

Aus Daten im Arbeitsspeicher hochladen

Die Methode putData:metadata:completion: ist die einfachste Möglichkeit, eine Datei in Cloud Storage hochzuladen. putData:metadata:completion: akzeptiert ein NSData-Objekt und gibt ein FIRStorageUploadTask zurück, mit dem Sie Ihren Upload verwalten und seinen Status überwachen können.

Swift

// 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;
      }
    }];
  }
}];

Aus einer lokalen Datei hochladen

Mit der Methode putFile:metadata:completion: können Sie lokale Dateien auf die Geräte hochladen, z. B. Fotos und Videos von der Kamera. putFile:metadata:completion: akzeptiert ein NSURL und gibt ein FIRStorageUploadTask zurück, mit dem Sie Ihren Upload verwalten und seinen Status überwachen können.

Swift

// 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;
      }
    }];
  }
}];

Wenn Sie Ihren Upload aktiv verwalten möchten, können Sie die Methoden putData: oder putFile: verwenden und die Uploadaufgabe beobachten, anstatt den Completion-Handler zu verwenden. Weitere Informationen finden Sie unter Uploads verwalten.

Dateimetadaten hinzufügen

Sie können auch Metadaten einfügen, wenn Sie Dateien hochladen. Diese Metadaten enthalten typische Dateimetadaten-Attribute wie name, size und contentType (allgemein als MIME-Typ bezeichnet). Bei der putFile:-Methode wird der Inhaltstyp automatisch aus der Dateinamenerweiterung NSURL abgeleitet. Sie können den automatisch erkannten Typ jedoch überschreiben, indem Sie contentType in den Metadaten angeben. Wenn Sie kein contentType angeben und Cloud Storage keinen Standardwert aus der Dateiendung ableiten kann, verwendet Cloud Storage application/octet-stream. Weitere Informationen zu Dateimetadaten finden Sie im Abschnitt Dateimetadaten verwenden.

Swift

// 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];

Uploads verwalten

Neben dem Starten von Uploads können Sie Uploads mit den Methoden pause, resume und cancel pausieren, fortsetzen und abbrechen. Mit diesen Methoden werden die Ereignisse pause, resume und cancel ausgelöst. Wenn Sie einen Upload abbrechen, schlägt er mit einer Fehlermeldung fehl, die darauf hinweist, dass der Upload abgebrochen wurde.

Swift

// 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];

Uploadfortschritt im Blick behalten

Sie können Beobachter an FIRStorageUploadTask anhängen, um den Fortschritt des Uploads zu überwachen. Wenn Sie einen Beobachter hinzufügen, wird ein FIRStorageHandle zurückgegeben, mit dem der Beobachter entfernt werden kann.

Swift

// 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
NSString *observer = [uploadTask observeStatus:FIRStorageTaskStatusProgress
                                        handler:^(FIRStorageTaskSnapshot *snapshot) {
  // A progress event occurred
}];

Folgende Beobachter können einem FIRStorageTaskStatus-Ereignis hinzugefügt werden:

FIRStorageTaskStatus Ereignis Typische Verwendung
FIRStorageTaskStatusResume Dieses Ereignis wird ausgelöst, wenn die Aufgabe mit dem Hochladen beginnt oder das Hochladen fortgesetzt wird. Es wird häufig in Verbindung mit dem Ereignis FIRStorageTaskStatusPause verwendet.
FIRStorageTaskStatusProgress Dieses Ereignis wird immer ausgelöst, wenn Daten in Cloud Storage hochgeladen werden. Es kann verwendet werden, um eine Fortschrittsanzeige für den Upload zu erstellen.
FIRStorageTaskStatusPause Dieses Ereignis wird immer dann ausgelöst, wenn der Upload pausiert wird. Es wird häufig in Verbindung mit dem FIRStorageTaskStatusResume-Ereignis verwendet.
FIRStorageTaskStatusSuccess Dieses Ereignis wird ausgelöst, wenn ein Upload erfolgreich abgeschlossen wurde.
FIRStorageTaskStatusFailure Dieses Ereignis wird ausgelöst, wenn ein Upload fehlgeschlagen ist. Sehen Sie sich den Fehler an, um den Grund für den Fehler zu ermitteln.

Wenn ein Ereignis eintritt, wird ein FIRStorageTaskSnapshot-Objekt zurückgegeben. Dieser Snapshot ist eine unveränderliche Ansicht der Aufgabe zum Zeitpunkt des Ereignisses. Dieses Objekt enthält die folgenden Attribute:

Attribut Typ Beschreibung
progress NSProgress Ein NSProgress-Objekt mit dem Fortschritt des Uploads.
error NSError Ein Fehler, der während des Uploads aufgetreten ist, falls vorhanden.
metadata FIRStorageMetadata „During upload“ enthält Metadaten, die hochgeladen werden. Enthält nach einem FIRTaskStatusSuccess-Ereignis die Metadaten der hochgeladenen Datei.
task FIRStorageUploadTask Die Aufgabe, von der dies ein Snapshot ist. Sie kann verwendet werden, um die Aufgabe zu verwalten (pause, resume, cancel).
reference FIRStorageReference Die Referenz, aus der diese Aufgabe stammt.

Sie können Beobachter auch einzeln, nach Status oder alle zusammen entfernen.

Swift

// 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
NSString *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];

Um Speicherlecks zu vermeiden, werden alle Beobachter nach einem FIRStorageTaskStatusSuccess- oder FIRStorageTaskStatusFailure-Ereignis entfernt.

Fehlerbehandlung

Es gibt eine Reihe von Gründen, warum beim Hochladen Fehler auftreten können. Dazu gehören, dass die lokale Datei nicht vorhanden ist oder der Nutzer keine Berechtigung zum Hochladen der gewünschten Datei hat. Weitere Informationen zu Fehlern finden Sie im Abschnitt Fehlerbehebung der Dokumentation.

Vollständiges Beispiel

Ein vollständiges Beispiel für einen Upload mit Fortschrittsüberwachung und Fehlerbehandlung finden Sie unten:

Swift

// 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;
    }
  }
}];

Nachdem Sie Dateien hochgeladen haben, erfahren Sie nun, wie Sie sie aus Cloud Storage herunterladen.