DynamoDB-Toolbox 中解决 DeleteItemCommand 键计算问题的实践指南

问题背景

在使用 DynamoDB-Toolbox 进行 DynamoDB 操作时，开发者可能会遇到 DeleteItemCommand 无法正确计算主键的问题。具体表现为执行删除操作时，生成的键值对中出现了 undefined 值，导致操作失败。

核心问题分析

这个问题的根源在于实体定义时键属性的配置方式不正确。DynamoDB-Toolbox 提供了多种方式来定义主键：

1. 直接定义键属性：通过 .key() 方法明确标记哪些属性是键属性
2. 链接计算：使用 .link() 方法基于其他属性计算键值
3. 计算键函数：通过 computeKey 选项提供自定义键计算逻辑

解决方案

方案一：正确使用键属性和链接

const JurisdictionSchema = schema({
    code: string().key(),  // 明确标记code为键属性
    name: string(),
    description: string(),
    regionCode: string(),
    countryCode: string().optional(),
}).and((schema) => ({
    pk: string().key().link<typeof schema>(({ code }) => `JURISDICTION#${code}`),
    sk: string().key().link<typeof schema>(({ code }) => `JURISDICTION#${code}`),
}));

关键点：

• 必须对 code 属性使用 .key() 标记
• 对 pk 和 sk 也使用 .key() 标记
• 链接函数放在 .key() 之后

方案二：使用计算键函数

const JurisdictionEntity = new Entity({
    name: "Jurisdiction",
    table: VisaFeeTable,
    schema: JurisdictionSchema,
    computeKey: ({ code }) => ({
        pk: `JURISDICTION#${code}`,
        sk: `JURISDICTION#${code}`,
    }),
});

这种方法更直接，但需要确保传入的对象包含 code 属性。

方案三：使用前缀转换器

DynamoDB-Toolbox 提供了内置的转换器来简化常见操作：

import { prefix } from 'dynamodb-toolbox/transformers/prefix'

const JurisdictionSchema = schema({
    code: string().key(),
    // 其他属性...
}).and((schema) => ({
    pk: string().key().link<typeof schema>(({ code }) => code)
               .transform(prefix("JURISDICTION")),
    sk: string().key().link<typeof schema>(({ code }) => code)
               .transform(prefix("JURISDICTION")),
}));

最佳实践建议

1. 明确键属性：始终使用 .key() 明确标记哪些属性参与键计算
2. 保持一致性：选择一种键定义方式并在整个项目中保持一致
3. 利用内置功能：优先使用内置转换器等工具简化代码
4. 类型安全：充分利用 TypeScript 的类型检查确保键属性存在
5. 测试验证：编写单元测试验证键计算逻辑的正确性

总结

DynamoDB-Toolbox 提供了灵活的键定义方式，但需要开发者理解其工作原理。通过正确配置键属性和计算逻辑，可以避免 DeleteItemCommand 等操作中的键计算问题。选择适合项目需求的方案，并遵循最佳实践，可以构建出健壮高效的 DynamoDB 数据访问层。