mcpField
C
common-technical-practices

common-technical-practices

github.com/tencentbluekingDevelopment2.5k47 installsUpdated 2d ago
Repository

About common-technical-practices

A skill for framework-level cross-cutting practices, covering AOP, distributed locks, retries, parameter validation, performance monitoring, scheduled tasks, and audit logging. It is for developers adding reusable capabilities across business modules, not for specific utility components or business rules.

Key features

  1. 01AOP aspect practices
  2. 02Distributed locks and concurrency control
  3. 03Retries and backoff strategies
  4. 04API parameter validation
  5. 05Performance monitoring and audit logs
  6. 06Scheduled task practices

Use cases

  1. 01Add shared cross-cutting capabilities to modules
  2. 02Configure concurrency locks and retry behavior
  3. 03Add parameter validation to APIs
  4. 04Introduce performance monitoring or audit records

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/tencentblueking/bk-ci --skill common-technical-practices

After installing, type/common-technical-practicesin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

reference/
1-aop-aspect.md
2-distributed-lock.md
3-retry-mechanism.md
4-parameter-validation.md
5-performance-monitoring.md
6-scheduled-tasks.md
7-audit-logging.md

Details

From the project README

通用技术实践

适用场景

  • 添加 AOP 切面
  • 使用分布式锁控制并发
  • 配置重试机制与退避策略
  • 做接口参数校验
  • 添加性能监控埋点
  • 编写定时任务
  • 记录审计日志

不适用场景

  • 只是使用某个具体工具类，例如 JWT、表达式解析、线程池工具
  • 只是微服务之间的调用、事件驱动或多环境配置
  • 只是某个模块自己的业务规则

快速指导

  1. 这个 skill 关注的是“框架级横切实践”，不是具体业务模块。
  2. 如果问题更像“给业务逻辑增加一层通用能力”，通常落在这里。
  3. 先按主题进入对应参考文档：
    • 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
  4. 如果你要的是“某个现成组件怎么用”，切到 utility-components；如果你要的是“微服务基础能力怎么搭”，切到 microservice-infrastructure。

高信号规则

  • AOP、锁、重试、监控、审计这类能力通常跨多个模块复用
  • 这类实践往往和 Spring / 框架集成方式强相关
  • 落地时要优先考虑幂等性、可观测性和并发安全
  • 不要把横切能力写死在单个业务类里

关键陷阱

  • 把工具类使用问题误放到这里
  • 只实现功能，不处理幂等、超时、并发和可观测性
  • 重试、锁、定时任务直接上，而不先判断是否真的需要
  • 把审计日志、监控埋点散落在业务代码里，后续难以维护

延伸阅读

  • 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

Comments

Markdown supported