Java Springboot
GitHubOfficialFirst committed by jduboisDistributed by GitHub
- Skill
- Tool integration
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides rules and best practices for developing features within an established Spring Boot 3 or 4 project. It covers essential areas including configuration management, data access, REST API design, messaging, and startup optimization. The skill emphasizes maintaining consistency with existing project conventions, verifying changes through the project's build system, and avoiding implicit upgrades or unauthorized infrastructure additions.
What it does
- Provides guidance on implementing controllers, validation, and ProblemDetail error handling.
- Offers patterns for Spring Data JPA/JDBC, RestClient, and HTTP interfaces.
- Details configuration management using type-safe properties and profiles.
- Covers integration of messaging systems like Kafka and AMQP, caching, and scheduling.
- Explains startup tuning techniques including AOT, CDS, and virtual threads.
- Enforces strict adherence to existing project build tools and versioning conventions.
When to use it
- When you need to add new features or modify existing code in a Spring Boot 3 or 4 project.
- When implementing new configuration properties or managing environment-specific settings.
- When optimizing application startup times or memory usage using AOT or CDS.
- When integrating new messaging, caching, or database components into an existing codebase.
Advantages
- Ensures consistency by matching existing project structure, versions, and naming conventions.
- Promotes safe development practices by requiring build verification before finalizing changes.
- Provides clear guidance on modern Spring Boot features like virtual threads and AOT.
- Reduces configuration errors through type-safe property binding and validation.
Usage examples
- “How do I add a new configuration property for my mail service in my Spring Boot 4 project?”
- The agent will provide a code snippet for a type-safe record using @ConfigurationProperties and explain how to register it using @ConfigurationPropertiesScan.
- “I need to implement a REST endpoint that returns a custom error using ProblemDetail.”
- The agent will guide you to create a @RestControllerAdvice and demonstrate how to map exceptions to the RFC 7807 ProblemDetail format.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/github/java-springboot/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip java-springboot.zip -d .agents/skills
Documentation by jdubois
Spring Boot application development
Opinionated rules plus a router to deeper references. Code samples in the references were compiled and run on Spring Boot 4.1.1 (Spring Framework 7) and, where they differ, on Boot 3.5.16 (Framework 6.2). Boot 3 vs 4 differences are marked "Boot 3" / "Boot 4" in each reference.
Before writing code
Detect, do not assume: read
pom.xml/build.gradle(.kts)for the Spring Boot version, Java version, starters in use (spring-boot-starter-webis Boot 3,spring-boot-starter-webmvcis Boot 4), persistence (JPA, JDBC), the migration tool, the test setup, and the package layout and naming conventions of the existing code. Match them.Never upgrade Spring Boot, Java or dependencies implicitly. A Boot 3 -> 4 move is a deliberate task (
spring-boot-4-migration).Ask before adding infrastructure: a broker (Kafka, RabbitMQ), a cache provider, a new database, or a scheduler/async setup. Add only what the user requested, with the Boot-managed version (no explicit version for BOM-managed artifacts, never
latest).Verify every change with the project's own build:
./mvnw verifyor./gradlew build(plainmvn/gradleif no wrapper). Integration tests need Docker when they use Testcontainers.
Router
| Task | Read |
|---|---|
Repositories, projections, pagination, N+1, @Transactional, auditing, Flyway/Liquibase, Spring Data JDBC | references/data.md |
Controllers, validation, ProblemDetail, RestClient, @HttpExchange, API versioning, OpenAPI, JSpecify | references/rest-api.md |
Kafka/AMQP, @Cacheable/Caffeine, @Scheduled, @Async, virtual threads, outbox | references/messaging-caching.md |
@ConfigurationProperties, profiles, secrets, config import, Docker Compose / Testcontainers at dev time | references/configuration.md |
| AOT, CDS/AppCDS, lazy initialization, native image | references/aot-and-startup.md |
If these standalone skills are installed, also use them for their topic; otherwise rely on the official docs: java-hibernate-jpa (JPA mapping), spring-boot-testing (tests), spring-security (authentication, authorization, CSRF/CORS), spring-observability (metrics, tracing, Actuator, logs), create-spring-boot-java-project (project defaults, Boot 3 vs 4 build changes), java-add-graalvm-native-image-support (native executable).
Core rules
Structure and layers: package by feature; constructor injection; controllers return DTOs/records, never entities; services own the transaction.
Validation and errors: Bean Validation on request records with
@Valid; one@RestControllerAdvicereturningProblemDetail. JSpecify annotations document nullability only and do not validate.Jackson: Boot 4 uses Jackson 3 (
tools.jackson.databind.*,JsonMapper; annotations stay incom.fasterxml.jackson.annotation); Boot 3 uses Jackson 2 (com.fasterxml.jackson.databind.*,ObjectMapper).Slice-test gotcha: put
@EnableJpaAuditing,@EnableCaching,@EnableAsync,@EnableSchedulingon dedicated@Configurationclasses, not on the@SpringBootApplicationclass, or slices such as@DataJpaTestfail to start (for example, noCacheManager). Slices do not scan@Configurationclasses:@Importthe one a test needs.Proxied beans:
@Cacheable,@Asyncand@Transactionalwork through proxies: they do nothing on self-invocation or onprivate/finalmethods; test them through the injected bean.
Checklist
[ ] Versions, build tool and conventions detected; starters match the Boot major
[ ] No new infrastructure or dependency without the user's agreement
[ ]
./mvnw verify/./gradlew buildpasses; secrets absent from code, properties and logs
See also: Spring Boot reference https://docs.spring.io/spring-boot/reference/, Spring Framework reference https://docs.spring.io/spring-framework/reference/, Spring Data https://docs.spring.io/spring-data/commons/reference/.
Files
- ATTRIBUTION.mdAdded by AutoGineer861 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md4.3 KiB
- references/aot-and-startup.md5.3 KiB
- references/configuration.md5.0 KiB
- references/data.md5.9 KiB
- references/messaging-caching.md7.2 KiB
- references/rest-api.md9.0 KiB
references/messaging-caching.md
Messaging, caching, scheduling, async
Ask before adding a broker, a cache provider or a scheduler/async setup to an existing project: each one adds infrastructure and operational cost. When the user agrees, use the Boot-managed versions (no explicit version for Spring-managed artifacts). Verified on Boot 4.1.1 (JDK 26 runtime, --release 25); Boot 3 differences noted where known. Tests for these: spring-boot-testing; tracing/metrics for them: spring-observability.
Kafka (Spring for Apache Kafka)
Boot 4:
spring-boot-starter-kafka(+spring-boot-starter-kafka-test). Boot 3:org.springframework.kafka:spring-kafka(no starter; version managed by the Boot BOM).Producer:
KafkaTemplate<String, String>; consumer:@KafkaListener.
@Component
class Events {
private final KafkaTemplate<String, String> template;
Events(KafkaTemplate<String, String> template) { this.template = template; }
void publish(String key, String payload) { template.send("orders", key, payload); }
@KafkaListener(topics = "orders", groupId = "demo")
void on(String payload) { /* must be idempotent: delivery is at-least-once */ }
}spring.kafka.bootstrap-servers=${KAFKA_BOOTSTRAP_SERVERS:localhost:9092}
spring.kafka.consumer.auto-offset-reset=earliestConsumers must be idempotent (at-least-once delivery); decide on a retry/dead-letter strategy (
DefaultErrorHandlerwithDeadLetterPublishingRecoverer) before going to production.Keep payloads as versioned DTOs (records); avoid sending JPA entities.
Test with a real broker through Testcontainers (verified: send then receive in a
@SpringBootTest):
import org.testcontainers.kafka.KafkaContainer;
@TestConfiguration(proxyBeanMethods = false)
public class TestcontainersConfiguration {
@Bean @ServiceConnection
KafkaContainer kafkaContainer() { return new KafkaContainer(DockerImageName.parse("apache/kafka-native:4.0.0")); }
} Boot 4 uses Testcontainers 2.x (artifact org.testcontainers:testcontainers-kafka); Boot 3 uses 1.x (artifact org.testcontainers:kafka). The example uses org.testcontainers.kafka.KafkaContainer, available in recent 1.x releases as well as 2.x; check that the project's BOM-managed version supports apache/kafka-native. Do not substitute the legacy org.testcontainers.containers.KafkaContainer: it requires a confluentinc/cp-kafka image. If the project's older Testcontainers version lacks the modern class or native-image support, use the legacy class with a compatible pinned Confluent image instead, without implicitly upgrading dependencies. Pin the image tag, never latest. Wait with a CountDownLatch/Awaitility, not Thread.sleep.
RabbitMQ / AMQP (not verified in this skill's builds)
spring-boot-starter-amqp (Boot 3 and 4), RabbitTemplate to send, @RabbitListener to consume, @ServiceConnection with the Testcontainers RabbitMQ module for tests. Declare queues/exchanges as Queue/TopicExchange/Binding beans, use Jackson2JsonMessageConverter-style JSON converters only after checking the Jackson major in use (Boot 4 = Jackson 3), and configure a dead-letter exchange. Check the Spring AMQP reference for the exact converter class names for your version before generating code.
Transactional outbox
Publishing to a broker inside a database transaction is not atomic: a crash between commit and send loses the message. When messages must not be lost, write the event to an outbox table in the same transaction as the state change, and have a relay (scheduled poller or CDC such as Debezium) publish and mark it sent. Consumers stay idempotent. Do not implement it unless the user needs that guarantee; for events that can be lost, @TransactionalEventListener(phase = AFTER_COMMIT) is simpler.
Caching with Caffeine
Dependencies:
spring-boot-starter-cache(Boot 4 + test starterspring-boot-starter-cache-test; Boot 3 the same starter name) andcom.github.ben-manes.caffeine:caffeine(BOM-managed).
@Configuration(proxyBeanMethods = false)
@EnableCaching
class CachingConfig {} // a dedicated class, not the @SpringBootApplication class
@Service
class RateService {
@Cacheable("rates") // key = method arguments
public Rate expensive(String currency) { ... }
@CacheEvict(value = "rates", allEntries = true)
public void evict() {}
}spring.cache.type=caffeine
spring.cache.cache-names=rates
spring.cache.caffeine.spec=maximumSize=500,expireAfterWrite=10mVerified on Boot 4.1.1: second call is served from cache,
evict()forces a reload. Always setmaximumSizeand an expiry; unbounded caches are memory leaks.Cache immutable DTOs/records, not managed JPA entities. The cache is per JVM: with several instances use a distributed cache (Redis) only if the user asks for it, and expect stale data across nodes with Caffeine.
@Cacheableis proxy-based: self-invocation andprivatemethods bypass it. Do not cache methods with side effects ornullreturns you do not intend to cache.Enabling caching in
@SpringBootApplicationbreaks slice tests that do not register aCacheManager(verified:@DataJpaTestfails with "No qualifying bean of type CacheManager"), hence the dedicated@Configuration.To expose cache statistics in Micrometer call
recordStats(Caffeine specrecordStats); otherwise Boot logs a warning that the cache is not recording statistics (observed).
Scheduling
@Configuration(proxyBeanMethods = false)
@EnableScheduling
class SchedulingConfig {}
@Scheduled(fixedDelayString = "${app.tick:PT10S}") // or cron = "0 0 * * * *", zone = "UTC"
void cleanup() { ... }Verified: @Scheduled(fixedDelayString = "${...:100ms}") runs on Boot 4.1.1. Prefer fixedDelay over fixedRate to avoid overlapping runs. @Scheduled runs on every instance: with several replicas use a lock (ShedLock) or an external scheduler; add that only after asking. Scheduled methods take no arguments and must not throw unhandled exceptions silently: log and handle.
Async and virtual threads
spring.threads.virtual.enabled=true # Java 21+, Boot 3.2+With the property set, Boot runs Tomcat/Jetty request handling, @Async tasks (through the auto-configured task executor) and other Boot-managed executors on virtual threads. Verified on Boot 4.1.1: an @Async method reports Thread.currentThread().isVirtual() == true.
@Configuration(proxyBeanMethods = false)
@EnableAsync
class AsyncConfig {}
@Async
public CompletableFuture<Result> compute() { ... } // return void or CompletableFutureNeeds Java 21+; on Boot 3 the property exists from 3.2. Do not enable it on Java 17.
Virtual threads help blocking I/O workloads (JDBC, HTTP). They do not speed up CPU-bound work. Pool sizes become the bottleneck: size the HikariCP pool deliberately and consider limits on downstream calls. Before JDK 24,
synchronizedblocks around blocking calls pin the carrier thread; preferReentrantLockthere.@Asyncis proxy-based like@Transactional: the caller must be another bean, and the transaction/security context does not follow into the async thread unless propagated.With
@Asyncreturningvoid, exceptions are lost unless anAsyncUncaughtExceptionHandleris configured.
Requirements and compatibility
Written for: GitHub Copilot
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- First committed by
jdubois
- Publisher
- GitHub (Official)
- Distributed by
- GitHub
- Source
- github/awesome-copilot · skills/java-springboot · commit 797337f
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
- Contributors
- jdubois
AutoGineer is not affiliated with or endorsed by jdubois or GitHub.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download java-springboot.zip