Turms即时通讯系统中自定义属性扩展方案解析

背景与需求分析

在现代即时通讯系统开发中，业务场景往往需要为基本通信对象（用户、群组、会话）添加自定义属性。以Turms项目为例，开发者提出了以下典型需求：

1. 用户对象扩展：需要支持标签系统（如"同事/活跃/可爱"）、办公地点、邮箱等业务属性
2. 群组对象扩展：要求支持VIP标识、欠费状态、所属组织ID等业务标记
3. 会话对象扩展：需要在会话列表展示自定义状态信息，包括私人会话标签、群组会话特殊标识等

技术方案演进

初始方案评估

传统解决方案通常采用两种方式：

1. 独立存储关联：建立额外数据表，通过userId/groupId等外键关联
2. 通用扩展字段：使用类似Map<String, String>的extra字段存储任意键值对

Turms团队出于以下考虑未采用通用扩展字段方案：

• 类型安全性难以保证
• 缺乏字段约束机制
• 可能导致数据滥用问题

官方解决方案设计

Turms团队提出了更优雅的解决方案：

1. 专用属性存储：

   • 为每个实体类型设计独立的Settings对象（UserSettings/GroupSettings/ConversationSettings）
   • 支持严格类型校验和值验证
   • 提供细粒度的访问控制

2. 典型应用场景：

   • 阅后即焚功能：通过ConversationSettings.burnAfter配置
   • 业务标记：使用flags数组存储VIP、组织ID等标识
   • 客户端偏好设置：如界面语言、通知偏好等

3. 查询优化：

   • 在queryXXX接口中直接返回关联的Settings对象
   • MongoDB存储优化，确保查询效率

实现建议

对于需要扩展属性的开发者，建议：

1. 简单属性扩展：

// 用户设置示例
UserSettings settings = new UserSettings()
    .add("tags", List.of("colleague", "active"))
    .add("officeLocation", "Beijing");

2. 复杂业务场景：

// 群组设置示例
GroupSettings settings = new GroupSettings()
    .add("vipLevel", 3)
    .add("relatedCompanyId", "comp_123")
    .add("paymentStatus", "paid");

3. 服务端配置： 通过Turms服务端配置可以限制允许的字段名和类型，确保数据规范性。

架构优势

该方案相比传统方案具有显著优势：

1. 类型安全：避免Map<String, Object>带来的类型转换风险
2. 可维护性：明确的字段定义便于后期维护
3. 性能优化：MongoDB内嵌文档设计减少查询次数
4. 扩展灵活：支持未来新增预定义字段

总结

Turms通过精心设计的Settings机制，既满足了业务系统对自定义属性的需求，又保持了系统的健壮性和可维护性。这种设计思路值得其他IM系统借鉴，特别是在需要平衡灵活性和规范性的场景下。开发者可以基于此方案快速实现各类业务扩展需求，而无需担心底层数据存储的兼容性问题。