SuperAPI AI 工具集

common-technical-practices

编程与开发

查看项目

更新于 10-16 09:35

技能介绍

用途:本技能面向 BK-CI 后端的横切技术实践,处理“给业务逻辑增加一层通用能力”这类框架级问题,而不是具体业务功能或单个工具类的使用。

主要能力:覆盖 AOP 切面、分布式锁、重试机制与退避策略、接口参数校验、性能监控埋点、定时任务、审计日志等主题。

使用方式:按主题进入对应参考文档——AOP 见 reference/1-aop-aspect.md,分布式锁见 reference/2-distributed-lock.md,重试见 reference/3-retry-mechanism.md,参数校验见 reference/4-parameter-validation.md,性能监控见 reference/5-performance-monitoring.md,定时任务见 reference/6-scheduled-tasks.md,审计日志见 reference/7-audit-logging.md。若需要现成组件用法,转 utility-components;若需要微服务基础能力搭建,转 microservice-infrastructure。

高信号规则:这类能力通常跨模块复用,与 Spring 及框架集成方式强相关;落地应优先考虑幂等性、可观测性与并发安全,不要把横切能力写死在单个业务类里。

限制与陷阱:不适用于仅使用某个具体工具类(如 JWT、表达式解析、线程池工具)、微服务间调用与事件驱动、多环境配置,或某个模块自身的业务规则。常见陷阱包括把工具类使用问题误放此处、只实现功能而不处理幂等/超时/并发/可观测性、重试锁与定时任务不先判断必要性、审计日志与监控埋点散落在业务代码中导致难维护。

其余运行细节、示例代码与配置方式暂未提供。