common-technical-practices

Standardizes backend engineering practices for Spring Boot ecosystems.

2.5k|521|Updated May 29, 2019
One-click install
npx skills add https://github.com/TencentBlueKing/bk-ci --skill common-technical-practices
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: common-technical-practices
Source: https://github.com/TencentBlueKing/bk-ci/tree/main/ai/skills/common-technical-practices
Command: npx skills add https://github.com/TencentBlueKing/bk-ci --skill common-technical-practices

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill consolidates core backend engineering practices (AOP, distributed locks, retry strategies, parameter validation, performance monitoring, scheduling, and auditing) into a single, reusable reference to improve code quality, consistency, and reliability across services.

Core Features & Use Cases

  • Cross-cutting concerns guidance: AOP aspects, distributed locking, retry logic, input validation, observability, scheduled tasks, and auditing.
  • Use cases: applying AOP for authorization checks, implementing Redis-based locks to prevent concurrent processing, adding retry and backoff for transient failures, validating inputs at the API layer, instrumenting metrics for performance, scheduling periodic tasks with safe concurrency, and recording auditable actions.

Quick Start

Refer to the reference docs under 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, and reference/7-audit-logging.md to implement best practices in your services.

Frequently Asked Questions about common-technical-practices

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I implement distributed locking in a Spring Boot microservices environment?

Use Redis-based distributed locks to prevent concurrent processing across your Spring Boot microservices. This standardizes cross-cutting locking practices, ensuring safe concurrency whether operating in microservices or monolithic architectures.

What is the best way to handle transient failures with retry policies in Spring Boot?

Apply exponential backoff retry mechanisms for transient failures in Spring Boot. This standardizes retry logic across services, improving reliability when handling intermittent network or resource issues without manual intervention.

How do I use AOP for cross-cutting concerns like authorization checks in Spring Boot?

Apply AOP aspects to handle cross-cutting concerns like authorization checks in your Spring Boot applications. This enforces consistent engineering practices by separating logic from business code using proper annotations.

Does this backend engineering practice guidance work for both monoliths and microservices?

Yes, these backend engineering practices apply to both microservices and monoliths. The guidance standardizes cross-cutting concerns like AOP, parameter validation, and performance monitoring across any Spring Boot ecosystem architecture.

How do I validate API parameters and record auditable events in Spring Boot?

Implement input validation at the API layer and record auditable actions using proper annotations. This ensures data integrity and tracks auditable events across your Spring Boot services for compliance and monitoring.

Why should I standardize performance monitoring and scheduled tasks across backend services?

Standardizing performance monitoring and scheduled tasks ensures consistent metrics instrumentation and safe concurrency. This improves overall code quality, reliability, and observability across your entire Spring Boot service ecosystem.

Related Skills