استفاده از فراداده فایل با Cloud Storage در Flutter

پس‌از بارگذاری فایل در مرجع Cloud Storage، می‌توانید فراداده فایل را نیز دریافت و به‌روز کنید، برای مثال برای مشاهده یا به‌روزرسانی نوع محتوا. فایل‌ها همچنین می‌توانند جفت‌های کلید/مقدار سفارشی را با فراداده‌های فایل اضافی ذخیره کنند.

دریافت فراداده فایل

فراداده فایل حاوی ویژگی‌های رایجی مثل name، size، و contentType (که اغلب نوع MIME نامیده می‌شود) و همچنین برخی ویژگی‌های کمتر رایج مثل contentDisposition و timeCreated است. این فراداده را می‌توان بااستفاده از روش getMetadata() از مرجع Cloud Storage بازیابی کرد.

// Create reference to the file whose metadata we want to retrieve
final forestRef = storageRef.child("images/forest.jpg");

// Get metadata properties
final metadata = await forestRef.getMetadata();

// Metadata now contains the metadata for 'images/forest.jpg'

به‌روزرسانی فراداده فایل

هرزمان که بخواهید می‌توانید فراداده فایل را پس‌از تکمیل بارگذاری فایل بااستفاده از روش updateMetadata() به‌روز کنید. برای اطلاعات بیشتر درباره اینکه کدام ویژگی‌ها را می‌توان به‌روز کرد، به فهرست کامل مراجعه کنید. فقط ویژگی‌های مشخص‌شده در فراداده به‌روز می‌شوند، بقیه بدون تغییر باقی می‌مانند.

// Create reference to the file whose metadata we want to change
final forestRef = storageRef.child("images/forest.jpg");

// Create file metadata to update
final newMetadata = SettableMetadata(
  cacheControl: "public,max-age=300",
  contentType: "image/jpeg",
);

// Update metadata properties
final metadata = await forestRef.updateMetadata(newMetadata);

// Updated metadata for 'images/forest.jpg' is returned

می‌توانید با ارسال null، ویژگی‌های فراداده قابل‌نوشتن را حذف کنید:

// Delete the cacheControl property
final newMetadata = SettableMetadata(cacheControl: null);
final metadata = await forestRef.updateMetadata(newMetadata);

مدیریت کردن خطاها

دلایل متعددی برای بروز خطا هنگام دریافت یا به‌روزرسانی فراداده وجود دارد، ازجمله عدم وجود فایل یا نداشتن اجازه دسترسی کاربر به فایل موردنظر. اطلاعات بیشتر درباره خطاها را می‌توانید در بخش رسیدگی به خطاها در اسناد پیدا کنید.

فراداده سفارشی

بااستفاده از پارامتر customMetadata از سازنده SettableMetadata می‌توانید فراداده سفارشی را مشخص کنید:

// Create reference to the file whose metadata we want to change
final forestRef = storageRef.child("images/forest.jpg");

// Create file metadata to update
final newCustomMetadata = SettableMetadata(
  customMetadata: {
    "location": "Yosemite, CA, USA",
    "activity": "Hiking",
  },
);

// Update metadata properties
final metadata = await forestRef.updateMetadata(newCustomMetadata);

// Updated metadata for 'images/forest.jpg' is returned

می‌توانید داده‌های مختص برنامه را برای هر فایل در فراداده سفارشی ذخیره کنید، اما اکیداً توصیه می‌کنیم از پایگاه داده (مانند پایگاه داده بی‌درنگ Firebase) برای ذخیره و همگام‌سازی این نوع داده‌ها استفاده کنید.

ویژگی‌های فراداده فایل

فهرست کامل ویژگی‌های فراداده در فایل در زیر دردسترس است:

بارگذاری، بارگیری، و به‌روزرسانی فایل‌ها مهم است، اما توانایی برداشتن آن‌ها نیز مهم است. بیایید با نحوه حذف فایل‌ها از Cloud Storage آشنا شویم.