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.

Przesyłanie plików

Aby przesłać plik do Cloud Storage, najpierw utwórz odwołanie do pełnej ścieżki pliku, w tym do 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

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

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

Nie możesz przesłać danych z odwołaniem do katalogu głównego zasobnika Cloud Storage. Plik referencyjny musi wskazywać adres URL elementu podrzędnego.

Przesyłanie danych z pamięci

Metoda putBytes() to najprostszy sposób na przesłanie 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.
    // ...
}

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() akceptuje byte[], więc wymaga, aby aplikacja przechowywała całą zawartość pliku w pamięci jednocześnie. Aby zmniejszyć wykorzystanie 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. Metoda 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.
    // ...
}

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

Przesyłanie z pliku lokalnego

Możesz przesyłać pliki lokalne na urządzeniu, takie jak zdjęcia i filmy z aparatu, za pomocą metody putFile(). Metoda 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.
    // ...
}

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

Pobieranie adresu URL do pobrania

Po przesłaniu pliku możesz uzyskać adres URL, aby go pobrać, 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
        // ...
    }
}

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

Dodaj metadane pliku

Podczas przesyłania plików możesz też dołączyć metadane. Te metadane zawierają typowe właściwości metadanych plików, takie jak name, size i contentType (powszechnie nazywane typem MIME). Metoda putFile() automatycznie wnioskuje typ MIME z rozszerzenia File, ale możesz zastąpić automatycznie wykryty typ, określając contentType w metadanych. Jeśli nie podasz wartości contentType, a Cloud Storage nie może wywnioskować wartości domyślnej z rozszerzenia pliku, Cloud Storage używa application/octet-stream. Więcej informacji o metadanych plików znajdziesz w sekcji Używanie metadanych plików.

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)

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

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, że przesyłanie kończy się niepowodzeniem i wyświetla się błąd informujący o anulowaniu przesyłania.

Kotlin

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

Monitorowanie postępu przesyłania

Możesz dodać detektory, aby obsługiwać powodzenie, niepowodzenie, postęp lub przerwy w zadaniu przesyłania:

Typ detektora Typowe zastosowanie
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 po pomyślnym zakończeniu zadania.
OnFailureListener Ten detektor jest wywoływany za każdym razem, gdy nie uda się przesłać danych. Może się tak zdarzyć z powodu przerw w dostępie do sieci, błędów autoryzacji lub anulowania zadania.

Metoda OnFailureListener jest wywoływana z instancją Exception. Inne detektory są wywoływane z obiektem UploadTask.TaskSnapshot. Ten obiekt jest niezmiennym widokiem zadania w momencie wystąpienia zdarzenia. Obiekt 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, trudny do odgadnięcia 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, w tym polu pojawi się przyczyna w postaci wyjątku.
getBytesTransferred long Łączna liczba bajtów, które zostały przesłane w momencie utworzenia 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 przez kolejne wywołanie metody putFile.
getMetadata StorageMetadata Zanim przesyłanie się zakończy, te metadane są wysyłane na serwer. Po zakończeniu przesyłania serwer zwraca te metadane.
getTask UploadTask Zadanie, które utworzyło ten zrzut. To zadanie umożliwia anulowanie, wstrzymanie lub wznowienie przesyłania.
getStorage StorageReference StorageReference użyty 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")
}

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

Obsługa zmian cyklu życia aktywności

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

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

Przykład poniżej pokazuje, jak to zrobić, a także jak zachować użytą ścieżkę do pliku referencyjnego w pamięci masowej.

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

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

Kontynuowanie przesyłania po ponownym uruchomieniu procesu

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

Aby to zrobić, zacznij przesyłać dane przez putFile. W wywołanym obiekcie StorageTask wywołaj metodę getUploadSessionUri i zapisz wynik 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.
    }
}

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

Po ponownym uruchomieniu procesu z przerwanym przesyłaniem ponownie wywołaj funkcję putFile. Tym razem jednak 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,
)

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

Sesje trwają tydzień. Jeśli spróbujesz wznowić sesję po jej wygaśnięciu lub po wystąpieniu błędu, otrzymasz wywołanie zwrotne z informacją o niepowodzeniu. Obowiązek zapewnienia, że plik nie zmienił się między przesłaniami, spoczywa na Tobie.

Obsługa błędów

Błędy podczas przesyłania mogą wystąpić z różnych powodów, np. gdy plik lokalny nie istnieje lub użytkownik nie ma uprawnień 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ępów 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
    // ...
}

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

Teraz, gdy pliki zostały przesłane, dowiedzmy się, jak je pobrać z usługi Cloud Storage.