Russian (Pусский) translation by Ilya Nikov (you can also view the original English article)
Во время конференции Google I/O в 2016 году Firebase была вновь представлена сообществу разработчиков в качестве основного инструмента для быстрой поддержки веб-страниц и мобильных приложений. В этом руководстве вы познакомитесь с функциями хранения и извлечения файлов, доступными для ваших приложений Android.
Чтобы узнать больше о базе данных Firebase в реальном времени, аналитике, отчетах о сбоях и аутентификации, ознакомьтесь с некоторыми нашими другими учебниками здесь, в Envato Tuts +.
Настройка проверки подлинности
Для краткости мы пропустим общий процесс настройки Firebase в вашем приложении Android и консоли Firebase. Если вы впервые пытаетесь использовать Firebase в приложении, я предлагаю сначала проверить статью Ashraff Hathibelagal «Начало работы с Firebase для Android».
Прежде чем вы сможете начать использовать Firebase Storage, вам необходимо либо убедиться, что ваш пользователь аутентифицирован, либо изменить правила проверки подлинности в консоли Firebase, чтобы позволить пользователям, не прошедшим проверку подлинности, получить доступ и загрузить файлы. Чтобы все было просто, мы сделаем последнее. Начнем с перехода в раздел Storage, выбрав Storage в левом меню.
Затем вы заметите, что в верхней части экрана Storage находятся две вкладки: Файлы и Правила.
Перейдите на вкладку «Правила», и в строке allow read, write: if request.auth != null; измените != на == и нажмите кнопку ОПУБЛИКОВАТЬ.
Теперь любой пользователь вашего приложения должен иметь возможность скачивать или загружать файлы из вашего Firebase-сервера. Хотя это не идеально подходит для production окружения, это значительно облегчит изучение хранилища Firebase без необходимости разбираться в коде аутентификации.
Загрузка файлов вручную
Хотя возможность загрузки файлов из приложения очень удобная, иногда вы просто хотите хранить файлы где-то, где можно легко получить доступ и скачать их в ваше приложение. Здесь вы можете загружать файлы вручную из Firebase Console. На вкладке «Файлы» вы увидите синюю кнопку «Загрузить файл».
Щелкните ее и выберите файл, который вы хотите загрузить, и он появится в вашем хранилище Firebase.
При выборе этого файла на консоли будет отображаться подробное представление, позволяющее вам проверять файлы, которые ранее были загружены.
Загрузка файлов из приложения для Android
Теперь, когда у вас есть файл, хранящийся в Firebase, давайте скачаем его в приложение. Мы будем использовать простой макет в нашей MainActivity, который содержит ImageView с id изображения.
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="https://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent">
<ImageView
android:id="@+id/image"
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
</RelativeLayout>
Чтобы получить доступ к файлам хранилища Firebase, вам нужно сначала получить ссылку на объект FirebaseStorage, а затем создать StorageReference на URL вашего проекта и файл, который вы хотите загрузить. URL вашего проекта можно найти в верхней части раздела «Файлы» Хранилища в Firebase Console.
FirebaseStorage storage = FirebaseStorage.getInstance();
StorageReference storageRef = storage.getReferenceFromUrl("gs://tutsplus-firebase.appspot.com").child("android.jpg");
Затем вы можете создать объект File и попытаться загрузить нужный файл, вызвав getFile у вашего StorageReference с новым объектом File, переданным в качестве параметра. Поскольку эта операция выполняется асинхронно, вы можете добавить OnSuccessListener и OnFailureListener к вашему вызову, чтобы справляться с непредвиденными обстоятельствами.
try {
final File localFile = File.createTempFile("images", "jpg");
storageRef.getFile(localFile).addOnSuccessListener(new OnSuccessListener<FileDownloadTask.TaskSnapshot>() {
@Override
public void onSuccess(FileDownloadTask.TaskSnapshot taskSnapshot) {
Bitmap bitmap = BitmapFactory.decodeFile(localFile.getAbsolutePath());
mImageView.setImageBitmap(bitmap);
}
}).addOnFailureListener(new OnFailureListener() {
@Override
public void onFailure(@NonNull Exception exception) {
}
});
} catch (IOException e ) {}
В onSuccess() из OnSuccessListener вы можете взять объект FileDownloadTask.TaskSnapshot и получить файл, из которого мы установим изображение в наш ImageView.
Загрузка файлов в виде массива байтов
Если вам нужно только загрузить файл в виде byte[], и он не нужен вам в качестве файла, что является более вероятным случаем при загрузке изображения в ImageView, тогда вы можете получить байты аналогичным образом.
final long ONE_MEGABYTE = 1024 * 1024;
storageRef.getBytes(ONE_MEGABYTE).addOnSuccessListener(new OnSuccessListener<byte[]>() {
@Override
public void onSuccess(byte[] bytes) {
Bitmap bitmap = BitmapFactory.decodeByteArray(bytes, 0, bytes.length);
mImageView.setImageBitmap(bitmap);
}
});
Получение URL-адреса файла
Могут быть ситуации, когда вам не нужны фактические данные для сохраненного файла, но скорее будет нужен URL. Вы можете сделать это аналогично двум последним примерам, используя метод getDownloadUrl() на вашем StorageReference, который даст вам Uri, указывающий на местоположение файла.
storageRef.getDownloadUrl().addOnSuccessListener(new OnSuccessListener<Uri>() {
@Override
public void onSuccess(Uri uri) {
Log.e("Tuts+", "uri: " + uri.toString());
//Handle whatever you're going to do with the URL here
}
});
Вышеуказанный метод распечатает URL-адрес изображения, которое мы вручную загрузили ранее в Android-мониторе.
E/Tuts+: uri: https://firebasestorage.googleapis.com/v0/b/tutsplus-firebase.appspot.com/o/android.jpg?alt=media&token=1828111c-78e7-4640-b418-c65e7571576a
Загрузка из Android приложения
Теперь, когда вы знаете, как загружать файлы из Firebase, пришло время поработать над загрузками. Как вы видели при загрузке из Firebase Storage, процессы для каждой формы ваших данных довольно схожи. Загрузка не отличается, поэтому мы просто погрузимся в то, как вы можете перемещать файлы из своего приложения в Firebase Storage.
Загрузка массива байтов
Как и при загрузке, вам нужно будет получить ссылку на объект FirebaseStorage и создать ссылку на место хранения вашего нового файла в качестве StorageReference. В этом примере мы покажем ic_launcher.png в нашем ImageView, а затем загрузим его как массив байтов.
FirebaseStorage storage = FirebaseStorage.getInstance();
StorageReference storageReference = storage.getReferenceFromUrl("gs://tutsplus-firebase.appspot.com").child("ic_launcher.png");
Затем нам нужно будет получить массив байтов из изображения, хранящегося в памяти, через ImageView. Это делается путем извлечения его в виде Bitmap, сжимающего его в ByteArrayOutputStream, а затем превращая его в byte[].
mImageView.setDrawingCacheEnabled(true); mImageView.measure(View.MeasureSpec.makeMeasureSpec(0, View.MeasureSpec.UNSPECIFIED), View.MeasureSpec.makeMeasureSpec(0, View.MeasureSpec.UNSPECIFIED)); mImageView.layout(0, 0, mImageView.getMeasuredWidth(), mImageView.getMeasuredHeight()); mImageView.buildDrawingCache(); Bitmap bitmap = Bitmap.createBitmap(mImageView.getDrawingCache()); ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); bitmap.compress(Bitmap.CompressFormat.JPEG, 100, outputStream); byte[] data = outputStream.toByteArray();
Наконец, вы можете создать UploadTask, вызвав putBytes(byte[]), чтобы загрузить изображение в Firebase. В этом UploadTask также могут быть связанные с ним OnSuccessListener и OnFailureListener.
UploadTask uploadTask = storageReference.putBytes(data);
uploadTask.addOnFailureListener(new OnFailureListener() {
@Override
public void onFailure(@NonNull Exception exception) {
}
}).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() {
@Override
public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) {
}
});
Когда вы проверяете страницу хранилища Firebase Console, вы должны увидеть ic_launcher.png в своем списке файлов.
Загрузка из InputStream или файла
Теперь, когда вы знаете, как загрузить массив байтов, два других типа загрузок должны быть достаточно интуитивно понятными. Допустим, у нас есть текстовый файл с именем test.txt в нашей папке с исходными ресурсами. Мы можем прочитать его в InputStream, а затем загрузить его, используя метод putStream(InputStream) у StorageReference.
FirebaseStorage storage = FirebaseStorage.getInstance();
StorageReference storageReference = storage.getReferenceFromUrl("gs://tutsplus-firebase.appspot.com").child("test.txt");
InputStream stream = getResources().openRawResource(R.raw.test);
UploadTask uploadTask = storageReference.putStream(stream);
Загрузка существующего файла так же делается довольно легко: просто получите ссылку на файл и вызовите putFile(Uri) с URI, указывающим на ваш файл. В этом примере мы просто создадим пустой файл temp в нашем коде.
FirebaseStorage storage = FirebaseStorage.getInstance();
StorageReference storageReference = storage.getReferenceFromUrl("gs://tutsplus-firebase.appspot.com").child("test2.txt");
File file = null;
try {
file = File.createTempFile("test2", "txt");
} catch( IOException e ) {
}
UploadTask uploadTask = storageReference.putFile(Uri.fromFile(file));
Управление загрузками и использование обратных вызовов
Пока файлы, которые мы загрузили до сих пор, были небольшими, могут быть случаи, когда у вас будут большие загрузки, которые занимают достаточно много времени. Firebase предоставляет несколько методов с UploadTask, которые позволят вам контролировать поток загрузки и слушать изменения прогресса и состояния. Эти методы включают pause(), resume() и cancel(). pause() и resume() позволят вам приостановить и возобновить UploadTask, тогда как cancel() полностью остановит ее. Кроме того, вы можете использовать OnPauseListener и OnProgressListener, чтобы отслеживать состояния загрузки и состояния паузы.
mPause = (Button) findViewById(R.id.pause);
mResume = (Button) findViewById(R.id.resume);
mPause.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
mUploadTask.pause();
}
});
mResume.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
mUploadTask.resume();
}
});
FirebaseStorage storage = FirebaseStorage.getInstance();
StorageReference storageReference = storage.getReferenceFromUrl("gs://tutsplus-firebase.appspot.com").child("image.jpg");
InputStream stream = getResources().openRawResource(R.raw.image);
mUploadTask = storageReference.putStream(stream);
mUploadTask.addOnPausedListener(new OnPausedListener<UploadTask.TaskSnapshot>() {
@Override
public void onPaused(UploadTask.TaskSnapshot taskSnapshot) {
Log.e("Tuts+", "upload paused!");
}
});
mUploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() {
@Override
public void onProgress(UploadTask.TaskSnapshot taskSnapshot) {
Log.e("Tuts+", "Bytes uploaded: " + taskSnapshot.getBytesTransferred());
}
});
Вышеприведенный код позволит вам контролировать процесс загрузки для несколько большого (1 МБ, в данном случае) изображения и видеть его состояния, изменяющиеся в логах Android, когда нажаты кнопки паузы и возобновления.
E/Tuts+: Bytes uploaded: 524288 E/Tuts+: upload paused! E/Tuts+: Bytes uploaded: 786432
Обработка жизненного цикла Android Activity
Как может подтвердить любой разработчик Android, иногда жизненный цикл Android Activityможет вызвать непредвиденные проблемы. Одним из распространенных источников проблем является прослушивание, которое длится дольше, чем их родительская Activity, что может быть причиной для успешного или неуспешного завершения слушаетелй, связанных с задачей хранения Firebase.
Если Activity уничтожается и воссоздается (например, при вращении экрана) во время выполнения задачи, вы можете получить исключение NullPointerException, когда задача завершится. Чтобы этого избежать, вам нужно сохранить свой StorageReference в виде String в своем исходном Bundle в методе onSaveInstanceState(Bundle), а затем восстановить его и добавить слушателей успеха в каждую FileDownloadTask или FileUploadTask, связанную с этим StorageReference.
@Override
protected void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
if (mStorageReference != null) {
outState.putString(EXTRA_STORAGE_REFERENCE_KEY, mStorageReference.toString());
}
}
@Override
protected void onRestoreInstanceState(Bundle savedInstanceState) {
super.onRestoreInstanceState(savedInstanceState);
final String stringRef = savedInstanceState.getString(EXTRA_STORAGE_REFERENCE_KEY);
if (stringRef == null) {
return;
}
mStorageReference = FirebaseStorage.getInstance().getReferenceFromUrl(stringRef);
List<FileDownloadTask> tasks = mStorageReference.getActiveDownloadTasks();
for( FileDownloadTask task : tasks ) {
task.addOnSuccessListener(this, new OnSuccessListener<FileDownloadTask.TaskSnapshot>() {
@Override
public void onSuccess(FileDownloadTask.TaskSnapshot taskSnapshot) {
Log.e("Tuts+", "download successful!");
}
});
}
}
Вывод
В этом уроке вы много узнали о Firebase и его доступных вариантах хранения файлов. Теперь вы можете загружать и скачивать файлы, управлять передачей данных и обрабатывать изменения жизненного цикла вашего приложения во время транзакции.
Хотя мы только лишь поверхностно прошлись по этой теме, понимание этого инструмента, мы надеемся, позволит вам расширить возможности ваших собственных приложений.
А пока ознакомьтесь с некоторыми другими нашими статьями по разработке Android!
