Kysely项目中的自定义Select查询构建技巧

在使用Kysely进行数据库查询时，开发者经常需要复用相同的字段选择逻辑。本文将通过一个实际案例，介绍如何在Kysely中优雅地实现Select查询的重用。

问题背景

在开发过程中，我们经常需要从用户表中获取相同的基本信息，但可能在不同的查询条件下使用。例如，我们可能需要获取用户的ID和用户名，但查询条件可能根据用户ID、用户名或其他字段而变化。

常见误区

许多开发者会尝试创建一个返回SelectQueryBuilder的函数，类似这样：

function GetBasicUserData() {
   return (eb: ExpressionBuilder<Database, 'user'>) => {
   return eb.selectFrom("user")
   .select(["user.userID as ID", "user.username as Username"]);
   }
}

然后尝试在查询中使用：

getBasicUserFromID(UserID: string) {
  return SQL.DB.selectFrom("user")
  .where("user.userID", "=", UserID)
  .select(GetBasicUserData()) // 这里会出现错误
  .executeTakeFirst();
}

这种方法会导致类型错误，因为Kysely的select方法期望的是直接的字段选择，而不是一个构建器函数。

正确解决方案

Kysely提供了更简单的方式来实现字段选择的重用。我们可以直接定义一个包含所需字段的数组，并在多个查询中复用这个数组：

// 使用as const确保TypeScript保留字面量类型
const userSelections = ["user.userID AS ID", "user.username as UserName"] as const;

function getBasicUserFromID(UserID: string) {
  return SQL.DB.selectFrom("user")
    .where("user.userID", "=", UserID)
    .select(userSelections)
    .executeTakeFirst();
}

技术要点解析

1. 类型安全：使用as const断言非常重要，它告诉TypeScript保留数组元素的实际字符串字面量类型，而不是将其扩展为普通的string类型。

2. 复用性：定义的userSelections可以在应用程序的任何地方重复使用，确保字段选择的一致性。

3. 简洁性：这种方法避免了不必要的函数调用和构建器模式，使代码更加直观和易于维护。

扩展应用

这种模式不仅适用于简单的字段选择，还可以用于更复杂的场景：

// 定义常用选择字段
const userProfileSelections = [
  "user.userID AS id",
  "user.username",
  "user.email",
  "user.createdAt",
  "user.updatedAt"
] as const;

// 在不同查询中复用
function getUserProfile(id: string) {
  return db.selectFrom("user")
    .where("userID", "=", id)
    .select(userProfileSelections)
    .executeTakeFirst();
}

function searchUsers(keyword: string) {
  return db.selectFrom("user")
    .where("username", "like", `%${keyword}%`)
    .select(userProfileSelections)
    .execute();
}

总结

在Kysely中，通过定义常量数组来复用字段选择是一种简单而有效的方法。它不仅提高了代码的可维护性，还确保了类型安全。相比尝试创建复杂的查询构建器函数，这种直接的方式更加符合Kysely的设计哲学，能够帮助开发者编写出更清晰、更可靠的数据库查询代码。