Android'de Cloud Storage ile dosya yükleme

Cloud Storage for Firebase, dosyalarınızı bir API'ye hızla ve kolayca yüklemenizi sağlar. Sağlanan Cloud Storage paketi Firebase tarafından yönetilir.

Dosya Yükle

Bir dosyayı Cloud Storage'a yüklemek için önce tam yolunu sunar.

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

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 putBytes() numarasını ararsınız. Dosyayı yüklemek için putFile() veya putStream() yöntemi Cloud Storage'a taşıdık.

Cloud Storage paketi. Referansınız bir alt URL'ye yönlendirmelidir.

Bellekteki verilerden yükle

putBytes() yöntemi, veri yüklemenin en basit yoludur Cloud Storage'a taşımanızı sağlar. putBytes() bir byte[] alıp şunu döndürür: UploadTask (yüklemenin durumunu yönetmek ve izlemek için kullanabilirsiniz).

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

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() bir byte[] kabul ettiği için uygulamanızın dosyanın içeriğini aynı anda görüntülemek için kullanır. putStream() veya Daha az bellek kullanmak için putFile().

Akıştan yükleme

putStream() yöntemi, veri yüklemenin en çok yönlü yoludur. Cloud Storage'a taşımanızı sağlar. putStream() InputStream alıp geri döner Yükleme işleminin durumunu yönetmek ve izlemek için kullanabileceğiniz bir UploadTask.

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

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 dosyadan yükle

Cihazdaki yerel dosyaları (ör. fotoğraflar ve videolar) putFile() yöntemiyle kameranızı açın. putFile() bir File alıp şunu döndürür: UploadTask. Yükleme işleminin durumunu yönetmek ve izlemek için kullanabilirsiniz.

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

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 al

Bir dosya yükledikten sonra, StorageReference üzerindeki getDownloadUrl() yöntemi:

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

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 veri; name, size, ve contentType (genellikle MIME türü olarak adlandırılır). putFile() yöntemi MIME türünü File uzantısından otomatik olarak çıkarır, ancak Meta veride contentType belirterek otomatik olarak algılanan türü geçersiz kılabilirsiniz. Eğer bir contentType sağlamazsanız Cloud Storage, Cloud Storage, dosya uzantısından varsayılan olarak application/octet-stream. Bkz. Dosya Meta Verilerini Kullanma 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)

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 aşağıdakileri kullanarak yüklemeleri duraklatabilir, devam ettirebilir ve iptal edebilirsiniz: pause(), resume() ve cancel() yöntemleri. Etkinlikleri duraklatma ve devam ettirme sırasıyla pause ve progress durum değişikliklerini artır. Bir bu, yüklemenin başarısız olmasına neden olur. Bu hata, yüklemenin yükleme iptal edildi.

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

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 İlerlemesini İzleme

Projenizde başarıya, başarısızlığa, ilerlemeye veya duraklamalara yükleme görevi:

Dinleyici Türü Tipik Kullanım
OnProgressListener Bu işleyici, veriler aktarılırken düzenli olarak çağrılır ve yükleme/indirme göstergesini doldurmak için kullanılabilir.
OnPausedListener Görev her duraklatıldığında bu işleyici çağrılır.
OnSuccessListener Bu işleyici, görev başarıyla tamamlandığında çağrılır.
OnFailureListener Yükleme başarısız olduğunda bu işleyici çağrılır. Bu durum ağ zaman aşımları, yetkilendirme hataları veya görevi iptal etmeniz nedeniyle oluşabilir.

OnFailureListener, Exception örneğiyle çağrılır. Diğer işleyiciler bir UploadTask.TaskSnapshot nesnesiyle çağrılır. Bu nesne, etkinliğin gerçekleştiği anda görevin sabit 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 müşterilerle paylaşılabilecek, herkese açık ve tahmin edilemeyen bir URL'dir. Bu değer, yükleme işlemi tamamlandıktan sonra doldurulur.
getError Exception Görev başarısız olursa bu neden bir İstisna 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 Başka bir putFile çağrısı aracılığıyla bu göreve devam etmek için kullanılabilecek bir URI.
getMetadata StorageMetadata Yükleme tamamlanmadan önce sunucuya gönderilen meta veri budur. Yükleme tamamlandıktan sonra, sunucu tarafından döndürülen meta veriler bu şekildedir.
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 öğesini oluşturmak için kullanılan StorageReference.

UploadTask etkinlik işleyicileri, web sitenizin performansını izlemek için basit ve güçlü bir yöntem yükleme etkinliğidir.

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

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 Yönetme

Etkinlik yaşam döngüsü değişikliklerinden sonra bile yüklemeler arka planda devam eder (ör. (ör. iletişim kutusu gösterme veya ekranı döndürme) Eklediğiniz dinleyiciler ekli olarak kalacak. Bu durum, kalite standartlarının , etkinlik durdurulduktan sonra çağrılır.

Dinleyicilerinize etkinlik kapsamı aboneliği sunarak bu sorunu çözebilirsiniz Etkinlik durduğunda çocuğunuzun kaydını otomatik olarak iptal edebilirsiniz. Daha sonra, Yükleme görevlerini almak için etkinlik yeniden başlatıldığında getActiveUploadTasks yöntemi üzerinde çalıştığınız proje planı taslağınızı açın.

Aşağıdaki örnekte bu ve depolama alanının nasıl kalıcı olarak tutulacağı gösterilmiştir. referans yolu kullanılır.

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

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, şu değerde ve altındaki tüm etkin yükleme görevlerini alır: referans gösterilir, bu nedenle birden çok görevi yerine getirmeniz gerekebilir.

İşlem Yeniden Başlatmalarında Yüklemelere Devam Etme

İşleminiz kapatılırsa devam eden yükleme işlemleri kesintiye uğrar. Ancak işlem yeniden başladığında yükleme işlemini devam ettirerek oturum açın. Bu yöntem, dosyanın başlangıcından itibaren yüklemeyi başlatır.

Bunun için putFile ile yüklemeye başlayın. Elde edilen StorageTask üzerinde, getUploadSessionUri komutunu çağırır ve sonuç olarak ortaya çıkan değeri kalıcı depolama alanına kaydeder (örneğin, SharedPreferences).

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

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şladıktan sonra putFile'ı tekrar çağırın. Ama bu kez kaydedilen URI'yı da iletir.

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

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. Şu andan sonra oturumu devam ettirmeye çalışırsanız: süresi dolmuşsa veya bir hatayla karşılaştıysa bir hata geri araması 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 hataların oluşmasının birkaç nedeni vardır: yerel dosya mevcut değil veya kullanıcının yükleme izni yok seçin. Hatalarla ilgili daha fazla bilgiyi Hataları İşleme bölümünde bulabilirsiniz.

Tam Örnek

İlerleme durumu izleme ve hata giderme özelliklerini içeren tam bir yükleme örneği aşağıda gösterilmiştir:

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

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

Artık dosya yüklediğinize göre bunları indirin Cloud Storage'dan edinilebilir.