Pobieranie plików za pomocą Cloud Storage na platformach Apple

Cloud Storage for Firebase umożliwia szybkie i łatwe pobieranie plików z Cloud Storage zasobnika udostępnianego i zarządzanego przez Firebase.

Tworzenie referencji

Aby pobrać plik, najpierw utwórz Cloud Storage referencję do pliku, który chcesz pobrać.

Referencję możesz utworzyć, dodając ścieżki podrzędne do katalogu głównego zasobnika Cloud Storage lub utworzyć referencję na podstawie istniejącego adresu URL gs:// lub https:// odwołującego się do obiektu w Cloud Storage.

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

Pobieranie plików

Gdy masz referencję, możesz pobierać pliki z Cloud Storage na 3 sposoby:

  1. Pobieranie do NSData w pamięci
  2. Pobieranie do NSURL reprezentującego plik na urządzeniu
  3. Generowanie NSURL reprezentującego plik online

Pobieranie do pamięci

Pobierz plik do obiektu NSData w pamięci za pomocą metody dataWithMaxSize:completion:. Jest to najłatwiejszy sposób na szybkie pobranie pliku, ale wymaga wczytania całej zawartości pliku do pamięci. Jeśli poprosisz o plik większy niż dostępna pamięć aplikacji, aplikacja ulegnie awarii. Aby zapobiec problemom z pamięcią, ustaw maksymalny rozmiar na wartość, którą aplikacja może obsłużyć, lub użyj innej metody pobierania.

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

Pobieranie do pliku lokalnego

Metoda writeToFile:completion: pobiera plik bezpośrednio na urządzenie lokalne. Użyj tej metody, jeśli użytkownicy chcą mieć dostęp do pliku offline lub udostępniać go w innej aplikacji. Metoda writeToFile:completion: zwraca FIRStorageDownloadTask, za pomocą którego możesz zarządzać pobieraniem i monitorować stan przesyłania.

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

Jeśli chcesz aktywnie zarządzać pobieraniem, możesz użyć metody writeToFile: i obserwować zadanie pobierania zamiast używać procedury obsługi zakończenia. Więcej informacji znajdziesz w sekcji Zarządzanie pobranymi plikami.

Generowanie adresu URL pobierania

Jeśli masz już infrastrukturę pobierania opartą na adresach URL lub po prostu chcesz udostępnić adres URL, możesz uzyskać adres URL pobierania pliku, wywołując metodę downloadURLWithCompletion: w referencji Cloud Storage.

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

Pobieranie obrazów za pomocą FirebaseUI

FirebaseUI zapewnia proste, konfigurowalne i gotowe do użycia w środowisku produkcyjnym natywne powiązania mobilne, które eliminują powtarzalny kod i promują sprawdzone metody Google. Dzięki FirebaseUI możesz szybko i łatwo pobierać, buforować i wyświetlać obrazy z Cloud Storage za pomocą integracji z SDWebImage.

Najpierw dodaj FirebaseUI do pliku Podfile:

pod 'FirebaseStorageUI'

Następnie możesz wczytywać obrazy bezpośrednio z Cloud Storage do 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];

Zarządzanie pobranymi plikami

Oprócz rozpoczynania pobierania możesz wstrzymywać, wznawiać i anulować pobieranie za pomocą metod pause, resume i cancel. Te metody wywołują zdarzenia pause, resume i cancel, które możesz obserwować.

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

Monitorowanie postępu pobierania

Aby monitorować postęp pobierania, możesz dołączyć obserwatorów do FIRStorageDownloadTask. Dodanie obserwatora zwraca FIRStorageHandle, za pomocą którego można usunąć obserwatora.

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

Obserwatorów można zarejestrować w zdarzeniu FIRStorageTaskStatus:

Zdarzenie `FIRStorageTaskStatus` Typowe zastosowanie
FIRStorageTaskStatusResume To zdarzenie jest wywoływane, gdy zadanie rozpoczyna lub wznawia pobieranie. Jest często używane w połączeniu ze zdarzeniem FIRStorageTaskStatusPause .
FIRStorageTaskStatusProgress To zdarzenie jest wywoływane za każdym razem, gdy dane są pobierane z Cloud Storage, i można go używać do wypełniania wskaźnika postępu pobierania.
FIRStorageTaskStatusPause To zdarzenie jest wywoływane za każdym razem, gdy pobieranie jest wstrzymywane. Jest często używane w połączeniu ze zdarzeniem FIRStorageTaskStatusResume.
FIRStorageTaskStatusSuccess To zdarzenie jest wywoływane, gdy pobieranie zostało zakończone.
FIRStorageTaskStatusFailure To zdarzenie jest wywoływane, gdy pobieranie nie powiodło się. Sprawdź błąd aby określić przyczynę niepowodzenia.

Gdy wystąpi zdarzenie, zwracany jest obiekt FIRStorageTaskSnapshot. Ta migawka to niezmienny widok zadania w momencie wystąpienia zdarzenia. Ten obiekt zawiera te właściwości:

Właściwość Typ Opis
progress NSProgress Obiekt NSProgress zawierający postęp pobierania.
error NSError Błąd, który wystąpił podczas pobierania (jeśli wystąpił).
metadata FIRStorageMetadata nil w przypadku pobierania.
task FIRStorageDownloadTask Zadanie, którego migawką jest ten obiekt. Można go używać do zarządzania (pause, resume, cancel) zadaniem.
reference FIRStorageReference Referencja, z której pochodzi to zadanie.

Możesz też usuwać obserwatorów pojedynczo, według stanu lub usuwać wszystkie.

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

Aby zapobiec wyciekom pamięci, po wystąpieniu zdarzenia FIRStorageTaskStatusSuccess lub FIRStorageTaskStatusFailure usuwane są wszystkie obserwatory.

Obsługa błędów

Błędy podczas pobierania mogą wystąpić z wielu powodów, m.in. z powodu braku pliku lub braku uprawnień użytkownika do dostępu do żądanego pliku. Więcej informacji o błędach znajdziesz w sekcji Obsługa błędów w dokumentacji.

Pełny przykład

Poniżej znajdziesz pełny przykład pobierania do pliku lokalnego z obsługą błędów:

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

Możesz też pobierać i aktualizować metadane plików przechowywanych w Cloud Storage.