DynamoDB Toolbox 中 computeKey 与 GetItemCommand 的使用问题解析

在使用 DynamoDB Toolbox 进行开发时，经常会遇到主键计算和项目查询的问题。本文将深入分析一个典型场景，帮助开发者正确使用 computeKey 和 GetItemCommand。

问题背景

在 DynamoDB 数据模型设计中，我们经常需要根据业务需求自定义主键结构。DynamoDB Toolbox 提供了 computeKey 方法来实现这一需求。然而，当与 GetItemCommand 结合使用时，可能会出现查询不到预期结果的情况。

典型错误示例

考虑以下数据模型定义：

schema: schema({
    username: string().required("always"),
    updatedBy: string().required("always"),
    alarmColumns: list(columTypeSchema).required("always"),
  }).and((prevSchema) => ({
    createdBy: string()
      .required("never")
      .putLink<typeof prevSchema>(({ updatedBy }) => updatedBy),
    esk: string()
      .required("never")
      .putLink<typeof prevSchema>(({ username }) => username),
  })),
  computeKey: ({ username }) => ({
    pk: `${username}`, 
    sk: "columnSettings",
  }),

这个模型看似合理，但在实际查询时却无法正常工作。

问题根源分析

1. 未标记关键字段：username 字段虽然是必需的，但没有明确标记为 key 字段，这会导致 DynamoDB Toolbox 无法正确识别它作为主键的一部分。

2. 类型转换问题：在 computeKey 中对 username 进行了不必要的字符串转换，虽然这在 JavaScript 中通常无害，但可能在某些情况下导致类型不一致。

3. 查询方式不当：直接使用 username 作为查询键，而没有考虑完整的键结构。

正确解决方案

方案一：明确标记关键字段

schema: schema({
    username: string().key(), // 明确标记为关键字段
    updatedBy: string().required("always"),
    alarmColumns: list(columTypeSchema).required("always"),
  }).and((prevSchema) => ({
    createdBy: string()
      .optional()
      .putLink<typeof prevSchema>(({ updatedBy }) => updatedBy),
    esk: string()
      .optional()
      .putLink<typeof prevSchema>(({ username }) => username),
  })),
  computeKey: ({ username }) => ({
    pk: username, // 不再需要类型转换
    sk: "columnSettings",
  }),

方案二：使用 savedAs 替代 computeKey

schema: schema({
    username: string().key().savedAs('pk'),
    entityName: string().key().const('columnSettings').savedAs('sk'),
    updatedBy: string().required("always"),
    alarmColumns: list(columTypeSchema).required("always"),
  }).and((prevSchema) => ({
    createdBy: string()
      .optional()
      .putLink<typeof prevSchema>(({ updatedBy }) => updatedBy),
    esk: string()
      .optional()
      .putLink<typeof prevSchema>(({ username }) => username),
  })),

最佳实践建议

1. 明确标记关键字段：对于任何参与主键计算的字段，都应该使用 .key() 方法明确标记。

2. 避免不必要的类型转换：DynamoDB Toolbox 会自动处理类型转换，手动转换可能导致意外行为。

3. 优先使用 savedAs：相比 computeKey，savedAs 提供了更直观和声明式的方式来定义键结构。

4. 保持一致性：确保在创建和查询项目时使用相同的键结构。

5. 测试验证：在实现后，应该编写测试用例验证创建和查询功能是否正常工作。

通过遵循这些原则，可以避免在使用 DynamoDB Toolbox 时遇到的大多数键相关的问题，确保数据操作的可靠性和一致性。