spring-boot-4-migration
Skill41 starsChanged 4 months agoApache-2.0View on GitHub
Guides Spring Boot version migrations: 2.7.x to 3.5.x, 3.5.x to 4.x, and minor upgrades within 4.x. Covers Java/Kotlin baseline upgrades, Jakarta EE namespace (javax to jakarta), Hibernate 5/6/7, Spring Security 5/6/7, modular starters, Jackson 3, Spring Framework 7, observability (Micrometer Tracing, OpenTelemetry), property and package relocations, JUnit 6, Testcontainers 2, MockitoBean, HTTP clients, resilience, AOT/native, API versioning, and OpenRewrite recipe automation. Supports all-at-once and gradual strategies with compatibility bridges. Java and Kotlin; Maven and Gradle. Trigger on requests like "upgrade/migrate to Spring Boot 3 or 4", "Spring Boot 2 to 3", "javax to jakarta", "upgrade to 4.1", "OpenRewrite Spring Boot", or any request moving a Spring Boot project to a newer major or minor version. Do NOT use for general Spring Boot development on a fixed version (new endpoints, services, JPA, tests) — use the spring-boot skill for that.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- github/awesome-copilottheir own version, first seen Nov 8, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
- github/awesome-copilot★ 41ksame name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
The file
Show its rules and text
We split this skill into the rules it gives an agent
41 rules. About 0 are common, 17 are distinctive, and 24 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈17
Distinctive · estimate
This author's own choices. Worth a look.
24
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 60
If your project is on Boot 2.7.x or earlier, start with § "Coming from Spring Boot 2.7?" below, complete the 2 → 3 leg, then return here …
- Very specific: line 70
Use Context7 (mcp__claude_ai_Context7__resolve-library-id then mcp__claude_ai_Context7__query-docs) for library docs.
- Very specific: line 72
Use WebSearch / WebFetch for breaking-change announcements, CVEs, and community migration reports.
- Very specific: line 74
Use gh for release notes (e.g., gh api repos/spring-projects/spring-boot/releases/latest).
- Distinctive: line 79
Before starting any migration, detect the project's Java, Kotlin, Maven, and Gradle versions.
- Very specific: line 83
Read references/toolchain-versions.md for the minimum/recommended versions table and per-tool upgrade commands.
- Very specific: line 88
If your project is on Spring Boot 2.7.x (or earlier), do the 2.7 → 3.5 leg FIRST: Boot 2.7.x → Boot 3.5.x latest → Boot 4.x.
- Very specific: line 91
Read references/spring-boot-2-to-3-migration.md.
- Distinctive: line 106
All deprecated API calls from Boot 3.x are resolved where possible
- Distinctive: line 107
If on Boot 3.4 or earlier, first upgrade to 3.5.x before proceeding
- Distinctive: line 112
Check the official release notes for the target version
- Very specific: line 118
Read references/gradual-upgrade-strategy.md FIRST.
- Distinctive: line 125
Use this when: multiple teams, many services, phased rollouts, or when complete Jackson 3 / Security 7 migration will take more than one …
- Distinctive: line 134
Before doing manual migration, consider using OpenRewrite recipes to automate the mechanical changes.
- Distinctive: line 162
Update Boot/Framework versions, build plugins, and replace deprecated starters with modular equivalents.
- Very specific: line 166
Read references/build-and-dependencies.md for complete starter mappings, build plugin changes, and step-by-step instructions.
- Very specific: line 169
If your project uses Spring for Apache Kafka, also read references/spring-kafka-4-migration.md — Spring Kafka 4 changes the test starter …
- Very specific: line 175
Compile check: Run mvn compile or gradle compileJava — fix any dependency resolution errors before continuing.
- Very specific: line 184
Read references/property-changes.md for the complete property mapping.
- Very specific: line 190
Use spring-boot-jackson2 bridge as a temporary stopgap if needed.
- Very specific: line 192
Read references/jackson3-migration.md for complete details.
- Very specific: line 193
If your project uses Spring Kafka JSON serializers/deserializers or header mappers, also read the Jackson section of …
- Very specific: line 204
Read references/api-changes.md for the full list of relocated packages and removed APIs.
- Very specific: line 234
If your project uses @EmbeddedKafka or EmbeddedKafkaZKBroker, also read references/spring-kafka-4-migration.md — Spring Kafka 4 removes the …
- Distinctive: line 257
Run the verification script if available, otherwise manually check:
- Very specific: line 260
Verify application starts: mvn spring-boot:run or gradle bootRun
- Very specific: line 261
Check actuator health: curl localhost:8080/actuator/health
- Distinctive: line 262
Verify liveness/readiness probes (now enabled by default)
- Distinctive: line 263
Check structured logging output format
- Distinctive: line 264
Run integration tests against each active Spring profile
- Distinctive: line 265
Verify Docker image builds if using buildpacks or Jib
- Distinctive: line 272
When upgrading between Spring Boot 4.x minor versions, follow this process:
- Very specific: line 276
Read references/minor-version-changes.md for the target version.
- Distinctive: line 293
If you are still using a bridge that is being removed in the target version, complete the corresponding migration track BEFORE upgrading.
- Distinctive: line 298
Update the Spring Boot version in your build file to the target minor version's latest patch release.
- Very specific: line 300
Run mvn compile / gradle compileJava — fix any new compilation errors.
- Distinctive: line 301
Run the full test suite — fix any test failures.
- Very specific: line 304
Run verify_migration.sh to confirm migration state.
- Very specific: line 327
If build won't compile at all after version bump, use spring-boot-starter-classic and spring-boot-starter-test-classic to get running, then …
- Very specific: line 328
If Jackson 3 migration is blocking, add spring-boot-jackson2 temporarily.
- Very specific: line 329
If Spring Security changes are extensive, add spring-security-access bridge and upgrade to Security 6.5 preparation steps first (they …
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Spring Boot 4 Migration Skill
Migrate Spring Boot 2.7.x applications to 3.5.x, then 3.5.x to 4.x, and stay current across 4.x minor versions, anchored to the official Spring Boot migration guides and release notes for each leg.
Currency
Last verified: 2026-07 (Spring Boot 4.1.0 / Framework 7.0.8 era). Facts here age. If the answer hinges on a version-sensitive fact — a removal target, a managed dependency version, an OpenRewrite recipe ID, a "deprecated in X" claim — and time has passed since the stamp above, spot-check current release notes or the tool's own source before asserting it. When current docs disagree with this file, the docs win: say so and note the line is stale.
Scope: 2.7.x → 3.5.x → 4.x and 4.x Minor Versions
This skill covers three scenarios:
- Legacy migration (2.7.x → 3.5.x) — the prelude. Covered in
references/spring-boot-2-to-3-migration.md: Java 8/11 → 17 baseline, Jakarta EE namespace migration (javax.*→jakarta.*), Spring Security 5 → 6, Hibernate 5 → 6, observability migration to Micrometer Tracing/Observation, OpenRewrite recipe automation for every step. Reach Boot 3.5 latest patch here, then chain into the next scenario. - Major migration (3.5.x → 4.0) — the bulk of this skill. All 9 phases, the gradual upgrade strategy, and the bridge system below.
- Minor version upgrades (4.0 → 4.1, 4.1 → 4.2, etc.) — tracked in
references/minor-version-changes.md. Minor versions may deprecate APIs, remove compatibility bridges, change defaults, and introduce new features. Check that file before bumping to any new 4.x minor version.
If your project is on Boot 2.7.x or earlier, start with § "Coming from Spring Boot 2.7?" below, complete the 2 → 3 leg, then return here for the 3 → 4 phases.
Verify APIs Against Current Documentation
Many APIs change across these migrations. When unsure whether an API, property, or pattern is still valid for the target version, look it up rather than relying on model knowledge:
- Use Context7 (
mcp__claude_ai_Context7__resolve-library-idthenmcp__claude_ai_Context7__query-docs) for library docs. - Use
WebSearch/WebFetchfor breaking-change announcements, CVEs, and community migration reports. - Use
ghfor release notes (e.g.,gh api repos/spring-projects/spring-boot/releases/latest).
Toolchain Version Check (Do This First)
Before starting any migration, detect the project's Java, Kotlin, Maven, and Gradle versions. If any are below the minimums for the target Boot version, upgrade them BEFORE bumping Boot.
Read references/toolchain-versions.md for the minimum/recommended
versions table and per-tool upgrade commands.
Coming from Spring Boot 2.7? Start here.
If your project is on Spring Boot 2.7.x (or earlier), do the 2.7 → 3.5
leg FIRST: Boot 2.7.x → Boot 3.5.x latest → Boot 4.x.
Read references/spring-boot-2-to-3-migration.md. It covers the
toolchain bump, 2.7.18 pre-flight, OpenRewrite recipes
(UpgradeSpringBoot_3_5 one-shot or per-minor), Jakarta namespace,
Security 5 → 6, Hibernate 5 → 6, property migration, and observability
migration to Micrometer Tracing.
Return here once ./mvnw verify / ./gradlew build passes on Boot 3.5
latest patch and spring-boot-properties-migrator is quiet.
Prerequisites
For 3.x → 4.0 migration:
- Toolchain versions meet minimums (see Toolchain Version Check above)
- Source project compiles and tests pass on Spring Boot 3.5.x (latest patch)
- Java 17+ is available (Java 21+ recommended, Java 25 supported)
- All deprecated API calls from Boot 3.x are resolved where possible
- If on Boot 3.4 or earlier, first upgrade to 3.5.x before proceeding
For 4.x → 4.y minor version upgrade:
- Project is on the latest patch of the current minor version (e.g., 4.0.x latest)
- Review
references/minor-version-changes.mdfor the target version - Check the official release notes for the target version
- Resolve any deprecation warnings from the current version
Choose Your Migration Strategy
Strategy 1 — Gradual Upgrade (Recommended for enterprise/large codebases)
Read references/gradual-upgrade-strategy.md FIRST. This models migration
as a dependency graph: a Day-1 baseline using compatibility bridges, then
6 independent tracks (Starters, Jackson 3, Properties, Security, Testing,
Framework 7) completed at your own pace. Key bridges:
spring-boot-starter-classic— restores 3.x monolithic auto-configurationspring-boot-jackson2— keeps Jackson 2 code working alongside Boot 4spring-security-access— bridges legacy AccessDecisionManager/Voter Use this when: multiple teams, many services, phased rollouts, or when complete Jackson 3 / Security 7 migration will take more than one sprint.
Strategy 2 — All-at-Once (below) Execute all 9 phases sequentially in one effort. Best for greenfield projects, small codebases, or single-team ownership.
Automated Migration with OpenRewrite
Before doing manual migration, consider using OpenRewrite recipes to automate the mechanical changes. Run OpenRewrite FIRST to handle bulk find-replace operations, then use this skill's phases to address the remaining manual changes (Security DSL rewrites, behavioral differences, property semantics, etc.).
For the 2.7 → 3.5 leg (run before any 3 → 4 work): see the recipe table in references/spring-boot-2-to-3-migration.md § 3 — UpgradeSpringBoot_3_5 one-shot composes every step, or run per-minor for large codebases.
For the 3.5 → 4.0 leg:
| Recipe ID | Coverage |
org.openrewrite.java.spring.boot4.UpgradeSpringBoot_4_0 (Community Edition variant available) | Boot 3.5 → 4.0 |
org.openrewrite.java.spring.kafka.UpgradeSpringKafka_4_0 | Spring Kafka 3.x → 4.0 (use alongside the Boot 4 recipe — see references/spring-kafka-4-migration.md) |
org.openrewrite.java.jackson.UpgradeJackson_2_3 | Jackson 2 → 3 package/import migration |
org.openrewrite.java.spring.boot4.ReplaceMockBeanAndSpyBean | @MockBean/@SpyBean → @MockitoBean/@MockitoSpyBean |
See: moderne.ai/blog/spring-boot-4x-migration-guide. For the 4.0 recipe specifically: docs.openrewrite.org/recipes/java/spring/boot4/upgradespringboot_4_0-community-edition.
Invocation: ./mvnw org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-spring:RELEASE -Drewrite.activeRecipes=<recipe-id> (Maven) or ./gradlew rewriteRun -Drewrite.activeRecipes=<recipe-id> (Gradle).
Migration Workflow (All-at-Once)
Execute these phases IN ORDER. Each phase must compile and pass tests before proceeding to the next.
Phase 1: Build File Migration
Update Boot/Framework versions, build plugins, and replace deprecated starters with modular equivalents. Add modular test starters for each technology used in tests. Use classic starters as a stopgap if needed.
Read references/build-and-dependencies.md for complete starter mappings,
build plugin changes, and step-by-step instructions.
If your project uses Spring for Apache Kafka, also read
references/spring-kafka-4-migration.md — Spring Kafka 4 changes the
test starter coordinates (spring-kafka-test →
spring-boot-starter-kafka-test) and ships dedicated OpenRewrite
recipes that should run alongside UpgradeSpringBoot_4_0.
Compile check: Run mvn compile or gradle compileJava — fix any
dependency resolution errors before continuing.
Phase 2: Property Migration
Scan all application.properties, application.yml, profile-specific
variants, and @SpringBootTest(properties = ...) annotations. Rename
changed property keys (Jackson, MongoDB, session, actuator, Hibernate).
Read references/property-changes.md for the complete property mapping.
Phase 3: Jackson 3 Migration
Jackson 3 is the default in Boot 4. Migrate group IDs, packages, and
renamed Boot classes (@JsonComponent → @JacksonComponent, etc.).
Use spring-boot-jackson2 bridge as a temporary stopgap if needed.
Read references/jackson3-migration.md for complete details.
If your project uses Spring Kafka JSON serializers/deserializers or
header mappers, also read the Jackson section of
references/spring-kafka-4-migration.md — Kafka serializer code moves
to the tools.jackson.* package tree.
Phase 4: Package and API Relocations
Fix relocated imports (@EntityScan, BootstrapRegistry, etc.), removed
APIs (PropertyMapper.alwaysApplyingNotNull, path matching options), and
deprecated converters. Also migrate HTTP client code if applicable.
Read references/api-changes.md for the full list of relocated packages
and removed APIs.
Also read references/http-clients.md if your project uses RestClient,
WebClient, @HttpExchange, or Feign.
Phase 5: Observability Migration
Replace individual Micrometer/OTel dependencies with the consolidated
spring-boot-starter-opentelemetry starter, update OTLP properties, and
rename observability modules. Actuator is now optional for OTel export.
Read references/observability-migration.md for complete details.
Phase 6: Spring Security 7 Migration
Migrate to Security 7 DSL (lambda-only, no and()), replace removed
AuthorizationManager#check, switch to PathPatternRequestMatcher, and
update Jackson/SAML integrations. Use spring-security-access bridge if
legacy AccessDecisionManager/Voter code cannot migrate immediately.
Read references/spring-security7.md for complete details.
Phase 7: Testing Infrastructure Migration
Replace @MockBean/@SpyBean with @MockitoBean/@MockitoSpyBean
(removed, not just deprecated). Add explicit auto-configure annotations
for test HTTP clients. Migrate Testcontainers 2 module names/packages
and adopt JUnit 6. Add modular test starters for each technology.
Read references/testing-migration.md for complete details.
If your project uses @EmbeddedKafka or EmbeddedKafkaZKBroker, also
read references/spring-kafka-4-migration.md — Spring Kafka 4 removes
the ZooKeeper code paths (KRaft only) and the corresponding
@EmbeddedKafka attributes.
Phase 8: Spring Framework 7 Specific Changes
Address JSpecify nullability (Kotlin impact), deprecated AntPathMatcher,
MVC XML config removal, SpringExtension scope changes, Hibernate 7.1
entity mapping changes, and Spring Retry → Framework core retry migration.
Read references/spring-framework7.md for complete details.
Also read references/resilience-migration.md if your project uses
Spring Retry, @Retryable, @ConcurrencyLimit, or Resilience4j.
If your project uses Spring for Apache Kafka, also read
references/spring-kafka-4-migration.md — Spring Kafka 4 drops its
Spring Retry dependency in favour of Framework 7 core retry, and
BackOffValuesGenerator now uses BackOff instead of BackOffPolicy.
Optionally read references/api-versioning.md for new API versioning
capabilities introduced in Framework 7.
Phase 9: Final Verification
Run the verification script if available, otherwise manually check:
mvn clean verifyorgradle clean build— full compile + tests- Verify application starts:
mvn spring-boot:runorgradle bootRun - Check actuator health:
curl localhost:8080/actuator/health - Verify liveness/readiness probes (now enabled by default)
- Check structured logging output format
- Run integration tests against each active Spring profile
- Verify Docker image builds if using buildpacks or Jib
Optionally read references/aot-native.md if you plan to adopt AOT
processing, GraalVM native images, or the new AOT cache feature.
Minor Version Upgrades (4.0 → 4.1, 4.1 → 4.2, etc.)
When upgrading between Spring Boot 4.x minor versions, follow this process:
1. Check What Changed
Read references/minor-version-changes.md for the target version. Also
consult the official release notes:
- https://github.com/spring-projects/spring-boot/wiki (Release Notes per version)
- https://docs.spring.io/spring-boot/upgrading.html
2. Bridge Removal Awareness
Minor versions are where compatibility bridges get removed. Before upgrading, check whether any bridges you depend on are being dropped:
| Bridge | Introduced | Expected Removal |
spring-boot-jackson2 | 4.0 | 4.3.0 (per Javadoc forRemoval) |
spring-boot-starter-classic | 4.0 | 5.0 |
spring-boot-starter-test-classic | 4.0 | 5.0 |
| Deprecated starter names | 4.0 | 5.0 |
If you are still using a bridge that is being removed in the target version, complete the corresponding migration track BEFORE upgrading.
3. Upgrade Process
- Update the Spring Boot version in your build file to the target minor version's latest patch release.
- Run
mvn compile/gradle compileJava— fix any new compilation errors. - Run the full test suite — fix any test failures.
- Review deprecation warnings in both build output and application logs. These signal what will break in the NEXT minor version.
- Run
verify_migration.shto confirm migration state.
4. New Features
Each minor version introduces new features and auto-configurations. These are opt-in and don't require action, but you may want to adopt them. Check the "New and Noteworthy" section of each release's notes.
Troubleshooting
Common Compilation Errors
| Error | Cause | Fix |
ClassNotFoundException: ...autoconfigure... | Modular starters needed | Add specific spring-boot-starter-X |
NoSuchMethodError: PropertyMapper.alwaysApplyingNotNull | API removed | Use always() instead |
Cannot resolve symbol JsonComponent | Renamed | Use @JacksonComponent |
Package com.fasterxml.jackson does not exist | Jackson 3 packages | Change to tools.jackson |
Cannot resolve symbol MockBean | Deprecated/removed | Use @MockitoBean |
ClassNotFoundException: RestClientBuilderCustomizer | Elasticsearch change | Use Rest5ClientBuilderCustomizer |
Quick Fixes
- If build won't compile at all after version bump, use
spring-boot-starter-classicandspring-boot-starter-test-classicto get running, then incrementally migrate to modular starters. Seereferences/gradual-upgrade-strategy.mdfor the full Day-1 baseline. - If Jackson 3 migration is blocking, add
spring-boot-jackson2temporarily. This is a first-class bridge — see Track B in the gradual strategy. - If Spring Security changes are extensive, add
spring-security-accessbridge and upgrade to Security 6.5 preparation steps first (they provide opt-out flags for 7.0 breaking changes). See Track D in the gradual strategy. - For enterprise rollouts across many services, use the Wave 1-4 approach in
references/gradual-upgrade-strategy.mdto minimize blast radius.
Reference File Index
| File | When to read |
references/toolchain-versions.md | Toolchain check — Java/Kotlin/Maven/Gradle minimums and per-tool upgrade commands |
references/spring-boot-2-to-3-migration.md | Boot 2.7.x → 3.5.x prelude — Java baseline, Jakarta migration, Hibernate 5 → 6, Security 5 → 6, OpenRewrite recipes, per-minor highlights |
references/gradual-upgrade-strategy.md | FIRST (for 3 → 4) — migration dependency graph, bridges, independent tracks, enterprise rollout |
references/build-and-dependencies.md | Phase 1 / Track A — full starter mapping tables, build plugin changes |
references/property-changes.md | Phase 2 / Track C — all property key renames and value changes |
references/jackson3-migration.md | Phase 3 / Track B — Jackson 3 packages, APIs, compatibility mode |
references/api-changes.md | Phase 4 — package relocations, removed APIs, renamed classes |
references/observability-migration.md | Phase 5 — OpenTelemetry starter, OTLP properties, module renames, Actuator decoupling |
references/spring-security7.md | Phase 6 / Track D — Security 7 breaking changes and DSL migration |
references/testing-migration.md | Phase 7 / Track E — 2.7→3 testing leg (JUnit 4→5, javax→jakarta tests), then 3.5→4: MockBean, Testcontainers 2, JUnit 6, RestTestClient |
references/spring-framework7.md | Phase 8 / Track F — Framework 7 changes, JSpecify, path matching |
references/http-clients.md | HTTP clients — RestClient, WebClient, @HttpExchange, Feign migration, RestTestClient |
references/api-versioning.md | API versioning — strategies, semantic ranges, client-side, deprecation, testing |
references/resilience-migration.md | Resilience — Spring Retry → Framework 7, @Retryable, @ConcurrencyLimit, Resilience4j |
references/spring-kafka-4-migration.md | Spring for Apache Kafka 4 — Apache Kafka 4 client (KRaft only), EmbeddedKafkaZKBroker removal, spring-boot-starter-kafka-test, Jackson 3 serializers, Spring Retry removal, KIP-848 / KIP-932, OpenRewrite recipes |
references/aot-native.md | AOT/Native — BeanRegistrar, RuntimeHints, Spring Data AOT, GraalVM 25, AOT Cache |
references/minor-version-changes.md | 4.x minor upgrades — changes per minor version, bridge removals, new features |
scripts/verify_migration.sh | Phase 9 — bridge-aware verification with PASS/FAIL/WARN/BRIDGE |
Authoritative external sources for each leg are listed at the bottom of the corresponding reference file.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

