SharedPreferences: co to je, úložiště klíč-hodnota v Androidu

Co je SharedPreferences?

SharedPreferences je vestavěný mechanismus Androidu pro ukládání párů klíč-hodnota v XML souboru na interním úložišti zařízení. Je dostupný od API Level 1 a nevyžaduje připojení dalších knihoven. Hlavní účel — ukládání uživatelských nastavení, stavu rozhraní, příznaků prvního spuštění a dalších jednoduchých dat, která nevyžadují strukturovanou databázi.

Každý soubor SharedPreferences je spojen s konkrétním názvem a režimem přístupu. Ve výchozím nastavení se používá režim Context.MODE_PRIVATE, který omezuje přístup k souboru pouze na aktuální aplikaci. Dříve Android podporoval režimy MODE_WORLD_READABLE a MODE_WORLD_WRITEABLE, ale ty byly od API Level 17 prohlášeny za zastaralé a zcela odstraněny v Androidu 7.0 (API 24) z bezpečnostních důvodů.

Navzdory své jednoduchosti je SharedPreferences používán v milionech aplikací pro Android. Podle Google více než 90% aplikací publikovaných v Google Play používá SharedPreferences pro ukládání nastavení. Pro složité scénáře (velké objemy dat, typová bezpečnost, asynchronnost) však Google doporučuje modernější řešení, jako je Preferences DataStore z knihovny Android Jetpack.

Formát ukládání: XML na zařízení

Fyzicky je SharedPreferences uložen jako XML soubor v adresáři aplikace: /data/data/{package_name}/shared_prefs/{file_name}.xml. Soubor obsahuje kořenový element <map> s podřízenými elementy <string>, <int>, <boolean>, <float> a <long> v závislosti na typu uložené hodnoty. Velikost souboru není omezena, ale pro velké objemy dat (nad 100 KB) začíná výkon čtení a zápisu znatelně klesat.

Soubory SharedPreferences nejsou ve výchozím nastavení šifrovány. Data jsou uložena v otevřené podobě v souborovém systému zařízení. Pro ukládání citlivých dat (tokeny, hesla) se doporučuje používat EncryptedSharedPreferences z knihovny AndroidX Security, která automaticky šifruje klíče a hodnoty pomocí AES256-GCM.

Jak SharedPreferences funguje v Androidu

SharedPreferences funguje na principu ukládání do mezipaměti v paměti s pravidelnou synchronizací na disk. Při prvním přístupu k souboru (přes getSharedPreferences) Android nahraje XML soubor do RAM a parsuje ho do objektu Map. Všechny následné operace čtení se provádějí z paměti, bez opětovného čtení z disku. To zajišťuje vysokou rychlost přístupu k datům.

Operace zápisu používají Editor — interní buffer změn. Když vývojář zavolá putString nebo putBoolean, změny jsou uloženy v objektu Editor v paměti. Skutečný zápis na disk probíhá při volání metody commit (synchronně) nebo apply (asynchronně). Do doby volání těchto metod nejsou data uložena a při neočekávaném ukončení aplikace mohou být změny ztraceny.

Režimy přístupu a kontext

Pro získání instance SharedPreferences se používají dvě metody: getPreferences a getSharedPreferences. První je dostupná pouze uvnitř Activity a vytváří soubor s názvem Activity. Druhá je flexibilnější, přijímá název souboru a režim přístupu a je dostupná z libovolného kontextu (Application, Activity, Service). Doporučuje se používat getSharedPreferences s názvem souboru odpovídajícím modulu nebo funkcionalitě aplikace.

// Získání SharedPreferences
val prefs = context.getSharedPreferences(
    "user_settings", Context.MODE_PRIVATE
)

// Zápis dat
with(prefs.edit()) {
    putString("username", "Anna")
    putInt("age", 28)
    putBoolean("isLoggedIn", true)
    apply()
}

// Čtení dat
val username = prefs.getString("username", "")
val age = prefs.getInt("age", 0)
val isLoggedIn = prefs.getBoolean("isLoggedIn", false)

Při použití MODE_MULTI_PROCESS (zastaralé) se SharedPreferences synchronizuje mezi procesy. Tato synchronizace však nezaručuje atomicitu a Google doporučuje vyhnout se používání SharedPreferences v multi-process scénářích. Pro takové případy je lepší použít ContentProvider, Room s meziprocesovým přístupem nebo DataStore.

Hlavní metody SharedPreferences

SharedPreferences poskytuje sadu metod pro čtení dat podle klíče a rozhraní Editor pro zápis. Každá metoda čtení přijímá dva parametry: klíč a výchozí hodnotu, která je vrácena, pokud klíč není nalezen. Výchozí hodnota také určuje typ vrácené hodnoty: getString vrací String, getInt vrací Int a tak dále.

Editor a apply vs commit

Editor — interní objekt SharedPreferences, který shromažďuje změny v bufferu. Po provedení všech změn vývojář zavolá commit() (synchronní zápis) nebo apply() (asynchronní zápis). Rozdíl je kritický: commit blokuje aktuální vlákno do úplného zápisu na disk a vrací boolean (úspěch/neúspěch), zatímco apply provádí zápis na pozadí a okamžitě vrací řízení, ale nevrací výsledek.

Doporučuje se používat apply místo commit ve všech případech, kdy není třeba znát výsledek zápisu. apply je rychlejší a neblokuje UI vlákno. commit by měl být použit pouze tehdy, když je kritické vědět, zda byla data úspěšně uložena, nebo při práci s multi-process režimem. Pro odstranění jednotlivých klíčů se používá metoda remove, pro úplné vyčištění — clear. Všechny operace odstranění se také provádějí přes Editor.

// Více změn - jeden apply
prefs.edit {
    putString("theme", "dark")
    putBoolean("notifications", false)
    remove("old_key")
}

// Naslouchání změn hodnot
prefs.registerOnSharedPreferenceChangeListener { prefs, key ->
    Log.d("TAG", "Klíč se změnil: $key")
}

Od Androidu 12 (API 31) je SharedPreferences doplněn o podporu registerOnSharedPreferenceChangeListener s automatickým odhlášením prostřednictvím Lifecycle. To umožňuje vyhnout se únikům paměti spojeným se zapomenutými posluchači. Ve starších verzích je vývojář povinen ručně volat unregisterOnSharedPreferenceChangeListener v onDestroy nebo onStop komponenty.

SharedPreferences vs alternativy ukládání

Navzdory širokému rozšíření není SharedPreferences univerzálním řešením pro všechny scénáře ukládání dat v Androidu. V závislosti na objemu dat, požadavcích na typovou bezpečnost a výkon doporučuje Google různé alternativy zahrnuté v Android Jetpack a standardní knihovně Androidu.

DataStore — moderní alternativa

DataStore — knihovna Android Jetpack, představená Googlem jako náhrada za SharedPreferences. Nabízí dvě varianty: Preferences DataStore (klíč-hodnota, jako SharedPreferences) a Proto DataStore (typované ukládání přes Protocol Buffers). DataStore používá korutiny a Flow pro asynchronní práci, garantuje typovou bezpečnost a automaticky zpracovává migrace verzí. Google doporučuje DataStore pro všechny nové projekty.

Hlavní výhoda DataStore — asynchronnost na úrovni API. Všechny operace čtení vracejí Flow a operace zápisu jsou suspend-funkce. To zcela eliminuje blokování UI vlákna, které je možné při synchronním čtení SharedPreferences. Kromě toho DataStore garantuje konzistenci dat: zápis se provádí v transakci a v případě selhání jsou všechny změny vráceny zpět.

Příklad použití SharedPreferences v aplikaci

Podívejme se na praktický příklad: nastavení motivu (světlý/tmavý/systémový) v aplikaci pro Android. Uživatel vybere motiv a volba se uloží do SharedPreferences. Při následujících spuštěních aplikace se motiv obnoví z uložených nastavení. Pro reaktivní aktualizaci rozhraní se používá sledování změn prostřednictvím SharedPreferences.OnSharedPreferenceChangeListener.

Ukládání uživatelských nastavení

Vytvoříme třídu ThemePreferences, která zapouzdřuje veškerou práci s SharedPreferences pro motiv. Třída poskytuje metody getTheme (čtení), setTheme (zápis) a observeTheme (sledování). Název souboru nastavení bude "app_preferences" s režimem MODE_PRIVATE. Pro pohodlí jsou klíče vyčleněny do companion object jako konstanty.

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())
            }
        }
    }
}

V Activity nebo Fragmentu se získání instance ThemePreferences provádí přes kontext aplikace. Při inicializaci se volá getTheme pro nastavení aktuálního motivu. Když uživatel vybere nový motiv, zavolá se setTheme a prostřednictvím observeTheme se rozhraní aktualizuje bez restartování Activity. Je důležité nezapomenout se odhlásit z posluchače v onDestroy, aby se zabránilo úniku paměti, zejména pokud je Activity znovu vytvořeno při změně konfigurace.

Pro aplikace s minimální cílovou verzí Android 12+ se doporučuje používat registerOnSharedPreferenceChangeListener společně s LifecycleObserver. To automaticky spravuje přihlášení a odhlášení při změně životního cyklu komponenty. Pro starší verze je třeba přihlášení a odhlášení spravovat ručně, což je častým zdrojem chyb v produkčních aplikacích používajících SharedPreferences.