DynamoDB Toolbox 中处理复合主键的正确方式

在使用 DynamoDB Toolbox 进行开发时，复合主键(PK/SK)的设计是一个常见需求。本文将深入探讨如何正确使用 computeKey 和 savedAs 两种方式来实现这一功能。

复合主键的两种实现方式

1. 使用 savedAs 重命名属性

saveAs 是最直接的方式，它允许你将模型属性映射到 DynamoDB 的实际字段名：

const FeatureSet = new Entity({
  name: 'FeatureSet',
  schema: schema({
    id: string().key().savedAs('pk'),  // 将id映射为pk字段
    type: string().key().default('featureSetId').savedAs('sk'), // 将type映射为sk字段
    featureSets: string(),
  }),
  table: DashboardTable,
});

这种方式的特点是：

• 代码直观，明确显示了属性与字段的映射关系
• 不会在数据库中存储多余的属性
• 适合简单的键映射场景

2. 使用 computeKey 动态计算键值

computeKey 提供了更灵活的方式来生成主键：

const FeatureSet = new Entity({
  name: 'FeatureSet',
  schema: schema({
    id: string().key(),
    type: string().key().default('featureSetId'),
    featureSets: string(),
  }),
  computeKey: ({ id, type }) => ({ pk: id, sk: type }),
  table: DashboardTable,
});

需要注意的是：

• computeKey 仅用于生成主键，不会自动移除原始属性
• 如果使用这种方式，查询时仍需提供原始属性值
• 适合需要复杂计算的键值场景

常见问题解决方案

当遇到 formatter.missingAttribute 错误时，通常是因为：

1. 使用 computeKey 但未提供原始属性值
2. 格式化的数据缺少必需字段

解决方案有两种：

方案一：补充原始属性值

const formattedFset = FeatureSet.build(EntityFormatter).format({
  pk: '...',  // 计算后的pk值
  id: '...',   // 原始id值
  sk: '...',   // 计算后的sk值
  type: '...', // 原始type值
  // 其他属性...
});

方案二：改用 savedAs 方式

如前面所示，使用 savedAs 可以避免这种问题，使代码更加简洁。

最佳实践建议

1. 对于简单的键映射，优先使用 savedAs
2. 需要动态计算键值时再考虑 computeKey
3. 格式化数据时确保包含所有必需字段
4. 考虑使用 EntityFormatter 来简化格式化操作

通过理解这些概念和技巧，开发者可以更高效地使用 DynamoDB Toolbox 处理复合主键场景。