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ępnionego i zarządzanego przez Firebase.

Prześlij pliki

Aby przesłać plik do usługi Cloud Storage, najpierw utwórz odwołanie do pełna ścieżka do pliku, w tym nazwa pliku.

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
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 odwołania możesz wywołać metodę putBytes(), putFile() lub putStream(), aby przesłać plik do usługi Cloud Storage.

Nie możesz przesłać danych odwołujących się do poziomu głównego Zasobnik Cloud Storage. Odwoływanie musi wskazywać adres URL podrzędny.

Prześlij z danych w pamięci

Metoda putBytes() to najprostszy sposób przesyłania do pliku Cloud Storage. putBytes() przyjmuje byte[] i zwraca UploadTask, za pomocą których możesz zarządzać stanem przesyłania i nim monitorować.

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.
    // ...
}
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[], aplikacja wymaga przechowywania całej i zawartość pliku w pamięci. Rozważ użycie funkcji putStream() lub putFile(), aby wykorzystywać mniej pamięci.

Przesyłanie ze strumienia

Metoda putStream() to najbardziej uniwersalny sposób przesyłania do pliku Cloud Storage. putStream() bierze InputStream i wraca UploadTask, za pomocą którego możesz zarządzać stanem przesyłania i nim monitorować.

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

Prześlij z pliku lokalnego

Pliki lokalne na urządzeniu, takie jak zdjęcia i filmy z aparatu, możesz przesłać za pomocą metody putFile(). putFile() przyjmuje File i zwraca UploadTask, za pomocą których możesz zarządzać stanem przesyłania i go monitorować.

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.
    // ...
}
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, aby go pobrać, wywołując metoda getDownloadUrl() w StorageReference:

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

Dodaj metadane pliku

Możesz też dołączyć metadane podczas przesyłania plików. Zawierają one typowe właściwości metadanych plików, takie jak name, size, i contentType (powszechnie określanych jako typ MIME). Metoda putFile() automatycznie określa typ MIME z rozszerzenia File, ale możesz zastąp automatycznie wykryty typ, podając w metadanych contentType. Jeśli nie podano contentType, więc Cloud Storage nie może wywnioskować domyślnie z rozszerzenia pliku, Cloud Storage używa application/octet-stream Zobacz Używanie metadanych pliku. .

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)
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 wstrzymywać, wznawiać i anulować przesyłanie za pomocą: metody pause(), resume() i cancel(). Wstrzymywanie i wznawianie wydarzeń podnieś odpowiednio zmiany stanu pause i progress. Anulowanie powoduje błąd przesyłania, który wskazuje, że przesyłanie zostało anulowane.

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()
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 do obsługi sukcesów, niepowodzeń, postępów i przerw w zadanie przesyłania:

Typ detektora Typowe zastosowanie
OnProgressListener Ten detektor jest wywoływany okresowo w miarę 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 po ukończeniu zadania.
OnFailureListener Ten detektor jest wywoływany za każdym razem, gdy przesyłanie się nie uda. Może to wynikać z przekroczenia limitu czasu sieci, błędów autoryzacji lub anulowania zadania.

Funkcja OnFailureListener jest wywoływana z wystąpieniem Exception. Inny powód detektory są wywoływane za pomocą obiektu UploadTask.TaskSnapshot. Ten obiekt jest niezmiennym widokiem zadania w momencie wystąpienia zdarzenia. Element UploadTask.TaskSnapshot zawiera te właściwości:

Właściwość Typ Opis
getDownloadUrl String Adres URL, za pomocą którego można pobrać obiekt. To jest publiczny, niemożliwe do odgadnięcia adres URL, który można udostępnić innym klientom. Ta wartość jest wypełniana po zakończeniu przesyłania.
getError Exception Jeśli zadanie się nie udało, jako wyjątek będzie widoczna przyczyna.
getBytesTransferred long Łączna liczba bajtów, które zostały przesłane podczas wykonywania tego zrzutu.
getTotalByteCount long Oczekiwana liczba bajtów do przesłania.
getUploadSessionUri String Identyfikator URI, którego można użyć do kontynuowania tego zadania przez kolejne wywołanie do putFile.
getMetadata StorageMetadata Przed zakończeniem przesyłania metadane są wysyłane na serwer. Po zakończeniu przesyłania te metadane zwrócone przez serwer.
getTask UploadTask Zadanie, które utworzyło ten zrzut. Wykonaj to zadanie, aby anulować, wstrzymać lub wznowić przesyłanie.
getStorage StorageReference StorageReference użyty do utworzenia UploadTask.

Detektory zdarzeń UploadTask umożliwiają w prosty i zaawansowany sposób monitorowanie przesyłania zdarzeń.

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")
}
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 zmianie cyklu życia aktywności (np. jak prezentację okna lub obrócenie ekranu). wszystkich podłączonych słuchaczy, pozostaną dołączone. Może to spowodować nieoczekiwane wyniki, jeśli wywołany po zatrzymaniu aktywności.

Aby rozwiązać ten problem, możesz subskrybować słuchaczy za pomocą zakresu aktywności, aby automatycznie anulować ich subskrypcję, gdy aktywność się zakończy. Następnie skorzystaj z Metoda getActiveUploadTasks po ponownym uruchomieniu aktywności w celu uzyskania zadań przesyłania nadal realizowane lub niedawno zakończone.

Przykład poniżej pokazuje to i także sposób trwałego zapisania ścieżki odwołania do pamięci.

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!
            // ...
        }
    }
}
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 z serwera podany numer referencyjny, więc może być konieczne wykonanie wielu zadań.

Kontynuowanie przesyłania po ponownym uruchomieniu procesu

Jeśli Twój proces się zakończy, wszystkie trwające operacje przesyłania zostaną przerwane. Możesz jednak kontynuować przesyłanie po ponownym uruchomieniu procesu, wznawiając z serwerem. Może to zaoszczędzić czas i przepustowość, ponieważ przesyłanie nie rozpocznie się od początku pliku.

W tym celu rozpocznij przesyłanie za pomocą usługi putFile. W wynikającym obiekcie StorageTask wywołaj funkcję getUploadSessionUri i zapisz otrzymaną wartość w trwałym magazynie (np. 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.
    }
}
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 i przerwaniu przesyłania wywołaj ponownie putFile. Ale tym razem również przekazać zapisany identyfikator URI.

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,
)
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 miały miejsce w ciągu ostatniego tygodnia. Jeśli spróbujesz wznowić sesję po jej zakończeniu wygasł lub wystąpił błąd, otrzymasz oddzwonienie w sprawie nieudanej transakcji. Twoim obowiązkiem jest dopilnowanie, aby plik nie został zmieniony przed przesłaniem.

Obsługa błędów

Błędy podczas przesyłania mogą wystąpić z różnych powodów, na przykład dlatego, że plik lokalny nie istnieje lub użytkownik nie ma uprawnień do przesłania odpowiedniego pliku. Więcej informacji o błędach znajdziesz w Obsługa błędów sekcji dokumentów.

Pełny przykład

Pełny przykład przesyłania z monitorowaniem postępu i obsługą błędów widać poniżej:

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
    // ...
}
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 masz już przesłane pliki, pobierz je od Cloud Storage.