SQLCipher for Android 使用指南

SQLCipher for Android 使用指南

项目地址:https://gitcode.com/gh_mirrors/an/android-database-sqlcipher

1. 项目介绍

SQLCipher for Android 是一个基于 SQLCipher 的安卓 SQLite 数据库 API，提供了数据库加密功能，确保数据在存储时的安全性。此项目已正式废弃，并推荐使用 sqlcipher-android 作为长期替代方案。SQLCipher for Android 支持从 Android 5.0（API 级别 21）开始的版本，并兼容 armeabi-v7a、x86、x86_64 和 arm64-v8a 架构。它通过提供一个加密层来增强标准SQLite数据库的安全性，使得数据库文件在未解密状态下不可读。

2. 项目快速启动

要快速启动使用 SQLCipher for Android，首先需要在你的项目中添加依赖。以下是在 Android 项目 build.gradle 文件的 dependencies 部分加入 SQLCipher 的示例：

dependencies {
    // 替换 '4.5.3' 为你想使用的具体版本号
    implementation "net.zetetic:android-database-sqlcipher:4.5.3"
    // 若你的应用使用 Room 或者其他依赖于 androidx.sqlite 的消费者，也需要相应的依赖
}

之后，在你的应用中初始化 SQLCipher。如果你使用的是 Room 数据库，你需要创建一个 SupportFactory 实例来配置 Room 使用 SQLCipher：

import net.sqlcipher.database.SQLiteDatabase
import net.sqlcipher.database.SupportFactory

// 假设 userEnteredPassphrase 是用户提供的密码字符串
val passphrase = SQLiteDatabase.getBytes(userEnteredPassphrase)
val factory = SupportFactory(passphrase)
val database: YourRoomDatabase = Room.databaseBuilder(
        applicationContext,
        YourRoomDatabase::class.java,
        DATABASE_NAME
).openHelperFactory(factory).build()

对于不使用 Room 的情况，确保调用 SQLiteDatabase.loadLibs() 加载必要的库，然后以字节数组或字符数组的形式传递密码打开数据库。

3. 应用案例和最佳实践

使用 Room 的最佳实践

• 安全性: 确保 clearPassphrase=true 来增加安全，但请注意，这会导致工厂对象只能一次性使用。
• 密码管理: 不要在代码中硬编码密码，应由用户输入或安全机制管理。
• 升级数据库: 在升级数据库版本时，考虑使用 onUpgrade 提供新的密码或者迁移策略。

直接使用 SQLCipher API

• 资源清理: 在数据库操作完毕后，记得关闭数据库连接。
• 性能优化: 尽可能减少频繁的数据库加解锁操作，合并数据库事务。

4. 典型生态项目

虽然 SQLCipher for Android 已经被官方废弃，但其影响深远，许多应用程序特别是那些需要加强数据隐私保护的应用，都曾或仍在使用它。它的替代品 sqlcipher-android 继承了这一传统，继续在安卓应用生态系统中扮演重要角色。开发者社区中存在诸多分享经验和实现案例的博客、论坛讨论以及第三方应用，这些是学习和借鉴的最佳资源。在集成 SQLCipher 进入项目时，参考其GitHub页面和相关技术论坛可以获得最新的支持信息和最佳实践建议。

---

以上就是 SQLCipher for Android 的简要使用指南，遵循这些步骤和原则可以帮助你快速安全地整合加密数据库功能到你的安卓应用中。随着项目的废弃，及时转向更新的解决方案也是重要的考虑点。

android-database-sqlcipher sqlcipher/android-database-sqlcipher: 是一个基于 Android 平台的 SQLite 数据库加密库，它提供了一个加密的 SQLite 数据库，适用于 Android 应用。适合用于 Android 平台的数据库开发，特别是对于需要数据库加密的场景。特点是 Android 数据库开发、SQLite 数据库、加密数据库。 项目地址: https://gitcode.com/gh_mirrors/an/android-database-sqlcipher