Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Provide support for deprecated auto-configuration classes

Browse Source 
Support `AutoConfiguration.replacements` file that can be placed
alongside an `AutoConfiguration.imports` to replace deprecated
auto-configurations.

Closes gh-14860
This commit is contained in:
Phillip Webb
2024-09-09 12:40:52 -07:00
parent ddd0d898c2
commit 72588fcda7
16 changed files with 569 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/developing-auto-configuration.adoc
View File

@@ -52,6 +52,26 @@ The order in which those beans are subsequently created is unaffected and is det
[[features.developing-auto-configuration.locating-auto-configuration-candidates.deprecating]]
=== Deprecating and Replacing Auto-configuration Classes
You may need to occasionally deprecate auto-configuration classes and offer an alternative.
For example, you may want to change the package name where your auto-configuration class resides.
Since auto-configuration classes may be referenced in `before`/`after` ordering and `excludes`, you'll need to add an additional file that tells Spring Boot how to deal with replacements.
To define replacements, create a `META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.replacements` file indicating the link between the old class and the new one.
For example:
[source]
----
com.mycorp.libx.autoconfigure.LibXAutoConfiguration=com.mycorp.libx.autoconfigure.core.LibXAutoConfiguration
----
NOTE: The `AutoConfiguration.imports` file should also be updated to _only_ reference the replacement class.
[[features.developing-auto-configuration.condition-annotations]]
== Condition Annotations