Dateien mit Cloud Storage auf Android-Geräten herunterladen

Mit Cloud Storage for Firebase können Sie schnell und einfach Dateien aus einem von Firebase bereitgestellten und verwalteten Cloud Storage-Bucket herunterladen.

Referenz erstellen

Wenn Sie eine Datei herunterladen möchten, müssen Sie zuerst eine Cloud Storage-Referenz für die Datei erstellen, die Sie herunterladen möchten.

Sie können eine Referenz erstellen, indem Sie untergeordnete Pfade an den Stamm Ihres Cloud Storage-Buckets anhängen. Alternativ können Sie eine Referenz aus einer vorhandenen gs://- oder https://-URL erstellen, die auf ein Objekt in Cloud Storage verweist.

Kotlin

// Create a storage reference from our app
val storageRef = storage.reference

// Create a reference with an initial file path and name
val pathReference = storageRef.child("images/stars.jpg")

// Create a reference to a file from a Google Cloud Storage URI
val gsReference = storage.getReferenceFromUrl("gs://bucket/images/stars.jpg")

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
val httpsReference = storage.getReferenceFromUrl(
    "https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg",
)

Java

// Create a storage reference from our app
StorageReference storageRef = storage.getReference();

// Create a reference with an initial file path and name
StorageReference pathReference = storageRef.child("images/stars.jpg");

// Create a reference to a file from a Google Cloud Storage URI
StorageReference gsReference = storage.getReferenceFromUrl("gs://bucket/images/stars.jpg");

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
StorageReference httpsReference = storage.getReferenceFromUrl("https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg");

Dateien herunterladen

Sobald Sie eine Referenz haben, können Sie Dateien aus Cloud Storage herunterladen, indem Sie getBytes() oder getStream() aufrufen. Wenn Sie die Datei lieber mit einer anderen Bibliothek herunterladen möchten, können Sie mit getDownloadUrl() eine Download-URL abrufen.

In den Arbeitsspeicher herunterladen

Laden Sie die Datei mit der Methode getBytes() in ein byte[] herunter. Dies ist die einfachste Methode zum Herunterladen einer Datei, aber es muss der gesamte Inhalt der Datei in den Arbeitsspeicher geladen werden. Wenn Sie eine Datei anfordern, die größer ist als der verfügbare Speicher Ihrer App, stürzt Ihre App ab. Um Speicherprobleme zu vermeiden, werden für getBytes() maximal so viele Byte heruntergeladen. Legen Sie die maximale Größe auf einen Wert fest, den Ihre App verarbeiten kann, oder verwenden Sie eine andere Downloadmethode.

Kotlin

var islandRef = storageRef.child("images/island.jpg")

val ONE_MEGABYTE: Long = 1024 * 1024
islandRef.getBytes(ONE_MEGABYTE).addOnSuccessListener {
    // Data for "images/island.jpg" is returned, use this as needed
}.addOnFailureListener {
    // Handle any errors
}

Java

StorageReference islandRef = storageRef.child("images/island.jpg");

final long ONE_MEGABYTE = 1024 * 1024;
islandRef.getBytes(ONE_MEGABYTE).addOnSuccessListener(new OnSuccessListener<byte[]>() {
    @Override
    public void onSuccess(byte[] bytes) {
        // Data for "images/island.jpg" is returns, use this as needed
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Handle any errors
    }
});

In eine lokale Datei herunterladen

Mit der Methode getFile() wird eine Datei direkt auf ein lokales Gerät heruntergeladen. Verwenden Sie diese Methode, wenn Ihre Nutzer offline auf die Datei zugreifen oder die Datei in einer anderen App freigeben möchten. getFile() gibt ein DownloadTask zurück, mit dem Sie den Download verwalten und den Status des Downloads überwachen können.

Kotlin

islandRef = storageRef.child("images/island.jpg")

val localFile = File.createTempFile("images", "jpg")

islandRef.getFile(localFile).addOnSuccessListener {
    // Local temp file has been created
}.addOnFailureListener {
    // Handle any errors
}

Java

islandRef = storageRef.child("images/island.jpg");

File localFile = File.createTempFile("images", "jpg");

islandRef.getFile(localFile).addOnSuccessListener(new OnSuccessListener<FileDownloadTask.TaskSnapshot>() {
    @Override
    public void onSuccess(FileDownloadTask.TaskSnapshot taskSnapshot) {
        // Local temp file has been created
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Handle any errors
    }
});

Wenn Sie Ihren Download aktiv verwalten möchten, finden Sie weitere Informationen unter Downloads verwalten.

Daten über URL herunterladen

Wenn Sie bereits eine Downloadinfrastruktur haben, die auf URLs basiert, oder einfach eine URL zum Teilen benötigen, können Sie die Download-URL für eine Datei abrufen, indem Sie die Methode getDownloadUrl() für eine Cloud Storage-Referenz aufrufen.

Kotlin

storageRef.child("users/me/profile.png").downloadUrl.addOnSuccessListener {
    // Got the download URL for 'users/me/profile.png'
}.addOnFailureListener {
    // Handle any errors
}

Java

storageRef.child("users/me/profile.png").getDownloadUrl().addOnSuccessListener(new OnSuccessListener<Uri>() {
    @Override
    public void onSuccess(Uri uri) {
        // Got the download URL for 'users/me/profile.png'
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Handle any errors
    }
});

Bilder mit FirebaseUI herunterladen

FirebaseUI bietet einfache, anpassbare und einsatzbereite native mobile Bindungen, um Boilerplate-Code zu eliminieren und die Best Practices von Google zu fördern. Mit FirebaseUI können Sie Bilder aus Cloud Storage schnell und einfach herunterladen, im Cache speichern und anzeigen lassen. Dazu nutzen wir unsere Integration mit Glide.

Fügen Sie zuerst FirebaseUI zu Ihrer app/build.gradle hinzu:

dependencies {
    // FirebaseUI Storage only
    implementation 'com.firebaseui:firebase-ui-storage:9.0.0'
}

Anschließend können Sie Bilder direkt aus Cloud Storage in eine ImageView laden:

Kotlin

// Reference to an image file in Cloud Storage
val storageReference = Firebase.storage.reference

// ImageView in your Activity
val imageView = findViewById<ImageView>(R.id.imageView)

// Download directly from StorageReference using Glide
// (See MyAppGlideModule for Loader registration)
Glide.with(context)
    .load(storageReference)
    .into(imageView)

Java

// Reference to an image file in Cloud Storage
StorageReference storageReference = FirebaseStorage.getInstance().getReference();

// ImageView in your Activity
ImageView imageView = findViewById(R.id.imageView);

// Download directly from StorageReference using Glide
// (See MyAppGlideModule for Loader registration)
Glide.with(context)
        .load(storageReference)
        .into(imageView);

Änderungen im Aktivitätslebenszyklus verarbeiten

Downloads werden im Hintergrund fortgesetzt, auch wenn sich der Aktivitätslebenszyklus ändert, z. B. wenn ein Dialogfeld angezeigt oder der Bildschirm gedreht wird. Alle Listener, die Sie angehängt haben, bleiben angehängt. Das kann zu unerwarteten Ergebnissen führen, wenn sie nach dem Beenden der Aktivität aufgerufen werden.

Sie können dieses Problem beheben, indem Sie Ihre Listener mit einem Aktivitätsbereich abonnieren, damit sie automatisch abgemeldet werden, wenn die Aktivität beendet wird. Verwenden Sie dann die Methode getActiveDownloadTasks, wenn die Aktivität neu gestartet wird, um Downloadaufgaben abzurufen, die noch ausgeführt werden oder kürzlich abgeschlossen wurden.

Das folgende Beispiel veranschaulicht dies und zeigt auch, wie der verwendete Speicherreferenzpfad beibehalten wird.

Kotlin

override fun onSaveInstanceState(outState: Bundle) {
    super.onSaveInstanceState(outState)

    // If there's a download 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 a download in progress, get its reference and create a new StorageReference
    val stringRef = savedInstanceState.getString("reference") ?: return

    storageRef = Firebase.storage.getReferenceFromUrl(stringRef)

    // Find all DownloadTasks under this StorageReference (in this example, there should be one)
    val tasks = storageRef.activeDownloadTasks

    if (tasks.size > 0) {
        // Get the task monitoring the download
        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 a download 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 a download 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 DownloadTasks under this StorageReference (in this example, there should be one)
    List<FileDownloadTask> tasks = mStorageRef.getActiveDownloadTasks();
    if (tasks.size() > 0) {
        // Get the task monitoring the download
        FileDownloadTask task = tasks.get(0);

        // Add new listeners to the task using an Activity scope
        task.addOnSuccessListener(this, new OnSuccessListener<FileDownloadTask.TaskSnapshot>() {
            @Override
            public void onSuccess(FileDownloadTask.TaskSnapshot state) {
                // Success!
                // ...
            }
        });
    }
}

Fehler beheben

Es gibt eine Reihe von Gründen, warum beim Herunterladen Fehler auftreten können. Dazu gehören, dass die Datei nicht vorhanden ist oder der Nutzer keine Berechtigung hat, auf die gewünschte Datei zuzugreifen. Weitere Informationen zu Fehlern finden Sie in der Dokumentation im Abschnitt Fehlerbehandlung.

Vollständiges Beispiel

Ein vollständiges Beispiel für einen Download mit Fehlerbehandlung finden Sie unten:

Kotlin

storageRef.child("users/me/profile.png").getBytes(Long.MAX_VALUE).addOnSuccessListener {
    // Use the bytes to display the image
}.addOnFailureListener {
    // Handle any errors
}

Java

storageRef.child("users/me/profile.png").getBytes(Long.MAX_VALUE).addOnSuccessListener(new OnSuccessListener<byte[]>() {
    @Override
    public void onSuccess(byte[] bytes) {
        // Use the bytes to display the image
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Handle any errors
    }
});

Sie können auch Metadaten für Dateien abrufen und aktualisieren, die in Cloud Storage gespeichert sind.