5.9 KiB
5.9 KiB
Server模块Service缓存调整为Vo对象共识文档
1. 明确的需求描述
1.1 基础需求
将server模块中所有注解了@CacheConfig的Service类实现的IEntityService接口的泛型参数从实体类类型修改为对应的VO类类型，并同步修改这些Service类中实现的IEntityService接口的所有方法的参数和返回类型。
1.2 扩展需求
使用VO替代实体类进行缓存，避免Hibernate代理对象在Redis序列化过程中可能导致的懒加载异常问题。
1.3 需求目标
通过将IEntityService接口的泛型从实体类改为VO类，实现接口层与数据访问层的更好解耦，并提高系统的可维护性。同时，通过使用VO对象作为缓存值，彻底解决Redis缓存中的代理对象序列化问题。
2. 验收标准
- 功能完整性: 修改后的Service类能够正确实现IEntityService接口的所有方法
- 类型一致性: 所有方法的参数和返回类型与新的泛型参数一致
- 缓存功能: 缓存配置和注解在修改后仍然有效
- 数据转换: 正确处理实体类和VO类之间的数据转换
- 系统兼容性: 修改后不影响系统的其他功能模块
- 编译通过: 修改后的代码能够成功编译，无编译错误
3. 技术实现方案
3.1 泛型修改方案
对于每个注解了@CacheConfig的Service类：
-
修改接口声明:
- Service类继承IEntityService接口，泛型类型保持为Model（实体类）
- Service类继承QueryService接口，泛型类型修改为Vo（视图对象）
-
修改方法签名: 同步修改所有实现的接口方法的参数和返回类型
- findById(Integer id): 根据接口不同返回不同类型（IEntityService返回Model，QueryService返回Vo）
- findAll: 根据接口不同参数和返回类型不同
- save: 根据接口不同参数和返回类型不同
3.2 数据转换策略
-
实体到VO的转换:
- 为每个Service类添加实体类到VO类的转换方法
- 在findById、findAll等返回VO的方法中，使用转换方法将查询到的实体对象转换为VO对象
-
VO到实体的转换:
- 在save、delete等接收VO参数的方法中，先将VO对象转换为实体对象，再调用Repository进行操作
- 利用现有的VoableService接口提供的updateByVo方法进行属性映射
3.3 缓存注解处理
- 假设VO类与实体类具有相同的属性结构（如id、code等），因此缓存注解中的键表达式（如@CacheEvict(key = "#p0.id")）可能不需要修改。如果VO类结构不同，需要相应调整缓存键表达式。
- 确保所有标注@Cacheable的方法都返回VO对象，并在存储前完成从实体类到VO的转换，以避免代理对象序列化问题
- 清除Redis中现有的实体类缓存数据，确保新的缓存数据都是VO对象
3.4 Specification处理
由于Specification是基于JPA实体类的查询规范，需要特别处理getSpecification方法：
- 如果VO类与实体类结构相似，可以保留原有的Specification实现，但需要修改泛型类型
- 如果需要基于VO类属性构建查询，可能需要创建新的转换逻辑
4. 技术约束
- 保持接口兼容性: 不修改IEntityService接口的定义，只修改实现类
- 数据一致性: 确保实体类和VO类之间的数据转换不会导致数据丢失或不一致
- 事务边界: 确保修改不会破坏原有的事务处理逻辑
- 性能影响: 考虑数据转换可能带来的性能影响，必要时进行优化
- 序列化约束: 确保VO类是可序列化的（实现Serializable接口），避免在VO类中包含不可序列化的引用，确保Redis缓存的序列化和反序列化性能
- WebSocket服务兼容性: 确保修改后的IEntityService接口能够与WebSocketServerCallbackManager类兼容，特别是createNewEntity、findEntityTypeInInterfaces等方法
- 类型推断机制: 确保WebSocketServerCallbackManager中的类型推断机制能够正确处理从实体类到VO类的泛型变化
5. 集成方案
- 阶段性修改: 可以按模块或按功能进行阶段性修改，降低风险
- 依赖更新: 同步更新所有调用修改后Service的组件，确保它们使用新的接口定义
- 测试策略: 对修改后的Service类进行单元测试和集成测试，验证功能正确性
- WebSocket服务适配: 在实施修改时，需要特别关注WebSocketServerCallbackManager类中的方法实现，确保其能够正确处理从实体类到VO类的泛型变化
- 测试createNewEntity、findEntityTypeInInterfaces等方法在新泛型参数下的行为
- 确保invokerFindByIdMethod、invokerFindAllMethod等方法能够正确处理VO类型的返回值
- 任务管理验证: 验证WebSocketServerTaskManager类中的任务处理逻辑在接口泛型修改后是否正常工作，特别是涉及到数据转换的部分
6. 任务边界限制
- 范围限制: 仅修改server模块中注解了@CacheConfig的Service类
- 接口限制: 不修改IEntityService和VoableService接口的定义
- 不涉及功能: 不添加新功能，仅修改现有功能的实现方式
7. 关键假设确认
- VO类结构: 假设VO类与对应的实体类具有相似的属性结构，特别是缓存键中使用的属性
- 转换机制: 假设系统中存在或可以添加实体类与VO类之间的转换机制
- 依赖影响: 假设修改Service接口不会导致不可预见的依赖问题
8. 项目特性规范对齐
- 代码规范: 遵循项目现有的Java编码规范和命名约定
- 文档规范: 按照6A工作流创建相应的文档
- 测试规范: 为修改后的代码编写测试用例，确保功能正确
- 版本控制: 所有修改通过版本控制系统管理，便于回溯
以上共识内容已经明确了任务的需求、验收标准、技术实现方案和约束条件，为后续的架构设计和实现阶段提供了清晰的指导。