Android studio sharedpreferences int

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 в контексте приложения, передав имя общих настроек (имя файла):

По умолчанию используется MODE_PRIVATE — только приложение имеет доступ к настройкам. Также существуют другие режимы, с которыми практически не встречался.

• MODE_APPEND — присоединяет новые настройки к существующим
• MODE_ENABLE_WRITE_AHEAD_LOGGING
• MODE_MULTI_PROCESS
• MODE_WORLD_READABLE — позволяет другим приложениям читать настройки
• MODE_WORLD_WRITEABLE — позволяет другим приложениям записывать новые настройки

Для любознательных могу добавить, что файлы настроек хранятся в каталоге /data/data/имя_пакета/shared_prefs/имя_файла_настроек.xml. Поэтому в отладочных целях, если вам нужно сбросить настройки в эмуляторе, то при помощи перспективы DDMS, используя файловый менеджер, зайдите в нужную папку, удалите файл настроек и перезапустите эмулятор, так как эмулятор хранит данные в памяти, которые он сбрасывает в файл. На устройстве вы можете удалить программу и поставить ее заново, то же самое можно сделать и на эмуляторе, что бывает проще, чем удалять файл настроек вручную и перезапускать эмулятор.

Если открыть файл настроек текстовым редактором, то можно увидеть приблизительно такое:

В данном случае в настройках хранятся только строковые значения.

Сохранение значений параметров

Для удобства создадим константу для имени файла настроек, например:

Далее нужно создать параметры, которые вы хотите сохранять в настройках. Удобнее их сделать константами:

Когда вы определили названия параметров, то можете сохранять любые значения этих параметров. Для этого создаём переменную, представляющую экземпляр класса SharedPreferences:

Внутри метода onCreate() вы инициализируете эту переменную:

Вы передаёте в указанный метод название вашего файла (он будет создан автоматически) и стандартное разрешение, дающее доступ только компонентам приложения.

Чтобы внести изменения в настройки (редактировать), нужно использовать класс SharedPreferences.Editor. Получить объект Editor можно через вызов метода edit объекта SharedPreferences, который вы хотите изменить. После того, как вы внесли все необходимые изменения, вызовите метод commit() или apply() объекта Editor, чтобы изменения вступили в силу. Метод apply() появился в API 9 и работает в асинхронном режиме, что является более предпочтительным вариантом. Метод commit() приходится использовать для старых версий и кроме того, он возвращает значение true в успешном случае и false в случае ошибки. Если вам надо отслеживать ошибки, то используйте его.

Предположим, что у нас есть два текстовых поля, где пользователь должен ввести имя кота и его и возраст. Чтобы сохранить параметр, нужно получить текст, который ввел пользователь, через метод getText().toString():

Получив нужный текст, сохраняем его через метод putString() (есть также putLong(), putBoolean() и т.п.):

Как правило, параметры сохраняют в методах активности onPause() или onStop() в тех случаях, когда данные требуются сохранить между запусками приложения. Но могут быть и другие сценарии.

Чтение значений параметров

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

В этих строчках кода мы проверили существование параметра APP_PREFERENCES_NAME и получили его значение через getString(), передавая ключ и значение по умолчанию (используется в том случае, если для данного ключа пока что не сохранено никакое значение). Осталось только загрузить полученный результат в текстовое поле.

Аналогично поступаем и с другими параметрами через методы get () (getLong, getBoolean() и т.д.).

Если вам ещё не понятно, то ниже исходный код:

Показать код (щелкните мышкой)

Можно получить ассоциативный массив со всеми ключами и значениями через метод getAll(). После этого можно проверить наличие конкретного ключа с помощью метода contains().

Очистка значений

Для очистки значений используйте методы SharedPreferences.Editor.remove(String key) и SharedPreferences.Editor.clear().

Методы getStringSet() и putStringSet()

Начиная с API 11, у класса SharedPreferences появился новый метод getStringSet(), а у класса SharedPreferences.Editor родственный ему метод putStringSet(). Данные методы позволяют работать с наборами строк, что бывает удобно при большом количестве настроек, которые нужно сразу записать или считать.

Удаление файла

Как я уже сказал, файл настроек хранится в /data/data/имя_пакета/shared_prefs/имя_файла_настроек.xml. Вы можете удалить его программно, например так:

Учтите, что данные могут оставаться в памяти и временном файле *.bak. Поэтому, даже после удаления файла, он может заново воссоздаться. Вообще удалять файл не рекомендуется. Он автоматически удалится при удалении самой программы.

Метод getPreferences() — Сохранение состояния активности

Если вы хотите сохранить информацию, которая принадлежит активности и не должна быть доступна другим компонентам (например, переменным экземпляра класса), вы можете вызвать метод Activity.getPreferences() без указания названия Общих настроек. Доступ к возвращённому ассоциативному массиву Общих настроек ограничен активностью, из которой он был вызван. Каждая активность поддерживает только один безымянный объект Общих настроек.

Сохранение настроек на SD-карту

Сам файл с настройками хранится в системе и обычному пользователю он не виден. Если вам понадобится получить все значения, хранимые в настройках, то вы можете считать все данные при помощи метода getAll() и записать их в файл, который можно сохранить на SD-карте:

Я у тебя первый?

Предположим, вы хотите выводить пользователю какую-то информацию при первом запуске приложения (краткую инструкцию, заставку и т.п.).

Запомнить пользователя

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

Запомнить состояние переключателей

Если нужно запомнить состояние переключателей, то код может быть таким. Создадим разметку с тремя переключателями.

Код, который отслеживает выбор переключателя и записывает состояние в настройки.

getDefaultSharedPreferences()

В используемых примерах я использовал getSharedPreferences() с придумыванием имени файла для хранения настроек. Этот способ придаёт гибкости в том случае, когда вам нужно создать несколько отдельных файлов. Но если вам нужен один файл, то можно ничего не придумывать, а использовать метод getDefaultSharedPreferences() из объекта PreferencesManager. Система сама сгенерирует имя файла из имени вашего пакета с добавлением слова _preferences. Вот как выглядит связка из трёх методов в исходниках Android (обратите внимание на выделенный текст).

Поэтому примеры можно переделать следующим образом.

Удаляем файл настроек

В API 24 появился новый метод, позволяющий удалить сам файл настроек. До этого можно было удалить своими силами, зная его местоположение. Поэтому универсальный код будет приблизительно следующим.

Источник

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() можно получить все доступные значения.

Чтобы записать значение переменной необходимо:

1. получить объект SharedPreferences.Editor выполнив метод edit() объекта класса SharedPreferences
2. записать значение с помощью методов:
   • 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)
3. выполнить метод commit()

Также есть возможность удалить конкретное значение (remove(String key)) или все значения (clear())

Приведенный ниже код демонстрирует запись переменной типа String в хранилище:

Источник

Русские Блоги

Понимание и использование Android SharedPreferences

Пять методов хранения данных Android:

1. SharedPreferences: хранить простые параметры конфигурации в виде карты;
2. ContentProvider: предоставлять частные данные приложения другим приложениям;
3. Файловое хранилище: хранится в виде потока ввода-вывода, который можно разделить на внутреннее и внешнее хранилище мобильного телефона (SD-карта и т. Д.), Который может хранить большие данные;
4. SQLite: легкая кроссплатформенная база данных, все данные хранятся в одном файле на телефоне, занимая небольшой объем памяти;
5. Сетевое хранилище: данные хранятся на сервере, и данные получаются при подключении к сети;

Sharedpreferences — это облегченный класс хранилища на платформе Android, используемый для хранения различной информации о конфигурации приложения. Его суть — XML-файл, который сохраняет данные в виде пар «ключ-значение». Файл хранится в / data / data // каталог shared_prefs. С точки зрения глобальных переменных, его преимущество состоит в том, что он не создает проблем с приложениями, статическими переменными OOM (нехватка памяти) и нулевым указателем. Его недостатком является то, что эффективность не так высока, как у двух вышеуказанных методов.

1. Получить SharedPreferences

Чтобы использовать SharedPreferences для хранения данных, вам сначала нужно получить объект SharedPreferences. Android в основном предоставляет три метода получения объектов SharedPreferences.

1.1 Метод getSharedPreferences () в классе Context:

Этот метод получает два параметра. Первый параметр используется для указания имени файла SharedPreferences. Если указанный файл не существует, будет создан один. Второй параметр используется для указания режима работы. В основном существуют следующие режимы на выбор. MODE_PRIVATE — это режим работы по умолчанию, и эффект такой же, как при прямой передаче 0.
Два режима MODE_WORLD_READABLE и MODE_WORLD_WRITEABLE объявлены устаревшими в Android 4.2.

1.2 Метод getPreferences () в классе Activity:

Этот метод похож на метод getSharedPreferences () в контексте, но он принимает только параметр режима работы, потому что при использовании этого метода имя текущего активного класса автоматически используется как имя файла SharedPreferences.

1.3 Метод getDefaultSharedPreferences () в классе PreferenceManager:

Это статический метод, который получает параметр Context и автоматически использует имя пакета текущего приложения в качестве префикса для имени файла SharedPreferences.

2. Использование SharedPreferences

Сам объект SharedPreferences может только получать данные и не поддерживает хранение и модификацию.Модификация хранилища реализуется через объект Editor внутреннего интерфейса, полученный SharedPreferences.edit (). Используйте Preference для доступа к данным, используйте интерфейс SharedPreferences и внутренний интерфейс SharedPreferences.Editor SharedPreferences, эти два интерфейса находятся в пакете android.content;

нота: Если вы используете SharedPreferences в Fragment, вам необходимо инициализировать SharedPreferences в onAttach (Activity activity), иначе он сообщит о нулевом указателе, то есть getActivity () может вернуть null!

Шаги по чтению и записи SharedPreferences для других приложений следующие:
1. При создании SharedPreferences укажите режим MODE_WORLD_READABLE, указывая, что данные SharedPreferences могут быть прочитаны другими программами;
2. Создайте контекст, соответствующий другим приложениям;
3. Используйте контекст других программ, чтобы получить соответствующие SharedPreferences;
4. Если вы пишете данные, просто используйте интерфейс редактора, и все остальные операции будут такими же, как и раньше;

3. Анализ исходного кода SharedPreferences (API 25)

GetSharedPreferences контекста:

Мы знаем, что класс Context в Android фактически использует шаблон декоратора, а украшенный объект на самом деле является объектом ContextImpl, методом getSharedPreferences ContextImpl:

Из вышесказанного мы можем видеть отношения между ними:
（ArrayMap ）
mSharedPrefsPaths хранит сопоставление между именем и папкой. Имя здесь — это имя, передаваемое при использовании getSharedPreferences. Если mSharedPrefsPaths имеет значение null, оно будет инициализировано. Если значение файла равно null, создайте новый файл и Добавьте его в mSharedPrefsPaths;

（ ArrayMap > ）
sSharedPrefsCache сохраняет имя пакета и пару «ключ-значение» ArrayMap. по умолчанию будет использовать имя пакета в качестве ключа в паре «ключ-значение» во время инициализации. Обратите внимание, что это статическая переменная;

（ArrayMap ）
sSharedPrefs packagePrefs сохраняет имя файла и пару «ключ-значение» SharedPreferencesImpl.

нота:

1. Для того же имени SharedPreferences получается тот же объект SharedPreferences, который на самом деле является объектом SharedPreferencesImpl.
2. sSharedPrefs статичен в программе.Если вы выходите из программы, но контекст не очищается, при следующем входе в программу вы все равно можете получить значение, которое должно было быть удалено. И переключитесь на другой способ очистки SharedPreferences: использование метода фиксации SharedPreferences.Editor может работать, и он вступит в силу немедленно, без выхода из программы после вызова.

SharedPreferencesImpl объект

Видно, что для имени файла SharedPreferences первый вызов getSharedPreferences создаст объект SharedPreferencesImpl, который запустит дочерний поток, а затем прочитает все пары ключ-значение в указанном файле SharedPreferences и сохранит их в Map. в.

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

Очевидно, что для ожидания этой блокировки используется метод awaitLoadedLocked. В конце метода loadFromDiskLocked мы также видим, что он вызывает метод notifyAll. В это время, если getString заблокирован ранее, он будет активирован. Тогда здесь возникнет проблема. Наша getString записана в потоке пользовательского интерфейса. Если getString заблокирована слишком долго, например 60 секунд, в это время произойдет ANR, поэтому мы должны решить, нужно ли нам читать и записывать SharedPreferences в соответствии с конкретной ситуацией. В дочернем потоке.

Что касается mBackupFile, SharedPreferences сначала переименует предыдущий XML-файл в файл резервной копии при записи, а затем запишет данные для записи в новый файл. Если процесс выполнен успешно, файл резервной копии будет сохранен. удалять. Видно, что даже если вы каждый раз просто добавляете пару ключ-значение, данные всего файла будут перезаписаны. Это также показывает, что SharedPreferences подходит только для сохранения небольшого объема данных, а размер файла слишком велик, и возникнут проблемы с производительностью.

нота:

1. Вызов getXXX в потоке пользовательского интерфейса может вызвать ANR.
2. Когда мы инициализируем объект SharedPreferencesImpl, мы добавляем все данные в XML-файл, соответствующий SharedPreferencesImpl, для загрузки в память. Если XML-файл большой, он будет занимать много памяти. Нам нужно только прочитать значение ключа в XML-файле. Но когда мы его получим, загрузится весь файл.
3. Каждый раз, когда добавляется пара «ключ-значение», данные всего файла будут перезаписаны, а не добавочная запись; В итоге можно объяснить, что Sharedpreferences подходят только для облегченного хранилища.

Внутренний редактор классов SharedPreferences

Фактически, вы получаете объект EditorImpl, который является внутренним классом SharedPreferencesImpl:

Вы можете видеть, что у него есть объект карты mModified, который используется для сохранения «измененных данных», то есть каждый раз, когда вы вводите, вы помещаете только пару ключ-значение в этот mModified и, наконец, вызываете apply или commit, чтобы фактически поместить данные Запишите в файл, например, метод putString выше, и другие коды putXXX в основном такие же.

Разница между методом фиксации и методом применения

Оба метода сначала используют функцию commitTomemory для записи измененного содержимого в SharedPreferencesImpl, а затем вызывают enqueueDiskWrite для записи операции с диском. CommitToMemory создает «подходящий» объект mcr MemoryCommitResult, а затем этот объект необходимо передать при вызове enqueueDiskWrite, commitToMemory метод:

Здесь вам нужно выяснить два объекта mMap и mModified: mMap предназначен для хранения пар ключ-значение в текущем файле SharedPreferences, а mModified — для хранения пар ключ-значение, введенных при редактировании в это время. mDiskWritesInFlight представляет количество операций, ожидающих записи.
Вы можете видеть, что этот метод сначала обрабатывает флаг очистки, он вызывает mMap.clear (), а затем проходит через mModified, чтобы поместить новую пару «ключ-значение» в mMap, что означает, что В транзакции фиксации, если вы поместите несколько пар ключ-значение и одновременно вызовете clear, а затем выполните фиксацию, тогда будут очищены только предыдущие пары ключ-значение, а пары ключ-значение, введенные в этот раз, все равно будут записаны.
При обходе mModified необходимо иметь дело со специальным случаем, то есть, если значение пары «ключ-значение» равно this (SharedPreferencesImpl) или null, это означает, что пара «ключ-значение» удалена. Это находится в методе удаления. Видно, что если раньше был такой же ключ и значение другое, старое значение перезаписывается новым значением, а если такой же ключ не существует, оно записывается полностью. Следует отметить, что здесь используется объект синхронного редактора блокировки, чтобы гарантировать правильное сохранение текущих данных.

Следующим шагом является вызов метода enqueueDiskWrite:

Определите задачу Runnable. В Runnable сначала вызовите writeToFile для выполнения операции записи. Операция записи должна сначала получить mWritingToDiskLock, что является блокировкой записи. Затем выполните mDiskWritesInFlight–, указав, что количество операций, ожидающих записи, уменьшается на 1.
Определите, является ли postWriteRunnable нулевым, нулевым при вызове фиксации и не нулевым при вызове apply. isFromSyncCommit имеет значение true, и необходимо выполнить операцию записи, затем вызовите writeToDiskRunnable.run (), обратите внимание, что этот вызов выполняется в текущем потоке. Если это не фиксация, то примените, затем вызовите QueuedWork.singleThreadExecutor (). Execute (writeToDiskRunnable). Этот класс QueuedWork на самом деле очень прост. Существует SingleThreadExecutor для асинхронного выполнения этого writeToDiskRunnable. Операция записи фиксации выполняется в вызывающем потоке. Выполнение и внутреннее применение реализовано с помощью пула однопоточных потоков, поэтому операции записи выполняются в дочерних потоках.

Резюме фиксации и применения:

1. apply не имеет возвращаемого значения, а фиксация возвращает логическое значение, чтобы указать, успешно ли передана модификация;
2. Фиксация — это синхронная отправка содержимого на жесткий диск, а применение apply немедленно отправляет изменения в память, а затем открывает асинхронный поток для отправки на жесткий диск, и если отправка не удалась, вы не получите никаких уведомлений.
3. Вся отправка фиксации является синхронным процессом, и эффективность будет ниже, чем при применении асинхронной отправки.Если вас не заботит успех результата отправки, предпочтительнее применить метод.
4. Apply — это запись на диск с использованием асинхронных потоков, а commit — синхронная запись на диск. Поэтому, когда мы используем фиксацию в основном потоке, нам нужно учитывать, будут ли проблемы с ANR. (Не подходит для больших хранилищ данных)

4. Просмотрите XML-файл, в котором Sharedpreferencesd сохраняет данные.

Если вы хотите просмотреть файл данных, вы должны сначала получить корневые права доступа мобильного телефона.После успешного рутирования измените права доступа к данным, чтобы просматривать базу данных в данных. Поскольку вы можете четко просматривать данные каждой пары «ключ-значение» в XML-файле, лучше всего зашифровать и сохранить наиболее важные данные с помощью Sharedpreferencesd. Успешный вид показан на следующем рисунке:

Метод изменения разрешения данных:

Когда вы используете команду ll или ls -la под Linux, вы увидите логотип вида drwxr-xr-x. Что это означает? Общая длина этого идентификатора составляет 10 цифр (10′- ‘), первая цифра указывает тип файла, если файл является файлом (обозначается -), если файл является папкой (Обозначается d), если файл является файлом подключения (обозначается l), следующие 9 разделены на три группы: первая группа: права пользователя, вторая группа: права группы, а третья группа: другие права. Каждая группа состоит из трех битов: чтение r, запись w и выполнение x. Эти разрешения могут быть представлены числами: r 4, w 2, x 1. Если ни одно из разрешений отсутствует, оно обозначается знаком «-». Например: 1. -rwxrwx —, первая буква «-» представляет файл, вторая — четвертая rwx представляет владельца файла, который прочитал, записал, Разрешения на выполнение, пользователи в той же группе также имеют разрешения на чтение, запись и выполнение, а другие группы пользователей не имеют разрешений. Если он представлен числами, это 770.
2. drwx ——, first’d ‘представляет папку, со второго по четвертый rwx представляет, что владелец этой папки прочитал, Разрешения на запись и выполнение. С пятого по седьмой представляют разрешения владельца и той же группы пользователей. У той же группы пользователей нет никаких разрешений. С восьмого по десятый представляют разрешения других пользователей, а у других пользователей нет. Никаких разрешений. Если выражается цифрами, это 700.

Источник