Dateien mit Cloud Storage auf Apple-Plattformen herunterladen

Mit Cloud Storage for Firebase können Sie Inhalte schnell und einfach Dateien aus einem Cloud Storage Bucket wird von Firebase bereitgestellt und verwaltet.

Hinweis: Standardmäßig benötigt ein Cloud Storage-Bucket Firebase Authentication, um eine Aktion für die Daten oder Dateien des Buckets ausführen. Sie können Firebase Security Rules für Cloud Storage ändern um einen nicht authentifizierten Zugriff zuzulassen. Da Firebase und die Standardeinstellung Ihres Projekts App Engine App hat diesen Bucket freigegeben. Durch das Konfigurieren des öffentlichen Zugriffs wird möglicherweise hat App Engine Dateien öffentlich zugänglich gemacht. Achten Sie darauf, wieder Zugriff auf den Bucket Cloud Storage haben, wenn Sie Authentication einrichten.

Referenz erstellen

Wenn Sie eine Datei herunterladen möchten, Cloud Storage-Referenz erstellen in der Datei, die Sie herunterladen möchten.

Sie können eine Referenz erstellen, indem Sie untergeordnete Pfade an das Stammverzeichnis Ihres Cloud Storage Bucket, oder Sie erstellen eine Referenz aus einem vorhandenen Bucket gs://- oder https://-URL, 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 du eine Referenz hast, kannst du Dateien von Cloud Storage herunterladen auf drei Arten:

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

In Arbeitsspeicher herunterladen

Laden Sie die Datei mithilfe der MethodeNSData dataWithMaxSize:completion:-Methode. Dies ist der einfachste Weg, eine Datei herunterladen, aber der gesamte Inhalt der Datei muss in den Arbeitsspeicher geladen werden. Wenn Sie eine Datei anfordern, die größer als der verfügbare Arbeitsspeicher Ihrer App ist, wird Ihre App Abstürze. Um Speicherprobleme 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 eine lokale . Verwenden Sie diese Option, wenn Ihre Nutzer Zugriff auf die Datei haben möchten, während oder in einer anderen App teilen. writeToFile:completion: gibt Folgendes zurück: FIRStorageDownloadTask, mit dem du Downloads und Monitoring verwalten kannst Status des Uploads angezeigt.

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 den Downloadvorgang beobachten, anstatt den Abschluss-Handler zu verwenden. Weitere Informationen finden Sie unter Downloads verwalten.

Download-URL generieren

Wenn Sie bereits eine Download-Infrastruktur basierend auf URLs haben oder eine URL freigegeben haben, können Sie die Download-URL für eine Datei abrufen, indem Sie die Methode downloadURLWithCompletion:-Methode für eine Cloud Storage-Referenz.

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 ein einfaches, anpassbare und produktionsreife native mobile Bindungen, um und die Best Practices von Google bekannt machen. Mit FirebaseUI können Sie Bilder schnell und einfach herunterladen, im Cache speichern und anzeigen von Cloud Storage über unsere Integration mit SDWebImage

Fügen Sie zuerst FirebaseUI zu Podfile hinzu:

pod 'FirebaseStorageUI'

Dann können Sie Bilder direkt aus Cloud Storage in eine UIImageView:

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 pausieren, fortsetzen und abbrechen. mit den Methoden pause, resume und cancel. Diese Methoden lösen pause, resume- und cancel-Ereignisse, 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 FIRStorageDownloadTasks anhängen, um den Messwert den Fortschritt des Downloads. Das Hinzufügen eines Beobachters gibt eine FIRStorageHandle zurück. mit dem der Beobachter entfernt werden kann.

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
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 der Download der Aufgabe gestartet oder fortgesetzt wird und wird häufig in Verbindung mit FIRStorageTaskStatusPause verwendet .
FIRStorageTaskStatusProgress	Dieses Ereignis wird ausgelöst, wenn Daten von Cloud Storage heruntergeladen werden. Es kann verwendet werden, um eine Downloadfortschrittsanzeige zu füllen.
FIRStorageTaskStatusPause	Dieses Ereignis wird immer dann ausgelöst, wenn der Download angehalten wird und wird häufig verwendet in in Verbindung mit dem Ereignis FIRStorageTaskStatusResume.
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 Eigenschaften:

Attribut	Typ	Beschreibung
progress	NSProgress	Ein NSProgress-Objekt, das den Fortschritt des Downloads enthält.
error	NSError	Fehler, der während des Downloads aufgetreten ist (falls vorhanden)
metadata	FIRStorageMetadata	nil für Downloads.
task	FIRStorageDownloadTask	Die Aufgabe, deren Snapshot dies ist, mit der die Aufgabe verwaltet werden kann (pause, resume, cancel).
reference	FIRStorageReference	Die Referenz, aus der diese Aufgabe stammt.

Sie können Beobachter auch einzeln, nach Status oder durch Entfernen von allen.

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
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 vermeiden, werden alle Beobachter nach einem FIRStorageTaskStatusSuccess oder FIRStorageTaskStatusFailure entfernt.

Fehler beheben

Fehler können aus verschiedenen Gründen beim Download auftreten, Datei nicht vorhanden oder der Nutzer hat keine Zugriffsberechtigung für die gewünschte Datei. Weitere Informationen zu Fehlern finden Sie in der Fehler beheben der Dokumentation.

Vollständiges Beispiel

Im Folgenden finden Sie ein vollständiges Beispiel für den Download 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.