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

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

Uwaga: domyślnie zasobnik Cloud Storage wymaga uwierzytelniania Firebase do wykonania jakichkolwiek działań na danych lub plikach zasobnika. Możesz zmienić reguły zabezpieczeń Firebase dla Cloud Storage, aby zezwolić na nieuwierzytelniony dostęp. Ponieważ Firebase i domyślna aplikacja App Engine w Twoim projekcie współdzielą ten zasobnik, skonfigurowanie dostępu publicznego może sprawić, że nowo przesłane pliki App Engine staną się publicznie dostępne. Pamiętaj, aby ponownie ograniczyć dostęp do zasobnika Cloud Storage podczas konfigurowania uwierzytelniania.

Tworzenie referencji

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

Możesz utworzyć odwołanie, dodając ścieżki podrzędne do katalogu głównego zasobnika Cloud Storage. Możesz też utworzyć odwołanie z 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 pliku

Po utworzeniu pliku referencyjnego możesz pobrać pliki z Cloud Storage na 3 sposoby:

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

Pobierz we wspomnieniu

Pobierz plik do obiektu NSData w pamięci przy użyciu metody dataWithMaxSize:completion:. To najprostszy sposób na szybkie pobranie pliku, który musi jednak wczytać do pamięci całą jego zawartość. Jeśli zażądasz pliku większego niż dostępna pamięć aplikacji, aplikacja ulegnie awarii. Aby zapobiec problemom z pamięcią, ustaw maksymalny rozmiar na coś, co wiesz, co Twoja aplikacja obsługuje, 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żywaj, jeśli użytkownicy chcą mieć dostęp do pliku offline lub udostępnić go w innej aplikacji. writeToFile:completion: zwraca wartość FIRStorageDownloadTask, której możesz używać do zarządzania pobieraniem i monitorowania stanu 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, zamiast korzystać z modułu obsługi ukończenia, możesz użyć metody writeToFile: i obserwować zadanie pobierania. Więcej informacji znajdziesz w artykule Zarządzanie pobranymi plikami.

Generowanie adresu URL pobierania

Jeśli masz już do pobrania infrastrukturę opartą na adresach URL lub chcesz tylko udostępnić adres URL, możesz uzyskać adres URL pobierania pliku, wywołując metodę downloadURLWithCompletion: w informacjach o 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 udostępnia proste, możliwe do dostosowania i gotowe do wykorzystania w środowisku produkcyjnym wiązania natywnych urządzeń mobilnych, które eliminują powtarzalny kod i promują sprawdzone metody Google. Korzystając z FirebaseUI, możesz szybko i łatwo pobierać, buforować oraz wyświetlać obrazy z Cloud Storage dzięki integracji z SDWebImage.

Najpierw dodaj FirebaseUI do Podfile:

pod 'FirebaseStorageUI'

Następnie możesz wczytać 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, używając metod pause, resume i cancel. Te metody zwiększają liczbę zdarzeń 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

Możesz dołączyć obserwatorów do FIRStorageDownloadTask, aby monitorować postęp pobierania. Dodanie obserwatora zwraca element FIRStorageHandle, który może zostać usunięty.

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

Ten obserwator może zostać zarejestrowany w zdarzeniu FIRStorageTaskStatus:

Zdarzenie „FIRStorageTaskStatus”	Typowe zastosowanie
FIRStorageTaskStatusResume	To zdarzenie jest wywoływane, gdy zadanie rozpoczyna lub wznawia się pobieranie. Często jest używane w połączeniu ze zdarzeniem FIRStorageTaskStatusPause.
FIRStorageTaskStatusProgress	To zdarzenie jest uruchamiane za każdym razem, gdy dane są pobierane z Cloud Storage. Może ono zostać wykorzystane do wypełnienia wskaźnika postępu pobierania.
FIRStorageTaskStatusPause	To zdarzenie jest uruchamiane po każdym wstrzymaniu pobierania i często jest używane w połączeniu ze zdarzeniem FIRStorageTaskStatusResume.
FIRStorageTaskStatusSuccess	To zdarzenie jest uruchamiane po ukończeniu pobierania.
FIRStorageTaskStatusFailure	To zdarzenie jest uruchamiane, gdy nie udało się pobrać pliku. Sprawdź błąd, aby określić jego przyczynę.

W chwili wystąpienia zdarzenia zwracany jest obiekt FIRStorageTaskSnapshot. Ten zrzut to stały widok zadania w momencie wystąpienia zdarzenia. Ten obiekt ma te właściwości:

Właściwość	Typ	Opis
progress	NSProgress	Obiekt NSProgress zawierający postęp pobierania.
error	NSError	Podczas pobierania wystąpił błąd (jeśli wystąpił)
metadata	FIRStorageMetadata	nil o pobraniach.
task	FIRStorageDownloadTask	Zadanie, którego jest zrzutem, może służyć do zarządzania zadaniem (pause, resume, cancel).
reference	FIRStorageReference	Odwołanie, z którego pochodzi to zadanie.

Możesz też usuwać obserwatorów pojedynczo, według stanu lub usuwając ich wszystkich.

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

Aby zapobiec wyciekom pamięci, po wystąpieniu FIRStorageTaskStatusSuccess lub FIRStorageTaskStatusFailure wszyscy obserwatorzy są usuwani.

Obsługa błędów

Błędy mogą wynikać z różnych powodów, np. gdy plik nie istnieje lub użytkownik nie ma uprawnień dostępu do niego. Więcej informacji o błędach znajdziesz w sekcji Obsługa błędów w tej dokumentacji.

Pełny przykład

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

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.