首页
/ DynamoDB Toolbox 中 FormattedItem 类型的使用技巧

DynamoDB Toolbox 中 FormattedItem 类型的使用技巧

2025-07-06 21:31:27作者:殷蕙予

理解 FormattedItem 类型

在 DynamoDB Toolbox 这个优秀的 TypeScript 库中,FormattedItem<ENTITY> 是一个非常有用的类型工具。它能够根据我们定义的实体模式(schema)自动推断出完整的类型结构,包括实体本身的属性以及 DynamoDB Toolbox 自动添加的内部属性。

默认情况下,FormattedItem 类型会包含:

  1. 实体模式中定义的所有属性
  2. 两个自动管理的时间戳属性:createdmodified

时间戳属性的控制

在实际开发中,我们经常需要创建新的实体对象,但在创建阶段并不需要(也不应该)手动设置 createdmodified 这些内部属性。DynamoDB Toolbox 提供了灵活的方式来控制这些时间戳属性:

全局禁用时间戳

可以在创建实体时通过配置完全禁用时间戳功能:

const myEntity = new Entity({
  name: 'MyEntity',
  attributes: {...},
  timestamps: false  // 禁用所有时间戳属性
});

选择性禁用特定时间戳

也可以选择性地禁用某一个时间戳属性:

const myEntity = new Entity({
  name: 'MyEntity',
  attributes: {...},
  timestamps: {
    createdAt: false,  // 仅禁用 createdAt
    updatedAt: true    // 保留 updatedAt
  }
});

更合适的类型选择

对于创建新实体的场景,特别是使用 batchWrite 批量写入时,FormattedItem 可能不是最合适的选择,因为它要求包含所有属性(包括自动生成的属性)。

DynamoDB Toolbox 提供了 PutItemInput 类型,它更适合这种场景:

  • 自动使具有默认值的属性变为可选
  • 使关联属性(如时间戳)变为可选
  • 完美匹配写入操作的类型要求

使用示例:

type StationDescription = PutItemInput<typeof stationDescriptionEntity>;

const stations: StationDescription[] = [];

for (const data of someOtherDataSource) {
  stations.push({
    id: data.id,
    foo: 'bar',
    address: data.address + 'x'
  });  // 不再需要包含 created/modified
}

类型推断的最佳实践

在使用 DynamoDB Toolbox 的类型系统时,有一个重要注意事项:当手动为 Entity 提供泛型参数时,必须提供所有泛型参数,否则未提供的参数会使用默认值而非从参数中推断。

因此,最佳实践是让 TypeScript 自动推断类型,而不是手动指定泛型参数:

// 推荐做法 - 自动推断所有类型
const myEntity = new Entity({
  name: 'MyEntity',
  attributes: {...},
  timestamps: false
});

// 不推荐 - 手动指定泛型可能导致类型推断不完整
const myEntity = new Entity<...>({...});

通过遵循这些实践,可以确保获得最准确的类型推断,同时保持代码的简洁性和可维护性。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511