Cloud Storage for Firebase, Firebase tarafından sağlanan ve yönetilen bir Cloud Storage paketine dosyaları hızlı ve kolay bir şekilde yüklemenize olanak tanır.
Dosya Yükle
Cloud Storage'ya dosya yüklemek için önce dosya adı da dahil olmak üzere dosyanın tam yoluna referans oluşturursunuz.
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
Uygun bir referans oluşturduktan sonra dosyayı Cloud Storage'ye yüklemek için putBytes()
, putFile()
veya putStream()
yöntemini çağırırsınız.
Cloud Storage paketinize ait köke referans veren verileri yükleyemezsiniz. Referansınız bir alt URL'ye yönlendirmelidir.
Bellekteki verilerden yükleme
putBytes()
yöntemi, Cloud Storage'ye dosya yüklemenin en basit yoludur. putBytes()
, byte[]
alır ve yüklemenin durumunu yönetip izlemek için kullanabileceğiniz bir UploadTask
döndürür.
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[]
kabul ettiğinden uygulamanızın bir dosyanın tüm içeriğini aynı anda bellekte tutması gerekir. Daha az bellek kullanmak için putStream()
veya putFile()
kullanabilirsiniz.
Akıştan yükleme
putStream()
yöntemi, Cloud Storage'ye dosya yüklemenin en çok yönlü yoludur. putStream()
, InputStream
alır ve yüklemenin durumunu yönetip izlemek için kullanabileceğiniz bir UploadTask
döndürür.
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. // ... } });
Yerel bir dosyadan yükleme
putFile()
yöntemini kullanarak cihazdaki yerel dosyaları (ör. kameradan alınan fotoğraf ve videolar) yükleyebilirsiniz. putFile()
, File
alır ve yüklemenin durumunu yönetip izlemek için kullanabileceğiniz bir UploadTask
döndürür.
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. // ... } });
İndirme URL'si alma
Bir dosyayı yükledikten sonra, StorageReference
üzerinde getDownloadUrl()
yöntemini çağırarak dosyayı indirmek için bir URL alabilirsiniz:
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 // ... } } });
Dosya meta verileri ekleme
Dosya yüklerken meta verileri de ekleyebilirsiniz.
Bu meta veriler, name
, size
ve contentType
(genellikle MIME türü olarak adlandırılır) gibi tipik dosya meta veri özelliklerini içerir. putFile()
yöntemi, MIME türünü File
uzantısından otomatik olarak çıkarır. Ancak meta verilerde contentType
değerini belirterek otomatik olarak algılanan türü geçersiz kılabilirsiniz. contentType
sağlamazsanız ve Cloud Storage, dosya uzantısından varsayılan bir contentType
çıkaramazsa Cloud Storage, application/octet-stream
kullanır. Dosya meta verileri hakkında daha fazla bilgi için Dosya Meta Verilerini Kullanma bölümüne bakın.
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);
Yüklemeleri Yönet
Yüklemeleri başlatmanın yanı sıra pause()
, resume()
ve cancel()
yöntemlerini kullanarak yüklemeleri duraklatabilir, devam ettirebilir ve iptal edebilirsiniz. Etkinlikleri duraklatma ve devam ettirme işlemleri sırasıyla pause
ve progress
durum değişikliklerine neden olur. Yüklemenin iptal edilmesi, yüklemenin iptal edildiğini belirten bir hatayla sonuçlanır.
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();
Yükleme ilerleme durumunu izleme
Yükleme görevinizde başarı, hata, ilerleme veya duraklatma durumlarını işlemek için dinleyiciler ekleyebilirsiniz:
Dinleyici Türü | Tipik Kullanım |
---|---|
OnProgressListener |
Bu dinleyici, veriler aktarılırken periyodik olarak çağrılır ve bir yükleme/indirme göstergesini doldurmak için kullanılabilir. |
OnPausedListener |
Bu dinleyici, görev her duraklatıldığında çağrılır. |
OnSuccessListener |
Bu dinleyici, görev başarıyla tamamlandığında çağrılır. |
OnFailureListener |
Bu dinleyici, yükleme her başarısız olduğunda çağrılır. Bu durum, ağ zaman aşımları, yetkilendirme hataları veya görevi iptal etmenizden kaynaklanabilir. |
OnFailureListener
, Exception
örneğiyle çağrılır. Diğer dinleyiciler UploadTask.TaskSnapshot
nesnesiyle çağrılır.
Bu nesne, etkinlik gerçekleştiği sırada görevin değişmez bir görünümüdür.
UploadTask.TaskSnapshot
aşağıdaki özellikleri içerir:
Özellik | Tür | Açıklama |
---|---|---|
getDownloadUrl |
String |
Nesneyi indirmek için kullanılabilecek bir URL. Bu, diğer istemcilerle paylaşılabilecek, herkese açık ve tahmin edilemeyen bir URL'dir. Bu değer, yükleme tamamlandıktan sonra doldurulur. |
getError |
Exception |
Görev başarısız olursa bu alan, nedeni İstisna olarak gösterir. |
getBytesTransferred |
long |
Bu anlık görüntü alındığında aktarılan toplam bayt sayısı. |
getTotalByteCount |
long |
Yüklenecek toplam bayt sayısı. |
getUploadSessionUri |
String |
Bu görevi başka bir putFile çağrısıyla devam ettirmek için kullanılabilecek bir URI. |
getMetadata |
StorageMetadata |
Yükleme tamamlanmadan önce sunucuya gönderilen meta verilerdir. Yükleme tamamlandıktan sonra sunucu tarafından döndürülen meta verilerdir. |
getTask |
UploadTask |
Bu anlık görüntüyü oluşturan görev. Yüklemeyi iptal etmek, duraklatmak veya devam ettirmek için bu görevi kullanın. |
getStorage |
StorageReference |
UploadTask oluşturmak için kullanılan StorageReference . |
UploadTask
etkinlik işleyicileri, yükleme etkinliklerini izlemenin basit ve etkili bir yolunu sunar.
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"); } });
Etkinlik Yaşam Döngüsü Değişikliklerini İşleme
Yüklemeler, etkinlik yaşam döngüsü değişse bile (ör. iletişim kutusu gösterilmesi veya ekranın döndürülmesi) arka planda devam eder. Eklediğiniz dinleyiciler de ekli kalır. Bu işlevler, etkinlik durdurulduktan sonra çağrılırsa beklenmedik sonuçlara neden olabilir.
Bu sorunu, dinleyicilerinizi etkinlik kapsamıyla abone ederek ve etkinlik durduğunda otomatik olarak kayıtlarını silerek çözebilirsiniz. Ardından, etkinlik yeniden başladığında getActiveUploadTasks
yöntemini kullanarak hâlâ devam eden veya yakın zamanda tamamlanan yükleme görevlerini alın.
Aşağıdaki örnekte bu durum gösterilmekte ve kullanılan depolama referans yolunun nasıl kalıcı hale getirileceği açıklanmaktadır.
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
, sağlanan referansın altındaki ve referansla aynı düzeydeki tüm etkin yükleme görevlerini alır. Bu nedenle, birden fazla görevi yönetmeniz gerekebilir.
İşlem yeniden başlatıldığında yüklemelere devam etme
İşleminiz kapatılırsa devam eden yükleme işlemleri kesintiye uğrar. Ancak, sunucuyla yükleme oturumunu devam ettirerek işlem yeniden başladığında yüklemeye devam edebilirsiniz. Bu sayede, yükleme işlemini dosyanın başından başlatmak gerekmez. Böylece zamandan ve bant genişliğinden tasarruf edilebilir.
Bunun için putFile
üzerinden yüklemeye başlayın. Sonuçta elde edilen StorageTask
üzerinde getUploadSessionUri
işlevini çağırın ve sonuçta elde edilen değeri kalıcı depolama alanına (ör. SharedPreferences) kaydedin.
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. } } });
Yükleme işlemi kesintiye uğradıktan sonra yeniden başladığında putFile'ı tekrar çağırın. Ancak bu kez kaydedilen URI'yi de iletin.
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);
Oturumlar bir hafta sürer. Oturumun süresi dolduktan veya oturumda bir hata oluştuğunda oturumu devam ettirmeye çalışırsanız başarısızlık geri araması alırsınız. Yüklemeler arasında dosyanın değişmediğinden emin olmak sizin sorumluluğunuzdadır.
Hata İşleme
Yükleme sırasında hataların oluşmasının çeşitli nedenleri vardır. Örneğin, yerel dosya mevcut olmayabilir veya kullanıcının istenen dosyayı yükleme izni olmayabilir. Hatalar hakkında daha fazla bilgiyi dokümanların Hataları İşleme bölümünde bulabilirsiniz.
Tam Örnek
Aşağıda, ilerleme izleme ve hata işleme içeren bir yükleme işleminin tam örneği gösterilmektedir:
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 // ... } });
Dosyaları yüklediğinize göre şimdi Cloud Storage'dan nasıl indireceğinizi öğrenelim.