Kysely项目中如何安全地限制数据库部分访问权限

在实际开发中，我们经常会遇到需要共享数据库访问逻辑的场景，特别是像身份验证这样的通用功能。本文将探讨如何在使用Kysely这个TypeScript SQL查询构建器时，优雅地实现数据库部分表的访问控制。

问题背景

假设我们有几个应用都使用Kysely访问数据库，现在需要提取一些共享逻辑（如认证逻辑）。我们希望这些共享模块只知道自己需要的表结构，而不需要了解整个数据库的完整结构。但同时，这些模块还需要能够与其他业务逻辑一起在同一个事务中工作，因此必须使用相同的数据库连接。

类型安全的解决方案

基础方案

首先定义部分数据库接口和完整数据库接口：

// 共享模块中的定义
interface PartialDb {
  users: {
    id: string
    username: string
    password_hash: string
  };
}

// 应用完整定义
interface WholeDb {
  users: {
    id: string
    username: string
    password_hash: string
  };
  products: {
    id: string
    name: string
    price: number
  };
}

类型断言方案

Kysely核心贡献者推荐使用类型断言的方式，在保证外部类型安全的前提下，内部进行类型转换：

function authFunction<DB extends PartialDb>(db: Kysely<DB>) {
  // 外部类型检查确保传入的db至少包含PartialDb结构
  // 内部进行类型转换以简化类型处理
  return (db as unknown as Kysely<PartialDb>)
    .selectFrom("users")
    .select(["id", "username"])
    .executeTakeFirstOrThrow();
}

这种方案的优势在于：

1. 外部调用时保证了类型安全
2. 内部简化了类型处理
3. 保持了事务等高级功能的完整性

接口继承方案

另一种思路是利用TypeScript的接口继承特性：

// 共享模块
export interface AuthTables {
  users: {
    id: string
    username: string
    password_hash: string
  };
  sessions: {
    id: string
    user_id: string
    expires_at: Date
  };
}

// 应用模块
interface AppDb extends AuthTables {
  products: {
    id: string
    name: string
    price: number
  };
  orders: {
    id: string
    user_id: string
    product_id: string
    quantity: number
  };
}

这种方式更符合面向对象的设计原则，但灵活性稍逊于类型断言方案。

高级技巧

对于需要更精细控制的情况，可以考虑以下方法：

1. 使用Omit工具类型：排除不需要的方法

   type RestrictedKysely = Omit<Kysely<PartialDb>, "transaction" | "connection">;
   

2. 组合使用泛型和类型守卫：创建更灵活的类型检查

   function isPartialDb<T>(db: Kysely<T>): db is Kysely<T & PartialDb> {
     // 实现运行时检查逻辑
     return true;
   }
   

最佳实践建议

1. 共享模块设计：将数据库接口定义与业务逻辑分离，便于复用
2. 类型安全优先：始终确保外部调用的类型安全性
3. 文档说明：对任何类型转换进行充分注释说明
4. 单元测试：增加类型相关的测试用例

总结

在Kysely项目中实现数据库部分访问控制，核心在于平衡类型安全性和代码灵活性。通过合理使用TypeScript的类型系统特性，我们可以在保持代码整洁的同时，实现严格的访问控制。无论是选择类型断言还是接口继承方案，关键是根据项目实际需求选择最适合的方式。

对于大型项目，建议采用分层架构设计，将数据库访问层、业务逻辑层和共享模块清晰分离，这样既能保证代码的可维护性，又能实现精细的访问控制。