Web'de Cloud Storage ile dosyaları listeleme

Firebase için Cloud Storage, Cloud Storage paketinizin içeriğini listelemenize olanak tanır. SDK'lar, geçerli Cloud Storage referansı altındaki nesnelerin hem öğelerini hem de öneklerini döndürür.

Liste API'sini kullanan projeler, Firebase Kuralları için Cloud Storage Sürüm 2'yi gerektirir. Mevcut bir Firebase projeniz varsa Güvenlik Kuralları Kılavuzu'ndaki adımları izleyin.

list() Google Bulut Depolama Listesi API'sini kullanır. Firebase için Cloud Storage'da sınırlayıcı olarak / kullanıyoruz, bu da dosya sistemi anlambilimini taklit etmemize olanak tanıyor. List API, büyük, hiyerarşik Cloud Storage paketlerinde verimli bir şekilde geçiş yapılmasına olanak sağlamak için önekleri ve öğeleri ayrı ayrı döndürür. Örneğin, bir dosya /images/uid/file1 yüklerseniz,

• root.child('images').listAll() önek olarak /images/uid döndürür.
• root.child('images/uid').listAll() dosyayı bir öğe olarak döndürecektir.

Firebase SDK için Cloud Storage, ardışık iki / içeren veya /. . Örneğin, aşağıdaki nesneleri içeren bir paket düşünün:

• correctPrefix/happyItem
• wrongPrefix//sadItem
• lonelyItem/

Bu paketteki öğelere ilişkin liste işlemleri aşağıdaki sonuçları verecektir:

• Kökteki liste işlemi, correctPrefix , wrongPrefix ve lonelyItem yapılan başvuruları prefixes olarak döndürür.
• correctPrefix/ deki liste işlemi, correctPrefix/happyItem yapılan başvuruları items olarak döndürür.
• wrongPrefix/ deki liste işlemi herhangi bir başvuru döndürmez çünkü wrongPrefix//sadItem ardışık iki / s içerir.
• lonelyItem/ nesnesindeki liste işlemi herhangi bir başvuru döndürmez çünkü lonelyItem/ nesnesi / ile biter.

Tüm dosyaları listele

Bir dizine ilişkin tüm sonuçları getirmek için listAll kullanabilirsiniz. Tüm sonuçlar bellekte ara belleğe alındığından, bu en iyi şekilde küçük dizinler için kullanılır. İşlem sırasında nesneler eklenir veya kaldırılırsa işlem aynı zamanda tutarlı bir anlık görüntü döndürmeyebilir.

Büyük bir liste için, listAll() tüm sonuçları bellekte ara belleğe aldığından sayfalandırılmış list() yöntemini kullanın.

Aşağıdaki örnekte listAll gösterilmektedir.

import { getStorage, ref, listAll } from "firebase/storage";

const storage = getStorage();

// Create a reference under which you want to list
const listRef = ref(storage, 'files/uid');

// Find all the prefixes and items.
listAll(listRef)
  .then((res) => {
    res.prefixes.forEach((folderRef) => {
      // All the prefixes under listRef.
      // You may call listAll() recursively on them.
    });
    res.items.forEach((itemRef) => {
      // All the items under listRef.
    });
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_list_all.js

// Create a reference under which you want to list
var listRef = storageRef.child('files/uid');

// Find all the prefixes and items.
listRef.listAll()
  .then((res) => {
    res.prefixes.forEach((folderRef) => {
      // All the prefixes under listRef.
      // You may call listAll() recursively on them.
    });
    res.items.forEach((itemRef) => {
      // All the items under listRef.
    });
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
list-files.js

Liste sonuçlarını sayfalara ayır

list() API'si, döndürdüğü sonuç sayısına bir sınır koyar. list() tutarlı bir sayfa görünümü sağlar ve ek sonuçların ne zaman getirileceği konusunda kontrole izin veren bir pageToken sunar.

pageToken, önceki sonuçta döndürülen son öğenin yolunu ve sürümünü kodlar. pageToken kullanılarak yapılan sonraki bir istekte, pageToken'dan sonra gelen öğeler gösterilir.

Aşağıdaki örnek, async/await kullanılarak bir sonucun sayfalandırılmasını gösterir.

import { getStorage, ref, list } from "firebase/storage";

async function pageTokenExample(){
  // Create a reference under which you want to list
  const storage = getStorage();
  const listRef = ref(storage, 'files/uid');

  // Fetch the first page of 100.
  const firstPage = await list(listRef, { maxResults: 100 });

  // Use the result.
  // processItems(firstPage.items)
  // processPrefixes(firstPage.prefixes)

  // Fetch the second page if there are more elements.
  if (firstPage.nextPageToken) {
    const secondPage = await list(listRef, {
      maxResults: 100,
      pageToken: firstPage.nextPageToken,
    });
    // processItems(secondPage.items)
    // processPrefixes(secondPage.prefixes)
  }
}
storage_list_paginate.js

async function pageTokenExample(){
  // Create a reference under which you want to list
  var listRef = storageRef.child('files/uid');

  // Fetch the first page of 100.
  var firstPage = await listRef.list({ maxResults: 100});

  // Use the result.
  // processItems(firstPage.items)
  // processPrefixes(firstPage.prefixes)

  // Fetch the second page if there are more elements.
  if (firstPage.nextPageToken) {
    var secondPage = await listRef.list({
      maxResults: 100,
      pageToken: firstPage.nextPageToken,
    });
    // processItems(secondPage.items)
    // processPrefixes(secondPage.prefixes)
  }
}
list-files.js

Hataları işleme

list() ve listAll() Güvenlik Kurallarını sürüm 2'ye yükseltmediyseniz reddedilen bir Sözü döndürür. Bu hatayı görürseniz Güvenlik Kurallarınızı yükseltin:

Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.

Diğer olası hatalar kullanıcının doğru izne sahip olmadığını gösterebilir. Hatalarla ilgili daha fazla bilgiyi Hataları İşleme bölümünde bulabilirsiniz.