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

Cloud Storage dla 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 odniesienie do Cloud Storage 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 odwołujących się do katalogu głównego zasobnika Cloud Storage. Odwołanie musi wskazywać podrzędny URL.

Prześlij pliki

Po utworzeniu odniesienia możesz przesłać pliki do Cloud Storage na 2 sposoby:

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

Prześlij z danych w pamięci

Metoda putData:metadata:completion: to najprostszy sposób przesyłania pliku do Cloud Storage. putData:metadata:completion: pobiera 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;
      }
    }];
  }
}];

Prześlij z pliku lokalnego

Metoda putFile:metadata:completion: umożliwia przesyłanie plików lokalnych z urządzeń, np. zdjęć i filmów z aparatu. putFile:metadata:completion: pobiera NSURL i zwraca FIRStorageUploadTask, którego możesz używać 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 korzystać z metod putData: lub putFile: i obserwować zadanie przesyłania, zamiast korzystać z modułu obsługi uzupełniania. Więcej informacji znajdziesz w artykule Zarządzanie przesyłaniem.

Dodaj metadane pliku

Możesz też dołączyć metadane podczas przesyłania plików. Zawierają one typowe właściwości metadanych plików, takie jak name, size i contentType (powszechnie nazywane typem MIME). Metoda putFile: automatycznie określa typ treści na podstawie rozszerzenia nazwy pliku NSURL, ale możesz zastąpić automatycznie wykryty typ, podając w metadanych contentType. Jeśli nie podasz contentType, a Cloud Storage nie będzie w stanie ustalić wartości domyślnej na podstawie rozszerzenia pliku, Cloud Storage użyje application/octet-stream. Więcej informacji o metadanych pliku znajdziesz w sekcji Używanie metadanych pliku.

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 wstrzymywać, wznawiać i anulować przesyłanie, korzystając z metod pause, resume i cancel. Te metody zwiększają liczbę zdarzeń pause, resume i cancel. Jeśli to zrobisz, przesyłanie zakończy się niepowodzeniem i wyświetli się komunikat o błędzie informujący o anulowaniu.

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

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

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
FIRStorageHandle 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 się lub wznawia przesyłanie. Często jest używane w połączeniu ze zdarzeniem FIRStorageTaskStatusPause.
FIRStorageTaskStatusProgress To zdarzenie uruchamia się za każdym razem, gdy dane są przesyłane do Cloud Storage. Może ono posłużyć do wypełnienia wskaźnika postępu przesyłania.
FIRStorageTaskStatusPause To zdarzenie uruchamia się za każdym razem, gdy wstrzymasz przesyłanie. Często jest używane w połączeniu ze zdarzeniem FIRStorageTaskStatusResume.
FIRStorageTaskStatusSuccess To zdarzenie jest uruchamiane po pomyślnym zakończeniu przesyłania.
FIRStorageTaskStatusFailure To zdarzenie jest uruchamiane, gdy przesyłanie się nie powiodło. 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 informacje o postępie przesyłania.
error NSError Jeśli podczas przesyłania wystąpił błąd,
metadata FIRStorageMetadata Podczas przesyłania zawiera przesyłane metadane. Po zdarzeniu FIRTaskStatusSuccess zawiera metadane przesłanego pliku.
task FIRStorageUploadTask Zadanie to jest zrzutem dysku, którego można 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 = 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
FIRStorageHandle 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 FIRStorageTaskStatusSuccess lub FIRStorageTaskStatusFailure wszyscy obserwatorzy są usuwani.

Obsługa błędów

Błędy mogą występować przy przesyłaniu 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 dokumentacji w sekcji Obsługa błędów.

Pełny przykład

Pełny przykład przesyłania z monitorowaniem postępu i obsługą błędów znajdziesz poniżej:

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

Dowiedz się, jak pobrać je z Cloud Storage.