Dateien mit Cloud Storage auf Apple-Plattformen herunterladen

Cloud Storage for Firebase ermöglicht Ihnen das schnelle und einfache Herunterladen von Dateien aus einem Cloud Storage Bucket, der von Firebase bereitgestellt und verwaltet wird.

Referenz erstellen

Wenn Sie eine Datei herunterladen möchten, erstellen Sie zuerst eine Cloud Storage Referenz zur gewünschten Datei.

Sie können eine Referenz erstellen, indem Sie untergeordnete Pfade an den Stamm Ihres Cloud Storage Buckets anhängen. Alternativ können Sie eine Referenz aus einer vorhandenen gs:// oder https:// URL erstellen, die auf ein Objekt in Cloud Storage verweist.

Swift

// Create a reference with an initial file path and name
let pathReference = storage.reference(withPath: "images/stars.jpg")

// Create a reference from a Google Cloud Storage URI
let gsReference = storage.reference(forURL: "gs://<your-firebase-storage-bucket>/images/stars.jpg")

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
let httpsReference = storage.reference(forURL: "https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg")

Objective-C

// Create a reference with an initial file path and name
FIRStorageReference *pathReference = [storage referenceWithPath:@"images/stars.jpg"];

// Create a reference from a Google Cloud Storage URI
FIRStorageReference *gsReference = [storage referenceForURL:@"gs://<your-firebase-storage-bucket>/images/stars.jpg"];

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
FIRStorageReference *httpsReference = [storage referenceForURL:@"https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg"];

Dateien herunterladen

Sobald Sie eine Referenz haben, können Sie Dateien auf drei Arten aus Cloud Storage herunterladen:

  1. In NSData im Arbeitsspeicher herunterladen
  2. In eine NSURL herunterladen, die eine Datei auf dem Gerät darstellt
  3. Eine NSURL generieren, die die Datei online darstellt

In den Arbeitsspeicher herunterladen

Laden Sie die Datei mit der Methode dataWithMaxSize:completion: in ein NSData-Objekt im Arbeitsspeicher herunter. Dies ist die einfachste Möglichkeit, eine Datei schnell herunterzuladen. Allerdings muss der gesamte Inhalt der Datei in den Arbeitsspeicher geladen werden. Wenn Sie eine Datei anfordern, die größer ist als der verfügbare Arbeitsspeicher Ihrer App, stürzt die App ab. Um Probleme mit dem Arbeitsspeicher zu vermeiden, legen Sie die maximale Größe auf einen Wert fest, den Ihre App verarbeiten kann, oder verwenden Sie eine andere Downloadmethode.

Swift

// Create a reference to the file you want to download
let islandRef = storageRef.child("images/island.jpg")

// Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes)
islandRef.getData(maxSize: 1 * 1024 * 1024) { data, error in
  if let error = error {
    // Uh-oh, an error occurred!
  } else {
    // Data for "images/island.jpg" is returned
    let image = UIImage(data: data!)
  }
}

Objective-C

// Create a reference to the file you want to download
FIRStorageReference *islandRef = [storageRef child:@"images/island.jpg"];

// Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes)
[islandRef dataWithMaxSize:1 * 1024 * 1024 completion:^(NSData *data, NSError *error){
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Data for "images/island.jpg" is returned
    UIImage *islandImage = [UIImage imageWithData:data];
  }
}];

In eine lokale Datei herunterladen

Mit der Methode writeToFile:completion: wird eine Datei direkt auf ein lokales Gerät heruntergeladen. Verwenden Sie diese Methode, wenn Ihre Nutzer offline auf die Datei zugreifen oder sie in einer anderen App freigeben möchten. writeToFile:completion: gibt ein FIRStorageDownloadTask-Objekt zurück, mit dem Sie den Download verwalten und den Status des Uploads überwachen können.

Swift

// Create a reference to the file you want to download
let islandRef = storageRef.child("images/island.jpg")

// Create local filesystem URL
let localURL = URL(string: "path/to/image")!

// Download to the local filesystem
let downloadTask = islandRef.write(toFile: localURL) { url, error in
  if let error = error {
    // Uh-oh, an error occurred!
  } else {
    // Local file URL for "images/island.jpg" is returned
  }
}

Objective-C

// Create a reference to the file you want to download
FIRStorageReference *islandRef = [storageRef child:@"images/island.jpg"];

// Create local filesystem URL
NSURL *localURL = [NSURL URLWithString:@"path/to/image"];

// Download to the local filesystem
FIRStorageDownloadTask *downloadTask = [islandRef writeToFile:localURL completion:^(NSURL *URL, NSError *error){
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Local file URL for "images/island.jpg" is returned
  }
}];

Wenn Sie den Download aktiv verwalten möchten, können Sie die Methode writeToFile: verwenden und die Downloadaufgabe beobachten, anstatt den Completion-Handler zu verwenden. Weitere Informationen finden Sie unter Downloads verwalten.

Download-URL generieren

Wenn Sie bereits eine Downloadinfrastruktur haben, die auf URLs basiert, oder einfach nur eine URL zum Freigeben benötigen, können Sie die Download-URL für eine Datei abrufen, indem Sie die downloadURLWithCompletion: Methode für eine Cloud Storage Referenz aufrufen.

Swift

// Create a reference to the file you want to download
let starsRef = storageRef.child("images/stars.jpg")

// Fetch the download URL
starsRef.downloadURL { url, error in
  if let error = error {
    // Handle any errors
  } else {
    // Get the download URL for 'images/stars.jpg'
  }
}

Objective-C

// Create a reference to the file you want to download
FIRStorageReference *starsRef = [storageRef child:@"images/stars.jpg"];

// Fetch the download URL
[starsRef downloadURLWithCompletion:^(NSURL *URL, NSError *error){
  if (error != nil) {
    // Handle any errors
  } else {
    // Get the download URL for 'images/stars.jpg'
  }
}];

Bilder mit FirebaseUI herunterladen

FirebaseUI bietet einfache, anpassbare und produktionsfertige native mobile Bindungen, um Boilerplate-Code zu vermeiden und die Best Practices von Google zu fördern. Mit FirebaseUI können Sie Bilder aus Cloud Storage schnell und einfach herunterladen, im Cache speichern und anzeigen. Dazu wird unsere Integration mit SDWebImage verwendet.

Fügen Sie zuerst FirebaseUI zu Ihrer Podfile hinzu:

pod 'FirebaseStorageUI'

Anschließend können Sie Bilder direkt aus Cloud Storage in eine UIImageView laden:

Swift

// Reference to an image file in Firebase Storage
let reference = storageRef.child("images/stars.jpg")

// UIImageView in your ViewController
let imageView: UIImageView = self.imageView

// Placeholder image
let placeholderImage = UIImage(named: "placeholder.jpg")

// Load the image using SDWebImage
imageView.sd_setImage(with: reference, placeholderImage: placeholderImage)

Objective-C

// Reference to an image file in Firebase Storage
FIRStorageReference *reference = [storageRef child:@"images/stars.jpg"];

// UIImageView in your ViewController
UIImageView *imageView = self.imageView;

// Placeholder image
UIImage *placeholderImage;

// Load the image using SDWebImage
[imageView sd_setImageWithStorageReference:reference placeholderImage:placeholderImage];

Downloads verwalten

Sie können Downloads nicht nur starten, sondern auch mit den Methoden pause, resume und cancel pausieren, fortsetzen und abbrechen. Diese Methoden lösen die Ereignisse pause, resume und cancel aus, die Sie beobachten können.

Swift

// Start downloading a file
let downloadTask = storageRef.child("images/mountains.jpg").write(toFile: localFile)

// Pause the download
downloadTask.pause()

// Resume the download
downloadTask.resume()

// Cancel the download
downloadTask.cancel()

Objective-C

// Start downloading a file
FIRStorageDownloadTask *downloadTask = [[storageRef child:@"images/mountains.jpg"] writeToFile:localFile];

// Pause the download
[downloadTask pause];

// Resume the download
[downloadTask resume];

// Cancel the download
[downloadTask cancel];

Downloadfortschritt überwachen

Sie können Beobachter an FIRStorageDownloadTask-Objekte anhängen, um den Fortschritt des Downloads zu überwachen. Wenn Sie einen Beobachter hinzufügen, wird ein FIRStorageHandle-Objekt zurückgegeben, mit dem Sie den Beobachter entfernen können.

Swift

// Add a progress observer to a download task
let observer = downloadTask.observe(.progress) { snapshot in
  // A progress event occurred
}

Objective-C

// Add a progress observer to a download task
NSString *observer = [downloadTask observeStatus:FIRStorageTaskStatusProgress
                                         handler:^(FIRStorageTaskSnapshot *snapshot) {
  // A progress event occurred
}];

Diese Beobachter können für ein FIRStorageTaskStatus-Ereignis registriert werden:

`FIRStorageTaskStatus`-Ereignis Typische Verwendung
FIRStorageTaskStatusResume Dieses Ereignis wird ausgelöst, wenn der Download gestartet oder fortgesetzt wird. Es wird häufig in Verbindung mit dem FIRStorageTaskStatusPause Ereignis verwendet.
FIRStorageTaskStatusProgress Dieses Ereignis wird jedes Mal ausgelöst, wenn Daten aus Cloud Storage heruntergeladen werden. Es kann verwendet werden, um eine Fortschrittsanzeige für den Download zu füllen.
FIRStorageTaskStatusPause Dieses Ereignis wird jedes Mal ausgelöst, wenn der Download pausiert wird. Es wird häufig in Verbindung mit dem FIRStorageTaskStatusResume Ereignis verwendet.
FIRStorageTaskStatusSuccess Dieses Ereignis wird ausgelöst, wenn ein Download erfolgreich abgeschlossen wurde.
FIRStorageTaskStatusFailure Dieses Ereignis wird ausgelöst, wenn ein Download fehlgeschlagen ist. Prüfen Sie den Fehler 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 Downloads.
error NSError Ein Fehler, der während des Downloads aufgetreten ist (falls vorhanden).
metadata FIRStorageMetadata nil bei Downloads.
task FIRStorageDownloadTask Die Aufgabe, von der dieser Snapshot stammt. 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 = downloadTask.observe(.progress) { snapshot in
// A progress event occurred
}

// Remove an individual observer
downloadTask.removeObserver(withHandle: observer)

// Remove all observers of a particular status
downloadTask.removeAllObservers(for: .progress)

// Remove all observers
downloadTask.removeAllObservers()

Objective-C

// Create a task listener handle
NSString *observer = [downloadTask observeStatus:FIRStorageTaskStatusProgress
                                         handler:^(FIRStorageTaskSnapshot *snapshot) {
  // A progress event occurred
}];

// Remove an individual observer
[downloadTask removeObserverWithHandle:observer];

// Remove all observers of a particular status
[downloadTask removeAllObserversForStatus:FIRStorageTaskStatusProgress];

// Remove all observers
[downloadTask removeAllObservers];

Um Speicherlecks zu vermeiden, werden alle Beobachter entfernt, nachdem ein FIRStorageTaskStatusSuccess- oder FIRStorageTaskStatusFailure-Ereignis eingetreten ist.

Fehler verarbeiten

Es gibt eine Reihe von Gründen, warum beim Download Fehler auftreten können. Dazu gehören beispielsweise, dass die Datei nicht vorhanden ist oder der Nutzer keine Berechtigung hat, auf die gewünschte Datei zuzugreifen. Weitere Informationen zu Fehlern finden Sie im Abschnitt Fehler verarbeiten in der Dokumentation.

Vollständiges Beispiel

Unten sehen Sie ein vollständiges Beispiel für das Herunterladen in eine lokale Datei mit Fehlerbehandlung:

Swift

// Create a reference to the file we want to download
let starsRef = storageRef.child("images/stars.jpg")

// Start the download (in this case writing to a file)
let downloadTask = storageRef.write(toFile: localURL)

// Observe changes in status
downloadTask.observe(.resume) { snapshot in
  // Download resumed, also fires when the download starts
}

downloadTask.observe(.pause) { snapshot in
  // Download paused
}

downloadTask.observe(.progress) { snapshot in
  // Download reported progress
  let percentComplete = 100.0 * Double(snapshot.progress!.completedUnitCount)
    / Double(snapshot.progress!.totalUnitCount)
}

downloadTask.observe(.success) { snapshot in
  // Download completed successfully
}

// Errors only occur in the "Failure" case
downloadTask.observe(.failure) { snapshot in
  guard let errorCode = (snapshot.error as? NSError)?.code else {
    return
  }
  guard let error = StorageErrorCode(rawValue: errorCode) else {
    return
  }
  switch (error) {
  case .objectNotFound:
    // File doesn't exist
    break
  case .unauthorized:
    // User doesn't have permission to access file
    break
  case .cancelled:
    // User cancelled the download
    break

  /* ... */

  case .unknown:
    // Unknown error occurred, inspect the server response
    break
  default:
    // Another error occurred. This is a good place to retry the download.
    break
  }
}

Objective-C

// Create a reference to the file we want to download
FIRStorageReference *starsRef = [storageRef child:@"images/stars.jpg"];

// Start the download (in this case writing to a file)
FIRStorageDownloadTask *downloadTask = [storageRef writeToFile:localURL];

// Observe changes in status
[downloadTask observeStatus:FIRStorageTaskStatusResume handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download resumed, also fires when the download starts
}];

[downloadTask observeStatus:FIRStorageTaskStatusPause handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download paused
}];

[downloadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download reported progress
  double percentComplete = 100.0 * (snapshot.progress.completedUnitCount) / (snapshot.progress.totalUnitCount);
}];

[downloadTask observeStatus:FIRStorageTaskStatusSuccess handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download completed successfully
}];

// Errors only occur in the "Failure" case
[downloadTask 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;
    }
  }
}];

Sie können auch Metadaten abrufen und aktualisieren für Dateien, die in Cloud Storage gespeichert sind.