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

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

Примечание: По умолчанию для выполнения любых действий с данными или файлами в хранилище Cloud Storage for Firebase требуется Firebase Authentication . Вы можете изменить Firebase Security Rules для Cloud Storage , чтобы разрешить неаутентифицированный доступ в определенных ситуациях . Однако в большинстве случаев мы настоятельно рекомендуем ограничить доступ и настроить надежные правила безопасности (особенно для приложений, используемых в производственной среде). Обратите внимание, что если вы используете Google App Engine и у вас есть хранилище Cloud Storage по умолчанию с именем в формате [укажите формат имени], это может быть связано с использованием [укажите формат имени]. *.appspot.com вам, возможно, потребуется учесть, как ваши правила безопасности влияют на доступ к файлам App Engine .

Примечание: Для проектов, использующих тарифный план Spark, Firebase блокирует загрузку и размещение определенных типов исполняемых файлов для Windows (файлы с расширениями .exe , .dll и .bat ), Android ( .apk ) и Apple ( .ipa ) через Cloud Storage for Firebase и Firebase Hosting . Эта политика существует для предотвращения злоупотреблений на нашей платформе. Проекты, использующие тарифный план Blaze, не затрагиваются. Для получения дополнительной информации см. этот раздел часто задаваемых вопросов .

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

Для загрузки файла сначала создайте 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
    

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
  

Вы не можете загружать данные, ссылаясь на корневой каталог вашего 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
    }
  }
}
    

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

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

С помощью метода 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
    }
  }
}
    

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

Если вы хотите активно управлять загрузкой, вы можете использовать методы 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)
    

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

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

Помимо начала загрузки, вы можете приостанавливать, возобновлять и отменять загрузку, используя методы 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()
    

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

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

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

Быстрый

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

Эти наблюдатели могут быть добавлены к событию 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()
    

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

Для предотвращения утечек памяти все наблюдатели удаляются после возникновения состояния 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
    }
  }
}
    

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

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