SharedPreferences: що це, ключ-значення сховище Android

Що таке SharedPreferences?

SharedPreferences — це вбудований механізм Android для зберігання пар ключ-значення в XML-файлі на внутрішньому сховищі пристрою. Він доступний починаючи з API Level 1 і не потребує підключення додаткових бібліотек. Основне призначення — збереження користувацьких налаштувань, стану інтерфейсу, прапорців першого запуску та інших простих даних, які не потребують структурованої бази даних.

Кожен файл SharedPreferences пов'язаний з конкретним ім'ям та режимом доступу. За замовчуванням використовується режим Context.MODE_PRIVATE, який обмежує доступ до файлу лише поточним додатком. Раніше Android підтримував режими MODE_WORLD_READABLE та MODE_WORLD_WRITEABLE, але вони були оголошені застарілими починаючи з API Level 17 та повністю видалені в Android 7.0 (API 24) з міркувань безпеки.

Незважаючи на свою простоту, SharedPreferences використовується в мільйонах Android-додатків. За даними Google, понад 90% додатків, опублікованих в Google Play, використовують SharedPreferences для зберігання налаштувань. Однак для складних сценаріїв (великі обсяги даних, типобезпека, асинхронність) Google рекомендує більш сучасні рішення, такі як Preferences DataStore з бібліотеки Android Jetpack.

Формат зберігання: XML на пристрої

Фізично SharedPreferences зберігається у вигляді XML-файлу в директорії додатку: /data/data/{package_name}/shared_prefs/{file_name}.xml. Файл містить кореневий елемент <map> з дочірніми елементами <string>, <int>, <boolean>, <float> та <long> залежно від типу збереженого значення. Розмір файлу не обмежений, але для великих обсягів даних (понад 100 KB) продуктивність читання та запису починає помітно знижуватися.

Файли SharedPreferences не шифруються за замовчуванням. Дані зберігаються у відкритому вигляді в файловій системі пристрою. Для зберігання чутливих даних (токени, паролі) рекомендується використовувати EncryptedSharedPreferences з бібліотеки AndroidX Security, яка автоматично шифрує ключі та значення за допомогою AES256-GCM.

Як працює SharedPreferences в Android

SharedPreferences працює за принципом кешування в пам'яті з періодичною синхронізацією на диск. При першому зверненні до файлу (через getSharedPreferences) Android завантажує XML-файл в оперативну пам'ять та парсить його в об'єкт Map. Всі наступні операції читання виконуються з пам'яті, без повторного читання з диска. Це забезпечує високу швидкість доступу до даних.

Операції запису використовують Editor — внутрішній буфер змін. Коли розробник викликає putString або putBoolean, зміни зберігаються в об'єкті Editor в пам'яті. Фактичний запис на диск відбувається при виклику методу commit (синхронно) або apply (асинхронно). До виклику цих методів дані не зберігаються, і при аварійному завершенні додатку зміни можуть бути втрачені.

Режими доступу та контекст

Для отримання екземпляра SharedPreferences використовуються два методи: getPreferences та getSharedPreferences. Перший доступний лише всередині Activity та створює файл з ім'ям Activity. Другий — більш гнучкий, приймає ім'я файлу та режим доступу, і доступний з будь-якого контексту (Application, Activity, Service). Рекомендується використовувати getSharedPreferences з ім'ям файлу, що відповідає модулю або функціональності додатку.

// Отримання SharedPreferences
val prefs = context.getSharedPreferences(
    "user_settings", Context.MODE_PRIVATE
)

// Запис даних
with(prefs.edit()) {
    putString("username", "Ганна")
    putInt("age", 28)
    putBoolean("isLoggedIn", true)
    apply()
}

// Читання даних
val username = prefs.getString("username", "")
val age = prefs.getInt("age", 0)
val isLoggedIn = prefs.getBoolean("isLoggedIn", false)

При використанні MODE_MULTI_PROCESS (застарілий) SharedPreferences синхронізується між процесами. Однак ця синхронізація не гарантує атомарність, і Google рекомендує уникати використання SharedPreferences в мультипроцесних сценаріях. Для таких випадків краще використовувати ContentProvider, Room з міжпроцесним доступом або DataStore.

Основні методи SharedPreferences

SharedPreferences надає набір методів для читання даних за ключем та інтерфейс Editor для запису. Кожен метод читання приймає два параметри: ключ та значення за замовчуванням, яке повертається, якщо ключ не знайдено. Значення за замовчуванням визначає також тип значення, що повертається: getString повертає String, getInt — Int і так далі.

Editor та apply vs commit

Editor — це внутрішній об'єкт SharedPreferences, який збирає зміни в буфері. Після внесення всіх змін розробник викликає commit() (синхронний запис) або apply() (асинхронний запис). Різниця критична: commit блокує поточний потік до повного запису на диск та повертає boolean (успіх/невдача), а apply виконує запис у фоновому потоці та негайно повертає управління, але не повертає результат.

Рекомендується використовувати apply замість commit у всіх випадках, коли не потрібно знати результат запису. apply швидший та не блокує UI-потік. commit слід використовувати лише коли критично знати, чи успішно збереглися дані, або при роботі з мультипроцесним режимом. Для видалення окремих ключів використовується метод remove, для повного очищення — clear. Всі операції видалення також виконуються через Editor.

// Множинні зміни - один apply
prefs.edit {
    putString("theme", "dark")
    putBoolean("notifications", false)
    remove("old_key")
}

// Слухач зміни значень
prefs.registerOnSharedPreferenceChangeListener { prefs, key ->
    Log.d("TAG", "Змінився ключ: $key")
}

Починаючи з Android 12 (API 31), SharedPreferences була доповнена підтримкою registerOnSharedPreferenceChangeListener з автоматичним відписуванням через Lifecycle. Це дозволяє уникнути витоків пам'яті, пов'язаних із забутими слухачами. У старіших версіях розробник зобов'язаний вручну викликати unregisterOnSharedPreferenceChangeListener в onDestroy або onStop компонента.

SharedPreferences vs альтернативи зберігання

Незважаючи на широку поширеність, SharedPreferences не є універсальним рішенням для всіх сценаріїв зберігання даних на Android. Залежно від обсягу даних, вимог до типобезпеки та продуктивності, Google рекомендує різні альтернативи, включені в Android Jetpack та стандартну бібліотеку Android.

DataStore — сучасна альтернатива

DataStore — це бібліотека Android Jetpack, представлена Google як заміна SharedPreferences. Вона надає два варіанти: Preferences DataStore (ключ-значення, як SharedPreferences) та Proto DataStore (типізоване зберігання через Protocol Buffers). DataStore використовує корутини та Flow для асинхронної роботи, гарантує типобезпеку та автоматично обробляє міграції версій. Google рекомендує DataStore для всіх нових проектів.

Основна перевага DataStore — асинхронність на рівні API. Всі операції читання повертають Flow, а операції запису є suspend-функціями. Це повністю виключає блокування UI-потоку, яке можливе при синхронному читанні SharedPreferences. Крім того, DataStore гарантує консистентність даних: запис виконується в транзакції, і при збої всі зміни відкочуються.

Приклад використання SharedPreferences в додатку

Розглянемо практичний приклад: налаштування теми оформлення (світла/темна/системна) в Android-додатку. Користувач вибирає тему, і вибір зберігається в SharedPreferences. При наступних запусках додатку тема відновлюється зі збережених налаштувань. Для реактивного оновлення UI використовується спостереження за змінами через SharedPreferences.OnSharedPreferenceChangeListener.

Збереження налаштувань користувача

Створимо клас ThemePreferences, який інкапсулює всю роботу з SharedPreferences для теми. Клас надає методи getTheme (читання), setTheme (запис) та observeTheme (спостереження). Ім'я файлу налаштувань буде «app_preferences» з режимом MODE_PRIVATE. Для зручності ключі винесені в companion object як константи.

class ThemePreferences(context: Context) {
    companion object {
        private const val PREF_NAME = "app_preferences"
        private const val KEY_THEME = "theme_mode"
        const val THEME_LIGHT = "light"
        const val THEME_DARK = "dark"
        const val THEME_SYSTEM = "system"
    }

    private val prefs = context
        .getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)

    fun getTheme(): String =
        prefs.getString(KEY_THEME, THEME_SYSTEM) ?: THEME_SYSTEM

    fun setTheme(theme: String) {
        prefs.edit { putString(KEY_THEME, theme) }
    }

    fun observeTheme(callback: (String) -> Unit) {
        prefs.registerOnSharedPreferenceChangeListener { _, key ->
            if (key == KEY_THEME) {
                callback.invoke(getTheme())
            }
        }
    }
}

В Activity або Fragment отримання екземпляра ThemePreferences виконується через контекст додатку. При ініціалізації викликається getTheme для встановлення актуальної теми. При виборі користувачем нової теми викликається setTheme, і через observeTheme інтерфейс оновлюється без перезапуску Activity. Важливо не забути відписатися від listener в onDestroy для запобігання витоку пам'яті, особливо якщо Activity перестворюється при зміні конфігурації.

Для додатків з мінімальною цільовою версією Android 12+ рекомендується використовувати registerOnSharedPreferenceChangeListener спільно з LifecycleObserver. Це автоматично керує підпискою та відпискою при зміні життєвого циклу компонента. Для старіших версій підписку та відписку необхідно керувати вручну, що є частим джерелом помилок у production-додатках, які використовують SharedPreferences.