Cloud Storage for Firebase ช่วยให้คุณดาวน์โหลดไฟล์จากที่เก็บข้อมูล Cloud Storage ที่ Firebase มีให้และจัดการได้อย่างรวดเร็วและง่ายดาย
สร้างการอ้างอิง
หากต้องการดาวน์โหลดไฟล์ ก่อนอื่น ให้สร้างCloud Storageการอ้างอิงสำหรับไฟล์ที่ต้องการดาวน์โหลด
คุณสามารถสร้างการอ้างอิงได้โดยเพิ่มเส้นทางย่อยต่อท้ายรูทของที่เก็บข้อมูล Cloud Storage หรือจะสร้างการอ้างอิงจาก URL gs://
หรือ https://
ที่มีอยู่ซึ่งอ้างอิงถึงออบเจ็กต์ใน Cloud Storage ก็ได้
Kotlin+KTX
// Create a storage reference from our app val storageRef = storage.reference // Create a reference with an initial file path and name val pathReference = storageRef.child("images/stars.jpg") // Create a reference to a file from a Google Cloud Storage URI val gsReference = storage.getReferenceFromUrl("gs://bucket/images/stars.jpg") // Create a reference from an HTTPS URL // Note that in the URL, characters are URL escaped! val httpsReference = storage.getReferenceFromUrl( "https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg", )
Java
// Create a storage reference from our app StorageReference storageRef = storage.getReference(); // Create a reference with an initial file path and name StorageReference pathReference = storageRef.child("images/stars.jpg"); // Create a reference to a file from a Google Cloud Storage URI StorageReference gsReference = storage.getReferenceFromUrl("gs://bucket/images/stars.jpg"); // Create a reference from an HTTPS URL // Note that in the URL, characters are URL escaped! StorageReference httpsReference = storage.getReferenceFromUrl("https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg");
ดาวน์โหลดไฟล์
เมื่อมีข้อมูลอ้างอิงแล้ว คุณจะดาวน์โหลดไฟล์จาก Cloud Storage ได้โดยเรียกใช้ getBytes()
หรือ getStream()
หากต้องการดาวน์โหลดไฟล์ด้วยไลบรารีอื่น ให้รับ URL ดาวน์โหลดด้วย getDownloadUrl()
ดาวน์โหลดในหน่วยความจำ
ดาวน์โหลดไฟล์เป็น byte[]
โดยใช้เมธอด getBytes()
วิธีนี้เป็นวิธีที่ง่ายที่สุดในการดาวน์โหลดไฟล์ แต่ต้องโหลดเนื้อหาทั้งหมดของไฟล์ลงในหน่วยความจำ หากคุณขอไฟล์ที่มีขนาดใหญ่กว่าหน่วยความจำที่พร้อมใช้งานของแอป แอปจะขัดข้อง getBytes()
จะดาวน์โหลดไบต์สูงสุดเพื่อป้องกันปัญหาเกี่ยวกับหน่วยความจำ ตั้งค่าขนาดสูงสุดเป็นขนาดที่คุณรู้ว่าแอปจัดการได้ หรือใช้วิธีการดาวน์โหลดอื่น
Kotlin+KTX
var islandRef = storageRef.child("images/island.jpg") val ONE_MEGABYTE: Long = 1024 * 1024 islandRef.getBytes(ONE_MEGABYTE).addOnSuccessListener { // Data for "images/island.jpg" is returned, use this as needed }.addOnFailureListener { // Handle any errors }
Java
StorageReference islandRef = storageRef.child("images/island.jpg"); final long ONE_MEGABYTE = 1024 * 1024; islandRef.getBytes(ONE_MEGABYTE).addOnSuccessListener(new OnSuccessListener<byte[]>() { @Override public void onSuccess(byte[] bytes) { // Data for "images/island.jpg" is returns, use this as needed } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle any errors } });
ดาวน์โหลดไปยังไฟล์ในเครื่อง
วิธี getFile()
จะดาวน์โหลดไฟล์ไปยังอุปกรณ์ในเครื่องโดยตรง ใช้คำสั่งนี้หากผู้ใช้ต้องการเข้าถึงไฟล์ขณะออฟไลน์หรือแชร์ไฟล์ในแอปอื่น getFile()
จะแสดงผลเป็น DownloadTask
ซึ่งคุณใช้เพื่อจัดการการดาวน์โหลดและตรวจสอบสถานะการดาวน์โหลดได้
Kotlin+KTX
islandRef = storageRef.child("images/island.jpg") val localFile = File.createTempFile("images", "jpg") islandRef.getFile(localFile).addOnSuccessListener { // Local temp file has been created }.addOnFailureListener { // Handle any errors }
Java
islandRef = storageRef.child("images/island.jpg"); File localFile = File.createTempFile("images", "jpg"); islandRef.getFile(localFile).addOnSuccessListener(new OnSuccessListener<FileDownloadTask.TaskSnapshot>() { @Override public void onSuccess(FileDownloadTask.TaskSnapshot taskSnapshot) { // Local temp file has been created } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle any errors } });
หากต้องการจัดการการดาวน์โหลดอย่างสม่ำเสมอ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อจัดการการดาวน์โหลด
ดาวน์โหลดข้อมูลผ่าน URL
หากมีโครงสร้างพื้นฐานการดาวน์โหลดที่อิงตาม URL อยู่แล้ว หรือเพียงแค่ต้องการ URL ที่จะแชร์ คุณก็รับ URL การดาวน์โหลดของไฟล์ได้โดยเรียกใช้เมธอด getDownloadUrl()
ในข้อมูลอ้างอิง Cloud Storage
Kotlin+KTX
storageRef.child("users/me/profile.png").downloadUrl.addOnSuccessListener { // Got the download URL for 'users/me/profile.png' }.addOnFailureListener { // Handle any errors }
Java
storageRef.child("users/me/profile.png").getDownloadUrl().addOnSuccessListener(new OnSuccessListener<Uri>() { @Override public void onSuccess(Uri uri) { // Got the download URL for 'users/me/profile.png' } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle any errors } });
การดาวน์โหลดรูปภาพด้วย FirebaseUI
FirebaseUI มีการเชื่อมโยงบนอุปกรณ์เคลื่อนที่แบบเนทีฟที่เรียบง่าย ปรับแต่งได้ และพร้อมใช้งานจริงเพื่อขจัดโค้ดที่ซ้ำกันและใช้แนวทางปฏิบัติแนะนำของ Google เมื่อใช้ FirebaseUI คุณจะดาวน์โหลด แคช และแสดงรูปภาพจาก Cloud Storage ได้อย่างรวดเร็วและง่ายดายโดยใช้การผสานรวมกับ Glide
ขั้นแรก ให้เพิ่ม FirebaseUI ไปยัง app/build.gradle
ดังนี้
dependencies { // FirebaseUI Storage only implementation 'com.firebaseui:firebase-ui-storage:7.2.0' }
จากนั้นคุณสามารถโหลดรูปภาพจาก Cloud Storage ไปยัง ImageView
ได้โดยตรง ดังนี้
Kotlin+KTX
// Reference to an image file in Cloud Storage val storageReference = Firebase.storage.reference // ImageView in your Activity val imageView = findViewById<ImageView>(R.id.imageView) // Download directly from StorageReference using Glide // (See MyAppGlideModule for Loader registration) Glide.with(context) .load(storageReference) .into(imageView)
Java
// Reference to an image file in Cloud Storage StorageReference storageReference = FirebaseStorage.getInstance().getReference(); // ImageView in your Activity ImageView imageView = findViewById(R.id.imageView); // Download directly from StorageReference using Glide // (See MyAppGlideModule for Loader registration) Glide.with(context) .load(storageReference) .into(imageView);
จัดการกับการเปลี่ยนแปลงวงจรของกิจกรรม
การดาวน์โหลดจะยังคงดำเนินต่อไปในเบื้องหลังแม้ว่าวงจรกิจกรรมจะเปลี่ยนแปลง (เช่น การแสดงกล่องโต้ตอบหรือการหมุนหน้าจอ) ผู้ฟังที่คุณแนบไว้ จะยังแนบมาด้วย ซึ่งอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิดหากมีการเรียกใช้ หลังจากกิจกรรมหยุดลงแล้ว
คุณแก้ปัญหานี้ได้โดยการสมัครใช้บริการ Listener ที่มีขอบเขตกิจกรรมเพื่อยกเลิกการลงทะเบียนโดยอัตโนมัติเมื่อกิจกรรมหยุดลง จากนั้นใช้วิธี getActiveDownloadTasks
เมื่อกิจกรรมเริ่มทํางานอีกครั้งเพื่อดูงานดาวน์โหลดที่ยังคงทํางานอยู่หรือเพิ่งเสร็จสิ้น
ตัวอย่างด้านล่างแสดงวิธีนี้และยังแสดงวิธีเก็บถาวรเส้นทางอ้างอิงพื้นที่เก็บข้อมูลที่ใช้
Kotlin+KTX
override fun onSaveInstanceState(outState: Bundle) { super.onSaveInstanceState(outState) // If there's a download in progress, save the reference so you can query it later outState.putString("reference", storageRef.toString()) } override fun onRestoreInstanceState(savedInstanceState: Bundle) { super.onRestoreInstanceState(savedInstanceState) // If there was a download in progress, get its reference and create a new StorageReference val stringRef = savedInstanceState.getString("reference") ?: return storageRef = Firebase.storage.getReferenceFromUrl(stringRef) // Find all DownloadTasks under this StorageReference (in this example, there should be one) val tasks = storageRef.activeDownloadTasks if (tasks.size > 0) { // Get the task monitoring the download val task = tasks[0] // Add new listeners to the task using an Activity scope task.addOnSuccessListener(this) { // Success! // ... } } }
Java
@Override protected void onSaveInstanceState(Bundle outState) { super.onSaveInstanceState(outState); // If there's a download in progress, save the reference so you can query it later if (mStorageRef != null) { outState.putString("reference", mStorageRef.toString()); } } @Override protected void onRestoreInstanceState(Bundle savedInstanceState) { super.onRestoreInstanceState(savedInstanceState); // If there was a download in progress, get its reference and create a new StorageReference final String stringRef = savedInstanceState.getString("reference"); if (stringRef == null) { return; } mStorageRef = FirebaseStorage.getInstance().getReferenceFromUrl(stringRef); // Find all DownloadTasks under this StorageReference (in this example, there should be one) List<FileDownloadTask> tasks = mStorageRef.getActiveDownloadTasks(); if (tasks.size() > 0) { // Get the task monitoring the download FileDownloadTask task = tasks.get(0); // Add new listeners to the task using an Activity scope task.addOnSuccessListener(this, new OnSuccessListener<FileDownloadTask.TaskSnapshot>() { @Override public void onSuccess(FileDownloadTask.TaskSnapshot state) { // Success! // ... } }); } }
จัดการข้อผิดพลาด
ข้อผิดพลาดที่อาจเกิดขึ้นระหว่างการดาวน์โหลดมีได้หลายสาเหตุ เช่น ไฟล์ไม่อยู่ หรือผู้ใช้ไม่มีสิทธิ์เข้าถึงไฟล์ที่ต้องการ ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดได้ในส่วนจัดการข้อผิดพลาดของเอกสาร
ตัวอย่างแบบเต็ม
ตัวอย่างการดาวน์โหลดแบบเต็มที่มีการจัดการข้อผิดพลาดแสดงอยู่ด้านล่าง
Kotlin+KTX
storageRef.child("users/me/profile.png").getBytes(Long.MAX_VALUE).addOnSuccessListener { // Use the bytes to display the image }.addOnFailureListener { // Handle any errors }
Java
storageRef.child("users/me/profile.png").getBytes(Long.MAX_VALUE).addOnSuccessListener(new OnSuccessListener<byte[]>() { @Override public void onSuccess(byte[] bytes) { // Use the bytes to display the image } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle any errors } });
นอกจากนี้ คุณยังรับและอัปเดตข้อมูลเมตาสำหรับไฟล์ที่เก็บไว้ใน Cloud Storage ได้ด้วย