คุณสามารถทริกเกอร์ฟังก์ชันเพื่อตอบสนองต่อการอัปโหลด การอัปเดต หรือการลบไฟล์และโฟลเดอร์ใน Cloud Storage ได้
ตัวอย่างในหน้านี้อิงตามฟังก์ชันตัวอย่างที่ทริกเกอร์เมื่ออัปโหลดไฟล์ภาพไปยัง Cloud Storage ฟังก์ชันตัวอย่างนี้สาธิตวิธีเข้าถึงแอตทริบิวต์เหตุการณ์ วิธีดาวน์โหลดไฟล์ไปยังอินสแตนซ์ Cloud Functions และพื้นฐานอื่นๆ ในการจัดการเหตุการณ์ Cloud Storage
นำเข้าโมดูลที่จำเป็น
ในการเริ่มต้นใช้งาน ให้นำเข้าโมดูลที่จำเป็นสำหรับการจัดการเหตุการณ์ Cloud Storage ดังนี้
Node.js
const {onObjectFinalized} = require("firebase-functions/storage");
Python
from firebase_functions import storage_fn
หากต้องการสร้างตัวอย่างแบบเต็ม ให้เพิ่มทรัพยากร Dependency สำหรับ Firebase Admin SDK และเครื่องมือประมวลผลรูปภาพด้วย โดยทำดังนี้
Node.js
const {initializeApp} = require("firebase-admin/app");
const {getStorage} = require("firebase-admin/storage");
const logger = require("firebase-functions/logger");
const path = require("path");
// library for image resizing
const sharp = /** @type {typeof import("sharp")} */ (require("sharp"));
initializeApp();
Python
import io
import pathlib
from PIL import Image
from firebase_admin import initialize_app
initialize_app()
from firebase_admin import storage
กำหนดขอบเขตฟังก์ชัน Cloud Storage
ใช้รูปแบบต่อไปนี้เพื่อกำหนดขอบเขตฟังก์ชันของคุณไปยังบักเก็ต Cloud Storage ที่เฉพาะเจาะจง และตั้งค่าตัวเลือกที่ต้องการ
Node.js
// scope handler to a specific bucket, using storage options parameter
exports.archivedopts = onObjectArchived({ bucket: "myBucket" }, (event) => {
//…
});
Python
# Scope handler to a specific bucket using storage options parameter
@storage_fn.on_object_archived(bucket="myBucket")
def archived_bucket(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
# ...
ในทางตรงกันข้าม ฟังก์ชันตัวสร้างภาพขนาดย่อตัวอย่างจะกำหนดขอบเขตเป็นที่เก็บข้อมูลเริ่มต้นสำหรับโปรเจ็กต์
Node.js
exports.generateThumbnail = onObjectFinalized({cpu: 2}, async (event) => { // ... });
Python
@storage_fn.on_object_archived()
def generatethumbnail(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
# ...
ตั้งค่าตำแหน่งของฟังก์ชัน
ตำแหน่งที่ไม่ตรงกันอาจส่งผลให้การติดตั้งใช้งานล้มเหลว นอกจากนี้ ระยะห่างระหว่างตำแหน่งของที่เก็บข้อมูล Cloud Storage และตำแหน่งของฟังก์ชันอาจทำให้เกิดเวลาในการตอบสนองของเครือข่ายที่นานขึ้นอย่างมาก หากต้องการหลีกเลี่ยงสถานการณ์เหล่านี้ ให้ระบุตำแหน่งของฟังก์ชันให้ตรงกับตำแหน่งของที่เก็บข้อมูล/ทริกเกอร์ด้วยวิธีใดวิธีหนึ่งต่อไปนี้
- ตำแหน่งของฟังก์ชันเหมือนกับตำแหน่งของทริกเกอร์
- ตำแหน่งของฟังก์ชันอยู่ภายในตำแหน่งของทริกเกอร์ (เมื่อภูมิภาคของทริกเกอร์เป็นแบบ 2 ภูมิภาค/หลายภูมิภาค)
- ฟังก์ชันอาจอยู่ในตำแหน่งใดก็ได้หากตั้งค่าภูมิภาคทริกเกอร์เป็น
us-central1
จัดการเหตุการณ์ Cloud Storage รายการ
ตัวแฮนเดิลต่อไปนี้พร้อมใช้งานสำหรับการตอบสนองต่อเหตุการณ์ Cloud Storage
Node.js
onObjectArchivedส่งเมื่อ Bucket ได้เปิดใช้การกำหนดเวอร์ชันออบเจ็กต์เท่านั้น เหตุการณ์นี้บ่งชี้ว่าออบเจ็กต์เวอร์ชันที่ใช้งานจริงได้กลายเป็นเวอร์ชันที่เก็บถาวรแล้ว เนื่องจากมีการเก็บถาวรหรือถูกเขียนทับโดยการอัปโหลดออบเจ็กต์ที่มีชื่อเดียวกันonObjectDeletedส่งเมื่อลบออบเจ็กต์อย่างถาวรแล้ว ซึ่งรวมถึงออบเจ็กต์ที่ถูกเขียนทับหรือลบจากส่วนหนึ่งของการกำหนดค่าอายุการใช้งานของ Bucket สำหรับ Bucket ที่เปิดใช้การกำหนดเวอร์ชันออบเจ็กต์ ระบบจะไม่ส่งเหตุการณ์นี้เมื่อมีการเก็บออบเจ็กต์ถาวร (ดูonArchive) แม้ว่าการเก็บถาวรจะเกิดขึ้นผ่านเมธอดstorage.objects.deleteก็ตามonObjectFinalizedส่งเมื่อมีการสร้างออบเจ็กต์ใหม่ (หรือรุ่นใหม่ของออบเจ็กต์ที่มีอยู่) ใน Bucket เรียบร้อยแล้ว ซึ่งรวมถึงการคัดลอกหรือเขียนออบเจ็กต์ที่มีอยู่ใหม่ การอัปโหลดที่ล้มเหลวจะไม่ทริกเกอร์เหตุการณ์นี้onMetadataUpdatedส่งเมื่อข้อมูลเมตาของออบเจ็กต์ที่มีอยู่มีการเปลี่ยนแปลง
Python
on_object_archivedส่งเมื่อ Bucket ได้เปิดใช้การกำหนดเวอร์ชันออบเจ็กต์เท่านั้น เหตุการณ์นี้บ่งชี้ว่าออบเจ็กต์เวอร์ชันที่ใช้งานจริงได้กลายเป็นเวอร์ชันที่เก็บถาวรแล้ว เนื่องจากมีการเก็บถาวรหรือถูกเขียนทับโดยการอัปโหลดออบเจ็กต์ที่มีชื่อเดียวกันon_object_deletedส่งเมื่อลบออบเจ็กต์อย่างถาวรแล้ว ซึ่งรวมถึงออบเจ็กต์ที่ถูกเขียนทับหรือลบจากส่วนหนึ่งของการกำหนดค่าอายุการใช้งานของ Bucket สำหรับ Bucket ที่เปิดใช้การกำหนดเวอร์ชันออบเจ็กต์ ระบบจะไม่ส่งเหตุการณ์นี้เมื่อมีการเก็บออบเจ็กต์ถาวร (ดูonArchive) แม้ว่าการเก็บถาวรจะเกิดขึ้นผ่านเมธอดstorage.objects.deleteก็ตามon_object_finalizedส่งเมื่อมีการสร้างออบเจ็กต์ใหม่ (หรือรุ่นใหม่ของออบเจ็กต์ที่มีอยู่) ใน Bucket เรียบร้อยแล้ว ซึ่งรวมถึงการคัดลอกหรือเขียนออบเจ็กต์ที่มีอยู่ใหม่ การอัปโหลดที่ล้มเหลวจะไม่ทริกเกอร์เหตุการณ์นี้on_metadata_updatedส่งเมื่อข้อมูลเมตาของออบเจ็กต์ที่มีอยู่มีการเปลี่ยนแปลง
เข้าถึงแอตทริบิวต์ออบเจ็กต์ Cloud Storage
Cloud Functions แสดงแอตทริบิวต์ออบเจ็กต์ Cloud Storage จำนวนหนึ่ง เช่น ขนาดของออบเจ็กต์และประเภทเนื้อหาสำหรับไฟล์ที่อัปเดต แอตทริบิวต์ metageneration จะเพิ่มขึ้นทุกครั้งที่มีการเปลี่ยนแปลงข้อมูลเมตาของออบเจ็กต์ สำหรับออบเจ็กต์ใหม่ ค่า metageneration คือ 1
Node.js
const fileBucket = event.data.bucket; // Storage bucket containing the file. const filePath = event.data.name; // File path in the bucket. const contentType = event.data.contentType; // File content type.
Python
bucket_name = event.data.bucket
file_path = pathlib.PurePath(event.data.name)
content_type = event.data.content_type
ตัวอย่างการสร้างภาพขนาดย่อใช้แอตทริบิวต์เหล่านี้บางส่วนเพื่อตรวจหากรณีการออกซึ่งฟังก์ชันจะแสดงผลดังนี้
Node.js
// Exit if this is triggered on a file that is not an image. if (!contentType.startsWith("image/")) { return logger.log("This is not an image."); } // Exit if the image is already a thumbnail. const fileName = path.basename(filePath); if (fileName.startsWith("thumb_")) { return logger.log("Already a Thumbnail."); }
Python
# Exit if this is triggered on a file that is not an image.
if not content_type or not content_type.startswith("image/"):
print(f"This is not an image. ({content_type})")
return
# Exit if the image is already a thumbnail.
if file_path.name.startswith("thumb_"):
print("Already a thumbnail.")
return
ดาวน์โหลด แปลง และอัปโหลดไฟล์
ในบางกรณี คุณอาจไม่จำเป็นต้องดาวน์โหลดไฟล์จาก Cloud Storage อย่างไรก็ตาม หากต้องการทำงานที่ต้องใช้ทรัพยากรมาก เช่น การสร้างภาพขนาดย่อจากไฟล์ที่จัดเก็บไว้ใน Cloud Storage คุณต้องดาวน์โหลดไฟล์ไปยังอินสแตนซ์ของฟังก์ชัน ซึ่งก็คือเครื่องเสมือนที่เรียกใช้โค้ดของคุณ
การใช้ Cloud Functions ร่วมกับโปรแกรมประมวลผลรูปภาพ เช่น sharp สำหรับ Node.js และ Pillow สำหรับ Python จะช่วยให้คุณจัดการไฟล์ภาพกราฟิกได้ ตัวอย่างต่อไปนี้แสดงวิธีสร้างภาพขนาดย่อสำหรับไฟล์ภาพที่อัปโหลด
Node.js
/**
* When an image is uploaded in the Storage bucket,
* generate a thumbnail automatically using sharp.
*/
exports.generateThumbnail = onObjectFinalized({cpu: 2}, async (event) => {
const fileBucket = event.data.bucket; // Storage bucket containing the file.
const filePath = event.data.name; // File path in the bucket.
const contentType = event.data.contentType; // File content type.
// Exit if this is triggered on a file that is not an image.
if (!contentType.startsWith("image/")) {
return logger.log("This is not an image.");
}
// Exit if the image is already a thumbnail.
const fileName = path.basename(filePath);
if (fileName.startsWith("thumb_")) {
return logger.log("Already a Thumbnail.");
}
// Download file into memory from bucket.
const bucket = getStorage().bucket(fileBucket);
const downloadResponse = await bucket.file(filePath).download();
const imageBuffer = downloadResponse[0];
logger.log("Image downloaded!");
// Generate a thumbnail using sharp.
const thumbnailBuffer = await sharp(imageBuffer).resize({
width: 200,
height: 200,
withoutEnlargement: true,
}).toBuffer();
logger.log("Thumbnail created");
// Prefix 'thumb_' to file name.
const thumbFileName = `thumb_${fileName}`;
const thumbFilePath = path.join(path.dirname(filePath), thumbFileName);
// Upload the thumbnail.
const metadata = {contentType: contentType};
await bucket.file(thumbFilePath).save(thumbnailBuffer, {
metadata: metadata,
});
return logger.log("Thumbnail uploaded!");
});
ดาวน์โหลดไฟล์ไปยังไดเรกทอรีชั่วคราวในอินสแตนซ์ Cloud Functions ในตำแหน่งนี้ คุณสามารถประมวลผลไฟล์ตามต้องการ แล้วอัปโหลดไปยัง Cloud Storage เมื่อทำงานแบบอะซิงโครนัส โปรดตรวจสอบว่าคุณได้แสดงผล JavaScript Promise ใน Callback
Python
@storage_fn.on_object_finalized()
def generatethumbnail(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
"""When an image is uploaded in the Storage bucket, generate a thumbnail
automatically using Pillow."""
bucket_name = event.data.bucket
file_path = pathlib.PurePath(event.data.name)
content_type = event.data.content_type
# Exit if this is triggered on a file that is not an image.
if not content_type or not content_type.startswith("image/"):
print(f"This is not an image. ({content_type})")
return
# Exit if the image is already a thumbnail.
if file_path.name.startswith("thumb_"):
print("Already a thumbnail.")
return
bucket = storage.bucket(bucket_name)
image_blob = bucket.blob(str(file_path))
image_bytes = image_blob.download_as_bytes()
image = Image.open(io.BytesIO(image_bytes))
image.thumbnail((200, 200))
thumbnail_io = io.BytesIO()
image.save(thumbnail_io, format="png")
thumbnail_path = file_path.parent / pathlib.PurePath(f"thumb_{file_path.stem}.png")
thumbnail_blob = bucket.blob(str(thumbnail_path))
thumbnail_blob.upload_from_string(thumbnail_io.getvalue(), content_type="image/png")
โค้ดนี้จะสร้างภาพขนาดย่อขนาด 200x200 สำหรับรูปภาพที่บันทึกไว้ในไดเรกทอรีชั่วคราว แล้วอัปโหลดกลับไปยัง Cloud Storage