Загрузка файлов с помощью Cloud Storage на Android

Cloud Storage for Firebase позволяет быстро и легко загружать файлы в контейнер Cloud Storage предоставляемый и управляемый Firebase.

Загрузить файлы

Чтобы загрузить файл в Cloud Storage , сначала необходимо создать ссылку на полный путь к файлу, включая имя файла.

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

После создания соответствующей ссылки вы вызываете метод putBytes() , putFile() или putStream() для загрузки файла в Cloud Storage .

Вы не можете загружать данные, ссылаясь на корень вашего контейнера Cloud Storage . Ссылка должна указывать на дочерний URL.

Загрузка из данных в памяти

Метод putBytes() — это самый простой способ загрузить файл в Cloud Storage . putBytes() принимает byte[] и возвращает UploadTask , который можно использовать для управления и отслеживания состояния загрузки.

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

Поскольку putBytes() принимает byte[] , ваше приложение должно хранить в памяти всё содержимое файла одновременно. Для экономии памяти рассмотрите возможность использования putStream() или putFile() .

Загрузить из потока

Метод putStream() — наиболее универсальный способ загрузки файла в Cloud Storage . putStream() принимает InputStream и возвращает UploadTask , который можно использовать для управления и отслеживания состояния загрузки.

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

Загрузить из локального файла

Вы можете загружать локальные файлы на устройство, например фотографии и видео с камеры, с помощью метода putFile() . putFile() принимает File и возвращает UploadTask , который можно использовать для управления и отслеживания состояния загрузки.

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

Получить URL для загрузки

После загрузки файла вы можете получить URL-адрес для его загрузки, вызвав метод getDownloadUrl() в 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

Добавить метаданные файла

Вы также можете включать метаданные при загрузке файлов. Эти метаданные содержат типичные свойства метаданных файла, такие как name , size и contentType (обычно называемый типом MIME). Метод putFile() автоматически определяет тип MIME из расширения File , но вы можете переопределить автоматически определенный тип, указав contentType в метаданных. Если contentType не указан, и Cloud Storage не может определить значение по умолчанию из расширения файла, Cloud Storage использует application/octet-stream . Подробнее о метаданных файлов см. в разделе «Использование метаданных файлов».

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

Управление загрузками

Помимо запуска загрузки, вы можете приостанавливать, возобновлять и отменять её с помощью методов pause() , resume() и cancel() . События приостановки и возобновления вызывают изменения состояний pause и progress соответственно. Отмена загрузки приводит к сбою загрузки с сообщением об отмене.

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

Мониторинг хода загрузки

Вы можете добавить прослушиватели для обработки успешного выполнения, сбоя, прогресса или пауз в задаче загрузки:

Тип слушателя Типичное использование
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 

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

Обработка изменений жизненного цикла активности

Загрузка данных продолжается в фоновом режиме даже после изменения жизненного цикла активности (например, отображения диалогового окна или поворота экрана). Все прикреплённые вами слушатели также останутся прикреплёнными. Это может привести к непредвиденным результатам, если они будут вызваны после остановки активности.

Эту проблему можно решить, подписав слушателей на область действия, чтобы автоматически отменить их регистрацию после остановки действия. Затем используйте метод getActiveUploadTasks при перезапуске действия, чтобы получить задачи загрузки, которые всё ещё выполняются или недавно завершены.

Приведенный ниже пример демонстрирует это, а также показывает, как сохранить используемый путь ссылки на хранилище.

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 извлекает все активные задачи загрузки на уровне указанной ссылки и ниже, поэтому вам может потребоваться обработать несколько задач.

Продолжение загрузок после перезапуска процесса

Если ваш процесс будет остановлен, все текущие загрузки будут прерваны. Однако вы можете продолжить загрузку после перезапуска процесса, возобновив сеанс загрузки с сервером. Это может сэкономить время и пропускную способность, поскольку загрузка не будет начинаться с начала файла.

Для этого начните загрузку через putFile . В полученном StorageTask вызовите getUploadSessionUri и сохраните полученное значение в постоянном хранилище (например, 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

После перезапуска процесса с прерванной загрузкой снова вызовите putFile. Но на этот раз передайте также сохранённый 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

Сеанс длится одну неделю. При попытке возобновить сеанс после его истечения или в случае ошибки вы получите сообщение об ошибке. Вы несёте ответственность за сохранение файла между загрузками.

Обработка ошибок

Ошибки при загрузке могут возникать по ряду причин, включая отсутствие локального файла или отсутствие у пользователя прав на загрузку нужного файла. Подробнее об ошибках можно узнать в разделе «Обработка ошибок» документации.

Полный пример

Полный пример загрузки с мониторингом хода выполнения и обработкой ошибок показан ниже:

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

Теперь, когда вы загрузили файлы, давайте узнаем, как скачать их из Cloud Storage .