Dateien mit Cloud Storage auf Android-Geräten hochladen

Cloud Storage for Firebase können Sie schnell und einfach Dateien in einen Cloud Storage-Bucket hochladen, der von Firebase bereitgestellt und verwaltet wird.

Dateien hochladen

Wenn Sie eine Datei in Cloud Storage hochladen möchten, erstellen Sie zuerst einen Verweis auf den vollständigen Pfad der Datei, einschließlich des Dateinamens.

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

Nachdem Sie einen entsprechenden Verweis erstellt haben, rufen Sie die putBytes(), putFile(), oder putStream() Methode auf, um die Datei in Cloud Storage hochzuladen.

Sie können keine Daten mit einem Verweis auf das Stammverzeichnis Ihres Cloud Storage Buckets hochladen. Ihr Verweis muss auf eine untergeordnete URL verweisen.

Aus Daten im Arbeitsspeicher hochladen

Die Methode putBytes() ist die einfachste Möglichkeit, eine Datei in Cloud Storage hochzuladen. putBytes() verwendet ein byte[] und gibt ein UploadTask zurück, mit dem Sie den Status des Uploads verwalten und beobachten können.

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

Da putBytes() ein byte[] akzeptiert, muss Ihre App den gesamten Inhalt einer Datei gleichzeitig im Arbeitsspeicher speichern. Verwenden Sie putStream() oder putFile(), um weniger Arbeitsspeicher zu verwenden.

Aus einem Stream hochladen

Die Methode putStream() ist die vielseitigste Möglichkeit, eine Datei in Cloud Storage hochzuladen. putStream() verwendet ein InputStream und gibt ein UploadTask zurück, mit dem Sie den Status des Uploads verwalten und beobachten können.

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

Aus einer lokalen Datei hochladen

Mit der Methode putFile() können Sie lokale Dateien auf dem Gerät hochladen, z. B. Fotos und Videos von der Kamera. putFile() verwendet ein File und gibt ein UploadTask zurück, mit dem Sie den Status des Uploads verwalten und beobachten können.

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

Download-URL abrufen

Nach dem Hochladen einer Datei können Sie eine URL zum Herunterladen der Datei abrufen, indem Sie die Methode getDownloadUrl() für die StorageReference aufrufen:

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

Dateimetadaten hinzufügen

Sie können beim Hochladen von Dateien auch Metadaten einfügen. Diese Metadaten enthalten typische Dateimetadatenattribute wie name, size und contentType (allgemein als MIME-Typ bezeichnet). Die putFile() Methode leitet den MIME-Typ automatisch aus der File Erweiterung ab. Sie können den automatisch erkannten Typ jedoch überschreiben, indem Sie contentType in den Metadaten angeben. Wenn Sie keinen contentType angeben und Cloud Storage keinen Standardwert aus der Dateierweiterung ableiten kann, verwendet Cloud Storage application/octet-stream. Weitere Informationen zu Dateimetadaten finden Sie im Abschnitt Dateimetadaten verwenden.

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

Uploads verwalten

Sie können Uploads nicht nur starten, sondern auch mit den Methoden pause(), resume() und cancel() pausieren, fortsetzen und abbrechen. Bei Ereignissen zum Pausieren und Fortsetzen werden die Statusänderungen pause bzw. progress ausgelöst. Wenn Sie einen Upload abbrechen, schlägt er mit einem Fehler fehl, der darauf hinweist, dass der Upload abgebrochen wurde.

Kotlin

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

Upload-Fortschritt beobachten

Sie können Listener hinzufügen, um Erfolg, Fehler, Fortschritt oder Pausen in Ihrer Upload-Aufgabe zu verarbeiten:

Listener-Typ Typische Verwendung
OnProgressListener Dieser Listener wird regelmäßig aufgerufen, wenn Daten übertragen werden, und kann verwendet werden, um eine Anzeige für Uploads/Downloads zu füllen.
OnPausedListener Dieser Listener wird immer aufgerufen, wenn die Aufgabe pausiert wird.
OnSuccessListener Dieser Listener wird aufgerufen, wenn die Aufgabe erfolgreich abgeschlossen wurde.
OnFailureListener Dieser Listener wird immer aufgerufen, wenn der Upload fehlgeschlagen ist. Das kann aufgrund von Netzwerk-Time-outs, Autorisierungsfehlern oder wenn Sie die Aufgabe abbrechen, passieren.

OnFailureListener wird mit einer Exception-Instanz aufgerufen. Andere Listener werden mit einem UploadTask.TaskSnapshot-Objekt aufgerufen. Dieses Objekt ist eine unveränderliche Ansicht der Aufgabe zum Zeitpunkt des Ereignisses. Ein UploadTask.TaskSnapshot enthält die folgenden Attribute:

Attribut Typ Beschreibung
getDownloadUrl String Eine URL, die zum Herunterladen des Objekts verwendet werden kann. Dies ist eine öffentliche, nicht erratbare URL, die für andere Clients freigegeben werden kann. Dieser Wert wird nach Abschluss eines Uploads ausgefüllt.
getError Exception Wenn die Aufgabe fehlgeschlagen ist, enthält dieses Feld die Ursache als Ausnahme.
getBytesTransferred long Die Gesamtzahl der Byte, die übertragen wurden, als dieser Snapshot erstellt wurde.
getTotalByteCount long Die Gesamtzahl der Byte, die hochgeladen werden sollen.
getUploadSessionUri String Eine URI, die verwendet werden kann, um diese Aufgabe über einen weiteren Aufruf von „putFile“ fortzusetzen.
getMetadata StorageMetadata Vor Abschluss eines Uploads sind dies die Metadaten, die an den Server gesendet werden. Nach Abschluss des Uploads sind dies die Metadaten, die vom Server zurückgegeben werden.
getTask UploadTask Die Aufgabe, mit der dieser Snapshot erstellt wurde. Mit dieser Aufgabe können Sie den Upload abbrechen, pausieren oder fortsetzen.
getStorage StorageReference Die StorageReference, die zum Erstellen von UploadTask verwendet wurde.

Die Ereignis-Listener von UploadTask bieten eine einfache und leistungsstarke Möglichkeit, Upload-Ereignisse zu beobachten.

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

Änderungen im Aktivitätslebenszyklus verarbeiten

Uploads werden auch nach Änderungen im Aktivitätslebenszyklus (z. B. beim Anzeigen eines Dialogfelds oder Drehen des Bildschirms) im Hintergrund fortgesetzt. Alle Listener, die Sie angehängt haben, bleiben ebenfalls angehängt. Das kann zu unerwarteten Ergebnissen führen, wenn sie aufgerufen werden, nachdem die Aktivität beendet wurde.

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 getActiveUploadTasks, wenn die Aktivität neu gestartet wird, um Upload-Aufgaben abzurufen, die noch ausgeführt werden oder kürzlich abgeschlossen wurden.

Das folgende Beispiel veranschaulicht dies und zeigt auch, wie der verwendete Speicherverweis-Pfad beibehalten wird.

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!
            // ...
        }
    }
}
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 ruft alle aktiven Upload-Aufgaben an und unterhalb des angegebenen Verweises ab. Daher müssen Sie möglicherweise mehrere Aufgaben verarbeiten.

Uploads nach Neustarts des Prozesses fortsetzen

Wenn Ihr Prozess beendet wird, werden alle laufenden Uploads unterbrochen. Sie können jedoch mit dem Hochladen fortfahren, sobald der Prozess neu gestartet wird, indem Sie die Upload-Sitzung mit dem Server fortsetzen. So können Sie Zeit und Bandbreite sparen, da der Upload nicht am Anfang der Datei gestartet wird.

Beginnen Sie dazu mit dem Hochladen über putFile. Rufen Sie für die resultierende StorageTask die Methode getUploadSessionUri auf und speichern Sie den resultierenden Wert im persistenten Speicher (z. B. SharedPreferences).

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

Nachdem Ihr Prozess mit einem unterbrochenen Upload neu gestartet wurde, rufen Sie „putFile“ noch einmal auf. Übergeben Sie dieses Mal aber auch die gespeicherte URI.

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

Sitzungen dauern eine Woche. Wenn Sie versuchen, eine Sitzung fortzusetzen, nachdem sie abgelaufen ist oder ein Fehler aufgetreten ist, erhalten Sie einen Fehler-Callback. Sie sind dafür verantwortlich, dass sich die Datei zwischen den Uploads nicht geändert hat.

Fehlerbehandlung

Es gibt eine Reihe von Gründen, warum beim Hochladen Fehler auftreten können. Dazu gehören beispielsweise, dass die lokale Datei nicht vorhanden ist oder der Nutzer keine Berechtigung zum Hochladen der gewünschten Datei hat. Weitere Informationen zu Fehlern finden Sie im Abschnitt Fehlerbehebung in der Dokumentation.

Vollständiges Beispiel

Ein vollständiges Beispiel für einen Upload mit Fortschrittsüberwachung und Fehlerbehandlung finden Sie unten:

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

Nachdem Sie Dateien hochgeladen haben, erfahren Sie jetzt, wie Sie sie herunterladen aus Cloud Storage.