Android'de Cloud Storage ile dosya yükleme

Firebase için Cloud Storage, dosyaları Firebase tarafından sağlanan ve yönetilen bir Cloud Storage paketine hızlı ve kolay bir şekilde yüklemenize olanak tanır.

Dosyaları yükle

Cloud Storage'a bir dosya yüklemek için öncelikle dosya adı da dahil olmak üzere dosyanın tam yoluna bir referans oluşturursunuz.

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

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

Uygun bir referans oluşturduktan sonra dosyayı Cloud Storage'a yüklemek için putBytes() , putFile() veya putStream() yöntemini çağırırsınız.

Cloud Storage paketinizin köküne referansla veri yükleyemezsiniz. Referansınız bir alt URL'ye işaret etmelidir.

Bellekteki verilerden yükleme

putBytes() yöntemi, Cloud Storage'a dosya yüklemenin en basit yoludur. putBytes() bir byte[] alır ve yüklemenin durumunu yönetmek ve izlemek için kullanabileceğiniz bir UploadTask döndürür.

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

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

putBytes() bir byte[] kabul ettiğinden, uygulamanızın bir dosyanın tüm içeriğini aynı anda bellekte tutmasını gerektirir. Daha az bellek kullanmak için putStream() veya putFile() kullanmayı düşünün.

Bir akıştan yükleme

putStream() yöntemi, Cloud Storage'a dosya yüklemenin en çok yönlü yoludur. putStream() bir InputStream alır ve yüklemenin durumunu yönetmek ve izlemek için kullanabileceğiniz bir UploadTask döndürür.

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

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

Yerel bir dosyadan yükleme

putFile() yöntemini kullanarak kameradaki fotoğraf ve video gibi yerel dosyaları cihaza yükleyebilirsiniz. putFile() bir File alır ve yükleme durumunu yönetmek ve izlemek için kullanabileceğiniz bir UploadTask döndürür.

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

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

Bir indirme URL'si alın

Bir dosyayı yükledikten sonra, StorageReference getDownloadUrl() yöntemini çağırarak dosyayı indirmek için bir URL alabilirsiniz:

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

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

Dosya Meta Verilerini Ekle

Dosyaları yüklerken meta verileri de ekleyebilirsiniz. Bu meta veriler name , size ve contentType (genellikle MIME türü olarak anılır) gibi tipik dosya meta verisi özelliklerini içerir. putFile() yöntemi, MIME türünü File uzantısından otomatik olarak çıkarır, ancak meta verilerde contentType belirterek otomatik olarak algılanan türü geçersiz kılabilirsiniz. Bir contentType sağlamazsanız ve Cloud Storage dosya uzantısından bir varsayılan çıkarım yapamıyorsa Cloud Storage application/octet-stream kullanır. Dosya meta verileri hakkında daha fazla bilgi için Dosya Meta Verilerini Kullan bölümüne bakın.

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

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

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. Duraklatma ve devam ettirme olayları sırasıyla pause ve progress durumu değişikliklerini artırır. Bir yüklemenin iptal edilmesi, yüklemenin iptal edildiğini belirten bir hata vererek yüklemenin başarısız olmasına neden olur.

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

Java

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

Yükleme İlerlemesini İzleyin

Yükleme görevinizdeki başarıyı, başarısızlığı, ilerlemeyi veya duraklamaları yönetmek 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örevin duraklatıldığı herhangi bir zamanda çağrılır.
OnSuccessListener Bu dinleyici, görev başarıyla tamamlandığında çağrılır.
OnFailureListener Bu dinleyici, yüklemenin başarısız olduğu herhangi bir zamanda çağrılır. Bunun nedeni ağ zaman aşımları, yetkilendirme hataları veya görevi iptal etmeniz olabilir.

OnFailureListener bir Exception örneğiyle çağrılır. Diğer dinleyiciler UploadTask.TaskSnapshot nesnesiyle çağrılır. Bu nesne, olayın meydana geldiği andaki görevin değişmez bir görünümüdür. Bir UploadTask.TaskSnapshot aşağıdaki özellikleri içerir:

Mülk Tip Tanım
getDownloadUrl String Nesneyi indirmek için kullanılabilecek bir URL. Bu, diğer istemcilerle paylaşılabilen, genel, tahmin edilemeyen bir URL'dir. Bu değer, yükleme tamamlandıktan sonra doldurulur.
getError Exception Görev başarısız olursa bunun nedeni bir İstisna olacaktır.
getBytesTransferred long Bu anlık görüntü çekildiğinde aktarılan toplam bayt sayısı.
getTotalByteCount long Yüklenmesi beklenen toplam bayt sayısı.
getUploadSessionUri String Bu göreve putFile'a yapılan başka bir çağrı aracılığıyla devam etmek için kullanılabilecek bir URI.
getMetadata StorageMetadata Bir yükleme tamamlanmadan önce bu, sunucuya gönderilen meta verilerdir. Yükleme tamamlandıktan sonra bu, sunucunun döndürdüğü 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 olay dinleyicileri, yükleme olaylarını izlemek için basit ve güçlü bir yol sağlar.

Kotlin+KTX

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

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

Etkinlik Yaşam Döngüsü Değişikliklerini Yönetme

Etkinlik yaşam döngüsü değişikliklerinden sonra bile (bir iletişim kutusunun sunulması veya ekranın döndürülmesi gibi) yüklemeler arka planda devam eder. Eklediğiniz dinleyiciler de bağlı kalacaktır. Bu, etkinlik durdurulduktan sonra çağrılmaları durumunda beklenmeyen sonuçlara neden olabilir.

Etkinlik durduğunda kayıtlarını otomatik olarak iptal edecek bir etkinlik kapsamıyla dinleyicilerinize abone olarak bu sorunu çözebilirsiniz. Daha sonra, etkinlik yeniden başlatıldığında, halen çalışmakta olan veya yakın zamanda tamamlanan yükleme görevlerini almak için getActiveUploadTasks yöntemini kullanın.

Aşağıdaki örnek bunu göstermektedir ve ayrıca kullanılan depolama referans yolunun nasıl kalıcı hale getirileceğini de göstermektedir.

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

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

getActiveUploadTasks sağlanan referanstaki ve altındaki tüm etkin yükleme görevlerini alır; dolayısıyla birden fazla görevi yerine getirmeniz gerekebilir.

Süreç Yeniden Başlatmalarında Yüklemelere Devam Edilmesi

İşleminiz kapatılırsa devam eden tüm yüklemeler kesintiye uğrayacaktır. Ancak işlem yeniden başlatıldığında sunucudaki yükleme oturumunu sürdürerek yüklemeye devam edebilirsiniz. Bu, yüklemeyi dosyanın başından başlatmayarak zamandan ve bant genişliğinden tasarruf sağlayabilir.

Bunu yapmak için putFile aracılığıyla yüklemeye başlayın. Ortaya çıkan StorageTask getUploadSessionUri çağırın ve ortaya çıkan değeri kalıcı depolamaya (SharedPreferences gibi) kaydedin.

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

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

İşleminiz kesintiye uğramış bir yüklemeyle yeniden başladıktan sonra putFile'ı tekrar arayın. Ama bu sefer kurtarılan Uri'yi de geçiyoruz.

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

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

Seanslar bir hafta sürüyor. Süresi dolduktan sonra bir oturumu sürdürmeye çalışırsanız veya bir hatayla karşılaştıysanız, bir başarısızlık geri araması alırsınız. Dosyanın yüklemeler arasında değişmediğinden emin olmak sizin sorumluluğunuzdadır.

Hata yönetimi

Yerel dosyanın mevcut olmaması veya kullanıcının istenen dosyayı yükleme iznine sahip olmaması da dahil olmak üzere yükleme sırasında hataların ortaya çıkmasının çeşitli nedenleri vardır. Dokümanların Hataları İşleme bölümünde hatalar hakkında daha fazla bilgi bulabilirsiniz.

Tam Örnek

İlerleme izleme ve hata işleme özelliklerine sahip bir yüklemenin tam örneği aşağıda gösterilmektedir:

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

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

Dosyaları yüklediğinize göre artık bunları Cloud Storage'dan nasıl indireceğinizi öğrenelim.