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); >>
Android: использование SharedPreferences для сохранения настроек
Для большинства приложений требуется сохранить настройки, управляющие поведением программы. Android предоставляет несколько альтернативных способов сохранения данных приложения, каждый из которых оптимизирован для определенных нужд.
Общие настройки — простой и легкий механизм, основанный на парах «ключ — значение» и предназначенный для сохранения примитивных данных приложения, чаще всего пользовательских настроек.
- Введение
- Создание и сохранение настроек
- Получение общих настроек
- Очистка/удаление значения
- Preferences Framework
- PreferenceScreen
- settings.xml
- Определение параметров в string.xml и array.xml
- PreferenceActivity
- Отслеживание изменений в общих настройках
- This function is not relevant for a modern fragment-based PreferenceActivity
Введение
Класс SharedPreferences позволяет создавать в приложении именованные ассоциативные массивы типа «ключ — значение», которые могут быть использованы различными компонентами приложения (работая при этом в контексте одного и того же приложения).
Общие настройки поддерживают базовые типы boolean, string, float, long и integer, что делает их идеальным средством для быстрого сохранения значений по умолчанию, переменных экземпляра класса, текущего состояния UI и пользовательских настроек.
Создание и сохранение настроек
Чтобы создать или изменить Общие настройки, нужно вызвать метод getSharedPreferences в контексте приложения, передавая имя общих настроек, которые вы хотите изменить. Настройки недоступны для других приложений.
public static String MY_PREF = "MY_PREF"; protected void savePreferences() < // получить доступ к объекту Editor, чтобы изменить общие настройки. SharedPreferences.Editor editor = mySharedPreferences.edit(); // задать новые базовые типы в объекте общих настроек. editor.putBoolean("isTrue", true); editor.putFloat("floatNumber", 1f); editor.putInt("intNumber", 2); editor.putLong("longNumber", 3l); editor.putString("textValue", "Not Empty"); editor.commit(); >
Получение общих настроек
Надо передать в getSharedPreferences имя тех общих настроек, доступ к которым хотите получить, и используйте типизированный метод get , чтобы извлечь сохраненные значения. Передаются ключ и значение по умолчанию (используется случае, если для данного ключа пока что не сохранено никакое значение).
public static String MY_PREF = «MY_PREF»; public void loadPreferences()
Очистка/удаление значения
Для очистки значений используйте методы SharedPreferences.Editor.remove(String key) и SharedPreferences.Editor.clear() .
Файл настроек хранится в /data/data/package_name/shared_prefs/имя_файла_настроек.xml. Можно удалить:
File file= new File("/data/data/. /shared_prefs/файл_настроек.xml") file.delete();
Preferences Framework
В примерах выше происходило обычное сохранение и восстанавлениеи нужных параметров. То есть, создаётся свой xml-файл разметки и размещаются там нужные элементы управления. Но Android для этих целей предоставляет собственный Preferences Framework, с помощью которого можно создавать индивидуальный набор предпочтений и встраивать их в приложения.
То есть, теперь нет необходимости создавать файл разметки и get/set параметров писать самим. Необходимо лишь в отдельном файле перечислить параметры, а Android уже остальное сделает. Предпочтения — это отдельная активность в приложении, вызываемая из активности. Сам Activity расширяется от класса PreferenceActivity . Предпочтения определяются в отдельном XML-файле, где корневым элементом является элемент , который представляет собой контейнер для предпочтений и может содержать дочерние элементы . Элемент также является контейнерным элементом и предназначен для объединения предпочтений в группы.
PreferenceScreen
Необходимо первоначально создать в папке res/xml/ XML-файл ресурсов, как например, settings.xml. Выбирайте тип файла Android XML File:
При создании файла в диалоговом окне установите переключатель на Preference и убедитесь, что корневым элементом файла установлен PreferenceScreen:
settings.xml
Далее задаём необходимые настройки:
Мы определили две настройки: размер шрифта, язык приложения. С всё в целом понятно, простое поле. А вот для выбора языка посложнее элемент. Нас тут интересует 2 поля: android:entries и android:entryValues . Из названия, думаю, понятно их назначение.
Определение параметров в string.xml и array.xml
Естественно, необходимо определить все переменные. В string.xml:
Стиль Размер Настройки интерфейса Размер шрифта Устанавливает новый размер шрифта Введите размер шрифта (от 10 до 32) Язык приложения Устанавливает стиль для шрифта Выберите язык Настройки
А так же в array.xml:
- Язык аппарата
- English
- Русский
- default
- en
- ru
PreferenceActivity
Для PreferenceActivity автоматически создаётся SettingsActivity . Нам в нём слегка необходимо изменить метод onCreate .
@Override public void onCreate(Bundle savedInstanceState)
Метод addPreferencesFromResource() считывает установленные настройки из XML-файла, где хранятся наши ресурсы, и делает их доступными для программы. В результате мы должны увидеть настройки на экране. Если автоматически наше Activity не было зарегестрировано, то добавим в манифесте AndroidManifest.xml:
Ну и напишем код, чтобы при клике на меню, открывалось наше окно с настройками. Для этого определим метод по созданию меню и onCreateOptionsMenu и метод, отслеживающий нажатия по меню onOptionsItemSelected :
public static final int IDM_PREF = 101; @Override public boolean onCreateOptionsMenu(Menu menu ) < menu.add(0, IDM_PREF, 0, "Настройки"); return super.onCreateOptionsMenu(menu); >@Override public boolean onOptionsItemSelected(MenuItem item) < Intent intent = new Intent(); switch (item.getItemId()) < case IDM_PREF: intent.setClass(this, SettingsActivity.class); startActivity(intent); break; >>
Теперь при вызове меню опций, нажимайте на пункт «Настройки» и откроется наше окно настроек.
Для сохранения предпочтений на выбор есть 4 класса:
- CheckBoxPreference
- EditTextPreference
- ListPreference
- RingtonePreference
Конкретно в данном примере используется EditTextPreference и ListPreference.
Так выглядит окно изменения для настроек:
Отслеживание изменений в общих настройках
Класс onSharedPreferenceChangeListener позволяет вызвать callback-метод в момент добавления, удаления или изменения конкретной Общей настройки. Используя этот обработчик, компоненты вашего приложения могут следить за изменениями в настройках, установленных пользователем, и обновлять пользовательский интерфейс или корректировать поведение программы.
This function is not relevant for a modern fragment-based PreferenceActivity
This function is not relevant for a modern fragment-based PreferenceActivity. Inflates the given XML resource and adds the preference hierarchy to the current preference hierarchy.
Такое сообщение вы увидите в SDK по поводу многих методов PreferenceActivity , у того же addPreferencesFromResource . Это означает, что методы устарели. В сущности, ничего фатального в этом нет, просто в более поздних версиях появились более удобные методы.
С версии 3.0 появились так называемые Fragments, с помощью которых можно работать с настройками.
Ещё раз повторю, если у вас старый вариант для работы с настройками используется, то он будет работать на всех устройствах нормально. Но если вы пишите для устройств с версией Android 3+, то лучше используйте фрагменты.
Не могу получить значение SharedPreferences в другой активити
Проблема в том, что bl всегда равен false . Перечитав литературу, заметил, что SharedPreferences работает только с одной активностью. Подскажите, как сохранить и получить значение правильно? P.S. Я сохраняю значение настройки, которое равно true или false (по умолчанию) в одном активити, а в другом должен получить данное значение, в зависимости от которого изменить поведение кнопки.
Отслеживать
36.8k 6 6 золотых знаков 48 48 серебряных знаков 125 125 бронзовых знаков
задан 3 авг 2016 в 11:38
1,093 13 13 серебряных знаков 26 26 бронзовых знаков
вы уверены, что ON_CAMERA у вас одинаковый и там и там?
3 авг 2016 в 11:40
@metalurgus, да
3 авг 2016 в 11:41
1 ответ 1
Сортировка: Сброс на вариант по умолчанию
Чтобы получить экземпляр класса SharedPreferences для получения доступа к настройкам в коде приложения используются три метода:
getPreferences() — внутри активности, чтобы обратиться к данным одной активности;
getSharedPreferences() — внутри активности, чтобы обратиться к данным на уровне приложения;
getDefaultSharedPreferences() — из объекта PreferencesManager , чтобы получить общедоступную настройку, предоставляемую Android.
Для доступа к настройкам из любого места приложения, вам нужно использовать второй или третий метод:
SharedPreferences sharedPreferences = getSharedPreferences(APP_PREFERENCES, Context.MODE_PRIVATE); Android studio shared preference как забрать значения
Нередко приложению требуется сохранять небольшие кусочки данных для дальнейшего использования, например, данные о пользователе, настройки конфигурации и т.д. Для этого в 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() . Однако вся остальная работа по добавлению, получению и изменению настроек будет аналогична работает с общими настройками.