82 lines
3.5 KiB
Markdown
82 lines
3.5 KiB
Markdown
|
# 变更记录：同步配置管理实现
|
|||
|
|
|
|||
|
|
## 变更信息
|
|||
|
|
|
|||
|
|
- **版本号**: v1.1.0
|
|||
|
|
- **发布日期**: 2026-01-10
|
|||
|
|
- **变更类型**: [特性更新]
|
|||
|
|
|
|||
|
|
## 变更摘要
|
|||
|
|
|
|||
|
|
本次变更实现了Salesforce Pub/Sub API实时同步的配置管理功能，包括同步配置管理、通过objectController提供变更实时同步状态的方法、以及在对象启用Pub/Sub API时检查batch表是否全量拉取存量数据的功能。这些配置管理功能确保了实时同步的灵活性和可靠性。
|
|||
|
|
|
|||
|
|
## 详细变更
|
|||
|
|
|
|||
|
|
### 特性更新
|
|||
|
|
|
|||
|
|
- **同步配置管理** - 通过is_realtime_sync字段控制对象是否开启实时同步
|
|||
|
|
- **状态变更方法** - 在objectController中增加updateRealtimeSyncStatus方法，用于变更对象的实时同步状态
|
|||
|
|
- **batch表检查** - 在对象启用Pub/Sub API时检查batch表是否已经全量拉取存量数据，若没有则提示但仍可启用Pub/Sub API
|
|||
|
|
- **Salesforce配置验证** - 在变更实时同步状态时，查询Salesforce的PlatformEventChannelMember表，检查是否启用了实时同步
|
|||
|
|
- **Pub/Sub API集成** - 集成Salesforce Pub/Sub API客户端库，实现高性能的实时数据同步
|
|||
|
|
|
|||
|
|
## 影响范围
|
|||
|
|
|
|||
|
|
### 受影响的模块
|
|||
|
|
|
|||
|
|
- **配置管理模块** - 扩展配置管理功能
|
|||
|
|
- **对象管理模块** - 新增实时同步状态变更方法
|
|||
|
|
- **Salesforce集成模块** - 新增Salesforce Pub/Sub API集成和配置验证功能
|
|||
|
|
|
|||
|
|
### 兼容性说明
|
|||
|
|
|
|||
|
|
- **向后兼容** - 本次变更不影响现有的配置管理功能
|
|||
|
|
- **API兼容性** - 新增的配置管理API与现有API保持一致
|
|||
|
|
|
|||
|
|
## 升级指南
|
|||
|
|
|
|||
|
|
### 升级步骤
|
|||
|
|
|
|||
|
|
1. **更新代码** - 更新配置管理相关的代码，集成Salesforce Pub/Sub API客户端库
|
|||
|
|
2. **重启服务** - 重启应用服务以加载新的配置管理功能
|
|||
|
|
3. **配置对象** - 配置需要开启实时同步的对象
|
|||
|
|
4. **验证功能** - 验证配置管理功能是否正常工作
|
|||
|
|
|
|||
|
|
### 注意事项
|
|||
|
|
|
|||
|
|
- **Salesforce权限** - 确保应用有足够的权限查询PlatformEventChannelMember表和使用Pub/Sub API
|
|||
|
|
- **batch表数据** - 确保batch表中有全量拉取的存量数据
|
|||
|
|
- **缓存更新** - 确保配置变更后及时更新缓存中的配置信息
|
|||
|
|
- **Pub/Sub API配置** - 确保正确配置Pub/Sub API客户端参数，以获得最佳性能和可靠性
|
|||
|
|
|
|||
|
|
## 测试信息
|
|||
|
|
|
|||
|
|
### 测试环境
|
|||
|
|
|
|||
|
|
- **开发环境** - 本地开发环境，连接Salesforce Sandbox
|
|||
|
|
- **测试环境** - 测试服务器，连接Salesforce Sandbox
|
|||
|
|
|
|||
|
|
### 测试结果
|
|||
|
|
|
|||
|
|
- **配置管理测试** - 成功管理同步配置
|
|||
|
|
- **状态变更测试** - 成功变更对象的实时同步状态
|
|||
|
|
- **batch表检查测试** - 成功检查batch表是否全量拉取存量数据
|
|||
|
|
- **Salesforce配置验证测试** - 成功验证Salesforce的实时同步配置
|
|||
|
|
- **Pub/Sub API集成测试** - 成功集成和使用Salesforce Pub/Sub API
|
|||
|
|
|
|||
|
|
## 相关链接
|
|||
|
|
|
|||
|
|
- [需求文档](../requirements/0001-salesforce-realtime-sync.md) - Salesforce数据及时同步至本地数据库
|
|||
|
|
- [设计文档](../design/0001-salesforce-cdc-realtime-sync.md) - Salesforce Pub/Sub API实时同步设计
|
|||
|
|
- [架构决策](../decisions/adr/0001-salesforce-cdc-sync.md) - Salesforce Pub/Sub API同步方案
|
|||
|
|
|
|||
|
|
## 发布人员
|
|||
|
|
|
|||
|
|
- **开发人员** - 系统管理员
|
|||
|
|
|
|||
|
|
## 审核信息
|
|||
|
|
|
|||
|
|
- **审核人员**: 系统管理员
|
|||
|
|
- **审核日期**: 2026-01-10
|
|||
|
|
- **审核状态**: [通过]
|
|||
|
|
- **审核意见**: 同步配置管理实现符合设计要求，支持基于DataiConfiguration表的配置管理，提供了变更实时同步状态的方法，以及batch表检查功能，并集成了Salesforce Pub/Sub API，确保了实时同步的灵活性、可靠性和高性能。
|