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

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

อัปโหลดไฟล์

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

// 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
StorageActivity.kt

// 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
StorageActivity.java

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

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

อัปโหลดจากข้อมูลในหน่วยความจำ

เมธอด putBytes() เป็นวิธีที่ง่ายที่สุดในการอัปโหลด ไปยัง Cloud Storage putBytes() รับ byte[] และแสดงผล UploadTaskที่ใช้จัดการและตรวจสอบสถานะของการอัปโหลดได้

// 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.
    // ...
}
StorageActivity.kt

// 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.
        // ...
    }
});
StorageActivity.java

เนื่องจาก putBytes() ยอมรับ byte[] แอปจึงต้องเก็บใบอนุญาตทั้งหมดไว้ เนื้อหาของไฟล์ในหน่วยความจำได้พร้อมกัน ลองใช้ putStream() หรือ putFile() เพื่อลดการใช้หน่วยความจำ

อัปโหลดจากสตรีม

เมธอด putStream() เป็นวิธีที่มีประโยชน์หลากหลายที่สุดในการอัปโหลด ไปยัง Cloud Storage putStream() รับ InputStream และส่งคืน UploadTask ที่คุณสามารถใช้เพื่อจัดการและตรวจสอบสถานะของการอัปโหลด

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.
    // ...
}
StorageActivity.kt

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.
        // ...
    }
});
StorageActivity.java

อัปโหลดจากไฟล์ในเครื่อง

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

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.
    // ...
}
StorageActivity.kt

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.
        // ...
    }
});
StorageActivity.java

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

หลังจากอัปโหลดไฟล์แล้ว คุณสามารถดู URL สำหรับดาวน์โหลดไฟล์ได้โดยโทรหา เมธอด getDownloadUrl() ใน StorageReference:

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
        // ...
    }
}
StorageActivity.kt

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
            // ...
        }
    }
});
StorageActivity.java

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

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

// 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)
StorageActivity.kt

// 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);
StorageActivity.java

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

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

uploadTask = storageRef.child("images/mountains.jpg").putFile(file)

// Pause the upload
uploadTask.pause()

// Resume the upload
uploadTask.resume()

// Cancel the upload
uploadTask.cancel()
StorageActivity.kt

uploadTask = storageRef.child("images/mountains.jpg").putFile(file);

// Pause the upload
uploadTask.pause();

// Resume the upload
uploadTask.resume();

// Cancel the upload
uploadTask.cancel();
StorageActivity.java

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

คุณสามารถเพิ่ม Listener เพื่อจัดการความสำเร็จ ความล้มเหลว ความคืบหน้า หรือการหยุดเล่นชั่วคราวใน งานการอัปโหลด:

มีการเรียก OnFailureListener ด้วยอินสแตนซ์ Exception อื่นๆ Listener จะถูกเรียกด้วยออบเจ็กต์ UploadTask.TaskSnapshot ออบเจ็กต์นี้เป็นมุมมองที่เปลี่ยนแปลงไม่ได้ของงานในขณะที่เกิดเหตุการณ์ UploadTask.TaskSnapshot จะมีพร็อพเพอร์ตี้ต่อไปนี้

Listener เหตุการณ์ UploadTask มอบวิธีที่ง่ายและมีประสิทธิภาพในการตรวจสอบ อัปโหลดเหตุการณ์

// 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")
}
StorageActivity.kt

// 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");
    }
});
StorageActivity.java

จัดการกับการเปลี่ยนแปลงวงจรของกิจกรรม

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

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

ตัวอย่างด้านล่างแสดงวิธีคงพื้นที่เก็บข้อมูลไว้ เส้นทางอ้างอิงที่ใช้

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!
            // ...
        }
    }
}
UploadActivity.kt

@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!
                // ...
            }
        });
    }
}
UploadActivity.java

getActiveUploadTasks เรียกข้อมูลงานการอัปโหลดทั้งหมดที่ดำเนินการอยู่ทั้งในและต่ำกว่า ข้อมูลอ้างอิงที่ให้ไว้ ดังนั้นคุณอาจต้องจัดการงานหลายอย่าง

การอัปโหลดอย่างต่อเนื่องในกระบวนการรีสตาร์ท

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

โดยเริ่มอัปโหลดผ่าน putFile ใน StorageTask ที่ได้ เรียกใช้ getUploadSessionUri และบันทึกค่าที่ได้ลงในพื้นที่เก็บข้อมูลถาวร (เช่น SharedPreferences)

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.
    }
}
UploadActivity.kt

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.
        }
    }
});
UploadActivity.java

หลังจากกระบวนการเริ่มต้นใหม่โดยมีการอัปโหลดที่หยุดชะงัก ให้เรียกใช้ PutFile อีกครั้ง แต่ คราวนี้ให้ส่งผ่าน URI ที่บันทึกไว้ด้วย

// 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,
)
UploadActivity.kt

//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);
UploadActivity.java

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

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

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

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

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

// 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
    // ...
}
StorageActivity.kt

// 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
        // ...
    }
});
StorageActivity.java

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