Cloud Storage for Firebase ช่วยให้คุณอัปโหลดไฟล์ไปยังที่เก็บข้อมูล Cloud Storage ที่ Firebase มีให้และจัดการได้อย่างรวดเร็วและง่ายดาย
สร้างการอ้างอิง
หากต้องการอัปโหลดไฟล์ ก่อนอื่น ให้สร้างการอ้างอิง Cloud Storage ไปยังตำแหน่งใน Cloud Storage ที่ต้องการอัปโหลดไฟล์
คุณสร้างข้อมูลอ้างอิงได้โดยเพิ่มเส้นทางย่อยต่อท้ายรูทของที่เก็บข้อมูล Cloud Storage ดังนี้
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 การอ้างอิงต้องชี้ไปยัง URL ย่อย
อัปโหลดไฟล์
เมื่อมีคําแนะนําแล้ว คุณจะอัปโหลดไฟล์ไปยัง Cloud Storage ได้ 2 วิธีดังนี้
- อัปโหลดจากข้อมูลในหน่วยความจำ
- อัปโหลดจาก URL ที่แสดงไฟล์ในอุปกรณ์
อัปโหลดจากข้อมูลในหน่วยความจำ
วิธี putData:metadata:completion:
เป็นวิธีที่ง่ายที่สุดในการอัปโหลดไฟล์ไปยัง Cloud Storage putData:metadata:completion:
จะรับออบเจ็กต์ NSData และแสดงผล FIRStorageUploadTask
ซึ่งคุณใช้เพื่อจัดการการอัปโหลดและตรวจสอบสถานะได้
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; } }]; } }];
อัปโหลดจากไฟล์ในเครื่อง
คุณสามารถอัปโหลดไฟล์ในเครื่อง เช่น รูปภาพและวิดีโอจากกล้อง ด้วยวิธี putFile:metadata:completion:
putFile:metadata:completion:
จะรับ NSURL
และแสดงผล FIRStorageUploadTask
ซึ่งคุณใช้เพื่อจัดการการอัปโหลดและตรวจสอบสถานะการอัปโหลดได้
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; } }]; } }];
หากต้องการจัดการการอัปโหลดอย่างสม่ำเสมอ คุณสามารถใช้เมธอด putData:
หรือ putFile:
และตรวจสอบงานอัปโหลดแทนการใช้ตัวแฮนเดิลการเสร็จสมบูรณ์ ดูข้อมูลเพิ่มเติมได้ที่จัดการการอัปโหลด
เพิ่มข้อมูลเมตาของไฟล์
นอกจากนี้ คุณยังใส่ข้อมูลเมตาเมื่ออัปโหลดไฟล์ได้ด้วย
ข้อมูลเมตานี้มีพร็อพเพอร์ตี้ข้อมูลเมตาของไฟล์ทั่วไป เช่น name
, size
และ contentType
(โดยทั่วไปเรียกว่าประเภท MIME) เมธอด putFile:
จะอนุมานประเภทเนื้อหาโดยอัตโนมัติจากส่วนขยายชื่อไฟล์ NSURL
แต่คุณสามารถลบล้างประเภทที่ตรวจพบโดยอัตโนมัติได้โดยระบุ contentType
ในข้อมูลเมตา หากคุณไม่ได้ระบุ contentType
และ Cloud Storage ไม่สามารถอนุมานค่าเริ่มต้นจากนามสกุลไฟล์ Cloud Storage จะใช้ application/octet-stream
ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อมูลเมตาของไฟล์ได้ในส่วนใช้ข้อมูลเมตาของไฟล์
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];
จัดการการอัปโหลด
นอกจากการเริ่มอัปโหลดแล้ว คุณยังหยุดชั่วคราว เล่นต่อ และยกเลิกการอัปโหลดได้โดยใช้ปุ่ม pause
, resume
และ cancel
วิธีการเหล่านี้จะเพิ่มเหตุการณ์ pause
,
resume
และ cancel
การยกเลิกการอัปโหลดจะทำให้การอัปโหลดไม่สำเร็จ โดยมีข้อผิดพลาดที่ระบุว่าการอัปโหลดถูกยกเลิก
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];
ติดตามความคืบหน้าในการอัปโหลด
คุณสามารถแนบผู้สังเกตการณ์กับFIRStorageUploadTask
เพื่อติดตามความคืบหน้าของการอัปโหลดได้ การเพิ่มผู้สังเกตการณ์จะแสดงผล FIRStorageHandle
ซึ่งสามารถใช้เพื่อนำผู้สังเกตการณ์ออก
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 FIRStorageHandle observer = [uploadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) { // A progress event occurred }];
คุณเพิ่มผู้สังเกตการณ์เหล่านี้ลงในเหตุการณ์ FIRStorageTaskStatus
ได้
FIRStorageTaskStatus เหตุการณ์ |
การใช้งานทั่วไป |
---|---|
FIRStorageTaskStatusResume |
เหตุการณ์นี้จะทริกเกอร์เมื่องานเริ่มหรืออัปโหลดต่อ และมักใช้ร่วมกับเหตุการณ์ FIRStorageTaskStatusPause |
FIRStorageTaskStatusProgress |
เหตุการณ์นี้จะทริกเกอร์ทุกครั้งที่มีการส่งข้อมูลไปยัง Cloud Storage และสามารถใช้เพื่อแสดงตัวบ่งชี้ความคืบหน้าในการอัปโหลด |
FIRStorageTaskStatusPause |
เหตุการณ์นี้จะทริกเกอร์ทุกครั้งที่มีการหยุดการอัปโหลดชั่วคราว และมักใช้ร่วมกับเหตุการณ์ FIRStorageTaskStatusResume |
FIRStorageTaskStatusSuccess |
เหตุการณ์นี้จะทริกเกอร์เมื่อการอัปโหลดเสร็จสมบูรณ์ |
FIRStorageTaskStatusFailure |
เหตุการณ์นี้จะเริ่มต้นเมื่อการอัปโหลดไม่สําเร็จ ตรวจสอบข้อผิดพลาดเพื่อหาสาเหตุของความล้มเหลว |
เมื่อเกิดเหตุการณ์ ระบบจะส่งออบเจ็กต์ FIRStorageTaskSnapshot
กลับ ภาพรวมนี้เป็นการดูงานที่แก้ไขไม่ได้ ณ เวลาที่เกิดเหตุการณ์
ออบเจ็กต์นี้มีพร็อพเพอร์ตี้ต่อไปนี้
พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
---|---|---|
progress |
NSProgress |
ออบเจ็กต์ NSProgress ที่มีความคืบหน้าของการอัปโหลด |
error |
NSError |
ข้อผิดพลาดที่เกิดขึ้นระหว่างการอัปโหลด (หากมี) |
metadata |
FIRStorageMetadata |
ระหว่างการอัปโหลดมีข้อมูลเมตาที่อัปโหลด หลังจากเหตุการณ์ FIRTaskStatusSuccess มีข้อมูลเมตาของไฟล์ที่อัปโหลด |
task |
FIRStorageUploadTask |
งานที่เป็นภาพรวมนี้ ซึ่งสามารถใช้เพื่อจัดการ (pause , resume , cancel ) งาน |
reference |
FIRStorageReference |
ข้อมูลอ้างอิงที่มาของงาน |
นอกจากนี้ คุณยังนำผู้สังเกตการณ์ออกทีละคน ตามสถานะ หรือนำออกทั้งหมดได้ด้วย
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 FIRStorageHandle 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];
ระบบจะนำผู้สังเกตการณ์ทั้งหมดออกหลังจากเกิด FIRStorageTaskStatusSuccess
หรือ FIRStorageTaskStatusFailure
เพื่อป้องกันไม่ให้หน่วยความจำรั่วไหล
การจัดการข้อผิดพลาด
ข้อผิดพลาดที่อาจเกิดขึ้นในการอัปโหลดมีสาเหตุหลายประการ เช่น ไฟล์ในเครื่องไม่อยู่ หรือผู้ใช้ไม่มีสิทธิ์อัปโหลดไฟล์ที่ต้องการ ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดได้ในส่วนจัดการข้อผิดพลาดของเอกสาร
ตัวอย่างแบบเต็ม
ตัวอย่างการอัปโหลดแบบเต็มที่มีการตรวจสอบความคืบหน้าและการจัดการข้อผิดพลาดแสดงอยู่ด้านล่าง
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; } } }];
เมื่ออัปโหลดไฟล์แล้ว มาดูวิธีดาวน์โหลดไฟล์จาก Cloud Storage