OA

oliveraaaaa/ai-coding-java-springboot-skills

Developer tools
26ย stars Quality 40 Trend 32

๐Ÿš€ AI-powered Spring Boot developer. Focus on complete project development with Java, Spring Boot, MyBatis-Plus & Redis. Blending vibe coding with AI tools to build production-ready applications.

Overview

 ๐Ÿ“–English  |  ๐Ÿ“–็ฎ€ไฝ“ไธญๆ–‡ A comprehensive, production-ready development standards library for Spring Boot backend projects. Designed as a skill reference for AI coding assistants (Claude Code, Cursor, Windsurf, Copilot, OpenCode) and development teams โ€” covering RESTful API design, layered architecture, database design, exception handling, logging, performance optimization, and security best practices. AI coding assistants generate better code when given clear, structured standards. This project provides that enforce consistent, maintainable, and secure Spring Boot code โ€” whether you're building microservices, RESTful APIs, or monolithic backends. Violations lead to serious maintainability and performance issues in production. Reference the standards directly in your prompts: Place this repo alongside your project in the same workspace: Create a rules file (e.g., .ai/project-rule.

README

Spring Boot Development Standards for AI Coding Assistants

A comprehensive, production-ready development standards library for Spring Boot backend projects. Designed as a skill reference for AI coding assistants (Claude Code, Cursor, Windsurf, Copilot, OpenCode) and development teams โ€” covering RESTful API design, layered architecture, database design, exception handling, logging, performance optimization, and security best practices.

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

View this README on GitHub

Recommended Tools

Try a different keyword or remove a filter.

Install

npx skillfish add oliveraaaaa/ai-coding-java-springboot-skills