复制安装命令
用 Codex 或 Claude 安装复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它先审查 Skill 页面再帮你安装。
复制前请先查看来源、License 和安全提示。
Production-grade Spring Boot skills for Claude Code and Codex.
用 Codex 或 Claude 安装复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它先审查 Skill 页面再帮你安装。
复制前请先查看来源、License 和安全提示。
来源文件:README.md
Production-grade Spring Boot skills for Claude Code and Codex. Drop a skill into your project and your AI coding agent instantly understands your architecture, patterns, and conventions.
Quick Start · Skills Catalog · Before / After · Skill Anatomy · Contributing
AI coding agents are great at Python. They hallucinate in Spring Boot.
They generate @Autowired field injection instead of constructor injection. They use ResponseEntity<?> where you have a standard response wrapper. They ignore your existing exception hierarchy and invent a new one. They don't know your project uses Flyway, so they generate schema SQL by hand. They emit pre-GA Spring AI artifact names that no longer exist in Maven Central.
Skills fix this. A skill is a markdown file your agent reads before touching your code. It tells the agent your conventions, your stack, your gotchas — not generic Spring Boot from 2020.
flowchart LR
A["💬 You ask:<br/>"add an orders endpoint""] --> B{Agent matches<br/>skill triggers}
B -->|"REST code?"| C["📜 rest-api-conventions"]
B -->|"persistence?"| D["📜 spring-data-jpa"]
C --> E["🤖 Agent codes with<br/>YOUR envelope, YOUR<br/>status mapping, YOUR<br/>pagination contract"]
D --> E
E --> F["✅ Code that looks like<br/>your team wrote it"]
style A fill:#0f172a,stroke:#38bdf8,color:#e2e8f0
style B fill:#1e293b,stroke:#94a3b8,color:#e2e8f0
style C fill:#10241a,stroke:#6DB33F,color:#a7f3d0
style D fill:#10241a,stroke:#6DB33F,color:#a7f3d0
style E fill:#0f172a,stroke:#d97757,color:#e2e8f0
style F fill:#10241a,stroke:#6DB33F,color:#a7f3d0
This repo is a collection of battle-tested skills. Copy, adapt, drop in.
| Concept | Description |
|---|---|
| Skills | Markdown files loaded into Claude Code or Codex context — tell the agent how to work in your codebase |
| CLAUDE.md / AGENTS.md | Project-level persistent memory — your agent's onboarding doc |
| MCP Java SDK | Official Java SDK for building MCP servers — connect your Spring Boot app to any AI agent |
| Marketplace plugins | Versioned Claude Code and Codex packages for all Boot 3 or Boot 4 skills |
| Project templates | Ready-to-adapt CLAUDE.md and AGENTS.md guidance for Boot 3 and Boot 4 projects |
| Planned workflows | Repeatable commands such as /generate-endpoint, /write-test, and /db-migrate are listed in the roadmap |
The catalog ships in two version trees — pick the folder that matches your stack. Shared topics normally have both flavors; genuinely version-specific topics may live only in the relevant tree.
| Folder | Target stack | Compatibility baseline |
|---|---|---|
skills/spring-boot-4/ | Spring Boot 4.x · Spring Framework 7 · Spring Security 7 · Spring Batch 6 · Jackson 3 · Spring AI 2.0 | Java 17+; examples use Java 21; Boot 4.0.x and 4.1.x |
skills/spring-boot-3/ | Spring Boot 3.x · Spring Framework 6 · Spring Security 6 · Spring Batch 5 · Jackson 2 · Spring AI 1.x | Java 17+; examples use Java 21 |
Drop any skill folder into your agent's skills directory. Claude Code users can copy them to .claude/skills/; Codex users can adapt the same SKILL.md folders for .codex/skills/.
The catalog below links to the Spring Boot 4 versions — swap spring-boot-4 for spring-boot-3 in any path if you're still on Boot 3.
The version guidance follows the Spring Boot 4 system requirements, the Spring Boot 4 migration guide, and Spring AI's compatibility guidance. Check the official release notes before upgrading a project.
Fast-moving integrations were last verified in August 2026 against Spring Boot 4.1, Spring AI 2.0, MCP Java SDK 2.0, Spring Cloud 2025.1, and Spring Cloud Gateway 5.0. Keep BOM-managed dependency versions together and recheck the linked official sources before adopting a newer release line.
| Skill | Description | Tags |
|---|---|---|
| configuration-properties | Typed binding, startup validation, duration units and secret handling. | configuration validation |
| Skill | Description | Tags |
|---|---|---|
| layered-architecture | Enforces Controller → Service → Repository separation. Prevents business logic leaking into controllers or repositories. | architecture |
| hexagonal-architecture | Ports and adapters pattern for Spring Boot. Keeps domain clean of framework dependencies. | architecture ddd |
| domain-driven-design | Aggregates, value objects, domain events with commit-safe publication. Includes JPA mapping conventions. | ddd jpa |
| multi-module-maven | Parent POM conventions, shared BOM, inter-module dependency rules. Prevents circular deps. | maven architecture |
| spring-modulith | Module boundaries, verification and durable event publication. | architecture modulith |
| multi-tenancy | Tenant resolution, database/schema isolation, tenant-aware persistence, caches, jobs, and migrations. | architecture security data |
| Skill | Description | Tags |
|---|---|---|
| rest-api-conventions | Your project's response envelope, error codes, pagination contract, versioning strategy. Fill in the template. | rest api |
| openapi-first | Generate controllers and DTOs from OpenAPI spec. Uses openapi-generator-maven-plugin. | openapi codegen |
| problem-details-rfc9457 | RFC 9457 compliant error responses with Spring's ProblemDetail. Replaces ad-hoc error envelopes. | error-handling rest |
| idempotency-patterns | Concurrent retries, scoped request keys, replay and transaction boundaries. | api transactions |
| hateoas | Spring HATEOAS link building conventions. Teaches agent when and how to add hypermedia links. | hateoas rest |
| Skill | Description | Tags |
|---|---|---|
| spring-cloud-gateway | Secure route design, header hygiene, timeouts, rate limits, retries, and release-train compatibility. | gateway spring-cloud security |
| webflux-reactive-patterns | Non-blocking WebFlux, Reactor context, R2DBC, backpressure, cancellation, and reactive tests. | webflux reactor r2dbc |
| Skill | Description | Tags |
|---|---|---|
| spring-data-jpa | Boot 4 JPA with Hibernate 7: entity modeling, Jakarta imports, relationships, projections, N+1 prevention, keyset pagination, and batch writes. | jpa hibernate |
| flyway-migrations | Migration naming convention, safe multi-step schema changes, team workflow for concurrent migrations. | flyway migrations |
| spring-data-redis | Cache-aside pattern, key naming, TTL strategy, stampede protection, serialization config. | redis caching |
| transactional-patterns | @Transactional propagation rules, self-invocation pitfall, after-commit side effects, saga pattern. | transactions |
| Skill | Description | Tags |
|---|---|---|
| event-driven-messaging | Kafka/RabbitMQ/Pulsar/JMS contracts, idempotent consumers, outbox delivery, retries, and dead letters. | messaging kafka rabbitmq |
| Skill | Description | Tags |
|---|---|---|
| spring-batch | Spring Batch 6 chunk jobs, JDBC versus resourceless repositories, JobOperator, restartability, reader sort/thread-safety, and transaction boundaries. | batch etl |
| Skill | Description | Tags |
|---|---|---|
| spring-boot-migration | Staged Boot 3.5 → 4 migration covering modular starters, Jackson 3, tests, servers, and verification. | migration spring-boot-4 |
| container-native-deployment | Buildpacks, layered OCI images, JVM containers, GraalVM native images, AOT hints, and probes. | containers graalvm aot |
| Skill | Description | Tags |
|---|---|---|
| api-versioning | Spring Framework 7 built-in API versioning: mapping versions, central request resolution, defaults, supported versions, and deprecation headers. | rest api versioning |
| http-interface-clients | Boot 4 declarative HTTP clients with @ImportHttpServices, grouped base URLs/timeouts, and RestClient versus WebClient selection. | http clients |
| null-safety | JSpecify nullability for Framework 7: @NullMarked, @Nullable, generic and array positions, Kotlin interop, and NullAway. | null-safety jspecify |
| resilience-retry | Framework 7 core @Retryable and @ConcurrencyLimit: enablement, backoff, no @Recover, proxy, and transaction pitfalls. | resilience retry |
| Skill | Description | Tags |
|---|---|---|
| spring-security-jwt | JWT auth filter chain, access and refresh token validation, RBAC with method security. Opinionated starting point. | security jwt |
| oauth2-resource-server | OAuth2 resource server config, JWT claim extraction, scope-based authorization. | security oauth2 |
| Skill | Description | Tags |
|---|---|---|
| spring-ai-integration | Spring AI ChatClient, chat memory, RAG pipeline, structured output. Real GA artifact names — no dead pre-GA coordinates. | spring-ai llm |
| mcp-server | Build MCP servers with the Java SDK 2.x and Spring AI 2.0 native annotations. Tool registration, Streamable HTTP, and stdio safety. | mcp ai-agents |
| ai-observability | Token usage tracking, latency monitoring, prompt/response logging for Spring AI apps. | observability spring-ai |
| Skill | Description | Tags |
|---|---|---|
| production-observability | Actuator, Micrometer, OpenTelemetry/OTLP, health probes, structured logging, and actionable alerts. | actuator micrometer opentelemetry |
| Skill | Description | Tags |
|---|---|---|
| testing-pyramid | Unit → Slice → Integration conventions. @WebMvcTest, @DataJpaTest, @MockitoBean, Testcontainers. | testing |
1. Prepare your coding agent
Install Claude Code if needed:
npm install -g @anthropic-ai/claude-code
If you use Codex, confirm the CLI or desktop app command is available:
codex --version
2. Drop a skill into your project
Claude Code:
PROJECT_DIR=/path/to/my-spring-app
mkdir -p "$PROJECT_DIR/.claude/skills"
# Spring Boot 4 project
cp -r skills/spring-boot-4/rest-api-conventions "$PROJECT_DIR/.claude/skills/"
cp -r skills/spring-boot-4/spring-data-jpa "$PROJECT_DIR/.claude/skills/"
# Spring Boot 3 project — same skills, Boot 3 flavor
cp -r skills/spring-boot-3/rest-api-conventions "$PROJECT_DIR/.claude/skills/"
Codex:
PROJECT_DIR=/path/to/my-spring-app
mkdir -p "$PROJECT_DIR/.codex/skills"
# Spring Boot 4 project
cp -r skills/spring-boot-4/rest-api-conventions "$PROJECT_DIR/.codex/skills/"
cp -r skills/spring-boot-4/spring-data-jpa "$PROJECT_DIR/.codex/skills/"
# Spring Boot 3 project — same skills, Boot 3 flavor
cp -r skills/spring-boot-3/rest-api-conventions "$PROJECT_DIR/.codex/skills/"
Run these commands from the root of this repository, or replace skills/ with the path to your
local clone.
For persistent project guidance, start from the matching templates:
# Codex, Spring Boot 4
cp templates/spring-boot-4/AGENTS.md "$PROJECT_DIR/AGENTS.md"
# Claude Code, Spring Boot 4
cp templates/spring-boot-4/CLAUDE.md "$PROJECT_DIR/CLAUDE.md"
Boot 3 equivalents live under templates/spring-boot-3/. Adapt commands and conventions to the
project rather than using the templates unchanged.
This repository also exposes two marketplace plugins without duplicating the skill files:
claude plugin marketplace add rrezartprebreza/spring-boot-skills
claude plugin install spring-boot-4-skills@spring-boot-skills
# or for a Boot 3 project:
claude plugin install spring-boot-3-skills@spring-boot-skills
The marketplace manifest is .claude-plugin/marketplace.json.
Validate it locally with claude plugin validate .. The repository can be submitted to Anthropic's
Claude Code community marketplace; approval is a
separate review step. GitHub Marketplace is intended for GitHub Apps and Actions, so this skills
repository should use GitHub releases and the Claude marketplace instead.
Codex uses its own plugin manifest and marketplace catalog. Add this repository and install the version that matches your application:
codex plugin marketplace add rrezartprebreza/spring-boot-skills
codex plugin add spring-boot-4-skills@spring-boot-skills
# or for a Boot 3 project:
codex plugin add spring-boot-3-skills@spring-boot-skills
The Codex package metadata lives in .agents/plugins/marketplace.json
and the two plugin manifests under plugins/. Direct copying into .codex/skills/
remains supported for projects that do not use plugins.
3. Tell your agent what you want
claude
> Generate a CRUD endpoint for the Order entity following our REST conventions
or:
codex
> Generate a CRUD endpoint for the Order entity following our REST conventions
That's it. Your agent reads the skill before writing a single line.
The value of these skills is not generic Spring Boot advice. The value is preventing the small mistakes AI agents make when they do not know your backend conventions.
| ❌ Without a skill | ✅ With layered-architecture + rest-api-conventions |
|---|---|
|
|
|
|
Every skill in this repo follows the same structure:
skills/spring-boot-4/rest-api-conventions/
├── SKILL.md ← the skill: trigger description + conventions + gotchas
├── agents/
│ └── openai.yaml ← Codex skill-list metadata and default prompt
├── examples/ ← good and bad examples, side by side
│ ├── good-controller.java
│ └── bad-controller.java
└── templates/ ← copy-paste starting points
├── ApiResponse.java
└── GlobalExceptionHandler.java
SKILL.md has two critical parts:
---
name: rest-api-conventions
description: >
Use when generating REST controllers, response objects, DTOs, or error handlers.
Defines the project's response envelope, HTTP status mapping, and error code conventions.
---
## Conventions
...
The description is a trigger — write it as "use when [condition]", not as a summary. This is what makes the agent actually load the skill.
The Gotchas section at the bottom of each skill is the secret weapon: a running list of the exact mistakes agents make in that domain, phrased as Agent does X — do Y instead.
The Gotchas section is the most valuable part — add to it every time the agent does something wrong. Your future self will thank you.
Don't describe what Spring Boot already knows. Skills should push your agent out of its default behavior, not repeat the docs.
Be opinionated about your project. Generic Spring Boot best practices belong in a blog post. Skills belong in your agent skills folder.
Fork this repo and customize. Every team's conventions are different. These are starting points, not gospel.
Combine with CLAUDE.md or AGENTS.md. Project guidance stores build commands, verification, and architecture decisions. Skills provide reusable domain-specific workflows.
| Anti-pattern | Fix |
|---|---|
| Giant SKILL.md with everything | Split into focused skills, one concern each |
| "Always use constructor injection" | Already a strong agent default — skip it |
| No examples | Add a good.java and bad.java — the contrast is what teaches |
| Prescriptive step-by-step instructions | Give goals and constraints, let agent decide how |
| Never updating | Add a Gotchas section, update it when agent fails |
The mcp-server skill is the most powerful one here.
It teaches your agent to build production-ready MCP servers on MCP Java SDK 2.x and the Spring AI 2.0 starters - the same protocol used by Claude, Codex, Cursor, VS Code, and other major AI coding tools.
The MCP skill distinguishes native MCP annotations such as @McpTool from Spring AI model
tool-calling annotations such as @Tool. Use the native MCP path when exposing server tools.
// What the agent generates with the skill loaded —
// real GA API: spring-ai-starter-mcp-server + annotation scanning
@Component
public class OrderMcpTools {
private final OrderService orderService;
@McpTool(name = "get_order",
description = "Get a single order by ID including all line items and status history")
public OrderResponse getOrder(
@McpToolParam(description = "UUID of the order", required = true) String orderId) {
return OrderResponse.from(orderService.findById(UUID.fromString(orderId)));
}
}
Without the skill, the agent guesses: dead pre-GA artifact names, removed SDK constructors,
@Tool instead of native @McpTool, or System.out logging that corrupts stdio transport.
skills/spring-boot-4/)/generate-endpoint command/write-test command/db-migrate commandSkills get better with real-world use. If you find a gap — the agent did something stupid in your Spring Boot project — open a PR and add it to the Gotchas section of the relevant skill.
Before opening a PR, install the validator dependency in a virtual environment and run:
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r scripts/requirements.txt
bash scripts/validate-skills.sh
The validator parses YAML safely, rejects duplicate keys, and checks both version trees, metadata, README links and marketplace packaging. There are 33 topics with Boot 3 and Boot 4 variants.
The behavior fixture compiles the shipped JWT, Problem Details, pagination and configuration templates. Its tests cover token/account rejection, HTTP error contracts, configuration startup validation, and JPA/Flyway against PostgreSQL. CI runs Boot 3.5 and Boot 4.1 with Java 17 and 21. The MCP compilation fixture remains separate. This is targeted coverage, not a claim that every example in the catalog has executable tests.
Agent evaluations provide repeatable prompts and review criteria for Claude Code and Codex. Transcript collection and human review are separate from CI validation; a successful model invocation is not a benchmark pass.
1. Fork the repo
2. Copy an existing skill as a template
3. Fill in conventions, examples, gotchas
4. PR with a one-line description of what problem it solves
| Repo | Description |
|---|---|
| Hatch | Multi-module background job library for Spring Boot — REST polling, retry, Redis/JDBC backends, SSE dashboard |
| SpringPulse | Runtime observability for @Scheduled methods — AOP interception, WebSocket dashboard |
| rest-api-generator | CLI that scaffolds Spring Boot REST APIs from plain English prompts |
If a skill saved your agent from writing @Autowired field injection today — ⭐ star the repo.
spring-boot · java · claude-code · codex · mcp · spring-ai · skills · developer-tools
Built by @rrezartprebreza · Pristina, Kosovo
name: transactional-patterns
description: >
Use when working with @Transactional, multi-step database operations, distributed
transactions, or any code that needs atomicity guarantees. Covers propagation rules,
isolation levels, read-only optimization, and common pitfalls.@Transactional belongs on service methods, never controllers or repositoriesREQUIRED — joins existing transaction or creates one@Transactional(readOnly = true) on all read-only service methods — enables optimizations@Service
@RequiredArgsConstructor
@Transactional(readOnly = true) // default for all methods in this service
public class OrderService {
@Transactional // overrides readOnly for writes
public Order createOrder(CreateOrderRequest request) {
inventoryService.reserve(request.items()); // participates in same TX
return orderRepository.save(Order.from(request));
}
public Optional<Order> findById(UUID id) {
return orderRepository.findById(id); // readOnly = true inherited
}
}
| Propagation | Behavior |
|---|---|
REQUIRED (default) | Join existing TX or create new |
REQUIRES_NEW | Always create new TX, suspend existing |
SUPPORTS | Join if exists, proceed without TX if not |
NOT_SUPPORTED | Always run without TX |
MANDATORY | Must have existing TX, throw if not |
NEVER | Must NOT have TX, throw if one exists |
// REQUIRES_NEW — for audit logging that must survive rollback
@Transactional(propagation = Propagation.REQUIRES_NEW)
public void logAuditEvent(AuditEvent event) {
auditRepository.save(event); // commits independently of parent TX
}
// Order TX rolls back, audit log still saved
@Transactional
public void processOrder(Order order) {
auditService.logAuditEvent(new AuditEvent("ORDER_START", order.getId()));
try {
// ... process, may throw
} catch (Exception e) {
auditService.logAuditEvent(new AuditEvent("ORDER_FAILED", order.getId()));
throw e; // parent TX rolls back, audit TX already committed
}
}
// ❌ BROKEN — self-invocation bypasses Spring proxy, @Transactional ignored
@Service
public class OrderService {
@Transactional
public void processAll(List<UUID> ids) {
ids.forEach(id -> this.processSingle(id)); // bypasses proxy!
}
@Transactional(propagation = Propagation.REQUIRES_NEW)
public void processSingle(UUID id) { ... } // never creates new TX
}
// ✅ FIX — inject self or extract to separate bean
@Service
@RequiredArgsConstructor
public class OrderService {
private final OrderProcessor orderProcessor; // separate bean
@Transactional
public void processAll(List<UUID> ids) {
ids.forEach(id -> orderProcessor.processSingle(id)); // goes through proxy
}
}
// @Transactional rolls back on RuntimeException by default
// For checked exceptions, explicitly declare rollbackFor
@Transactional(rollbackFor = InsufficientInventoryException.class) // checked exception
public Order createOrder(CreateOrderRequest request) throws InsufficientInventoryException {
...
}
// noRollbackFor — for non-fatal exceptions you want to commit anyway
@Transactional(noRollbackFor = OptimisticLockException.class)
public void updateWithRetry(UUID id) { ... }
@Entity
public class Order {
@Version
private Long version; // Hibernate handles conflicts automatically
}
// Handles concurrent updates
@Transactional
public Order updateStatus(UUID id, OrderStatus newStatus) {
Order order = orderRepository.findById(id).orElseThrow();
order.updateStatus(newStatus); // if another TX modified it, throws ObjectOptimisticLockingFailureException
return orderRepository.save(order);
}
Retry support ships in core Spring Framework (org.springframework.resilience.annotation) — no
Spring Retry dependency. Enable once with @EnableResilientMethods, then retry transient failures
such as optimistic-lock conflicts:
@Configuration
@EnableResilientMethods
public class ResilienceConfig {}
@Service
@RequiredArgsConstructor
public class OrderStatusFacade {
private final OrderService orderService; // separate bean — retry must wrap the TX
@Retryable(includes = ObjectOptimisticLockingFailureException.class,
maxRetries = 3, delay = 50, jitter = 25)
public Order updateStatus(UUID id, OrderStatus newStatus) {
return orderService.updateStatus(id, newStatus); // fresh @Transactional per attempt
}
}
Put @Retryable on a method that calls the @Transactional method on another bean — each attempt
needs a fresh transaction. Retrying inside the failed transaction re-runs code in a TX already marked
rollback-only. For hot write paths, @ConcurrencyLimit(10) (same package) caps concurrent invocations
instead of letting contention turn into retry storms.
For multi-service operations, use the Saga pattern instead of distributed TX:
@Service
@RequiredArgsConstructor
public class OrderSaga {
@Transactional
public void execute(CreateOrderRequest request) {
Order order = orderRepository.save(Order.create(request));
try {
inventoryClient.reserve(request.items()); // step 1
paymentClient.charge(order.getId(), request.total()); // step 2
order.confirm();
orderRepository.save(order);
} catch (PaymentException e) {
inventoryClient.release(request.items()); // compensate step 1
order.fail("Payment failed");
orderRepository.save(order);
throw e;
}
}
}
Never fire an external side effect (email, Kafka publish, webhook, cache warm) inside the transaction — if the TX rolls back, you've already sent it. Bind the side effect to the commit instead:
// Publisher — inside the TX
@Transactional
public Order place(UUID id) {
Order order = orderRepository.findById(id).orElseThrow();
order.place();
eventPublisher.publishEvent(new OrderPlaced(order.getId())); // not sent yet
return orderRepository.save(order);
}
// Listener — runs ONLY if the TX commits successfully
@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
public void onOrderPlaced(OrderPlaced event) {
emailService.sendConfirmation(event.orderId()); // safe: data is durable
}
AFTER_COMMIT runs after the DB commits. Note: it runs outside the original transaction, so a
new @Transactional(REQUIRES_NEW) is needed if the listener itself writes to the DB. This is the
clean way to publish the domain events collected in the [[domain-driven-design]] aggregate.
@Transactional on controllers — only on service layer@TransactionalEventListener(AFTER_COMMIT)readOnly = true on read methods — missed DB optimization@Transactional methods on this — self-invocation bypasses proxyrollbackFor@Transactional on private methods — Spring proxy can't interceptspring-retry + @EnableRetry — retry is core framework now: @Retryable + @EnableResilientMethods (attributes are includes/maxRetries/delay, not Spring Retry's retryFor/maxAttempts)@Retryable and @Transactional on the same method — the retry re-runs inside the doomed TX; put @Retryable on the calling bean
评论 (0)
暂无评论,成为第一个评论者吧!