Хранение данных на устройстве

Обратите внимание на то, что для работы с рассматриваемыми здесь возможностями нам понадобилось подключить пространства имен Windows.Storage и System.IO.

Обработчик события нажатия на кнопку объявлен с модификатором async. Он нужен нам для того, чтобы мы могли в данном обработчике использовать оператор await. Это – элементы асинхронного программирования, которые необходимы при выполнении операций с файлами. Чтение или запись файла – это операции, которые могут длиться достаточно долго для того, чтобы выполнение их в потоке пользовательского интерфейса приложения (синхронно) привело к заметным задержкам.

При получении объекта StorageFile для файла мы обращаемся к пакету приложения с использованием схемы <ms-appx:///>, которая используется при работе с API из пространства имен Windows. Похожее обращение, для других API, можно выполнить, используя схему <appdata:\>. Файлы, хранящиеся в установочном пакете приложения, доступны только для чтения. Приложения не имеют доступа к данным других приложений.

Получив объект StorageFile, мы открываем его для чтения, после чего считываем содержимое файла в текстовое поле txtHello.

В Листинге 33.3. приведен код страницы LocalFolder.xaml

<phone:PhoneApplicationPage
    x:Class="P10_1.LocalFolder"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:phone="clr-namespace:Microsoft.Phone.Controls;assembly=Microsoft.Phone"
    xmlns:shell="clr-namespace:Microsoft.Phone.Shell;assembly=Microsoft.Phone"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    FontFamily="{StaticResource PhoneFontFamilyNormal}"
    FontSize="{StaticResource PhoneFontSizeNormal}"
    Foreground="{StaticResource PhoneForegroundBrush}"
    SupportedOrientations="Portrait" Orientation="Portrait"
    mc:Ignorable="d"
    shell:SystemTray.IsVisible="True">

    <!--LayoutRoot представляет корневую сетку, где размещается все содержимое страницы-->
    <Grid x:Name="LayoutRoot" Background="Transparent">
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>

        <!--TitlePanel содержит имя приложения и заголовок страницы-->
        <StackPanel Grid.Row="0" Margin="12,17,0,28">
            <TextBlock Text="ДАННЫЕ" Style="{StaticResource PhoneTextNormalStyle}"/>
            <TextBlock Text="локальные" Margin="9,-7,0,0" 
Style="{StaticResource PhoneTextTitle1Style}"/>
        </StackPanel>

        <!--ContentPanel – поместите здесь дополнительное содержимое-->
        <Grid x:Name="ContentPanel" Grid.Row="1" 
Margin="12,0">
            <TextBox 
        Name="textBox1" 
        HorizontalAlignment="Left"
        Height="72" 
        Margin="0,22,0,0" 
        TextWrapping="Wrap" 
        Text="Введите текст" 
        VerticalAlignment="Top" Width="456"/>
            <Button 
        Name='btnWrite' 
        Content="Записать"
        HorizontalAlignment="Left" 
        Margin="10,94,0,0" 
        VerticalAlignment="Top"
        Width="175" 
        Click="btnWrite_Click"/>
            <TextBlock 
        Name="textBlock1" 
        HorizontalAlignment="Left"
        Margin="10,293,0,0" 
        TextWrapping="Wrap" Text=""
        VerticalAlignment="Top" 
        Height="61" 
        Width="436"/>
            <Button 
        Name="btnRead" 
        Content="Прочитать"
        HorizontalAlignment="Left" 
        Margin="10,374,0,0" 
        VerticalAlignment="Top"
        Width="175" 
        IsEnabled="False"
        Click="btnRead_Click"/>
        </Grid>
    </Grid>
</phone:PhoneApplicationPage>

Здесь есть текстовое поле для ввода текста, кнопки для выполнения записи данных в файл, создаваемый в локальной папке приложения, и для чтения этого файла. При чтении данных, записанных в файл, они выводятся в текстовый блок.

В Листинге 33.4 приведен код файла LocalFolder.xaml.cs

using System;
using System.Windows;
using Microsoft.Phone.Controls;

using System.IO;
using System.Threading.Tasks;
using Windows.Storage;

namespace P10_1
{
    public partial class LocalFolder : PhoneApplicationPage
    {
        public LocalFolder()
        {
            InitializeComponent();
        }

        private async void btnWrite_Click(object sender, RoutedEventArgs e)
        {
            await WriteToFile();

            // Обновление пользовательского интерфейса.
            this.btnWrite.IsEnabled = false;
            this.btnRead.IsEnabled = true;
        }

        //Запись файла
        private async Task WriteToFile()
        {
            // Получим текстовые данные из текстового поля. 
            byte[] fileBytes = System.Text.Encoding.UTF8.GetBytes(this.textBox1.Text.ToCharArray());

            // Получим локальную папку.
            StorageFolder local = Windows.Storage.ApplicationData.Current.LocalFolder;

            // Создадим новую папку с именем DataFolder.
            var dataFolder = await local.CreateFolderAsync("DataFolder",
                CreationCollisionOption.OpenIfExists);

            // Создадим в новой папке файл DataFile.txt.
            var file = await dataFolder.CreateFileAsync("DataFile.txt",
            CreationCollisionOption.ReplaceExisting);

            // Запишем данные из текстового поля в файл.
            using (var s = await file.OpenStreamForWriteAsync())
            {
                s.Write(fileBytes, 0, fileBytes.Length);
            }
        }

        //Чтение файла
        private async void btnRead_Click(object sender, RoutedEventArgs e)
        {
            await ReadFile();

            // Обновим интерфейс.
            this.btnWrite.IsEnabled = true;
            this.btnRead.IsEnabled = false;
        }

        private async Task ReadFile()
        {
            // Получим локальную папку.
            StorageFolder local = Windows.Storage.ApplicationData.Current.LocalFolder;

            if (local != null)
            {
                // Получим папку DataFolder.
                var dataFolder = await local.GetFolderAsync("DataFolder");

                // Получим файл.
                var file = await dataFolder.OpenStreamForReadAsync("DataFile.txt");

                // Прочтем данные файла и запишем в текстовое поле.
                using (StreamReader streamReader = new StreamReader(file))
                {
                    this.textBlock1.Text = streamReader.ReadToEnd();
                }
            }
        }
    }
}

Здесь, при записи данных, работа начинается с получения объекта StorageFolder для локальной папки приложения, в ней создаётся папка для хранения данных, в папке создаётся файл с данными. Для работы с отдельным файлом используется объект StorageFile. Он поддерживает полный набор операций, необходимых для управления файлом и его содержимым.

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

Здесь так же используются средства для обеспечения асинхронной обработки операций.

В Листинге 33.5 приведен код файла AppSettings.xaml.

<phone:PhoneApplicationPage
    x:Class="P10_1.AppSettings"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:phone="clr-namespace:Microsoft.Phone.Controls;assembly=Microsoft.Phone"
    xmlns:shell="clr-namespace:Microsoft.Phone.Shell;assembly=Microsoft.Phone"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    FontFamily="{StaticResource PhoneFontFamilyNormal}"
    FontSize="{StaticResource PhoneFontSizeNormal}"
    Foreground="{StaticResource PhoneForegroundBrush}"
    SupportedOrientations="Portrait" Orientation="Portrait"
    mc:Ignorable="d"
    shell:SystemTray.IsVisible="True">

    <!--LayoutRoot представляет корневую сетку, где размещается все содержимое страницы-->
    <Grid x:Name="LayoutRoot" Background="Transparent">
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>

        <!--TitlePanel содержит имя приложения и заголовок страницы-->
        <StackPanel Grid.Row="0" Margin="12,17,0,28">
            <TextBlock Text="ДАННЫЕ" Style="{StaticResource PhoneTextNormalStyle}"/>
            <TextBlock Text="параметры" Margin="9,-7,0,0" 
Style="{StaticResource PhoneTextTitle1Style}"/>
        </StackPanel>

        <!--ContentPanel – поместите здесь дополнительное содержимое-->
        <Grid x:Name="ContentPanel" Grid.Row="1" Margin="12,0,12,0">
            <TextBox Height="72" HorizontalAlignment="Left" 
Margin="12,6,0,0" Name="txtInput" 
      Text="Введите данные" VerticalAlignment="Top" Width="438" />
            <Button Content="Сохранить данные" Height="72" 
HorizontalAlignment="Left" Margin="110,83,0,0" 
      Name="btnSave" VerticalAlignment="Top" Width="255" Click="btnSave_Click" />
            <Button Content="Отобразить данные" Height="72" HorizontalAlignment="Left" Margin="110,174,0,0" 
      Name="btnDisplay" VerticalAlignment="Top" Width="255" Click="btnDisplay_Click" />
            <Button Content="Удалить данные" Height="72" 
HorizontalAlignment="Left" Margin="110,263,0,0" 
      Name="btnRemove" VerticalAlignment="Top" 
Width="255" Click="btnRemove_Click" />

            <TextBlock Height="60" HorizontalAlignment="Left"
 Margin="25,422,0,0" Name="txtDisplay" 
      Text="Данные, введенные пользователем:" VerticalAlignment="Top" Width="395" />
        </Grid>
    </Grid>
</phone:PhoneApplicationPage>

Здесь имеется текстовое поле для ввода данных, текстовый блок для вывода и кнопки для демонстрации различных процедур работы с параметрами приложения. Параметры хранятся в специальном словаре, в виде "ключ – значение". Ими удобно пользоваться для сохранения небольших объемов данных, в частности – параметров приложения. Как правило, такие параметры считываются и записываются при обработке событий жизненного цикла приложения, либо, часть работы перекладывается на специальную страницу для настройки параметров. Так как операции, касающиеся работы с хранилищем данных – это потенциально медленные операции, следует свести к минимуму их использование в приложении. То есть, например, не следует всякий раз для выполнения какой-либо настройки на странице приложения (при переходе на неё, например), обращаться к параметру, считывая его из хранилища. Для подобных целей рациональнее всего будет использовать, например, переменные, объявленные в классе App (то есть – данные, которые хранятся в оперативной памяти), которые и хранят значения параметров, считанные один раз при запуске приложения.

В Листинге 33.6 приведен код файла AppSettings.xaml.cs

using System.Windows;
using Microsoft.Phone.Controls;

using System.IO.IsolatedStorage;

namespace P10_1
{
    public partial class AppSettings : PhoneApplicationPage
    {
        public AppSettings()
        {
            InitializeComponent();
        }
        //Запись параметра
        private void btnSave_Click(object sender, RoutedEventArgs e)
        {
            //Получим изолированное хранилище настроек
            IsolatedStorageSettings settings = IsolatedStorageSettings.ApplicationSettings;
            // Если среди параметров не существует параметра с ключом userData
            if (!settings.Contains("userData"))
            {
                //Добавим новый параметр с ключом userData и запишем в него содержимое поля
                settings.Add("userData", txtInput.Text);
            }
            else
            {
                //Если такой праметр уже существует - обновим его содержимое
                settings["userData"] = txtInput.Text;
            }
            //Сохраним параметры приложения
            settings.Save();
        }

        //Чтение параметра
        private void btnDisplay_Click(object sender, RoutedEventArgs e)
        {
            // Подготовим поле txtDisplay к выводу данных и выведем их если нужный параметр существует.
            txtDisplay.Text = "Данные: ";
            if (IsolatedStorageSettings.ApplicationSettings.Contains("userData"))
            {
                //Добавим к тексту, уже отображаемому в поле, текст, прочитанный из параметра с ключом userData
                txtDisplay.Text +=
                IsolatedStorageSettings.ApplicationSettings["userData"] as string;
            }
        }

        //Удаление параметра
        private void btnRemove_Click(object sender, RoutedEventArgs e)
        {
           //Если параметр с ключом userData существует, удалим его
            if (IsolatedStorageSettings.ApplicationSettings.Contains("userData"))
            {
                IsolatedStorageSettings.ApplicationSettings.Remove("userData");
            }
        }
    }
}

Для работы с изолированным хранилищем настроек используется пространство имен System.IO.IsolatedStorage, объект IsolatedStorageSettings.ApplicationSettings предоставляет высокоуровневый доступ к хранилищу, с его помощью мы можем непосредственно манипулировать параметрами – создавать их, проверять наличие, считывать, модифицировать.

В Windows Phone 8, помимо вышеописанных возможностей, есть и возможность работы с подключаемой к устройству SD-картой. Узнать подробности об использовании этой возможности можно в материале "Чтение с SD-карты в Windows Phone 8", http://msdn.microsoft.com/ru-ru/library/windowsphone/develop/jj720573%28v=vs.105%29.aspx.

Дополнительные подробности о работе с данными в Windows Phone можно найти в материале: "Данные для Windows Phone", http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff402541%28v=vs.105%29.aspx

Для того, чтобы при отладке приложения получить возможность работы с данными, которые хранятся в его локальной папке, на устройстве, или на эмуляторе, можно воспользоваться средством Isolated Explorer Tool. Оно имеет интерфейс командной строки, при работе с ним сначала нужно выяснить параметр ProductID вашего приложения, так как без знания этого параметра нельзя получить доступ к папке приложения, развёрнутого на устройстве. Значение этого параметра можно найти в файле-манифесте приложения (WMAppManifest.xml). При открытии его в редакторе манифеста нужно перейти на закладку Упаковка, где, в поле Идентификатор продукта и будет находиться нужное значение.

IsolaedStorage Explorer Tool расположен по следующему адресу: Program Files (x86)\Microsoft SDKs\Windows Phone\v8.0\Tools\IsolatedStorageExplorerTool.

Подробности о средстве для работы с содержимым папки приложения, Isolated Storage Explorer, можно узнать в материале: "Как использовать Isolated Storage Explorer для Windows Phone", http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh286408%28v=vs.105%29.aspx.

На указанной странице имеются примеры использования этого средства. Для работы с ним удобно создать пакетные (.bat) файлы, используемые при автоматизации часто выполняемых операций по работе с конкретным приложением.

Доступ к папке данных приложения весьма полезен при его отладке. Например, анализ файлов, которые создаёт приложение, позволяет судить о правильности работы реализованных в нем механизмов, если в работе приложения используются некие файлы, для создания которых требуется определенное время (например, время, необходимое для нескольких запусков приложения, записи каких-либо сведений), можно использовать файлы, которые созданы в приложении ранее, чтобы имитировать длительную работу пользователя с приложением без необходимости каждый раз, при тестировании, выполнять эту работу.

Выводы

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

Задание

Использование файлов, хранящихся в локальных папках приложения, позволяет сохранять сериализованные представления объектов и, соответственно, загружать их. Это позволяет сохранять состояние приложения, например, при выходе из него, и загружать его при запуске приложения, то есть, если это оправдано сценарием приложения, создать у пользователя впечатление о том, что приложение "работает" непрерывно, позволяя ему, не беспокоясь о потере данных, в любой момент работы выходить из приложения, выполнять другие задачи на телефоне, а потом снова запускать его и продолжать работу. Проанализируйте приложение, которое вы создаёте, с учетом возможности сохранения его состояния в перерывах между работой с ним пользователя.

Если подобная модель взаимодействия с пользователем подходит вашему приложению, подумайте, как сократить до минимума объем данных, которые нужно хранить между запусками приложения, а так же, если объем данных достаточно велик, о так называемом инкрементном сохранении данных приложения во время работы, а не только при вызове обработчиков жизненного цикла приложения. То же самое касается загрузки приложения – чем меньший объем данных ему приходится считывать и обрабатывать при запуске – тем лучше. Подготовьте отчёт о проделанной работе с описанием особенностей сохранения и восстановления данных приложения между сеансами работы.

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

Дополнительные материалы

К данной лекции подготовлено видеоприложение и демонстрационный программный проект.