DynamoDB Toolbox 实体方法详解：高效操作DynamoDB的秘诀

原创于 2025-06-26 09:30:33 发布 · 372 阅读

7 ·

CC 4.0 BY-SA版权

DynamoDB Toolbox 实体方法详解：高效操作DynamoDB的秘诀

前言

在开发基于DynamoDB的应用时，我们经常需要处理各种CRUD操作。DynamoDB Toolbox提供了一套简洁而强大的实体方法，让开发者能够更高效地与DynamoDB交互。本文将深入解析这些核心方法，帮助你掌握它们的用法和最佳实践。

基础方法

attribute方法：属性名解析

attribute方法是一个简单但实用的工具，它可以帮助你在属性名和别名之间进行转换：

const attrName = MyEntity.attribute('aliasName')

这在构建复杂查询时特别有用，特别是当你需要将用户友好的别名转换为DynamoDB实际使用的属性名时。

parse方法：数据解析

从DynamoDB获取的数据需要经过解析才能使用友好的别名。parse方法提供了这种转换能力：

const parsedData = MyEntity.parse(rawDataFromDynamoDB)

它支持多种输入格式：

单个对象
对象数组
包含Item或Items属性的响应对象

你还可以通过第二个参数指定只解析特定字段，这在只需要部分数据时能提升性能。

CRUD操作方法

get方法：精准获取单条数据

get方法是GetItem API的封装，用于精确获取指定主键的数据：

const result = await MyEntity.get({
  pk: 'user#123',
  sk: 'profile'
}, {
  consistent: true,  // 使用强一致性读取
  attributes: ['name', 'email']  // 只返回需要的字段
})

关键特性：

支持强一致性读取
支持属性投影（只返回指定字段）
可自定义返回的容量指标

delete方法：安全删除数据

删除操作需要谨慎，delete方法提供了多种安全措施：

const deletedItem = await MyEntity.delete(
  { pk: 'order#456', sk: '2023-01-01' },
  {
    conditions: { attr: 'status', exists: true },
    returnValues: 'all_old'  // 返回被删除前的数据
  }
)

安全特性：

支持条件删除（只有满足条件才执行）
可返回被删除前的数据
支持返回容量指标和集合统计信息

put方法：创建或替换数据

put方法既可以创建新数据，也可以完全替换现有数据：

await MyEntity.put({
  id: 'user#789',
  name: '张三',
  email: 'zhangsan@example.com',
  tags: ['vip', 'early-adopter']
}, {
  conditions: { attr: 'version', eq: 5 },  // 只有版本为5时才替换
  strictSchemaCheck: true  // 严格检查字段
})

重要选项：

strictSchemaCheck：严格模式会过滤掉未定义的字段
支持条件写入
可返回写入前的旧数据

update方法：灵活更新数据

update方法提供了最灵活的数据更新方式，支持多种更新操作：

基础更新

await MyEntity.update({
  pk: 'product#101',
  sk: 'detail',
  price: 99.99,
  stock: { $add: -1 }  // 库存减1
})

特殊操作

await MyEntity.update({
  pk: 'user#202',
  sk: 'preferences',
  $remove: ['temporary_flag'],  // 删除字段
  $add: {
    login_count: 1,  // 数字增加
    visited_pages: ['/new-page']  // 向集合添加元素
  }
})

高级特性：