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

Recommend using Maven's <annotationProcessorPaths>

Browse Source 
Closes gh-43329
This commit is contained in:
Andy Wilkinson
2024-12-03 11:10:53 +00:00
parent 13c9f68b45
commit 4763123932
2 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -283,18 +283,7 @@ If you do it that way, the library is not provided and, by default, Spring Boot
Spring Boot uses an annotation processor to collect the conditions on auto-configurations in a metadata file (`META-INF/spring-autoconfigure-metadata.properties`).
If that file is present, it is used to eagerly filter auto-configurations that do not match, which will improve startup time.
When building with Maven, it is recommended to add the following dependency in a module that contains auto-configurations:
[source,xml]
----
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure-processor</artifactId>
<optional>true</optional>
</dependency>
----
If you have defined auto-configurations directly in your application, make sure to configure the `spring-boot-maven-plugin` to prevent the `repackage` goal from adding the dependency into the uber jar:
When building with Maven, configure the compiler plugin (3.12.0 or later) to add `spring-boot-autoconfigure-processor` to the annotation processor paths:
[source,xml]
----
@@ -302,15 +291,15 @@ If you have defined auto-configurations directly in your application, make sure
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<annotationProcessorPaths>
<path>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure-processor</artifactId>
</exclude>
</excludes>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>