Kysely 中动态引用嵌套 JSON 属性的探讨

Kysely 是一个类型安全的 SQL 查询构建器，它提供了强大的类型系统来构建 SQL 查询。在使用 Kysely 时，开发者经常会遇到需要动态引用数据库表中嵌套 JSON 属性的场景。

问题背景

假设我们有一个用户表，其中包含一个存储为 JSON 类型的 name 字段，该字段包含 first_name 和 last_name 两个子属性。开发者希望能够构建一个灵活的查询接口，允许客户端通过任意字段（包括嵌套的 JSON 属性）来过滤用户数据。

现有解决方案

Kysely 提供了 DynamicModule.ref 方法来动态引用列名，但它原生不支持直接引用嵌套的 JSON 属性路径。目前，开发者可以通过以下方式实现这一需求：

1. 使用原生 SQL 表达式：通过 sql 模板字面量手动构建 JSON 路径引用
2. 自定义解析函数：编写辅助函数来解析和构建 JSON 路径引用

技术实现细节

对于 JSON 类型的列，PostgreSQL 提供了 -> 和 ->> 操作符来访问嵌套属性。在 Kysely 中，我们可以利用这些操作符构建查询：

const [col, ...subPaths] = column.split('.');

query = query.where(eb => eb(
  subPaths.length ? 
    sql`${sql.ref(col)}->>${subPaths.map(path => `'${path}'`).join('->>')}` : 
    sql.ref(col), 
  op, 
  value
))

这种方法虽然有效，但缺乏类型安全性，因为编译器无法验证 JSON 路径的正确性。

类型安全考虑

Kysely 的核心优势在于其类型安全性。对于动态 JSON 路径引用，完全的编译时类型检查确实存在挑战，因为：

1. JSON 结构可能在运行时变化
2. 路径字符串来自用户输入
3. 不同记录可能有不同的 JSON 结构

最佳实践建议

1. 输入验证：在使用前验证用户提供的路径字符串
2. 有限路径集：如果可能，限制可查询的 JSON 路径为已知集合
3. 防御性编程：处理可能不存在的 JSON 路径情况
4. 文档说明：清晰记录支持的查询字段和格式

未来可能性

虽然当前 Kysely 核心团队认为这个功能过于宽泛而难以保证类型安全，但随着 TypeScript 类型系统的发展，未来可能会有更优雅的解决方案出现，比如：

1. 基于模板字面量类型的路径验证
2. 预定义的 JSON 模式类型
3. 更强大的编译时字符串处理能力

总结

在 Kysely 中处理动态 JSON 属性引用需要权衡灵活性和类型安全性。虽然目前没有内置的一站式解决方案，但通过组合现有的 SQL 构建功能，开发者仍然可以实现这一需求。重要的是要根据具体应用场景选择适当的抽象级别，并在灵活性和安全性之间找到平衡点。