Gleam-Cake 库：SQL 查询构建器的演进与实践-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_07225/article/details/148576170

Gleam-Cake 库：SQL 查询构建器的演进与实践

gleam-cake A Gleam library to compose SQL queries targeting SQL dialects PostgreSQL, SQLite, MariaDB and MySQL. 项目地址: https://gitcode.com/gh_mirrors/gl/gleam-cake

Gleam-Cake 是一个为 Gleam 语言设计的 SQL 查询构建器库，它提供了一种类型安全且富有表现力的方式来构建和执行 SQL 查询。本文将从技术演进的角度，深入探讨该库的设计理念、核心功能以及最佳实践。

核心设计理念

Gleam-Cake 采用了模块化的设计思想，将 SQL 的不同操作（如 SELECT、INSERT、UPDATE、DELETE）分离到独立的模块中。这种设计不仅提高了代码的可维护性，还使得 API 更加直观和易于理解。

库的核心在于其查询构建器模式，开发者可以通过链式调用逐步构建复杂的 SQL 查询。例如，一个典型的 SELECT 查询构建过程如下：

sql_select.new()
|> sql_select.from_table("users")
|> sql_select.select(sql_select.col("*"))
|> sql_select.where(sql_where.col("age") |> sql_where.gt(sql_where.int(18)))

关键功能演进

查询到 SQL 的转换：早期版本中，开发者需要依赖内部 API 来获取生成的 SQL 语句和参数。经过社区反馈，0.10.0 版本引入了公共接口 cake.get_sql 和 cake.get_params，使得这一过程更加规范和稳定。
参数类型系统：参数模块从内部实现提升为公共 API，提供了 Param 类型及其变体（如 BoolParam、IntParam 等），支持类型安全的参数传递。
多方言支持：库设计考虑到了对不同 SQL 方言的支持，通过可插拔的方言模块实现。

实际应用示例

以下是一个完整的 PostgreSQL 查询示例，展示了如何构建查询、获取 SQL 及参数，并执行查询：

// 构建查询
let #(sql, raw_params) =
  sql_select.new()
  |> sql_select.from_table("ninjas")
  |> sql_select.select(sql_select.col("*"))
  |> sql_select.where(sql_where.col("rank") |> sql_where.eq(sql_where.string("S")))
  |> sql_select.to_query
  |> cake.to_sql

// 转换参数为数据库驱动需要的格式
let params = list.map(raw_params, fn(param) {
  case param {
    BoolParam(b) -> pgo.bool(b)
    IntParam(i) -> pgo.int(i)
    FloatParam(f) -> pgo.float(f)
    StringParam(s) -> pgo.text(s)
    NullParam -> pgo.null()
  }
})

// 执行查询
pgo.execute(sql, db, params, decoder)

最佳实践建议

模块导入风格：建议使用简洁的模块别名，如将 cake/select 导入为 s，cake/where 导入为 w 等，可以提高代码的简洁性。
查询分离：将复杂查询逻辑分离到专门的模块中，有助于提高代码的可维护性。
类型安全：充分利用 Gleam 的类型系统，为查询结果定义明确的解码器。