Web'de Cloud Storage ile dosyaları listeleme

Cloud Storage for Firebase, Cloud Storage paketinizin içeriğini listelemenize olanak tanır. SDK'lar, öğeleri ve geçerli Cloud Storage referansı altındaki nesnelerin ön eklerini döndürür.

List API'yi kullanan projeler için Cloud Storage for Firebase Kurallar Sürümü 2 gerekir. Mevcut bir Firebase projeniz varsa Güvenlik Kuralları Kılavuzu'ndaki adımları uygulayın.

list(), Google Cloud Storage List API'yi kullanır. Cloud Storage for Firebase içinde, dosya sistemi semantiğini taklit etmemize olanak tanıyan bir sınırlayıcı olarak / kullanılır. List API, büyük ve hiyerarşik Cloud Storage paketlerin verimli bir şekilde geçilmesine olanak tanımak için ön ekleri ve öğeleri ayrı ayrı döndürür. Örneğin, bir dosya yüklerseniz /images/uid/file1,

  • root.child('images').listAll(), /images/uid değerini ön ek olarak döndürür.
  • root.child('images/uid').listAll(), dosyayı öğe olarak döndürür.

Cloud Storage for Firebase SDK'sı, art arda iki / içeren veya /. ile biten nesne yollarını döndürmez. Örneğin, aşağıdaki nesneleri içeren bir paketi ele alalım:

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

Bu paketteki öğeler üzerinde yapılan liste işlemleri aşağıdaki sonuçları verir:

  • Kök dizindeki liste işlemi, correctPrefix, wrongPrefix ve lonelyItem referanslarını prefixes olarak döndürür.
  • correctPrefix/ konumundaki liste işlemi, correctPrefix/happyItem öğesine yapılan referansları items olarak döndürür.
  • wrongPrefix/ konumundaki liste işlemi, wrongPrefix//sadItem iki ardışık / içerdiğinden herhangi bir referans döndürmüyor.
  • lonelyItem/ konumundaki liste işlemi, lonelyItem/ nesnesi / ile bittiği için herhangi bir referans döndürmüyor.

Tüm dosyaları listeleme

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

Büyük bir liste için, list() yöntemi tüm sonuçları bellekte arabelleğe aldığından listAll() yöntemini kullanın.

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

Web

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

Web

// 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ı sayfalandırma

list() API, döndürdüğü sonuç sayısını sınırlar. list() tutarlı bir sayfa görüntüleme sağlar ve ek sonuçların ne zaman getirileceğini kontrol etmeye olanak tanıyan bir pageToken gösterir.

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 örnekte, async/await kullanılarak bir sonucun nasıl sayfalandırılacağı gösterilmektedir.

Web

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

Web

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

Güvenlik kurallarını 2. sürüme yükseltmediyseniz list() ve listAll() reddedilen bir Promise döndürür. Bu hatayı görüyorsanız 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. Hatalar hakkında daha fazla bilgiyi Hataları İşleme bölümünde bulabilirsiniz.