SQLDelight 在 Android 上的 SQLite 开发指南

SQLDelight 在 Android 上的 SQLite 开发指南

sqldelight 项目地址: https://gitcode.com/gh_mirrors/sql/sqldelight

前言

SQLDelight 是一个强大的 SQL 代码生成工具，它能帮助开发者在 Android 平台上更高效地使用 SQLite 数据库。本文将详细介绍如何在 Android 项目中使用 SQLDelight 进行数据库开发。

环境配置

首先需要在项目中添加 SQLDelight 插件和依赖。在模块级的构建配置文件中进行如下配置：

plugins {
  id("app.cash.sqldelight") version "x.x.x"
}

dependencies {
  implementation("app.cash.sqldelight:android-driver:x.x.x")
}

建议将 Android Studio 的文件视图切换为"Project"视图，这样可以更方便地查找和编辑 SQLDelight 相关文件。

数据库架构定义

SQLDelight 使用 .sq 文件来定义数据库架构。这些文件通常放在 src/main/sqldelight 目录下。一个简单的示例：

-- 定义数据表
CREATE TABLE hockeyPlayer (
  id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
  name TEXT NOT NULL,
  number INTEGER NOT NULL
);

-- 定义查询语句
selectAll:
SELECT *
FROM hockeyPlayer
ORDER BY number;

insert:
INSERT INTO hockeyPlayer(name, number)
VALUES (?, ?);

驱动初始化

在 Android 应用中使用 SQLDelight 需要初始化 Android 驱动：

val driver: SqlDriver = AndroidSqliteDriver(
    schema = Database.Schema,
    context = context,
    name = "test.db"
)

AndroidSqliteDriver 在构造时会自动创建或迁移数据库架构。如果需要手动执行迁移，可以参考相关迁移文档。

查询操作

生成的代码会为每个查询语句创建对应的函数。使用示例：

// 创建数据库实例
val database = Database(driver)

// 执行查询
val players: List<HockeyPlayer> = database.hockeyPlayerQueries.selectAll().executeAsList()

// 执行插入
database.hockeyPlayerQueries.insert("John Doe", 42)

SQLite 版本兼容性

SQLDelight Gradle 插件会根据项目的 minSdkVersion 自动选择对应的 SQLite 方言版本。不同 Android SDK 版本支持的 SQLite 版本有所不同，开发者需要注意兼容性问题。

最佳实践

1. 将复杂的查询逻辑放在 .sq 文件中，而不是在代码中拼接 SQL
2. 合理使用事务处理批量操作
3. 对于大型数据库，考虑在子线程执行耗时操作
4. 定期检查生成的代码，确保符合预期

总结

SQLDelight 为 Android 开发者提供了一种类型安全、编译时检查的 SQLite 操作方式。通过定义清晰的 SQL 文件，自动生成类型安全的 Kotlin 代码，大大提高了数据库开发的效率和可靠性。本文介绍了基本的使用方法，开发者可以在此基础上探索更多高级功能。

sqldelight 项目地址: https://gitcode.com/gh_mirrors/sql/sqldelight