深入理解 API 中的字段掩码:实现部分检索与更新
1. 部分更新的必要性
在 API 操作中,有时我们会遇到这样的情况。例如以下代码示例:
chatRoom = oldClient.GetChatRoom({ id: '1' });
console.log(chatRoom);
{
id: '1',
title: 'Old title',
}
chatRoom.title = 'New title';
ReplaceChatRoom({ chatRoom: chatRoom });
chatRoom = latestClient.GetChatRoom({ id: '1' });
console.log(chatRoom);
{
id: '1',
title: 'New title',
description: null
}
这里可以看到,使用旧客户端获取资源时,描述字段缺失;更新标题后,再用新客户端获取资源,描述字段被擦除。这是因为标准的替换方法会让远程资源与请求中指定的资源完全一致,会移除缺失字段的数据。所以,部分更新就显得尤为重要,它能让 API 消费者更明确表达自己的意图。如果要替换整个资源,可以使用标准的替换方法;若只想更新单个字段,则需要更细粒度的机制,而部分更新就是很好的解决方案。
2. 字段掩码概述
为了实现部分检索和部分更新这两个目标,我们可以借助字段掩码。字段掩码本质上是一组字符串,这些字符串代表了我们对某个资源感兴趣的字段列表。
- 部分检索 <
订阅专栏 解锁全文
34

被折叠的 条评论
为什么被折叠?



