อัปโหลดไฟล์ด้วย Cloud Storage บน Flutter

Cloud Storage for Firebase ช่วยให้คุณอัปโหลดไฟล์ไปยังที่เก็บข้อมูล Cloud Storage ที่ให้บริการและจัดการโดย Firebase ได้อย่างรวดเร็วและง่ายดาย

อัปโหลดไฟล์

หากต้องการอัปโหลดไฟล์ไปยัง Cloud Storage ก่อนอื่นคุณต้องสร้างการอ้างอิงไปยังเส้นทางแบบเต็มของไฟล์ รวมถึงชื่อไฟล์

// Create a storage reference from our app
final storageRef = FirebaseStorage.instance.ref();

// Create a reference to "mountains.jpg"
final mountainsRef = storageRef.child("mountains.jpg");

// Create a reference to 'images/mountains.jpg'
final mountainImagesRef = storageRef.child("images/mountains.jpg");

// While the file names are the same, the references point to different files
assert(mountainsRef.name == mountainImagesRef.name);
assert(mountainsRef.fullPath != mountainImagesRef.fullPath);

เมื่อสร้างข้อมูลอ้างอิงที่เหมาะสมแล้ว คุณจะเรียกเมธอด putFile(), putString() หรือ putData() เพื่ออัปโหลดไฟล์ไปยัง Cloud Storage

คุณอัปโหลดข้อมูลที่มีการอ้างอิงไปยังรูทของที่เก็บข้อมูล Cloud Storage ไม่ได้ ข้อมูลอ้างอิงต้องชี้ไปยัง URL ย่อย

อัปโหลดจากไฟล์

หากต้องการอัปโหลดไฟล์ ก่อนอื่นคุณต้องได้รับเส้นทางสัมบูรณ์ไปยังตำแหน่งไฟล์ในอุปกรณ์ ตัวอย่างเช่น หากมีไฟล์อยู่ในไดเรกทอรีเอกสารของแอปพลิเคชัน ให้ใช้แพ็กเกจ path_provider อย่างเป็นทางการเพื่อสร้างเส้นทางของไฟล์และส่งไปยัง putFile() ดังนี้

Directory appDocDir = await getApplicationDocumentsDirectory();
String filePath = '${appDocDir.absolute}/file-to-upload.png';
File file = File(filePath);

try {
  await mountainsRef.putFile(file);
} on firebase_core.FirebaseException catch (e) {
  // ...
}

อัปโหลดจากสตริง

คุณอัปโหลดข้อมูลเป็นสตริงที่เข้ารหัสแบบ RAW, base64, base64url หรือ data_url ได้โดยใช้เมธอด putString() ตัวอย่างเช่น หากต้องการอัปโหลดสตริงข้อความที่เข้ารหัสเป็น URL ข้อมูล ให้ทำดังนี้

String dataUrl = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==';

try {
  await mountainsRef.putString(dataUrl, format: PutStringFormat.dataUrl);
} on FirebaseException catch (e) {
  // ...
}

การอัปโหลดข้อมูลดิบ

คุณสามารถอัปโหลดข้อมูลที่พิมพ์ในระดับต่ำกว่าในรูปแบบ Uint8List สำหรับกรณีที่การอัปโหลดสตริงหรือ File ใช้งานไม่ได้ ในกรณีนี้ ให้เรียกเมธอด putData() ที่มีข้อมูลของคุณ

try {
  // Upload raw data.
  await mountainsRef.putData(data);
} on firebase_core.FirebaseException catch (e) {
  // ...
}

ดู URL สำหรับดาวน์โหลด

หลังจากอัปโหลดไฟล์แล้ว คุณจะดู URL เพื่อดาวน์โหลดไฟล์ได้โดยเรียกใช้เมธอด getDownloadUrl() ใน Reference

await mountainsRef.getDownloadURL();

เพิ่มข้อมูลเมตาของไฟล์

นอกจากนี้ยังใส่ข้อมูลเมตาเมื่ออัปโหลดไฟล์ได้อีกด้วย ข้อมูลเมตานี้มีคุณสมบัติโดยทั่วไปของข้อมูลเมตาของไฟล์ เช่น contentType (โดยทั่วไปเรียกว่าประเภท MIME) เมธอด putFile() จะอนุมานประเภท MIME จากส่วนขยาย File โดยอัตโนมัติ แต่คุณสามารถลบล้างประเภทที่ตรวจพบอัตโนมัติได้ด้วยการระบุ contentType ในข้อมูลเมตา หากคุณไม่ระบุ contentType และ Cloud Storage สรุปค่าเริ่มต้นจากนามสกุลไฟล์ไม่ได้ Cloud Storage จะใช้ application/octet-stream โปรดดูใช้ข้อมูลเมตาของไฟล์

try {
  await mountainsRef.putFile(file, SettableMetadata(
    contentType: "image/jpeg",
  ));
} on firebase_core.FirebaseException catch (e) {
  // ...
}

จัดการการอัปโหลด

นอกจากการเริ่มอัปโหลดแล้ว คุณยังหยุดอัปโหลดชั่วคราว ดำเนินการต่อ และยกเลิกการอัปโหลดได้โดยใช้เมธอด pause(), resume() และ cancel() เหตุการณ์หยุดชั่วคราวและทำต่อจะเพิ่มการเปลี่ยนแปลงสถานะ pause และ progress ตามลำดับ การยกเลิกการอัปโหลดทำให้การอัปโหลดล้มเหลวโดยมีข้อผิดพลาดที่ระบุว่าการอัปโหลดถูกยกเลิก

final task = mountainsRef.putFile(largeFile);

// Pause the upload.
bool paused = await task.pause();
print('paused, $paused');

// Resume the upload.
bool resumed = await task.resume();
print('resumed, $resumed');

// Cancel the upload.
bool canceled = await task.cancel();
print('canceled, $canceled');

ตรวจสอบความคืบหน้าในการอัปโหลด

คุณฟังสตรีมเหตุการณ์ของงานเพื่อจัดการความสำเร็จ ความล้มเหลว ความคืบหน้า หรือหยุดชั่วคราวในงานอัปโหลดได้ โดยทำดังนี้

ประเภทเหตุการณ์ การใช้งานทั่วไป
TaskState.running ส่งออกเป็นระยะๆ เมื่อมีการโอนข้อมูล และสามารถใช้เพื่อสร้างตัวบ่งชี้การอัปโหลด/ดาวน์โหลด
TaskState.paused ส่งออกเมื่อใดก็ตามที่งานหยุดชั่วคราว
TaskState.success ส่งเมื่องานเสร็จเรียบร้อยแล้ว
TaskState.canceled ส่งออกเมื่อใดก็ตามที่ยกเลิกงาน
TaskState.error ส่งเมื่ออัปโหลดไม่สำเร็จ กรณีนี้อาจเกิดจากการหมดเวลาของเครือข่าย การให้สิทธิ์ไม่สำเร็จ หรือคุณยกเลิกงาน 
mountainsRef.putFile(file).snapshotEvents.listen((taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      // ...
      break;
    case TaskState.paused:
      // ...
      break;
    case TaskState.success:
      // ...
      break;
    case TaskState.canceled:
      // ...
      break;
    case TaskState.error:
      // ...
      break;
  }
});

การจัดการข้อผิดพลาด

การเกิดข้อผิดพลาดขึ้นในการอัปโหลดมีสาเหตุหลายประการ ได้แก่ การที่ไฟล์ในเครื่องไม่มีอยู่ หรือผู้ใช้ไม่มีสิทธิ์อัปโหลดไฟล์ที่ต้องการ ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดได้ในส่วนจัดการข้อผิดพลาดของเอกสาร

ตัวอย่างแบบเต็ม

ตัวอย่างแบบเต็มของการอัปโหลดที่มีการตรวจสอบความคืบหน้าและการจัดการข้อผิดพลาดมีดังนี้

final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/path/to/mountains.jpg";
final file = File(filePath);

// Create the file metadata
final metadata = SettableMetadata(contentType: "image/jpeg");

// Create a reference to the Firebase Storage bucket
final storageRef = FirebaseStorage.instance.ref();

// Upload file and metadata to the path 'images/mountains.jpg'
final uploadTask = storageRef
    .child("images/path/to/mountains.jpg")
    .putFile(file, metadata);

// Listen for state changes, errors, and completion of the upload.
uploadTask.snapshotEvents.listen((TaskSnapshot taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      final progress =
          100.0 * (taskSnapshot.bytesTransferred / taskSnapshot.totalBytes);
      print("Upload is $progress% complete.");
      break;
    case TaskState.paused:
      print("Upload is paused.");
      break;
    case TaskState.canceled:
      print("Upload was canceled");
      break;
    case TaskState.error:
      // Handle unsuccessful uploads
      break;
    case TaskState.success:
      // Handle successful uploads on complete
      // ...
      break;
  }
});

เมื่อคุณอัปโหลดไฟล์แล้ว ต่อไปมาดูวิธีดาวน์โหลดไฟล์เหล่านั้นจาก Cloud Storage กัน