Cloud Storage for Firebase ช่วยให้คุณอัปโหลดไฟล์ไปยังที่เก็บข้อมูล Cloud Storageที่ Firebase จัดเตรียมให้ และจัดการได้อย่างรวดเร็วและง่ายดาย
อัปโหลดไฟล์
หากต้องการอัปโหลดไฟล์ไปยัง Cloud Storage คุณต้องสร้างการอ้างอิงไปยัง เส้นทางแบบเต็มของไฟล์ รวมถึงชื่อไฟล์ก่อน
Kotlin
// Create a storage reference from our app val storageRef = storage.reference // Create a reference to "mountains.jpg" val mountainsRef = storageRef.child("mountains.jpg") // Create a reference to 'images/mountains.jpg' val 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.path == mountainImagesRef.path // false
Java
// Create a storage reference from our app StorageReference storageRef = storage.getReference(); // Create a reference to "mountains.jpg" StorageReference mountainsRef = storageRef.child("mountains.jpg"); // Create a reference to 'images/mountains.jpg' StorageReference mountainImagesRef = storageRef.child("images/mountains.jpg"); // While the file names are the same, the references point to different files mountainsRef.getName().equals(mountainImagesRef.getName()); // true mountainsRef.getPath().equals(mountainImagesRef.getPath()); // false
เมื่อสร้างการอ้างอิงที่เหมาะสมแล้ว ให้เรียกใช้เมธอด putBytes()
,
putFile()
หรือ putStream()
เพื่ออัปโหลดไฟล์
ไปยัง Cloud Storage
คุณอัปโหลดข้อมูลโดยอ้างอิงถึงรูทของที่เก็บข้อมูล Cloud Storage ไม่ได้ การอ้างอิงต้องชี้ไปยัง URL ของเด็ก
อัปโหลดจากข้อมูลในหน่วยความจำ
putBytes()
เป็นวิธีที่ง่ายที่สุดในการอัปโหลดไฟล์ไปยัง Cloud Storage putBytes()
จะใช้ byte[]
และแสดงผล UploadTask
ที่คุณใช้เพื่อจัดการและตรวจสอบสถานะการอัปโหลดได้
Kotlin
// Get the data from an ImageView as bytes imageView.isDrawingCacheEnabled = true imageView.buildDrawingCache() val bitmap = (imageView.drawable as BitmapDrawable).bitmap val baos = ByteArrayOutputStream() bitmap.compress(Bitmap.CompressFormat.JPEG, 100, baos) val data = baos.toByteArray() var uploadTask = mountainsRef.putBytes(data) uploadTask.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { taskSnapshot -> // taskSnapshot.metadata contains file metadata such as size, content-type, etc. // ... }
Java
// Get the data from an ImageView as bytes imageView.setDrawingCacheEnabled(true); imageView.buildDrawingCache(); Bitmap bitmap = ((BitmapDrawable) imageView.getDrawable()).getBitmap(); ByteArrayOutputStream baos = new ByteArrayOutputStream(); bitmap.compress(Bitmap.CompressFormat.JPEG, 100, baos); byte[] data = baos.toByteArray(); UploadTask uploadTask = mountainsRef.putBytes(data); uploadTask.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // taskSnapshot.getMetadata() contains file metadata such as size, content-type, etc. // ... } });
เนื่องจาก putBytes()
ยอมรับ byte[]
แอปของคุณจึงต้องเก็บเนื้อหาทั้งหมดของไฟล์ไว้ในหน่วยความจำพร้อมกัน ลองใช้ putStream()
หรือ
putFile()
เพื่อใช้หน่วยความจำน้อยลง
อัปโหลดจากสตรีม
putStream()
เป็นวิธีที่ยืดหยุ่นที่สุดในการอัปโหลดไฟล์ไปยัง Cloud Storage putStream()
จะใช้ InputStream
และแสดงผล UploadTask
ที่คุณใช้เพื่อจัดการและตรวจสอบสถานะการอัปโหลดได้
Kotlin
val stream = FileInputStream(File("path/to/images/rivers.jpg")) uploadTask = mountainsRef.putStream(stream) uploadTask.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { taskSnapshot -> // taskSnapshot.metadata contains file metadata such as size, content-type, etc. // ... }
Java
InputStream stream = new FileInputStream(new File("path/to/images/rivers.jpg")); uploadTask = mountainsRef.putStream(stream); uploadTask.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // taskSnapshot.getMetadata() contains file metadata such as size, content-type, etc. // ... } });
อัปโหลดจากไฟล์ในเครื่อง
คุณสามารถอัปโหลดไฟล์ในเครื่องบนอุปกรณ์ เช่น รูปภาพและวิดีโอจากกล้อง โดยใช้putFile()
วิธีนี้ putFile()
จะรับ File
และส่งคืน
UploadTask
ซึ่งคุณใช้เพื่อจัดการและตรวจสอบสถานะการอัปโหลดได้
Kotlin
var file = Uri.fromFile(File("path/to/images/rivers.jpg")) val riversRef = storageRef.child("images/${file.lastPathSegment}") uploadTask = riversRef.putFile(file) // Register observers to listen for when the download is done or if it fails uploadTask.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { taskSnapshot -> // taskSnapshot.metadata contains file metadata such as size, content-type, etc. // ... }
Java
Uri file = Uri.fromFile(new File("path/to/images/rivers.jpg")); StorageReference riversRef = storageRef.child("images/"+file.getLastPathSegment()); uploadTask = riversRef.putFile(file); // Register observers to listen for when the download is done or if it fails uploadTask.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // taskSnapshot.getMetadata() contains file metadata such as size, content-type, etc. // ... } });
รับ URL สำหรับดาวน์โหลด
หลังจากอัปโหลดไฟล์แล้ว คุณจะรับ URL เพื่อดาวน์โหลดไฟล์ได้โดยเรียกใช้เมธอด getDownloadUrl()
ใน StorageReference
ดังนี้
Kotlin
val ref = storageRef.child("images/mountains.jpg") uploadTask = ref.putFile(file) val urlTask = uploadTask.continueWithTask { task -> if (!task.isSuccessful) { task.exception?.let { throw it } } ref.downloadUrl }.addOnCompleteListener { task -> if (task.isSuccessful) { val downloadUri = task.result } else { // Handle failures // ... } }
Java
final StorageReference ref = storageRef.child("images/mountains.jpg"); uploadTask = ref.putFile(file); Task<Uri> urlTask = uploadTask.continueWithTask(new Continuation<UploadTask.TaskSnapshot, Task<Uri>>() { @Override public Task<Uri> then(@NonNull Task<UploadTask.TaskSnapshot> task) throws Exception { if (!task.isSuccessful()) { throw task.getException(); } // Continue with the task to get the download URL return ref.getDownloadUrl(); } }).addOnCompleteListener(new OnCompleteListener<Uri>() { @Override public void onComplete(@NonNull Task<Uri> task) { if (task.isSuccessful()) { Uri downloadUri = task.getResult(); } else { // Handle failures // ... } } });
เพิ่มข้อมูลเมตาของไฟล์
นอกจากนี้ คุณยังใส่ข้อมูลเมตาเมื่ออัปโหลดไฟล์ได้ด้วย
ข้อมูลเมตานี้มีพร็อพเพอร์ตี้ข้อมูลเมตาของไฟล์ทั่วไป เช่น name
, size
และ contentType
(โดยทั่วไปเรียกว่าประเภท MIME) putFile()
เมธอด
จะอนุมานประเภท MIME จากส่วนขยาย File
โดยอัตโนมัติ แต่คุณสามารถ
ลบล้างประเภทที่ตรวจหาอัตโนมัติได้โดยการระบุ contentType
ในข้อมูลเมตา หากคุณไม่ระบุ contentType
และ Cloud Storage ไม่สามารถอนุมานค่าเริ่มต้นจากนามสกุลไฟล์ได้ Cloud Storage จะใช้ application/octet-stream
ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อมูลเมตาของไฟล์ได้ที่ส่วนใช้ข้อมูลเมตาของไฟล์
Kotlin
// Create file metadata including the content type var metadata = storageMetadata { contentType = "image/jpg" } // Upload the file and metadata uploadTask = storageRef.child("images/mountains.jpg").putFile(file, metadata)
Java
// Create file metadata including the content type StorageMetadata metadata = new StorageMetadata.Builder() .setContentType("image/jpg") .build(); // Upload the file and metadata uploadTask = storageRef.child("images/mountains.jpg").putFile(file, metadata);
จัดการการอัปโหลด
นอกเหนือจากการเริ่มอัปโหลดแล้ว คุณยังหยุดชั่วคราว กลับมาอัปโหลดต่อ และยกเลิกการอัปโหลดได้โดยใช้วิธีการ pause()
, resume()
และ cancel()
เหตุการณ์หยุดชั่วคราวและเล่นต่อ
จะทำให้เกิดการเปลี่ยนแปลงสถานะ pause
และ progress
ตามลำดับ การยกเลิกการอัปโหลดจะทำให้การอัปโหลดไม่สำเร็จและมีข้อผิดพลาดที่ระบุว่ามีการยกเลิกการอัปโหลด
Kotlin
uploadTask = storageRef.child("images/mountains.jpg").putFile(file) // Pause the upload uploadTask.pause() // Resume the upload uploadTask.resume() // Cancel the upload uploadTask.cancel()
Java
uploadTask = storageRef.child("images/mountains.jpg").putFile(file); // Pause the upload uploadTask.pause(); // Resume the upload uploadTask.resume(); // Cancel the upload uploadTask.cancel();
ตรวจสอบความคืบหน้าในการอัปโหลด
คุณเพิ่ม Listener เพื่อจัดการความสำเร็จ ความล้มเหลว ความคืบหน้า หรือการหยุดชั่วคราวในงานอัปโหลดได้โดยทำดังนี้
ประเภทผู้ฟัง | การใช้งานทั่วไป |
---|---|
OnProgressListener |
ระบบจะเรียกใช้ Listener นี้เป็นระยะๆ ขณะโอนข้อมูล และใช้เพื่อแสดงตัวบ่งชี้การอัปโหลด/ดาวน์โหลดได้ |
OnPausedListener |
ระบบจะเรียกใช้ Listener นี้ทุกครั้งที่หยุดงานชั่วคราว |
OnSuccessListener |
ระบบจะเรียกใช้ Listener นี้เมื่องานเสร็จสมบูรณ์แล้ว |
OnFailureListener |
ระบบจะเรียกใช้ Listener นี้ทุกครั้งที่อัปโหลดไม่สำเร็จ ซึ่งอาจเกิดจากเครือข่ายหมดเวลา การให้สิทธิ์ล้มเหลว หรือหากคุณยกเลิกงาน |
OnFailureListener
จะเรียกใช้ด้วยอินสแตนซ์ Exception
ระบบจะเรียกใช้ Listener อื่นๆ ด้วยออบเจ็กต์ UploadTask.TaskSnapshot
ออบเจ็กต์นี้เป็นมุมมองที่แก้ไขไม่ได้ของงาน ณ เวลาที่เกิดเหตุการณ์
UploadTask.TaskSnapshot
มีพร็อพเพอร์ตี้ต่อไปนี้
พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
---|---|---|
getDownloadUrl |
String |
URL ที่ใช้ดาวน์โหลดออบเจ็กต์ได้ นี่คือ URL สาธารณะที่คาดเดาไม่ได้ซึ่งแชร์กับไคลเอ็นต์อื่นๆ ได้ ค่านี้จะแสดงเมื่อการอัปโหลดเสร็จสมบูรณ์ |
getError |
Exception |
หากงานไม่สำเร็จ ค่านี้จะมีสาเหตุเป็นข้อยกเว้น |
getBytesTransferred |
long |
จำนวนไบต์ทั้งหมดที่โอนเมื่อมีการถ่ายภาพรวมนี้ |
getTotalByteCount |
long |
จำนวนไบต์ทั้งหมดที่คาดว่าจะอัปโหลด |
getUploadSessionUri |
String |
URI ที่ใช้เพื่อทำงานนี้ต่อผ่านการเรียก putFile อีกครั้งได้ |
getMetadata |
StorageMetadata |
ก่อนการอัปโหลดจะเสร็จสมบูรณ์ นี่คือข้อมูลเมตาที่จะส่งไปยังเซิร์ฟเวอร์ หลังจากอัปโหลดเสร็จสมบูรณ์แล้ว ข้อมูลเมตานี้คือข้อมูลที่เซิร์ฟเวอร์ส่งคืน |
getTask |
UploadTask |
งานที่สร้างสแนปชอตนี้ ใช้ฟังก์ชันนี้เพื่อยกเลิก หยุดชั่วคราว หรือกลับมาอัปโหลดต่อ |
getStorage |
StorageReference |
StorageReference ที่ใช้สร้าง UploadTask |
UploadTask
Listener เหตุการณ์เป็นวิธีที่ง่ายและมีประสิทธิภาพในการตรวจสอบ
เหตุการณ์การอัปโหลด
Kotlin
// Observe state change events such as progress, pause, and resume // You'll need to import com.google.firebase.storage.component1 and // com.google.firebase.storage.component2 uploadTask.addOnProgressListener { (bytesTransferred, totalByteCount) -> val progress = (100.0 * bytesTransferred) / totalByteCount Log.d(TAG, "Upload is $progress% done") }.addOnPausedListener { Log.d(TAG, "Upload is paused") }
Java
// Observe state change events such as progress, pause, and resume uploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() { @Override public void onProgress(UploadTask.TaskSnapshot taskSnapshot) { double progress = (100.0 * taskSnapshot.getBytesTransferred()) / taskSnapshot.getTotalByteCount(); Log.d(TAG, "Upload is " + progress + "% done"); } }).addOnPausedListener(new OnPausedListener<UploadTask.TaskSnapshot>() { @Override public void onPaused(UploadTask.TaskSnapshot taskSnapshot) { Log.d(TAG, "Upload is paused"); } });
จัดการการเปลี่ยนแปลงวงจรของกิจกรรม
การอัปโหลดจะดำเนินต่อไปในเบื้องหลังแม้ว่าวงจรกิจกรรมจะเปลี่ยนไป (เช่น การแสดงกล่องโต้ตอบหรือการหมุนหน้าจอ) ผู้ฟังที่คุณแนบไว้ จะยังคงแนบอยู่เช่นเดิม ซึ่งอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิดหากมีการเรียกใช้หลังจากหยุดกิจกรรมแล้ว
คุณแก้ปัญหานี้ได้โดยการสมัครรับข้อมูลผู้ฟังที่มีขอบเขตกิจกรรม
เพื่อยกเลิกการลงทะเบียนโดยอัตโนมัติเมื่อกิจกรรมหยุดลง จากนั้นให้ใช้วิธีการ
getActiveUploadTasks
เมื่อกิจกรรมรีสตาร์ทเพื่อรับงานการอัปโหลด
ที่ยังทำงานอยู่หรือเพิ่งเสร็จสมบูรณ์
ตัวอย่างด้านล่างแสดงให้เห็นถึงเรื่องนี้ และยังแสดงวิธีคงเส้นทางการอ้างอิงพื้นที่เก็บข้อมูลที่ใช้ด้วย
Kotlin
override fun onSaveInstanceState(outState: Bundle) { super.onSaveInstanceState(outState) // If there's an upload 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 an upload in progress, get its reference and create a new StorageReference val stringRef = savedInstanceState.getString("reference") ?: return storageRef = Firebase.storage.getReferenceFromUrl(stringRef) // Find all UploadTasks under this StorageReference (in this example, there should be one) val tasks = storageRef.activeUploadTasks if (tasks.size > 0) { // Get the task monitoring the upload 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 an upload 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 an upload 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 UploadTasks under this StorageReference (in this example, there should be one) List<UploadTask> tasks = mStorageRef.getActiveUploadTasks(); if (tasks.size() > 0) { // Get the task monitoring the upload UploadTask task = tasks.get(0); // Add new listeners to the task using an Activity scope task.addOnSuccessListener(this, new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot state) { // Success! // ... } }); } }
getActiveUploadTasks
จะดึงข้อมูลงานการอัปโหลดที่ใช้งานอยู่ทั้งหมดที่ระดับและต่ำกว่าข้อมูลอ้างอิงที่ระบุ คุณจึงอาจต้องจัดการหลายงาน
อัปโหลดต่อเมื่อกระบวนการรีสตาร์ท
หากกระบวนการถูกปิด การอัปโหลดที่กำลังดำเนินการอยู่จะถูกขัดจังหวะ อย่างไรก็ตาม คุณจะอัปโหลดต่อได้เมื่อกระบวนการเริ่มต้นใหม่โดยการกลับมาใช้ เซสชันการอัปโหลดกับเซิร์ฟเวอร์ ซึ่งจะช่วยประหยัดเวลาและแบนด์วิดท์ได้โดยไม่ต้องเริ่มอัปโหลดตั้งแต่ต้นไฟล์
โดยเริ่มอัปโหลดผ่าน putFile
ใน StorageTask
ที่ได้
ให้เรียกใช้ getUploadSessionUri
และบันทึกค่าที่ได้ไว้ในที่เก็บข้อมูลแบบถาวร
(เช่น SharedPreferences)
Kotlin
uploadTask = storageRef.putFile(localFile) uploadTask.addOnProgressListener { taskSnapshot -> sessionUri = taskSnapshot.uploadSessionUri if (sessionUri != null && !saved) { saved = true // A persisted session has begun with the server. // Save this to persistent storage in case the process dies. } }
Java
uploadTask = mStorageRef.putFile(localFile); uploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() { @Override public void onProgress(UploadTask.TaskSnapshot taskSnapshot) { Uri sessionUri = taskSnapshot.getUploadSessionUri(); if (sessionUri != null && !mSaved) { mSaved = true; // A persisted session has begun with the server. // Save this to persistent storage in case the process dies. } } });
หลังจากกระบวนการรีสตาร์ทด้วยการอัปโหลดที่ถูกขัดจังหวะ ให้เรียกใช้ putFile อีกครั้ง แต่ คราวนี้ให้ส่ง Uri ที่บันทึกไว้ด้วย
Kotlin
// resume the upload task from where it left off when the process died. // to do this, pass the sessionUri as the last parameter uploadTask = storageRef.putFile( localFile, storageMetadata { }, sessionUri, )
Java
//resume the upload task from where it left off when the process died. //to do this, pass the sessionUri as the last parameter uploadTask = mStorageRef.putFile(localFile, new StorageMetadata.Builder().build(), sessionUri);
เซสชันมีระยะเวลา 1 สัปดาห์ หากพยายามเริ่มเซสชันต่อหลังจากที่เซสชัน หมดอายุแล้วหรือหากเซสชันเกิดข้อผิดพลาด คุณจะได้รับการเรียกกลับที่ล้มเหลว คุณมีหน้าที่รับผิดชอบในการตรวจสอบว่าไฟล์ไม่ได้เปลี่ยนแปลงระหว่างการอัปโหลด
การจัดการข้อผิดพลาด
การอัปโหลดอาจเกิดข้อผิดพลาดได้ด้วยเหตุผลหลายประการ เช่น ไม่มีไฟล์ในเครื่อง หรือผู้ใช้ไม่มีสิทธิ์อัปโหลด ไฟล์ที่ต้องการ ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดได้ในส่วน จัดการข้อผิดพลาด ของเอกสาร
ตัวอย่างแบบเต็ม
ตัวอย่างการอัปโหลดแบบเต็มพร้อมการตรวจสอบความคืบหน้าและการจัดการข้อผิดพลาด แสดงอยู่ด้านล่าง
Kotlin
// File or Blob file = Uri.fromFile(File("path/to/mountains.jpg")) // Create the file metadata metadata = storageMetadata { contentType = "image/jpeg" } // Upload file and metadata to the path 'images/mountains.jpg' uploadTask = storageRef.child("images/${file.lastPathSegment}").putFile(file, metadata) // Listen for state changes, errors, and completion of the upload. // You'll need to import com.google.firebase.storage.component1 and // com.google.firebase.storage.component2 uploadTask.addOnProgressListener { (bytesTransferred, totalByteCount) -> val progress = (100.0 * bytesTransferred) / totalByteCount Log.d(TAG, "Upload is $progress% done") }.addOnPausedListener { Log.d(TAG, "Upload is paused") }.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { // Handle successful uploads on complete // ... }
Java
// File or Blob file = Uri.fromFile(new File("path/to/mountains.jpg")); // Create the file metadata metadata = new StorageMetadata.Builder() .setContentType("image/jpeg") .build(); // Upload file and metadata to the path 'images/mountains.jpg' uploadTask = storageRef.child("images/"+file.getLastPathSegment()).putFile(file, metadata); // Listen for state changes, errors, and completion of the upload. uploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() { @Override public void onProgress(UploadTask.TaskSnapshot taskSnapshot) { double progress = (100.0 * taskSnapshot.getBytesTransferred()) / taskSnapshot.getTotalByteCount(); Log.d(TAG, "Upload is " + progress + "% done"); } }).addOnPausedListener(new OnPausedListener<UploadTask.TaskSnapshot>() { @Override public void onPaused(UploadTask.TaskSnapshot taskSnapshot) { Log.d(TAG, "Upload is paused"); } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // Handle successful uploads on complete // ... } });
ตอนนี้คุณได้อัปโหลดไฟล์แล้ว มาดูวิธีดาวน์โหลดไฟล์จาก Cloud Storage กัน