Przesyłanie plików za pomocą Cloud Storage na platformach Apple

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

Tworzenie referencji

Aby przesłać plik, najpierw utwórz Cloud Storage plik referencyjny do lokalizacji w Cloud Storage, do której chcesz przesłać plik.

Możesz utworzyć odwołanie, dołączając ścieżki podrzędne do katalogu głównego zasobnika Cloud Storage:

Swift

// Create a root reference
let storageRef = storage.reference()

// Create a reference to "mountains.jpg"
let mountainsRef = storageRef.child("mountains.jpg")

// Create a reference to 'images/mountains.jpg'
let mountainImagesRef = storageRef.child("images/mountains.jpg")

// While the file names are the same, the references point to different files
mountainsRef.name == mountainImagesRef.name            // true
mountainsRef.fullPath == mountainImagesRef.fullPath    // false

Objective-C

// Create a root reference
FIRStorageReference *storageRef = [storage reference];

// Create a reference to "mountains.jpg"
FIRStorageReference *mountainsRef = [storageRef child:@"mountains.jpg"];

// Create a reference to 'images/mountains.jpg'
FIRStorageReference *mountainImagesRef = [storageRef child:@"images/mountains.jpg"];

// While the file names are the same, the references point to different files
[mountainsRef.name isEqualToString:mountainImagesRef.name];         // true
[mountainsRef.fullPath isEqualToString:mountainImagesRef.fullPath]; // false

Nie możesz przesłać danych z odwołaniem do katalogu głównego zasobnika Cloud Storage. Plik referencyjny musi wskazywać adres URL elementu podrzędnego.

Przesyłanie plików

Gdy masz już plik referencyjny, możesz przesłać pliki do Cloud Storage na 2 sposoby:

  1. Przesyłanie danych z pamięci
  2. Przesyłanie z adresu URL reprezentującego plik na urządzeniu

Przesyłanie danych z pamięci

Metoda putData:metadata:completion: to najprostszy sposób na przesłanie pliku do Cloud Storage. Metoda putData:metadata:completion: przyjmuje obiekt NSData i zwraca obiekt FIRStorageUploadTask, którego możesz używać do zarządzania przesyłaniem i monitorowania jego stanu.

Swift

// Data in memory
let data = Data()

// Create a reference to the file you want to upload
let riversRef = storageRef.child("images/rivers.jpg")

// Upload the file to the path "images/rivers.jpg"
let uploadTask = riversRef.putData(data, metadata: nil) { (metadata, error) in
  guard let metadata = metadata else {
    // Uh-oh, an error occurred!
    return
  }
  // Metadata contains file metadata such as size, content-type.
  let size = metadata.size
  // You can also access to download URL after upload.
  riversRef.downloadURL { (url, error) in
    guard let downloadURL = url else {
      // Uh-oh, an error occurred!
      return
    }
  }
}

Objective-C

// Data in memory
NSData *data = [NSData dataWithContentsOfFile:@"rivers.jpg"];

// Create a reference to the file you want to upload
FIRStorageReference *riversRef = [storageRef child:@"images/rivers.jpg"];

// Upload the file to the path "images/rivers.jpg"
FIRStorageUploadTask *uploadTask = [riversRef putData:data
                                             metadata:nil
                                           completion:^(FIRStorageMetadata *metadata,
                                                        NSError *error) {
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Metadata contains file metadata such as size, content-type, and download URL.
    int size = metadata.size;
    // You can also access to download URL after upload.
    [riversRef downloadURLWithCompletion:^(NSURL * _Nullable URL, NSError * _Nullable error) {
      if (error != nil) {
        // Uh-oh, an error occurred!
      } else {
        NSURL *downloadURL = URL;
      }
    }];
  }
}];

Przesyłanie z pliku lokalnego

Możesz przesyłać pliki lokalne na urządzenia, np. zdjęcia i filmy z aparatu, za pomocą metody putFile:metadata:completion:. putFile:metadata:completion: przyjmuje NSURL i zwraca FIRStorageUploadTask, którego możesz użyć do zarządzania przesyłaniem i monitorowania jego stanu.

Swift

// File located on disk
let localFile = URL(string: "path/to/image")!

// Create a reference to the file you want to upload
let riversRef = storageRef.child("images/rivers.jpg")

// Upload the file to the path "images/rivers.jpg"
let uploadTask = riversRef.putFile(from: localFile, metadata: nil) { metadata, error in
  guard let metadata = metadata else {
    // Uh-oh, an error occurred!
    return
  }
  // Metadata contains file metadata such as size, content-type.
  let size = metadata.size
  // You can also access to download URL after upload.
  riversRef.downloadURL { (url, error) in
    guard let downloadURL = url else {
      // Uh-oh, an error occurred!
      return
    }
  }
}

Objective-C

// File located on disk
NSURL *localFile = [NSURL URLWithString:@"path/to/image"];

// Create a reference to the file you want to upload
FIRStorageReference *riversRef = [storageRef child:@"images/rivers.jpg"];

// Upload the file to the path "images/rivers.jpg"
FIRStorageUploadTask *uploadTask = [riversRef putFile:localFile metadata:nil completion:^(FIRStorageMetadata *metadata, NSError *error) {
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Metadata contains file metadata such as size, content-type, and download URL.
    int size = metadata.size;
    // You can also access to download URL after upload.
    [riversRef downloadURLWithCompletion:^(NSURL * _Nullable URL, NSError * _Nullable error) {
      if (error != nil) {
        // Uh-oh, an error occurred!
      } else {
        NSURL *downloadURL = URL;
      }
    }];
  }
}];

Jeśli chcesz aktywnie zarządzać przesyłaniem, możesz użyć metody putData: lub putFile: i obserwować zadanie przesyłania, zamiast używać modułu obsługi zakończenia. Więcej informacji znajdziesz w artykule Zarządzanie przesyłaniem.

Dodaj metadane pliku

Podczas przesyłania plików możesz też dołączyć metadane. Te metadane zawierają typowe właściwości metadanych plików, takie jak name, size i contentType (powszechnie nazywane typem MIME). Metoda putFile: automatycznie wnioskuje typ treści na podstawie rozszerzenia nazwy pliku NSURL, ale możesz zastąpić automatycznie wykryty typ, określając contentType w metadanych. Jeśli nie podasz parametru contentType, a Cloud Storage nie może wywnioskować wartości domyślnej z rozszerzenia pliku, Cloud Storage używa application/octet-stream. Więcej informacji o metadanych plików znajdziesz w sekcji Używanie metadanych plików.

Swift

// Create storage reference
let mountainsRef = storageRef.child("images/mountains.jpg")

// Create file metadata including the content type
let metadata = StorageMetadata()
metadata.contentType = "image/jpeg"

// Upload data and metadata
mountainsRef.putData(data, metadata: metadata)

// Upload file and metadata
mountainsRef.putFile(from: localFile, metadata: metadata)

Objective-C

// Create storage reference
FIRStorageReference *mountainsRef = [storageRef child:@"images/mountains.jpg"];

// Create file metadata including the content type
FIRStorageMetadata *metadata = [[FIRStorageMetadata alloc] init];
metadata.contentType = @"image/jpeg";

// Upload data and metadata
FIRStorageUploadTask *uploadTask = [mountainsRef putData:data metadata:metadata];

// Upload file and metadata
uploadTask = [mountainsRef putFile:localFile metadata:metadata];

Zarządzaj przesyłaniem

Oprócz rozpoczynania przesyłania możesz je wstrzymywać, wznawiać i anulować za pomocą metod pause, resume i cancel. Te metody wywołują zdarzenia pause, resume i cancel. Anulowanie przesyłania powoduje błąd wskazujący, że przesyłanie zostało anulowane.

Swift

// Start uploading a file
let uploadTask = storageRef.putFile(from: localFile)

// Pause the upload
uploadTask.pause()

// Resume the upload
uploadTask.resume()

// Cancel the upload
uploadTask.cancel()

Objective-C

// Start uploading a file
FIRStorageUploadTask *uploadTask = [storageRef putFile:localFile];

// Pause the upload
[uploadTask pause];

// Resume the upload
[uploadTask resume];

// Cancel the upload
[uploadTask cancel];

Monitorowanie postępu przesyłania

Do obiektów FIRStorageUploadTask możesz dołączyć obserwatorów, aby monitorować postęp przesyłania. Dodanie obserwatora zwraca obiekt FIRStorageHandle, którego można użyć do usunięcia obserwatora.

Swift

// Add a progress observer to an upload task
let observer = uploadTask.observe(.progress) { snapshot in
  // A progress event occured
}

Objective-C

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

Do zdarzenia FIRStorageTaskStatus można dodać tych obserwatorów:

FIRStorageTaskStatus zdarzenie Typowe zastosowanie
FIRStorageTaskStatusResume To zdarzenie jest wywoływane, gdy zadanie rozpoczyna lub wznawia przesyłanie, i często jest używane w połączeniu ze zdarzeniem FIRStorageTaskStatusPause.
FIRStorageTaskStatusProgress To zdarzenie jest wywoływane za każdym razem, gdy dane są przesyłane do Cloud Storage, i może służyć do wypełniania wskaźnika postępu przesyłania.
FIRStorageTaskStatusPause To zdarzenie jest wywoływane za każdym razem, gdy przesyłanie zostanie wstrzymane, i często jest używane w połączeniu ze zdarzeniem FIRStorageTaskStatusResume.
FIRStorageTaskStatusSuccess To zdarzenie jest wywoływane, gdy przesyłanie zostanie zakończone.
FIRStorageTaskStatusFailure To zdarzenie jest wywoływane, gdy przesyłanie się nie powiedzie. Sprawdź błąd, aby określić przyczynę niepowodzenia.

Gdy wystąpi zdarzenie, zwracany jest obiekt FIRStorageTaskSnapshot. Ten zrzut 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 informacje o postępach przesyłania.
error NSError Błąd, który wystąpił podczas przesyłania (jeśli wystąpił).
metadata FIRStorageMetadata Podczas przesyłania zawiera przesyłane metadane. Po zdarzeniu FIRTaskStatusSuccess zawiera metadane przesłanego pliku.
task FIRStorageUploadTask Zadanie, którego dotyczy to podsumowanie. Można go użyć do zarządzania zadaniem (pause, resume, cancel).
reference FIRStorageReference Odniesienie, z którego pochodzi to zadanie.

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

Swift

// Create a task listener handle
let observer = uploadTask.observe(.progress) { snapshot in
  // A progress event occurred
}

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

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

// Remove all observers
uploadTask.removeAllObservers()

Objective-C

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

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

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

// Remove all observers
[uploadTask removeAllObservers];

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

Obsługa błędów

Błędy podczas przesyłania mogą wystąpić z różnych powodów, np. gdy plik lokalny nie istnieje lub użytkownik nie ma uprawnień do przesłania 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 przesyłania z monitorowaniem postępów i obsługą błędów:

Swift

// Local file you want to upload
let localFile = URL(string: "path/to/image")!

// Create the file metadata
let metadata = StorageMetadata()
metadata.contentType = "image/jpeg"

// Upload file and metadata to the object 'images/mountains.jpg'
let uploadTask = storageRef.putFile(from: localFile, metadata: metadata)

// Listen for state changes, errors, and completion of the upload.
uploadTask.observe(.resume) { snapshot in
  // Upload resumed, also fires when the upload starts
}

uploadTask.observe(.pause) { snapshot in
  // Upload paused
}

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

uploadTask.observe(.success) { snapshot in
  // Upload completed successfully
}

uploadTask.observe(.failure) { snapshot in
  if let error = snapshot.error as? NSError {
    switch (StorageErrorCode(rawValue: error.code)!) {
    case .objectNotFound:
      // File doesn't exist
      break
    case .unauthorized:
      // User doesn't have permission to access file
      break
    case .cancelled:
      // User canceled the upload
      break

    /* ... */

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

Objective-C

// Local file you want to upload
NSURL *localFile = [NSURL URLWithString:@"path/to/image"];

// Create the file metadata
FIRStorageMetadata *metadata = [[FIRStorageMetadata alloc] init];
metadata.contentType = @"image/jpeg";

// Upload file and metadata to the object 'images/mountains.jpg'
FIRStorageUploadTask *uploadTask = [storageRef putFile:localFile metadata:metadata];

// Listen for state changes, errors, and completion of the upload.
[uploadTask observeStatus:FIRStorageTaskStatusResume handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Upload resumed, also fires when the upload starts
}];

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

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

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

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

Teraz, gdy pliki zostały przesłane, dowiedzmy się, jak je pobrać z usługi Cloud Storage.