Skip to content

使用 Web Worker Driver 進行多平台設定

首先在您的專案中套用 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"
    }
  }
}

將您的 SQL 陳述式撰寫在 src/main/sqldelight 下的 .sq 檔案中。 通常 .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")
}