RxDB中自定义删除字段与冲突处理的注意事项

RxDB作为一款优秀的客户端数据库解决方案，在处理数据同步冲突时提供了灵活的配置选项。本文将深入探讨在使用自定义删除字段(deletedField)时可能遇到的冲突处理问题，帮助开发者更好地理解和解决这类问题。

问题背景

在RxDB中，默认使用_deleted字段来标记文档是否被删除。然而在实际项目中，开发者可能需要与使用不同字段名的后端系统进行同步。例如，当后端GraphQL API使用deleted而非_deleted时，开发者可以通过设置deletedField: 'deleted'来适配。

核心问题

当配置了自定义删除字段后，在冲突处理过程中会出现一个关键问题：冲突处理器的输入参数中，不同状态文档的删除字段命名不一致。

具体表现为：

• realMasterState仍然使用RxDB内部的_deleted字段
• newDocumentState和assumedMasterState则使用配置的自定义deleted字段

这种不一致性会导致冲突处理逻辑变得复杂，开发者需要额外处理字段名的转换。

技术原理

RxDB的这种行为设计有其内在逻辑：

1. 内部存储一致性：RxDB内部始终使用_deleted作为标准字段名，这是为了保持核心功能的稳定性
2. 网络层转换：自定义删除字段名仅在数据同步时生效，用于与外部系统交互
3. 冲突处理上下文：冲突处理器接收的是原始内部状态，因此保留了_deleted字段

最佳实践

针对这一问题，开发者可以采取以下策略：

1. 统一处理逻辑：在冲突处理器中显式处理两种字段名

const deletedValue = 
  realMasterState._deleted !== undefined 
    ? realMasterState._deleted 
    : (realMasterState as any).deleted;

2. 类型扩展：为冲突处理器创建专门的类型定义，明确可能存在的两种字段

type ConflictDoc<T> = T & {
  _deleted?: boolean;
  deleted?: boolean;
};

3. 结果规范化：无论处理过程中使用哪个字段，最终返回的解决结果应使用_deleted

设计建议

从RxDB的设计角度来看，这个问题可能有以下改进方向：

1. 内部统一：冲突处理器中的所有状态文档都使用_deleted字段
2. 配置感知：使冲突处理器能够感知deletedField配置，自动处理转换
3. 文档完善：在官方文档中明确说明这一行为，帮助开发者预期

总结

理解RxDB中删除字段的处理机制对于实现可靠的数据同步至关重要。当使用自定义删除字段时，开发者应当注意冲突处理器中的字段名差异，并采取适当的处理策略。虽然当前行为可能带来一些不便，但通过合理的封装和类型定义，完全可以构建出健壮的冲突解决逻辑。

对于需要深度定制同步逻辑的项目，建议在冲突处理器上层添加一个适配层，统一处理字段名转换，从而保持业务逻辑的简洁性。