Cloud Storage for Firebase позволяет быстро и легко загружать файлы в корзину Cloud Storage , предоставляемую и управляемую Firebase.
Загрузить файлы
Чтобы загрузить файл в Cloud Storage, вы сначала создаете ссылку на полный путь к файлу, включая имя файла.
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
, и облачное хранилище не может вывести по умолчанию из расширения файла, облачное хранилище использует 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.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"); } });
Обработка изменений жизненного цикла активности
Загрузки продолжаются в фоновом режиме даже после изменений жизненного цикла активности (например, представление диалогового окна или вращение экрана). Все прикрепленные вами слушатели также останутся подключенными. Это может привести к неожиданным результатам, если они будут вызваны после остановки активности.
Вы можете решить эту проблему, подписав своих прослушивателей на область действия, чтобы автоматически отменять их регистрацию, когда действие прекращается. Затем используйте метод 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. Но на этот раз также проходит 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, )
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.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 // ... } });
Теперь, когда вы загрузили файлы, давайте узнаем, как загрузить их из облачного хранилища.