Laden Sie Dateien mit Cloud Storage auf Apple-Plattformen herunter

Mit Cloud Storage für Firebase können Sie schnell und einfach Dateien aus einem von Firebase bereitgestellten und verwalteten Cloud Storage- Bucket herunterladen.

Hinweis: Standardmäßig erfordert ein Cloud Storage-Bucket die Firebase-Authentifizierung, um Aktionen an den Daten oder Dateien des Buckets durchzuführen. Sie können Ihre Firebase-Sicherheitsregeln für Cloud Storage ändern , um nicht authentifizierten Zugriff zu ermöglichen. Da Firebase und die Standard-App Engine-App Ihres Projekts diesen Bucket gemeinsam nutzen, können durch die Konfiguration des öffentlichen Zugriffs möglicherweise auch neu hochgeladene App Engine-Dateien öffentlich zugänglich gemacht werden. Achten Sie darauf, den Zugriff auf Ihren Cloud Storage-Bucket erneut einzuschränken, wenn Sie die Authentifizierung einrichten.

Erstellen Sie eine Referenz

Um eine Datei herunterzuladen, erstellen Sie zunächst einen Cloud Storage-Verweis auf die Datei, die Sie herunterladen möchten.

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

Schnell

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

Ziel 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 dem Cloud-Speicher herunterladen:

1. Laden Sie es in NSData im Speicher herunter
2. Laden Sie es auf eine NSURL herunter, die eine Datei auf dem Gerät darstellt
3. Generieren Sie online eine NSURL , die die Datei darstellt

Im Speicher herunterladen

Laden Sie die Datei mit der Methode dataWithMaxSize:completion: in ein NSData Objekt im Speicher herunter. Dies ist der einfachste Weg, eine Datei schnell herunterzuladen, es muss jedoch der gesamte Inhalt Ihrer Datei in den Speicher geladen werden. Wenn Sie eine Datei anfordern, die größer ist als der verfügbare Speicher Ihrer App, stürzt Ihre App ab. Stellen Sie zum Schutz vor Speicherproblemen sicher, dass Sie die maximale Größe auf einen Wert festlegen, von dem Sie wissen, dass Ihre App ihn verarbeiten kann, oder verwenden Sie eine andere Download-Methode.

Schnell

// 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!)
  }
}
    

Ziel 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

Die Methode writeToFile:completion: lädt eine Datei direkt auf ein lokales Gerät herunter. Verwenden Sie diese Option, wenn Ihre Benutzer offline auf die Datei zugreifen oder sie in einer anderen App teilen möchten. writeToFile:completion: gibt eine FIRStorageDownloadTask zurück, mit der Sie Ihren Download verwalten und den Status des Uploads überwachen können.

Schnell

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

Ziel 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 Ihren Download aktiv verwalten möchten, können Sie die Methode writeToFile: verwenden und die Download-Aufgabe beobachten, anstatt den Abschlusshandler zu verwenden. Weitere Informationen finden Sie unter Downloads verwalten .

Generieren Sie eine Download-URL

Wenn Sie bereits über eine auf URLs basierende Download-Infrastruktur verfügen oder einfach nur eine URL teilen möchten, können Sie die Download-URL für eine Datei abrufen, indem Sie die downloadURLWithCompletion: -Methode in einer Cloud Storage-Referenz aufrufen.

Schnell

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

Ziel 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'
  }
}];
    

Herunterladen von Bildern mit FirebaseUI

FirebaseUI bietet einfache, anpassbare und produktionsbereite native mobile Bindungen, um Standardcode zu eliminieren und die Best Practices von Google zu fördern. Mit FirebaseUI können Sie mithilfe unserer Integration mit SDWebImage schnell und einfach Bilder aus dem Cloud-Speicher herunterladen, zwischenspeichern und anzeigen.

Fügen Sie zunächst FirebaseUI zu Ihrem Podfile hinzu:

pod 'FirebaseStorageUI'

Anschließend können Sie Bilder direkt aus dem Cloud-Speicher in ein UIImageView laden:

Schnell

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

Ziel 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

Zusätzlich zum Starten von Downloads können Sie Downloads mit den Methoden „ pause “, „ resume “ und cancel anhalten, fortsetzen und abbrechen. Diese Methoden lösen pause , resume und cancel Ereignisse aus, die Sie beobachten können.

Schnell

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

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

Überwachen Sie den Download-Fortschritt

Sie können Beobachter an FIRStorageDownloadTask s anhängen, um den Fortschritt des Downloads zu überwachen. Durch das Hinzufügen eines Beobachters wird ein FIRStorageHandle zurückgegeben, mit dem der Beobachter entfernt werden kann.

Schnell

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

Ziel c

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

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

Ereignis „FIRStorageTaskStatus“.	Typische Verwendung
FIRStorageTaskStatusResume	Dieses Ereignis wird ausgelöst, wenn die Aufgabe den Download startet oder fortsetzt, und wird häufig in Verbindung mit dem Ereignis FIRStorageTaskStatusPause verwendet.
FIRStorageTaskStatusProgress	Dieses Ereignis wird jedes Mal ausgelöst, wenn Daten aus dem Cloud-Speicher heruntergeladen werden, und kann zum Füllen einer Download-Fortschrittsanzeige verwendet werden.
FIRStorageTaskStatusPause	Dieses Ereignis wird jedes Mal ausgelöst, wenn der Download angehalten wird, und wird häufig in Verbindung mit dem Ereignis FIRStorageTaskStatusResume verwendet.
FIRStorageTaskStatusSuccess	Dieses Ereignis wird ausgelöst, wenn ein Download erfolgreich abgeschlossen wurde.
FIRStorageTaskStatusFailure	Dieses Ereignis wird ausgelöst, wenn ein Download fehlgeschlagen ist. Untersuchen Sie den Fehler, um die Fehlerursache zu ermitteln.

Wenn ein Ereignis auftritt, wird ein FIRStorageTaskSnapshot Objekt zurückgegeben. Dieser Schnappschuss ist eine unveränderliche Ansicht der Aufgabe zum Zeitpunkt des Auftretens des Ereignisses. Dieses Objekt enthält die folgenden Eigenschaften:

Eigentum	Typ	Beschreibung
progress	NSProgress	Ein NSProgress Objekt, das den Fortschritt des Downloads enthält.
error	NSError	Ein Fehler, der während des Downloads aufgetreten ist, falls vorhanden.
metadata	FIRStorageMetadata	nil Downloads.
task	FIRStorageDownloadTask	Bei der Aufgabe handelt es sich um eine Momentaufnahme, die zum Verwalten ( pause , resume , cancel ) der Aufgabe verwendet werden kann.
reference	FIRStorageReference	Die Referenz, aus der diese Aufgabe stammt.

Sie können Beobachter auch einzeln, nach Status oder durch Entfernen aller Beobachter entfernen.

Schnell

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

Ziel c

// Create a task listener handle
FIRStorageHandle 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 verhindern, werden alle Beobachter entfernt, nachdem ein FIRStorageTaskStatusSuccess oder FIRStorageTaskStatusFailure auftritt.

Behandeln Sie Fehler

Es gibt eine Reihe von Gründen, warum beim Herunterladen Fehler auftreten können, darunter, dass die Datei nicht vorhanden ist oder der Benutzer keine Berechtigung zum Zugriff auf die gewünschte Datei hat. Weitere Informationen zu Fehlern finden Sie im Abschnitt „Fehler behandeln“ der Dokumentation.

Vollständiges Beispiel

Ein vollständiges Beispiel für das Herunterladen in eine lokale Datei mit Fehlerbehandlung ist unten dargestellt:

Schnell

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

Ziel 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 für Dateien abrufen und aktualisieren , die in Cloud Storage gespeichert sind.