Check out what’s new from Firebase at Google I/O 2022. Learn more

فایل‌ها را با Cloud Storage در اندروید آپلود کنید

Cloud Storage برای Firebase به شما این امکان را می دهد که به سرعت و به راحتی فایل ها را در یک سطل Cloud Storage که توسط Firebase تهیه و مدیریت می شود آپلود کنید.

آپلود فایل ها

برای آپلود یک فایل در Cloud Storage، ابتدا یک مرجع به مسیر کامل فایل، از جمله نام فایل ایجاد می کنید.

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

Kotlin+KTX

// 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

هنگامی که یک مرجع مناسب ایجاد کردید، سپس putBytes() ، putFile() ، یا putStream() را برای آپلود فایل در Cloud Storage فراخوانی می کنید.

نمی‌توانید داده‌ها را با ارجاع به ریشه سطل فضای ذخیره‌سازی ابری خود آپلود کنید. مرجع شما باید به نشانی اینترنتی فرزند اشاره کند.

آپلود از داده ها در حافظه

putBytes() ساده ترین راه برای آپلود فایل در فضای ذخیره سازی ابری است. putBytes() یک byte[] می گیرد و یک UploadTask را برمی گرداند که می توانید از آن برای مدیریت و نظارت بر وضعیت آپلود استفاده کنید.

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

Kotlin+KTX

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

از آنجایی که putBytes() یک byte[] را می پذیرد، به برنامه شما نیاز دارد که کل محتویات یک فایل را یکجا در حافظه نگه دارد. برای استفاده از حافظه کمتر از putStream() یا putFile() استفاده کنید.

آپلود از یک جریان

putStream() همه کاره ترین راه برای آپلود فایل در فضای ذخیره سازی ابری است. putStream() یک InputStream می گیرد و یک UploadTask را برمی گرداند که می توانید از آن برای مدیریت و نظارت بر وضعیت آپلود استفاده کنید.

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

Kotlin+KTX

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

از یک فایل محلی آپلود کنید

می توانید با روش putFile() فایل های محلی مانند عکس ها و فیلم های دوربین را روی دستگاه آپلود کنید. putFile() یک File می گیرد و یک UploadTask را برمی گرداند که می توانید از آن برای مدیریت و نظارت بر وضعیت آپلود استفاده کنید.

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

Kotlin+KTX

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

یک URL دانلود دریافت کنید

پس از آپلود یک فایل، می توانید با فراخوانی getDownloadUrl() در StorageReference یک URL برای دانلود فایل دریافت کنید:

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

Kotlin+KTX

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

افزودن فراداده فایل

همچنین می‌توانید هنگام آپلود فایل‌ها، متادیتا را نیز اضافه کنید. این ابرداده حاوی ویژگی‌های فراداده معمولی فایل مانند name ، size و نوع contentType (که معمولاً به عنوان نوع MIME شناخته می‌شود) است. putFile() به طور خودکار نوع MIME را از پسوند File استنباط می کند، اما می توانید نوع شناسایی خودکار را با تعیین contentType در فراداده لغو کنید. اگر contentType ارائه نکنید و Cloud Storage نمی تواند پیش فرضی را از پسوند فایل استنتاج کند، Cloud Storage از application/octet-stream استفاده می کند. برای اطلاعات بیشتر در مورد فراداده فایل، بخش Use 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);

Kotlin+KTX

// 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)

مدیریت آپلودها

علاوه بر شروع آپلود، می توانید با استفاده از متدهای pause() , resume() و cancel() آپلودها را متوقف، از سر بگیرید و لغو کنید. رویدادهای مکث و از سرگیری به ترتیب باعث افزایش pause و تغییر وضعیت progress می شوند. لغو آپلود باعث می شود که آپلود با خطایی که نشان می دهد آپلود لغو شده است با شکست مواجه شود.

Java

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

// Pause the upload
uploadTask.pause();

// Resume the upload
uploadTask.resume();

// Cancel the upload
uploadTask.cancel();

Kotlin+KTX

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

// Pause the upload
uploadTask.pause()

// Resume the upload
uploadTask.resume()

// Cancel the upload
uploadTask.cancel()

نظارت بر پیشرفت آپلود

می‌توانید برای مدیریت موفقیت، شکست، پیشرفت یا توقف در کار آپلود، شنوندگان اضافه کنید:

نوع شنونده استفاده معمولی
OnProgressListener این شنونده به صورت دوره ای هنگام انتقال داده ها نامیده می شود و می توان از آن برای پر کردن نشانگر آپلود/دانلود استفاده کرد.
OnPausedListener هر زمان که کار متوقف شود، این شنونده فراخوانی می شود.
OnSuccessListener این شنونده زمانی فراخوانی می شود که کار با موفقیت انجام شود.
OnFailureListener هر زمانی که آپلود ناموفق باشد، این شنونده فراخوانی می شود. این ممکن است به دلیل وقفه های زمانی شبکه، خرابی مجوزها، یا در صورت لغو کار اتفاق بیفتد.

OnFailureListener با یک نمونه Exception فراخوانی می شود. سایر شنوندگان با یک شی UploadTask.TaskSnapshot می شوند. این شی یک نمای تغییرناپذیر از کار در زمان وقوع رویداد است. یک UploadTask.TaskSnapshot دارای ویژگی های زیر است:

ویژگی تایپ کنید شرح
getDownloadUrl String آدرس اینترنتی که می توان از آن برای دانلود شی استفاده کرد. این یک URL عمومی غیرقابل حدس زدن است که می تواند با سایر مشتریان به اشتراک گذاشته شود. این مقدار پس از تکمیل آپلود پر می شود.
getError Exception اگر کار با شکست مواجه شد، این دلیل به عنوان یک استثنا خواهد بود.
getBytesTransferred long تعداد کل بایت هایی که هنگام گرفتن این عکس فوری منتقل شده اند.
getTotalByteCount long تعداد کل بایت های مورد انتظار برای آپلود.
getUploadSessionUri String یک URI که می تواند برای ادامه این کار از طریق تماس دیگری با putFile استفاده شود.
getMetadata StorageMetadata قبل از تکمیل آپلود، این ابرداده است که به سرور ارسال می شود. پس از تکمیل آپلود، این ابرداده ای است که توسط سرور بازگردانده می شود.
getTask UploadTask وظیفه ای که این عکس فوری را ایجاد کرد. از این کار برای لغو، توقف موقت یا از سرگیری آپلود استفاده کنید.
getStorage StorageReference StorageReference برای ایجاد UploadTask استفاده می شود.

شنوندگان رویداد UploadTask یک راه ساده و قدرتمند برای نظارت بر رویدادهای آپلود ارائه می دهند.

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");
    }
});

Kotlin+KTX

// Observe state change events such as progress, pause, and resume
// You'll need to import com.google.firebase.storage.ktx.component1 and 
// com.google.firebase.storage.ktx.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")
}

مدیریت تغییرات چرخه حیات فعالیت

آپلودها در پس‌زمینه ادامه می‌یابند حتی پس از تغییر چرخه عمر فعالیت (مانند ارائه یک گفتگو یا چرخاندن صفحه). هر شنونده ای که پیوست کرده بودید نیز پیوست خواهد ماند. اگر پس از توقف فعالیت با آنها تماس گرفته شود، این می تواند نتایج غیرمنتظره ای ایجاد کند.

می توانید این مشکل را با اشتراک شنوندگان خود با یک محدوده فعالیت حل کنید تا پس از توقف فعالیت، به طور خودکار آنها را لغو ثبت کنید. سپس، هنگام شروع مجدد فعالیت، از روش getActiveUploadTasks استفاده کنید تا کارهای آپلودی را که هنوز در حال اجرا هستند یا اخیراً تکمیل شده اند، بدست آورید.

مثال زیر این را نشان می‌دهد و همچنین نشان می‌دهد که چگونه می‌توان مسیر مرجع ذخیره‌سازی مورد استفاده را ادامه داد.

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

Kotlin+KTX

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

getActiveUploadTasks همه وظایف آپلود فعال را در مرجع ارائه شده و زیر آن بازیابی می کند، بنابراین ممکن است لازم باشد چندین کار را انجام دهید.

ادامه آپلودها در طول فرآیند دوباره شروع می شود

اگر فرآیند شما بسته شود، هر بارگذاری در حال انجام قطع خواهد شد. با این حال، می‌توانید پس از شروع مجدد فرآیند با از سرگیری جلسه آپلود با سرور، آپلود را ادامه دهید. این می تواند با شروع نکردن آپلود از ابتدای فایل، در زمان و پهنای باند صرفه جویی کند.

برای انجام این کار، آپلود را از طریق putFile شروع کنید. در StorageTask ایجاد شده، getUploadSessionUri را فراخوانی کنید و مقدار حاصل را در فضای ذخیره سازی دائمی (مانند SharedPreferences) ذخیره کنید.

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

Kotlin+KTX

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

پس از شروع مجدد فرآیند با آپلود قطع شده، دوباره با putFile تماس بگیرید. اما این بار نیز از Uri که نجات یافته بود عبور کنید.

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+KTX

// 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)

جلسات یک هفته طول می کشد. اگر سعی کنید یک جلسه را پس از انقضای آن از سر بگیرید یا اگر با خطا مواجه شده بود، یک تماس با شکست دریافت خواهید کرد. این مسئولیت شماست که مطمئن شوید فایل بین آپلودها تغییر نکرده است.

رسیدگی به خطا

دلایل متعددی وجود دارد که ممکن است هنگام آپلود خطا رخ دهد، از جمله اینکه فایل محلی موجود نیست یا کاربر اجازه آپلود فایل مورد نظر را ندارد. می توانید اطلاعات بیشتری در مورد خطاها در بخش Handle Errors در اسناد پیدا کنید.

مثال کامل

یک مثال کامل از آپلود با نظارت بر پیشرفت و مدیریت خطا در زیر نشان داده شده است:

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

Kotlin+KTX

// 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.ktx.component1 and 
// com.google.firebase.storage.ktx.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
    // ...
}

اکنون که فایل‌ها را آپلود کردید، بیایید نحوه دانلود آنها را از فضای ذخیره‌سازی ابری بیاموزیم.