在 Android 上开始使用 SQLite

首先在项目中应用 Gradle 插件。

KotlinGroovy

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

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") {
      packageName.set("com.example")
    }
  }
}

plugins {
  id "app.cash.sqldelight" version "2.1.0"
}

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") { // 这将是生成的数据库类的名称。
      packageName = "com.example"
    }
  }
}

Tip

建议将 Android Studio 切换为使用文件的“Project”视图，而不是“Android”视图，以便更轻松地查找和编辑 SQLDelight 文件。

在 src/main/sqldelight 文件夹下的 .sq 文件中编写您的 SQL 语句。 通常，.sq 文件中的第一个语句会创建一个表，但您也可以创建索引或设置默认内容。

CREATE TABLE hockeyPlayer (
  player_number INTEGER PRIMARY KEY NOT NULL,
  full_name TEXT NOT NULL
);

CREATE INDEX hockeyPlayer_full_name ON hockeyPlayer(full_name);

INSERT INTO hockeyPlayer (player_number, full_name)
VALUES (15, 'Ryan Getzlaf');

根据这些语句，SQLDelight 将生成一个 Database 类及关联的 Schema 对象，可用于创建数据库并对其执行语句。Database 类是由 generateSqlDelightInterface Gradle 任务生成的，当您编辑 .sq 文件时，SQLDelight IDE 插件会自动运行该任务，同时它也是普通 Gradle 构建的一部分。

要在代码中使用生成的数据库，必须将 SQLDelight Android 驱动程序依赖项添加到项目中。

KotlinGroovy

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

dependencies {
  implementation "app.cash.sqldelight:android-driver:2.1.0"
}

驱动程序的实例可以按如下方式构造，并且需要引用生成的 Schema 对象。

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

Info

AndroidSqliteDriver 会在构造驱动程序时自动创建或迁移您的架构。如果需要，也可以手动执行迁移。有关更多信息，请参阅代码迁移。

定义类型安全查询

SQLDelight 会为 .sq 文件中任何带有标签的 SQL 语句生成一个类型安全函数。

selectAll:
SELECT *
FROM hockeyPlayer;

insert:
INSERT INTO hockeyPlayer(player_number, full_name)
VALUES (?, ?);

insertFullPlayerObject:
INSERT INTO hockeyPlayer(player_number, full_name)
VALUES ?;

将为每个包含标签语句的 .sq 文件生成一个“Queries”对象。 例如，将为上文所示的 Player.sq 文件生成一个 PlayerQueries 对象。 此对象可用于调用生成的类型安全函数，这些函数将执行实际的 SQL 语句。

fun doDatabaseThings(driver: SqlDriver) {
  val database = Database(driver)
  val playerQueries: PlayerQueries = database.playerQueries

  println(playerQueries.selectAll().AsList()) 
  // [HockeyPlayer(15, "Ryan Getzlaf")]

  playerQueries.insert(player_number = 10, full_name = "Corey Perry")
  println(playerQueries.selectAll().AsList()) 
  // [HockeyPlayer(15, "Ryan Getzlaf"), HockeyPlayer(10, "Corey Perry")]

  val player = HockeyPlayer(10, "Ronald McDonald")
  playerQueries.insertFullPlayerObject(player)
}

就是这样！请查看侧边栏的其他页面以了解其他功能。

SQLite 版本

对于 Android 项目，SQLDelight Gradle 插件会根据项目的 minSdkVersion 设置自动选择 SQLite 方言版本。点击此处查看每个 Android SDK 级别上支持的 SQLite 版本列表。