Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

Carica file con Cloud Storage su Android

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Cloud Storage per Firebase ti consente di caricare i file in modo rapido e semplice in un bucket Cloud Storage fornito e gestito da Firebase.

Caricare files

Per caricare un file su Cloud Storage, devi prima creare un riferimento al percorso completo del file, incluso il nome del file.

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

Dopo aver creato un riferimento appropriato, chiama il putBytes() , putFile() o putStream() per caricare il file in Cloud Storage.

Non puoi caricare dati con un riferimento alla radice del tuo bucket Cloud Storage. Il tuo riferimento deve puntare a un URL secondario.

Carica dai dati in memoria

Il metodo putBytes() è il modo più semplice per caricare un file su Cloud Storage. putBytes() accetta un byte[] e restituisce un UploadTask che puoi utilizzare per gestire e monitorare lo stato del caricamento.

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

Poiché putBytes() accetta un byte[] , richiede che la tua app mantenga in memoria l'intero contenuto di un file contemporaneamente. Prendi in considerazione l'utilizzo putStream() o putFile() per utilizzare meno memoria.

Carica da un flusso

Il metodo putStream() è il modo più versatile per caricare un file su Cloud Storage. putStream() prende un InputStream e restituisce un UploadTask che puoi utilizzare per gestire e monitorare lo stato del caricamento.

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

Carica da un file locale

Puoi caricare file locali sul dispositivo, come foto e video dalla fotocamera, con il metodo putFile() . putFile() prende un File e restituisce un UploadTask che puoi utilizzare per gestire e monitorare lo stato del caricamento.

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

Ottieni un URL per il download

Dopo aver caricato un file, puoi ottenere un URL per scaricare il file chiamando il metodo getDownloadUrl() su 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
            // ...
        }
    }
});

Aggiungi metadati file

Puoi anche includere i metadati quando carichi i file. Questi metadati contengono proprietà tipiche dei metadati di file come name , size e contentType (comunemente indicato come tipo MIME). Il metodo putFile() deduce automaticamente il tipo MIME dall'estensione File , ma puoi sovrascrivere il tipo rilevato automaticamente specificando contentType nei metadati. Se non fornisci un contentType e Cloud Storage non può dedurre un valore predefinito dall'estensione del file, Cloud Storage utilizza application/octet-stream . Vedere la sezione Usa metadati file per ulteriori informazioni sui metadati file.

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

Gestisci caricamenti

Oltre ad avviare i caricamenti, puoi mettere in pausa, riprendere e annullare i caricamenti utilizzando i metodi pause() , resume() e cancel() . Gli eventi Pausa e Riprendi provocano rispettivamente la pause e le modifiche allo stato di progress . L'annullamento di un caricamento causa il fallimento del caricamento con un errore che indica che il caricamento è stato annullato.

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

Monitora l'avanzamento del caricamento

Puoi aggiungere ascoltatori per gestire l'esito positivo, il fallimento, l'avanzamento o le pause nell'attività di caricamento:

Tipo di ascoltatore Uso tipico
OnProgressListener Questo listener viene chiamato periodicamente quando i dati vengono trasferiti e può essere utilizzato per popolare un indicatore di caricamento/download.
OnPausedListener Questo listener viene chiamato ogni volta che l'attività viene messa in pausa.
OnSuccessListener Questo listener viene chiamato quando l'attività è stata completata correttamente.
OnFailureListener Questo listener viene chiamato ogni volta che il caricamento non riesce. Ciò può accadere a causa di timeout di rete, errori di autorizzazione o se si annulla l'attività.

OnFailureListener viene chiamato con un'istanza di Exception . Altri listener vengono chiamati con un oggetto UploadTask.TaskSnapshot . Questo oggetto è una vista immutabile dell'attività nel momento in cui si è verificato l'evento. Un UploadTask.TaskSnapshot contiene le seguenti proprietà:

Proprietà Tipo Descrizione
getDownloadUrl String Un URL che può essere utilizzato per scaricare l'oggetto. Si tratta di un URL pubblico non indovinabile che può essere condiviso con altri client. Questo valore viene popolato una volta completato il caricamento.
getError Exception Se l'attività non è riuscita, la causa sarà un'eccezione.
getBytesTransferred long Il numero totale di byte che sono stati trasferiti durante l'acquisizione di questo snapshot.
getTotalByteCount long Il numero totale di byte che si prevede di caricare.
getUploadSessionUri String Un URI che può essere utilizzato per continuare questa attività tramite un'altra chiamata a putFile.
getMetadata StorageMetadata Prima del completamento di un caricamento, questi sono i metadati inviati al server. Al termine del caricamento, questi sono i metadati restituiti dal server.
getTask UploadTask L'attività che ha creato questo snapshot. Utilizza questa attività per annullare, mettere in pausa o riprendere il caricamento.
getStorage StorageReference StorageReference utilizzato per creare UploadTask .

I listener di eventi UploadTask forniscono un modo semplice ed efficace per monitorare gli eventi di caricamento.

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

Gestire le modifiche del ciclo di vita delle attività

I caricamenti continuano in background anche dopo le modifiche al ciclo di vita dell'attività (come la presentazione di una finestra di dialogo o la rotazione dello schermo). Tutti gli ascoltatori che avevi collegato rimarranno anch'essi collegati. Ciò potrebbe causare risultati imprevisti se vengono chiamati dopo che l'attività è stata interrotta.

Puoi risolvere questo problema iscrivendo i tuoi ascoltatori con un ambito di attività per annullarne automaticamente la registrazione quando l'attività si interrompe. Quindi, utilizza il metodo getActiveUploadTasks quando l'attività viene riavviata per ottenere le attività di caricamento ancora in esecuzione o completate di recente.

L'esempio seguente lo dimostra e mostra anche come rendere persistente il percorso di riferimento di archiviazione utilizzato.

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 recupera tutte le attività di caricamento attive in corrispondenza e al di sotto del riferimento fornito, pertanto potrebbe essere necessario gestire più attività.

Il proseguimento dei caricamenti attraverso il processo si riavvia

Se il processo viene interrotto, tutti i caricamenti in corso verranno interrotti. Tuttavia, puoi continuare a caricare una volta riavviato il processo riprendendo la sessione di caricamento con il server. Ciò può far risparmiare tempo e larghezza di banda non avviando il caricamento dall'inizio del file.

Per fare ciò, inizia a caricare tramite putFile . Nell'oggetto StorageTask risultante, chiama getUploadSessionUri e salva il valore risultante nell'archivio permanente (come 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.
        }
    }
});

Dopo il riavvio del processo con un caricamento interrotto, chiama di nuovo putFile. Ma stavolta passa anche l'Uri che si è salvato.

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

Le sessioni durano una settimana. Se tenti di riprendere una sessione dopo che è scaduta o se si è verificato un errore, riceverai una richiamata di errore. È tua responsabilità assicurarti che il file non sia cambiato tra i caricamenti.

Gestione degli errori

Esistono diversi motivi per cui possono verificarsi errori durante il caricamento, incluso il file locale non esistente o l'utente che non dispone dell'autorizzazione per caricare il file desiderato. Puoi trovare ulteriori informazioni sugli errori nella sezione Gestione degli errori dei documenti.

Esempio completo

Di seguito è riportato un esempio completo di caricamento con monitoraggio dell'avanzamento e gestione degli errori:

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

Ora che hai caricato i file, impariamo come scaricarli da Cloud Storage.