Accesso a file specifici dell'app

In molti casi, l'app crea file a cui non è necessario accedere o non devono accedere altre app. Il sistema fornisce le seguenti posizioni per l'archiviazione di questi file specifici per le app:

• Directory della memoria interna: queste directory includono una posizione dedicata per l'archiviazione di file permanenti e un'altra posizione per l'archiviazione dei dati della cache. Il sistema impedisce ad altre app di accedere a queste posizioni e, su Android 10 (livello API 29) e versioni successive, queste posizioni vengono criptate. Queste caratteristiche rendono le sedi ideali per archiviare dati sensibili a cui solo la tua app può accedere.

• Directory di archiviazione esterna:queste directory includono una posizione dedicata per l'archiviazione di file permanenti e un'altra posizione per l'archiviazione dei dati della cache. Sebbene sia possibile che un'altra app possa accedere a queste directory se quest'ultima dispone delle autorizzazioni appropriate, i file archiviati in queste directory sono destinati a essere utilizzati solo dalla tua app. Se intendi creare file a cui altre app devono poter accedere, l'app deve archiviarli nella parte dello spazio di archiviazione condiviso dello spazio di archiviazione esterno.

Quando l'utente disinstalla l'app, i file salvati nello spazio di archiviazione specifico dell'app vengono rimossi. A causa di questo comportamento, non devi utilizzare questo spazio di archiviazione per salvare tutto ciò che l'utente prevede di conservare indipendentemente dalla tua app. Ad esempio, se la tua app consente agli utenti di acquisire foto, l'utente si aspetterebbe di poter accedere a queste foto anche dopo aver disinstallato l'app. Quindi, dovresti utilizzare lo spazio di archiviazione condiviso per salvare questi tipi di file nella raccolta multimediale appropriata.

Le seguenti sezioni descrivono come archiviare e accedere ai file all'interno delle directory specifiche delle app.

Accesso dalla memoria interna

Per ogni app, il sistema fornisce directory all'interno della memoria interna in cui un'app può organizzare i propri file. Una directory è progettata per i file persistenti dell'app, mentre un'altra contiene i file dell'app memorizzati nella cache. L'app non richiede autorizzazioni di sistema per leggere e scrivere nei file in queste directory.

Le altre app non possono accedere ai file memorizzati nella memoria interna. Di conseguenza, la memoria interna è un ottimo spazio per i dati dell'app a cui le altre app non dovrebbero accedere.

Tieni presente, tuttavia, che queste directory tendono a essere piccole. Prima di scrivere file specifici dell'app nella memoria interna, l'app deve eseguire query sullo spazio libero sul dispositivo.

Accedi ai file permanenti

I file permanenti normali dell'app si trovano in una directory a cui puoi accedere utilizzando la proprietà filesDir di un oggetto di contesto. Il framework offre diversi metodi per accedere ai file e archiviarli.

Accedere ai file e archiviarli

Puoi utilizzare l'API File per accedere ai file e archiviarli.

Per mantenere le prestazioni della tua app, non aprire e chiudere lo stesso file più volte.

Il seguente snippet di codice mostra come utilizzare l'API File:

Kotlin

val file = File(context.filesDir, filename)

Java

File file = new File(context.getFilesDir(), filename);

Archiviare un file utilizzando uno stream

In alternativa all'utilizzo dell'API File, puoi chiamare openFileOutput() per ottenere una FileOutputStream che scrive in un file all'interno della directory filesDir.

Il seguente snippet di codice mostra come scrivere del testo in un file:

Kotlin

val filename = "myfile"
val fileContents = "Hello world!"
context.openFileOutput(filename, Context.MODE_PRIVATE).use {
        it.write(fileContents.toByteArray())
}

Java

String filename = "myfile";
String fileContents = "Hello world!";
try (FileOutputStream fos = context.openFileOutput(filename, Context.MODE_PRIVATE)) {
    fos.write(fileContents.toByteArray());
}

Attenzione :sui dispositivi con Android 7.0 (livello API 24) o versioni successive, a meno che non passi la modalità file Context.MODE_PRIVATE a openFileOutput(), si verifica SecurityException.

Per consentire ad altre app di accedere ai file archiviati in questa directory all'interno della memoria interna, utilizza FileProvider con l'attributo FLAG_GRANT_READ_URI_PERMISSION.

Accedere a un file utilizzando uno stream

Per leggere un file come flusso, utilizza openFileInput():

Kotlin

context.openFileInput(filename).bufferedReader().useLines { lines ->
    lines.fold("") { some, text ->
        "$some\n$text"
    }
}

Java

FileInputStream fis = context.openFileInput(filename);
InputStreamReader inputStreamReader =
        new InputStreamReader(fis, StandardCharsets.UTF_8);
StringBuilder stringBuilder = new StringBuilder();
try (BufferedReader reader = new BufferedReader(inputStreamReader)) {
    String line = reader.readLine();
    while (line != null) {
        stringBuilder.append(line).append('\n');
        line = reader.readLine();
    }
} catch (IOException e) {
    // Error occurred when opening raw file for reading.
} finally {
    String contents = stringBuilder.toString();
}

Nota: se devi accedere a un file come flusso al momento dell'installazione, salva il file nella directory /res/raw del progetto. Puoi aprire questi file con openRawResource(), passando il nome file con prefisso R.raw come ID risorsa. Questo metodo restituisce un elemento InputStream che puoi utilizzare per leggere il file. Non puoi scrivere sul file originale.

Visualizza l'elenco dei file

Puoi ottenere un array contenente i nomi di tutti i file all'interno della directory filesDir chiamando fileList(), come mostrato nel seguente snippet di codice:

Kotlin

var files: Array<String> = context.fileList()

Java

Array<String> files = context.fileList();

Crea directory nidificate

Puoi anche creare directory nidificate o aprire una directory interna, chiamando getDir() nel codice basato su Kotlin o passando la directory principale e un nuovo nome di directory a un costruttore File nel codice basato su Java:

Kotlin

context.getDir(dirName, Context.MODE_PRIVATE)

Java

File directory = context.getFilesDir();
File file = new File(directory, filename);

Nota: filesDir è sempre una directory predecessore di questa nuova directory.

Crea file cache

Se devi archiviare i dati sensibili solo temporaneamente, per salvare i dati devi usare la directory della cache designata dell'app all'interno della memoria interna. Come per tutti gli spazi di archiviazione specifici delle app, i file archiviati in questa directory vengono rimossi quando l'utente disinstalla l'app, anche se i file in questa directory potrebbero essere rimossi prima.

Nota: questa directory della cache è progettata per archiviare una piccola quantità di dati sensibili dell'app. Per determinare quanto spazio di cache è attualmente disponibile per la tua app, chiama getCacheQuotaBytes().

Per creare un file memorizzato nella cache, richiama File.createTempFile():

Kotlin

File.createTempFile(filename, null, context.cacheDir)

Java

File.createTempFile(filename, null, context.getCacheDir());

L'app accede a un file in questa directory utilizzando la proprietà cacheDir di un oggetto di contesto e l'API File:

Kotlin

val cacheFile = File(context.cacheDir, filename)

Java

File cacheFile = new File(context.getCacheDir(), filename);

Attenzione: quando lo spazio di archiviazione interno del dispositivo sta per esaurirsi, Android potrebbe eliminare questi file della cache per recuperare spazio. Quindi, verifica l'esistenza dei file della cache prima di leggerli.

Rimuovi file della cache

Anche se a volte Android elimina i file della cache autonomamente, non devi fare affidamento sul sistema per pulire questi file al posto tuo. I file della cache dell'app devono essere sempre conservati nella memoria interna.

Per rimuovere un file dalla directory della cache all'interno della memoria interna, utilizza uno dei seguenti metodi:

• Il metodo delete() su un oggetto File che rappresenta il file:

  Kotlin

  cacheFile.delete()
  

  Java

  cacheFile.delete();
  

• Il metodo deleteFile() del contesto dell'app, passando il nome del file:

  Kotlin

  context.deleteFile(cacheFileName)
  

  Java

  context.deleteFile(cacheFileName);
  

Accesso da memoria esterna

Se la memoria interna non offre spazio sufficiente per archiviare file specifici dell'app, valuta la possibilità di utilizzare un'unità di archiviazione esterna. Il sistema fornisce directory all'interno della memoria esterna in cui un'app può organizzare i file che forniscono valore all'utente solo all'interno dell'app. Una directory è progettata per i file permanenti dell'app e un'altra contiene i file memorizzati nella cache dell'app.

Su Android 4.4 (livello API 19) o versioni successive, la tua app non deve richiedere autorizzazioni relative allo spazio di archiviazione per accedere alle directory specifiche dell'app all'interno dello spazio di archiviazione esterno. I file archiviati in queste directory vengono rimossi quando l'app viene disinstallata.

Attenzione :non è garantito che i file in queste directory siano accessibili, ad esempio quando una scheda SD rimovibile viene estratto dal dispositivo. Se la funzionalità della tua app dipende da questi file, devi invece archiviare i file all'interno della archiviazione interna.

Sui dispositivi con Android 9 (livello API 28) o versioni precedenti, la tua app può accedere ai file specifici dell'app che appartengono ad altre app, a condizione che l'app disponga delle autorizzazioni di archiviazione appropriate. Per offrire agli utenti un maggiore controllo sui loro file e limitare il disordine dei file, alle app destinate ad Android 10 (livello API 29) e versioni successive viene concesso l'accesso con ambito alla memoria esterna, o archiviazione con ambito, per impostazione predefinita. Quando l'archiviazione con ambito è abilitata, le app non possono accedere alle directory specifiche delle app che appartengono ad altre app.

Verifica che lo spazio di archiviazione sia disponibile

Poiché l'archiviazione esterna risiede su un volume fisico che l'utente potrebbe essere in grado di rimuovere, verifica che quest'ultimo sia accessibile prima di tentare di leggere o scrivere dati specifici dell'app nella memoria esterna.

Puoi eseguire query sullo stato del volume chiamando Environment.getExternalStorageState(). Se lo stato restituito è MEDIA_MOUNTED, puoi leggere e scrivere file specifici delle app all'interno della memoria esterna. Se è MEDIA_MOUNTED_READ_ONLY, puoi solo leggere questi file.

Ad esempio, i seguenti metodi sono utili per determinare la disponibilità dello spazio di archiviazione:

Kotlin

// Checks if a volume containing external storage is available
// for read and write.
fun isExternalStorageWritable(): Boolean {
    return Environment.getExternalStorageState() == Environment.MEDIA_MOUNTED
}

// Checks if a volume containing external storage is available to at least read.
fun isExternalStorageReadable(): Boolean {
     return Environment.getExternalStorageState() in
        setOf(Environment.MEDIA_MOUNTED, Environment.MEDIA_MOUNTED_READ_ONLY)
}

Java

// Checks if a volume containing external storage is available
// for read and write.
private boolean isExternalStorageWritable() {
    return Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED);
}

// Checks if a volume containing external storage is available to at least read.
private boolean isExternalStorageReadable() {
     return Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED) ||
            Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED_READ_ONLY);
}

Sui dispositivi senza memoria esterna rimovibile, utilizza il seguente comando per abilitare un volume virtuale per testare la logica di disponibilità dello spazio di archiviazione esterno:

adb shell sm set-virtual-disk true

Seleziona una posizione di archiviazione fisica

A volte, un dispositivo che alloca una partizione della sua memoria interna come memoria esterna fornisce anche uno slot per scheda SD. Ciò significa che il dispositivo ha più volumi fisici che potrebbero contenere spazio di archiviazione esterno, quindi devi selezionare quale utilizzare per l'archiviazione specifica per l'app.

Per accedere alle diverse sedi, chiama il numero ContextCompat.getExternalFilesDirs(). Come mostrato nello snippet di codice, il primo elemento nell'array restituito è considerato il volume di archiviazione esterna principale. Usa questo volume a meno che non sia pieno o non disponibile.

Kotlin

val externalStorageVolumes: Array<out File> =
        ContextCompat.getExternalFilesDirs(applicationContext, null)
val primaryExternalStorage = externalStorageVolumes[0]

Java

File[] externalStorageVolumes =
        ContextCompat.getExternalFilesDirs(getApplicationContext(), null);
File primaryExternalStorage = externalStorageVolumes[0];

Nota: se la tua app viene utilizzata su un dispositivo con Android 4.3 (livello API 18) o versioni precedenti, l'array contiene un solo elemento, che rappresenta il volume di archiviazione esterno principale.

Accedi ai file permanenti

Per accedere a file specifici delle app da una memoria esterna, chiama getExternalFilesDir().

Per mantenere le prestazioni della tua app, non aprire e chiudere lo stesso file più volte.

Il seguente snippet di codice mostra come chiamare getExternalFilesDir():

Kotlin

val appSpecificExternalDir = File(context.getExternalFilesDir(null), filename)

Java

File appSpecificExternalDir = new File(context.getExternalFilesDir(null), filename);

Nota: su Android 11 (livello API 30) e versioni successive, le app non possono creare la propria directory specifica dell'app sullo spazio di archiviazione esterno.

Crea file cache

Per aggiungere un file specifico dell'app alla cache all'interno della memoria esterna, consulta externalCacheDir:

Kotlin

val externalCacheFile = File(context.externalCacheDir, filename)

Java

File externalCacheFile = new File(context.getExternalCacheDir(), filename);

Rimuovi file della cache

Per rimuovere un file dalla directory della cache esterna, utilizza il metodo delete() su un oggetto File che rappresenta il file:

Kotlin

externalCacheFile.delete()

Java

externalCacheFile.delete();

Contenuti multimediali

Se la tua app funziona con file multimediali che forniscono valore all'utente solo all'interno dell'app, ti consigliamo di archiviarli in directory specifiche dell'app all'interno di spazio di archiviazione esterno, come mostrato nel seguente snippet di codice:

Kotlin

fun getAppSpecificAlbumStorageDir(context: Context, albumName: String): File? {
    // Get the pictures directory that's inside the app-specific directory on
    // external storage.
    val file = File(context.getExternalFilesDir(
            Environment.DIRECTORY_PICTURES), albumName)
    if (!file?.mkdirs()) {
        Log.e(LOG_TAG, "Directory not created")
    }
    return file
}

Java

@Nullable
File getAppSpecificAlbumStorageDir(Context context, String albumName) {
    // Get the pictures directory that's inside the app-specific directory on
    // external storage.
    File file = new File(context.getExternalFilesDir(
            Environment.DIRECTORY_PICTURES), albumName);
    if (file == null || !file.mkdirs()) {
        Log.e(LOG_TAG, "Directory not created");
    }
    return file;
}

È importante utilizzare i nomi delle directory forniti da costanti API come DIRECTORY_PICTURES. Questi nomi di directory assicurano che i file vengano trattati correttamente dal sistema. Se nessuno dei nomi di sottodirectory predefinite è adatto ai tuoi file, puoi trasferire null in getExternalFilesDir(). Questa operazione restituisce la directory specifica dell'app principale all'interno della memoria esterna.

Esegui query sullo spazio libero

Molti utenti non hanno molto spazio di archiviazione disponibile sui propri dispositivi, quindi la tua app deve occupare lo spazio in modo ponderato.

Se sai in anticipo quanti dati stai memorizzando, puoi scoprire quanto spazio può fornire alla tua app il dispositivo chiamando il numero getAllocatableBytes(). Il valore restituito di getAllocatableBytes() potrebbe essere superiore all'attuale quantità di spazio libero sul dispositivo. Questo perché il sistema ha identificato file che è in grado di rimuovere dalle directory della cache di altre app.

Se c'è spazio sufficiente per salvare i dati dell'app, chiama il numero allocateBytes(). In caso contrario, l'app può richiedere all'utente di rimuovere alcuni file dal dispositivo o di rimuovere tutti i file della cache dal dispositivo.

Il seguente snippet di codice mostra un esempio di come l'app può eseguire query sullo spazio libero sul dispositivo:

Kotlin

// App needs 10 MB within internal storage.
const val NUM_BYTES_NEEDED_FOR_MY_APP = 1024 * 1024 * 10L;

val storageManager = applicationContext.getSystemService<StorageManager>()!!
val appSpecificInternalDirUuid: UUID = storageManager.getUuidForPath(filesDir)
val availableBytes: Long =
        storageManager.getAllocatableBytes(appSpecificInternalDirUuid)
if (availableBytes >= NUM_BYTES_NEEDED_FOR_MY_APP) {
    storageManager.allocateBytes(
        appSpecificInternalDirUuid, NUM_BYTES_NEEDED_FOR_MY_APP)
} else {
    val storageIntent = Intent().apply {
        // To request that the user remove all app cache files instead, set
        // "action" to ACTION_CLEAR_APP_CACHE.
        action = ACTION_MANAGE_STORAGE
    }
}

Java

// App needs 10 MB within internal storage.
private static final long NUM_BYTES_NEEDED_FOR_MY_APP = 1024 * 1024 * 10L;

StorageManager storageManager =
        getApplicationContext().getSystemService(StorageManager.class);
UUID appSpecificInternalDirUuid = storageManager.getUuidForPath(getFilesDir());
long availableBytes =
        storageManager.getAllocatableBytes(appSpecificInternalDirUuid);
if (availableBytes >= NUM_BYTES_NEEDED_FOR_MY_APP) {
    storageManager.allocateBytes(
            appSpecificInternalDirUuid, NUM_BYTES_NEEDED_FOR_MY_APP);
} else {
    // To request that the user remove all app cache files instead, set
    // "action" to ACTION_CLEAR_APP_CACHE.
    Intent storageIntent = new Intent();
    storageIntent.setAction(ACTION_MANAGE_STORAGE);
}

Nota: non è necessario controllare la quantità di spazio disponibile prima di salvare il file. Puoi invece provare a scrivere subito il file, quindi rilevare un IOException se presente. Potresti aver bisogno di questa opzione se non sai esattamente quanto spazio ti serve. Ad esempio, se modifichi la codifica del file prima di salvarlo convertendo un'immagine PNG in JPEG, non conosci in anticipo le dimensioni del file.

Creare un'attività di gestione dello spazio di archiviazione

La tua app può dichiarare e creare un'attività personalizzata che, una volta avviata, consente all'utente di gestire i dati archiviati dall'app sul dispositivo dell'utente. Dichiari questa attività personalizzata di "gestione dello spazio" utilizzando l'attributo android:manageSpaceActivity nel file manifest. Le app di gestione di file possono richiamare questa attività anche se la tua app non esporta l'attività, ovvero quando l'attività viene impostata android:exported su false.

Chiedi all'utente di rimuovere alcuni file del dispositivo

Per richiedere all'utente di scegliere i file da rimuovere sul dispositivo, richiama un intent che include l'azione ACTION_MANAGE_STORAGE. Questo intent mostra una richiesta all'utente. Se vuoi, questo prompt può mostrare la quantità di spazio libero disponibile sul dispositivo. Per mostrare queste informazioni di facile utilizzo, utilizza il risultato del seguente calcolo:

StorageStatsManager.getFreeBytes() / StorageStatsManager.getTotalBytes()

Chiedi all'utente di rimuovere tutti i file della cache

In alternativa, puoi richiedere all'utente di cancellare i file della cache da tutte le app sul dispositivo. A questo scopo, richiama un intent che includa l'azione di intent ACTION_CLEAR_APP_CACHE.

Attenzione: l'azione intent ACTION_CLEAR_APP_CACHE può influire notevolmente sulla durata della batteria del dispositivo e potrebbe rimuovere un numero elevato di file dal dispositivo.

Risorse aggiuntive

Per ulteriori informazioni sul salvataggio di file nello spazio di archiviazione del dispositivo, consulta le risorse seguenti.

Video

• Prepararsi per l'archiviazione con ambito (Android Dev Summit '19)