DynamoDB Toolbox 中 GSI 索引的正确使用方法

概述

在使用 DynamoDB Toolbox 时，许多开发者会遇到如何正确配置和使用全局二级索引(GSI)的问题。本文将详细介绍在 DynamoDB Toolbox 中配置和使用 GSI 的最佳实践。

核心概念

主键与索引键的区别

在 DynamoDB 中，主键(PK/SK)和索引键(GSI)是两种不同的概念。主键是表的必需组成部分，而索引键则是可选的辅助查询结构。DynamoDB Toolbox 通过 computeKey 方法专门处理主键，而索引键则需要通过其他方式处理。

常见误区

许多开发者会尝试在 computeKey 方法中同时定义主键和索引键，这是不正确的做法。computeKey 方法仅应用于主键的计算，索引键应该通过其他机制处理。

正确实现方法

使用链接(Link)机制

DynamoDB Toolbox 提供了链接机制，可以优雅地处理索引键的生成。我们可以将业务字段链接到技术字段，并应用必要的转换：

const conversationSchema = schema({
  userId: string().key(),
  conversationId: string().key().savedAs('id'),
  // 其他业务字段...
});

export const SomeEntity = new Entity({
  name: 'Conversation',
  table: Table,
  schema: conversationSchema.and({
    pk: string()
      .key()
      .link(({ userId }) => userId)
      .transform(prefix('USER')),
    sk: string()
      .key()
      .link(({ conversationId }) => conversationId)
      .transform(prefix('CONVERSATION_ID')),
    gsi1pk: string()
      .link(({ conversationId }) => conversationId)
      .transform(prefix('CONVERSATION_ID')),
    gsi1sk: string()
      .link(({ userId }) => userId)
      .transform(prefix('USER'))
  })
});

数据操作示例

插入数据

await SomeEntity.build(PutItemCommand)
  .item({ conversationId, userId })
  .send();

查询数据

const { Items } = await Table.build(QueryCommand)
  .query({
    partition: `CONVERSATION_ID#${conversationId}`,
    index: 'GSI1'
  })
  .entities(ConversationEntity)
  .send();

最佳实践

1. 分离业务字段与技术字段：保持业务模型的纯净，在实体定义中扩展技术字段
2. 使用链接和转换：利用链接机制和转换函数简化键的生成
3. 明确区分主键和索引键：理解它们在 DynamoDB 中的不同角色
4. 保持一致性：在键的命名和前缀使用上保持一致的约定

总结

通过正确使用 DynamoDB Toolbox 的链接机制，我们可以优雅地处理 GSI 索引的生成和使用。这种方法不仅保持了代码的整洁性，还确保了数据模型的一致性。理解主键和索引键的区别是有效使用 DynamoDB 的关键，而 DynamoDB Toolbox 提供了强大的工具来简化这一过程。