Облачное хранилище для Firebase позволяет быстро и легко загружать файлы в корзину облачного хранилища , предоставляемую и управляемую Firebase.
Загрузить файлы
Чтобы загрузить файл в облачное хранилище, вы сначала создаете ссылку на полный путь к файлу, включая имя файла.
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
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
Создав соответствующую ссылку, вы вызываете метод putBytes()
, putFile()
или putStream()
для загрузки файла в облачное хранилище.
Вы не можете загружать данные со ссылкой на корень вашей корзины Cloud Storage. Ваша ссылка должна указывать на дочерний URL.
Выгрузить из данных в памяти
Метод putBytes()
— самый простой способ загрузить файл в облачное хранилище. putBytes()
принимает byte[]
и возвращает UploadTask
, который можно использовать для управления и отслеживания состояния загрузки.
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. // ... }
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()
принимает byte[]
, требуется, чтобы ваше приложение одновременно хранило все содержимое файла в памяти. Рассмотрите возможность использования putStream()
или putFile()
, чтобы использовать меньше памяти.
Загрузить из потока
Метод putStream()
является наиболее универсальным способом загрузки файла в облачное хранилище. putStream()
принимает InputStream
и возвращает UploadTask
, который можно использовать для управления и отслеживания состояния загрузки.
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. // ... }
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. // ... } });
Загрузить из локального файла
Вы можете загружать на устройство локальные файлы, например фотографии и видео с камеры, с помощью метода putFile()
. putFile()
принимает File
и возвращает UploadTask
, который вы можете использовать для управления и отслеживания состояния загрузки.
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. // ... }
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. // ... } });
Получить URL-адрес загрузки
После загрузки файла вы можете получить URL-адрес для загрузки файла, вызвав метод getDownloadUrl()
для 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 // ... } }
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 // ... } } });
Добавить метаданные файла
Вы также можете включать метаданные при загрузке файлов. Эти метаданные содержат типичные свойства метаданных файла, такие как name
, size
и contentType
(обычно называемый типом MIME). Метод putFile()
автоматически определяет тип MIME из расширения File
, но вы можете переопределить автоматически определенный тип, указав contentType
в метаданных. Если вы не укажете contentType
и Cloud Storage не сможет вывести значение по умолчанию из расширения файла, Cloud Storage использует application/octet-stream
. Дополнительные сведения о метаданных файлов см. в разделе «Использование метаданных файлов».
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)
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);
Управление загрузками
Помимо запуска загрузки, вы можете приостанавливать, возобновлять и отменять загрузку с помощью методов pause()
, resume()
и cancel()
. События паузы и возобновления вызывают изменения состояния pause
и progress
соответственно. Отмена загрузки приводит к сбою загрузки с ошибкой, указывающей на то, что загрузка была отменена.
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()
Java
uploadTask = storageRef.child("images/mountains.jpg").putFile(file); // Pause the upload uploadTask.pause(); // Resume the upload uploadTask.resume(); // Cancel the upload uploadTask.cancel();
Мониторинг процесса загрузки
Вы можете добавить слушателей для обработки успеха, неудачи, прогресса или пауз в задаче загрузки:
Тип слушателя | Типичное использование |
---|---|
OnProgressListener | Этот прослушиватель периодически вызывается по мере передачи данных и может использоваться для заполнения индикатора загрузки/выгрузки. |
OnPausedListener | Этот прослушиватель вызывается каждый раз, когда задача приостанавливается. |
OnSuccessListener | Этот прослушиватель вызывается, когда задача успешно завершена. |
OnFailureListener | Этот прослушиватель вызывается каждый раз, когда загрузка не удалась. Это может произойти из-за тайм-аутов сети, сбоев авторизации или при отмене задачи. |
OnFailureListener
вызывается с экземпляром Exception
. Другие прослушиватели вызываются с помощью объекта UploadTask.TaskSnapshot
. Этот объект представляет собой неизменное представление задачи на момент возникновения события. UploadTask.TaskSnapshot
содержит следующие свойства:
Свойство | Тип | Описание |
---|---|---|
getDownloadUrl | String | URL-адрес, который можно использовать для загрузки объекта. Это общедоступный URL-адрес, который невозможно угадать, которым можно поделиться с другими клиентами. Это значение заполняется после завершения загрузки. |
getError | Exception | Если задача не удалась, это будет иметь причину как исключение. |
getBytesTransferred | long | Общее количество байтов, которые были переданы при создании этого моментального снимка. |
getTotalByteCount | long | Общее количество байтов, которое, как ожидается, будет загружено. |
getUploadSessionUri | String | URI, который можно использовать для продолжения этой задачи через другой вызов putFile. |
getMetadata | StorageMetadata | Перед завершением загрузки метаданные отправляются на сервер. После завершения загрузки это метаданные, возвращаемые сервером. |
getTask | UploadTask | Задача, которая создала этот снимок. Используйте это задание, чтобы отменить, приостановить или возобновить загрузку. |
getStorage | StorageReference | StorageReference используемый для создания UploadTask . |
Прослушиватели событий UploadTask
предоставляют простой и эффективный способ отслеживания событий загрузки.
Kotlin+KTX
// Observe state change events such as progress, pause, and resume // You'll need to import com.google.firebase.storage.ktx.component1 and // com.google.firebase.storage.ktx.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"); } });
Обработка изменений жизненного цикла активности
Загрузка продолжается в фоновом режиме даже после изменения жизненного цикла активности (например, представления диалогового окна или поворота экрана). Любые слушатели, которых вы прикрепили, также останутся подключенными. Это может привести к неожиданным результатам, если они будут вызваны после остановки действия.
Вы можете решить эту проблему, подписав своих слушателей с областью действия, чтобы автоматически отменять их регистрацию, когда действие прекращается. Затем используйте метод getActiveUploadTasks
при перезапуске действия, чтобы получить задачи загрузки, которые все еще выполняются или недавно завершены.
Пример ниже демонстрирует это, а также показывает, как сохранить используемый путь ссылки на хранилище.
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! // ... } } }
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
извлекает все активные задачи загрузки в указанной ссылке и ниже, поэтому вам может потребоваться обработать несколько задач.
Продолжение загрузки при перезапуске процесса
Если ваш процесс остановлен, любые выполняемые загрузки будут прерваны. Однако вы можете продолжить загрузку после перезапуска процесса, возобновив сеанс загрузки с сервером. Это может сэкономить время и пропускную способность, поскольку загрузка не начинается с начала файла.
Для этого начните загрузку через putFile
. В полученном StorageTask
вызовите getUploadSessionUri
и сохраните полученное значение в постоянном хранилище (например, 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. } }
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. } } });
После перезапуска процесса с прерванной загрузкой снова вызовите putFile. Но на этот раз также передайте спасенного Ури.
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, )
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);
Сеансы длятся одну неделю. Если вы попытаетесь возобновить сеанс после истечения срока его действия или в случае возникновения ошибки, вы получите обратный вызов с ошибкой. Вы несете ответственность за то, чтобы файл не изменился между загрузками.
Обработка ошибок
Существует ряд причин, по которым при загрузке могут возникать ошибки, в том числе отсутствие локального файла или отсутствие у пользователя разрешения на загрузку нужного файла. Дополнительную информацию об ошибках можно найти в разделе документации «Обработка ошибок» .
Полный пример
Полный пример загрузки с отслеживанием хода выполнения и обработкой ошибок показан ниже:
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.ktx.component1 and // com.google.firebase.storage.ktx.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 // ... } });
Теперь, когда вы загрузили файлы, давайте узнаем, как загрузить их из облачного хранилища.