Przesyłanie plików za pomocą Cloud Storage na Androida

Cloud Storage for Firebase umożliwia szybkie i łatwe przesyłanie plików do zasobnika Cloud Storage udostępnianego i zarządzanego przez Firebase.

Prześlij pliki

Aby przesłać plik do Cloud Storage, najpierw utwórz odniesienie do pełnej ścieżki pliku, w tym jego nazwy.

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

Po utworzeniu odpowiedniego odniesienia wywołaj metodę putBytes(), putFile() lub putStream(), aby przesłać plik do Cloud Storage.

Nie możesz przesyłać danych z odniesieniem do katalogu głównego zasobnika Cloud Storage bucket. Odniesienie musi wskazywać adres URL elementu podrzędnego.

Przesyłanie danych z pamięci

Metoda putBytes() to najprostszy sposób przesyłania pliku do Cloud Storage. putBytes() przyjmuje byte[] i zwraca UploadTask, którego możesz użyć do zarządzania stanem przesyłania i jego monitorowania.

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

Ponieważ putBytes() akceptuje byte[], wymaga, aby aplikacja przechowywała całą zawartość pliku w pamięci jednocześnie. Aby zużywać mniej pamięci, rozważ użycie putStream() lub putFile().

Przesyłanie ze strumienia

Metoda putStream() to najbardziej wszechstronny sposób przesyłania pliku do Cloud Storage. putStream() przyjmuje InputStream i zwraca UploadTask, którego możesz użyć do zarządzania stanem przesyłania i jego monitorowania.

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

Przesyłanie z pliku lokalnego

Za pomocą metody putFile() możesz przesyłać pliki lokalne na urządzeniu, takie jak zdjęcia i filmy z aparatu. putFile() przyjmuje File i zwraca UploadTask, którego możesz użyć do zarządzania stanem przesyłania i jego monitorowania.

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

Uzyskiwanie adresu URL pobierania

Po przesłaniu pliku możesz uzyskać adres URL do jego pobrania, wywołując metodę getDownloadUrl() w StorageReference:

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

Dodawanie metadanych pliku

Podczas przesyłania plików możesz też dołączyć metadane. Zawierają one typowe właściwości metadanych pliku, takie jak name, size i contentType (zwykle nazywany typem MIME). Metoda putFile() automatycznie wywnioskuje typ MIME z rozszerzenia File, ale możesz zastąpić automatycznie wykryty typ, określając contentType w metadanych. Jeśli nie podasz contentType, a Cloud Storage nie będzie w stanie wywnioskować domyślnego typu z rozszerzenia pliku, Cloud Storage użyje application/octet-stream. Więcej informacji o metadanych pliku znajdziesz w sekcji Korzystanie z metadanych pliku.

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

Zarządzaj przesyłaniem

Oprócz rozpoczynania przesyłania możesz je wstrzymywać, wznawiać i anulować za pomocą metod pause(), resume() i cancel(). Zdarzenia wstrzymania i wznowienia powodują odpowiednio zmiany stanu pause i progress. Anulowanie przesyłania powoduje jego niepowodzenie z błędem wskazującym, że zostało ono anulowane.

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

Monitorowanie postępu przesyłania

Możesz dodać detektory, które będą obsługiwać powodzenie, niepowodzenie, postęp lub wstrzymanie zadania przesyłania:

Typ detektora Typowe użycie
OnProgressListener Ten detektor jest wywoływany okresowo podczas przesyłania danych i może służyć do wypełniania wskaźnika przesyłania/pobierania.
OnPausedListener Ten detektor jest wywoływany za każdym razem, gdy zadanie zostanie wstrzymane.
OnSuccessListener Ten detektor jest wywoływany, gdy zadanie zostanie ukończone.
OnFailureListener Ten detektor jest wywoływany za każdym razem, gdy przesyłanie się nie powiedzie. Może się to zdarzyć z powodu przekroczenia limitu czasu sieci, błędów autoryzacji lub anulowania zadania.

OnFailureListener jest wywoływany z instancją Exception. Inne detektory są wywoływane z obiektem UploadTask.TaskSnapshot. Ten obiekt jest niezmiennym widokiem zadania w momencie wystąpienia zdarzenia. UploadTask.TaskSnapshot zawiera te właściwości:

Właściwość Typ Opis
getDownloadUrl String Adres URL, którego można użyć do pobrania obiektu. Jest to publiczny, nieprzewidywalny adres URL, który można udostępniać innym klientom. Ta wartość jest wypełniana po zakończeniu przesyłania.
getError Exception Jeśli zadanie się nie powiodło, ta właściwość będzie zawierać przyczynę w postaci wyjątku.
getBytesTransferred long Łączna liczba bajtów przesłanych w momencie wykonania tego zrzutu.
getTotalByteCount long Łączna liczba bajtów, które mają zostać przesłane.
getUploadSessionUri String Identyfikator URI, którego można użyć do kontynuowania tego zadania za pomocą innego wywołania putFile.
getMetadata StorageMetadata Przed zakończeniem przesyłania są to metadane wysyłane na serwer. Po zakończeniu przesyłania są to metadane zwracane przez serwer.
getTask UploadTask Zadanie, które utworzyło ten zrzut. Użyj tego zadania, aby anulować, wstrzymać lub wznowić przesyłanie.
getStorage StorageReference StorageReference użyte do utworzenia UploadTask.

Detektory zdarzeń UploadTask zapewniają prosty i skuteczny sposób monitorowania zdarzeń przesyłania.

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

Obsługa zmian w cyklu życia aktywności

Przesyłanie jest kontynuowane w tle nawet po zmianach w cyklu życia aktywności (np. po wyświetleniu okna lub obróceniu ekranu). Wszystkie dołączone detektory pozostaną dołączone. Jeśli zostaną wywołane po zatrzymaniu aktywności, może to spowodować nieoczekiwane wyniki.

Możesz rozwiązać ten problem, subskrybując detektory w zakresie aktywności, aby automatycznie je wyrejestrować po zatrzymaniu aktywności. Następnie, gdy aktywność zostanie ponownie uruchomiona, użyj metody getActiveUploadTasks, aby uzyskać zadania przesyłania, które są nadal uruchomione lub zostały niedawno zakończone.

Poniższy przykład pokazuje, jak to zrobić, a także jak utrwalić ścieżkę odniesienia do pamięci.

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 pobiera wszystkie aktywne zadania przesyłania w podanym odniesieniu i poniżej niego, więc może być konieczne obsłużenie wielu zadań.

Kontynuowanie przesyłania po ponownym uruchomieniu procesu

Jeśli proces zostanie wyłączony, wszystkie trwające przesyłania zostaną przerwane. Możesz jednak kontynuować przesyłanie po ponownym uruchomieniu procesu, wznawiając sesję przesyłania na serwerze. Pozwoli to zaoszczędzić czas i przepustowość, ponieważ nie trzeba będzie rozpoczynać przesyłania od początku pliku.

Aby to zrobić, rozpocznij przesyłanie za pomocą putFile. W wynikowym StorageTask wywołaj getUploadSessionUri i zapisz wynikową wartość w pamięci trwałej (np. 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

Po ponownym uruchomieniu procesu z przerwanym przesyłaniem ponownie wywołaj putFile. Tym razem przekaż też zapisany identyfikator 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

Sesje trwają tydzień. Jeśli spróbujesz wznowić sesję po jej wygaśnięciu lub jeśli wystąpił w niej błąd, otrzymasz wywołanie zwrotne z informacją o niepowodzeniu. Twoim obowiązkiem jest upewnienie się, że plik nie zmienił się między przesyłaniami.

Obsługa błędów

Błędy podczas przesyłania mogą wystąpić z wielu powodów, m.in. z powodu braku pliku lokalnego lub braku uprawnień użytkownika do przesłania żądanego pliku. Więcej informacji o błędach znajdziesz w sekcji Obsługa błędów w dokumentacji.

Pełny przykład

Poniżej znajdziesz pełny przykład przesyłania z monitorowaniem postępu i obsługą błędów:

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

Teraz, gdy już wiesz, jak przesyłać pliki, dowiedz się, jak je pobierać z Cloud Storage.