Skip to content

Latest commit

 

History

History
160 lines (125 loc) · 5.16 KB

getting-start-cn.md

File metadata and controls

160 lines (125 loc) · 5.16 KB

开始使用

欢迎使用 SQLlin ！！！

在 Gradle 中使用 Maven 引入

将 sqllin-dsl、sqllin-driver 以及 sqllin-processor 依赖添加到你的 build.gradle.kts：

plugins {
    kotlin("multiplatform")
    kotlin("plugin.serialization")
    id("com.android.library")
    id("com.google.devtools.ksp")
}

val sqllinVersion = "1.1.0"

kotlin {
    // ......
    sourceSets {
        val commonMain by getting {
            kotlin.srcDir("build/generated/ksp/metadata/commonMain/kotlin")
            dependencies {
                // sqllin-dsl
                implementation("com.ctrip.kotlin:sqllin-dsl:$sqllinVersion")
                // sqllin-driver
                implementation("com.ctrip.kotlin:sqllin-driver:$sqllinVersion")

                // The sqllin-dsl serialization and deserialization depends on kotlinx-serialization
                implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:1.5.1")
            }
        }
        // ......
    }
}

// KSP dependencies
dependencies {
    // sqllin-processor
    add("kspCommonMainMetadata", "com.ctrip.kotlin:sqllin-processor:$sqllinVersion")
}

创建数据库

创建 Database 实例如下示例所示：

import com.ctrip.sqllin.dsl.Database

val database = Database(name = "Person.db", path = getGlobalPath(), version = 1)

DatabasePath 是 Database 构造函数中第二个参数的类型，它在不同的平台上的标识有所不同。在 Android 中，你可以通过Context 来获取它，在 native 平台上则可以通过字符串来获取它。 比如，你可以在 common source set 中定义一个 expect 函数：

import com.ctrip.sqllin.driver.DatabasePath

expect fun getGlobalDatabasePath(): DatabasePath

在 Android source set 中，你可以这样实现它：

import android.content.Context
import com.ctrip.sqllin.driver.DatabasePath
import com.ctrip.sqllin.driver.toDatabasePath

actual fun getGlobalDatabasePath(): DatabasePath =
    applicationContext.toDatabasePath() 
    
val applicationContext: Context
    get() {
        // 使用自己的方式获取 applicationContext
    }

在 iOS source set 中（在其他 Apple 平台也类似），可以这样实现：

import com.ctrip.sqllin.driver.DatabasePath
import com.ctrip.sqllin.driver.toDatabasePath

actual fun getGlobalDatabasePath(): DatabasePath =
    (NSSearchPathForDirectoriesInDomains(
        NSDocumentDirectory, 
        NSUserDomainMask, true).firstOrNull() as? String ?: ""
    ).toDatabasePath()

你也可以在创建 Database 实例的时候配置更多的 SQLite 参数：

import com.ctrip.sqllin.driver.DatabaseConfiguration
import com.ctrip.sqllin.dsl.Database

val database = Database(
    DatabaseConfiguration(
        name = "Person.db",
        path = getGlobalDatabasePath(),
        version = 1,
        isReadOnly = false,
        inMemory = false,
        journalMode = JournalMode.WAL,
        synchronousMode = SynchronousMode.NORMAL,
        busyTimeout = 5000,
        lookasideSlotSize = 0,
        lookasideSlotCount = 0,
        create = {
            it.execSQL("create table person (id integer primary key autoincrement, name text, age integer)")
        },
        upgrade = { databaseConnection, oldVersion, newVersion -> }
    )
)

注意，由于 Android Framework 的限制，inMemory、journalMode、synchronousMode、busyTimeout、lookasideSlotSize、lookasideSlotCount 这些参数仅在 Android 9 及以上版本生效。

当前由于会改变数据库结构的操作暂时还没有 DSL 化支持。因此，你需要在 create 和 update 参数中使用字符串编写 SQL 语句。

通常你只需要在你的组件的生命周期内创建一个 Database 对象，所以你需要在组件的生命周期结束时手动关闭数据库：

override fun onDestroy() {
    database.close()
}

定义你的 DBEntity

在 sqllin-dsl 中，你可以直接插入或查找对象。所以，你需要使用正确的方式定义你的 data class，比如：

import com.ctrip.sqllin.dsl.annotation.DBRow
import kotlinx.serialization.Serializable

@DBRow
@Serializable
data class Person(
    val name: String,
    val age: Int,
)

你定义的 DBEntity 的属性名应与数据库表的列名相对应。DBEntity 不应该拥有名字与表中的所有列名均不相同的属性，但是 DBEntity 的属性数量可以比表中列的数量少。

@DBRow 的参数 tableName 表示数据库中的表名，请确保传入正确的值。如果不手动传入，sqllin-processor 将会使用类名作为表名，比如 Person 类的默认表名是"Person"。

在 sqllin-dsl 中，对象序列化为 SQL 语句，或者从游标中反序列化依赖 kotlinx.serialization，所以你需要在你的 data class 上添加 @Serializable 注解。

接下来

你已经学习完了所有的准备工作，现在可以开始学习如何操作数据库了：