如何快速配置SQLDelight JVM环境：MySQL、PostgreSQL和SQLite驱动完整指南

【免费下载链接】sqldelight SQLDelight - Generates typesafe Kotlin APIs from SQL 项目地址: https://gitcode.com/gh_mirrors/sq/sqldelight

SQLDelight 是一款能从 SQL 生成类型安全 Kotlin API 的强大工具，它让开发者可以在 JVM 环境中轻松使用 MySQL、PostgreSQL 和 SQLite 等主流数据库。本指南将帮助你快速完成 SQLDelight 在 JVM 项目中的配置，掌握三种数据库驱动的集成方法，让数据库操作变得简单高效。

为什么选择SQLDelight？

SQLDelight 通过将 SQL 语句编译为类型安全的 Kotlin 代码，避免了手动编写数据库操作代码的繁琐和错误。它支持多种数据库方言，包括 MySQL、PostgreSQL 和 SQLite，并且与 Gradle 构建系统深度集成，提供了简洁的配置方式和强大的代码生成能力。无论是小型项目还是大型应用，SQLDelight 都能显著提升数据库操作的开发效率和代码质量。

准备工作

在开始配置之前，请确保你的开发环境满足以下要求：

• JDK 8 或更高版本
• Gradle 7.0 或更高版本
• 一个 JVM 项目（可以是纯 Kotlin 项目或 Java 项目）

首先，克隆 SQLDelight 项目仓库：

git clone https://gitcode.com/gh_mirrors/sq/sqldelight

Gradle 基础配置

SQLDelight 提供了直观的 Gradle 插件，用于配置数据库和生成代码。以下是基本的 Gradle 配置步骤：

添加 SQLDelight 插件

在项目的 build.gradle.kts（Kotlin DSL）或 build.gradle（Groovy DSL）中添加 SQLDelight 插件：

=== "Kotlin" kotlin plugins { id("app.cash.sqldelight") version "{{ versions.sqldelight }}" }

=== "Groovy" groovy plugins { id 'app.cash.sqldelight' version '{{ versions.sqldelight }}' }

配置数据库

在 Gradle 配置中声明数据库，指定包名、源文件目录和方言等信息：

=== "Kotlin" kotlin sqldelight { databases { create("MyDatabase") { packageName.set("com.example.db") srcDirs.setFrom("src/main/sqldelight") dialect("app.cash.sqldelight:sqlite-3-24-dialect:{{ versions.sqldelight }}") generateAsync.set(true) } } }

=== "Groovy" groovy sqldelight { databases { MyDatabase { packageName = "com.example.db" srcDirs = ['src/main/sqldelight'] dialect 'app.cash.sqldelight:sqlite-3-24-dialect:{{ versions.sqldelight }}' generateAsync = true } } }

MySQL 驱动配置

添加 MySQL 依赖

在 build.gradle.kts 或 build.gradle 中添加 MySQL 驱动和方言依赖：

=== "Kotlin" kotlin dependencies { implementation("app.cash.sqldelight:mysql-dialect:{{ versions.sqldelight }}") implementation("app.cash.sqldelight:jdbc-driver:{{ versions.sqldelight }}") runtimeOnly("mysql:mysql-connector-java:8.0.32") }

=== "Groovy" groovy dependencies { implementation 'app.cash.sqldelight:mysql-dialect:{{ versions.sqldelight }}' implementation 'app.cash.sqldelight:jdbc-driver:{{ versions.sqldelight }}' runtimeOnly 'mysql:mysql-connector-java:8.0.32' }

配置 MySQL 方言

在数据库配置中指定 MySQL 方言：

=== "Kotlin" kotlin dialect("app.cash.sqldelight:mysql-dialect:{{ versions.sqldelight }}")

=== "Groovy" groovy dialect 'app.cash.sqldelight:mysql-dialect:{{ versions.sqldelight }}'

创建数据库连接

使用 JDBC 驱动创建 MySQL 数据库连接：

val driver = JdbcDriver("jdbc:mysql://localhost:3306/mydatabase?user=root&password=password")
val database = MyDatabase(driver)

PostgreSQL 驱动配置

添加 PostgreSQL 依赖

在 build.gradle.kts 或 build.gradle 中添加 PostgreSQL 驱动和方言依赖：

=== "Kotlin" kotlin dependencies { implementation("app.cash.sqldelight:postgresql-dialect:{{ versions.sqldelight }}") implementation("app.cash.sqldelight:jdbc-driver:{{ versions.sqldelight }}") runtimeOnly("org.postgresql:postgresql:42.6.0") }

=== "Groovy" groovy dependencies { implementation 'app.cash.sqldelight:postgresql-dialect:{{ versions.sqldelight }}' implementation 'app.cash.sqldelight:jdbc-driver:{{ versions.sqldelight }}' runtimeOnly 'org.postgresql:postgresql:42.6.0' }

配置 PostgreSQL 方言

在数据库配置中指定 PostgreSQL 方言：

=== "Kotlin" kotlin dialect("app.cash.sqldelight:postgresql-dialect:{{ versions.sqldelight }}")

=== "Groovy" groovy dialect 'app.cash.sqldelight:postgresql-dialect:{{ versions.sqldelight }}'

创建数据库连接

使用 JDBC 驱动创建 PostgreSQL 数据库连接：

val driver = JdbcDriver("jdbc:postgresql://localhost:5432/mydatabase?user=postgres&password=password")
val database = MyDatabase(driver)

SQLite 驱动配置

添加 SQLite 依赖

在 build.gradle.kts 或 build.gradle 中添加 SQLite 驱动和方言依赖：

=== "Kotlin" kotlin dependencies { implementation("app.cash.sqldelight:sqlite-3-38-dialect:{{ versions.sqldelight }}") implementation("app.cash.sqldelight:sqlite-driver:{{ versions.sqldelight }}") }

=== "Groovy" groovy dependencies { implementation 'app.cash.sqldelight:sqlite-3-38-dialect:{{ versions.sqldelight }}' implementation 'app.cash.sqldelight:sqlite-driver:{{ versions.sqldelight }}' }

配置 SQLite 方言

SQLite 有多个版本的方言可供选择，例如 SQLite 3.38：

=== "Kotlin" kotlin dialect("app.cash.sqldelight:sqlite-3-38-dialect:{{ versions.sqldelight }}")

=== "Groovy" groovy dialect 'app.cash.sqldelight:sqlite-3-38-dialect:{{ versions.sqldelight }}'

创建数据库连接

使用 SQLite 驱动创建数据库连接：

val driver = SqliteDriver(JdbcDriver.IN_MEMORY)
val database = MyDatabase(driver)

高级配置选项

迁移验证

启用迁移验证，确保迁移文件没有错误：

=== "Kotlin" kotlin verifyMigrations.set(true)

=== "Groovy" groovy verifyMigrations = true

异步代码生成

生成异步查询方法，用于异步驱动：

=== "Kotlin" kotlin generateAsync.set(true)

=== "Groovy" groovy generateAsync = true

模式输出目录

指定 schema 文件输出目录，用于验证迁移：

=== "Kotlin" kotlin schemaOutputDirectory.set(file("src/main/sqldelight/databases"))

=== "Groovy" groovy schemaOutputDirectory = file("src/main/sqldelight/databases")

常见问题解决

依赖冲突

如果遇到依赖冲突，可以使用 Gradle 的 dependencyInsight 任务查看依赖树：

./gradlew dependencyInsight --configuration implementation --dependency app.cash.sqldelight

方言版本不匹配

确保方言版本与 SQLDelight 版本一致，避免出现兼容性问题。

迁移失败

如果迁移失败，检查迁移文件的语法和顺序，确保每个迁移文件都是正确的 SQL 语句。

总结

通过本指南，你已经学会了如何在 JVM 环境中配置 SQLDelight，集成 MySQL、PostgreSQL 和 SQLite 驱动。SQLDelight 的类型安全特性和简洁的配置方式将帮助你更高效地开发数据库应用。如果你想了解更多高级功能，可以参考官方文档 docs/ 和示例项目 sample/。

希望这篇指南对你有所帮助，祝你在 SQLDelight 的使用过程中开发顺利！ 🚀

【免费下载链接】sqldelight SQLDelight - Generates typesafe Kotlin APIs from SQL 项目地址: https://gitcode.com/gh_mirrors/sq/sqldelight