Generated banner for Java Springboot
Generated logo for Java Springboot

Java Springboot

GitHubOfficialFirst committed by jduboisDistributed by GitHub

  • Skill
  • Tool integration
  • Software development
  • MIT
  • No issues found

From the author

Write and review application code in an existing Spring Boot 3/4 project: controllers, validation and ProblemDetail errors, Spring Data JPA/JDBC, RestClient and HTTP interfaces, configuration properties, Kafka/AMQP, caching, scheduling, virtual threads, AOT and startup tuning. Use when adding or changing features. To scaffold a new project use create-spring-boot-java-project instead.
— the description by jdubois

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

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/github/java-springboot/download
  2. Unzip 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

  1. Detect, do not assume: read pom.xml/build.gradle(.kts) for the Spring Boot version, Java version, starters in use (spring-boot-starter-web is Boot 3, spring-boot-starter-webmvc is Boot 4), persistence (JPA, JDBC), the migration tool, the test setup, and the package layout and naming conventions of the existing code. Match them.

  2. Never upgrade Spring Boot, Java or dependencies implicitly. A Boot 3 -> 4 move is a deliberate task (spring-boot-4-migration).

  3. 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).

  4. Verify every change with the project's own build: ./mvnw verify or ./gradlew build (plain mvn/gradle if no wrapper). Integration tests need Docker when they use Testcontainers.

Router

TaskRead
Repositories, projections, pagination, N+1, @Transactional, auditing, Flyway/Liquibase, Spring Data JDBCreferences/data.md
Controllers, validation, ProblemDetail, RestClient, @HttpExchange, API versioning, OpenAPI, JSpecifyreferences/rest-api.md
Kafka/AMQP, @Cacheable/Caffeine, @Scheduled, @Async, virtual threads, outboxreferences/messaging-caching.md
@ConfigurationProperties, profiles, secrets, config import, Docker Compose / Testcontainers at dev timereferences/configuration.md
AOT, CDS/AppCDS, lazy initialization, native imagereferences/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 @RestControllerAdvice returning ProblemDetail. JSpecify annotations document nullability only and do not validate.

  • Jackson: Boot 4 uses Jackson 3 (tools.jackson.databind.*, JsonMapper; annotations stay in com.fasterxml.jackson.annotation); Boot 3 uses Jackson 2 (com.fasterxml.jackson.databind.*, ObjectMapper).

  • Slice-test gotcha: put @EnableJpaAuditing, @EnableCaching, @EnableAsync, @EnableScheduling on dedicated @Configuration classes, not on the @SpringBootApplication class, or slices such as @DataJpaTest fail to start (for example, no CacheManager). Slices do not scan @Configuration classes: @Import the one a test needs.

  • Proxied beans: @Cacheable, @Async and @Transactional work through proxies: they do nothing on self-invocation or on private/final methods; 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 build passes; 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

references/configuration.md

Configuration

Formats, profiles, .env and secret basics, and the short @ConfigurationProperties example already live in create-spring-boot-java-project (references/configuration.md); read it for those and keep one format (properties or YAML) as the project already does. This file adds what is needed when changing an existing application. Verified on Boot 4.1.1.

Type-safe properties (records)

@ConfigurationProperties(prefix = "app.mail")
@Validated
public record MailProperties(@NotBlank String from, @DefaultValue("3") @Positive int retries,
		@DefaultValue("5s") Duration timeout) {}
  • Records bind through their canonical constructor (constructor binding is the default for records). Use @DefaultValue (org.springframework.boot.context.properties.bind.DefaultValue) for optional values; Duration, DataSize, enums and List/Map bind natively (5s, PT5S, 10MB).

  • Register with @ConfigurationPropertiesScan on the application class (or @EnableConfigurationProperties(MailProperties.class)). Verified: the record is a bean with retries == 3 and timeout == 5s when only from is set.

  • @Validated + jakarta.validation constraints make the application fail at startup on invalid configuration, which is what you want. Validation needs the validation starter (spring-boot-starter-validation).

  • Prefer @ConfigurationProperties to scattered @Value; use @Value only for one-off values. Add spring-boot-configuration-processor (optional/annotation-processor path, as start.spring.io does) for IDE metadata.

  • Immutability: no setters; nested config as nested records.

  • Inject the record where needed; do not read Environment directly in business code.

Profiles

  • Keep production-safe defaults in application.properties; profile files (application-dev.properties) only override what differs. Activate with SPRING_PROFILES_ACTIVE.

  • Group related profiles with spring.profiles.group.prod=prod-db,prod-observability when a deployment needs several.

  • Use @Profile sparingly for beans; do not branch application logic on profile names.

  • Do not ship a test profile in src/main; tests use src/test/resources or @TestPropertySource (see spring-boot-testing).

Config import and secrets

spring.config.import=optional:file:.env[.properties],optional:configtree:/run/secrets/
  • optional: prevents startup failure when the file is absent (local development); drop it for values that must exist in production.

  • Kubernetes/Docker secrets mounted as files: configtree: maps each file to a property (file name = key).

  • Environment variables override files through relaxed binding (APP_MAIL_FROM -> app.mail.from).

  • Never commit .env or real credentials; commit .env.sample. Do not log property values holding secrets, and do not expose /actuator/env and /actuator/configprops publicly (spring-observability, spring-security).

  • Externalized config sources like Vault or Spring Cloud Config are out of scope unless the project already uses them; follow its existing import setup.

Dev-time services

Docker Compose

Add spring-boot-docker-compose (start.spring.io adds it, optional/development-only). With a compose.yaml at the project root, ./mvnw spring-boot:run starts the services and wires connection details automatically. Pin image tags (start.spring.io generates postgres:latest; replace it, see create-spring-boot-java-project references/database.md). Not executed in this skill's verification: only the generated files were inspected.

Testcontainers at dev time

start.spring.io (with the testcontainers dependency) generates TestcontainersConfiguration and a TestDemoApplication in src/test:

public class TestDemoApplication {
	public static void main(String[] args) {
		SpringApplication.from(DemoApplication::main).with(TestcontainersConfiguration.class).run(args);
	}
}

Run it with ./mvnw spring-boot:test-run (Gradle: ./gradlew bootTestRun). Verified on Boot 4.1.1: PostgreSQL and Kafka containers started from the @ServiceConnection beans, the app reached UP on /actuator/health, and stopping the app removed the containers (Ryuk). Make TestcontainersConfiguration public if it is used from other packages (see create-spring-boot-java-project references/spring-boot-4.md). Choose either Compose or Testcontainers for dev-time services, not both, to avoid two databases fighting over the same properties.

Boot 3 vs 4

Same property binding rules. Boot 4 changes that touch configuration: Jackson properties continue under spring.jackson.* for Jackson 3 (Jackson 2 compatibility lives in a separate module; consult the migration guide), modular auto-configuration (classes moved to org.springframework.boot.<technology>.autoconfigure, which matters only if you reference or exclude auto-configurations by class name: spring.autoconfigure.exclude=org.springframework.boot.jdbc.autoconfigure.DataSourceAutoConfiguration). Use the spring-boot-4-migration skill for the move itself.

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
GitHub avatar of jduboisjdubois
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