Android'de Cloud Storage ile dosya yükleme

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

Dosya Yükle

Cloud Storage hizmetine dosya yüklemek için önce dosya adı da dahil olmak üzere dosyanın tam yoluna bir 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 hizmetine yüklemek için putBytes(), putFile() veya putStream() yöntemini çağırırsınız.

Cloud Storage paketinizin köküne referans içeren verileri yükleyemezsiniz. Referansınız bir alt URL'ye yönlendirmelidir.

Bellekteki verilerden yükle

putBytes() yöntemi, Cloud Storage hizmetine 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

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

Canlı yayından yükleme

putStream() yöntemi, Cloud Storage hizmetine 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

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. kameradaki fotoğraf ve videolar) yükleyebilirsiniz. putFile(), bir File alır ve yüklemenin durumunu yönetmek ve 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

Dosya 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 değer çı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ükleme 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 etkinlikleri, sırasıyla pause ve progress durum değişikliklerini tetikler. Yükleme işleminin iptal edilmesi, yüklemenin iptal edildiğini belirten bir hatayla yüklemenin başarısız olmasına neden olur.

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 durumunu izleme

Yükleme görevinizdeki başarı, başarısızlık, ilerleme veya duraklatma durumlarını işlemek için dinleyiciler ekleyebilirsiniz:

Dinleyici Türü Tipik Kullanım
OnProgressListener Bu dinleyici, veriler aktarılırken düzenli olarak çağrılır ve 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 başarısız olduğunda çağrılır. Bu durum, ağ zaman aşımı, yetkilendirme hataları veya görevi iptal etmeniz nedeniyle ortaya çıkabilir.

OnFailureListener, bir Exception örneğiyle çağrılır. Diğer dinleyiciler bir UploadTask.TaskSnapshot nesnesiyle çağrılır. Bu nesne, etkinliğin gerçekleştiği andaki 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şılabilen, herkese açık ve tahmin edilemeyen bir URL'dir. Bu değer, yükleme işlemi tamamlandığında doldurulur.
getError Exception Görev başarısız olursa bu alanda neden bir istisna olarak gösterilir.
getBytesTransferred long Bu anlık görüntü alındığında aktarılan toplam bayt sayısı.
getTotalByteCount long Yüklenmesi beklenen toplam bayt sayısı.
getUploadSessionUri String Bu göreve başka bir putFile çağrısı aracılığıyla devam etmek 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şleyiciler, yükleme etkinliklerini izlemek için basit ve güçlü bir yöntem 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şikliklerinden (ör. iletişim kutusu gösterme veya ekranı döndürme) sonra bile arka planda devam eder. Eklediğiniz dinleyiciler de ekli kalır. Bu durum, etkinlik durdurulduktan sonra çağrılırlarsa beklenmedik sonuçlara neden olabilir.

Bu sorunu çözmek için dinleyicilerinizi bir etkinlik kapsamına abone ederek etkinlik durduğunda kayıtlarının otomatik olarak iptal edilmesini sağlayabilirsiniz. Ardından, etkinlik yeniden başlatıldığında hâlâ çalışmakta olan veya yakın zamanda tamamlanan yükleme görevlerini almak için getActiveUploadTasks yöntemini kullanın.

Aşağıdaki örnekte bu durum gösterilmekte ve kullanılan depolama alanı referans yolunun nasıl kalıcı hale getirileceği de 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 referansta ve altındaki tüm etkin yükleme görevlerini alır. Bu nedenle, birden fazla görevi işlemeniz gerekebilir.

İşlem Yeniden Başlatıldığında Yüklemelere Devam Etme

İşleminiz kapatılırsa devam eden yüklemeler kesintiye uğrar. Ancak sunucuyla yükleme oturumunu devam ettirerek işlem yeniden başlatıldığında yüklemeye devam edebilirsiniz. Bu sayede, yükleme işlemini dosyanın başından başlatmayarak zamandan ve bant genişliğinden tasarruf edebilirsiniz.

Bunu yapmak için putFile üzerinden yüklemeye başlayın. Sonuçta elde edilen StorageTask nesnesinde getUploadSessionUri yöntemini ç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.
        }
    }
});

İşleminiz kesintiye uğrayan bir yüklemeyle yeniden başlatıldıktan sonra 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. Süresi dolmuş veya hata oluşmuş bir oturumu devam ettirmeye çalışırsanız hata geri çağırma işlevi alırsınız. Dosyanın yüklemeler arasında değişmediğinden emin olmak sizin sorumluluğunuzdadır.

Hata İşleme

Yükleme sırasında hata oluşmasının çeşitli nedenleri vardır. Örneğin, yerel dosyanın mevcut olmaması veya kullanıcının istenen dosyayı yükleme izninin olmaması. Hatalar hakkında daha fazla bilgiyi belgelerin Hataları İşleme bölümünde bulabilirsiniz.

Tam Örnek

İlerleme durumu izleme ve hata işleme ile yükleme işleminin tam bir örneği aşağıda gösterilmiştir:

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 de Cloud Storage üzerinden dosya indirmeyi öğrenelim.