При разработке мобильных приложений зачастую возникает необходимость хранить настройки приложения (выбранную пользователем цветовую тему, пароль доступа к приложению, параметры синхронизации с сервером и т.д.). Поскольку такие задачи возникают довольно часто, в Google позаботились о разработчиках и создали механизм для быстрой и легкой реализации данного функционала. Этот механизм позволяет легко создавать, сохранять, отображать и производить разные манипуляции с настройками приложения. Мало того он позволяет автоматически создавать пользовательский интерфейс. При описании типа параметра настроек — автоматически генерируется часть пользовательского интерфейса в зависимости от типа параметра (boolean — чекбокс, String — поле ввода, ...) без написания кода. Звучит неплохо для быстрой разработки, не так ли?

Первым шагом в реализации механизма настроек приложения является наследования активности экрана вашего приложения от класса PreferenceActivity. Этот класс наследован от класса ListActivity
и позволяет создавать пользовательский интерфейс по описанию в XML файле ресурсов. Мало того, этот класс позволяет автоматически сохранять настройки в SharedPreferences незаметно для вас. SharedPreferences — интерфейс позволяющий обращаться и манипулировать данными настройки приложения вручную с помощью вызова метода getSharedPreferences из вашего Activity (подробнее Android Essentials: Application Preferences). Для того что бы увязать вместе наш класс унаследованный от PreferenceActivity и XML файл описывающий параметры конфигурации используется метод addPreferencesFromResource:

...

@Override

public void onCreate(Bundle savedInstanceState) {

    super.onCreate(savedInstanceState);

    addPreferencesFromResource(R.xml.preferences);

}

...

Теперь необходимо создать файл res/xml/preferences.xml который является описанием нашего списка параметров конфигурации приложения и будет подхвачен нашим PreferenceActivity. Этот XML файл имеет специфический формат позволяющий описывать типы параметров конфигурации. Все типы вытекают из класса Preference который представляет собой базовый блок пользовательского интерфейса и генерирует View которое в последствии отобразится в нужном месте пользовательского интерфейса и будет ассоциироваться с объектом SharedPreferences который можно будет извлекать и сохранять. Рассмотрим часто используемые подклассы, которые используются для описание типов параметров конфигурации:

CheckBoxPreference: чекбокс, представляет параметры типа boolean.
RingtonePreference: позволяет выбирать рингтон из доступных на устройстве. URI выбранного файла рингтона будет представлен в виде строки.
EditTextPreference: строка ввода текста, представляет параметры типа String.
ListPreference: показывает список возможных значений параметра в виде диалога, представляет параметры типа String.

Также необходимо отметить, что отдельные параметры могут группироваться в категории с помощью класса PreferenceCategory, который группирует объекты Preference и выводит неактивный заголовок группы.

Теперь опишем, что же мы хотим видеть в нашем XML описании. У нас будет две категории. В первой разместим CheckBoxPreference который будет активировать/дезактивировать синхронизацию данных нашего гипотетического приложения и ListPreference в которым будем задавать частоту синхронизации данных. Как вы уже наверняка заметили, между этими двумя параметрами есть зависимость, если первый не выбран, то второй нужно дезактивировать. Это достигается с помощью использования атрибута android:dependency. Во второй категории мы разместим EditTextPreference с помощью которого будем задавать текст приветствия. Представим все это в виде XML:

<?xml version="1.0" encoding="utf-8"?>

<PreferenceScreen xmlns:android="schemas.android.com/apk/res/android">

    <PreferenceCategory

        android:title="First Category"

        android:key="first_category">

        <CheckBoxPreference

            android:key="perform_updates"

            android:summary="Enable or disable data updates"

            android:title="Enable updates"

            android:defaultValue="true"

        />

        <ListPreference

            android:key="updates_interval"

            android:title="Updates interval"

            android:summary="Define how often updates will be performed"

            android:defaultValue="1000"

            android:entries="@array/updateInterval"

            android:entryValues="@array/updateIntervalValues"

            android:dependency="perform_updates"

        />

    </PreferenceCategory>

    <PreferenceCategory

        android:title="Second Category"

        android:key="second_category">

        <EditTextPreference

            android:key="welcome_message"

            android:title="Welcome Message"

            android:summary="Define the Welcome message to be shown"

            android:dialogTitle="Welcome Message"

            android:dialogMessage="Provide a message"

            android:defaultValue="Default welcome message" />

    </PreferenceCategory>

</PreferenceScreen>

Заметьте, что для ListPreference мы указали атрибут android:entries который указывает на место хранения возможных значений списка. Эти значения хранятся в XML файле res/values/arrays.xml. Значения “updateInterval” and “updateIntervalValue” хранятся в этом файле. На самом деле это просто пары ключ-значение, ключи хранятся в первом массиве, а значения — во втором:

<?xml version="1.0" encoding="utf-8"?>

<resources>

    <string-array name="updateInterval">

        <item name="1000">Every 1 second</item>

        <item name="5000">Every 5 seconds</item>

        <item name="30000">Every 30 seconds</item>

        <item name="60000">Every 1 minute</item>

        <item name="300000">Every 5 minutes</item>

    </string-array>

    <string-array name="updateIntervalValues">

        <item name="1000">1000</item>

        <item name="5000">5000</item>

        <item name="30000">30000</item>

        <item name="60000">60000</item>

        <item name="300000">300000</item>

    </string-array>

</resources>

Добавлю еще один полезный момент, который может пригодиться. Очень часто необходимо ограничить доступ к приложению с помощью пароля или PIN кода который задается в конфигурации приложения. Очевидно что для этих целей используется EditTextPreference. Но было бы неплохо в случае пароля или PIN-кода скрывать введенные символы, а для кода еще и ограничить ввод только цифрами. Для этого можно использовать атрибуты android:password и android:inputType соответственно:

<EditTextPreference

            android:key="pin"

            android:title="PIN code"

            android:summary="If login screen is enabled"

            android:dialogTitle="PIN code"

            android:dialogMessage="Provide a PIN"

            android:defaultValue=""

            android:inputType="number"

            android:password="true"

            android:dependency="runLoginScreen"

/>

Как говорилось выше, основную часть работы берет на себя сам andriod-фреймворк. Для того чтобы показать как читать уже заданные параметры мы создадим еще одну активность экрана, которая будет запускаться из нашей главной активности. Но вначале посмотрим на код главной:

package com.javacodegeeks.android.preferences;

import android.content.Intent;

import android.os.Bundle;

import android.preference.PreferenceActivity;

import android.view.Menu;

import android.view.MenuItem;

public class QuickPrefsActivity extends PreferenceActivity {

    @Override

    public void onCreate(Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);

        addPreferencesFromResource(R.xml.preferences);

    }

    @Override

    public boolean onCreateOptionsMenu(Menu menu) {

        menu.add(Menu.NONE, 0, 0, "Show current settings");

        return super.onCreateOptionsMenu(menu);

    }

    @Override

    public boolean onOptionsItemSelected(MenuItem item) {

        switch (item.getItemId()) {

            case 0:

                startActivity(new Intent(this, ShowSettingsActivity.class));

                return true;

        }

        return false;

    }

}

Мы создали опционное меню с одним элементом MenuItem с помощью метода onCreateOptionsMenu. Когда пользователь кликает на элемент меню, мы обрабатываем это событие в методе onOptionsItemSelected и запускаем новую активность используя метод startActivity. (подробнее Using options menus and customized dialogs for user interaction, Launching new activities with intents).

Теперь создадим вторую активность ShowSettingsActivity для отображения параметров конфигурации приложения. Но вначале мы должны описать новую активность в manifest файле AndroidManifest.xml:

<?xml version="1.0" encoding="utf-8"?>

<manifest xmlns:android="schemas.android.com/apk/res/android"

      package="com.javacodegeeks.android.preferences"

      android:versionCode="1"

      android:versionName="1.0">

    <application android:icon="@drawable/icon" android:label="@string/app_name">

        <activity android:name=".QuickPrefsActivity" android:label="@string/app_name">

            <intent-filter>

                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />

            </intent-filter>

        </activity>

        <activity android:name=".ShowSettingsActivity" />

    </application>

    <uses-sdk android:minSdkVersion="3" />

</manifest>

Код второй активности выглядит так:

package com.javacodegeeks.android.preferences;

import android.app.Activity;

import android.content.SharedPreferences;

import android.os.Bundle;

import android.preference.PreferenceManager;

import android.widget.TextView;

public class ShowSettingsActivity extends Activity {

    @Override

    protected void onCreate(Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);

        setContentView(R.layout.show_settings_layout);

        SharedPreferences sharedPrefs = PreferenceManager.getDefaultSharedPreferences(this);

        StringBuilder builder = new StringBuilder();

        builder.append("n" + sharedPrefs.getBoolean("perform_updates", false));

        builder.append("n" + sharedPrefs.getString("updates_interval", "-1"));

        builder.append("n" + sharedPrefs.getString("welcome_message", "NULL"));

        TextView settingsTextView = (TextView) findViewById(R.id.settings_text_view);

        settingsTextView.setText(builder.toString());

    }

}

Здесь мы извлекаем параметры конфигурации приложения в виде класса SharedPreferences с помощью статического метода getDefaultSharedPreferences класса PreferenceManager. Далее, в зависимости от типа данных параметра, мы используем соответствующий метод извлечения данных (например getBoolean или getString). Второй аргумент в методе извлечения данных — значение по умолчанию, на тот случай если параметр с таким именем еще не был задан. В качестве имен параметров мы используем ключи заданные в XML файле preferences.xml. Значения параметров конкатенируются и выводятся в TextView.

Вот описание простого пользовательского интерфейса для второй активности:

<?xml version="1.0" encoding="utf-8"?>

<LinearLayout

    xmlns:android="schemas.android.com/apk/res/android"

    android:orientation="vertical"

    android:layout_width="fill_parent"

    android:layout_height="fill_parent"

    >

    <TextView

        android:id="@+id/settings_text_view"

        android:layout_width="fill_parent"

        android:layout_height="wrap_content"

    />

</LinearLayout>

Давайте запустим приложение, мы увидим список наших параметров:

Кликаем на “Updates Interval” и видим список возможных значений:

Список возможных значений параметра

Кликаем на “Welcome Message” и видим редактирование текста приветствия:

Редактирования текста приветствия

Посмотрим на заданные параметры. Кликнете на кнопке меню и выберете единственный элемент “Show current settings”. Запуститься вторая активность в которой мы увидим значения наших параметров конфигурации:

Это все. Как видите, это действительно просто. Удачи!

Оригинал: Android Quick Preferences Tutorial

Конфигурация приложения в Android: быстрая разработка