Загружайте файлы с помощью Cloud Storage на платформах Apple.

Cloud Storage for Firebase позволяет быстро и легко загружать файлы в корзину Cloud Storage предоставляемую и управляемую Firebase.

Создать ссылку

Чтобы загрузить файл, сначала создайте ссылку на Cloud Storage указывающее на то место в Cloud Storage в которое вы хотите загрузить файл.

Вы можете создать ссылку, добавив дочерние пути в корень вашего сегмента Cloud Storage :

Быстрый 

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

Цель-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

Вы не можете загружать данные со ссылкой на корень вашего сегмента Cloud Storage . Ваша ссылка должна указывать на дочерний URL-адрес.

Загрузить файлы

Получив ссылку, вы можете загружать файлы в Cloud Storage двумя способами:

  1. Загрузка из данных в памяти
  2. Загрузка с URL-адреса, представляющего файл на устройстве.

Загрузка из данных в памяти

Метод putData:metadata:completion: — это самый простой способ загрузить файл в Cloud Storage . putData:metadata:completion: принимает объект NSData и возвращает FIRStorageUploadTask , который вы можете использовать для управления загрузкой и отслеживания ее статуса.

Быстрый 

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

Цель-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;
      }
    }];
  }
}];

Загрузить из локального файла

Вы можете загружать локальные файлы на устройства, например фотографии и видео с камеры, с помощью метода putFile:metadata:completion: :. putFile:metadata:completion: принимает NSURL и возвращает FIRStorageUploadTask , который вы можете использовать для управления загрузкой и отслеживания ее статуса.

Быстрый 

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

Цель-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;
      }
    }];
  }
}];

Если вы хотите активно управлять загрузкой, вы можете использовать методы putData: или putFile: и наблюдать за задачей загрузки, а не использовать обработчик завершения. Дополнительную информацию см. в разделе «Управление загрузками» .

Добавить метаданные файла

Вы также можете включать метаданные при загрузке файлов. Эти метаданные содержат типичные свойства метаданных файла, такие как name , size и contentType (обычно называемый типом MIME). Метод putFile: автоматически определяет тип контента на основе расширения имени файла NSURL , но вы можете переопределить автоматически определенный тип, указав contentType в метаданных. Если вы не указали contentType и Cloud Storage не может определить значение по умолчанию из расширения файла, Cloud Storage использует application/octet-stream . Дополнительную информацию о метаданных файла см. в разделе «Использование метаданных файла» .

Быстрый 

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

Цель-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];

Управление загрузками

Помимо запуска загрузок, вы можете приостанавливать, возобновлять и отменять загрузку, используя методы pause , resume и cancel . Эти методы вызывают события pause , resume и cancel . Отмена загрузки приводит к сбою загрузки с ошибкой, указывающей на то, что загрузка была отменена.

Быстрый 

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

Цель-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];

Отслеживание хода загрузки

Вы можете прикрепить наблюдателей к FIRStorageUploadTask , чтобы отслеживать ход загрузки. Добавление наблюдателя возвращает FIRStorageHandle , который можно использовать для удаления наблюдателя.

Быстрый 

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

Цель-C 

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

Этих наблюдателей можно добавить к событию FIRStorageTaskStatus :

Событие FIRStorageTaskStatus Типичное использование
FIRStorageTaskStatusResume Это событие срабатывает, когда задача запускает или возобновляет отправку, и часто используется вместе с событием FIRStorageTaskStatusPause .
FIRStorageTaskStatusProgress Это событие срабатывает каждый раз, когда данные загружаются в Cloud Storage , и может использоваться для заполнения индикатора хода загрузки.
FIRStorageTaskStatusPause Это событие срабатывает каждый раз, когда загрузка приостанавливается, и часто используется вместе с событием FIRStorageTaskStatusResume .
FIRStorageTaskStatusSuccess Это событие срабатывает, когда загрузка успешно завершена.
FIRStorageTaskStatusFailure Это событие возникает, когда загрузка не удалась. Проверьте ошибку, чтобы определить причину сбоя.

При возникновении события обратно передается объект FIRStorageTaskSnapshot . Этот снимок представляет собой неизменяемое представление задачи на момент возникновения события. Этот объект содержит следующие свойства:

Свойство Тип Описание
progress NSProgress Объект NSProgress , содержащий ход загрузки.
error NSError Ошибка, возникшая во время загрузки, если таковая имеется.
metadata FIRStorageMetadata Во время загрузки содержит загружаемые метаданные. После события FIRTaskStatusSuccess содержит метаданные загруженного файла.
task FIRStorageUploadTask Это снимок задачи, который можно использовать для управления ( pause , resume , cancel ) задачи.
reference FIRStorageReference Ссылка, из которой взята эта задача.

Вы также можете удалить наблюдателей по отдельности, по статусу или удалив их всех.

Быстрый 

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

Цель-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];

Чтобы предотвратить утечку памяти, все наблюдатели удаляются после возникновения FIRStorageTaskStatusSuccess или FIRStorageTaskStatusFailure .

Обработка ошибок

Существует ряд причин, по которым могут возникать ошибки при загрузке, включая отсутствие локального файла или отсутствие у пользователя разрешения на загрузку нужного файла. Дополнительную информацию об ошибках можно найти в разделе «Обработка ошибок» документации.

Полный пример

Полный пример загрузки с контролем хода выполнения и обработкой ошибок показан ниже:

Быстрый 

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

Цель-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;
    }
  }
}];

Теперь, когда вы загрузили файлы, давайте научимся загружать их из Cloud Storage .