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 เพื่อจัดการความสำเร็จ ความล้มเหลว ความคืบหน้า หรือการหยุดชั่วคราวในงานอัปโหลดได้ดังนี้
| ประเภท Listener | การใช้งานทั่วไป |
|---|---|
OnProgressListener |
ระบบจะเรียก Listener นี้เป็นระยะๆ ขณะที่โอนข้อมูล และสามารถใช้เพื่อแสดงตัวบ่งชี้การอัปโหลด/ดาวน์โหลด |
OnPausedListener |
ระบบจะเรียก Listener นี้ทุกครั้งที่หยุดงานชั่วคราว |
OnSuccessListener |
ระบบจะเรียก Listener นี้เมื่อทำงานเสร็จสมบูรณ์ |
OnFailureListener |
ระบบจะเรียก Listener นี้ทุกครั้งที่การอัปโหลดไม่สำเร็จ ซึ่งอาจเกิดขึ้นเนื่องจากเครือข่ายหมดเวลา การให้สิทธิ์ล้มเหลว หรือหากคุณยกเลิกงาน |
ระบบจะเรียก OnFailureListener ด้วยอินสแตนซ์ Exception ส่วน Listener อื่นๆ จะถูกเรียกด้วยออบเจ็กต์ UploadTask.TaskSnapshot
ออบเจ็กต์นี้เป็นมุมมองที่ไม่เปลี่ยนแปลงของงาน ณ เวลาที่เกิดเหตุการณ์
UploadTask.TaskSnapshot มีพร็อพเพอร์ตี้ต่อไปนี้
| พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
|---|---|---|
getDownloadUrl |
String |
URL ที่ใช้ดาวน์โหลดออบเจ็กต์ได้ URL นี้เป็น URL สาธารณะที่คาดเดาได้ยาก ซึ่งแชร์กับไคลเอ็นต์อื่นๆ ได้ ระบบจะป้อนค่านี้เมื่อการอัปโหลดเสร็จสมบูรณ์ |
getError |
Exception |
หากงานไม่สำเร็จ ค่านี้จะเป็นสาเหตุในรูปแบบ Exception |
getBytesTransferred |
long |
จำนวนไบต์ทั้งหมดที่โอนเมื่อมีการสร้างสแนปชอตนี้ |
getTotalByteCount |
long |
จำนวนไบต์ทั้งหมดที่คาดว่าจะอัปโหลด |
getUploadSessionUri |
String |
URI ที่ใช้ทำงานนี้ต่อผ่านการเรียกใช้ putFile อีกครั้งได้ |
getMetadata |
StorageMetadata |
ก่อนการอัปโหลดจะเสร็จสมบูรณ์ ข้อมูลเมตานี้จะถูกส่งไปยังเซิร์ฟเวอร์ หลังจากอัปโหลดเสร็จสมบูรณ์ ข้อมูลเมตานี้จะเป็นข้อมูลเมตาที่เซิร์ฟเวอร์ส่งกลับ |
getTask |
UploadTask |
งานที่สร้างสแนปชอตนี้ ใช้ฟังก์ชันนี้เพื่อยกเลิก หยุดชั่วคราว หรือกลับมาอัปโหลดต่อ |
getStorage |
StorageReference |
StorageReference ที่ใช้สร้าง UploadTask |
Listener เหตุการณ์ UploadTask เป็นวิธีที่ง่ายและมีประสิทธิภาพในการตรวจสอบเหตุการณ์การอัปโหลด
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"); } });
จัดการการเปลี่ยนแปลงวงจรกิจกรรม
การอัปโหลดจะดำเนินต่อไปในเบื้องหลังแม้หลังจากมีการเปลี่ยนแปลงวงจรกิจกรรม (เช่น การแสดงกล่องโต้ตอบหรือการหมุนหน้าจอ) Listener ที่คุณแนบไว้จะยังคงแนบอยู่ ซึ่งอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิดหากระบบเรียกใช้ Listener เหล่านั้นหลังจากหยุดกิจกรรม
คุณสามารถแก้ปัญหานี้ได้โดยการสมัครใช้ Listener ที่มีขอบเขตกิจกรรมเพื่อยกเลิกการลงทะเบียน Listener โดยอัตโนมัติเมื่อกิจกรรมหยุดลง จากนั้นใช้เมธอด 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 กัน