Apple platformlarında Cloud Storage ile dosya yükleme

Cloud Storage for Firebase, Firebase tarafından sağlanan ve yönetilen bir Cloud Storage paketine hızlı ve kolay bir şekilde dosya yüklemenize olanak tanır.

Referans Oluşturma

Dosya yüklemek için önce Cloud Storage içinde dosyayı yüklemek istediğiniz konuma bir Cloud Storage referansı oluşturun.

Cloud Storage paketinizin köküne alt yollar ekleyerek referans oluşturabilirsiniz:

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

Cloud Storage paketinizin köküne referans içeren verileri yükleyemezsiniz. Referansınız bir alt URL'ye yönlendirmelidir.

Dosya Yükle

Referans oluşturduktan sonra Cloud Storage adresine iki şekilde dosya yükleyebilirsiniz:

  1. Bellekteki verilerden yükle
  2. Cihazdaki bir dosyayı temsil eden URL'den yükleme

Bellekteki verilerden yükle

putData:metadata:completion: yöntemi, Cloud Storage hizmetine dosya yüklemenin en basit yoludur. putData:metadata:completion:, bir NSData nesnesi alır ve yüklemenizi yönetmek ve durumunu izlemek için kullanabileceğiniz bir FIRStorageUploadTask döndürür.

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

Yerel bir dosyadan yükleme

putFile:metadata:completion: yöntemini kullanarak cihazlardaki yerel dosyaları (ör. kameradaki fotoğraf ve videolar) yükleyebilirsiniz. putFile:metadata:completion:, bir NSURL alır ve yüklemenizi yönetmek ve durumunu izlemek için kullanabileceğiniz bir FIRStorageUploadTask döndürür.

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

Yüklemenizi etkin bir şekilde yönetmek istiyorsanız tamamlama işleyicisini kullanmak yerine putData: veya putFile: yöntemlerini kullanabilir ve yükleme görevini gözlemleyebilirsiniz. Daha fazla bilgi için Yüklemeleri yönetme başlıklı makaleyi inceleyin.

Dosya Meta Verileri Ekleme

Dosya yüklerken meta verileri de ekleyebilirsiniz. Bu meta veriler, name, size ve contentType (genellikle MIME türü olarak adlandırılır) gibi tipik dosya meta veri özelliklerini içerir. putFile: yöntemi, içerik türünü NSURL dosya adı uzantısından otomatik olarak çıkarır ancak meta verilerde contentType değerini belirterek otomatik olarak algılanan türü geçersiz kılabilirsiniz. contentType sağlamazsanız ve Cloud Storage dosya uzantısından varsayılan bir değer çıkaramazsa Cloud Storage, application/octet-stream kullanır. Dosya meta verileri hakkında daha fazla bilgi için Dosya Meta Verilerini Kullanma bölümüne bakın.

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

Yüklemeleri Yönet

Yükleme başlatmanın yanı sıra pause, resume ve cancel yöntemlerini kullanarak yüklemeleri duraklatabilir, devam ettirebilir ve iptal edebilirsiniz. Bu yöntemler pause, resume ve cancel etkinliklerini tetikler. Yükleme işleminin iptal edilmesi, yüklemenin iptal edildiğini belirten bir hatayla yüklemenin başarısız olmasına neden olur.

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

Yükleme durumunu izleme

Yükleme işleminin ilerleme durumunu izlemek için FIRStorageUploadTask nesnelerine gözlemciler ekleyebilirsiniz. Gözlemci ekleme işlemi, gözlemciyi kaldırmak için kullanılabilecek bir FIRStorageHandle döndürür.

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

Bu gözlemciler bir FIRStorageTaskStatus etkinliğine eklenebilir:

FIRStorageTaskStatus Etkinlik Tipik Kullanım
FIRStorageTaskStatusResume Bu etkinlik, görev yüklemeye başladığında veya yüklemeye devam ettiğinde tetiklenir ve genellikle FIRStorageTaskStatusPause etkinliğiyle birlikte kullanılır.
FIRStorageTaskStatusProgress Bu etkinlik, veriler Cloud Storage hizmetine yüklenirken tetiklenir ve yükleme ilerleme durumu göstergesini doldurmak için kullanılabilir.
FIRStorageTaskStatusPause Bu etkinlik, yükleme duraklatıldığında tetiklenir ve genellikle FIRStorageTaskStatusResume etkinliğiyle birlikte kullanılır.
FIRStorageTaskStatusSuccess Bu etkinlik, yükleme başarıyla tamamlandığında tetiklenir.
FIRStorageTaskStatusFailure Bu etkinlik, yükleme başarısız olduğunda tetiklenir. Hatanın nedenini belirlemek için hatayı inceleyin.

Bir etkinlik gerçekleştiğinde bir FIRStorageTaskSnapshot nesnesi döndürülür. Bu anlık görüntü, etkinliğin gerçekleştiği anda görevin değişmez bir görünümüdür. Bu nesne aşağıdaki özellikleri içerir:

Özellik Tür Açıklama
progress NSProgress Yükleme işleminin ilerleme durumunu içeren bir NSProgress nesnesi.
error NSError Yükleme sırasında oluşan hata (varsa).
metadata FIRStorageMetadata "Yükleme sırasında" durumu, yüklenmekte olan meta verileri içerir. FIRTaskStatusSuccess etkinliğinden sonra, yüklenen dosyanın meta verilerini içerir.
task FIRStorageUploadTask Bu anlık görüntünün ait olduğu görev. Görevi yönetmek (pause, resume, cancel) için kullanılabilir.
reference FIRStorageReference Bu görevin geldiği referans.

Gözlemcileri tek tek, duruma göre veya tümünü kaldırarak da silebilirsiniz.

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

Bellek sızıntılarını önlemek için FIRStorageTaskStatusSuccess veya FIRStorageTaskStatusFailure gerçekleştikten sonra tüm gözlemciler kaldırılır.

Hata İşleme

Yükleme sırasında hata oluşmasının çeşitli nedenleri vardır. Örneğin, yerel dosyanın mevcut olmaması veya kullanıcının istenen dosyayı yükleme izninin olmaması. Hatalar hakkında daha fazla bilgiyi belgelerin Hataları İşleme bölümünde bulabilirsiniz.

Tam Örnek

İlerleme durumu izleme ve hata işleme ile yükleme işleminin tam bir örneği aşağıda gösterilmiştir:

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

Dosyaları yüklediğinize göre, şimdi de Cloud Storage üzerinden dosya indirmeyi öğrenelim.