Isolated Storage: cartelle e file in Windows Phone. Aldo Junior Simoncini Matricola

Transcript

1 Isolated Storage: cartelle e file in Windows Phone Aldo Junior Simoncini Matricola

2 Introduzione Windows Phone mette a disposizione di ogni applicazione uno spazio di storage riservato, chiamato Isolated Storage, utilizzabile come un normale file system (creazione cartelle, scrittura e lettura files, ecc.). E bene specificare che l Isolated Storage è riservato in modo esclusivo alla singola applicazione, non è quindi possibile l accesso da parte di altre app e viene eliminato con la disinstallazione della stessa. Per accedere allo storage ed effettuarvi operazioni sono messe a disposizione dall SDK una serie di API. La classe di riferimento ApplicationData (namespace Windows.Storage) consente l accesso alle varie tipologie di storage tramite la proprietà Current, anche se Windows Phone 8 supporta una sola tipologia, ovvero Local Storage, che rappresenta l Isolated storage locale. Lavorare con le cartelle L Isolated storage può essere visto come un file system tradizionale, dove è possibile organizzare i file all interno di cartelle. Le cartelle sono rappresentate dalla classe StorageFolder. (LocalStorage è di tipo StorageFolder e rappresenta la cartella radice dello storage). I seguenti metodi sono quindi applicabili ad ogni oggetto di tipo StorageFolder. Creare cartelle Per creare una cartella si usa il metodo CreateFolderAsync(), che accetta in ingresso il nome della cartella e un parametro di tipo CreationCollisionOption per specificare il comportamento da adottare nel caso in cui esista già una cartella con il nominativo scelto. Per specificare percorsi complessi con sottocartelle si utilizza il simbolo \\ come separatore, nel caso in cui le cartelle di livello superiore non esistano, saranno create automaticamente. 2

3 Il parametro di tipo CreationCollisionOption può assumere i seguenti valori: - OpenIfExists, se la cartella specificata esiste già, il metodo restituisce un riferimento alla cartella esistente - FailIfExists, se la cartella specificata esiste già, sarà sollevata un eccezione generica, che dovrà essere opportunamente gestita - ReplaceExisting, se la cartella specificata esiste già, sarà sovrascritta, con conseguente eliminazione di eventuale contenuto della precedente cartella - GenerateUniqueName, se la cartella specificata esiste già, sarà generato un nome univoco partendo dal nome scelto Elencare e aprire le cartelle presenti Per conoscere le cartelle presenti nello storage si utilizza il metodo asincrono GetFoldersAsync(), che ritorna una collezione di oggetti di tipo StorageFolder, ognuno dei quali corrisponde a una delle cartelle presenti. Questo metodo viene chiamato su oggetti StorageFolder e restituisce solo le cartelle presenti al suo interno, non le sue eventuali sottocartelle. Nell esempio sopra viene recuperato l elenco di tutte le cartelle presenti nella radice dello storage, il cui nome viene mostrato a video tramite una MessageBox. Se abbiamo la necessità di interagire con una cartella specifica di cui conosciamo il nome a priori, possiamo utilizzare il metodo GetFolderAsync(), che accetta come parametro il nome della cartella. 3

4 Eliminare cartelle Per eliminare una cartella si usa il metodo DeleteAsync(), richiamato sull oggetto StorageFolder che rappresenta la cartella da cancellare. Ogni file o cartella contenuto all interno della cartella specificata verrà cancellato. Se si stanno eliminando cartelle contenenti dati sensibili, è possibile optare per una cancellazione permanente, che rende impossibile recuperare i dati, passando anche il valore StorageDeleteOption.PermanentDelete. Nell esempio, dopo aver recuperato il riferimento alla cartella miacartella, questa viene cancellata in modo permanente. Verificare l esistenza di una cartella Per verificare l esistenza di una cartella non esiste un metodo specifico. Chiamando GetFolderAsync() e ottenendo un eccezione di tipo FileNotFoundException sapremo che la cartella non esiste. Ovviamente l eccezione andrà opportunamente gestita. 4

5 Rinominare una cartella Per rinominare una cartella si chiama il metodo RenameAsync() sull oggetto di tipo StorageFolder che rappresenta la cartella da rinominare, passando come parametro il nuovo nome. Nell esempio, dopo aver recuperato il riferimento alla cartella miacartella, la rinominiamo in miacartella2. Lavorare con i file Le cartelle sono inutili senza un contenuto vero e proprio al loro interno. La classe base che rappresenta un file nello storage si chiama StorageFile ed offre tutti i metodi per manipolarlo. Creare un file Il metodo messo a disposizione da StorageFolder è CreateFileAsync() e accetta come parametro il nome del file da creare. Il file viene creato all interno della cartella che è rappresentata dall oggetto StorageFolder che si sta utilizzando. Viene ritornato un oggetto di tipo StorageFile che rappresenta il file stesso. Esattamente come con le cartelle, anche in questo caso si può passare un parametro di tipo CreationCollisionOption, per decidere il comportamento da adottare nel caso in cui il file esiste già. Una volta ottenuto accesso al file, è possibile scrivere dati al suo interno. Il modo più semplice è quello di usare la classe DataWriter, che presenta una serie di metodi predisposti per scrivere i tipi di dato più comuni, come stringhe, interi o byte. 5

6 Nell esempio scriviamo una stringa. Per utilizzare la classe DataWriter abbiamo bisogno di accedere allo stream del file, che possiamo ottenere in due passaggi. Il primo consiste nell aprire effettivamente il file, tramite OpenAsync() della classe StorageFile. Come parametro, occorre specificare il tipo di apertura. Dato che vogliamo scrivere dei dati all interno del file, dobbiamo utilizzare il valore FileAccessMode.ReadWrite. Il metodo OpenAsync() ci restituisce uno stream di tipo IRandomAccessStream. Il secondo passaggio consiste nel trasformarlo in OutputStream, tramite il metodo GetOutputStreamAt(), che accetta in ingresso la posizione da cui iniziare a leggere o scrivere (nel nostro caso, passiamo 0, dato che la scrittura sarà eseguita a partire dall inizio del file). A questo punto possiamo creare una nuova istanza della classe DataWriter, usando il costrutto using. Usiamo la classe DataWriter per scrivere i dati nel file. Nell esempio, dato che vogliamo scrivere del testo, utilizziamo il metodo WriteString(). Altri esempi di metodi disponibili sono WriteDouble(per scrivere un numero decimale), WriteDateTime (per scrivere una data) o WriteBytes (per scrivere un array di byte). Una volta che abbiamo preparato il nostro dato, il passaggio finale è quello di scriverlo effettivamente nel file, tramite il metodo asincrono StoreAsync(). Infine chiamiamo il metodo FlushAsync() per liberare lo stream e completare l operazione. Leggere un file Per aprire il file in lettura utilizziamo sempre OpenFileAsync() ma come parametro utilizziamo FileAccesMode.Read. Il processo di lettura è simile a quello di scrittura con la differenza che invece della classe DataWriter, si utilizza la classe DataReader. 6

7 Dopo aver ottenuto l accesso al file tramite GetFileAsync(), lo apriamo per accedere allo stream, tramite il metodo OpenAsync() visto in precedenza. In questo caso il nostro obiettivo è leggere il contenuto del file, perciò possiamo utilizzare FileAccessMode.Read come parametro del metodo per accedere in sola lettura. Un altra differenza rispetto alla procedura utilizzata per scrivere all interno del file è che abbiamo la necessità di usare un InputStream, ottenuto tramite il metodo GetInputStreamAt(), anche in questo caso passiamo come parametro il valore 0, dato che vogliamo leggere il file dall inizio. A questo punto siamo in grado di leggere il contenuto del file grazie alla classe DataReader. Dopo aver utilizzato il metodo LoadAsync() per ottenere la dimensione del file, possiamo leggere il contenuto con il metodo ReadString() dato che in questo caso stiamo elaborando un file di testo. Nel caso si fosse trattato di un altro tipo di file, la classe DataReader mette a disposizione altri metodi, come ReadDateTime(), ReadDouble(), ReadBytes(). Eliminare file Per eliminare un file si utilizza il metodo DeleteAsync(), da chiamare sull oggetto di tipo StorageFile che rappresenta il file che si vuole cancellare. Esattamente come per l eliminazione di una cartella, possiamo passare un parametro di tipo StorageDeleteOption se vogliamo effettuare una cancellazione sicura. 7

8 Recuperare l elenco dei file Anche in questo caso, la procedura è analoga a quella per ottenere l elenco delle cartelle. Occorre chiamare il metodo GetFilesSync() sull oggetto di tipo StorageFolder che rappresenta la cartella contenente i file che vogliamo visualizzare. Quello che ci viene restituito è una collezione di oggetti di tipo StorageFile, ognuno dei quali rappresenta uno dei file contenuti nella cartella. Verificare l esistenza di un file Come per le cartelle, non esiste un modo esplicito per capire se un file esiste o meno nello storage. Si tenta di aprire il file tramite OpenFileAsync() e si intercetta l eventuale eccezione di tipo FileNotFoundException(). 8

9 Rinominare un file Per rinominare un file si usa il metodo RenameAsync(), che occorre chiamare sull oggetto di tipo StorageFile che rappresenta il file da rinominare. Spostare e copiare file La classe StorageFile, presenta i metodi CopyAsync() e MoveAsync(), che accettano come parametro un oggetto di tipo StorageFolder che rappresenta la cartella in cui si vuole copiare o spostare il file. Abbiamo la possibilità di personalizzare l operazione di copia, tramite il passaggio di due parametri opzionali: il nome che vogliamo dare al file, nel caso in cui vogliamo che sia differente da quello originale un oggetto di tipo NameCollisionOptions, per il comportamento da adottare nel caso in cui esiste già un file con lo stesso nome della cartella di destinazione: - ReplaceExisting, consente di sovrascrivere il file già esistente con quello nuovo - FailIfExists, scatenta un eccezione, da gestire - GenerateUniqueName, genera un nome univoco per il file partendo da quello originale 9

10 In questo caso, il file viene spostato anziché copiato, in più viene rinominato in file2.txt, sovrascrivendo un eventuale file già esistente con lo stesso nome. Accedere ai file contenuti nel progetto L Isolated storage è l unico spazio che abbiamo a disposizione per scrivere file. In alcuni casi, però, si ha necessitò di importare un file già esistente oppure di accedere a dei dati in sola lettura. Quando l app viene installata sul device, l intero contenuto del progetto viene copiato in una cartella nascosta del sistema operativo, alla quale possiamo accedere grazie alla classe Package.Current.InstalledLocation, contenuta nel namespace Windows.ApplicationModel. L accesso è in sola lettura. La classe InstalledLocation è di tipo StorageFolder, di conseguenza abbiamo a disposizione tutti i metodi esclusi quelli per la scrittura. In questo esempio, recuperiamo un riferimento al file file.xml contenuto nella radice del nostro progetto di Visual Studio e, sfruttando il metodo CopyAsync(), lo copiamo all interno della radice dell Isolated storage. Come visualizzare lo storage di un applicazione L SDK di Windows Phone ha introdotto un tool chiamato Isolated Storage Explorer, che permette di effettuare operazioni sullo storage: visualizzare file e cartelle o scaricarne e modificarne il contenuto. Isolated Storage Explorer è però un tool scomodo, a linea di comando e macchinoso ad eseguire certe operazioni. Un altra possibilità è quella di utilizzare un tool open source, Windows Phone Power Tools, il quale permette di collegarsi a un device (o all emulatore) per accedere allo storage dell applicazione, visualizzare il contenuto, caricare o scaricare file. 10