ai-coding-java-springboot-skills

Spring Boot Development Standards for AI Coding Assistants

Why Use This?

AI coding assistants generate better code when given clear, structured standards. This project provides 7 battle-tested skill modules that enforce consistent, maintainable, and secure Spring Boot code — whether you're building microservices, RESTful APIs, or monolithic backends.

These are not suggestions — they are baseline requirements. Violations lead to serious maintainability and performance issues in production.

Tech Stack

Technology	Version	Purpose
Java	17+	Language runtime
Spring Boot	3.x	Application framework
MyBatis Plus	3.5.x	ORM / Data access
Redis	6.0+	Caching layer

Skill Modules

Module	When to Use	Key Standards
API Standards	Writing Controllers, designing endpoints	RESTful URLs, unified response format, pagination, DTO/VO patterns
Coding Conventions	Writing business logic, DI, transactions	Layered architecture, @Resource injection, naming conventions
Database Design	Creating tables, writing SQL, MyBatis mappers	Table design, entity standards, index design, batch operations
Exception Handling	Error handling, error code design	Exception hierarchy, global handler, service-layer strategies
Logging & Monitoring	Log output, tracing, metrics	Log levels, structured logging, sensitive data masking
Performance	Query optimization, caching, high concurrency	N+1 prevention, cursor pagination, cache protection
Security	Auth, user input, sensitive data	SQL injection prevention, XSS, BCrypt passwords, JWT security

How to Use with AI Coding Tools

Claude Code

Reference the standards directly in your prompts:

Implement the user management module for this Spring Boot project.
Strictly follow ai-coding-java-springboot-skills/skill.md:
- Layering: Controller -> BizManageService -> Service -> Mapper
- Use @Resource injection
- Return unified ApiResponse

OpenCode

Place this repo alongside your project in the same workspace:

You are writing code for a Spring Boot backend project.
Follow the standards in ai-coding-java-springboot-skills/skill.md.

Cursor / Windsurf / Continue / Cline

Create a rules file (e.g., .ai/project-rule.md) in your project root:

This project must follow these development standards:
../ai-coding-java-springboot-skills/skill.md

Task-Based Skill Selection

Load only what you need for the current task:

Task	Skill Module
Writing Controllers / APIs	api-standards
Writing business logic	coding-conventions
Designing tables / SQL	db-design
Handling exceptions	exception-handling
Optimizing performance	performance
Security controls	security-standards
Logging & monitoring	logging-monitoring

Project Structure

ai-coding-java-springboot-skills/
├── skill.md                              # Skill collection overview (entry point)
├── README.md                             # This file (English)
├── docs/
│   └── README_zh.md                      # 中文文档
├── spec/
│   └── springboot-development-spec.md    # Complete development specification
└── references/                           # Detailed technical documentation
    ├── springboot-api-standards.md       # REST API design & documentation
    ├── springboot-coding-conventions.md  # Coding standards & layered architecture
    ├── springboot-db-design.md           # Database design & MyBatis Mapper
    ├── springboot-exception-handling.md  # Exception handling & error codes
    ├── springboot-logging-monitoring.md  # Logging & monitoring standards
    ├── springboot-performance.md         # Performance optimization
    └── springboot-security-standards.md  # Security best practices

Applicable Scenarios

• Spring Boot + MyBatis Plus + Redis projects
• Java 17+ backend applications
• RESTful API design
• Microservice architectures

Star History

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

contact me

License

This project is licensed under the MIT License.

---

Version: 1.0.0