PocketBase JS SDK 中 TypeScript 与关联查询的实践指南

关联查询的数据结构特点

在使用 PocketBase JS SDK 进行开发时，处理关联查询（expanded relations）是一个常见的场景。与许多 REST API 不同，PocketBase 采用了一种特殊的数据结构来返回关联数据。当使用 expand 参数查询关联记录时，关联数据不会直接合并到主记录中，而是被放置在专门的 expand 对象下。

例如，查询声明记录并扩展用户关联时：

pb.collection("declarations").getFullList({ expand: "user" })

返回的数据结构会是：

{
  "id": "rec123",
  "date": "2024-09-18",
  "user": "user123",
  "expand": {
    "user": {
      "id": "user123",
      "name": "John Doe"
    }
  }
}

TypeScript 类型定义的最佳实践

为了在 TypeScript 中正确处理这种数据结构，我们需要特别注意类型定义。以下是几个关键点：

1. 基础字段类型：确保字段类型与实际返回的数据类型匹配。例如，日期字段实际上是字符串而非 Date 对象。

2. 关联字段处理：关联字段（如 user）在未扩展时只包含关联记录的 ID，扩展后才包含完整对象。

推荐的类型定义方式：

class Declaration {
  id?: string;
  created?: string;
  updated?: string;
  date?: string;  // 注意是字符串而非Date
  hours?: number;
  user?: string | User; // 可以是ID或完整用户对象
  expand?: {
    user?: User;
    assignment?: Assignment;
  };
}

数据转换策略

在实际应用中，我们通常需要将原始 API 响应转换为更适合前端使用的形式。以下是几种常见策略：

1. 自定义转换函数：

function transformDeclaration(raw: any): Declaration {
  return {
    ...raw,
    user: raw.expand?.user || raw.user,
    date: raw.date ? new Date(raw.date) : undefined
  };
}

2. 使用类 getter：

class Declaration {
  private _raw: any;
  
  constructor(raw: any) {
    this._raw = raw;
  }
  
  get user(): User | undefined {
    return this._raw.expand?.user || this._raw.user;
  }
  
  get date(): Date | undefined {
    return this._raw.date ? new Date(this._raw.date) : undefined;
  }
}

3. 响应拦截器：

pb.afterSend = function (response, data) {
  if (data?.expand) {
    return { ...data, ...data.expand };
  }
  return data;
};

实际开发中的注意事项

1. 类型安全性：始终确保类型定义与实际数据结构匹配，避免运行时错误。

2. 空值处理：关联字段可能不存在，代码中应做好防御性编程。

3. 性能考量：大量数据转换可能影响性能，特别是在移动设备上。

4. 一致性：在整个项目中保持统一的数据处理策略，便于维护。

通过合理设计类型系统和数据处理流程，可以充分利用 TypeScript 的类型优势，同时适应 PocketBase 的特殊数据结构，构建健壮的前端应用。