SharedPreferences
Чтобы получить экземпляр класса SharedPreferences для получения доступа к настройкам в коде приложения используются три метода:
- getPreferences() — внутри активности, чтобы обратиться к определённому для активности предпочтению;
- getSharedPreferences() — внутри активности, чтобы обратиться к предпочтению на уровне приложения;
- getDefaultSharedPreferences() — из объекта PreferencesManager, чтобы получить общедоступную настройку, предоставляемую Android.
Все эти методы возвращают экземпляр класса SharedPreferences, из которого можно получить соответствующую настройку с помощью ряда методов:
- getBoolean(String key, boolean defValue)
- getFloat(String key, float defValue)
- getInt(String key, int defValue)
- getLong(String key, long defValue)
- getString(String key, String defValue)
Обратите внимание, что тип double не поддерживается.
Чтобы создать или изменить Общие настройки, нужно вызвать метод getSharedPreferences в контексте приложения, передав имя общих настроек (имя файла):
SharedPreferences mySharedPreferences = getSharedPreferences(APP_PREFERENCES, Context.MODE_PRIVATE);
По умолчанию используется MODE_PRIVATE — только приложение имеет доступ к настройкам. Также существуют другие режимы, с которыми практически не встречался.
- MODE_APPEND — присоединяет новые настройки к существующим
- MODE_ENABLE_WRITE_AHEAD_LOGGING
- MODE_MULTI_PROCESS
- MODE_WORLD_READABLE — позволяет другим приложениям читать настройки
- MODE_WORLD_WRITEABLE — позволяет другим приложениям записывать новые настройки
Для любознательных могу добавить, что файлы настроек хранятся в каталоге /data/data/имя_пакета/shared_prefs/имя_файла_настроек.xml. Поэтому в отладочных целях, если вам нужно сбросить настройки в эмуляторе, то при помощи перспективы DDMS, используя файловый менеджер, зайдите в нужную папку, удалите файл настроек и перезапустите эмулятор, так как эмулятор хранит данные в памяти, которые он сбрасывает в файл. На устройстве вы можете удалить программу и поставить ее заново, то же самое можно сделать и на эмуляторе, что бывает проще, чем удалять файл настроек вручную и перезапускать эмулятор.
Если открыть файл настроек текстовым редактором, то можно увидеть приблизительно такое:
В данном случае в настройках хранятся только строковые значения.
Сохранение значений параметров
Для удобства создадим константу для имени файла настроек, например:
// это будет именем файла настроек public static final String APP_PREFERENCES = "mysettings";
Далее нужно создать параметры, которые вы хотите сохранять в настройках. Удобнее их сделать константами:
public static final String APP_PREFERENCES_NAME = "Nickname"; // имя кота public static final String APP_PREFERENCES_AGE = "Age"; // возраст кота
Когда вы определили названия параметров, то можете сохранять любые значения этих параметров. Для этого создаём переменную, представляющую экземпляр класса SharedPreferences:
SharedPreferences mSettings;
Внутри метода onCreate() вы инициализируете эту переменную:
mSettings = getSharedPreferences(APP_PREFERENCES, Context.MODE_PRIVATE);
Вы передаёте в указанный метод название вашего файла (он будет создан автоматически) и стандартное разрешение, дающее доступ только компонентам приложения.
Чтобы внести изменения в настройки (редактировать), нужно использовать класс SharedPreferences.Editor. Получить объект Editor можно через вызов метода edit объекта SharedPreferences, который вы хотите изменить. После того, как вы внесли все необходимые изменения, вызовите метод commit() или apply() объекта Editor, чтобы изменения вступили в силу. Метод apply() появился в API 9 и работает в асинхронном режиме, что является более предпочтительным вариантом. Метод commit() приходится использовать для старых версий и кроме того, он возвращает значение true в успешном случае и false в случае ошибки. Если вам надо отслеживать ошибки, то используйте его.
Предположим, что у нас есть два текстовых поля, где пользователь должен ввести имя кота и его и возраст. Чтобы сохранить параметр, нужно получить текст, который ввел пользователь, через метод getText().toString():
EditText editNickname = findViewById(R.id.editNickname); String strNickName = editNickname.getText().toString(); // здесь содержится текст, введенный в текстовом поле
Получив нужный текст, сохраняем его через метод putString() (есть также putLong(), putBoolean() и т.п.):
Editor editor = mSettings.edit(); editor.putString(APP_PREFERENCES_NAME, strNickName); editor.apply();
Как правило, параметры сохраняют в методах активности onPause() или onStop() в тех случаях, когда данные требуются сохранить между запусками приложения. Но могут быть и другие сценарии.
Чтение значений параметров
Для считывания данных при загрузке приложения обычно используют методы onCreate() или onResume(). Нам нужно получить доступ к настройкам программы и проверить, есть ли среди них нужный нам параметр. Нас интересует ключ Nickname. Если мы его найдём, то загрузим его значение в текстовое поле.
if(mSettings.contains(APP_PREFERENCES_NAME))
В этих строчках кода мы проверили существование параметра APP_PREFERENCES_NAME и получили его значение через getString(), передавая ключ и значение по умолчанию (используется в том случае, если для данного ключа пока что не сохранено никакое значение). Осталось только загрузить полученный результат в текстовое поле.
Аналогично поступаем и с другими параметрами через методы get() (getLong, getBoolean() и т.д.).
Если вам ещё не понятно, то ниже исходный код:
Показать код (щелкните мышкой)
package ru.alexanderklimov.pref; import . public class MainActivity extends Activity < // имя настройки public static final String APP_PREFERENCES = "mysettings"; public static final String APP_PREFERENCES_NICKNAME = "Nickname"; public static final String APP_PREFERENCES_AGE = "Age"; SharedPreferences mSettings; EditText editNickname; TextView tvInfo; @Override public void onCreate(Bundle savedInstanceState) < super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); mSettings = getSharedPreferences(APP_PREFERENCES, Context.MODE_PRIVATE); editNickname = findViewById(R.id.editNickname); tvInfo = findViewById(R.id.tvInfo); >// Щелчки кнопок public void onClick(View v) < switch (v.getId()) < // Кнопка сохранения данных case R.id.buttonSave: // здесь содержится текст, введенный в текстовом поле String strNickName = editNickname.getText().toString(); Editor editor = mSettings.edit(); editor.putString(APP_PREFERENCES_NICKNAME, strNickName); editor.apply(); break; // Кнопка извлечения данных case R.id.buttonGet: if (mSettings.contains(APP_PREFERENCES_NICKNAME)) < // выводим данные в TextView tvInfo.setText(mSettings.getString(APP_PREFERENCES_NICKNAME, "")); >break; > > >
Можно получить ассоциативный массив со всеми ключами и значениями через метод getAll(). После этого можно проверить наличие конкретного ключа с помощью метода contains().
Map allPreferences = mySharedPreferences.getAll(); boolean containtsNickName = mySharedPreferences.contains(APP_PREFERENCES_NICKNAME);
Очистка значений
Для очистки значений используйте методы SharedPreferences.Editor.remove(String key) и SharedPreferences.Editor.clear().
Методы getStringSet() и putStringSet()
Начиная с API 11, у класса SharedPreferences появился новый метод getStringSet(), а у класса SharedPreferences.Editor родственный ему метод putStringSet(). Данные методы позволяют работать с наборами строк, что бывает удобно при большом количестве настроек, которые нужно сразу записать или считать.
SharedPreferences sp; String catnames; // записываем имена котов в файл настроек public void onPutSettings(View v) < Setcatnames = new HashSet(); catnames.add("Мурзик"); catnames.add("Барсик"); catnames.add("Рыжик"); Editor e = sp.edit(); e.putStringSet("strSetKey", catnames); e.apply(); > // считываем имена котов обратно public void onShowSettings(View v) < Setret = sp.getStringSet("strSetKey", new HashSet()); for(String r : ret) < Log.i("Share", "Имя кота: " + r); >>
Удаление файла
Как я уже сказал, файл настроек хранится в /data/data/имя_пакета/shared_prefs/имя_файла_настроек.xml. Вы можете удалить его программно, например так:
File file= new File("/data/data/. /shared_prefs/вашфайл.xml") file.delete();
Учтите, что данные могут оставаться в памяти и временном файле *.bak. Поэтому, даже после удаления файла, он может заново воссоздаться. Вообще удалять файл не рекомендуется. Он автоматически удалится при удалении самой программы.
Метод getPreferences() — Сохранение состояния активности
Если вы хотите сохранить информацию, которая принадлежит активности и не должна быть доступна другим компонентам (например, переменным экземпляра класса), вы можете вызвать метод Activity.getPreferences() без указания названия Общих настроек. Доступ к возвращённому ассоциативному массиву Общих настроек ограничен активностью, из которой он был вызван. Каждая активность поддерживает только один безымянный объект Общих настроек.
// Java protected void saveActivityPreferences() < // Создайте или извлеките объект настроек активности. SharedPreferences activityPreferences = getPreferences(Activity.MODE_PRIVATE); // Извлеките редактор, чтобы изменить Общие настройки. SharedPreferences.Editor editor = activityPreferences.edit(); // Извлеките представление. TextView myTextView = (TextView)findViewById(R.id.myTextView); // Запишите новые значения примитивных типов в объект Общих настроек. editor.putString("currentTextValue", myTextView.getText().toString()); // Сохраните изменения. editor.commit(); >
// Kotlin val prefs = getPreferences(Context.MODE_PRIVATE)
Сохранение настроек на SD-карту
Сам файл с настройками хранится в системе и обычному пользователю он не виден. Если вам понадобится получить все значения, хранимые в настройках, то вы можете считать все данные при помощи метода getAll() и записать их в файл, который можно сохранить на SD-карте:
private void saveSharedPreferences() < // создадим для примера несколько строчек с настройками. Вы можете пропустить этот код SharedPreferences prefs = getSharedPreferences("MyPrefs", MODE_PRIVATE); SharedPreferences.Editor prefEdit = prefs.edit(); prefEdit.putBoolean("SomeBooleanValue_True", true); prefEdit.putInt("SomeIntValue_100", 100); prefEdit.putFloat("SomeFloatValue_1.11", 1.11f); prefEdit.putString("SomeStringValue_Unicorns", "Unicorns"); prefEdit.commit(); // Теперь сам пример File myPath = new File(Environment.getExternalStorageDirectory().toString()); File myFile = new File(myPath, "MySharedPreferences"); try < FileWriter fw = new FileWriter(myFile); PrintWriter pw = new PrintWriter(fw); MapprefsMap = prefs.getAll(); for(Map.Entry entry : prefsMap.entrySet()) < pw.println(entry.getKey() + ": " + entry.getValue().toString()); >pw.close(); fw.close(); > catch (Exception e) < // what a terrible failure. Log.wtf(getClass().getName(), e.toString()); >>
Я у тебя первый?
Предположим, вы хотите выводить пользователю какую-то информацию при первом запуске приложения (краткую инструкцию, заставку и т.п.).
public class SharedPreferencesExample extends Activity < private static final String MY_SETTINGS = "my_settings"; @Override protected void onCreate(Bundle savedInstanceState) < super.onCreate(savedInstanceState); setContentView(R.layout.main); SharedPreferences sp = getSharedPreferences(MY_SETTINGS, Context.MODE_PRIVATE); // проверяем, первый ли раз открывается программа boolean hasVisited = sp.getBoolean("hasVisited", false); if (!hasVisited) < // выводим нужную активность Editor e = sp.edit(); e.putBoolean("hasVisited", true); e.commit(); // не забудьте подтвердить изменения >> >
Запомнить пользователя
Иногда требуется запомнить имя пользователя или другие данные (пин-код, номер телефона и т.д.). В этом случае вам также подойдут предпочтения, когда вы просто сохраняете нужную строку из текстового поля:
EditText userNameLogin = findViewById(R.id.login_editText); String userName = userNameLogin.getText().toString(); Editor e = sp.edit(); e.putString("userName", userName); e.commit();
Запомнить состояние переключателей
Если нужно запомнить состояние переключателей, то код может быть таким. Создадим разметку с тремя переключателями.
Код, который отслеживает выбор переключателя и записывает состояние в настройки.
package ru.alexanderklimov.pref; import . public class MainActivity extends Activity < RadioGroup radioGroup; // это будет именем файла настроек public static final String APP_PREFERENCES = "mysettings"; final String KEY_RADIOBUTTON_INDEX = "SAVED_RADIO_BUTTON_INDEX"; @Override protected void onCreate(Bundle savedInstanceState) < super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); radioGroup = findViewById(R.id.radiogroup); radioGroup .setOnCheckedChangeListener(radioGroupOnCheckedChangeListener); LoadPreferences(); >OnCheckedChangeListener radioGroupOnCheckedChangeListener = new OnCheckedChangeListener() < @Override public void onCheckedChanged(RadioGroup group, int checkedId) < RadioButton checkedRadioButton = (RadioButton) radioGroup .findViewById(checkedId); int checkedIndex = radioGroup.indexOfChild(checkedRadioButton); SavePreferences(KEY_RADIOBUTTON_INDEX, checkedIndex); >>; private void SavePreferences(String key, int value) < SharedPreferences sharedPreferences = getSharedPreferences( APP_PREFERENCES, MODE_PRIVATE); SharedPreferences.Editor editor = sharedPreferences.edit(); editor.putInt(key, value); editor.apply(); >private void LoadPreferences() < SharedPreferences sharedPreferences = getSharedPreferences( APP_PREFERENCES, MODE_PRIVATE); int savedRadioIndex = sharedPreferences.getInt( KEY_RADIOBUTTON_INDEX, 0); RadioButton savedCheckedRadioButton = (RadioButton) radioGroup .getChildAt(savedRadioIndex); savedCheckedRadioButton.setChecked(true); >>
getDefaultSharedPreferences()
В используемых примерах я использовал getSharedPreferences() с придумыванием имени файла для хранения настроек. Этот способ придаёт гибкости в том случае, когда вам нужно создать несколько отдельных файлов. Но если вам нужен один файл, то можно ничего не придумывать, а использовать метод getDefaultSharedPreferences() из объекта PreferencesManager. Система сама сгенерирует имя файла из имени вашего пакета с добавлением слова _preferences. Вот как выглядит связка из трёх методов в исходниках Android (обратите внимание на выделенный текст).
public static SharedPreferences getDefaultSharedPreferences(Context context) < return context.getSharedPreferences(getDefaultSharedPreferencesName(context), getDefaultSharedPreferencesMode()); >private static String getDefaultSharedPreferencesName(Context context) < return context.getPackageName() + "_preferences"; > private static int getDefaultSharedPreferencesMode()
Поэтому примеры можно переделать следующим образом.
SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this); Editor edit = sharedPreferences.edit(); edit.putBoolean("sly", false); edit.commit();
Удаляем файл настроек
В API 24 появился новый метод, позволяющий удалить сам файл настроек. До этого можно было удалить своими силами, зная его местоположение. Поэтому универсальный код будет приблизительно следующим.
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) < context.deleteSharedPreferences(preferencesKey); >else < try < FileUtils.cleanDirectory(new File(context.getCacheDir().getParent() + "/shared_prefs/")); >catch (IOException e) < Log.e(TAG, "Cannot delete files in shared pref directory", e); >>
Preferences android studio где
Нередко приложению требуется сохранять небольшие кусочки данных для дальнейшего использования, например, данные о пользователе, настройки конфигурации и т.д. Для этого в Android существует концепция Preferences или настройки. Настройки представляют собой группу пар ключ-значение, которые используются приложением.
В качестве значений могут выступать данные следующих типов: Boolean, Float, Integer, Long, String, набор строк.
Настройки общими для всех activity в приложении, но также могут быть и настройки непосредственно для отдельных activity
Настройки хранятся в xml-файлах в незашифрованном виде в локальном хранилище. Они невидимы, поэтому для простого пользователя недоступны.
При работе с настройками следует учитывать следующие моменты. Так как они хранятся в незашифрованном виде, то не рекомендуется сохранять в них чувствительные данные типа пароля или номеров кредитных карт. Кроме того, они представляют данные, ассоцииованные с приложением, и через панель управления приложением в Настройках ОС пользователь может удалить эти данные.
Общие настройки
Для работы с разделяемыми настройками в классе Activity (точнее в его базовом классе Context) имеется метод getSharedPreferences() :
import android.content.SharedPreferences; //. SharedPreferences settings = getSharedPreferences("PreferencesName", MODE_PRIVATE);
Первый параметр метода указывает на название настроек. В данном случае название — «PreferencesName». Если настроек с подобным названием нет, то они создаются при вызове данного метода. Второй параметр указывает на режим доступа. В данном случае режим описан константой MODE_PRIVATE
Класс android.content.SharedPreferences предоставляет ряд методов для управления настройками:
- contains(String key) : возвращает true, если в настройках сохранено значение с ключом key
- getAll() : возвращает все сохраненные в настройках значения
- getBoolean (String key, boolean defValue) : возвращает из настроек значение типа Boolean, которое имеет ключ key. Если элемента с таким ключом не окажется, то возвращается значение defValue, передаваемое вторым параметром
- getFloat(String key, float defValue) : возвращает значение типа float с ключом key. Если элемента с таким ключом не окажется, то возвращается значение defValue
- getInt(String key, int defValue) : возвращает значение типа int с ключом key
- getLong(String key, long defValue) : возвращает значение типа long с ключом key
- getString(String key, String defValue) : возвращает строковое значение с ключом key
- getStringSet(String key, Set defValues) : возвращает массив строк с ключом key
- edit() : возвращает объект SharedPreferences.Editor , который используется для редактирования настроек
Для управления настройками используется объект класса SharedPreferences.Editor , возвращаемый метод edit() . Он определяет следующие методы:
- clear() : удаляет все настройки
- remove(String key) : удаляет из настроек значение с ключом key
- putBoolean(String key, boolean value) : добавляет в настройки значение типа boolean с ключом key
- putFloat(String key, float value) : добавляет в настройки значение типа float с ключом key
- putInt(String key, int value) : добавляет в настройки значение int с ключом key
- putLong(String key, long value) : добавляет в настройки значение типа long с ключом key
- putString(String key, String value) : добавляет в настройки строку с ключом key
- putStringSet(String key, Set values) : добавляет в настройки строковый массив
- commit() : подтверждает все изменения в настройках
- apply() : также, как и метод commit(), подтверждает все изменения в настройках, однако измененный объект SharedPreferences вначале сохраняется во временной памяти, и лишь затем в результате асинхронной операции записывается на мобильное устройство
Рассмотрим пример сохранения и получения настроек в приложении. Определим в файле activity_main.xml следующий пользовательский интерфейс:
На экране будут две кнопки — для сохранения и для вывода ранее сохраненного значения, а также поле для ввода и текстовое поля ля вывода сохраненной настройки.
Определим методы обработчики кнопок в классе MainActivity :
package com.example.settingsapp; import androidx.appcompat.app.AppCompatActivity; import android.content.SharedPreferences; import android.os.Bundle; import android.view.View; import android.widget.EditText; import android.widget.TextView; public class MainActivity extends AppCompatActivity < private static final String PREFS_FILE = "Account"; private static final String PREF_NAME = "Name"; SharedPreferences settings; @Override protected void onCreate(Bundle savedInstanceState) < super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); settings = getSharedPreferences(PREFS_FILE, MODE_PRIVATE); >public void saveName(View view) < // получаем введенное имя EditText nameBox = findViewById(R.id.nameBox); String name = nameBox.getText().toString(); // сохраняем его в настройках SharedPreferences.Editor prefEditor = settings.edit(); prefEditor.putString(PREF_NAME, name); prefEditor.apply(); >public void getName(View view) < // получаем сохраненное имя TextView nameView = findViewById(R.id.nameView); String name = settings.getString(PREF_NAME,"не определено"); nameView.setText(name); >>
При отсутствии настроек при попытке их получить, приложение выведет значение по умолчанию:

Теперь сохраним и выведем заново сохраненное значение:

Нередко возникает задача автоматически сохранять вводимые данные при выходе пользователя из activity. Для этого мы можем переопределить метод onPause:
package com.example.settingsapp; import androidx.appcompat.app.AppCompatActivity; import android.content.SharedPreferences; import android.os.Bundle; import android.view.View; import android.widget.EditText; public class MainActivity extends AppCompatActivity < private static final String PREFS_FILE = "Account"; private static final String PREF_NAME = "Name"; EditText nameBox; SharedPreferences settings; SharedPreferences.Editor prefEditor; @Override protected void onCreate(Bundle savedInstanceState) < super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); nameBox = findViewById(R.id.nameBox); settings = getSharedPreferences(PREFS_FILE, MODE_PRIVATE); // получаем настройки String name = settings.getString(PREF_NAME,""); nameBox.setText(name); >@Override protected void onPause() < super.onPause(); String name = nameBox.getText().toString(); // сохраняем в настройках prefEditor = settings.edit(); prefEditor.putString(PREF_NAME, name); prefEditor.apply(); >public void saveName(View view) < >public void getName(View view) < >>
Приватные настройки
Кроме общих настроек каждая activity может использовать приватные, к которым доступ из других activity будет невозможен. Для получения настроек уровня activity используется метод getPreferences(MODE_PRIVATE) :
import android.content.SharedPreferences; //. SharedPreferences settings = getPreferences(MODE_PRIVATE);
То есть в отличие от общих настроек здесь не используется название группы настроек в качестве первого параметра, как в методе getSharedPreferences() . Однако вся остальная работа по добавлению, получению и изменению настроек будет аналогична работает с общими настройками.
SharedPreferences. Сохранение данных в постоянное хранилище Android
SharedPreferences – постоянное хранилище на платформе Android, используемое приложениями для хранения своих настроек, например. Это хранилище является относительно постоянным, пользователь может зайти в настройки приложения и очистить данные приложения, тем самым очистив все данные в хранилище.
Для работы с данными постоянного хранилища нам понадобится экземпляр класса SharedPreferences, который можно получить у любого объекта, унаследованного от класса android.content.Context (например, Activity или Service). У объектов этих классов (унаследованных от Context) есть метод getSharedPreferences, который принимает 2 параметра:
- name – выбранный файл настроек. Если файл настроек с таким именем не существует, он будет создан при вызове метода edit() и фиксировании изменений с помощью метода commit().
- mode – режим работы. Возможные значения:
- MODE_PRIVATE – используется в большинстве случаев для приватного доступа к данным приложением-владельцем
- MODE_WORLD_READABLE – только для чтения
- MODE_WORLD_WRITEABLE – только записи
- MODE_MULTI_PROCESS – несколько процессов совместно используют один файл SharedPreferences.
ВНИМАНИЕ! Все модификаторы кроме MODE_PRIVATE в настоящий момент объявлены deprecated и не рекомендуются к использованию в целях безопасности. Если необходимо реализовать использование общих данных несколькими приложениями, это можно сделать через сервисы или контент-провайдеры. Подробнее можно почитать, например, здесь.
Чтобы получить значение необходимой переменной, используйте следующие методы объекта SharedPreferences:
- getBoolean(String key, boolean defValue),
- getFloat(String key, float defValue),
- getInt(String key, int defValue),
- getLong(String key, long defValue),
- getString(String key, String defValue),
- getStringSet(String key, Set defValues).
Второй параметр – значение, которое вернется в случае если значение по ключу key отсутствует в SharedPreferences. Также, методом getAll() можно получить все доступные значения.
Чтобы записать значение переменной необходимо:
- получить объект SharedPreferences.Editor выполнив метод edit() объекта класса SharedPreferences
- записать значение с помощью методов:
- putBoolean(String key, boolean value),
- putFloat(String key, float value),
- putInt(String key, int value),
- putLong(String key, long value),
- putString(String key, String value),
- putStringSet(String key, Set values)
- выполнить метод commit()
Также есть возможность удалить конкретное значение (remove(String key)) или все значения (clear())
Приведенный ниже код демонстрирует запись переменной типа String в хранилище:
SharedPreferences settings = context.getSharedPreferences(PERSISTANT_STORAGE_NAME, Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); editor.putString( "name", "John" ); editor.commit();
– context – объект, унаследованный от android.content.Context.
Представим простой класс для работы с постоянным хранилищем – PersistantStorage.
Перед записью значений в хранилище или получением значений из хранилища, класс нужно проинициализировать, вызвав метод init() и передав ему объект, унаследованный от android.content.Context (например, Activity или Service).
import android.content.Context; import android.content.SharedPreferences; public class PersistantStorage < public static final String STORAGE_NAME = "StorageName"; private static SharedPreferences settings = null; private static SharedPreferences.Editor editor = null; private static Context context = null; public static void init( Context cntxt )< context = cntxt; >private static void init() < settings = context.getSharedPreferences(STORAGE_NAME, Context.MODE_PRIVATE); editor = settings.edit(); >public static void addProperty( String name, String value ) < if( settings == null )< init(); >editor.putString( name, value ); editor.commit(); > public static String getProperty( String name ) < if( settings == null )< init(); >return settings.getString( name, null ); > >
В этом классе реализована работа только со строковыми данными. Вы легко можете самостоятельно его расширить, используя стандартные методы PersistantStorage или написав собственные сериализаторы для сложных объектов.
ВНИМАНИЕ! Метод commit() устарел и объявлен deprecated. Вместо него следует использовать метод apply() – он появился в API 9 и работает в асинхронном режиме, что является более предпочтительным вариантом.
Вам також може сподобатися

Продвинутые курсы по разработке мобильных приложений на Android 59 17 194
Записывайтесь на Продвинутый курс по созданию андроид-приложения для записи звука на языке Котлин. Разработка

Уроки по android разработке на Java 0 11 561
[:ru]Андроид обеспечивает clipboard framework (фреймворк буфера обмена) для копирования и вставки различных типов данных. Данные могут

Уроки по android разработке на Java 0 1 064
[:ru]Видеоурок о том, как конвертировать GIF-анимацию в красивые живые обои для вашего Android устройства

Архитектура андроид-приложений 0 6 010
Во второй части этой серии вы узнали, как управлять пользовательским интерфейсом при помощи корутин.
Инструменты android разработчика 0 36 248
Продолжаем работать с Firebase. В этом уроке будем тестировать сервис аутентификации. Идентификация пользователей необходима
Урок 71. Preferences как настройки приложения. PreferenceActivity
Мы уже проходили Preferences, использовали их для хранения своих данных, знаем механизм. Теперь посмотрим, как они используются для хранения настроек приложения. Android предоставляет специальное Activity для работы с настройками – PreferenceActivity. Оно умеет читать определенные xml-файлы и создавать из них экран с настройками.
Создадим простое приложение. На первом экране будем читать и отображать настройки приложения, а на втором будем их задавать с помощью PreferenceActivity.
Надо придумать какие-нибудь настройки. Пусть это будут настройки неких уведомлений, а именно возможность включить/выключить уведомления (чекбокс) и возможность прописать адрес получателя (поле для ввода текста).
Project name: P0711_PreferencesSimple
Build Target: Android 2.3.3
Application name: PreferencesSimple
Package name: ru.startandroid.develop.p0711preferencessimple
Create Activity: MainActivityСначала создадим xml-файл с описанием настроек. В папке res создаем папку xml, а в ней создаем файл pref.xml:
Здесь мы указали, что наш экран настроек (PreferenceScreen) будет содержать чекбокс (CheckBoxPreference) и поле (EditTextPreference) для ввода значения. Параметры: key – ключ для сохранения/чтения, summary – текст-пояснение, title – заголовок. Далее увидим, что и где используется.
Создаем Activity для настроек. PrefActivity.java:
package ru.startandroid.develop.p0711preferencessimple; import android.os.Bundle; import android.preference.PreferenceActivity; public class PrefActivity extends PreferenceActivity < @Override protected void onCreate(Bundle savedInstanceState) < super.onCreate(savedInstanceState); addPreferencesFromResource(R.xml.pref); >>
Вместо setContentView используется метод addPreferencesFromResource, который берет файл pref.xml и по нему создает экран настроек.
Не забудьте добавить это Activity в манифест. Тут никаких особенностей, все как обычно.
Рисуем экран main.xml:
Одно TextView, которое будет читать и отображать настройки приложения.
MainActivity.java:
package ru.startandroid.develop.p0711preferencessimple; import android.app.Activity; import android.content.Intent; import android.content.SharedPreferences; import android.os.Bundle; import android.preference.PreferenceManager; import android.view.Menu; import android.view.MenuItem; import android.widget.TextView; public class MainActivity extends Activity < TextView tvInfo; SharedPreferences sp; /** Called when the activity is first created. */ public void onCreate(Bundle savedInstanceState) < super.onCreate(savedInstanceState); setContentView(R.layout.main); tvInfo = (TextView) findViewById(R.id.tvInfo); // получаем SharedPreferences, которое работает с файлом настроек sp = PreferenceManager.getDefaultSharedPreferences(this); // полная очистка настроек // sp.edit().clear().commit(); >protected void onResume() < Boolean notif = sp.getBoolean("notif", false); String address = sp.getString("address", ""); String text = "Notifications are " + ((notif) ? "enabled, address = " + address : "disabled"); tvInfo.setText(text); super.onResume(); >public boolean onCreateOptionsMenu(Menu menu) < MenuItem mi = menu.add(0, 1, 0, "Preferences"); mi.setIntent(new Intent(this, PrefActivity.class)); return super.onCreateOptionsMenu(menu); >>В onCreate мы находим TextView и получаем объект для работы с настройками — SharedPreferences. Он нам знаком, мы с ним работали ранее в уроке про Preferences. Далее идет закоментированный код полной очистки настроек приложения. Мы его не используем, я на всякий случай указал, может кому понадобится.
В onResume мы читаем из SharedPreferences настройки и выводим их в TextView. При чтении используем те самые ключи, которые прописывали в xml-файле в атрибутах key.
В onCreateOptionsMenu просто настраиваем меню для вызова окна настроек. Мы создаем пункт меню и вешаем на него Intent — в итоге при нажатии вызовется Activity.
На всякий случай уточню, почему для вывода инфы на экран здесь использую onResume, а не onCreate. Потому что, когда мы будем возвращаться с экрана настроек в главное окно, то onCreate главного окна не сработает (т.к. окно уже создано и висит в памяти) и изменения мы не увидим. А onResume точно сработает.
Все сохраняем и запускаем приложение. Видим такой экран:
По умолчанию, если настройки еще не заданы, мы получаем false и пустую строку, как и указывали в методах getBoolean и getString в onResume.
Жмем menu и переходим к настройкам.
То, что мы указывали в pref.xml система прочитала и сама создала экран настроек. Теперь мы можем здесь указывать нужные нам значения и они сразу же будут сохраняться без всяких кнопок Save. Впрочем, это стандартное поведение Android-настроек. Думаю, каждый из вас когда-нить копался в настройках и знает это.
Давайте включим наши уведомления
и пропишем адрес
Жмем кнопку назад, попадаем на главный экран
который в onResume прочел свежие настройки и отобразил их.
На следующем уроке:
— используем в настройках список
— группируем настройки по экранам и категориямПрисоединяйтесь к нам в Telegram:
— в канале StartAndroid публикуются ссылки на новые статьи с сайта startandroid.ru и интересные материалы с хабра, medium.com и т.п.
— в чатах решаем возникающие вопросы и проблемы по различным темам: Android, Compose, Kotlin, RxJava, Dagger, Тестирование, Performance
— ну и если просто хочется поговорить с коллегами по разработке, то есть чат Флудильня