Przesyłaj pliki za pomocą Cloud Storage na platformy 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.

Utwórz odniesienie

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ć odniesienie, dołączając ścieżki podrzędne do katalogu głównego zasobnika Cloud Storage:

Szybki

// 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
    

Cel 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 przesyłać danych z odniesieniem do katalogu głównego zasobnika Cloud Storage. Twoje odwołanie musi wskazywać na podrzędny adres URL.

Prześlij pliki

Po uzyskaniu referencji możesz przesyłać pliki do Cloud Storage na dwa sposoby:

  1. Prześlij z danych znajdujących się w pamięci
  2. Prześlij z adresu URL reprezentującego plik na urządzeniu

Prześlij z danych znajdujących się w pamięci

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

Szybki

// 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
    }
  }
}
    

Cel 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

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

Szybki

// 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
    }
  }
}
    

Cel 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ć metod putData: lub putFile: i obserwować zadanie przesyłania, zamiast korzystać z procedury obsługi uzupełniania. Aby uzyskać więcej informacji, zobacz Zarządzanie przesyłaniem .

Dodaj metadane pliku

Przesyłając pliki, możesz także dołączyć metadane. Te metadane zawierają typowe właściwości metadanych pliku, takie jak name , size i contentType (powszechnie określane jako typ MIME). Metoda putFile: automatycznie wnioskuje typ zawartości z rozszerzenia nazwy pliku NSURL , ale można zastąpić typ wykryty automatycznie, określając contentType w metadanych. Jeśli nie podasz contentType i Cloud Storage nie będzie mógł wywnioskować wartości domyślnej z rozszerzenia pliku, Cloud Storage użyje application/octet-stream . Aby uzyskać więcej informacji na temat metadanych plików, zobacz sekcję Użyj metadanych pliku.

Szybki

// 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)
    

Cel 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 . Metody te powodują wywołanie zdarzeń pause , resume i cancel . Anulowanie przesyłania powoduje niepowodzenie przesyłania i wyświetlenie błędu wskazującego, że przesyłanie zostało anulowane.

Szybki

// 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()
    

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

Monitoruj postęp przesyłania

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

Szybki

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

Cel C

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

Tych obserwatorów można dodać do zdarzenia FIRStorageTaskStatus :

Zdarzenie FIRStorageTaskStatus Typowe użycie
FIRStorageTaskStatusResume To zdarzenie jest wywoływane, gdy zadanie rozpoczyna się lub wznawia przesyłanie i jest często używane w połączeniu ze zdarzeniem FIRStorageTaskStatusPause .
FIRStorageTaskStatusProgress To zdarzenie jest uruchamiane za każdym razem, gdy dane są przesyłane do Cloud Storage i może zostać użyte do wypełnienia wskaźnika postępu przesyłania.
FIRStorageTaskStatusPause To zdarzenie jest uruchamiane 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 po pomyślnym zakończeniu przesyłania.
FIRStorageTaskStatusFailure To zdarzenie jest wywoływane, gdy przesyłanie nie powiodło się. Sprawdź błąd, aby określić przyczynę niepowodzenia.

Po wystąpieniu zdarzenia obiekt FIRStorageTaskSnapshot jest przekazywany z powrotem. Ta migawka to niezmienny widok zadania w momencie wystąpienia zdarzenia. Obiekt ten zawiera następujące właściwości:

Nieruchomość Typ Opis
progress NSProgress Obiekt NSProgress zawierający postęp 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 to jest migawką, której można użyć do zarządzania ( pause , resume , cancel ) zadaniem.
reference FIRStorageReference Referencja, z której pochodzi to zadanie.

Możesz także usuwać obserwatorów indywidualnie, według statusu lub usuwając ich wszystkich.

Szybki

// 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()
    

Cel 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, wszyscy obserwatorzy są usuwani po wystąpieniu FIRStorageTaskStatusSuccess lub FIRStorageTaskStatusFailure .

Obsługa błędów

Istnieje wiele powodów, dla których mogą wystąpić błędy podczas przesyłania, na przykład nieistniejący plik lokalny lub brak uprawnień użytkownika do przesłania żądanego pliku. Więcej informacji na temat błędów można znaleźć w sekcji Obsługiwanie błędów w dokumentacji.

Pełny przykład

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

Szybki

// 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
    }
  }
}
    

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

Po przesłaniu plików nauczmy się, jak je pobrać z Cloud Storage.