云原生中台缓存一致性代码审查规范

云原生中台缓存一致性代码审查规范一、总则（一）目的规范。为保障云原生中台缓存一致性，提升系统稳定性与性能，特制定本规范。（一）适用范围。本规范适用于云原生中台所有涉及缓存操作的代码，包括但不限于缓存设计、实现、使用及维护等环节。（二）基本原则。1.一致性原则。确保缓存数据与源数据同步，避免数据不一致问题。2.高可用原则。缓存系统应具备高可用性，支持故障自动切换。3.高性能原则。缓存读写操作应具备低延迟、高吞吐特性。4.安全性原则。防止缓存数据泄露、篡改等安全风险。二、缓存设计规范（一）缓存策略选择。1.根据业务场景选择合适的缓存策略，如LRU、LFU等。2.高频访问数据优先缓存，低频访问数据可考虑不缓存。3.缓存粒度应合理，避免缓存穿透、缓存雪崩问题。（二）缓存失效策略。1.设置合理的过期时间，避免数据过时。2.支持主动失效与被动失效两种模式。3.失效时需考虑对下游系统的影响，避免级联失效。（三）缓存同步机制。1.采用发布/订阅模式同步缓存数据。2.支持异步更新与同步更新两种方式。3.同步更新时需保证数据一致性，避免脏读。三、代码实现规范（一）缓存接口设计。1.接口命名应清晰、简洁，如GetCache、SetCache等。2.接口参数应完整，包括缓存键、值、过期时间等。3.接口返回值应明确，如成功、失败、缓存命中等。（二）缓存操作规范。1.缓存读写操作必须加锁，避免并发问题。2.缓存更新时需先删除旧数据，再写入新数据。3.缓存读取时需判断缓存是否存在，不存在时需从数据库读取。（三）异常处理规范。1.缓存操作异常时需记录日志，并向上抛出异常。2.异常处理应区分缓存异常与业务异常，分别处理。3.缓存异常时需考虑重试机制，避免因临时问题导致系统崩溃。四、缓存使用规范（一）缓存穿透防御。1.对查询参数进行校验，避免恶意查询。2.缓存空值时设置较短的过期时间。3.采用布隆过滤器判断数据是否存在，避免查询数据库。（二）缓存雪崩防御。1.设置合理的过期时间，避免大量缓存同时过期。2.采用随机过期时间，分散过期压力。3.缓存集群应具备水平扩展能力，支持动态扩容。（三）缓存击穿防御。1.对热点数据设置永不过期。2.采用互斥锁避免缓存击穿。3.缓存热点数据时需加锁，避免并发更新。五、代码审查要点（一）缓存设计审查。1.审查缓存策略是否合理，是否满足业务需求。2.审查缓存失效策略是否合理，是否会导致数据不一致。3.审查缓存同步机制是否有效，是否支持高并发场景。（二）代码实现审查。1.审查缓存接口设计是否规范，是否易于使用。2.审查缓存操作是否加锁，避免并发问题。3.审查异常处理是否完善，是否记录日志。（三）缓存使用审查。1.审查缓存穿透防御措施是否到位。2.审查缓存雪崩防御措施是否有效。3.审查缓存击穿防御措施是否合理。六、测试与运维规范（一）缓存测试规范。1.编写单元测试，验证缓存接口功能。2.编写集成测试，验证缓存同步机制。3.编写压力测试，验证缓存性能。（二）缓存运维规范。1.定期监控缓存性能，如命中率、延迟等指标。2.定期清理缓存，避免内存溢出。3.定期备份缓存数据，防止数据丢失。（三）故障处理规范。1.缓存故障时需快速定位问题，并恢复服务。2.缓存故障时需通知相关人员进行处理。3.缓存故障后需进行复盘，避免类似问题再次发生。七、附则（一）本规范自发布之日起实施，由技术部负责解释与修订。1.各部门应组织学习本规范，确保相关人员掌握规范内容。2.代码审查时需严格执行本规范，确保代码质量。3.对违反本规范的行为，将进行通报批评，并追究相关责任。（二）本规范将根据实际情况进行修订，修订后的规范将另行发布。1.各部门应关注本规范修订动态，及时更新相关文档。2.本规范修订时需征求各部门意见，确保修订内容合理。3.本规范修订后需组织培训，确保相关人员掌握修订内容。（三）本规范最终解释权归技术部所有，如有疑问请联系技