从零到一掌握SharedPreferences：Android轻量级存储全解析

简介

SharedPreferences 是 Android 开发中不可或缺的轻量级键值对存储方案，广泛应用于用户偏好设置、应用配置、简单数据缓存等场景。本文将从基础概念出发，结合企业级开发实战，深入解析 SharedPreferences 的原理、用法、最佳实践以及性能优化技巧。通过详细的代码示例和分步讲解，帮助开发者快速掌握 SharedPreferences 的核心能力，并解决实际开发中的复杂需求。

文章内容涵盖：

• SharedPreferences 的基础使用与数据存储机制
• 企业级开发中的模块化封装与安全存储策略
• 性能优化与敏感数据保护技巧
• 实战案例：用户登录状态管理与配置持久化

---

一、SharedPreferences 基础知识详解

1.1 SharedPreferences 的核心概念

SharedPreferences 是 Android 提供的轻量级数据存储工具，采用键值对（Key-Value）的形式存储数据。其核心特点包括：

• 轻量高效：以 XML 文件形式存储数据，适合存储少量非敏感信息。
• 生命周期绑定：数据存储在应用私有目录下（/data/data/<package>/shared_prefs/），仅当前应用可访问。
• 线程安全：支持多线程并发读写，但需注意异步操作的正确性。

1.2 数据类型支持

SharedPreferences 支持存储以下基本数据类型：

• String：字符串类型，例如 "user_name"
• int：整型，例如 25
• float：浮点型，例如 3.14
• long：长整型，例如 1000L
• boolean：布尔型，例如 true
• Set<String>：字符串集合，例如 ["blue", "green"]

1.3 存储结构与文件路径

SharedPreferences 的数据以 XML 文件形式存储在设备的私有目录下。例如，文件名 user_prefs.xml 对应的存储路径为：

/data/data/com.example.myapp/shared_prefs/user_prefs.xml

XML 文件内容示例：

<?xml version="1.0" encoding="utf-8"?>
<map>
    <string name="user_name">John Doe</string>
    <int name="user_age">25</int>
    <boolean name="is_logged_in">true</boolean>
    <set name="favorite_colors">
        <item>blue</item>
        <item>green</item>
    </set>
</map>

---

1.4 SharedPreferences 的基础使用

1.4.1 获取 SharedPreferences 实例

通过 Context.getSharedPreferences() 或 Activity.getPreferences() 方法获取实例：

// 获取指定文件名的 SharedPreferences
val sharedPreferences = context.getSharedPreferences("user_prefs", Context.MODE_PRIVATE)

// 获取与当前 Activity 绑定的 SharedPreferences
val activityPreferences = activity.getPreferences(Context.MODE_PRIVATE)

• MODE_PRIVATE：私有模式，仅当前应用可访问（推荐）。
• 其他模式（如 MODE_WORLD_READABLE）已弃用，存在安全风险。

1.4.2 数据存储与修改

通过 SharedPreferences.Editor 接口进行数据操作：

val editor = sharedPreferences.edit()

// 存储数据
editor.putString("user_name", "Alice")
editor.putInt("user_age", 30)
editor.putBoolean("is_logged_in", true)

// 提交更改（异步）
editor.apply()

// 或同步提交（阻塞主线程）
val success = editor.commit()

• apply()：异步提交，不会阻塞主线程（推荐）。
• commit()：同步提交，返回操作结果（适用于关键业务逻辑）。

1.4.3 数据读取

通过 SharedPreferences 实例的 get 方法读取数据：

val userName = sharedPreferences.getString("user_name", "Default Name")
val userAge = sharedPreferences.getInt("user_age", 0)
val isLoggedIn = sharedPreferences.getBoolean("is_logged_in", false)

// 读取 Set<String>
val favoriteColors = sharedPreferences.getStringSet("favorite_colors", setOf())

• 第二个参数为默认值，当键不存在时返回该值。

1.4.4 数据删除与清空

删除指定键或清空所有数据：

// 删除单个键
editor.remove("user_name").apply()

// 清空所有数据
editor.clear().apply()

---

二、企业级开发中的 SharedPreferences 优化技巧

2.1 模块化封装与代码复用

在大型项目中，建议将 SharedPreferences 封装为独立模块，提高代码复用性和可维护性。

2.1.1 创建数据管理类

class PreferencesManager(context: Context) {
    private val sharedPreferences = context.getSharedPreferences("app_prefs", Context.MODE_PRIVATE)

    fun saveUserLoggedIn(isLoggedIn: Boolean) {
        sharedPreferences.edit().putBoolean("is_logged_in", isLoggedIn).apply()
    }

    fun getUserLoggedIn(): Boolean {
        return sharedPreferences.getBoolean("is_logged_in", false)
    }

    fun clearAll() {
        sharedPreferences.edit().clear().apply()
    }
}

代码解析：

• 将 SharedPreferences 操作集中管理，降低耦合度。
• 提供统一接口供其他模块调用。

2.1.2 使用依赖注入（Hilt）

通过 Hilt 注入 PreferencesManager 实例，实现依赖解耦：

@Module
@InstallIn(SingletonComponent::class)
object AppModule {
    @Provides
    fun providePreferencesManager(context: Context): PreferencesManager {
        return PreferencesManager(context)
    }
}

class MainActivity @Inject constructor(
    private val preferencesManager: PreferencesManager
) : AppCompatActivity() {
    // 使用 preferencesManager 存取数据
}

---

2.2 敏感数据保护策略

SharedPreferences 默认存储明文数据，若需存储敏感信息（如密码），需结合加密技术。

2.2.1 数据加密存储

使用 AES 加密算法对敏感数据进行加密：

class SecurePreferences(context: Context) {
    private val sharedPreferences = context.getSharedPreferences("secure_prefs", Context.MODE_PRIVATE)
    private val key = "MySecretKey12345" // 密钥需妥善保管

    fun saveSecureData(key: String, value: String) {
        val encryptedValue = encrypt(value)
        sharedPreferences.edit().putString(key, encryptedValue).apply()
    }

    fun getSecureData(key: String): String? {
        val encryptedValue = sharedPreferences.getString(key, null)
        return encryptedValue?.let { decrypt(it) }
    }

    private fun encrypt(data: String): String {
        // 实现 AES 加密逻辑
        return data
    }

    private fun decrypt(encryptedData: String): String {
        // 实现 AES 解密逻辑
        return encryptedData
    }
}

注意事项：

• 密钥需通过安全渠道存储（如 Keystore）。
• 避免在代码中硬编码密钥。

---

2.3 性能优化技巧

2.3.1 避免频繁读写

减少不必要的读写操作，合并多个操作为一次提交：

val editor = sharedPreferences.edit()
editor.putString("key1", "value1")
editor.putInt("key2", 100)
editor.apply() // 一次性提交

2.3.2 使用异步任务处理大数据量

若需处理大量数据，建议使用 WorkManager 或协程调度：

viewModelScope.launch(Dispatchers.IO) {
    // 在后台线程执行数据操作
    sharedPreferences.edit().apply {
        putString("large_data", "A".repeat(10000))
        apply()
    }
}

---

三、实战案例：用户登录状态管理

3.1 需求分析

实现用户登录状态的持久化存储，包括：

• 保存登录状态（is_logged_in）
• 存储用户名（user_name）
• 退出登录时清除数据

3.2 代码实现

3.2.1 登录成功后保存状态

fun onLoginSuccess(userName: String) {
    val editor = sharedPreferences.edit()
    editor.putBoolean("is_logged_in", true)
    editor.putString("user_name", userName)
    editor.apply()
}

3.2.2 检查登录状态

fun checkLoginStatus(): Boolean {
    return sharedPreferences.getBoolean("is_logged_in", false)
}

3.2.3 退出登录时清除数据

fun onLogout() {
    val editor = sharedPreferences.edit()
    editor.remove("is_logged_in")
    editor.remove("user_name")
    editor.apply()
}

3.3 UI 集成

在 Activity 中根据登录状态更新 UI：

class MainActivity : AppCompatActivity() {
    private lateinit var preferencesManager: PreferencesManager

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        preferencesManager = PreferencesManager(this)

        if (preferencesManager.getUserLoggedIn()) {
            // 显示用户信息
            val userName = preferencesManager.getUserName()
            findViewById<TextView>(R.id.welcome_text).text = "Welcome, $userName"
        } else {
            // 跳转到登录页面
            startActivity(Intent(this, LoginActivity::class.java))
        }
    }
}

---

四、高级技巧与最佳实践

4.1 数据迁移与版本兼容

当应用升级时，需处理旧版数据迁移：

val oldPrefs = context.getSharedPreferences("old_prefs", Context.MODE_PRIVATE)
val newPrefs = context.getSharedPreferences("new_prefs", Context.MODE_PRIVATE)

val editor = newPrefs.edit()
editor.putString("new_key", oldPrefs.getString("old_key", "default"))
editor.apply()

// 删除旧文件
context.deleteSharedPreferences("old_prefs")

4.2 单元测试与模拟

使用 Mockito 或 TestSharedPreferences 进行单元测试：

class PreferencesManagerTest {
    @Test
    fun testSaveAndRetrieveUserLoggedIn() {
        val mockSharedPreferences = mock<SharedPreferences>()
        val mockEditor = mock<SharedPreferences.Editor>()
        whenever(mockSharedPreferences.edit()).thenReturn(mockEditor)

        val manager = PreferencesManager(context).apply {
            sharedPreferences = mockSharedPreferences
        }

        manager.saveUserLoggedIn(true)
        verify(mockEditor).putBoolean("is_logged_in", true)
        verify(mockEditor).apply()
    }
}

4.3 与 Room 数据库的协同使用

对于复杂数据，建议将 SharedPreferences 与 Room 数据库结合使用：

• SharedPreferences：存储轻量级配置（如主题设置）。
• Room：存储结构化数据（如用户信息、订单记录）。

---

总结

SharedPreferences 是 Android 开发中不可或缺的轻量级存储工具，适用于用户偏好设置、应用配置等场景。通过本文的讲解，开发者可以掌握 SharedPreferences 的基础用法、企业级开发优化技巧以及实战案例，从而构建高效、安全的应用架构。