Skip to content

使用 Web Worker 驱动程序的多平台设置

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

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

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") {
      packageName.set("com.example")
    }
  }
}
groovy
plugins {
  id "app.cash.sqldelight" version "2.1.0"
}

repositories {
  google()
  mavenCentral()
}

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

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

sql
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 构建的一部分。

groovy
kotlin {
  // 所需的驱动程序将根据您的目标平台而变化:

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

  // 或者 sourceSets.iosMain、sourceSets.windowsMain 等
  sourceSets.nativeMain.dependencies {
    implementation "app.cash.sqldelight:native-driver:2.1.0"
  }

  sourceSets.jvmMain.dependencies {
    implementation "app.cash.sqldelight:sqlite-driver:2.1.0"
  }

  sourceSets.jsMain.dependencies {
    implementation "app.cash.sqldelight:web-worker-driver:2.1.0"
    implementation npm("sql.js", "1.6.2")
    implementation devNpm("copy-webpack-plugin", "9.1.0")
  }
}

创建驱动程序

首先在您的公共代码中设置一种创建驱动程序的方法。这可以使用 expect/actual 来完成,或者简单地通过一个公共接口以及该接口的平台特定实现来完成。

kotlin
expect suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver

SqlSchema 接口包含一个泛型 QueryResult 类型参数,用于区分在 generateAsync 配置选项设置为 true 时生成的架构代码。 某些驱动程序在创建或迁移架构时依赖同步行为,因此要使用异步架构,您可以使用 synchronous() 扩展方法将其适配,以便与同步驱动程序一起使用。

kotlin
actual suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver {
  return WebWorkerDriver(
    Worker(
      js("""new URL("@cashapp/sqldelight-sqljs-worker/sqljs.worker.js", import.meta.url)""")
    )
  ).also { schema.create(it).await() }
}
kotlin
actual suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver {
  return JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY)
    .also { schema.create(it).await() }
}
kotlin
actual suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver {
  return AndroidSqliteDriver(schema.synchronous(), context, "test.db")
}
kotlin
actual suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver {
  return NativeSqliteDriver(schema.synchronous(), "test.db")
}