Cloud Storage for Firebase به شما امکان میدهد تا به سرعت و به راحتی فایلها را در یک مخزن Cloud Storage که توسط فایربیس ارائه و مدیریت میشود، آپلود کنید.
آپلود فایلها
برای آپلود فایل در 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. // ... } });
دریافت آدرس اینترنتی دانلود
 پس از آپلود فایل، میتوانید با فراخوانی متد getDownloadUrl() در StorageReference آدرس اینترنتی (URL) برای دانلود فایل را دریافت کنید: 
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 // ... } } });
افزودن متادیتای فایل
 همچنین میتوانید هنگام آپلود فایلها، فراداده (metadata) را نیز اضافه کنید. این فراداده شامل ویژگیهای معمول فراداده فایل مانند 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 و resume به ترتیب باعث ایجاد تغییرات در وضعیت 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();
نظارت بر پیشرفت آپلود
شما میتوانید شنوندههایی را برای مدیریت موفقیت، شکست، پیشرفت یا مکث در وظیفه آپلود خود اضافه کنید:
| نوع شنونده | کاربرد معمول | 
|---|---|
 OnProgressListener | این شنونده (listener) به صورت دورهای و همزمان با انتقال دادهها فراخوانی میشود و میتواند برای پر کردن یک نشانگر آپلود/دانلود استفاده شود. | 
 OnPausedListener | این شنونده هر زمان که وظیفه متوقف شود، فراخوانی میشود. | 
 OnSuccessListener | این شنونده زمانی فراخوانی میشود که وظیفه با موفقیت انجام شده باشد. | 
 OnFailureListener | این شنونده هر زمان که آپلود با شکست مواجه شود، فراخوانی میشود. این اتفاق میتواند به دلیل وقفههای زمانی شبکه، خرابی مجوزها یا در صورت لغو وظیفه توسط شما رخ دهد. | 
 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 روشی ساده و قدرتمند برای نظارت بر رویدادهای آپلود ارائه میدهند. 
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);
جلسات یک هفته طول میکشد. اگر پس از انقضای یک جلسه یا در صورت بروز خطا، سعی در از سرگیری آن داشته باشید، یک پیام خطا دریافت خواهید کرد. مسئولیت اطمینان از عدم تغییر فایل بین آپلودها بر عهده شماست.
مدیریت خطا
دلایل مختلفی برای بروز خطا در هنگام آپلود وجود دارد، از جمله عدم وجود فایل محلی یا عدم دسترسی کاربر برای آپلود فایل مورد نظر. میتوانید اطلاعات بیشتر در مورد خطاها را در بخش «مدیریت خطاها» در مستندات بیابید.
مثال کامل
یک مثال کامل از آپلود با قابلیت نظارت بر پیشرفت و مدیریت خطا در زیر نشان داده شده است:
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 دانلود کنیم.