Drizzle ORM 中如何优雅地处理 TypeScript 枚举类型

在 TypeScript 开发中，枚举(Enum)是一种常见的数据结构，用于定义一组命名的常量。Drizzle ORM 作为一个现代化的 TypeScript ORM 工具，提供了对枚举类型的支持，但在实际使用中开发者可能会遇到一些类型处理上的挑战。

枚举类型的常见使用场景

在数据库设计中，枚举字段非常常见。例如，用户状态(status)可能只有"active"、"inactive"、"pending"等几种固定值。在 TypeScript 中，我们通常有三种方式定义这样的枚举：

1. 传统字符串数组方式

export const STATUS_VALUES = ['active', 'inactive', 'pending'] as const;

2. 对象常量方式

export const STATUS = {
  ACTIVE: 'active',
  INACTIVE: 'inactive',
  PENDING: 'pending'
} as const;

3. TypeScript 原生枚举

enum Status {
  ACTIVE = 'active',
  INACTIVE = 'inactive',
  PENDING = 'pending'
}

Drizzle ORM 中的枚举支持

Drizzle ORM 目前主要支持第一种方式(字符串数组)来定义枚举字段。例如在 MySQL 中：

import { mysqlTable, mysqlEnum } from "drizzle-orm/mysql-core";

mysqlTable('users', {
  status: mysqlEnum('status', STATUS_VALUES)
});

然而，开发者更习惯使用对象常量或原生枚举的方式，因为这些方式提供了更好的类型安全性和代码可读性。

高级类型转换技巧

为了在 Drizzle ORM 中使用对象常量或原生枚举，我们需要一些高级的类型转换技巧。核心思路是将枚举类型转换为元组类型，这正是 Drizzle ORM 所期望的格式。

类型转换工具

我们可以创建一组类型工具来完成这个转换：

// 将联合类型转换为交叉类型
type UnionToIntersection<U> = 
  (U extends any ? (x: U) => any : never) extends (x: infer I) => any ? I : never;

// 获取联合类型的最后一个元素
type LastOf<T> = 
  UnionToIntersection<T extends any ? (x: T) => any : never> extends (x: infer L) => any ? L : never;

// 向元组添加元素
type Push<T extends any[], V> = [...T, V];

// 将联合类型转换为元组类型
type UnionToTuple<T, L = LastOf<T>> = 
  [T] extends [never] ? [] : Push<UnionToTuple<Exclude<T, L>>, L>;

// 主工具：将枚举转换为元组
type EnumToTuple<E> = UnionToTuple<E[keyof E]>;

实用函数

基于上述类型工具，我们可以创建一个实用函数：

function nativeEnum<E extends Record<string, string>>(anEnum: E): EnumToTuple<E> {
  return Object.values(anEnum) as unknown as EnumToTuple<E>;
}

使用示例：

enum UserStatus {
  ACTIVE = 'active',
  INACTIVE = 'inactive',
  PENDING = 'pending'
}

pgTable('users', {
  id: bigserial({ mode: 'number' }).primaryKey(),
  status: text({ enum: nativeEnum(UserStatus) }),
});

最佳实践建议

1. 对于简单的枚举值，可以直接使用字符串数组方式，这是最直接的支持方式。

2. 当需要更好的代码组织和类型安全时，可以使用原生枚举配合上述转换工具。

3. 考虑将类型转换工具封装为项目中的共享工具，提高代码复用性。

4. 注意枚举值的顺序在转换为元组后可能不会保持原样，如果顺序很重要，建议使用数组方式定义。

Drizzle ORM 从 0.42.0 版本开始已经内置了对这种枚举处理方式的支持，开发者可以更自然地使用 TypeScript 的枚举特性与数据库交互。