Spring Boot Reference Documentation

Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy
Wilkinson, Marcel Overdijk, Christian Dupuis, Sébastien Deleuze, Michael
Simons, Vedran Pavić, Jay Bryant, Madhura Bhave, Eddú Meléndez, Scott
Frederick

3.0.0-SNAPSHOT
Table of Contents
1. Legal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 

2. Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3  

3. Documentation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4  

3.1. First Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4  

3.2. Upgrading From an Earlier Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4  

3.3. Developing with Spring Boot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4  

3.4. Learning About Spring Boot Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4  

3.5. Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5  

3.6. Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5  

3.7. Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5  

3.8. IO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
 

3.9. Container Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6  

3.10. Advanced Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6  

4. Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7  

4.1. Introducing Spring Boot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7  

4.2. System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7  

4.2.1. Servlet Containers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7  

4.3. Installing Spring Boot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8  

4.3.1. Installation Instructions for the Java Developer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8  

Maven Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8  

Gradle Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9  

4.3.2. Installing the Spring Boot CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9  

Manual Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9  

Installation with SDKMAN!. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9  

OSX Homebrew Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10  

MacPorts Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11  

Command-line Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11  

Windows Scoop Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11  

Quick-start Spring CLI Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11  

4.4. Developing Your First Spring Boot Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12  

4.4.1. Creating the POM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13  

4.4.2. Adding Classpath Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15  

4.4.3. Writing the Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15  

The @RestController and @RequestMapping Annotations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16  

The @EnableAutoConfiguration Annotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16  

The “main” Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17  

4.4.4. Running the Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17  

4.4.5. Creating an Executable Jar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17  

 4.5. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19  

5. Upgrading Spring Boot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21  

5.1. Upgrading from 1.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21  

5.2. Upgrading to a new feature release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21  

5.3. Upgrading the Spring Boot CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21  

5.4. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21  

6. Developing with Spring Boot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23  

6.1. Build Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23  

6.1.1. Dependency Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23  

6.1.2. Maven . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
 

6.1.3. Gradle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
 

6.1.4. Ant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
 

6.1.5. Starters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
 

6.2. Structuring Your Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29  

6.2.1. Using the “default” Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29  

6.2.2. Locating the Main Application Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29  

6.3. Configuration Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30  

6.3.1. Importing Additional Configuration Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30  

6.3.2. Importing XML Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31  

6.4. Auto-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31  

6.4.1. Gradually Replacing Auto-configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31  

6.4.2. Disabling Specific Auto-configuration Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31  

6.5. Spring Beans and Dependency Injection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32  

6.6. Using the @SpringBootApplication Annotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33  

6.7. Running Your Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34  

6.7.1. Running from an IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35  

6.7.2. Running as a Packaged Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35  

6.7.3. Using the Maven Plugin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35  

6.7.4. Using the Gradle Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36  

6.7.5. Hot Swapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36  

6.8. Developer Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36  

6.8.1. Diagnosing Classloading Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37  

6.8.2. Property Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37  

6.8.3. Automatic Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38  

Logging changes in condition evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39  

Excluding Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39  

Watching Additional Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40  

Disabling Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40  

Using a Trigger File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41  

Customizing the Restart Classloader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41  

Known Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42  
 6.8.4. LiveReload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
 

6.8.5. Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

 

Configuring File System Watcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44  

6.8.6. Remote Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44  

Running the Remote Client Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45  

Remote Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
 

6.9. Packaging Your Application for Production. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47  

6.10. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47  

7. Core Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
 

7.1. SpringApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48  

7.1.1. Startup Failure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

 

7.1.2. Lazy Initialization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50  

7.1.3. Customizing the Banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51  

7.1.4. Customizing SpringApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52  

7.1.5. Fluent Builder API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53  

7.1.6. Application Availability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53  

Liveness State. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
 

Readiness State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
 

Managing the Application Availability State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54  

7.1.7. Application Events and Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56  

7.1.8. Web Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58  

7.1.9. Accessing Application Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58  

7.1.10. Using the ApplicationRunner or CommandLineRunner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59  

7.1.11. Application Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60  

7.1.12. Admin Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60  

7.1.13. Application Startup tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61  

7.2. Externalized Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61  

7.2.1. Accessing Command Line Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63  

7.2.2. JSON Application Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63  

7.2.3. External Application Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64  

Optional Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 

Wildcard Locations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66  

Profile Specific Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

 

Importing Additional Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68  

Importing Extensionless Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70  

Using Configuration Trees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70  

Property Placeholders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72  

Working with Multi-Document Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73  

Activation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74  

7.2.4. Encrypting Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75  

7.2.5. Working with YAML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75  

 Mapping YAML to Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75  

Directly Loading YAML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76  

7.2.6. Configuring Random Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76  

7.2.7. Configuring System Environment Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77  

7.2.8. Type-safe Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77  

JavaBean properties binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77  

Constructor binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79  

Enabling @ConfigurationProperties-annotated types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82  

Using @ConfigurationProperties-annotated types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83  

Third-party Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84  

Relaxed Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85  

Merging Complex Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87  

Properties Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90  

@ConfigurationProperties Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96  

@ConfigurationProperties vs. @Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99  

7.3. Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
 

7.3.1. Adding Active Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101  

7.3.2. Profile Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101  

7.3.3. Programmatically Setting Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102  

7.3.4. Profile-specific Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102  

7.4. Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

 

7.4.1. Log Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102  

7.4.2. Console Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103  

Color-coded Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104  

7.4.3. File Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 

7.4.4. File Rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 

7.4.5. Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

 

7.4.6. Log Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106  

7.4.7. Using a Log Shutdown Hook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107  

7.4.8. Custom Log Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107  

7.4.9. Logback Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110  

Profile-specific Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110  

Environment Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111  

7.5. Internationalization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111  

7.6. JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

 

7.6.1. Jackson . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

 

7.6.2. Gson . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

 

7.6.3. JSON-B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

 

7.7. Task Execution and Scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113  

7.8. Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

 

7.8.1. Test Scope Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114  

 7.8.2. Testing Spring Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115  

7.8.3. Testing Spring Boot Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115  

Detecting Web Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116  

Detecting Test Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117  

Excluding Test Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117  

Using Application Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118  

Testing with a mock environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119  

Testing with a running server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120  

Customizing WebTestClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122  

Using JMX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

 

Using Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

 

Mocking and Spying Beans. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123  

Auto-configured Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125  

Auto-configured JSON Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125  

Auto-configured Spring MVC Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127  

Auto-configured Spring WebFlux Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130  

Auto-configured Data Cassandra Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132  

Auto-configured Data JPA Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132  

Auto-configured JDBC Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134  

Auto-configured Data JDBC Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135  

Auto-configured jOOQ Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135  

Auto-configured Data MongoDB Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136  

Auto-configured Data Neo4j Tests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137  

Auto-configured Data Redis Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138  

Auto-configured Data LDAP Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139  

Auto-configured REST Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140  

Auto-configured Spring REST Docs Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141  

Auto-configured Spring Web Services Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147  

Additional Auto-configuration and Slicing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149  

User Configuration and Slicing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150  

Using Spock to Test Spring Boot Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152  

7.8.4. Test Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

 

ConfigDataApplicationContextInitializer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152  

TestPropertyValues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153  

OutputCapture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
 

TestRestTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 

7.9. Creating Your Own Auto-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156  

7.9.1. Understanding Auto-configured Beans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157  

7.9.2. Locating Auto-configuration Candidates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157  

7.9.3. Condition Annotations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157  

Class Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

 
 Bean Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159  

Property Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160  

Resource Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160  

Web Application Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161  

SpEL Expression Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161  

7.9.4. Testing your Auto-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161  

Simulating a Web Context. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163  

Overriding the Classpath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163  

7.9.5. Creating Your Own Starter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163  

Naming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
 

Configuration keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164  

The “autoconfigure” Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166  

Starter Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167  

7.10. Kotlin support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168  

7.10.1. Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168  

7.10.2. Null-safety . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168  

7.10.3. Kotlin API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169  

runApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169  

Extensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
 

7.10.4. Dependency management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169  

7.10.5. @ConfigurationProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170  

7.10.6. Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

 

7.10.7. Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171  

Further reading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171  

Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
 

7.11. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171  

8. Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
 

8.1. Servlet Web Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172  

8.1.1. The “Spring Web MVC Framework” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172  

Spring MVC Auto-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173  

HttpMessageConverters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174  

Custom JSON Serializers and Deserializers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175  

MessageCodesResolver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178  

Static Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

 

Welcome Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180  

Path Matching and Content Negotiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180  

ConfigurableWebBindingInitializer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183  

Template Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183  

Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183  

CORS Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188  

8.1.2. Embedded Servlet Container Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189  

 Servlets, Filters, and listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189  

Servlet Context Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190  

The ServletWebServerApplicationContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190  

Customizing Embedded Servlet Containers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191  

JSP Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194  

8.2. Reactive Web Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194  

8.2.1. The “Spring WebFlux Framework” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194  

Spring WebFlux Auto-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199  

HTTP Codecs with HttpMessageReaders and HttpMessageWriters . . . . . . . . . . . . . . . . . . . . . . 200  

Static Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 

Welcome Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201  

Template Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201  

Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202  

Web Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

 

8.2.2. Embedded Reactive Server Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205  

8.2.3. Reactive Server Resources Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205  

8.3. Graceful Shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206  

8.4. Spring Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207  

8.4.1. MVC Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207  

8.4.2. WebFlux Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208  

8.4.3. OAuth2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 

Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
 

Resource Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213  

Authorization Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215  

8.4.4. SAML 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215  

Relying Party . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215  

8.5. Spring Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217  

8.6. Spring HATEOAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219  

8.7. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219  

9. Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
 

9.1. SQL Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220  

9.1.1. Configure a DataSource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220  

Embedded Database Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220  

Connection to a Production Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221  

DataSource Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221  

Supported Connection Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222  

Connection to a JNDI DataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223  

9.1.2. Using JdbcTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223  

9.1.3. JPA and Spring Data JPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224  

Entity Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 

Spring Data JPA Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227  

 Spring Data Envers Repositories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227  

Creating and Dropping JPA Databases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228  

Open EntityManager in View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229  

9.1.4. Spring Data JDBC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229  

9.1.5. Using jOOQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229  

Code Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229  

Using DSLContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230  

jOOQ SQL Dialect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231  

Customizing jOOQ. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231  

9.1.6. Using R2DBC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232  

Embedded Database Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234  

Using DatabaseClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234  

Spring Data R2DBC Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235  

9.2. Working with NoSQL Technologies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235  

9.2.1. Redis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

 

Connecting to Redis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236  

9.2.2. MongoDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237  

Connecting to a MongoDB Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237  

MongoTemplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239  

Spring Data MongoDB Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239  

Embedded Mongo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240  

9.2.3. Neo4j . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

 

Connecting to a Neo4j Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241  

Spring Data Neo4j Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242  

9.2.4. Solr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

 

Connecting to Solr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243  

9.2.5. Elasticsearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244  

Connecting to Elasticsearch using REST clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244  

Connecting to Elasticsearch by Using Spring Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246  

Spring Data Elasticsearch Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247  

9.2.6. Cassandra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 

Connecting to Cassandra. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248  

Spring Data Cassandra Repositories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250  

9.2.7. Couchbase. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250  

Connecting to Couchbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250  

Spring Data Couchbase Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251  

9.2.8. LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

 

Connecting to an LDAP Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253  

Spring Data LDAP Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254  

Embedded In-memory LDAP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254  

9.2.9. InfluxDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

 
 Connecting to InfluxDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255  

9.3. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256  

10. Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257  

10.1. JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

 

10.1.1. ActiveMQ Artemis Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257  

10.1.2. Using a JNDI ConnectionFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258  

10.1.3. Sending a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259  

10.1.4. Receiving a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259  

10.2. AMQP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 

10.2.1. RabbitMQ support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262  

10.2.2. Sending a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263  

10.2.3. Sending a Message To A Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264  

10.2.4. Receiving a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264  

10.3. Apache Kafka Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267  

10.3.1. Sending a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267  

10.3.2. Receiving a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268  

10.3.3. Kafka Streams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269  

10.3.4. Additional Kafka Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270  

10.3.5. Testing with Embedded Kafka. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272  

10.4. RSocket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 

10.4.1. RSocket Strategies Auto-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273  

10.4.2. RSocket server Auto-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274  

10.4.3. Spring Messaging RSocket support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275  

10.4.4. Calling RSocket Services with RSocketRequester . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275  

10.5. Spring Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276  

10.6. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277  

11. IO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
 

11.1. Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 

11.1.1. Supported Cache Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279  

Generic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
 

JCache (JSR-107). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280  

Hazelcast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
 

Couchbase. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281  

Redis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
 

Caffeine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
 

Simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
 

None . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
 

11.2. Hazelcast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285  

11.3. Quartz Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286  

11.4. Sending Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288  

11.5. Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289  

 11.6. Calling REST Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290  

11.6.1. RestTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

 

RestTemplate Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291  

11.6.2. WebClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

 

WebClient Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294  

WebClient Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294  

11.7. Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

 

11.7.1. Calling Web Services with WebServiceTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295  

11.8. Distributed Transactions with JTA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297  

11.8.1. Using a Jakarta EE Managed Transaction Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297  

11.8.2. Mixing XA and Non-XA JMS Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297  

11.8.3. Supporting an Embedded Transaction Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298  

11.9. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298  

12. Container Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

 

12.1. Efficient container images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299  

12.1.1. Unpacking the fat jar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299  

12.1.2. Layering Docker Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299  

12.2. Dockerfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

 

12.3. Cloud Native Buildpacks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301  

12.4. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302  

13. Production-ready Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303  

13.1. Enabling Production-ready Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303  

13.2. Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

 

13.2.1. Enabling Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305  

13.2.2. Exposing Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306  

13.2.3. Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

 

Cross Site Request Forgery Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310  

13.2.4. Configuring Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310  

13.2.5. Hypermedia for Actuator Web Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311  

13.2.6. CORS Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 

13.2.7. Implementing Custom Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312  

Receiving Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

 

Custom Web Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313  

Servlet Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

 

Controller Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315  

13.2.8. Health Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315  

Auto-configured HealthIndicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316  

Writing Custom HealthIndicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317  

Reactive Health Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319  

Auto-configured ReactiveHealthIndicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320  

Health Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

 
 DataSource Health . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322  

13.2.9. Kubernetes Probes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323  

Checking External State with Kubernetes Probes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324  

Application Lifecycle and Probe States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325  

13.2.10. Application Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326  

Auto-configured InfoContributors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326  

Custom Application Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326  

Git Commit Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327  

Build Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328  

Java Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328  

OS Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328  

Writing Custom InfoContributors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328  

13.3. Monitoring and Management over HTTP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329  

13.3.1. Customizing the Management Endpoint Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329  

13.3.2. Customizing the Management Server Port. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330  

13.3.3. Configuring Management-specific SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331  

13.3.4. Customizing the Management Server Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332  

13.3.5. Disabling HTTP Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333  

13.4. Monitoring and Management over JMX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333  

13.4.1. Customizing MBean Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334  

13.4.2. Disabling JMX Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334  

13.5. Loggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

 

13.5.1. Configure a Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335  

13.6. Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

 

13.6.1. Getting started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336  

13.6.2. Supported Monitoring Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338  

AppOptics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
 

Atlas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
 

Datadog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
 

Dynatrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
 

Elastic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
 

Ganglia. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
 

Graphite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
 

Humio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
 

Influx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
 

JMX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
 

KairosDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
 

New Relic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

 

Prometheus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349  

SignalFx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
 

Simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
 
 Stackdriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
 

StatsD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
 

Wavefront. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
 

13.6.3. Supported Metrics and Meters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353  

JVM Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 

System Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353  

Application Startup Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354  

Logger Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354  

Task Execution and Scheduling Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354  

Spring MVC Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354  

Spring WebFlux Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355  

HTTP Client Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356  

Tomcat Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356  

Cache Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357  

DataSource Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357  

Spring Data Repository Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357  

RabbitMQ Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358  

Spring Integration Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358  

Kafka Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358 

MongoDB Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358  

Jetty Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

 

@Timed Annotation Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361  

Redis Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363 

13.6.4. Registering Custom Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363  

13.6.5. Customizing Individual Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364  

Common Tags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365  

Per-meter Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366  

13.6.6. Metrics Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366  

13.7. Auditing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

 

13.7.1. Custom Auditing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367  

13.8. HTTP Tracing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368  

13.8.1. Custom HTTP tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368  

13.9. Process Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368  

13.9.1. Extending Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368  

13.9.2. Programmatically Enabling Process Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368  

13.10. Cloud Foundry Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369  

13.10.1. Disabling Extended Cloud Foundry Actuator Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369  

13.10.2. Cloud Foundry Self-signed Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369  

13.10.3. Custom Context Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370  

13.11. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371  

14. Deploying Spring Boot Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372  

 14.1. Deploying to the Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372  

14.1.1. Cloud Foundry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372  

Binding to Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

 

14.1.2. Kubernetes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

 

Kubernetes Container Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375  

14.1.3. Heroku . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

 

14.1.4. OpenShift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

 

14.1.5. Amazon Web Services (AWS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378  

AWS Elastic Beanstalk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378  

Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
 

14.1.6. CloudCaptain and Amazon Web Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379  

14.1.7. Azure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

 

14.1.8. Google Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380 

14.2. Installing Spring Boot Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381  

14.2.1. Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382  

14.2.2. Unix/Linux Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382  

Installation as an init.d Service (System V). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382  

Installation as a systemd Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384  

Customizing the Startup Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385  

14.2.3. Microsoft Windows Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388  

14.3. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388  

15. Spring Boot CLI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

 

15.1. Installing the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389 

15.2. Using the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

 

15.2.1. Running Applications with the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390  

Deduced “grab” Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391  

Deduced “grab” Coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392  

Default Import Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392  

Automatic Main Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392  

Custom Dependency Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392  

15.2.2. Applications with Multiple Source Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393  

15.2.3. Packaging Your Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393  

15.2.4. Initialize a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393  

15.2.5. Using the Embedded Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394  

15.2.6. Adding Extensions to the CLI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395  

15.3. Developing Applications with the Groovy Beans DSL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395  

15.4. Configuring the CLI with settings.xml. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396  

15.5. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396  

16. Build Tool Plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

 

16.1. Spring Boot Maven Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398  

16.2. Spring Boot Gradle Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398  

 16.3. Spring Boot AntLib Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398  

16.3.1. Spring Boot Ant Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399  

Using the “exejar” Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399  

Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
 

16.3.2. Using the “findmainclass” Task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400  

Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
 

16.4. Supporting Other Build Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400  

16.4.1. Repackaging Archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401  

16.4.2. Nested Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401  

16.4.3. Finding a Main Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401  

16.4.4. Example Repackage Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401  

16.5. What to Read Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402  

17. “How-to” Guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

 

17.1. Spring Boot Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403  

17.1.1. Create Your Own FailureAnalyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403  

17.1.2. Troubleshoot Auto-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403  

17.1.3. Customize the Environment or ApplicationContext Before It Starts . . . . . . . . . . . . . . . . . 404  

17.1.4. Build an ApplicationContext Hierarchy (Adding a Parent or Root Context) . . . . . . . . . . 406  

17.1.5. Create a Non-web Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406  

17.2. Properties and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406  

17.2.1. Automatically Expand Properties at Build Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406  

Automatic Property Expansion Using Maven . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406  

Automatic Property Expansion Using Gradle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408  

17.2.2. Externalize the Configuration of SpringApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408  

17.2.3. Change the Location of External Properties of an Application . . . . . . . . . . . . . . . . . . . . . . 410  

17.2.4. Use ‘Short’ Command Line Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410  

17.2.5. Use YAML for External Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411  

17.2.6. Set the Active Spring Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412  

17.2.7. Set the Default Profile Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412  

17.2.8. Change Configuration Depending on the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413  

17.2.9. Discover Built-in Options for External Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414  

17.3. Embedded Web Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414  

17.3.1. Use Another Web Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414  

17.3.2. Disabling the Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415  

17.3.3. Change the HTTP Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416  

17.3.4. Use a Random Unassigned HTTP Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416  

17.3.5. Discover the HTTP Port at Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416  

17.3.6. Enable HTTP Response Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417  

17.3.7. Configure SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418  

17.3.8. Configure HTTP/2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418  

HTTP/2 with Tomcat. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418  

 HTTP/2 with Jetty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
 

HTTP/2 with Reactor Netty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419  

HTTP/2 with Undertow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419  

17.3.9. Configure the Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419  

17.3.10. Add a Servlet, Filter, or Listener to an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421  

Add a Servlet, Filter, or Listener by Using a Spring Bean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421  

Add Servlets, Filters, and Listeners by Using Classpath Scanning . . . . . . . . . . . . . . . . . . . . . . . 422  

17.3.11. Configure Access Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422  

17.3.12. Running Behind a Front-end Proxy Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423  

Customize Tomcat’s Proxy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424  

17.3.13. Enable Multiple Connectors with Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425  

17.3.14. Use Tomcat’s LegacyCookieProcessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426  

17.3.15. Enable Tomcat’s MBean Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426  

17.3.16. Enable Multiple Listeners with Undertow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427  

17.3.17. Create WebSocket Endpoints Using @ServerEndpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427  

17.4. Spring MVC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

 

17.4.1. Write a JSON REST Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428  

17.4.2. Write an XML REST Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429  

17.4.3. Customize the Jackson ObjectMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429  

17.4.4. Customize the @ResponseBody Rendering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431  

17.4.5. Handling Multipart File Uploads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431  

17.4.6. Switch Off the Spring MVC DispatcherServlet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432  

17.4.7. Switch off the Default MVC Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432  

17.4.8. Customize ViewResolvers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432  

17.5. HTTP Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

 

17.5.1. Configure RestTemplate to Use a Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434  

17.5.2. Configure the TcpClient used by a Reactor Netty-based WebClient . . . . . . . . . . . . . . . . . . 434  

17.6. Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

 

17.6.1. Configure Logback for Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436  

Configure Logback for File-only Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437  

17.6.2. Configure Log4j for Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437  

Use YAML or JSON to Configure Log4j 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439  

Use Composite Configuration to Configure Log4j 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439  

17.7. Data Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

 

17.7.1. Configure a Custom DataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439  

17.7.2. Configure Two DataSources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444  

17.7.3. Use Spring Data Repositories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448  

17.7.4. Separate @Entity Definitions from Spring Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 448  

17.7.5. Configure JPA Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448  

17.7.6. Configure Hibernate Naming Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449  

17.7.7. Configure Hibernate Second-Level Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451  

 17.7.8. Use Dependency Injection in Hibernate Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452  

17.7.9. Use a Custom EntityManagerFactory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452  

17.7.10. Using Multiple EntityManagerFactories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452  

17.7.11. Use a Traditional persistence.xml File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454  

17.7.12. Use Spring Data JPA and Mongo Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455  

17.7.13. Customize Spring Data’s Web Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455  

17.7.14. Expose Spring Data Repositories as REST Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455  

17.7.15. Configure a Component that is Used by JPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455  

17.7.16. Configure jOOQ with Two DataSources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456  

17.8. Database Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456  

17.8.1. Initialize a Database Using JPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456  

17.8.2. Initialize a Database Using Hibernate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456  

17.8.3. Initialize a Database Using Basic SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457  

17.8.4. Initialize a Spring Batch Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458  

17.8.5. Use a Higher-level Database Migration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458  

Execute Flyway Database Migrations on Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458  

Execute Liquibase Database Migrations on Startup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460  

17.8.6. Depend Upon an Initialized Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460  

Detect a Database Initializer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461  

Detect a Bean That Depends On Database Initialization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461  

17.9. Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

 

17.9.1. Disable Transacted JMS Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461  

17.10. Batch Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462  

17.10.1. Specifying a Batch Data Source. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462  

17.10.2. Running Spring Batch Jobs on Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462  

17.10.3. Running from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463  

17.10.4. Storing the Job Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463  

17.11. Actuator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

 

17.11.1. Change the HTTP Port or Address of the Actuator Endpoints . . . . . . . . . . . . . . . . . . . . . . 463  

17.11.2. Customize the ‘whitelabel’ Error Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463  

17.11.3. Sanitize Sensitive Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464  

17.11.4. Map Health Indicators to Micrometer Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465  

17.12. Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

 

17.12.1. Switch off the Spring Boot Security Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466  

17.12.2. Change the UserDetailsService and Add User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . 466  

17.12.3. Enable HTTPS When Running behind a Proxy Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466  

17.13. Hot Swapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467 

17.13.1. Reload Static Content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467  

17.13.2. Reload Templates without Restarting the Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467  

Thymeleaf Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468  

FreeMarker Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468  

 Groovy Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468  

17.13.3. Fast Application Restarts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468  

17.13.4. Reload Java Classes without Restarting the Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468  

17.14. Testing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

 

17.14.1. Testing With Spring Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468  

17.14.2. Use Testcontainers for Integration Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469  

17.15. Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

 

17.15.1. Generate Build Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471  

17.15.2. Generate Git Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472  

17.15.3. Customize Dependency Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473  

17.15.4. Create an Executable JAR with Maven . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473  

17.15.5. Use a Spring Boot Application as a Dependency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474  

17.15.6. Extract Specific Libraries When an Executable Jar Runs . . . . . . . . . . . . . . . . . . . . . . . . . . 475  

17.15.7. Create a Non-executable JAR with Exclusions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476  

17.15.8. Remote Debug a Spring Boot Application Started with Maven. . . . . . . . . . . . . . . . . . . . . 476  

17.15.9. Build an Executable Archive from Ant without Using spring-boot-antlib . . . . . . . . . . . 476  

17.16. Traditional Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477  

17.16.1. Create a Deployable War File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478  

17.16.2. Convert an Existing Application to Spring Boot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479  

17.16.3. Deploying a WAR to WebLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482  

Appendices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
 

Appendix A: Common Application Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485  

A.1. Core Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 

A.2. Cache Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493  

A.3. Mail Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

 

A.4. JSON Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495  

A.5. Data Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497 

A.6. Transaction Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520  

A.7. Data Migration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522  

A.8. Integration Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529  

A.9. Web Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548 

A.10. Templating Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556  

A.11. Server Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562  

A.12. Security Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574  

A.13. RSocket Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575  

A.14. Actuator Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576  

A.15. Devtools Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602  

A.16. Testing Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603  

Appendix B: Configuration Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605  

B.1. Metadata Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605  

B.1.1. Group Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607  

 B.1.2. Property Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607  

B.1.3. Hint Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610  

B.1.4. Repeated Metadata Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611  

B.2. Providing Manual Hints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612  

B.2.1. Value Hint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612  

B.2.2. Value Providers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613  

Any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
 

Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614  

Handle As . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
 

Logger Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616  

Spring Bean Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618  

Spring Profile Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618  

B.3. Generating Your Own Metadata by Using the Annotation Processor . . . . . . . . . . . . . . . . . . . . . 619  

B.3.1. Configuring the Annotation Processor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619  

B.3.2. Automatic Metadata Generation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620  

Nested Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624  

B.3.3. Adding Additional Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626  

Appendix C: Auto-configuration Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627  

C.1. spring-boot-autoconfigure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627  

C.2. spring-boot-actuator-autoconfigure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631  

Appendix D: Test Auto-configuration Annotations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635  

D.1. Test Slices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635

 

Appendix E: The Executable Jar Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643  

E.1. Nested JARs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643  

E.1.1. The Executable Jar File Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643  

E.1.2. The Executable War File Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644  

E.1.3. Index Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644  

E.1.4. Classpath Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644  

E.1.5. Layer Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645  

E.2. Spring Boot’s “JarFile” Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645  

E.2.1. Compatibility with the Standard Java “JarFile” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646  

E.3. Launching Executable Jars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646  

E.3.1. Launcher Manifest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646  

E.4. PropertiesLauncher Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647  

E.5. Executable Jar Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648  

E.6. Alternative Single Jar Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649  

Appendix F: Dependency Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650  

F.1. Managed Dependency Coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650  

F.2. Version Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676  

This document is also available as multiple HTML pages and as a single HTML
page.

1
Chapter 1. Legal
Copyright © 2012-2022

Copies of this document may be made for your own use and for distribution to others, provided
that you do not charge any fee for such copies and further provided that each copy contains this
Copyright Notice, whether distributed in print or electronically.

2
Chapter 2. Getting Help
If you have trouble with Spring Boot, we would like to help.

• Try the How-to documents. They provide solutions to the most common questions.

• Learn the Spring basics. Spring Boot builds on many other Spring projects. Check the spring.io
web-site for a wealth of reference documentation. If you are starting out with Spring, try one of
the guides.

• Ask a question. We monitor stackoverflow.com for questions tagged with spring-boot.

• Report bugs with Spring Boot at github.com/spring-projects/spring-boot/issues.

All of Spring Boot is open source, including the documentation. If you find problems
NOTE
with the docs or if you want to improve them, please get involved.

3
Chapter 3. Documentation Overview
This section provides a brief overview of Spring Boot reference documentation. It serves as a map
for the rest of the document.

The latest copy of this document is available at docs.spring.io/spring-boot/docs/current/reference/.

3.1. First Steps

If you are getting started with Spring Boot or 'Spring' in general, start with the following topics:

• From scratch: Overview | Requirements | Installation

• Tutorial: Part 1 | Part 2

• Running your example: Part 1 | Part 2

3.2. Upgrading From an Earlier Version

You should always ensure that you are running a supported version of Spring Boot.

Depending on the version that you are upgrading to, you can find some additional tips here:

• From 1.x: Upgrading from 1.x

• To a new feature release: Upgrading to New Feature Release

• Spring Boot CLI: Upgrading the Spring Boot CLI

3.3. Developing with Spring Boot

Ready to actually start using Spring Boot? We have you covered:

• Build systems: Maven | Gradle | Ant | Starters

• Best practices: Code Structure | @Configuration | @EnableAutoConfiguration | Beans and

Dependency Injection

• Running your code: IDE | Packaged | Maven | Gradle

• Packaging your app: Production jars

• Spring Boot CLI: Using the CLI

3.4. Learning About Spring Boot Features

Need more details about Spring Boot’s core features? The following content is for you:

• Spring Application: SpringApplication

• External Configuration: External Configuration

• Profiles: Profiles

4
 • Logging: Logging

3.5. Web
If you develop Spring Boot web applications, take a look at the following content:

• Servlet Web Applications: Spring MVC, Embedded Servlet Containers

• Reactive Web Applications: Spring Webflux, Embedded Servlet Containers

• Graceful Shutdown: Graceful Shutdown

• Spring Security: Default Security Configuration, Auto-configuration for OAuth2, SAML

• Spring Session: Auto-configuration for Spring Session

• Spring HATEOAS: Auto-configuration for Spring HATEOAS

3.6. Data
If your application deals with a datastore, you can see how to configure that here:

• SQL: Configuring a SQL Datastore, Embedded Database support, Connection pools, and more.

• NOSQL: Auto-configuration for NOSQL stores such as Redis, MongoDB, Neo4j, and others.

3.7. Messaging
If your application uses any messaging protocol, see one or more of the following sections:

• JMS: Auto-configuration for ActiveMQ and Artemis, Sending and Receiving messages through
JMS

• AMQP: Auto-configuration for RabbitMQ

• Kafka: Auto-configuration for Spring Kafka

• RSocket: Auto-configuration for Spring Framework’s RSocket Support

• Spring Integration: Auto-configuration for Spring Integration

3.8. IO
If your application needs IO capabilities, see one or more of the following sections:

• Caching: Caching support with Hazelcast and more

• Quartz: Quartz Scheduling

• Mail: Sending Email

• Validation: JSR-303 Validation

• REST Clients: Calling REST Services with RestTemplate and WebClient

• Webservices: Auto-configuration for Spring Web Services

5
 • JTA: Distributed Transactions with JTA

3.9. Container Images

Spring Boot provides first-class support for building efficient container images. You can read more
about it here:

• Efficient Container Images: Tips to optimize container images such as Docker images

• Dockerfiles: Building container images using dockerfiles

• Cloud Native Buildpacks: Support for Cloud Native Buildpacks with Maven and Gradle

3.10. Advanced Topics

Finally, we have a few topics for more advanced users:

• Spring Boot Applications Deployment: Cloud Deployment | OS Service

• Build tool plugins: Maven | Gradle

• Appendix: Application Properties | Configuration Metadata | Auto-configuration Classes | Test

Auto-configuration Annotations | Executable Jars | Dependency Versions

6
Chapter 4. Getting Started
If you are getting started with Spring Boot, or “Spring” in general, start by reading this section. It
answers the basic “what?”, “how?” and “why?” questions. It includes an introduction to Spring
Boot, along with installation instructions. We then walk you through building your first Spring Boot
application, discussing some core principles as we go.

4.1. Introducing Spring Boot

Spring Boot helps you to create stand-alone, production-grade Spring-based applications that you
can run. We take an opinionated view of the Spring platform and third-party libraries, so that you
can get started with minimum fuss. Most Spring Boot applications need very little Spring
configuration.

You can use Spring Boot to create Java applications that can be started by using java -jar or more
traditional war deployments. We also provide a command line tool that runs “spring scripts”.

Our primary goals are:

• Provide a radically faster and widely accessible getting-started experience for all Spring
development.

• Be opinionated out of the box but get out of the way quickly as requirements start to diverge
from the defaults.

• Provide a range of non-functional features that are common to large classes of projects (such as
embedded servers, security, metrics, health checks, and externalized configuration).

• Absolutely no code generation and no requirement for XML configuration.

4.2. System Requirements

Spring Boot 3.0.0-SNAPSHOT requires Java 17. Spring Framework 6.0.0-M2 or above is also
required.

Explicit build support is provided for the following build tools:

Build Tool Version

Maven 3.5+

Gradle 7.x (7.3 or later)

4.2.1. Servlet Containers

Spring Boot supports the following embedded servlet containers:

Name Servlet Version

Tomcat 10.0 5.0

7
Name Servlet Version

Jetty 11.0 5.1

Undertow 2.2 (Jakarta EE 9 variant) 5.0

You can also deploy Spring Boot applications to any servlet 5.0+ compatible container.

4.3. Installing Spring Boot

Spring Boot can be used with “classic” Java development tools or installed as a command line tool.
Either way, you need Java SDK v1.8 or higher. Before you begin, you should check your current Java
installation by using the following command:

$ java -version

If you are new to Java development or if you want to experiment with Spring Boot, you might want
to try the Spring Boot CLI (Command Line Interface) first. Otherwise, read on for “classic”
installation instructions.

4.3.1. Installation Instructions for the Java Developer

You can use Spring Boot in the same way as any standard Java library. To do so, include the
appropriate spring-boot-*.jar files on your classpath. Spring Boot does not require any special
tools integration, so you can use any IDE or text editor. Also, there is nothing special about a Spring
Boot application, so you can run and debug a Spring Boot application as you would any other Java
program.

Although you could copy Spring Boot jars, we generally recommend that you use a build tool that
supports dependency management (such as Maven or Gradle).

Maven Installation

Spring Boot is compatible with Apache Maven 3.3 or above. If you do not already have Maven
installed, you can follow the instructions at maven.apache.org.

On many operating systems, Maven can be installed with a package manager. If you
use OSX Homebrew, try brew install maven. Ubuntu users can run sudo apt-get
TIP
install maven. Windows users with Chocolatey can run choco install maven from an
elevated (administrator) prompt.

Spring Boot dependencies use the org.springframework.boot groupId. Typically, your Maven POM file
inherits from the spring-boot-starter-parent project and declares dependencies to one or more
“Starters”. Spring Boot also provides an optional Maven plugin to create executable jars.

More details on getting started with Spring Boot and Maven can be found in the Getting Started
section of the Maven plugin’s reference guide.

8
Gradle Installation

Spring Boot is compatible with Gradle 7.x (7.3 or later). If you do not already have Gradle installed,
you can follow the instructions at gradle.org.

Spring Boot dependencies can be declared by using the org.springframework.boot group. Typically,
your project declares dependencies to one or more “Starters”. Spring Boot provides a useful Gradle
plugin that can be used to simplify dependency declarations and to create executable jars.

Gradle Wrapper

The Gradle Wrapper provides a nice way of “obtaining” Gradle when you need to build a
project. It is a small script and library that you commit alongside your code to bootstrap the
build process. See docs.gradle.org/current/userguide/gradle_wrapper.html for details.

More details on getting started with Spring Boot and Gradle can be found in the Getting Started
section of the Gradle plugin’s reference guide.

4.3.2. Installing the Spring Boot CLI

The Spring Boot CLI (Command Line Interface) is a command line tool that you can use to quickly
prototype with Spring. It lets you run Groovy scripts, which means that you have a familiar Java-
like syntax without so much boilerplate code.

You do not need to use the CLI to work with Spring Boot, but it is a quick way to get a Spring
application off the ground without an IDE.

Manual Installation

You can download the Spring CLI distribution from the Spring software repository:

• spring-boot-cli-3.0.0-SNAPSHOT-bin.zip

• spring-boot-cli-3.0.0-SNAPSHOT-bin.tar.gz

Cutting edge snapshot distributions are also available.

Once downloaded, follow the INSTALL.txt instructions from the unpacked archive. In summary,
there is a spring script (spring.bat for Windows) in a bin/ directory in the .zip file. Alternatively,
you can use java -jar with the .jar file (the script helps you to be sure that the classpath is set
correctly).

Installation with SDKMAN!

SDKMAN! (The Software Development Kit Manager) can be used for managing multiple versions of
various binary SDKs, including Groovy and the Spring Boot CLI. Get SDKMAN! from sdkman.io and
install Spring Boot by using the following commands:

9
 $ sdk install springboot
$ spring --version
Spring CLI v3.0.0-SNAPSHOT

If you develop features for the CLI and want access to the version you built, use the following
commands:

$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-

cli-3.0.0-SNAPSHOT-bin/spring-3.0.0-SNAPSHOT/
$ sdk default springboot dev
$ spring --version
Spring CLI v3.0.0-SNAPSHOT

The preceding instructions install a local instance of spring called the dev instance. It points at your
target build location, so every time you rebuild Spring Boot, spring is up-to-date.

You can see it by running the following command:

$ sdk ls springboot

================================================================================
Available Springboot Versions
================================================================================
> + dev
* 3.0.0-SNAPSHOT

================================================================================
+ - local version
* - installed
> - currently in use
================================================================================

OSX Homebrew Installation

If you are on a Mac and use Homebrew, you can install the Spring Boot CLI by using the following
commands:

$ brew tap spring-io/tap

$ brew install spring-boot

Homebrew installs spring to /usr/local/bin.

If you do not see the formula, your installation of brew might be out-of-date. In that
NOTE
case, run brew update and try again.

10
MacPorts Installation

If you are on a Mac and use MacPorts, you can install the Spring Boot CLI by using the following
command:

$ sudo port install spring-boot-cli

Command-line Completion

The Spring Boot CLI includes scripts that provide command completion for the BASH and zsh shells.
You can source the script (also named spring) in any shell or put it in your personal or system-wide
bash completion initialization. On a Debian system, the system-wide scripts are in /shell-
completion/bash and all scripts in that directory are executed when a new shell starts. For example,
to run the script manually if you have installed by using SDKMAN!, use the following commands:

$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring
$ spring <HIT TAB HERE>
  grab help jar run test version

If you install the Spring Boot CLI by using Homebrew or MacPorts, the command-
NOTE
line completion scripts are automatically registered with your shell.

Windows Scoop Installation

If you are on a Windows and use Scoop, you can install the Spring Boot CLI by using the following
commands:

> scoop bucket add extras

> scoop install springboot

Scoop installs spring to ~/scoop/apps/springboot/current/bin.

If you do not see the app manifest, your installation of scoop might be out-of-date.
NOTE
In that case, run scoop update and try again.

Quick-start Spring CLI Example

You can use the following web application to test your installation. To start, create a file called
app.groovy, as follows:

11
 @RestController
class ThisWillActuallyRun {

  @RequestMapping("/")
  String home() {
  "Hello World!"
  }

Then run it from a shell, as follows:

$ spring run app.groovy

The first run of your application is slow, as dependencies are downloaded.

NOTE
Subsequent runs are much quicker.

Open localhost:8080 in your favorite web browser. You should see the following output:

Hello World!

4.4. Developing Your First Spring Boot Application

This section describes how to develop a small “Hello World!” web application that highlights some
of Spring Boot’s key features. We use Maven to build this project, since most IDEs support it.

The spring.io web site contains many “Getting Started” guides that use Spring Boot. If
you need to solve a specific problem, check there first.

TIP You can shortcut the steps below by going to start.spring.io and choosing the "Web"
starter from the dependencies searcher. Doing so generates a new project structure so
that you can start coding right away. Check the start.spring.io user guide for more
details.

Before we begin, open a terminal and run the following commands to ensure that you have valid
versions of Java and Maven installed:

$ java -version
java version "1.8.0_102"
Java(TM) SE Runtime Environment (build 1.8.0_102-b14)
Java HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)

12
 $ mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T14:33:14-
04:00)
Maven home: /usr/local/Cellar/maven/3.3.9/libexec
Java version: 1.8.0_102, vendor: Oracle Corporation

This sample needs to be created in its own directory. Subsequent instructions

NOTE assume that you have created a suitable directory and that it is your current
directory.

4.4.1. Creating the POM

We need to start by creating a Maven pom.xml file. The pom.xml is the recipe that is used to build your
project. Open your favorite text editor and add the following:

13
 <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example</groupId>
  <artifactId>myproject</artifactId>
  <version>0.0.1-SNAPSHOT</version>

  <parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>3.0.0-SNAPSHOT</version>
  </parent>

  <!-- Additional lines to be added here... -->

  <!-- (you do not need this if you are using a .RELEASE version) -->
  <repositories>
  <repository>
  <id>spring-snapshots</id>
  <url>https://repo.spring.io/snapshot</url>
  <snapshots><enabled>true</enabled></snapshots>
  </repository>
  <repository>
  <id>spring-milestones</id>
  <url>https://repo.spring.io/milestone</url>
  </repository>
  </repositories>
  <pluginRepositories>
  <pluginRepository>
  <id>spring-snapshots</id>
  <url>https://repo.spring.io/snapshot</url>
  </pluginRepository>
  <pluginRepository>
  <id>spring-milestones</id>
  <url>https://repo.spring.io/milestone</url>
  </pluginRepository>
  </pluginRepositories>
</project>

The preceding listing should give you a working build. You can test it by running mvn package (for
now, you can ignore the “jar will be empty - no content was marked for inclusion!” warning).

At this point, you could import the project into an IDE (most modern Java IDEs
NOTE include built-in support for Maven). For simplicity, we continue to use a plain text
editor for this example.

14
4.4.2. Adding Classpath Dependencies

Spring Boot provides a number of “Starters” that let you add jars to your classpath. Our
applications for smoke tests use the spring-boot-starter-parent in the parent section of the POM.
The spring-boot-starter-parent is a special starter that provides useful Maven defaults. It also
provides a dependency-management section so that you can omit version tags for “blessed”
dependencies.

Other “Starters” provide dependencies that you are likely to need when developing a specific type
of application. Since we are developing a web application, we add a spring-boot-starter-web
dependency. Before that, we can look at what we currently have by running the following
command:

$ mvn dependency:tree

[INFO] com.example:myproject:jar:0.0.1-SNAPSHOT

The mvn dependency:tree command prints a tree representation of your project dependencies. You
can see that spring-boot-starter-parent provides no dependencies by itself. To add the necessary
dependencies, edit your pom.xml and add the spring-boot-starter-web dependency immediately
below the parent section:

<dependencies>
  <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
</dependencies>

If you run mvn dependency:tree again, you see that there are now a number of additional
dependencies, including the Tomcat web server and Spring Boot itself.

4.4.3. Writing the Code

To finish our application, we need to create a single Java file. By default, Maven compiles sources
from src/main/java, so you need to create that directory structure and then add a file named
src/main/java/MyApplication.java to contain the following code:

15
 import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@EnableAutoConfiguration
public class MyApplication {

  @RequestMapping("/")
  String home() {
  return "Hello World!";
  }

  public static void main(String[] args) {

  SpringApplication.run(MyApplication.class, args);
  }

Although there is not much code here, quite a lot is going on. We step through the important parts
in the next few sections.

The @RestController and @RequestMapping Annotations

The first annotation on our MyApplication class is @RestController. This is known as a stereotype
annotation. It provides hints for people reading the code and for Spring that the class plays a
specific role. In this case, our class is a web @Controller, so Spring considers it when handling
incoming web requests.

The @RequestMapping annotation provides “routing” information. It tells Spring that any HTTP
request with the / path should be mapped to the home method. The @RestController annotation tells
Spring to render the resulting string directly back to the caller.

The @RestController and @RequestMapping annotations are Spring MVC annotations

TIP (they are not specific to Spring Boot). See the MVC section in the Spring Reference
Documentation for more details.

The @EnableAutoConfiguration Annotation

The second class-level annotation is @EnableAutoConfiguration. This annotation tells Spring Boot to
“guess” how you want to configure Spring, based on the jar dependencies that you have added.
Since spring-boot-starter-web added Tomcat and Spring MVC, the auto-configuration assumes that
you are developing a web application and sets up Spring accordingly.

16
 Starters and Auto-configuration

Auto-configuration is designed to work well with “Starters”, but the two concepts are not
directly tied. You are free to pick and choose jar dependencies outside of the starters. Spring
Boot still does its best to auto-configure your application.

The “main” Method

The final part of our application is the main method. This is a standard method that follows the Java
convention for an application entry point. Our main method delegates to Spring Boot’s
SpringApplication class by calling run. SpringApplication bootstraps our application, starting Spring,
which, in turn, starts the auto-configured Tomcat web server. We need to pass MyApplication.class
as an argument to the run method to tell SpringApplication which is the primary Spring component.
The args array is also passed through to expose any command-line arguments.

4.4.4. Running the Example

At this point, your application should work. Since you used the spring-boot-starter-parent POM,
you have a useful run goal that you can use to start the application. Type mvn spring-boot:run from
the root project directory to start the application. You should see output similar to the following:

$ mvn spring-boot:run

  . ____ _ __ _ _
 /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/ ___)| |_)| | | | | || (_| | ) ) ) )
  ' |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot :: (v3.0.0-SNAPSHOT)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.222 seconds (JVM running for 6.514)

If you open a web browser to localhost:8080, you should see the following output:

Hello World!

To gracefully exit the application, press ctrl-c.

4.4.5. Creating an Executable Jar

We finish our example by creating a completely self-contained executable jar file that we could run
in production. Executable jars (sometimes called “fat jars”) are archives containing your compiled
classes along with all of the jar dependencies that your code needs to run.

17
 Executable jars and Java

Java does not provide a standard way to load nested jar files (jar files that are themselves
contained within a jar). This can be problematic if you are looking to distribute a self-
contained application.

To solve this problem, many developers use “uber” jars. An uber jar packages all the classes
from all the application’s dependencies into a single archive. The problem with this approach
is that it becomes hard to see which libraries are in your application. It can also be
problematic if the same filename is used (but with different content) in multiple jars.

Spring Boot takes a different approach and lets you actually nest jars directly.

To create an executable jar, we need to add the spring-boot-maven-plugin to our pom.xml. To do so,
insert the following lines just below the dependencies section:

<build>
  <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  </plugin>
  </plugins>
</build>

The spring-boot-starter-parent POM includes <executions> configuration to bind

NOTE the repackage goal. If you do not use the parent POM, you need to declare this
configuration yourself. See the plugin documentation for details.

Save your pom.xml and run mvn package from the command line, as follows:

18
 $ mvn package

[INFO] Scanning for projects...

[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building myproject 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] .... ..
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ myproject ---
[INFO] Building jar: /Users/developer/example/spring-boot-example/target/myproject-
0.0.1-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:3.0.0-SNAPSHOT:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

If you look in the target directory, you should see myproject-0.0.1-SNAPSHOT.jar. The file should be
around 10 MB in size. If you want to peek inside, you can use jar tvf, as follows:

$ jar tvf target/myproject-0.0.1-SNAPSHOT.jar

You should also see a much smaller file named myproject-0.0.1-SNAPSHOT.jar.original in the target
directory. This is the original jar file that Maven created before it was repackaged by Spring Boot.

To run that application, use the java -jar command, as follows:

$ java -jar target/myproject-0.0.1-SNAPSHOT.jar

  . ____ _ __ _ _
 /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/ ___)| |_)| | | | | || (_| | ) ) ) )
  ' |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot :: (v3.0.0-SNAPSHOT)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.536 seconds (JVM running for 2.864)

As before, to exit the application, press ctrl-c.

4.5. What to Read Next

Hopefully, this section provided some of the Spring Boot basics and got you on your way to writing

19
your own applications. If you are a task-oriented type of developer, you might want to jump over to
spring.io and follow some of the getting started guides that solve specific “How do I do that with
Spring?” problems. We also have Spring Boot-specific “How-to” reference documentation.

Otherwise, the next logical step is to read Developing with Spring Boot. If you are really impatient,
you could also jump ahead and read about Spring Boot features.

20
Chapter 5. Upgrading Spring Boot
Instructions for how to upgrade from earlier versions of Spring Boot are provided on the project
wiki. Follow the links in the release notes section to find the version that you want to upgrade to.

Upgrading instructions are always the first item in the release notes. If you are more than one
release behind, please make sure that you also review the release notes of the versions that you
jumped.

5.1. Upgrading from 1.x

If you are upgrading from the 1.x release of Spring Boot, check the “migration guide” on the project
wiki that provides detailed upgrade instructions. Check also the “release notes” for a list of “new
and noteworthy” features for each release.

5.2. Upgrading to a new feature release

When upgrading to a new feature release, some properties may have been renamed or removed.
Spring Boot provides a way to analyze your application’s environment and print diagnostics at
startup, but also temporarily migrate properties at runtime for you. To enable that feature, add the
following dependency to your project:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-properties-migrator</artifactId>
  <scope>runtime</scope>
</dependency>

Properties that are added late to the environment, such as when using
WARNING
@PropertySource, will not be taken into account.

Once you finish the migration, please make sure to remove this module from your
NOTE
project’s dependencies.

5.3. Upgrading the Spring Boot CLI

To upgrade an existing CLI installation, use the appropriate package manager command (for
example, brew upgrade). If you manually installed the CLI, follow the standard instructions,
remembering to update your PATH environment variable to remove any older references.

5.4. What to Read Next

Once you’ve decided to upgrade your application, you can find detailed information regarding
specific features in the rest of the document.

21
Spring Boot’s documentation is specific to that version, so any information that you find in here
will contain the most up-to-date changes that are in that version.

22
Chapter 6. Developing with Spring Boot
This section goes into more detail about how you should use Spring Boot. It covers topics such as
build systems, auto-configuration, and how to run your applications. We also cover some Spring
Boot best practices. Although there is nothing particularly special about Spring Boot (it is just
another library that you can consume), there are a few recommendations that, when followed,
make your development process a little easier.

If you are starting out with Spring Boot, you should probably read the Getting Started guide before
diving into this section.

6.1. Build Systems

It is strongly recommended that you choose a build system that supports dependency management
and that can consume artifacts published to the “Maven Central” repository. We would recommend
that you choose Maven or Gradle. It is possible to get Spring Boot to work with other build systems
(Ant, for example), but they are not particularly well supported.

6.1.1. Dependency Management

Each release of Spring Boot provides a curated list of dependencies that it supports. In practice, you
do not need to provide a version for any of these dependencies in your build configuration, as
Spring Boot manages that for you. When you upgrade Spring Boot itself, these dependencies are
upgraded as well in a consistent way.

You can still specify a version and override Spring Boot’s recommendations if you
NOTE
need to do so.

The curated list contains all the Spring modules that you can use with Spring Boot as well as a
refined list of third party libraries. The list is available as a standard Bills of Materials (spring-boot-
dependencies) that can be used with both Maven and Gradle.

Each release of Spring Boot is associated with a base version of the Spring
WARNING
Framework. We highly recommend that you not specify its version.

6.1.2. Maven

To learn about using Spring Boot with Maven, see the documentation for Spring Boot’s Maven
plugin:

• Reference (HTML and PDF)

• API

6.1.3. Gradle

To learn about using Spring Boot with Gradle, see the documentation for Spring Boot’s Gradle
plugin:

23
 • Reference (HTML and PDF)

• API

6.1.4. Ant

It is possible to build a Spring Boot project using Apache Ant+Ivy. The spring-boot-antlib “AntLib”
module is also available to help Ant create executable jars.

To declare dependencies, a typical ivy.xml file looks something like the following example:

<ivy-module version="2.0">
  <info organisation="org.springframework.boot" module="spring-boot-sample-ant" />
  <configurations>
  <conf name="compile" description="everything needed to compile this module" />
  <conf name="runtime" extends="compile" description="everything needed to run
this module" />
  </configurations>
  <dependencies>
  <dependency org="org.springframework.boot" name="spring-boot-starter"
  rev="${spring-boot.version}" conf="compile" />
  </dependencies>
</ivy-module>

A typical build.xml looks like the following example:

24
 <project
  xmlns:ivy="antlib:org.apache.ivy.ant"
  xmlns:spring-boot="antlib:org.springframework.boot.ant"
  name="myapp" default="build">

  <property name="spring-boot.version" value="3.0.0-SNAPSHOT" />

  <target name="resolve" description="--> retrieve dependencies with ivy">

  <ivy:retrieve pattern="lib/[conf]/[artifact]-[type]-[revision].[ext]" />
  </target>

  <target name="classpaths" depends="resolve">

  <path id="compile.classpath">
  <fileset dir="lib/compile" includes="*.jar" />
  </path>
  </target>

  <target name="init" depends="classpaths">

  <mkdir dir="build/classes" />
  </target>

  <target name="compile" depends="init" description="compile">

  <javac srcdir="src/main/java" destdir="build/classes"
classpathref="compile.classpath" />
  </target>

  <target name="build" depends="compile">

  <spring-boot:exejar destfile="build/myapp.jar" classes="build/classes">
  <spring-boot:lib>
  <fileset dir="lib/runtime" />
  </spring-boot:lib>
  </spring-boot:exejar>
  </target>
</project>

If you do not want to use the spring-boot-antlib module, see the Build an Executable
TIP
Archive from Ant without Using spring-boot-antlib “How-to” .

6.1.5. Starters

Starters are a set of convenient dependency descriptors that you can include in your application.
You get a one-stop shop for all the Spring and related technologies that you need without having to
hunt through sample code and copy-paste loads of dependency descriptors. For example, if you
want to get started using Spring and JPA for database access, include the spring-boot-starter-data-
jpa dependency in your project.

The starters contain a lot of the dependencies that you need to get a project up and running quickly
and with a consistent, supported set of managed transitive dependencies.

25
 What is in a name

All official starters follow a similar naming pattern; spring-boot-starter-*, where * is a

particular type of application. This naming structure is intended to help when you need to
find a starter. The Maven integration in many IDEs lets you search dependencies by name.
For example, with the appropriate Eclipse or Spring Tools plugin installed, you can press
ctrl-space in the POM editor and type “spring-boot-starter” for a complete list.

As explained in the “Creating Your Own Starter” section, third party starters should not start
with spring-boot, as it is reserved for official Spring Boot artifacts. Rather, a third-party
starter typically starts with the name of the project. For example, a third-party starter project
called thirdpartyproject would typically be named thirdpartyproject-spring-boot-starter.

The following application starters are provided by Spring Boot under the org.springframework.boot
group:

Table 1. Spring Boot application starters

Name Description

spring-boot-starter Core starter, including auto-configuration

support, logging and YAML

spring-boot-starter-amqp Starter for using Spring AMQP and Rabbit MQ

spring-boot-starter-aop Starter for aspect-oriented programming with

Spring AOP and AspectJ

spring-boot-starter-artemis Starter for JMS messaging using Apache Artemis

spring-boot-starter-batch Starter for using Spring Batch

spring-boot-starter-cache Starter for using Spring Framework’s caching

support

spring-boot-starter-data-cassandra Starter for using Cassandra distributed database

and Spring Data Cassandra

spring-boot-starter-data-cassandra-reactive Starter for using Cassandra distributed database

and Spring Data Cassandra Reactive

spring-boot-starter-data-couchbase Starter for using Couchbase document-oriented

database and Spring Data Couchbase

spring-boot-starter-data-couchbase-reactive Starter for using Couchbase document-oriented

database and Spring Data Couchbase Reactive

spring-boot-starter-data-elasticsearch Starter for using Elasticsearch search and

analytics engine and Spring Data Elasticsearch

spring-boot-starter-data-jdbc Starter for using Spring Data JDBC

spring-boot-starter-data-jpa Starter for using Spring Data JPA with Hibernate

spring-boot-starter-data-ldap Starter for using Spring Data LDAP

26
Name Description

spring-boot-starter-data-mongodb Starter for using MongoDB document-oriented

database and Spring Data MongoDB

spring-boot-starter-data-mongodb-reactive Starter for using MongoDB document-oriented

database and Spring Data MongoDB Reactive

spring-boot-starter-data-neo4j Starter for using Neo4j graph database and

Spring Data Neo4j

spring-boot-starter-data-r2dbc Starter for using Spring Data R2DBC

spring-boot-starter-data-redis Starter for using Redis key-value data store with

Spring Data Redis and the Lettuce client

spring-boot-starter-data-redis-reactive Starter for using Redis key-value data store with

Spring Data Redis reactive and the Lettuce client

spring-boot-starter-data-rest Starter for exposing Spring Data repositories

over REST using Spring Data REST

spring-boot-starter-freemarker Starter for building MVC web applications using

FreeMarker views

spring-boot-starter-groovy-templates Starter for building MVC web applications using

Groovy Templates views

spring-boot-starter-hateoas Starter for building hypermedia-based RESTful

web application with Spring MVC and Spring
HATEOAS

spring-boot-starter-integration Starter for using Spring Integration

spring-boot-starter-jdbc Starter for using JDBC with the HikariCP

connection pool

spring-boot-starter-jooq Starter for using jOOQ to access SQL databases

with JDBC. An alternative to spring-boot-
starter-data-jpa or spring-boot-starter-jdbc

spring-boot-starter-json Starter for reading and writing json

spring-boot-starter-mail Starter for using Java Mail and Spring

Framework’s email sending support

spring-boot-starter-mustache Starter for building web applications using

Mustache views

spring-boot-starter-oauth2-client Starter for using Spring Security’s

OAuth2/OpenID Connect client features

spring-boot-starter-oauth2-resource-server Starter for using Spring Security’s OAuth2

resource server features

spring-boot-starter-quartz Starter for using the Quartz scheduler

spring-boot-starter-rsocket Starter for building RSocket clients and servers

spring-boot-starter-security Starter for using Spring Security

27
Name Description

spring-boot-starter-test Starter for testing Spring Boot applications with

libraries including JUnit Jupiter, Hamcrest and
Mockito

spring-boot-starter-thymeleaf Starter for building MVC web applications using

Thymeleaf views

spring-boot-starter-validation Starter for using Java Bean Validation with

Hibernate Validator

spring-boot-starter-web Starter for building web, including RESTful,

applications using Spring MVC. Uses Tomcat as
the default embedded container

spring-boot-starter-web-services Starter for using Spring Web Services

spring-boot-starter-webflux Starter for building WebFlux applications using

Spring Framework’s Reactive Web support

spring-boot-starter-websocket Starter for building WebSocket applications

using Spring Framework’s WebSocket support

In addition to the application starters, the following starters can be used to add production ready
features:

Table 2. Spring Boot production starters

Name Description

spring-boot-starter-actuator Starter for using Spring Boot’s Actuator which

provides production ready features to help you
monitor and manage your application

Finally, Spring Boot also includes the following starters that can be used if you want to exclude or
swap specific technical facets:

Table 3. Spring Boot technical starters

Name Description

spring-boot-starter-jetty Starter for using Jetty as the embedded servlet

container. An alternative to spring-boot-
starter-tomcat

spring-boot-starter-log4j2 Starter for using Log4j2 for logging. An

alternative to spring-boot-starter-logging

spring-boot-starter-logging Starter for logging using Logback. Default

logging starter

spring-boot-starter-reactor-netty Starter for using Reactor Netty as the embedded

reactive HTTP server.

28
Name Description

spring-boot-starter-tomcat Starter for using Tomcat as the embedded

servlet container. Default servlet container
starter used by spring-boot-starter-web

spring-boot-starter-undertow Starter for using Undertow as the embedded

servlet container. An alternative to spring-boot-
starter-tomcat

To learn how to swap technical facets, please see the how-to documentation for swapping web
server and logging system.

For a list of additional community contributed starters, see the README file in the
TIP
spring-boot-starters module on GitHub.

6.2. Structuring Your Code

Spring Boot does not require any specific code layout to work. However, there are some best
practices that help.

6.2.1. Using the “default” Package

When a class does not include a package declaration, it is considered to be in the “default package”.
The use of the “default package” is generally discouraged and should be avoided. It can cause
particular problems for Spring Boot applications that use the @ComponentScan,
@ConfigurationPropertiesScan, @EntityScan, or @SpringBootApplication annotations, since every class
from every jar is read.

We recommend that you follow Java’s recommended package naming conventions

TIP
and use a reversed domain name (for example, com.example.project).

6.2.2. Locating the Main Application Class

We generally recommend that you locate your main application class in a root package above other
classes. The @SpringBootApplication annotation is often placed on your main class, and it implicitly
defines a base “search package” for certain items. For example, if you are writing a JPA application,
the package of the @SpringBootApplication annotated class is used to search for @Entity items. Using
a root package also allows component scan to apply only on your project.

If you do not want to use @SpringBootApplication, the @EnableAutoConfiguration and

TIP @ComponentScan annotations that it imports defines that behavior so you can also use
those instead.

The following listing shows a typical layout:

29
 com
 +- example
  +- myapplication
  +- MyApplication.java
  |
  +- customer
  | +- Customer.java
  | +- CustomerController.java
  | +- CustomerService.java
  | +- CustomerRepository.java
  |
  +- order
  +- Order.java
  +- OrderController.java
  +- OrderService.java
  +- OrderRepository.java

The MyApplication.java file would declare the main method, along with the basic
@SpringBootApplication, as follows:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

  public static void main(String[] args) {

  SpringApplication.run(MyApplication.class, args);
  }

6.3. Configuration Classes

Spring Boot favors Java-based configuration. Although it is possible to use SpringApplication with
XML sources, we generally recommend that your primary source be a single @Configuration class.
Usually the class that defines the main method is a good candidate as the primary @Configuration.

Many Spring configuration examples have been published on the Internet that use
TIP XML configuration. If possible, always try to use the equivalent Java-based
configuration. Searching for Enable* annotations can be a good starting point.

6.3.1. Importing Additional Configuration Classes

You need not put all your @Configuration into a single class. The @Import annotation can be used to
import additional configuration classes. Alternatively, you can use @ComponentScan to automatically
pick up all Spring components, including @Configuration classes.

30
6.3.2. Importing XML Configuration

If you absolutely must use XML based configuration, we recommend that you still start with a
@Configuration class. You can then use an @ImportResource annotation to load XML configuration
files.

6.4. Auto-configuration
Spring Boot auto-configuration attempts to automatically configure your Spring application based
on the jar dependencies that you have added. For example, if HSQLDB is on your classpath, and you
have not manually configured any database connection beans, then Spring Boot auto-configures an
in-memory database.

You need to opt-in to auto-configuration by adding the @EnableAutoConfiguration or

@SpringBootApplication annotations to one of your @Configuration classes.

You should only ever add one @SpringBootApplication or @EnableAutoConfiguration

TIP annotation. We generally recommend that you add one or the other to your primary
@Configuration class only.

6.4.1. Gradually Replacing Auto-configuration

Auto-configuration is non-invasive. At any point, you can start to define your own configuration to
replace specific parts of the auto-configuration. For example, if you add your own DataSource bean,
the default embedded database support backs away.

If you need to find out what auto-configuration is currently being applied, and why, start your
application with the --debug switch. Doing so enables debug logs for a selection of core loggers and
logs a conditions report to the console.

6.4.2. Disabling Specific Auto-configuration Classes

If you find that specific auto-configuration classes that you do not want are being applied, you can
use the exclude attribute of @SpringBootApplication to disable them, as shown in the following
example:

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;

@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class })
public class MyApplication {

If the class is not on the classpath, you can use the excludeName attribute of the annotation and
specify the fully qualified name instead. If you prefer to use @EnableAutoConfiguration rather than
@SpringBootApplication, exclude and excludeName are also available. Finally, you can also control the

31
list of auto-configuration classes to exclude by using the spring.autoconfigure.exclude property.

TIP You can define exclusions both at the annotation level and by using the property.

Even though auto-configuration classes are public, the only aspect of the class that
is considered public API is the name of the class which can be used for disabling the
NOTE auto-configuration. The actual contents of those classes, such as nested
configuration classes or bean methods are for internal use only and we do not
recommend using those directly.

6.5. Spring Beans and Dependency Injection

You are free to use any of the standard Spring Framework techniques to define your beans and
their injected dependencies. We generally recommend using constructor injection to wire up
dependencies and @ComponentScan to find beans.

If you structure your code as suggested above (locating your application class in a top package), you
can add @ComponentScan without any arguments or use the @SpringBootApplication annotation which
implicitly includes it. All of your application components (@Component, @Service, @Repository,
@Controller, and others) are automatically registered as Spring Beans.

The following example shows a @Service Bean that uses constructor injection to obtain a required
RiskAssessor bean:

import org.springframework.stereotype.Service;

@Service
public class MyAccountService implements AccountService {

  private final RiskAssessor riskAssessor;

  public MyAccountService(RiskAssessor riskAssessor) {

  this.riskAssessor = riskAssessor;
  }

  // ...

If a bean has more than one constructor, you will need to mark the one you want Spring to use with
@Autowired:

32
 import java.io.PrintStream;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyAccountService implements AccountService {

  private final RiskAssessor riskAssessor;

  private final PrintStream out;

  @Autowired
  public MyAccountService(RiskAssessor riskAssessor) {
  this.riskAssessor = riskAssessor;
  this.out = System.out;
  }

  public MyAccountService(RiskAssessor riskAssessor, PrintStream out) {

  this.riskAssessor = riskAssessor;
  this.out = out;
  }

  // ...

Notice how using constructor injection lets the riskAssessor field be marked as final,
TIP
indicating that it cannot be subsequently changed.

6.6. Using the @SpringBootApplication Annotation

Many Spring Boot developers like their apps to use auto-configuration, component scan and be able
to define extra configuration on their "application class". A single @SpringBootApplication
annotation can be used to enable those three features, that is:

• @EnableAutoConfiguration: enable Spring Boot’s auto-configuration mechanism

• @ComponentScan: enable @Component scan on the package where the application is located (see the
best practices)

• @SpringBootConfiguration: enable registration of extra beans in the context or the import of

additional configuration classes. An alternative to Spring’s standard @Configuration that aids
configuration detection in your integration tests.

33
 import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // same as @SpringBootConfiguration @EnableAutoConfiguration

  // @ComponentScan
public class MyApplication {

  public static void main(String[] args) {

  SpringApplication.run(MyApplication.class, args);
  }

@SpringBootApplication also provides aliases to customize the attributes of

NOTE
@EnableAutoConfiguration and @ComponentScan.

None of these features are mandatory and you may choose to replace this single
annotation by any of the features that it enables. For instance, you may not want to
use component scan or configuration properties scan in your application:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.Import;

@SpringBootConfiguration(proxyBeanMethods = false)
@EnableAutoConfiguration
@Import({ SomeConfiguration.class, AnotherConfiguration.class })
NOTE
public class MyApplication {

  public static void main(String[] args) {

  SpringApplication.run(MyApplication.class, args);
  }

In this example, MyApplication is just like any other Spring Boot application except
that @Component-annotated classes and @ConfigurationProperties-annotated classes
are not detected automatically and the user-defined beans are imported explicitly
(see @Import).

6.7. Running Your Application

One of the biggest advantages of packaging your application as a jar and using an embedded HTTP
server is that you can run your application as you would any other. The sample applies to
debugging Spring Boot applications. You do not need any special IDE plugins or extensions.

34
 This section only covers jar-based packaging. If you choose to package your
NOTE
application as a war file, see your server and IDE documentation.

6.7.1. Running from an IDE

You can run a Spring Boot application from your IDE as a Java application. However, you first need
to import your project. Import steps vary depending on your IDE and build system. Most IDEs can
import Maven projects directly. For example, Eclipse users can select Import… → Existing Maven
Projects from the File menu.

If you cannot directly import your project into your IDE, you may be able to generate IDE metadata
by using a build plugin. Maven includes plugins for Eclipse and IDEA. Gradle offers plugins for
various IDEs.

If you accidentally run a web application twice, you see a “Port already in use” error.
TIP Spring Tools users can use the Relaunch button rather than the Run button to ensure
that any existing instance is closed.

6.7.2. Running as a Packaged Application

If you use the Spring Boot Maven or Gradle plugins to create an executable jar, you can run your
application using java -jar, as shown in the following example:

$ java -jar target/myapplication-0.0.1-SNAPSHOT.jar

It is also possible to run a packaged application with remote debugging support enabled. Doing so
lets you attach a debugger to your packaged application, as shown in the following example:

$ java -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=8000,suspend=n \

  -jar target/myapplication-0.0.1-SNAPSHOT.jar

6.7.3. Using the Maven Plugin

The Spring Boot Maven plugin includes a run goal that can be used to quickly compile and run your
application. Applications run in an exploded form, as they do in your IDE. The following example
shows a typical Maven command to run a Spring Boot application:

$ mvn spring-boot:run

You might also want to use the MAVEN_OPTS operating system environment variable, as shown in the
following example:

$ export MAVEN_OPTS=-Xmx1024m

35
6.7.4. Using the Gradle Plugin

The Spring Boot Gradle plugin also includes a bootRun task that can be used to run your application
in an exploded form. The bootRun task is added whenever you apply the org.springframework.boot
and java plugins and is shown in the following example:

$ gradle bootRun

You might also want to use the JAVA_OPTS operating system environment variable, as shown in the
following example:

$ export JAVA_OPTS=-Xmx1024m

6.7.5. Hot Swapping

Since Spring Boot applications are plain Java applications, JVM hot-swapping should work out of
the box. JVM hot swapping is somewhat limited with the bytecode that it can replace. For a more
complete solution, JRebel can be used.

The spring-boot-devtools module also includes support for quick application restarts. See the Hot
swapping “How-to” for details.

6.8. Developer Tools

Spring Boot includes an additional set of tools that can make the application development
experience a little more pleasant. The spring-boot-devtools module can be included in any project
to provide additional development-time features. To include devtools support, add the module
dependency to your build, as shown in the following listings for Maven and Gradle:

Maven

<dependencies>
  <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-devtools</artifactId>
  <optional>true</optional>
  </dependency>
</dependencies>

Gradle

dependencies {
  developmentOnly("org.springframework.boot:spring-boot-devtools")
}

36
 Devtools might cause classloading issues, in particular in multi-module projects.
CAUTION
Diagnosing Classloading Issues explains how to diagnose and solve them.

Developer tools are automatically disabled when running a fully packaged

application. If your application is launched from java -jar or if it is started from a
special classloader, then it is considered a “production application”. You can control
this behavior by using the spring.devtools.restart.enabled system property. To
NOTE enable devtools, irrespective of the classloader used to launch your application, set
the -Dspring.devtools.restart.enabled=true system property. This must not be done
in a production environment where running devtools is a security risk. To disable
devtools, exclude the dependency or set the
-Dspring.devtools.restart.enabled=false system property.

Flagging the dependency as optional in Maven or using the developmentOnly

TIP configuration in Gradle (as shown above) prevents devtools from being transitively
applied to other modules that use your project.

Repackaged archives do not contain devtools by default. If you want to use a certain
remote devtools feature, you need to include it. When using the Maven plugin, set the
TIP
excludeDevtools property to false. When using the Gradle plugin, configure the task’s
classpath to include the developmentOnly configuration.

6.8.1. Diagnosing Classloading Issues

As described in the Restart vs Reload section, restart functionality is implemented by using two
classloaders. For most applications, this approach works well. However, it can sometimes cause
classloading issues, in particular in multi-module projects.

To diagnose whether the classloading issues are indeed caused by devtools and its two classloaders,
try disabling restart. If this solves your problems, customize the restart classloader to include your
entire project.

6.8.2. Property Defaults

Several of the libraries supported by Spring Boot use caches to improve performance. For example,
template engines cache compiled templates to avoid repeatedly parsing template files. Also, Spring
MVC can add HTTP caching headers to responses when serving static resources.

While caching is very beneficial in production, it can be counter-productive during development,

preventing you from seeing the changes you just made in your application. For this reason, spring-
boot-devtools disables the caching options by default.

Cache options are usually configured by settings in your application.properties file. For example,
Thymeleaf offers the spring.thymeleaf.cache property. Rather than needing to set these properties
manually, the spring-boot-devtools module automatically applies sensible development-time
configuration.

37
Because you need more information about web requests while developing Spring MVC and Spring
WebFlux applications, developer tools suggests you to enable DEBUG logging for the web logging
group. This will give you information about the incoming request, which handler is processing it,
the response outcome, and other details. If you wish to log all request details (including potentially
sensitive information), you can turn on the spring.mvc.log-request-details or spring.codec.log-
request-details configuration properties.

If you do not want property defaults to be applied you can set spring.devtools.add-
NOTE
properties to false in your application.properties.

For a complete list of the properties that are applied by the devtools, see
TIP
DevToolsPropertyDefaultsPostProcessor.

6.8.3. Automatic Restart

Applications that use spring-boot-devtools automatically restart whenever files on the classpath
change. This can be a useful feature when working in an IDE, as it gives a very fast feedback loop
for code changes. By default, any entry on the classpath that points to a directory is monitored for
changes. Note that certain resources, such as static assets and view templates, do not need to restart
the application.

Triggering a restart

As DevTools monitors classpath resources, the only way to trigger a restart is to update the
classpath. The way in which you cause the classpath to be updated depends on the IDE that
you are using:

• In Eclipse, saving a modified file causes the classpath to be updated and triggers a restart.

• In IntelliJ IDEA, building the project (Build +→+ Build Project) has the same effect.

• If using a build plugin, running mvn compile for Maven or gradle build for Gradle will
trigger a restart.

If you are restarting with Maven or Gradle using the build plugin you must leave
NOTE the forking set to enabled. If you disable forking, the isolated application classloader
used by devtools will not be created and restarts will not operate properly.

Automatic restart works very well when used with LiveReload. See the LiveReload
section for details. If you use JRebel, automatic restarts are disabled in favor of
TIP
dynamic class reloading. Other devtools features (such as LiveReload and property
overrides) can still be used.

DevTools relies on the application context’s shutdown hook to close it during a

NOTE restart. It does not work correctly if you have disabled the shutdown hook
(SpringApplication.setRegisterShutdownHook(false)).

38
 DevTools needs to customize the ResourceLoader used by the ApplicationContext. If
NOTE your application provides one already, it is going to be wrapped. Direct override of
the getResource method on the ApplicationContext is not supported.

CAUTION Automatic restart is not supported when using AspectJ weaving.

Restart vs Reload

The restart technology provided by Spring Boot works by using two classloaders. Classes that
do not change (for example, those from third-party jars) are loaded into a base classloader.
Classes that you are actively developing are loaded into a restart classloader. When the
application is restarted, the restart classloader is thrown away and a new one is created. This
approach means that application restarts are typically much faster than “cold starts”, since
the base classloader is already available and populated.

If you find that restarts are not quick enough for your applications or you encounter
classloading issues, you could consider reloading technologies such as JRebel from
ZeroTurnaround. These work by rewriting classes as they are loaded to make them more
amenable to reloading.

Logging changes in condition evaluation

By default, each time your application restarts, a report showing the condition evaluation delta is
logged. The report shows the changes to your application’s auto-configuration as you make changes
such as adding or removing beans and setting configuration properties.

To disable the logging of the report, set the following property:

Properties

spring.devtools.restart.log-condition-evaluation-delta=false

Yaml

spring:
  devtools:
  restart:
  log-condition-evaluation-delta: false

Excluding Resources

Certain resources do not necessarily need to trigger a restart when they are changed. For example,
Thymeleaf templates can be edited in-place. By default, changing resources in /META-INF/maven,
/META-INF/resources, /resources, /static, /public, or /templates does not trigger a restart but does
trigger a live reload. If you want to customize these exclusions, you can use the
spring.devtools.restart.exclude property. For example, to exclude only /static and /public you

39
would set the following property:

Properties

spring.devtools.restart.exclude=static/**,public/**

Yaml

spring:
  devtools:
  restart:
  exclude: "static/**,public/**"

If you want to keep those defaults and add additional exclusions, use the
TIP
spring.devtools.restart.additional-exclude property instead.

Watching Additional Paths

You may want your application to be restarted or reloaded when you make changes to files that are
not on the classpath. To do so, use the spring.devtools.restart.additional-paths property to
configure additional paths to watch for changes. You can use the spring.devtools.restart.exclude
property described earlier to control whether changes beneath the additional paths trigger a full
restart or a live reload.

Disabling Restart

If you do not want to use the restart feature, you can disable it by using the
spring.devtools.restart.enabled property. In most cases, you can set this property in your
application.properties (doing so still initializes the restart classloader, but it does not watch for file
changes).

If you need to completely disable restart support (for example, because it does not work with a
specific library), you need to set the spring.devtools.restart.enabled System property to false
before calling SpringApplication.run(…), as shown in the following example:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

  public static void main(String[] args) {

  System.setProperty("spring.devtools.restart.enabled", "false");
  SpringApplication.run(MyApplication.class, args);
  }

40
Using a Trigger File

If you work with an IDE that continuously compiles changed files, you might prefer to trigger
restarts only at specific times. To do so, you can use a “trigger file”, which is a special file that must
be modified when you want to actually trigger a restart check.

Any update to the file will trigger a check, but restart only actually occurs if
NOTE
Devtools has detected it has something to do.

To use a trigger file, set the spring.devtools.restart.trigger-file property to the name (excluding
any path) of your trigger file. The trigger file must appear somewhere on your classpath.

For example, if you have a project with the following structure:

src
+- main
  +- resources
  +- .reloadtrigger

Then your trigger-file property would be:

Properties

spring.devtools.restart.trigger-file=.reloadtrigger

Yaml

spring:
  devtools:
  restart:
  trigger-file: ".reloadtrigger"

Restarts will now only happen when the src/main/resources/.reloadtrigger is updated.

You might want to set spring.devtools.restart.trigger-file as a global setting, so that

TIP
all your projects behave in the same way.

Some IDEs have features that save you from needing to update your trigger file manually. Spring
Tools for Eclipse and IntelliJ IDEA (Ultimate Edition) both have such support. With Spring Tools, you
can use the “reload” button from the console view (as long as your trigger-file is named
.reloadtrigger). For IntelliJ IDEA, you can follow the instructions in their documentation.

Customizing the Restart Classloader

As described earlier in the Restart vs Reload section, restart functionality is implemented by using
two classloaders. If this causes issues, you might need to customize what gets loaded by which
classloader.

41
By default, any open project in your IDE is loaded with the “restart” classloader, and any regular
.jar file is loaded with the “base” classloader. The same is true if you use mvn spring-boot:run or
gradle bootRun: the project containing your @SpringBootApplication is loaded with the “restart”
classloader, and everything else with the “base” classloader.

You can instruct Spring Boot to load parts of your project with a different classloader by creating a
META-INF/spring-devtools.properties file. The spring-devtools.properties file can contain
properties prefixed with restart.exclude and restart.include. The include elements are items that
should be pulled up into the “restart” classloader, and the exclude elements are items that should be
pushed down into the “base” classloader. The value of the property is a regex pattern that is applied
to the classpath, as shown in the following example:

Properties

restart.exclude.companycommonlibs=/mycorp-common-[\\w\\d-\\.]+\\.jar
restart.include.projectcommon=/mycorp-myproj-[\\w\\d-\\.]+\\.jar

Yaml

restart:
  exclude:
  companycommonlibs: "/mycorp-common-[\\w\\d-\\.]+\\.jar"
  include:
  projectcommon: "/mycorp-myproj-[\\w\\d-\\.]+\\.jar"

All property keys must be unique. As long as a property starts with restart.include.
NOTE
or restart.exclude. it is considered.

All META-INF/spring-devtools.properties from the classpath are loaded. You can

TIP
package files inside your project, or in the libraries that the project consumes.

Known Limitations

Restart functionality does not work well with objects that are deserialized by using a standard
ObjectInputStream. If you need to deserialize data, you may need to use Spring’s
ConfigurableObjectInputStream in combination with
Thread.currentThread().getContextClassLoader().

Unfortunately, several third-party libraries deserialize without considering the context classloader.
If you find such a problem, you need to request a fix with the original authors.

6.8.4. LiveReload

The spring-boot-devtools module includes an embedded LiveReload server that can be used to
trigger a browser refresh when a resource is changed. LiveReload browser extensions are freely
available for Chrome, Firefox and Safari from livereload.com.

If you do not want to start the LiveReload server when your application runs, you can set the

42
spring.devtools.livereload.enabled property to false.

You can only run one LiveReload server at a time. Before starting your application,
NOTE ensure that no other LiveReload servers are running. If you start multiple
applications from your IDE, only the first has LiveReload support.

WARNING To trigger LiveReload when a file changes, Automatic Restart must be enabled.

6.8.5. Global Settings

You can configure global devtools settings by adding any of the following files to the
$HOME/.config/spring-boot directory:

1. spring-boot-devtools.properties

2. spring-boot-devtools.yaml

3. spring-boot-devtools.yml

Any properties added to these files apply to all Spring Boot applications on your machine that use
devtools. For example, to configure restart to always use a trigger file, you would add the following
property to your spring-boot-devtools file:

Properties

spring.devtools.restart.trigger-file=.reloadtrigger

Yaml

spring:
  devtools:
  restart:
  trigger-file: ".reloadtrigger"

By default, $HOME is the user’s home directory. To customize this location, set the
SPRING_DEVTOOLS_HOME environment variable or the spring.devtools.home system property.

If devtools configuration files are not found in $HOME/.config/spring-boot, the root

of the $HOME directory is searched for the presence of a .spring-boot-
NOTE devtools.properties file. This allows you to share the devtools global configuration
with applications that are on an older version of Spring Boot that does not support
the $HOME/.config/spring-boot location.

43
 Profiles are not supported in devtools properties/yaml files.

Any profiles activated in .spring-boot-devtools.properties will not affect the

NOTE
loading of profile-specific configuration files. Profile specific filenames (of the form
spring-boot-devtools-<profile>.properties) and spring.config.activate.on-profile
documents in both YAML and Properties files are not supported.

Configuring File System Watcher

FileSystemWatcher works by polling the class changes with a certain time interval, and then
waiting for a predefined quiet period to make sure there are no more changes. Since Spring Boot
relies entirely on the IDE to compile and copy files into the location from where Spring Boot can
read them, you might find that there are times when certain changes are not reflected when
devtools restarts the application. If you observe such problems constantly, try increasing the
spring.devtools.restart.poll-interval and spring.devtools.restart.quiet-period parameters to
the values that fit your development environment:

Properties

spring.devtools.restart.poll-interval=2s
spring.devtools.restart.quiet-period=1s

Yaml

spring:
  devtools:
  restart:
  poll-interval: "2s"
  quiet-period: "1s"

The monitored classpath directories are now polled every 2 seconds for changes, and a 1 second
quiet period is maintained to make sure there are no additional class changes.

6.8.6. Remote Applications

The Spring Boot developer tools are not limited to local development. You can also use several
features when running applications remotely. Remote support is opt-in as enabling it can be a
security risk. It should only be enabled when running on a trusted network or when secured with
SSL. If neither of these options is available to you, you should not use DevTools' remote support.
You should never enable support on a production deployment.

To enable it, you need to make sure that devtools is included in the repackaged archive, as shown in
the following listing:

44
 <build>
  <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <configuration>
  <excludeDevtools>false</excludeDevtools>
  </configuration>
  </plugin>
  </plugins>
</build>

Then you need to set the spring.devtools.remote.secret property. Like any important password or
secret, the value should be unique and strong such that it cannot be guessed or brute-forced.

Remote devtools support is provided in two parts: a server-side endpoint that accepts connections
and a client application that you run in your IDE. The server component is automatically enabled
when the spring.devtools.remote.secret property is set. The client component must be launched
manually.

NOTE Remote devtools is not supported for Spring WebFlux applications.

Running the Remote Client Application

The remote client application is designed to be run from within your IDE. You need to run
org.springframework.boot.devtools.RemoteSpringApplication with the same classpath as the remote
project that you connect to. The application’s single required argument is the remote URL to which
it connects.

For example, if you are using Eclipse or Spring Tools and you have a project named my-app that you
have deployed to Cloud Foundry, you would do the following:

• Select Run Configurations… from the Run menu.

• Create a new Java Application “launch configuration”.

• Browse for the my-app project.

• Use org.springframework.boot.devtools.RemoteSpringApplication as the main class.

• Add https://myapp.cfapps.io to the Program arguments (or whatever your remote URL is).

A running remote client might resemble the following listing:

45
   . ____ _ __ _ _
 /\\ / ___'_ __ _ _(_)_ __ __ _ ___ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | | _ \___ _ __ ___| |_ ___ \ \ \ \
 \\/ ___)| |_)| | | | | || (_| []::::::[] / -_) ' \/ _ \ _/ -_) ) ) ) )
  ' |____| .__|_| |_|_| |_\__, | |_|_\___|_|_|_\___/\__\___|/ / / /
 =========|_|==============|___/===================================/_/_/_/
 :: Spring Boot Remote :: 3.0.0-SNAPSHOT

2015-06-10 18:25:06.632 INFO 14938 --- [ main]

o.s.b.devtools.RemoteSpringApplication : Starting RemoteSpringApplication on pwmbp
with PID 14938 (/Users/pwebb/projects/spring-boot/code/spring-boot-project/spring-
boot-devtools/target/classes started by pwebb in /Users/pwebb/projects/spring-
boot/code)
2015-06-10 18:25:06.671 INFO 14938 --- [ main]
s.c.a.AnnotationConfigApplicationContext : Refreshing
org.springframework.context.annotation.AnnotationConfigApplicationContext@2a17b7b6:
startup date [Wed Jun 10 18:25:06 PDT 2015]; root of context hierarchy
2015-06-10 18:25:07.043 WARN 14938 --- [ main]
o.s.b.d.r.c.RemoteClientConfiguration : The connection to http://localhost:8080 is
insecure. You should use a URL starting with 'https://'.
2015-06-10 18:25:07.074 INFO 14938 --- [ main]
o.s.b.d.a.OptionalLiveReloadServer : LiveReload server is running on port 35729
2015-06-10 18:25:07.130 INFO 14938 --- [ main]
o.s.b.devtools.RemoteSpringApplication : Started RemoteSpringApplication in 0.74
seconds (JVM running for 1.105)

Because the remote client is using the same classpath as the real application it can
NOTE directly read application properties. This is how the spring.devtools.remote.secret
property is read and passed to the server for authentication.

It is always advisable to use https:// as the connection protocol, so that traffic is

TIP
encrypted and passwords cannot be intercepted.

If you need to use a proxy to access the remote application, configure the
TIP
spring.devtools.remote.proxy.host and spring.devtools.remote.proxy.port properties.

Remote Update

The remote client monitors your application classpath for changes in the same way as the local
restart. Any updated resource is pushed to the remote application and (if required) triggers a
restart. This can be helpful if you iterate on a feature that uses a cloud service that you do not have
locally. Generally, remote updates and restarts are much quicker than a full rebuild and deploy
cycle.

On a slower development environment, it may happen that the quiet period is not enough, and the
changes in the classes may be split into batches. The server is restarted after the first batch of class
changes is uploaded. The next batch can’t be sent to the application, since the server is restarting.

46
This is typically manifested by a warning in the RemoteSpringApplication logs about failing to upload
some of the classes, and a consequent retry. But it may also lead to application code inconsistency
and failure to restart after the first batch of changes is uploaded. If you observe such problems
constantly, try increasing the spring.devtools.restart.poll-interval and
spring.devtools.restart.quiet-period parameters to the values that fit your development
environment. See the Configuring File System Watcher section for configuring these properties.

Files are only monitored when the remote client is running. If you change a file
NOTE
before starting the remote client, it is not pushed to the remote server.

6.9. Packaging Your Application for Production

Executable jars can be used for production deployment. As they are self-contained, they are also
ideally suited for cloud-based deployment.

For additional “production ready” features, such as health, auditing, and metric REST or JMX end-
points, consider adding spring-boot-actuator. See Production-ready Features for details.

6.10. What to Read Next

You should now understand how you can use Spring Boot and some best practices that you should
follow. You can now go on to learn about specific Spring Boot features in depth, or you could skip
ahead and read about the “production ready” aspects of Spring Boot.

47
Chapter 7. Core Features
This section dives into the details of Spring Boot. Here you can learn about the key features that you
may want to use and customize. If you have not already done so, you might want to read the
"Getting Started" and "Developing with Spring Boot" sections, so that you have a good grounding of
the basics.

7.1. SpringApplication
The SpringApplication class provides a convenient way to bootstrap a Spring application that is
started from a main() method. In many situations, you can delegate to the static
SpringApplication.run method, as shown in the following example:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

  public static void main(String[] args) {

  SpringApplication.run(MyApplication.class, args);
  }

When your application starts, you should see something similar to the following output:

48
   . ____ _ __ _ _
 /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/ ___)| |_)| | | | | || (_| | ) ) ) )
  ' |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot :: v3.0.0-SNAPSHOT

2021-02-03 10:33:25.224 INFO 17900 --- [ main]

o.s.b.d.s.s.SpringApplicationExample : Starting SpringAppplicationExample using
Java 17 on mycomputer with PID 17321 (/apps/myjar.jar started by pwebb)
2021-02-03 10:33:25.226 INFO 17900 --- [ main]
o.s.b.d.s.s.SpringApplicationExample : No active profile set, falling back to
default profiles: default
2021-02-03 10:33:26.046 INFO 17900 --- [ main]
o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8080
(http)
2021-02-03 10:33:26.054 INFO 17900 --- [ main]
o.apache.catalina.core.StandardService : Starting service [Tomcat]
2021-02-03 10:33:26.055 INFO 17900 --- [ main]
org.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache
Tomcat/9.0.41]
2021-02-03 10:33:26.097 INFO 17900 --- [ main]
o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded
WebApplicationContext
2021-02-03 10:33:26.097 INFO 17900 --- [ main]
w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization
completed in 821 ms
2021-02-03 10:33:26.144 INFO 17900 --- [ main]
s.tomcat.SampleTomcatApplication : ServletContext initialized
2021-02-03 10:33:26.376 INFO 17900 --- [ main]
o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with
context path ''
2021-02-03 10:33:26.384 INFO 17900 --- [ main]
o.s.b.d.s.s.SpringApplicationExample : Started SampleTomcatApplication in 1.514
seconds (JVM running for 1.823)

By default, INFO logging messages are shown, including some relevant startup details, such as the
user that launched the application. If you need a log level other than INFO, you can set it, as
described in Log Levels. The application version is determined using the implementation version
from the main application class’s package. Startup information logging can be turned off by setting
spring.main.log-startup-info to false. This will also turn off logging of the application’s active
profiles.

To add additional logging during startup, you can override logStartupInfo(boolean) in

TIP
a subclass of SpringApplication.

49
7.1.1. Startup Failure

If your application fails to start, registered FailureAnalyzers get a chance to provide a dedicated
error message and a concrete action to fix the problem. For instance, if you start a web application
on port 8080 and that port is already in use, you should see something similar to the following
message:

***************************
APPLICATION FAILED TO START
***************************

Description:

Embedded servlet container failed to start. Port 8080 was already in use.

Action:

Identify and stop the process that is listening on port 8080 or configure this
application to listen on another port.

Spring Boot provides numerous FailureAnalyzer implementations, and you can add
NOTE
your own.

If no failure analyzers are able to handle the exception, you can still display the full conditions
report to better understand what went wrong. To do so, you need to enable the debug property or
enable DEBUG logging for
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener.

For instance, if you are running your application by using java -jar, you can enable the debug
property as follows:

$ java -jar myproject-0.0.1-SNAPSHOT.jar --debug

7.1.2. Lazy Initialization

SpringApplication allows an application to be initialized lazily. When lazy initialization is enabled,

beans are created as they are needed rather than during application startup. As a result, enabling
lazy initialization can reduce the time that it takes your application to start. In a web application,
enabling lazy initialization will result in many web-related beans not being initialized until an
HTTP request is received.

A downside of lazy initialization is that it can delay the discovery of a problem with the application.
If a misconfigured bean is initialized lazily, a failure will no longer occur during startup and the
problem will only become apparent when the bean is initialized. Care must also be taken to ensure
that the JVM has sufficient memory to accommodate all of the application’s beans and not just those
that are initialized during startup. For these reasons, lazy initialization is not enabled by default
and it is recommended that fine-tuning of the JVM’s heap size is done before enabling lazy

50
initialization.

Lazy initialization can be enabled programmatically using the lazyInitialization method on

SpringApplicationBuilder or the setLazyInitialization method on SpringApplication. Alternatively,
it can be enabled using the spring.main.lazy-initialization property as shown in the following
example:

Properties

spring.main.lazy-initialization=true

Yaml

spring:
  main:
  lazy-initialization: true

If you want to disable lazy initialization for certain beans while using lazy
TIP initialization for the rest of the application, you can explicitly set their lazy attribute to
false using the @Lazy(false) annotation.

7.1.3. Customizing the Banner

The banner that is printed on start up can be changed by adding a banner.txt file to your classpath
or by setting the spring.banner.location property to the location of such a file. If the file has an
encoding other than UTF-8, you can set spring.banner.charset. In addition to a text file, you can also
add a banner.gif, banner.jpg, or banner.png image file to your classpath or set the
spring.banner.image.location property. Images are converted into an ASCII art representation and
printed above any text banner.

Inside your banner.txt file, you can use any of the following placeholders:

Table 4. Banner variables

Variable Description
${application.version} The version number of your application, as
declared in MANIFEST.MF. For example,
Implementation-Version: 1.0 is printed as 1.0.
${application.formatted-version} The version number of your application, as
declared in MANIFEST.MF and formatted for
display (surrounded with brackets and prefixed
with v). For example (v1.0).
${spring-boot.version} The Spring Boot version that you are using. For
example 3.0.0-SNAPSHOT.

51
Variable Description
${spring-boot.formatted-version} The Spring Boot version that you are using,
formatted for display (surrounded with brackets
and prefixed with v). For example (v3.0.0-
SNAPSHOT).

${Ansi.NAME} (or ${AnsiColor.NAME}, Where NAME is the name of an ANSI escape code.
${AnsiBackground.NAME}, ${AnsiStyle.NAME}) See AnsiPropertySource for details.
${application.title} The title of your application, as declared in
MANIFEST.MF. For example Implementation-Title:
MyApp is printed as MyApp.

The SpringApplication.setBanner(…) method can be used if you want to generate a

TIP banner programmatically. Use the org.springframework.boot.Banner interface and
implement your own printBanner() method.

You can also use the spring.main.banner-mode property to determine if the banner has to be printed
on System.out (console), sent to the configured logger (log), or not produced at all (off).

The printed banner is registered as a singleton bean under the following name: springBootBanner.

The ${application.version} and ${application.formatted-version} properties are

only available if you are using Spring Boot launchers. The values will not be
resolved if you are running an unpacked jar and starting it with java -cp
<classpath> <mainclass>.
NOTE

This is why we recommend that you always launch unpacked jars using java
org.springframework.boot.loader.JarLauncher. This will initialize the application.*
banner variables before building the classpath and launching your app.

7.1.4. Customizing SpringApplication

If the SpringApplication defaults are not to your taste, you can instead create a local instance and
customize it. For example, to turn off the banner, you could write:

52
 import org.springframework.boot.Banner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

  public static void main(String[] args) {

  SpringApplication application = new SpringApplication(MyApplication.class);
  application.setBannerMode(Banner.Mode.OFF);
  application.run(args);
  }

The constructor arguments passed to SpringApplication are configuration sources

NOTE for Spring beans. In most cases, these are references to @Configuration classes, but
they could also be direct references @Component classes.

It is also possible to configure the SpringApplication by using an application.properties file. See

Externalized Configuration for details.

For a complete list of the configuration options, see the SpringApplication Javadoc.

7.1.5. Fluent Builder API

If you need to build an ApplicationContext hierarchy (multiple contexts with a parent/child

relationship) or if you prefer using a “fluent” builder API, you can use the SpringApplicationBuilder.

The SpringApplicationBuilder lets you chain together multiple method calls and includes parent and
child methods that let you create a hierarchy, as shown in the following example:

new SpringApplicationBuilder()
  .sources(Parent.class)
  .child(Application.class)
  .bannerMode(Banner.Mode.OFF)
  .run(args);

There are some restrictions when creating an ApplicationContext hierarchy. For

example, Web components must be contained within the child context, and the
NOTE
same Environment is used for both parent and child contexts. See the
SpringApplicationBuilder Javadoc for full details.

7.1.6. Application Availability

When deployed on platforms, applications can provide information about their availability to the
platform using infrastructure such as Kubernetes Probes. Spring Boot includes out-of-the box

53
support for the commonly used “liveness” and “readiness” availability states. If you are using
Spring Boot’s “actuator” support then these states are exposed as health endpoint groups.

In addition, you can also obtain availability states by injecting the ApplicationAvailability interface
into your own beans.

Liveness State

The “Liveness” state of an application tells whether its internal state allows it to work correctly, or
recover by itself if it is currently failing. A broken “Liveness” state means that the application is in a
state that it cannot recover from, and the infrastructure should restart the application.

In general, the "Liveness" state should not be based on external checks, such as
NOTE Health checks. If it did, a failing external system (a database, a Web API, an external
cache) would trigger massive restarts and cascading failures across the platform.

The internal state of Spring Boot applications is mostly represented by the Spring
ApplicationContext. If the application context has started successfully, Spring Boot assumes that the
application is in a valid state. An application is considered live as soon as the context has been
refreshed, see Spring Boot application lifecycle and related Application Events.

Readiness State

The “Readiness” state of an application tells whether the application is ready to handle traffic. A
failing “Readiness” state tells the platform that it should not route traffic to the application for now.
This typically happens during startup, while CommandLineRunner and ApplicationRunner components
are being processed, or at any time if the application decides that it is too busy for additional traffic.

An application is considered ready as soon as application and command-line runners have been
called, see Spring Boot application lifecycle and related Application Events.

Tasks expected to run during startup should be executed by CommandLineRunner and

TIP ApplicationRunner components instead of using Spring component lifecycle callbacks
such as @PostConstruct.

Managing the Application Availability State

Application components can retrieve the current availability state at any time, by injecting the
ApplicationAvailability interface and calling methods on it. More often, applications will want to
listen to state updates or update the state of the application.

For example, we can export the "Readiness" state of the application to a file so that a Kubernetes
"exec Probe" can look at this file:

54
 import org.springframework.boot.availability.AvailabilityChangeEvent;
import org.springframework.boot.availability.ReadinessState;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class MyReadinessStateExporter {

  @EventListener
  public void onStateChange(AvailabilityChangeEvent<ReadinessState> event) {
  switch (event.getState()) {
  case ACCEPTING_TRAFFIC:
  // create file /tmp/healthy
  break;
  case REFUSING_TRAFFIC:
  // remove file /tmp/healthy
  break;
  }
  }

We can also update the state of the application, when the application breaks and cannot recover:

55
 import org.springframework.boot.availability.AvailabilityChangeEvent;
import org.springframework.boot.availability.LivenessState;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Component;

@Component
public class MyLocalCacheVerifier {

  private final ApplicationEventPublisher eventPublisher;

  public MyLocalCacheVerifier(ApplicationEventPublisher eventPublisher) {

  this.eventPublisher = eventPublisher;
  }

  public void checkLocalCache() {

  try {
  // ...
  }
  catch (CacheCompletelyBrokenException ex) {
  AvailabilityChangeEvent.publish(this.eventPublisher, ex,
LivenessState.BROKEN);
  }
  }

Spring Boot provides Kubernetes HTTP probes for "Liveness" and "Readiness" with Actuator Health
Endpoints. You can get more guidance about deploying Spring Boot applications on Kubernetes in
the dedicated section.

7.1.7. Application Events and Listeners

In addition to the usual Spring Framework events, such as ContextRefreshedEvent, a

SpringApplication sends some additional application events.

56
 Some events are actually triggered before the ApplicationContext is created, so you
cannot register a listener on those as a @Bean. You can register them with the
SpringApplication.addListeners(…) method or the
SpringApplicationBuilder.listeners(…) method.

If you want those listeners to be registered automatically, regardless of the way the
application is created, you can add a META-INF/spring.factories file to your project
NOTE
and reference your listener(s) by using the
org.springframework.context.ApplicationListener key, as shown in the following
example:

org.springframework.context.ApplicationListener=com.example.project.MyLi
stener

Application events are sent in the following order, as your application runs:

1. An ApplicationStartingEvent is sent at the start of a run but before any processing, except for
the registration of listeners and initializers.

2. An ApplicationEnvironmentPreparedEvent is sent when the Environment to be used in the context is

known but before the context is created.

3. An ApplicationContextInitializedEvent is sent when the ApplicationContext is prepared and

ApplicationContextInitializers have been called but before any bean definitions are loaded.

4. An ApplicationPreparedEvent is sent just before the refresh is started but after bean definitions
have been loaded.

5. An ApplicationStartedEvent is sent after the context has been refreshed but before any
application and command-line runners have been called.

6. An AvailabilityChangeEvent is sent right after with LivenessState.CORRECT to indicate that the

application is considered as live.

7. An ApplicationReadyEvent is sent after any application and command-line runners have been
called.

8. An AvailabilityChangeEvent is sent right after with ReadinessState.ACCEPTING_TRAFFIC to indicate

that the application is ready to service requests.

9. An ApplicationFailedEvent is sent if there is an exception on startup.

The above list only includes SpringApplicationEvents that are tied to a SpringApplication. In
addition to these, the following events are also published after ApplicationPreparedEvent and before
ApplicationStartedEvent:

• A WebServerInitializedEvent is sent after the WebServer is ready.

ServletWebServerInitializedEvent and ReactiveWebServerInitializedEvent are the servlet and
reactive variants respectively.

• A ContextRefreshedEvent is sent when an ApplicationContext is refreshed.

57
 You often need not use application events, but it can be handy to know that they exist.
TIP
Internally, Spring Boot uses events to handle a variety of tasks.

Event listeners should not run potentially lengthy tasks as they execute in the same
NOTE
thread by default. Consider using application and command-line runners instead.

Application events are sent by using Spring Framework’s event publishing mechanism. Part of this
mechanism ensures that an event published to the listeners in a child context is also published to
the listeners in any ancestor contexts. As a result of this, if your application uses a hierarchy of
SpringApplication instances, a listener may receive multiple instances of the same type of
application event.

To allow your listener to distinguish between an event for its context and an event for a descendant
context, it should request that its application context is injected and then compare the injected
context with the context of the event. The context can be injected by implementing
ApplicationContextAware or, if the listener is a bean, by using @Autowired.

7.1.8. Web Environment

A SpringApplication attempts to create the right type of ApplicationContext on your behalf. The
algorithm used to determine a WebApplicationType is the following:

• If Spring MVC is present, an AnnotationConfigServletWebServerApplicationContext is used

• If Spring MVC is not present and Spring WebFlux is present, an

AnnotationConfigReactiveWebServerApplicationContext is used

• Otherwise, AnnotationConfigApplicationContext is used

This means that if you are using Spring MVC and the new WebClient from Spring WebFlux in the
same application, Spring MVC will be used by default. You can override that easily by calling
setWebApplicationType(WebApplicationType).

It is also possible to take complete control of the ApplicationContext type that is used by calling
setApplicationContextClass(…).

It is often desirable to call setWebApplicationType(WebApplicationType.NONE) when

TIP
using SpringApplication within a JUnit test.

7.1.9. Accessing Application Arguments

If you need to access the application arguments that were passed to SpringApplication.run(…), you
can inject a org.springframework.boot.ApplicationArguments bean. The ApplicationArguments
interface provides access to both the raw String[] arguments as well as parsed option and non-
option arguments, as shown in the following example:

58
 import java.util.List;

import org.springframework.boot.ApplicationArguments;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  public MyBean(ApplicationArguments args) {

  boolean debug = args.containsOption("debug");
  List<String> files = args.getNonOptionArgs();
  if (debug) {
  System.out.println(files);
  }
  // if run with "--debug logfile.txt" prints ["logfile.txt"]
  }

Spring Boot also registers a CommandLinePropertySource with the Spring Environment.

TIP
This lets you also inject single application arguments by using the @Value annotation.

7.1.10. Using the ApplicationRunner or CommandLineRunner

If you need to run some specific code once the SpringApplication has started, you can implement
the ApplicationRunner or CommandLineRunner interfaces. Both interfaces work in the same way and
offer a single run method, which is called just before SpringApplication.run(…) completes.

This contract is well suited for tasks that should run after application startup but
NOTE
before it starts accepting traffic.

The CommandLineRunner interfaces provides access to application arguments as a string array,

whereas the ApplicationRunner uses the ApplicationArguments interface discussed earlier. The
following example shows a CommandLineRunner with a run method:

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class MyCommandLineRunner implements CommandLineRunner {

  @Override
  public void run(String... args) {
  // Do something...
  }

59
If several CommandLineRunner or ApplicationRunner beans are defined that must be called in a specific
order, you can additionally implement the org.springframework.core.Ordered interface or use the
org.springframework.core.annotation.Order annotation.

7.1.11. Application Exit

Each SpringApplication registers a shutdown hook with the JVM to ensure that the
ApplicationContext closes gracefully on exit. All the standard Spring lifecycle callbacks (such as the
DisposableBean interface or the @PreDestroy annotation) can be used.

In addition, beans may implement the org.springframework.boot.ExitCodeGenerator interface if they

wish to return a specific exit code when SpringApplication.exit() is called. This exit code can then
be passed to System.exit() to return it as a status code, as shown in the following example:

import org.springframework.boot.ExitCodeGenerator;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class MyApplication {

  @Bean
  public ExitCodeGenerator exitCodeGenerator() {
  return () -> 42;
  }

  public static void main(String[] args) {

  System.exit(SpringApplication.exit(SpringApplication.run(MyApplication.class,
args)));
  }

Also, the ExitCodeGenerator interface may be implemented by exceptions. When such an exception
is encountered, Spring Boot returns the exit code provided by the implemented getExitCode()
method.

7.1.12. Admin Features

It is possible to enable admin-related features for the application by specifying the

spring.application.admin.enabled property. This exposes the SpringApplicationAdminMXBean on the
platform MBeanServer. You could use this feature to administer your Spring Boot application
remotely. This feature could also be useful for any service wrapper implementation.

If you want to know on which HTTP port the application is running, get the property
TIP
with a key of local.server.port.

60
7.1.13. Application Startup tracking

During the application startup, the SpringApplication and the ApplicationContext perform many
tasks related to the application lifecycle, the beans lifecycle or even processing application events.
With ApplicationStartup, Spring Framework allows you to track the application startup sequence
with StartupStep objects. This data can be collected for profiling purposes, or just to have a better
understanding of an application startup process.

You can choose an ApplicationStartup implementation when setting up the SpringApplication

instance. For example, to use the BufferingApplicationStartup, you could write:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.metrics.buffering.BufferingApplicationStartup;

@SpringBootApplication
public class MyApplication {

  public static void main(String[] args) {

  SpringApplication application = new SpringApplication(MyApplication.class);
  application.setApplicationStartup(new BufferingApplicationStartup(2048));
  application.run(args);
  }

The first available implementation, FlightRecorderApplicationStartup is provided by Spring

Framework. It adds Spring-specific startup events to a Java Flight Recorder session and is meant for
profiling applications and correlating their Spring context lifecycle with JVM events (such as
allocations, GCs, class loading…). Once configured, you can record data by running the application
with the Flight Recorder enabled:

$ java -XX:StartFlightRecording:filename=recording.jfr,duration=10s -jar demo.jar

Spring Boot ships with the BufferingApplicationStartup variant; this implementation is meant for
buffering the startup steps and draining them into an external metrics system. Applications can ask
for the bean of type BufferingApplicationStartup in any component.

Spring Boot can also be configured to expose a startup endpoint that provides this information as a
JSON document.

7.2. Externalized Configuration

Spring Boot lets you externalize your configuration so that you can work with the same application
code in different environments. You can use a variety of external configuration sources, include
Java properties files, YAML files, environment variables, and command-line arguments.

61
Property values can be injected directly into your beans by using the @Value annotation, accessed
through Spring’s Environment abstraction, or be bound to structured objects through
@ConfigurationProperties.

Spring Boot uses a very particular PropertySource order that is designed to allow sensible
overriding of values. Properties are considered in the following order (with values from lower
items overriding earlier ones):

1. Default properties (specified by setting SpringApplication.setDefaultProperties).

2. @PropertySource annotations on your @Configuration classes. Please note that such property
sources are not added to the Environment until the application context is being refreshed. This is
too late to configure certain properties such as logging.* and spring.main.* which are read
before refresh begins.

3. Config data (such as application.properties files).

4. A RandomValuePropertySource that has properties only in random.*.

5. OS environment variables.

6. Java System properties (System.getProperties()).

7. JNDI attributes from java:comp/env.

8. ServletContext init parameters.

9. ServletConfig init parameters.

10. Properties from SPRING_APPLICATION_JSON (inline JSON embedded in an environment variable or

system property).

11. Command line arguments.

12. properties attribute on your tests. Available on @SpringBootTest and the test annotations for
testing a particular slice of your application.

13. @TestPropertySource annotations on your tests.

14. Devtools global settings properties in the $HOME/.config/spring-boot directory when devtools is
active.

Config data files are considered in the following order:

1. Application properties packaged inside your jar (application.properties and YAML variants).

2. Profile-specific application properties packaged inside your jar (application-

{profile}.properties and YAML variants).

3. Application properties outside of your packaged jar (application.properties and YAML

variants).

4. Profile-specific application properties outside of your packaged jar (application-

{profile}.properties and YAML variants).

It is recommended to stick with one format for your entire application. If you have
NOTE configuration files with both .properties and .yml format in the same location,
.properties takes precedence.

62
To provide a concrete example, suppose you develop a @Component that uses a name property, as
shown in the following example:

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  @Value("${name}")
  private String name;

  // ...

On your application classpath (for example, inside your jar) you can have an
application.properties file that provides a sensible default property value for name. When running
in a new environment, an application.properties file can be provided outside of your jar that
overrides the name. For one-off testing, you can launch with a specific command line switch (for
example, java -jar app.jar --name="Spring").

The env and configprops endpoints can be useful in determining why a property has a
TIP particular value. You can use these two endpoints to diagnose unexpected property
values. See the "Production ready features" section for details.

7.2.1. Accessing Command Line Properties

By default, SpringApplication converts any command line option arguments (that is, arguments
starting with --, such as --server.port=9000) to a property and adds them to the Spring Environment.
As mentioned previously, command line properties always take precedence over file-based
property sources.

If you do not want command line properties to be added to the Environment, you can disable them
by using SpringApplication.setAddCommandLineProperties(false).

7.2.2. JSON Application Properties

Environment variables and system properties often have restrictions that mean some property
names cannot be used. To help with this, Spring Boot allows you to encode a block of properties into
a single JSON structure.

When your application starts, any spring.application.json or SPRING_APPLICATION_JSON properties

will be parsed and added to the Environment.

For example, the SPRING_APPLICATION_JSON property can be supplied on the command line in a UN*X
shell as an environment variable:

63
 $ SPRING_APPLICATION_JSON='{"my":{"name":"test"}}' java -jar myapp.jar

In the preceding example, you end up with my.name=test in the Spring Environment.

The same JSON can also be provided as a system property:

$ java -Dspring.application.json='{"my":{"name":"test"}}' -jar myapp.jar

Or you could supply the JSON by using a command line argument:

$ java -jar myapp.jar --spring.application.json='{"my":{"name":"test"}}'

If you are deploying to a classic Application Server, you could also use a JNDI variable named
java:comp/env/spring.application.json.

Although null values from the JSON will be added to the resulting property source,
the PropertySourcesPropertyResolver treats null properties as missing values. This
NOTE
means that the JSON cannot override properties from lower order property sources
with a null value.

7.2.3. External Application Properties

Spring Boot will automatically find and load application.properties and application.yaml files from
the following locations when your application starts:

1. From the classpath

a. The classpath root

b. The classpath /config package

2. From the current directory

a. The current directory

b. The /config subdirectory in the current directory

c. Immediate child directories of the /config subdirectory

The list is ordered by precedence (with values from lower items overriding earlier ones).
Documents from the loaded files are added as PropertySources to the Spring Environment.

If you do not like application as the configuration file name, you can switch to another file name by
specifying a spring.config.name environment property. For example, to look for
myproject.properties and myproject.yaml files you can run your application as follows:

$ java -jar myproject.jar --spring.config.name=myproject

64
You can also refer to an explicit location by using the spring.config.location environment property.
This properties accepts a comma-separated list of one or more locations to check.

The following example shows how to specify two distinct files:

$ java -jar myproject.jar --spring.config.location=\

  optional:classpath:/default.properties,\
  optional:classpath:/override.properties

Use the prefix optional: if the locations are optional and you do not mind if they do
TIP
not exist.

spring.config.name, spring.config.location, and spring.config.additional-

location are used very early to determine which files have to be loaded. They
WARNING
must be defined as an environment property (typically an OS environment
variable, a system property, or a command-line argument).

If spring.config.location contains directories (as opposed to files), they should end in /. At runtime
they will be appended with the names generated from spring.config.name before being loaded. Files
specified in spring.config.location are imported directly.

Both directory and file location values are also expanded to check for profile-
specific files. For example, if you have a spring.config.location of
NOTE
classpath:myconfig.properties, you will also find appropriate classpath:myconfig-
<profile>.properties files are loaded.

In most situations, each spring.config.location item you add will reference a single file or
directory. Locations are processed in the order that they are defined and later ones can override
the values of earlier ones.

If you have a complex location setup, and you use profile-specific configuration files, you may need
to provide further hints so that Spring Boot knows how they should be grouped. A location group is
a collection of locations that are all considered at the same level. For example, you might want to
group all classpath locations, then all external locations. Items within a location group should be
separated with ;. See the example in the “Profile Specific Files” section for more details.

Locations configured by using spring.config.location replace the default locations. For example, if
spring.config.location is configured with the value optional:classpath:/custom-
config/,optional:file:./custom-config/, the complete set of locations considered is:

1. optional:classpath:custom-config/

2. optional:file:./custom-config/

If you prefer to add additional locations, rather than replacing them, you can use
spring.config.additional-location. Properties loaded from additional locations can override those
in the default locations. For example, if spring.config.additional-location is configured with the
value optional:classpath:/custom-config/,optional:file:./custom-config/, the complete set of

65
locations considered is:

1. optional:classpath:/;optional:classpath:/config/

2. optional:file:./;optional:file:./config/;optional:file:./config/*/

3. optional:classpath:custom-config/

4. optional:file:./custom-config/

This search ordering lets you specify default values in one configuration file and then selectively
override those values in another. You can provide default values for your application in
application.properties (or whatever other basename you choose with spring.config.name) in one of
the default locations. These default values can then be overridden at runtime with a different file
located in one of the custom locations.

If you use environment variables rather than system properties, most operating
systems disallow period-separated key names, but you can use underscores instead
NOTE
(for example, SPRING_CONFIG_NAME instead of spring.config.name). See Binding from
Environment Variables for details.

If your application runs in a servlet container or application server, then JNDI

NOTE properties (in java:comp/env) or servlet context initialization parameters can be
used instead of, or as well as, environment variables or system properties.

Optional Locations

By default, when a specified config data location does not exist, Spring Boot will throw a
ConfigDataLocationNotFoundException and your application will not start.

If you want to specify a location, but you do not mind if it does not always exist, you can use the
optional: prefix. You can use this prefix with the spring.config.location and
spring.config.additional-location properties, as well as with spring.config.import declarations.

For example, a spring.config.import value of optional:file:./myconfig.properties allows your

application to start, even if the myconfig.properties file is missing.

If you want to ignore all ConfigDataLocationNotFoundExceptions and always continue to start your
application, you can use the spring.config.on-not-found property. Set the value to ignore using
SpringApplication.setDefaultProperties(…) or with a system/environment variable.

Wildcard Locations

If a config file location includes the * character for the last path segment, it is considered a wildcard
location. Wildcards are expanded when the config is loaded so that immediate subdirectories are
also checked. Wildcard locations are particularly useful in an environment such as Kubernetes
when there are multiple sources of config properties.

For example, if you have some Redis configuration and some MySQL configuration, you might want
to keep those two pieces of configuration separate, while requiring that both those are present in
an application.properties file. This might result in two separate application.properties files

66
mounted at different locations such as /config/redis/application.properties and
/config/mysql/application.properties. In such a case, having a wildcard location of config/*/, will
result in both files being processed.

By default, Spring Boot includes config/*/ in the default search locations. It means that all
subdirectories of the /config directory outside of your jar will be searched.

You can use wildcard locations yourself with the spring.config.location and
spring.config.additional-location properties.

A wildcard location must contain only one * and end with */ for search locations
NOTE that are directories or */<filename> for search locations that are files. Locations with
wildcards are sorted alphabetically based on the absolute path of the file names.

Wildcard locations only work with external directories. You cannot use a wildcard in a
TIP
classpath: location.

Profile Specific Files

As well as application property files, Spring Boot will also attempt to load profile-specific files using
the naming convention application-{profile}. For example, if your application activates a profile
named prod and uses YAML files, then both application.yml and application-prod.yml will be
considered.

Profile-specific properties are loaded from the same locations as standard application.properties,
with profile-specific files always overriding the non-specific ones. If several profiles are specified, a
last-wins strategy applies. For example, if profiles prod,live are specified by the
spring.profiles.active property, values in application-prod.properties can be overridden by those
in application-live.properties.

67
 The last-wins strategy applies at the location group level. A spring.config.location
of classpath:/cfg/,classpath:/ext/ will not have the same override rules as
classpath:/cfg/;classpath:/ext/.

For example, continuing our prod,live example above, we might have the following
files:

/cfg
  application-live.properties
/ext
  application-live.properties
  application-prod.properties

NOTE When we have a spring.config.location of classpath:/cfg/,classpath:/ext/ we

process all /cfg files before all /ext files:

1. /cfg/application-live.properties

2. /ext/application-prod.properties

3. /ext/application-live.properties

When we have classpath:/cfg/;classpath:/ext/ instead (with a ; delimiter) we

process /cfg and /ext at the same level:

1. /ext/application-prod.properties

2. /cfg/application-live.properties

3. /ext/application-live.properties

The Environment has a set of default profiles (by default, [default]) that are used if no active profiles
are set. In other words, if no profiles are explicitly activated, then properties from application-
default are considered.

Properties files are only ever loaded once. If you have already directly imported a
NOTE
profile specific property files then it will not be imported a second time.

Importing Additional Data

Application properties may import further config data from other locations using the
spring.config.import property. Imports are processed as they are discovered, and are treated as
additional documents inserted immediately below the one that declares the import.

For example, you might have the following in your classpath application.properties file:

Properties

spring.application.name=myapp
spring.config.import=optional:file:./dev.properties

68
Yaml

spring:
  application:
  name: "myapp"
  config:
  import: "optional:file:./dev.properties"

This will trigger the import of a dev.properties file in current directory (if such a file exists). Values
from the imported dev.properties will take precedence over the file that triggered the import. In
the above example, the dev.properties could redefine spring.application.name to a different value.

An import will only be imported once no matter how many times it is declared. The order an
import is defined inside a single document within the properties/yaml file does not matter. For
instance, the two examples below produce the same result:

Properties

spring.config.import=my.properties
my.property=value

Yaml

spring:
  config:
  import: "my.properties"
my:
  property: "value"

Properties

my.property=value
spring.config.import=my.properties

Yaml

my:
  property: "value"
spring:
  config:
  import: "my.properties"

In both of the above examples, the values from the my.properties file will take precedence over the
file that triggered its import.

Several locations can be specified under a single spring.config.import key. Locations will be
processed in the order that they are defined, with later imports taking precedence.

69
 When appropriate, Profile-specific variants are also considered for import. The
NOTE example above would import both my.properties as well as any my-
<profile>.properties variants.

Spring Boot includes pluggable API that allows various different location addresses to
be supported. By default you can import Java Properties, YAML and “configuration
trees”.

Third-party jars can offer support for additional technologies (there is no requirement
TIP
for files to be local). For example, you can imagine config data being from external
stores such as Consul, Apache ZooKeeper or Netflix Archaius.

If you want to support your own locations, see the ConfigDataLocationResolver and
ConfigDataLoader classes in the org.springframework.boot.context.config package.

Importing Extensionless Files

Some cloud platforms cannot add a file extension to volume mounted files. To import these
extensionless files, you need to give Spring Boot a hint so that it knows how to load them. You can
do this by putting an extension hint in square brackets.

For example, suppose you have a /etc/config/myconfig file that you wish to import as yaml. You can
import it from your application.properties using the following:

Properties

spring.config.import=file:/etc/config/myconfig[.yaml]

Yaml

spring:
  config:
  import: "file:/etc/config/myconfig[.yaml]"

Using Configuration Trees

When running applications on a cloud platform (such as Kubernetes) you often need to read config
values that the platform supplies. It is not uncommon to use environment variables for such
purposes, but this can have drawbacks, especially if the value is supposed to be kept secret.

As an alternative to environment variables, many cloud platforms now allow you to map
configuration into mounted data volumes. For example, Kubernetes can volume mount both
ConfigMaps and Secrets.

There are two common volume mount patterns that can be used:

1. A single file contains a complete set of properties (usually written as YAML).

2. Multiple files are written to a directory tree, with the filename becoming the ‘key’ and the

70
 contents becoming the ‘value’.

For the first case, you can import the YAML or Properties file directly using spring.config.import as
described above. For the second case, you need to use the configtree: prefix so that Spring Boot
knows it needs to expose all the files as properties.

As an example, let’s imagine that Kubernetes has mounted the following volume:

etc/
  config/
  myapp/
  username
  password

The contents of the username file would be a config value, and the contents of password would be a
secret.

To import these properties, you can add the following to your application.properties or
application.yaml file:

Properties

spring.config.import=optional:configtree:/etc/config/

Yaml

spring:
  config:
  import: "optional:configtree:/etc/config/"

You can then access or inject myapp.username and myapp.password properties from the Environment in
the usual way.

Filenames with dot notation are also correctly mapped. For example, in the above
NOTE example, a file named myapp.username in /etc/config would result in a
myapp.username property in the Environment.

Configuration tree values can be bound to both string String and byte[] types
TIP
depending on the contents expected.

If you have multiple config trees to import from the same parent folder you can use a wildcard
shortcut. Any configtree: location that ends with /*/ will import all immediate children as config
trees.

For example, given the following volume:

71
 etc/
  config/
  dbconfig/
  db/
  username
  password
  mqconfig/
  mq/
  username
  password

You can use configtree:/etc/config/*/ as the import location:

Properties

spring.config.import=optional:configtree:/etc/config/*/

Yaml

spring:
  config:
  import: "optional:configtree:/etc/config/*/"

This will add db.username, db.password, mq.username and mq.password properties.

Directories loaded using a wildcard are sorted alphabetically. If you need a different
NOTE
order, then you should list each location as a separate import

Configuration trees can also be used for Docker secrets. When a Docker swarm service is granted
access to a secret, the secret gets mounted into the container. For example, if a secret named
db.password is mounted at location /run/secrets/, you can make db.password available to the Spring
environment using the following:

Properties

spring.config.import=optional:configtree:/run/secrets/

Yaml

spring:
  config:
  import: "optional:configtree:/run/secrets/"

Property Placeholders

The values in application.properties and application.yml are filtered through the existing
Environment when they are used, so you can refer back to previously defined values (for example,

72
from System properties). The standard ${name} property-placeholder syntax can be used anywhere
within a value.

For example, the following file will set app.description to “MyApp is a Spring Boot application”:

Properties

app.name=MyApp
app.description=${app.name} is a Spring Boot application

Yaml

app:
  name: "MyApp"
  description: "${app.name} is a Spring Boot application"

You can also use this technique to create “short” variants of existing Spring Boot
TIP
properties. See the Use ‘Short’ Command Line Arguments how-to for details.

Working with Multi-Document Files

Spring Boot allows you to split a single physical file into multiple logical documents which are each
added independently. Documents are processed in order, from top to bottom. Later documents can
override the properties defined in earlier ones.

For application.yml files, the standard YAML multi-document syntax is used. Three consecutive
hyphens represent the end of one document, and the start of the next.

For example, the following file has two logical documents:

spring:
  application:
  name: "MyApp"
---
spring:
  application:
  name: "MyCloudApp"
  config:
  activate:
  on-cloud-platform: "kubernetes"

For application.properties files a special #--- comment is used to mark the document splits:

spring.application.name=MyApp
#---
spring.application.name=MyCloudApp
spring.config.activate.on-cloud-platform=kubernetes

73
 Property file separators must not have any leading whitespace and must have
NOTE exactly three hyphen characters. The lines immediately before and after the
separator must not be comments.

Multi-document property files are often used in conjunction with activation properties
TIP
such as spring.config.activate.on-profile. See the next section for details.

Multi-document property files cannot be loaded by using the @PropertySource

WARNING
or @TestPropertySource annotations.

Activation Properties

It is sometimes useful to only activate a given set of properties when certain conditions are met. For
example, you might have properties that are only relevant when a specific profile is active.

You can conditionally activate a properties document using spring.config.activate.*.

The following activation properties are available:

Table 5. activation properties

Property Note
on-profile A profile expression that must match for the document to be active.
on-cloud-platform The CloudPlatform that must be detected for the document to be active.

For example, the following specifies that the second document is only active when running on
Kubernetes, and only when either the “prod” or “staging” profiles are active:

Properties

myprop=always-set
#---
spring.config.activate.on-cloud-platform=kubernetes
spring.config.activate.on-profile=prod | staging
myotherprop=sometimes-set

Yaml

myprop:
  "always-set"
---
spring:
  config:
  activate:
  on-cloud-platform: "kubernetes"
  on-profile: "prod | staging"
myotherprop: "sometimes-set"

74
7.2.4. Encrypting Properties

Spring Boot does not provide any built in support for encrypting property values, however, it does
provide the hook points necessary to modify values contained in the Spring Environment. The
EnvironmentPostProcessor interface allows you to manipulate the Environment before the application
starts. See Customize the Environment or ApplicationContext Before It Starts for details.

If you need a secure way to store credentials and passwords, the Spring Cloud Vault project
provides support for storing externalized configuration in HashiCorp Vault.

7.2.5. Working with YAML

YAML is a superset of JSON and, as such, is a convenient format for specifying hierarchical
configuration data. The SpringApplication class automatically supports YAML as an alternative to
properties whenever you have the SnakeYAML library on your classpath.

NOTE If you use “Starters”, SnakeYAML is automatically provided by spring-boot-starter.

Mapping YAML to Properties

YAML documents need to be converted from their hierarchical format to a flat structure that can be
used with the Spring Environment. For example, consider the following YAML document:

environments:
  dev:
  url: "https://dev.example.com"
  name: "Developer Setup"
  prod:
  url: "https://another.example.com"
  name: "My Cool App"

In order to access these properties from the Environment, they would be flattened as follows:

environments.dev.url=https://dev.example.com
environments.dev.name=Developer Setup
environments.prod.url=https://another.example.com
environments.prod.name=My Cool App

Likewise, YAML lists also need to be flattened. They are represented as property keys with [index]
dereferencers. For example, consider the following YAML:

my:
 servers:
 - "dev.example.com"
 - "another.example.com"

75
The preceding example would be transformed into these properties:

my.servers[0]=dev.example.com
my.servers[1]=another.example.com

Properties that use the [index] notation can be bound to Java List or Set objects using
TIP Spring Boot’s Binder class. For more details see the “Type-safe Configuration
Properties” section below.

YAML files cannot be loaded by using the @PropertySource or

WARNING @TestPropertySource annotations. So, in the case that you need to load values
that way, you need to use a properties file.

Directly Loading YAML

Spring Framework provides two convenient classes that can be used to load YAML documents. The
YamlPropertiesFactoryBean loads YAML as Properties and the YamlMapFactoryBean loads YAML as a
Map.

You can also use the YamlPropertySourceLoader class if you want to load YAML as a Spring
PropertySource.

7.2.6. Configuring Random Values

The RandomValuePropertySource is useful for injecting random values (for example, into secrets or
test cases). It can produce integers, longs, uuids, or strings, as shown in the following example:

Properties

my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.uuid=${random.uuid}
my.number-less-than-ten=${random.int(10)}
my.number-in-range=${random.int[1024,65536]}

Yaml

my:
  secret: "${random.value}"
  number: "${random.int}"
  bignumber: "${random.long}"
  uuid: "${random.uuid}"
  number-less-than-ten: "${random.int(10)}"
  number-in-range: "${random.int[1024,65536]}"

The random.int* syntax is OPEN value (,max) CLOSE where the OPEN,CLOSE are any character and

76
value,max are integers. If max is provided, then value is the minimum value and max is the maximum
value (exclusive).

7.2.7. Configuring System Environment Properties

Spring Boot supports setting a prefix for environment properties. This is useful if the system
environment is shared by multiple Spring Boot applications with different configuration
requirements. The prefix for system environment properties can be set directly on
SpringApplication.

For example, if you set the prefix to input, a property such as remote.timeout will also be resolved as
input.remote.timeout in the system environment.

7.2.8. Type-safe Configuration Properties

Using the @Value("${property}") annotation to inject configuration properties can sometimes be

cumbersome, especially if you are working with multiple properties or your data is hierarchical in
nature. Spring Boot provides an alternative method of working with properties that lets strongly
typed beans govern and validate the configuration of your application.

TIP See also the differences between @Value and type-safe configuration properties.

JavaBean properties binding

It is possible to bind a bean declaring standard JavaBean properties as shown in the following
example:

import java.net.InetAddress;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my.service")
public class MyProperties {

  private boolean enabled;

  private InetAddress remoteAddress;

  private final Security security = new Security();

  public boolean isEnabled() {

  return this.enabled;
  }

  public void setEnabled(boolean enabled) {

  this.enabled = enabled;

77
   }

  public InetAddress getRemoteAddress() {

  return this.remoteAddress;
  }

  public void setRemoteAddress(InetAddress remoteAddress) {

  this.remoteAddress = remoteAddress;
  }

  public Security getSecurity() {

  return this.security;
  }

  public static class Security {

  private String username;

  private String password;

  private List<String> roles = new ArrayList<>(Collections.singleton("USER"));

  public String getUsername() {

  return this.username;
  }

  public void setUsername(String username) {

  this.username = username;
  }

  public String getPassword() {

  return this.password;
  }

  public void setPassword(String password) {

  this.password = password;
  }

  public List<String> getRoles() {

  return this.roles;
  }

  public void setRoles(List<String> roles) {

  this.roles = roles;
  }

  }

78
The preceding POJO defines the following properties:

• my.service.enabled, with a value of false by default.

• my.service.remote-address, with a type that can be coerced from String.

• my.service.security.username, with a nested "security" object whose name is determined by the

name of the property. In particular, the type is not used at all there and could have been
SecurityProperties.

• my.service.security.password.

• my.service.security.roles, with a collection of String that defaults to USER.

The properties that map to @ConfigurationProperties classes available in Spring

Boot, which are configured through properties files, YAML files, environment
NOTE
variables, and other mechanisms, are public API but the accessors (getters/setters)
of the class itself are not meant to be used directly.

Such arrangement relies on a default empty constructor and getters and setters are
usually mandatory, since binding is through standard Java Beans property
descriptors, just like in Spring MVC. A setter may be omitted in the following cases:

• Maps, as long as they are initialized, need a getter but not necessarily a setter,
since they can be mutated by the binder.

• Collections and arrays can be accessed either through an index (typically with
YAML) or by using a single comma-separated value (properties). In the latter
case, a setter is mandatory. We recommend to always add a setter for such types.
If you initialize a collection, make sure it is not immutable (as in the preceding
NOTE example).

• If nested POJO properties are initialized (like the Security field in the preceding
example), a setter is not required. If you want the binder to create the instance
on the fly by using its default constructor, you need a setter.

Some people use Project Lombok to add getters and setters automatically. Make sure
that Lombok does not generate any particular constructor for such a type, as it is
used automatically by the container to instantiate the object.

Finally, only standard Java Bean properties are considered and binding on static
properties is not supported.

Constructor binding

The example in the previous section can be rewritten in an immutable fashion as shown in the
following example:

import java.net.InetAddress;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;

79
 import org.springframework.boot.context.properties.ConstructorBinding;
import org.springframework.boot.context.properties.bind.DefaultValue;

@ConstructorBinding
@ConfigurationProperties("my.service")
public class MyProperties {

  private final boolean enabled;

  private final InetAddress remoteAddress;

  private final Security security;

  public MyProperties(boolean enabled, InetAddress remoteAddress, Security security)

{
  this.enabled = enabled;
  this.remoteAddress = remoteAddress;
  this.security = security;
  }

  public boolean isEnabled() {

  return this.enabled;
  }

  public InetAddress getRemoteAddress() {

  return this.remoteAddress;
  }

  public Security getSecurity() {

  return this.security;
  }

  public static class Security {

  private final String username;

  private final String password;

  private final List<String> roles;

  public Security(String username, String password, @DefaultValue("USER")

List<String> roles) {
  this.username = username;
  this.password = password;
  this.roles = roles;
  }

  public String getUsername() {

  return this.username;

80
   }

  public String getPassword() {

  return this.password;
  }

  public List<String> getRoles() {

  return this.roles;
  }

  }

In this setup, the @ConstructorBinding annotation is used to indicate that constructor binding should
be used. This means that the binder will expect to find a constructor with the parameters that you
wish to have bound. If you are using Java 16 or later, constructor binding can be used with records.
In this case, unless your record has multiple constructors, there is no need to use
@ConstructorBinding.

Nested members of a @ConstructorBinding class (such as Security in the example above) will also be
bound through their constructor.

Default values can be specified using @DefaultValue and the same conversion service will be applied
to coerce the String value to the target type of a missing property. By default, if no properties are
bound to Security, the MyProperties instance will contain a null value for security. If you wish you
return a non-null instance of Security even when no properties are bound to it, you can use an
empty @DefaultValue annotation to do so:

public MyProperties(boolean enabled, InetAddress remoteAddress, @DefaultValue Security

security) {
  this.enabled = enabled;
  this.remoteAddress = remoteAddress;
  this.security = security;
}

To use constructor binding the class must be enabled using

@EnableConfigurationProperties or configuration property scanning. You cannot use
NOTE constructor binding with beans that are created by the regular Spring mechanisms
(for example @Component beans, beans created by using @Bean methods or beans
loaded by using @Import)

If you have more than one constructor for your class you can also use
TIP
@ConstructorBinding directly on the constructor that should be bound.

81
 The use of java.util.Optional with @ConfigurationProperties is not recommended
as it is primarily intended for use as a return type. As such, it is not well-suited to
NOTE configuration property injection. For consistency with properties of other types, if
you do declare an Optional property and it has no value, null rather than an empty
Optional will be bound.

Enabling @ConfigurationProperties-annotated types

Spring Boot provides infrastructure to bind @ConfigurationProperties types and register them as
beans. You can either enable configuration properties on a class-by-class basis or enable
configuration property scanning that works in a similar manner to component scanning.

Sometimes, classes annotated with @ConfigurationProperties might not be suitable for scanning, for
example, if you’re developing your own auto-configuration or you want to enable them
conditionally. In these cases, specify the list of types to process using the
@EnableConfigurationProperties annotation. This can be done on any @Configuration class, as shown
in the following example:

import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(SomeProperties.class)
public class MyConfiguration {

To use configuration property scanning, add the @ConfigurationPropertiesScan annotation to your

application. Typically, it is added to the main application class that is annotated with
@SpringBootApplication but it can be added to any @Configuration class. By default, scanning will
occur from the package of the class that declares the annotation. If you want to define specific
packages to scan, you can do so as shown in the following example:

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.ConfigurationPropertiesScan;

@SpringBootApplication
@ConfigurationPropertiesScan({ "com.example.app", "com.example.another" })
public class MyApplication {

82
 When the @ConfigurationProperties bean is registered using configuration property
scanning or through @EnableConfigurationProperties, the bean has a conventional
name: <prefix>-<fqn>, where <prefix> is the environment key prefix specified in the
@ConfigurationProperties annotation and <fqn> is the fully qualified name of the
NOTE bean. If the annotation does not provide any prefix, only the fully qualified name of
the bean is used.

The bean name in the example above is com.example.app-

com.example.app.SomeProperties.

We recommend that @ConfigurationProperties only deal with the environment and, in particular,
does not inject other beans from the context. For corner cases, setter injection can be used or any of
the *Aware interfaces provided by the framework (such as EnvironmentAware if you need access to the
Environment). If you still want to inject other beans using the constructor, the configuration
properties bean must be annotated with @Component and use JavaBean-based property binding.

Using @ConfigurationProperties-annotated types

This style of configuration works particularly well with the SpringApplication external YAML
configuration, as shown in the following example:

my:
  service:
  remote-address: 192.168.1.1
  security:
  username: "admin"
  roles:
  - "USER"
  - "ADMIN"

To work with @ConfigurationProperties beans, you can inject them in the same way as any other
bean, as shown in the following example:

83
 import org.springframework.stereotype.Service;

@Service
public class MyService {

  private final SomeProperties properties;

  public MyService(SomeProperties properties) {

  this.properties = properties;
  }

  public void openConnection() {

  Server server = new Server(this.properties.getRemoteAddress());
  server.start();
  // ...
  }

  // ...

Using @ConfigurationProperties also lets you generate metadata files that can be used
TIP
by IDEs to offer auto-completion for your own keys. See the appendix for details.

Third-party Configuration

As well as using @ConfigurationProperties to annotate a class, you can also use it on public @Bean
methods. Doing so can be particularly useful when you want to bind properties to third-party
components that are outside of your control.

To configure a bean from the Environment properties, add @ConfigurationProperties to its bean
registration, as shown in the following example:

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class ThirdPartyConfiguration {

  @Bean
  @ConfigurationProperties(prefix = "another")
  public AnotherComponent anotherComponent() {
  return new AnotherComponent();
  }

84
Any JavaBean property defined with the another prefix is mapped onto that AnotherComponent bean
in manner similar to the preceding SomeProperties example.

Relaxed Binding

Spring Boot uses some relaxed rules for binding Environment properties to @ConfigurationProperties
beans, so there does not need to be an exact match between the Environment property name and the
bean property name. Common examples where this is useful include dash-separated environment
properties (for example, context-path binds to contextPath), and capitalized environment properties
(for example, PORT binds to port).

As an example, consider the following @ConfigurationProperties class:

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "my.main-project.person")
public class MyPersonProperties {

  private String firstName;

  public String getFirstName() {

  return this.firstName;
  }

  public void setFirstName(String firstName) {

  this.firstName = firstName;
  }

With the preceding code, the following properties names can all be used:

Table 6. relaxed binding

Property Note
my.main- Kebab case, which is recommended for use in .properties and .yml files.
project.person.fir
st-name
my.main- Standard camel case syntax.
project.person.fir
stName
my.main- Underscore notation, which is an alternative format for use in .properties and
project.person.fir .yml files.
st_name
MY_MAINPROJECT_PER Upper case format, which is recommended when using system environment
SON_FIRSTNAME variables.

The prefix value for the annotation must be in kebab case (lowercase and separated
NOTE
by -, such as my.main-project.person).

85
Table 7. relaxed binding rules per property source

Property Source Simple List

Properties Files Camel case, kebab case, or underscore Standard list syntax using [ ] or
notation comma-separated values

YAML Files Camel case, kebab case, or underscore Standard YAML list syntax or comma-
notation separated values

Environment Upper case format with underscore as Numeric values surrounded by

Variables the delimiter (see Binding from underscores (see Binding from
Environment Variables). Environment Variables)

System properties Camel case, kebab case, or underscore Standard list syntax using [ ] or
notation comma-separated values

We recommend that, when possible, properties are stored in lower-case kebab format,
TIP
such as my.person.first-name=Rod.

Binding Maps

When binding to Map properties you may need to use a special bracket notation so that the original
key value is preserved. If the key is not surrounded by [], any characters that are not alpha-
numeric, - or . are removed.

For example, consider binding the following properties to a Map<String,String>:

Properties

my.map.[/key1]=value1
my.map.[/key2]=value2
my.map./key3=value3

Yaml

my:
  map:
  "[/key1]": "value1"
  "[/key2]": "value2"
  "/key3": "value3"

For YAML files, the brackets need to be surrounded by quotes for the keys to be
NOTE
parsed properly.

The properties above will bind to a Map with /key1, /key2 and key3 as the keys in the map. The slash
has been removed from key3 because it was not surrounded by square brackets.

You may also occasionally need to use the bracket notation if your key contains a . and you are
binding to non-scalar value. For example, binding a.b=c to Map<String, Object> will return a Map
with the entry {"a"={"b"="c"}} whereas [a.b]=c will return a Map with the entry {"a.b"="c"}.

86
Binding from Environment Variables

Most operating systems impose strict rules around the names that can be used for environment
variables. For example, Linux shell variables can contain only letters (a to z or A to Z), numbers (0 to
9) or the underscore character (_). By convention, Unix shell variables will also have their names in
UPPERCASE.

Spring Boot’s relaxed binding rules are, as much as possible, designed to be compatible with these
naming restrictions.

To convert a property name in the canonical-form to an environment variable name you can follow
these rules:

• Replace dots (.) with underscores (_).

• Remove any dashes (-).

• Convert to uppercase.

For example, the configuration property spring.main.log-startup-info would be an environment

variable named SPRING_MAIN_LOGSTARTUPINFO.

Environment variables can also be used when binding to object lists. To bind to a List, the element
number should be surrounded with underscores in the variable name.

For example, the configuration property my.service[0].other would use an environment variable
named MY_SERVICE_0_OTHER.

Merging Complex Types

When lists are configured in more than one place, overriding works by replacing the entire list.

For example, assume a MyPojo object with name and description attributes that are null by default.
The following example exposes a list of MyPojo objects from MyProperties:

import java.util.ArrayList;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my")
public class MyProperties {

  private final List<MyPojo> list = new ArrayList<>();

  public List<MyPojo> getList() {

  return this.list;
  }

87
Consider the following configuration:

Properties

my.list[0].name=my name
my.list[0].description=my description
#---
spring.config.activate.on-profile=dev
my.list[0].name=my another name

Yaml

my:
  list:
  - name: "my name"
  description: "my description"
---
spring:
  config:
  activate:
  on-profile: "dev"
my:
  list:
  - name: "my another name"

If the dev profile is not active, MyProperties.list contains one MyPojo entry, as previously defined. If
the dev profile is enabled, however, the list still contains only one entry (with a name of my another
name and a description of null). This configuration does not add a second MyPojo instance to the list,
and it does not merge the items.

When a List is specified in multiple profiles, the one with the highest priority (and only that one) is
used. Consider the following example:

Properties

my.list[0].name=my name
my.list[0].description=my description
my.list[1].name=another name
my.list[1].description=another description
#---
spring.config.activate.on-profile=dev
my.list[0].name=my another name

88
Yaml

my:
  list:
  - name: "my name"
  description: "my description"
  - name: "another name"
  description: "another description"
---
spring:
  config:
  activate:
  on-profile: "dev"
my:
  list:
  - name: "my another name"

In the preceding example, if the dev profile is active, MyProperties.list contains one MyPojo entry
(with a name of my another name and a description of null). For YAML, both comma-separated lists
and YAML lists can be used for completely overriding the contents of the list.

For Map properties, you can bind with property values drawn from multiple sources. However, for
the same property in multiple sources, the one with the highest priority is used. The following
example exposes a Map<String, MyPojo> from MyProperties:

import java.util.LinkedHashMap;
import java.util.Map;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my")
public class MyProperties {

  private final Map<String, MyPojo> map = new LinkedHashMap<>();

  public Map<String, MyPojo> getMap() {

  return this.map;
  }

Consider the following configuration:

89
Properties

my.map.key1.name=my name 1
my.map.key1.description=my description 1
#---
spring.config.activate.on-profile=dev
my.map.key1.name=dev name 1
my.map.key2.name=dev name 2
my.map.key2.description=dev description 2

Yaml

my:
  map:
  key1:
  name: "my name 1"
  description: "my description 1"
---
spring:
  config:
  activate:
  on-profile: "dev"
my:
  map:
  key1:
  name: "dev name 1"
  key2:
  name: "dev name 2"
  description: "dev description 2"

If the dev profile is not active, MyProperties.map contains one entry with key key1 (with a name of my
name 1 and a description of my description 1). If the dev profile is enabled, however, map contains
two entries with keys key1 (with a name of dev name 1 and a description of my description 1) and
key2 (with a name of dev name 2 and a description of dev description 2).

The preceding merging rules apply to properties from all property sources, and not
NOTE
just files.

Properties Conversion

Spring Boot attempts to coerce the external application properties to the right type when it binds to
the @ConfigurationProperties beans. If you need custom type conversion, you can provide a
ConversionService bean (with a bean named conversionService) or custom property editors (through
a CustomEditorConfigurer bean) or custom Converters (with bean definitions annotated as
@ConfigurationPropertiesBinding).

90
 As this bean is requested very early during the application lifecycle, make sure to
limit the dependencies that your ConversionService is using. Typically, any
dependency that you require may not be fully initialized at creation time. You may
NOTE
want to rename your custom ConversionService if it is not required for
configuration keys coercion and only rely on custom converters qualified with
@ConfigurationPropertiesBinding.

Converting Durations

Spring Boot has dedicated support for expressing durations. If you expose a java.time.Duration
property, the following formats in application properties are available:

• A regular long representation (using milliseconds as the default unit unless a @DurationUnit has
been specified)

• The standard ISO-8601 format used by java.time.Duration

• A more readable format where the value and the unit are coupled (10s means 10 seconds)

Consider the following example:

91
 import java.time.Duration;
import java.time.temporal.ChronoUnit;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.convert.DurationUnit;

@ConfigurationProperties("my")
public class MyProperties {

  @DurationUnit(ChronoUnit.SECONDS)
  private Duration sessionTimeout = Duration.ofSeconds(30);

  private Duration readTimeout = Duration.ofMillis(1000);

  public Duration getSessionTimeout() {

  return this.sessionTimeout;
  }

  public void setSessionTimeout(Duration sessionTimeout) {

  this.sessionTimeout = sessionTimeout;
  }

  public Duration getReadTimeout() {

  return this.readTimeout;
  }

  public void setReadTimeout(Duration readTimeout) {

  this.readTimeout = readTimeout;
  }

To specify a session timeout of 30 seconds, 30, PT30S and 30s are all equivalent. A read timeout of
500ms can be specified in any of the following form: 500, PT0.5S and 500ms.

You can also use any of the supported units. These are:

• ns for nanoseconds

• us for microseconds

• ms for milliseconds

• s for seconds

• m for minutes

• h for hours

• d for days

The default unit is milliseconds and can be overridden using @DurationUnit as illustrated in the
sample above.

92
If you prefer to use constructor binding, the same properties can be exposed, as shown in the
following example:

import java.time.Duration;
import java.time.temporal.ChronoUnit;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.ConstructorBinding;
import org.springframework.boot.context.properties.bind.DefaultValue;
import org.springframework.boot.convert.DurationUnit;

@ConfigurationProperties("my")
@ConstructorBinding
public class MyProperties {

  private final Duration sessionTimeout;

  private final Duration readTimeout;

  public MyProperties(@DurationUnit(ChronoUnit.SECONDS) @DefaultValue("30s")

Duration sessionTimeout,
  @DefaultValue("1000ms") Duration readTimeout) {
  this.sessionTimeout = sessionTimeout;
  this.readTimeout = readTimeout;
  }

  public Duration getSessionTimeout() {

  return this.sessionTimeout;
  }

  public Duration getReadTimeout() {

  return this.readTimeout;
  }

If you are upgrading a Long property, make sure to define the unit (using
TIP @DurationUnit) if it is not milliseconds. Doing so gives a transparent upgrade path
while supporting a much richer format.

Converting periods

In addition to durations, Spring Boot can also work with java.time.Period type. The following
formats can be used in application properties:

• An regular int representation (using days as the default unit unless a @PeriodUnit has been
specified)

• The standard ISO-8601 format used by java.time.Period

93
 • A simpler format where the value and the unit pairs are coupled (1y3d means 1 year and 3 days)

The following units are supported with the simple format:

• y for years

• m for months

• w for weeks

• d for days

The java.time.Period type never actually stores the number of weeks, it is a

NOTE
shortcut that means “7 days”.

Converting Data Sizes

Spring Framework has a DataSize value type that expresses a size in bytes. If you expose a DataSize
property, the following formats in application properties are available:

• A regular long representation (using bytes as the default unit unless a @DataSizeUnit has been
specified)

• A more readable format where the value and the unit are coupled (10MB means 10 megabytes)

Consider the following example:

94
 import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.convert.DataSizeUnit;
import org.springframework.util.unit.DataSize;
import org.springframework.util.unit.DataUnit;

@ConfigurationProperties("my")
public class MyProperties {

  @DataSizeUnit(DataUnit.MEGABYTES)
  private DataSize bufferSize = DataSize.ofMegabytes(2);

  private DataSize sizeThreshold = DataSize.ofBytes(512);

  public DataSize getBufferSize() {

  return this.bufferSize;
  }

  public void setBufferSize(DataSize bufferSize) {

  this.bufferSize = bufferSize;
  }

  public DataSize getSizeThreshold() {

  return this.sizeThreshold;
  }

  public void setSizeThreshold(DataSize sizeThreshold) {

  this.sizeThreshold = sizeThreshold;
  }

To specify a buffer size of 10 megabytes, 10 and 10MB are equivalent. A size threshold of 256 bytes
can be specified as 256 or 256B.

You can also use any of the supported units. These are:

• B for bytes

• KB for kilobytes

• MB for megabytes

• GB for gigabytes

• TB for terabytes

The default unit is bytes and can be overridden using @DataSizeUnit as illustrated in the sample
above.

If you prefer to use constructor binding, the same properties can be exposed, as shown in the
following example:

95
 import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.ConstructorBinding;
import org.springframework.boot.context.properties.bind.DefaultValue;
import org.springframework.boot.convert.DataSizeUnit;
import org.springframework.util.unit.DataSize;
import org.springframework.util.unit.DataUnit;

@ConfigurationProperties("my")
@ConstructorBinding
public class MyProperties {

  private final DataSize bufferSize;

  private final DataSize sizeThreshold;

  public MyProperties(@DataSizeUnit(DataUnit.MEGABYTES) @DefaultValue("2MB")

DataSize bufferSize,
  @DefaultValue("512B") DataSize sizeThreshold) {
  this.bufferSize = bufferSize;
  this.sizeThreshold = sizeThreshold;
  }

  public DataSize getBufferSize() {

  return this.bufferSize;
  }

  public DataSize getSizeThreshold() {

  return this.sizeThreshold;
  }

If you are upgrading a Long property, make sure to define the unit (using
TIP @DataSizeUnit) if it is not bytes. Doing so gives a transparent upgrade path while
supporting a much richer format.

@ConfigurationProperties Validation

Spring Boot attempts to validate @ConfigurationProperties classes whenever they are annotated
with Spring’s @Validated annotation. You can use JSR-303 javax.validation constraint annotations
directly on your configuration class. To do so, ensure that a compliant JSR-303 implementation is on
your classpath and then add constraint annotations to your fields, as shown in the following
example:

96
 import java.net.InetAddress;

import jakarta.validation.constraints.NotNull;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;

@ConfigurationProperties("my.service")
@Validated
public class MyProperties {

  @NotNull
  private InetAddress remoteAddress;

  public InetAddress getRemoteAddress() {

  return this.remoteAddress;
  }

  public void setRemoteAddress(InetAddress remoteAddress) {

  this.remoteAddress = remoteAddress;
  }

You can also trigger validation by annotating the @Bean method that creates the
TIP
configuration properties with @Validated.

To ensure that validation is always triggered for nested properties, even when no properties are
found, the associated field must be annotated with @Valid. The following example builds on the
preceding MyProperties example:

97
 import java.net.InetAddress;

import jakarta.validation.Valid;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;

@ConfigurationProperties("my.service")
@Validated
public class MyProperties {

  @NotNull
  private InetAddress remoteAddress;

  @Valid
  private final Security security = new Security();

  public InetAddress getRemoteAddress() {

  return this.remoteAddress;
  }

  public void setRemoteAddress(InetAddress remoteAddress) {

  this.remoteAddress = remoteAddress;
  }

  public Security getSecurity() {

  return this.security;
  }

  public static class Security {

  @NotEmpty
  private String username;

  public String getUsername() {

  return this.username;
  }

  public void setUsername(String username) {

  this.username = username;
  }

  }

You can also add a custom Spring Validator by creating a bean definition called
configurationPropertiesValidator. The @Bean method should be declared static. The configuration

98
properties validator is created very early in the application’s lifecycle, and declaring the @Bean
method as static lets the bean be created without having to instantiate the @Configuration class.
Doing so avoids any problems that may be caused by early instantiation.

The spring-boot-actuator module includes an endpoint that exposes all

@ConfigurationProperties beans. Point your web browser to /actuator/configprops or
TIP
use the equivalent JMX endpoint. See the "Production ready features" section for
details.

@ConfigurationProperties vs. @Value

The @Value annotation is a core container feature, and it does not provide the same features as type-
safe configuration properties. The following table summarizes the features that are supported by
@ConfigurationProperties and @Value:

Feature @ConfigurationProperti @Value

es

Relaxed binding Yes Limited (see note

below)

Meta-data support Yes No

SpEL evaluation No Yes

If you do want to use @Value, we recommend that you refer to property names using
their canonical form (kebab-case using only lowercase letters). This will allow
Spring Boot to use the same logic as it does when relaxed binding
@ConfigurationProperties. For example, @Value("{demo.item-price}") will pick up
NOTE
demo.item-price and demo.itemPrice forms from the application.properties file, as
well as DEMO_ITEMPRICE from the system environment. If you used
@Value("{demo.itemPrice}") instead, demo.item-price and DEMO_ITEMPRICE would not
be considered.

If you define a set of configuration keys for your own components, we recommend you group them
in a POJO annotated with @ConfigurationProperties. Doing so will provide you with structured,
type-safe object that you can inject into your own beans.

SpEL expressions from application property files are not processed at time of parsing these files and
populating the environment. However, it is possible to write a SpEL expression in @Value. If the
value of a property from an application property file is a SpEL expression, it will be evaluated when
consumed through @Value.

7.3. Profiles
Spring Profiles provide a way to segregate parts of your application configuration and make it be
available only in certain environments. Any @Component, @Configuration or @ConfigurationProperties
can be marked with @Profile to limit when it is loaded, as shown in the following example:

99
 import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Configuration(proxyBeanMethods = false)
@Profile("production")
public class ProductionConfiguration {

  // ...

If @ConfigurationProperties beans are registered through

@EnableConfigurationProperties instead of automatic scanning, the @Profile
annotation needs to be specified on the @Configuration class that has the
NOTE
@EnableConfigurationProperties annotation. In the case where
@ConfigurationProperties are scanned, @Profile can be specified on the
@ConfigurationProperties class itself.

You can use a spring.profiles.active Environment property to specify which profiles are active. You
can specify the property in any of the ways described earlier in this chapter. For example, you
could include it in your application.properties, as shown in the following example:

Properties

spring.profiles.active=dev,hsqldb

Yaml

spring:
  profiles:
  active: "dev,hsqldb"

You could also specify it on the command line by using the following switch:
--spring.profiles.active=dev,hsqldb.

If no profile is active, a default profile is enabled. The name of the default profile is default and it
can be tuned using the spring.profiles.default Environment property, as shown in the following
example:

Properties

spring.profiles.default=none

100
Yaml

spring:
  profiles:
  default: "none"

7.3.1. Adding Active Profiles

The spring.profiles.active property follows the same ordering rules as other properties: The
highest PropertySource wins. This means that you can specify active profiles in
application.properties and then replace them by using the command line switch.

Sometimes, it is useful to have properties that add to the active profiles rather than replace them.
The SpringApplication entry point has a Java API for setting additional profiles (that is, on top of
those activated by the spring.profiles.active property). See the setAdditionalProfiles() method in
SpringApplication. Profile groups, which are described in the next section can also be used to add
active profiles if a given profile is active.

7.3.2. Profile Groups

Occasionally the profiles that you define and use in your application are too fine-grained and
become cumbersome to use. For example, you might have proddb and prodmq profiles that you use to
enable database and messaging features independently.

To help with this, Spring Boot lets you define profile groups. A profile group allows you to define a
logical name for a related group of profiles.

For example, we can create a production group that consists of our proddb and prodmq profiles.

Properties

spring.profiles.group.production[0]=proddb
spring.profiles.group.production[1]=prodmq

Yaml

spring:
  profiles:
  group:
  production:
  - "proddb"
  - "prodmq"

Our application can now be started using --spring.profiles.active=production to active the

production, proddb and prodmq profiles in one hit.

101
7.3.3. Programmatically Setting Profiles

You can programmatically set active profiles by calling SpringApplication.setAdditionalProfiles(…

) before your application runs. It is also possible to activate profiles by using Spring’s
ConfigurableEnvironment interface.

7.3.4. Profile-specific Configuration Files

Profile-specific variants of both application.properties (or application.yml) and files referenced

through @ConfigurationProperties are considered as files and loaded. See "Profile Specific Files" for
details.

7.4. Logging
Spring Boot uses Commons Logging for all internal logging but leaves the underlying log
implementation open. Default configurations are provided for Java Util Logging, Log4J2, and
Logback. In each case, loggers are pre-configured to use console output with optional file output
also available.

By default, if you use the “Starters”, Logback is used for logging. Appropriate Logback routing is
also included to ensure that dependent libraries that use Java Util Logging, Commons Logging,
Log4J, or SLF4J all work correctly.

There are a lot of logging frameworks available for Java. Do not worry if the above list
TIP seems confusing. Generally, you do not need to change your logging dependencies and
the Spring Boot defaults work just fine.

When you deploy your application to a servlet container or application server, logging
performed with the Java Util Logging API is not routed into your application’s logs.
TIP
This prevents logging performed by the container or other applications that have been
deployed to it from appearing in your application’s logs.

7.4.1. Log Format

The default log output from Spring Boot resembles the following example:

102
 2019-03-05 10:57:51.112 INFO 45469 --- [ main]
org.apache.catalina.core.StandardEngine : Starting Servlet Engine: Apache
Tomcat/7.0.52
2019-03-05 10:57:51.253 INFO 45469 --- [ost-startStop-1]
o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded
WebApplicationContext
2019-03-05 10:57:51.253 INFO 45469 --- [ost-startStop-1]
o.s.web.context.ContextLoader : Root WebApplicationContext: initialization
completed in 1358 ms
2019-03-05 10:57:51.698 INFO 45469 --- [ost-startStop-1]
o.s.b.c.e.ServletRegistrationBean : Mapping servlet: 'dispatcherServlet' to [/]
2019-03-05 10:57:51.702 INFO 45469 --- [ost-startStop-1]
o.s.b.c.embedded.FilterRegistrationBean : Mapping filter: 'hiddenHttpMethodFilter'
to: [/*]

The following items are output:

• Date and Time: Millisecond precision and easily sortable.

• Log Level: ERROR, WARN, INFO, DEBUG, or TRACE.

• Process ID.

• A --- separator to distinguish the start of actual log messages.

• Thread name: Enclosed in square brackets (may be truncated for console output).

• Logger name: This is usually the source class name (often abbreviated).

• The log message.

NOTE Logback does not have a FATAL level. It is mapped to ERROR.

7.4.2. Console Output

The default log configuration echoes messages to the console as they are written. By default, ERROR
-level, WARN-level, and INFO-level messages are logged. You can also enable a “debug” mode by
starting your application with a --debug flag.

$ java -jar myapp.jar --debug

NOTE You can also specify debug=true in your application.properties.

When the debug mode is enabled, a selection of core loggers (embedded container, Hibernate, and
Spring Boot) are configured to output more information. Enabling the debug mode does not
configure your application to log all messages with DEBUG level.

Alternatively, you can enable a “trace” mode by starting your application with a --trace flag (or
trace=true in your application.properties). Doing so enables trace logging for a selection of core
loggers (embedded container, Hibernate schema generation, and the whole Spring portfolio).

103
Color-coded Output

If your terminal supports ANSI, color output is used to aid readability. You can set
spring.output.ansi.enabled to a supported value to override the auto-detection.

Color coding is configured by using the %clr conversion word. In its simplest form, the converter
colors the output according to the log level, as shown in the following example:

%clr(%5p)

The following table describes the mapping of log levels to colors:

Level Color
FATAL Red
ERROR Red
WARN Yellow
INFO Green
DEBUG Green
TRACE Green

Alternatively, you can specify the color or style that should be used by providing it as an option to
the conversion. For example, to make the text yellow, use the following setting:

%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}

The following colors and styles are supported:

• blue

• cyan

• faint

• green

• magenta

• red

• yellow

7.4.3. File Output

By default, Spring Boot logs only to the console and does not write log files. If you want to write log
files in addition to the console output, you need to set a logging.file.name or logging.file.path
property (for example, in your application.properties).

The following table shows how the logging.* properties can be used together:

104
Table 8. Logging properties

logging.file logging.file Example Description

.name .path

(none) (none) Console only logging.

Specific file (none) my.log Writes to the specified log file. Names can be an exact
location or relative to the current directory.

(none) Specific /var/log Writes spring.log to the specified directory. Names can
directory be an exact location or relative to the current directory.

Log files rotate when they reach 10 MB and, as with console output, ERROR-level, WARN-level, and INFO
-level messages are logged by default.

Logging properties are independent of the actual logging infrastructure. As a result,

TIP specific configuration keys (such as logback.configurationFile for Logback) are not
managed by spring Boot.

7.4.4. File Rotation

If you are using the Logback, it is possible to fine-tune log rotation settings using your
application.properties or application.yaml file. For all other logging system, you will need to
configure rotation settings directly yourself (for example, if you use Log4J2 then you could add a
log4j2.xml or log4j2-spring.xml file).

The following rotation policy properties are supported:

Name Description
logging.logback.rollingpolicy.file-name- The filename pattern used to create log archives.
pattern
logging.logback.rollingpolicy.clean-history- If log archive cleanup should occur when the
on-start application starts.
logging.logback.rollingpolicy.max-file-size The maximum size of log file before it is
archived.
logging.logback.rollingpolicy.total-size-cap The maximum amount of size log archives can
take before being deleted.
logging.logback.rollingpolicy.max-history The maximum number of archive log files to
keep (defaults to 7).

7.4.5. Log Levels

All the supported logging systems can have the logger levels set in the Spring Environment (for
example, in application.properties) by using logging.level.<logger-name>=<level> where level is
one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF. The root logger can be configured by
using logging.level.root.

The following example shows potential logging settings in application.properties:

105
Properties

logging.level.root=warn
logging.level.org.springframework.web=debug
logging.level.org.hibernate=error

Yaml

logging:
  level:
  root: "warn"
  org.springframework.web: "debug"
  org.hibernate: "error"

It is also possible to set logging levels using environment variables. For example,
LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG will set org.springframework.web to DEBUG.

The above approach will only work for package level logging. Since relaxed binding
always converts environment variables to lowercase, it is not possible to configure
NOTE
logging for an individual class in this way. If you need to configure logging for a
class, you can use the SPRING_APPLICATION_JSON variable.

7.4.6. Log Groups

It is often useful to be able to group related loggers together so that they can all be configured at the
same time. For example, you might commonly change the logging levels for all Tomcat related
loggers, but you can not easily remember top level packages.

To help with this, Spring Boot allows you to define logging groups in your Spring Environment. For
example, here is how you could define a “tomcat” group by adding it to your
application.properties:

Properties

logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat

Yaml

logging:
  group:
  tomcat: "org.apache.catalina,org.apache.coyote,org.apache.tomcat"

Once defined, you can change the level for all the loggers in the group with a single line:

Properties

logging.level.tomcat=trace

106
Yaml

logging:
  level:
  tomcat: "trace"

Spring Boot includes the following pre-defined logging groups that can be used out-of-the-box:

Name Loggers

web org.springframework.core.codec, org.springframework.http,

org.springframework.web, org.springframework.boot.actuate.endpoint.web,
org.springframework.boot.web.servlet.ServletContextInitializerBeans

sql org.springframework.jdbc.core, org.hibernate.SQL,

org.jooq.tools.LoggerListener

7.4.7. Using a Log Shutdown Hook

In order to release logging resources when your application terminates, a shutdown hook that will
trigger log system cleanup when the JVM exits is provided. This shutdown hook is registered
automatically unless your application is deployed as a war file. If your application has complex
context hierarchies the shutdown hook may not meet your needs. If it does not, disable the
shutdown hook and investigate the options provided directly by the underlying logging system. For
example, Logback offers context selectors which allow each Logger to be created in its own context.
You can use the logging.register-shutdown-hook property to disable the shutdown hook. Setting it to
false will disable the registration. You can set the property in your application.properties or
application.yaml file:

Properties

logging.register-shutdown-hook=false

Yaml

logging:
  register-shutdown-hook: false

7.4.8. Custom Log Configuration

The various logging systems can be activated by including the appropriate libraries on the
classpath and can be further customized by providing a suitable configuration file in the root of the
classpath or in a location specified by the following Spring Environment property: logging.config.

You can force Spring Boot to use a particular logging system by using the
org.springframework.boot.logging.LoggingSystem system property. The value should be the fully
qualified class name of a LoggingSystem implementation. You can also disable Spring Boot’s logging
configuration entirely by using a value of none.

107
 Since logging is initialized before the ApplicationContext is created, it is not possible
NOTE to control logging from @PropertySources in Spring @Configuration files. The only
way to change the logging system or disable it entirely is through System properties.

Depending on your logging system, the following files are loaded:

Logging System Customization

Logback logback-spring.xml, logback-spring.groovy,

logback.xml, or logback.groovy

Log4j2 log4j2-spring.xml or log4j2.xml

JDK (Java Util Logging) logging.properties

When possible, we recommend that you use the -spring variants for your logging
configuration (for example, logback-spring.xml rather than logback.xml). If you use
NOTE
standard configuration locations, Spring cannot completely control log
initialization.

There are known classloading issues with Java Util Logging that cause
WARNING problems when running from an 'executable jar'. We recommend that you
avoid it when running from an 'executable jar' if at all possible.

To help with the customization, some other properties are transferred from the Spring Environment
to System properties, as described in the following table:

Spring Environment System Property Comments

logging.exception-conversion- LOG_EXCEPTION_CONVERSION_WORD The conversion word used
word when logging exceptions.
logging.file.name LOG_FILE If defined, it is used in the
default log configuration.
logging.file.path LOG_PATH If defined, it is used in the
default log configuration.
logging.pattern.console CONSOLE_LOG_PATTERN The log pattern to use on the
console (stdout).
logging.pattern.dateformat LOG_DATEFORMAT_PATTERN Appender pattern for log date
format.
logging.charset.console CONSOLE_LOG_CHARSET The charset to use for console
logging.
logging.pattern.file FILE_LOG_PATTERN The log pattern to use in a file
(if LOG_FILE is enabled).
logging.charset.file FILE_LOG_CHARSET The charset to use for file
logging (if LOG_FILE is enabled).

108
Spring Environment System Property Comments
logging.pattern.level LOG_LEVEL_PATTERN The format to use when
rendering the log level (default
%5p).
PID PID The current process ID
(discovered if possible and
when not already defined as an
OS environment variable).

If you use Logback, the following properties are also transferred:

Spring Environment System Property Comments

logging.logback.rollingpolicy. LOGBACK_ROLLINGPOLICY_FILE_NAM Pattern for rolled-over log file
file-name-pattern E_PATTERN names (default
${LOG_FILE}.%d{yyyy-MM-
dd}.%i.gz).
logging.logback.rollingpolicy. LOGBACK_ROLLINGPOLICY_CLEAN_HI Whether to clean the archive
clean-history-on-start STORY_ON_START log files on startup.
logging.logback.rollingpolicy. LOGBACK_ROLLINGPOLICY_MAX_FILE Maximum log file size.
max-file-size _SIZE
logging.logback.rollingpolicy. LOGBACK_ROLLINGPOLICY_TOTAL_SI Total size of log backups to be
total-size-cap ZE_CAP kept.
logging.logback.rollingpolicy. LOGBACK_ROLLINGPOLICY_MAX_HIST Maximum number of archive
max-history ORY log files to keep.

All the supported logging systems can consult System properties when parsing their configuration
files. See the default configurations in spring-boot.jar for examples:

• Logback

• Log4j 2

• Java Util logging

If you want to use a placeholder in a logging property, you should use Spring Boot’s
syntax and not the syntax of the underlying framework. Notably, if you use Logback,
TIP
you should use : as the delimiter between a property name and its default value and
not use :-.

109
 You can add MDC and other ad-hoc content to log lines by overriding only the
LOG_LEVEL_PATTERN (or logging.pattern.level with Logback). For example, if you use
logging.pattern.level=user:%X{user} %5p, then the default log format contains an MDC
entry for "user", if it exists, as shown in the following example.
TIP

2019-08-30 12:30:04.031 user:someone INFO 22174 --- [ nio-8080-exec-0]

demo.Controller
Handling authenticated request

7.4.9. Logback Extensions

Spring Boot includes a number of extensions to Logback that can help with advanced configuration.
You can use these extensions in your logback-spring.xml configuration file.

Because the standard logback.xml configuration file is loaded too early, you cannot
NOTE use extensions in it. You need to either use logback-spring.xml or define a
logging.config property.

The extensions cannot be used with Logback’s configuration scanning. If you

WARNING attempt to do so, making changes to the configuration file results in an error
similar to one of the following being logged:

ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for

[springProperty], current ElementPath is [[configuration][springProperty]]
ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for
[springProfile], current ElementPath is [[configuration][springProfile]]

Profile-specific Configuration

The <springProfile> tag lets you optionally include or exclude sections of configuration based on
the active Spring profiles. Profile sections are supported anywhere within the <configuration>
element. Use the name attribute to specify which profile accepts the configuration. The
<springProfile> tag can contain a profile name (for example staging) or a profile expression. A
profile expression allows for more complicated profile logic to be expressed, for example
production & (eu-central | eu-west). Check the reference guide for more details. The following
listing shows three sample profiles:

110
 <springProfile name="staging">
  <!-- configuration to be enabled when the "staging" profile is active -->
</springProfile>

<springProfile name="dev | staging">

  <!-- configuration to be enabled when the "dev" or "staging" profiles are active
-->
</springProfile>

<springProfile name="!production">
  <!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>

Environment Properties

The <springProperty> tag lets you expose properties from the Spring Environment for use within
Logback. Doing so can be useful if you want to access values from your application.properties file
in your Logback configuration. The tag works in a similar way to Logback’s standard <property> tag.
However, rather than specifying a direct value, you specify the source of the property (from the
Environment). If you need to store the property somewhere other than in local scope, you can use
the scope attribute. If you need a fallback value (in case the property is not set in the Environment),
you can use the defaultValue attribute. The following example shows how to expose properties for
use within Logback:

<springProperty scope="context" name="fluentHost" source="myapp.fluentd.host"

  defaultValue="localhost"/>
<appender name="FLUENT" class="ch.qos.logback.more.appenders.DataFluentAppender">
  <remoteHost>${fluentHost}</remoteHost>
  ...
</appender>

The source must be specified in kebab case (such as my.property-name). However,

NOTE
properties can be added to the Environment by using the relaxed rules.

7.5. Internationalization
Spring Boot supports localized messages so that your application can cater to users of different
language preferences. By default, Spring Boot looks for the presence of a messages resource bundle
at the root of the classpath.

The auto-configuration applies when the default properties file for the configured
resource bundle is available (messages.properties by default). If your resource
NOTE bundle contains only language-specific properties files, you are required to add the
default. If no properties file is found that matches any of the configured base
names, there will be no auto-configured MessageSource.

111
The basename of the resource bundle as well as several other attributes can be configured using
the spring.messages namespace, as shown in the following example:

Properties

spring.messages.basename=messages,config.i18n.messages
spring.messages.fallback-to-system-locale=false

Yaml

spring:
  messages:
  basename: "messages,config.i18n.messages"
  fallback-to-system-locale: false

spring.messages.basename supports comma-separated list of locations, either a package

TIP
qualifier or a resource resolved from the classpath root.

See MessageSourceProperties for more supported options.

7.6. JSON
Spring Boot provides integration with three JSON mapping libraries:

• Gson

• Jackson

• JSON-B

Jackson is the preferred and default library.

7.6.1. Jackson

Auto-configuration for Jackson is provided and Jackson is part of spring-boot-starter-json. When

Jackson is on the classpath an ObjectMapper bean is automatically configured. Several configuration
properties are provided for customizing the configuration of the ObjectMapper.

7.6.2. Gson

Auto-configuration for Gson is provided. When Gson is on the classpath a Gson bean is automatically
configured. Several spring.gson.* configuration properties are provided for customizing the
configuration. To take more control, one or more GsonBuilderCustomizer beans can be used.

7.6.3. JSON-B

Auto-configuration for JSON-B is provided. When the JSON-B API and an implementation are on the
classpath a Jsonb bean will be automatically configured. The preferred JSON-B implementation is
Eclipse Yasson for which dependency management is provided.

112
7.7. Task Execution and Scheduling
In the absence of an Executor bean in the context, Spring Boot auto-configures a
ThreadPoolTaskExecutor with sensible defaults that can be automatically associated to asynchronous
task execution (@EnableAsync) and Spring MVC asynchronous request processing.

If you have defined a custom Executor in the context, regular task execution (that is
@EnableAsync) will use it transparently but the Spring MVC support will not be
configured as it requires an AsyncTaskExecutor implementation (named
applicationTaskExecutor). Depending on your target arrangement, you could change
TIP your Executor into a ThreadPoolTaskExecutor or define both a ThreadPoolTaskExecutor
and an AsyncConfigurer wrapping your custom Executor.

The auto-configured TaskExecutorBuilder allows you to easily create instances that

reproduce what the auto-configuration does by default.

The thread pool uses 8 core threads that can grow and shrink according to the load. Those default
settings can be fine-tuned using the spring.task.execution namespace, as shown in the following
example:

Properties

spring.task.execution.pool.max-size=16
spring.task.execution.pool.queue-capacity=100
spring.task.execution.pool.keep-alive=10s

Yaml

spring:
  task:
  execution:
  pool:
  max-size: 16
  queue-capacity: 100
  keep-alive: "10s"

This changes the thread pool to use a bounded queue so that when the queue is full (100 tasks), the
thread pool increases to maximum 16 threads. Shrinking of the pool is more aggressive as threads
are reclaimed when they are idle for 10 seconds (rather than 60 seconds by default).

A ThreadPoolTaskScheduler can also be auto-configured if need to be associated to scheduled task

execution (using @EnableScheduling for instance). The thread pool uses one thread by default and its
settings can be fine-tuned using the spring.task.scheduling namespace, as shown in the following
example:

113
Properties

spring.task.scheduling.thread-name-prefix=scheduling-
spring.task.scheduling.pool.size=2

Yaml

spring:
  task:
  scheduling:
  thread-name-prefix: "scheduling-"
  pool:
  size: 2

Both a TaskExecutorBuilder bean and a TaskSchedulerBuilder bean are made available in the context
if a custom executor or scheduler needs to be created.

7.8. Testing
Spring Boot provides a number of utilities and annotations to help when testing your application.
Test support is provided by two modules: spring-boot-test contains core items, and spring-boot-
test-autoconfigure supports auto-configuration for tests.

Most developers use the spring-boot-starter-test “Starter”, which imports both Spring Boot test
modules as well as JUnit Jupiter, AssertJ, Hamcrest, and a number of other useful libraries.

If you have tests that use JUnit 4, JUnit 5’s vintage engine can be used to run them. To
use the vintage engine, add a dependency on junit-vintage-engine, as shown in the
following example:

<dependency>
  <groupId>org.junit.vintage</groupId>
  <artifactId>junit-vintage-engine</artifactId>
TIP   <scope>test</scope>
  <exclusions>
  <exclusion>
  <groupId>org.hamcrest</groupId>
  <artifactId>hamcrest-core</artifactId>
  </exclusion>
  </exclusions>
</dependency>

hamcrest-core is excluded in favor of org.hamcrest:hamcrest that is part of spring-boot-starter-test.

7.8.1. Test Scope Dependencies

The spring-boot-starter-test “Starter” (in the test scope) contains the following provided libraries:

114
 • JUnit 5: The de-facto standard for unit testing Java applications.

• Spring Test & Spring Boot Test: Utilities and integration test support for Spring Boot
applications.

• AssertJ: A fluent assertion library.

• Hamcrest: A library of matcher objects (also known as constraints or predicates).

• Mockito: A Java mocking framework.

• JSONassert: An assertion library for JSON.

• JsonPath: XPath for JSON.

We generally find these common libraries to be useful when writing tests. If these libraries do not
suit your needs, you can add additional test dependencies of your own.

7.8.2. Testing Spring Applications

One of the major advantages of dependency injection is that it should make your code easier to unit
test. You can instantiate objects by using the new operator without even involving Spring. You can
also use mock objects instead of real dependencies.

Often, you need to move beyond unit testing and start integration testing (with a Spring
ApplicationContext). It is useful to be able to perform integration testing without requiring
deployment of your application or needing to connect to other infrastructure.

The Spring Framework includes a dedicated test module for such integration testing. You can
declare a dependency directly to org.springframework:spring-test or use the spring-boot-starter-
test “Starter” to pull it in transitively.

If you have not used the spring-test module before, you should start by reading the relevant
section of the Spring Framework reference documentation.

7.8.3. Testing Spring Boot Applications

A Spring Boot application is a Spring ApplicationContext, so nothing very special has to be done to
test it beyond what you would normally do with a vanilla Spring context.

External properties, logging, and other features of Spring Boot are installed in the
NOTE
context by default only if you use SpringApplication to create it.

Spring Boot provides a @SpringBootTest annotation, which can be used as an alternative to the
standard spring-test @ContextConfiguration annotation when you need Spring Boot features. The
annotation works by creating the ApplicationContext used in your tests through SpringApplication.
In addition to @SpringBootTest a number of other annotations are also provided for testing more
specific slices of an application.

115
 If you are using JUnit 4, do not forget to also add @RunWith(SpringRunner.class) to your
test, otherwise the annotations will be ignored. If you are using JUnit 5, there is no
TIP
need to add the equivalent @ExtendWith(SpringExtension.class) as @SpringBootTest and
the other @…Test annotations are already annotated with it.

By default, @SpringBootTest will not start a server. You can use the webEnvironment attribute of
@SpringBootTest to further refine how your tests run:

• MOCK(Default) : Loads a web ApplicationContext and provides a mock web environment.

Embedded servers are not started when using this annotation. If a web environment is not
available on your classpath, this mode transparently falls back to creating a regular non-web
ApplicationContext. It can be used in conjunction with @AutoConfigureMockMvc or
@AutoConfigureWebTestClient for mock-based testing of your web application.

• RANDOM_PORT: Loads a WebServerApplicationContext and provides a real web environment.

Embedded servers are started and listen on a random port.

• DEFINED_PORT: Loads a WebServerApplicationContext and provides a real web environment.

Embedded servers are started and listen on a defined port (from your application.properties)
or on the default port of 8080.

• NONE: Loads an ApplicationContext by using SpringApplication but does not provide any web
environment (mock or otherwise).

If your test is @Transactional, it rolls back the transaction at the end of each test
method by default. However, as using this arrangement with either RANDOM_PORT or
NOTE DEFINED_PORT implicitly provides a real servlet environment, the HTTP client and
server run in separate threads and, thus, in separate transactions. Any transaction
initiated on the server does not roll back in this case.

@SpringBootTest with webEnvironment = WebEnvironment.RANDOM_PORT will also start

NOTE the management server on a separate random port if your application uses a
different port for the management server.

Detecting Web Application Type

If Spring MVC is available, a regular MVC-based application context is configured. If you have only
Spring WebFlux, we will detect that and configure a WebFlux-based application context instead.

If both are present, Spring MVC takes precedence. If you want to test a reactive web application in
this scenario, you must set the spring.main.web-application-type property:

116
 import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest(properties = "spring.main.web-application-type=reactive")
class MyWebFluxTests {

  // ...

Detecting Test Configuration

If you are familiar with the Spring Test Framework, you may be used to using
@ContextConfiguration(classes=…) in order to specify which Spring @Configuration to load.
Alternatively, you might have often used nested @Configuration classes within your test.

When testing Spring Boot applications, this is often not required. Spring Boot’s @*Test annotations
search for your primary configuration automatically whenever you do not explicitly define one.

The search algorithm works up from the package that contains the test until it finds a class
annotated with @SpringBootApplication or @SpringBootConfiguration. As long as you structured your
code in a sensible way, your main configuration is usually found.

If you use a test annotation to test a more specific slice of your application, you
should avoid adding configuration settings that are specific to a particular area on
the main method’s application class.

NOTE The underlying component scan configuration of @SpringBootApplication defines

exclude filters that are used to make sure slicing works as expected. If you are using
an explicit @ComponentScan directive on your @SpringBootApplication-annotated class,
be aware that those filters will be disabled. If you are using slicing, you should
define them again.

If you want to customize the primary configuration, you can use a nested @TestConfiguration class.
Unlike a nested @Configuration class, which would be used instead of your application’s primary
configuration, a nested @TestConfiguration class is used in addition to your application’s primary
configuration.

Spring’s test framework caches application contexts between tests. Therefore, as

NOTE long as your tests share the same configuration (no matter how it is discovered), the
potentially time-consuming process of loading the context happens only once.

Excluding Test Configuration

If your application uses component scanning (for example, if you use @SpringBootApplication or
@ComponentScan), you may find top-level configuration classes that you created only for specific tests
accidentally get picked up everywhere.

As we have seen earlier, @TestConfiguration can be used on an inner class of a test to customize the

117
primary configuration. When placed on a top-level class, @TestConfiguration indicates that classes
in src/test/java should not be picked up by scanning. You can then import that class explicitly
where it is required, as shown in the following example:

import org.junit.jupiter.api.Test;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Import;

@SpringBootTest
@Import(MyTestsConfiguration.class)
class MyTests {

  @Test
  void exampleTest() {
  // ...
  }

If you directly use @ComponentScan (that is, not through @SpringBootApplication) you
NOTE
need to register the TypeExcludeFilter with it. See the Javadoc for details.

Using Application Arguments

If your application expects arguments, you can have @SpringBootTest inject them using the args
attribute.

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.test.context.SpringBootTest;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(args = "--app.test=one")
class MyApplicationArgumentTests {

  @Test
  void applicationArgumentsPopulated(@Autowired ApplicationArguments args) {
  assertThat(args.getOptionNames()).containsOnly("app.test");
  assertThat(args.getOptionValues("app.test")).containsOnly("one");
  }

118
Testing with a mock environment

By default, @SpringBootTest does not start the server but instead sets up a mock environment for
testing web endpoints.

With Spring MVC, we can query our web endpoints using MockMvc or WebTestClient, as shown in the
following example:

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.reactive.server.WebTestClient;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;

import static
org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static
org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
@AutoConfigureMockMvc
class MyMockMvcTests {

  @Test
  void testWithMockMvc(@Autowired MockMvc mvc) throws Exception {
 
mvc.perform(get("/")).andExpect(status().isOk()).andExpect(content().string("Hello
World"));
  }

  // If Spring WebFlux is on the classpath, you can drive MVC tests with a
WebTestClient
  @Test
  void testWithWebTestClient(@Autowired WebTestClient webClient) {
  webClient
  .get().uri("/")
  .exchange()
  .expectStatus().isOk()
  .expectBody(String.class).isEqualTo("Hello World");
  }

If you want to focus only on the web layer and not start a complete
TIP
ApplicationContext, consider using @WebMvcTest instead.

119
With Spring WebFlux endpoints, you can use WebTestClient as shown in the following example:

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import
org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.reactive.server.WebTestClient;

@SpringBootTest
@AutoConfigureWebTestClient
class MyMockWebTestClientTests {

  @Test
  void exampleTest(@Autowired WebTestClient webClient) {
  webClient
  .get().uri("/")
  .exchange()
  .expectStatus().isOk()
  .expectBody(String.class).isEqualTo("Hello World");
  }

Testing within a mocked environment is usually faster than running with a full servlet
container. However, since mocking occurs at the Spring MVC layer, code that relies on
lower-level servlet container behavior cannot be directly tested with MockMvc.

TIP For example, Spring Boot’s error handling is based on the “error page” support
provided by the servlet container. This means that, whilst you can test your MVC layer
throws and handles exceptions as expected, you cannot directly test that a specific
custom error page is rendered. If you need to test these lower-level concerns, you can
start a fully running server as described in the next section.

Testing with a running server

If you need to start a full running server, we recommend that you use random ports. If you use
@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT), an available port is picked at random
each time your test runs.

The @LocalServerPort annotation can be used to inject the actual port used into your test. For
convenience, tests that need to make REST calls to the started server can additionally @Autowire a
WebTestClient, which resolves relative links to the running server and comes with a dedicated API
for verifying responses, as shown in the following example:

120
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.test.web.reactive.server.WebTestClient;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyRandomPortWebTestClientTests {

  @Test
  void exampleTest(@Autowired WebTestClient webClient) {
  webClient
  .get().uri("/")
  .exchange()
  .expectStatus().isOk()
  .expectBody(String.class).isEqualTo("Hello World");
  }

TIP WebTestClient can be used against both live servers and mock environments.

This setup requires spring-webflux on the classpath. If you can not or will not add webflux, Spring
Boot also provides a TestRestTemplate facility:

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.test.web.client.TestRestTemplate;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyRandomPortTestRestTemplateTests {

  @Test
  void exampleTest(@Autowired TestRestTemplate restTemplate) {
  String body = restTemplate.getForObject("/", String.class);
  assertThat(body).isEqualTo("Hello World");
  }

121
Customizing WebTestClient

To customize the WebTestClient bean, configure a WebTestClientBuilderCustomizer bean. Any such

beans are called with the WebTestClient.Builder that is used to create the WebTestClient.

Using JMX

As the test context framework caches context, JMX is disabled by default to prevent identical
components to register on the same domain. If such test needs access to an MBeanServer, consider
marking it dirty as well:

import javax.management.MBeanServer;
import javax.management.MalformedObjectNameException;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.junit.jupiter.SpringExtension;

import static org.assertj.core.api.Assertions.assertThat;

@ExtendWith(SpringExtension.class)
@SpringBootTest(properties = "spring.jmx.enabled=true")
@DirtiesContext
class MyJmxTests {

  @Autowired
  private MBeanServer mBeanServer;

  @Test
  void exampleTest() throws MalformedObjectNameException {
  assertThat(this.mBeanServer.getDomains()).contains("java.lang");
  // ...
  }

Using Metrics

Regardless of your classpath, meter registries, except the in-memory backed, are not auto-
configured when using @SpringBootTest.

If you need to export metrics to a different backend as part of an integration test, annotate it with
@AutoConfigureMetrics.

122
Mocking and Spying Beans

When running tests, it is sometimes necessary to mock certain components within your application
context. For example, you may have a facade over some remote service that is unavailable during
development. Mocking can also be useful when you want to simulate failures that might be hard to
trigger in a real environment.

Spring Boot includes a @MockBean annotation that can be used to define a Mockito mock for a bean
inside your ApplicationContext. You can use the annotation to add new beans or replace a single
existing bean definition. The annotation can be used directly on test classes, on fields within your
test, or on @Configuration classes and fields. When used on a field, the instance of the created mock
is also injected. Mock beans are automatically reset after each test method.

If your test uses one of Spring Boot’s test annotations (such as @SpringBootTest), this
feature is automatically enabled. To use this feature with a different arrangement,
listeners must be explicitly added, as shown in the following example:

import
org.springframework.boot.test.mock.mockito.MockitoTestExecutionListener;
import
org.springframework.boot.test.mock.mockito.ResetMocksTestExecutionListen
er;
import org.springframework.test.context.ContextConfiguration;
NOTE
import org.springframework.test.context.TestExecutionListeners;

@ContextConfiguration(classes = MyConfig.class)
@TestExecutionListeners({ MockitoTestExecutionListener.class,
ResetMocksTestExecutionListener.class })
class MyTests {

  // ...

The following example replaces an existing RemoteService bean with a mock implementation:

123
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;

import static org.assertj.core.api.Assertions.assertThat;

import static org.mockito.BDDMockito.given;

@SpringBootTest
class MyTests {

  @Autowired
  private Reverser reverser;

  @MockBean
  private RemoteService remoteService;

  @Test
  void exampleTest() {
  given(this.remoteService.getValue()).willReturn("spring");
  String reverse = this.reverser.getReverseValue(); // Calls injected
RemoteService
  assertThat(reverse).isEqualTo("gnirps");
  }

@MockBean cannot be used to mock the behavior of a bean that is exercised during
application context refresh. By the time the test is executed, the application context
NOTE
refresh has completed and it is too late to configure the mocked behavior. We
recommend using a @Bean method to create and configure the mock in this situation.

Additionally, you can use @SpyBean to wrap any existing bean with a Mockito spy. See the Javadoc for
full details.

CGLib proxies, such as those created for scoped beans, declare the proxied methods
as final. This stops Mockito from functioning correctly as it cannot mock or spy on
final methods in its default configuration. If you want to mock or spy on such a
NOTE
bean, configure Mockito to use its inline mock maker by adding
org.mockito:mockito-inline to your application’s test dependencies. This allows
Mockito to mock and spy on final methods.

While Spring’s test framework caches application contexts between tests and reuses
NOTE a context for tests sharing the same configuration, the use of @MockBean or @SpyBean
influences the cache key, which will most likely increase the number of contexts.

124
 If you are using @SpyBean to spy on a bean with @Cacheable methods that refer to
parameters by name, your application must be compiled with -parameters. This
TIP
ensures that the parameter names are available to the caching infrastructure once the
bean has been spied upon.

When you are using @SpyBean to spy on a bean that is proxied by Spring, you may need
TIP to remove Spring’s proxy in some situations, for example when setting expectations
using given or when. Use AopTestUtils.getTargetObject(yourProxiedSpy) to do so.

Auto-configured Tests

Spring Boot’s auto-configuration system works well for applications but can sometimes be a little
too much for tests. It often helps to load only the parts of the configuration that are required to test
a “slice” of your application. For example, you might want to test that Spring MVC controllers are
mapping URLs correctly, and you do not want to involve database calls in those tests, or you might
want to test JPA entities, and you are not interested in the web layer when those tests run.

The spring-boot-test-autoconfigure module includes a number of annotations that can be used to

automatically configure such “slices”. Each of them works in a similar way, providing a @…Test
annotation that loads the ApplicationContext and one or more @AutoConfigure… annotations that
can be used to customize auto-configuration settings.

Each slice restricts component scan to appropriate components and loads a very
restricted set of auto-configuration classes. If you need to exclude one of them, most
NOTE
@…Test annotations provide an excludeAutoConfiguration attribute. Alternatively,
you can use @ImportAutoConfiguration#exclude.

Including multiple “slices” by using several @…Test annotations in one test is not
NOTE supported. If you need multiple “slices”, pick one of the @…Test annotations and
include the @AutoConfigure… annotations of the other “slices” by hand.

It is also possible to use the @AutoConfigure… annotations with the standard

TIP @SpringBootTest annotation. You can use this combination if you are not interested in
“slicing” your application but you want some of the auto-configured test beans.

Auto-configured JSON Tests

To test that object JSON serialization and deserialization is working as expected, you can use the
@JsonTest annotation. @JsonTest auto-configures the available supported JSON mapper, which can
be one of the following libraries:

• Jackson ObjectMapper, any @JsonComponent beans and any Jackson Modules

• Gson

• Jsonb

125
 A list of the auto-configurations that are enabled by @JsonTest can be found in the
TIP
appendix.

If you need to configure elements of the auto-configuration, you can use the
@AutoConfigureJsonTesters annotation.

Spring Boot includes AssertJ-based helpers that work with the JSONAssert and JsonPath libraries to
check that JSON appears as expected. The JacksonTester, GsonTester, JsonbTester, and
BasicJsonTester classes can be used for Jackson, Gson, Jsonb, and Strings respectively. Any helper
fields on the test class can be @Autowired when using @JsonTest. The following example shows a test
class for Jackson:

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.json.JsonTest;
import org.springframework.boot.test.json.JacksonTester;

import static org.assertj.core.api.Assertions.assertThat;

@JsonTest
class MyJsonTests {

  @Autowired
  private JacksonTester<VehicleDetails> json;

  @Test
  void serialize() throws Exception {
  VehicleDetails details = new VehicleDetails("Honda", "Civic");
  // Assert against a `.json` file in the same package as the test
  assertThat(this.json.write(details)).isEqualToJson("expected.json");
  // Or use JSON path based assertions
  assertThat(this.json.write(details)).hasJsonPathStringValue("@.make");
 
assertThat(this.json.write(details)).extractingJsonPathStringValue("@.make").isEqualTo
("Honda");
  }

  @Test
  void deserialize() throws Exception {
  String content = "{\"make\":\"Ford\",\"model\":\"Focus\"}";
  assertThat(this.json.parse(content)).isEqualTo(new VehicleDetails("Ford",
"Focus"));
  assertThat(this.json.parseObject(content).getMake()).isEqualTo("Ford");
  }

126
 JSON helper classes can also be used directly in standard unit tests. To do so, call the
NOTE
initFields method of the helper in your @Before method if you do not use @JsonTest.

If you use Spring Boot’s AssertJ-based helpers to assert on a number value at a given JSON path, you
might not be able to use isEqualTo depending on the type. Instead, you can use AssertJ’s satisfies to
assert that the value matches the given condition. For instance, the following example asserts that
the actual number is a float value close to 0.15 within an offset of 0.01.

@Test
void someTest() throws Exception {
  SomeObject value = new SomeObject(0.152f);
 
assertThat(this.json.write(value)).extractingJsonPathNumberValue("@.test.numberValue")
  .satisfies((number) -> assertThat(number.floatValue()).isCloseTo(0.15f,
within(0.01f)));
}

Auto-configured Spring MVC Tests

To test whether Spring MVC controllers are working as expected, use the @WebMvcTest annotation.
@WebMvcTest auto-configures the Spring MVC infrastructure and limits scanned beans to @Controller,
@ControllerAdvice, @JsonComponent, Converter, GenericConverter, Filter, HandlerInterceptor,
WebMvcConfigurer, WebMvcRegistrations, and HandlerMethodArgumentResolver. Regular @Component and
@ConfigurationProperties beans are not scanned when the @WebMvcTest annotation is used.
@EnableConfigurationProperties can be used to include @ConfigurationProperties beans.

A list of the auto-configuration settings that are enabled by @WebMvcTest can be found
TIP
in the appendix.

If you need to register extra components, such as the Jackson Module, you can import
TIP
additional configuration classes by using @Import on your test.

Often, @WebMvcTest is limited to a single controller and is used in combination with @MockBean to
provide mock implementations for required collaborators.

@WebMvcTest also auto-configures MockMvc. Mock MVC offers a powerful way to quickly test MVC
controllers without needing to start a full HTTP server.

You can also auto-configure MockMvc in a non-@WebMvcTest (such as @SpringBootTest) by

TIP
annotating it with @AutoConfigureMockMvc. The following example uses MockMvc:

127
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;

import static org.mockito.BDDMockito.given;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static
org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static
org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(UserVehicleController.class)
class MyControllerTests {

  @Autowired
  private MockMvc mvc;

  @MockBean
  private UserVehicleService userVehicleService;

  @Test
  void testExample() throws Exception {
  given(this.userVehicleService.getVehicleDetails("sboot"))
  .willReturn(new VehicleDetails("Honda", "Civic"));
  this.mvc.perform(get("/sboot/vehicle").accept(MediaType.TEXT_PLAIN))
  .andExpect(status().isOk())
  .andExpect(content().string("Honda Civic"));
  }

If you need to configure elements of the auto-configuration (for example, when servlet
TIP filters should be applied) you can use attributes in the @AutoConfigureMockMvc
annotation.

If you use HtmlUnit and Selenium, auto-configuration also provides an HtmlUnit WebClient bean
and/or a Selenium WebDriver bean. The following example uses HtmlUnit:

128
 import com.gargoylesoftware.htmlunit.WebClient;
import com.gargoylesoftware.htmlunit.html.HtmlPage;
import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;

import static org.assertj.core.api.Assertions.assertThat;

import static org.mockito.BDDMockito.given;

@WebMvcTest(UserVehicleController.class)
class MyHtmlUnitTests {

  @Autowired
  private WebClient webClient;

  @MockBean
  private UserVehicleService userVehicleService;

  @Test
  void testExample() throws Exception {
  given(this.userVehicleService.getVehicleDetails("sboot")).willReturn(new
VehicleDetails("Honda", "Civic"));
  HtmlPage page = this.webClient.getPage("/sboot/vehicle.html");
  assertThat(page.getBody().getTextContent()).isEqualTo("Honda Civic");
  }

By default, Spring Boot puts WebDriver beans in a special “scope” to ensure that the
NOTE driver exits after each test and that a new instance is injected. If you do not want
this behavior, you can add @Scope("singleton") to your WebDriver @Bean definition.

The webDriver scope created by Spring Boot will replace any user defined scope
WARNING of the same name. If you define your own webDriver scope you may find it stops
working when you use @WebMvcTest.

If you have Spring Security on the classpath, @WebMvcTest will also scan WebSecurityConfigurer
beans. Instead of disabling security completely for such tests, you can use Spring Security’s test
support. More details on how to use Spring Security’s MockMvc support can be found in this Testing
With Spring Security how-to section.

Sometimes writing Spring MVC tests is not enough; Spring Boot can help you run full
TIP
end-to-end tests with an actual server.

129
Auto-configured Spring WebFlux Tests

To test that Spring WebFlux controllers are working as expected, you can use the @WebFluxTest
annotation. @WebFluxTest auto-configures the Spring WebFlux infrastructure and limits scanned
beans to @Controller, @ControllerAdvice, @JsonComponent, Converter, GenericConverter, WebFilter, and
WebFluxConfigurer. Regular @Component and @ConfigurationProperties beans are not scanned when
the @WebFluxTest annotation is used. @EnableConfigurationProperties can be used to include
@ConfigurationProperties beans.

A list of the auto-configurations that are enabled by @WebFluxTest can be found in the
TIP
appendix.

If you need to register extra components, such as Jackson Module, you can import
TIP
additional configuration classes using @Import on your test.

Often, @WebFluxTest is limited to a single controller and used in combination with the @MockBean
annotation to provide mock implementations for required collaborators.

@WebFluxTest also auto-configures WebTestClient, which offers a powerful way to quickly test
WebFlux controllers without needing to start a full HTTP server.

You can also auto-configure WebTestClient in a non-@WebFluxTest (such as

TIP @SpringBootTest) by annotating it with @AutoConfigureWebTestClient. The following
example shows a class that uses both @WebFluxTest and a WebTestClient:

130
import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.MediaType;
import org.springframework.test.web.reactive.server.WebTestClient;

import static org.mockito.BDDMockito.given;

@WebFluxTest(UserVehicleController.class)
class MyControllerTests {

  @Autowired
  private WebTestClient webClient;

  @MockBean
  private UserVehicleService userVehicleService;

  @Test
  void testExample() throws Exception {
  given(this.userVehicleService.getVehicleDetails("sboot"))
  .willReturn(new VehicleDetails("Honda", "Civic"));
 
this.webClient.get().uri("/sboot/vehicle").accept(MediaType.TEXT_PLAIN).exchange()
  .expectStatus().isOk()
  .expectBody(String.class).isEqualTo("Honda Civic");
  }

This setup is only supported by WebFlux applications as using WebTestClient in a

TIP
mocked web application only works with WebFlux at the moment.

@WebFluxTest cannot detect routes registered through the functional web

NOTE framework. For testing RouterFunction beans in the context, consider importing
your RouterFunction yourself by using @Import or by using @SpringBootTest.

@WebFluxTest cannot detect custom security configuration registered as a @Bean of

NOTE type SecurityWebFilterChain. To include that in your test, you will need to import the
configuration that registers the bean by using @Import or by using @SpringBootTest.

Sometimes writing Spring WebFlux tests is not enough; Spring Boot can help you run
TIP
full end-to-end tests with an actual server.

131
Auto-configured Data Cassandra Tests

You can use @DataCassandraTest to test Cassandra applications. By default, it configures a

CassandraTemplate, scans for @Table classes, and configures Spring Data Cassandra repositories.
Regular @Component and @ConfigurationProperties beans are not scanned when the
@DataCassandraTest annotation is used. @EnableConfigurationProperties can be used to include
@ConfigurationProperties beans. (For more about using Cassandra with Spring Boot, see "
Cassandra", earlier in this chapter.)

A list of the auto-configuration settings that are enabled by @DataCassandraTest can be

TIP
found in the appendix.

The following example shows a typical setup for using Cassandra tests in Spring Boot:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.cassandra.DataCassandraTest;

@DataCassandraTest
class MyDataCassandraTests {

  @Autowired
  private SomeRepository repository;

Auto-configured Data JPA Tests

You can use the @DataJpaTest annotation to test JPA applications. By default, it scans for @Entity
classes and configures Spring Data JPA repositories. If an embedded database is available on the
classpath, it configures one as well. SQL queries are logged by default by setting the
spring.jpa.show-sql property to true. This can be disabled using the showSql() attribute of the
annotation.

Regular @Component and @ConfigurationProperties beans are not scanned when the @DataJpaTest
annotation is used. @EnableConfigurationProperties can be used to include @ConfigurationProperties
beans.

A list of the auto-configuration settings that are enabled by @DataJpaTest can be found
TIP
in the appendix.

By default, data JPA tests are transactional and roll back at the end of each test. See the relevant
section in the Spring Framework Reference Documentation for more details. If that is not what you
want, you can disable transaction management for a test or for the whole class as follows:

132
 import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

@DataJpaTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyNonTransactionalTests {

  // ...

Data JPA tests may also inject a TestEntityManager bean, which provides an alternative to the
standard JPA EntityManager that is specifically designed for tests.

TestEntityManager can also be auto-configured to any of your Spring-based test class by

adding @AutoConfigureTestEntityManager. When doing so, make sure that your test is
TIP
running in a transaction, for instance by adding @Transactional on your test class or
method.

A JdbcTemplate is also available if you need that. The following example shows the @DataJpaTest
annotation in use:

133
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager;

import static org.assertj.core.api.Assertions.assertThat;

@DataJpaTest
class MyRepositoryTests {

  @Autowired
  private TestEntityManager entityManager;

  @Autowired
  private UserRepository repository;

  @Test
  void testExample() throws Exception {
  this.entityManager.persist(new User("sboot", "1234"));
  User user = this.repository.findByUsername("sboot");
  assertThat(user.getUsername()).isEqualTo("sboot");
  assertThat(user.getEmployeeNumber()).isEqualTo("1234");
  }

In-memory embedded databases generally work well for tests, since they are fast and do not
require any installation. If, however, you prefer to run tests against a real database you can use the
@AutoConfigureTestDatabase annotation, as shown in the following example:

import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
import
org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase.Replace;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;

@DataJpaTest
@AutoConfigureTestDatabase(replace = Replace.NONE)
class MyRepositoryTests {

  // ...

Auto-configured JDBC Tests

@JdbcTest is similar to @DataJpaTest but is for tests that only require a DataSource and do not use
Spring Data JDBC. By default, it configures an in-memory embedded database and a JdbcTemplate.

134
Regular @Component and @ConfigurationProperties beans are not scanned when the @JdbcTest
annotation is used. @EnableConfigurationProperties can be used to include @ConfigurationProperties
beans.

A list of the auto-configurations that are enabled by @JdbcTest can be found in the
TIP
appendix.

By default, JDBC tests are transactional and roll back at the end of each test. See the relevant section
in the Spring Framework Reference Documentation for more details. If that is not what you want,
you can disable transaction management for a test or for the whole class, as follows:

import org.springframework.boot.test.autoconfigure.jdbc.JdbcTest;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

@JdbcTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyTransactionalTests {

If you prefer your test to run against a real database, you can use the @AutoConfigureTestDatabase
annotation in the same way as for DataJpaTest. (See "Auto-configured Data JPA Tests".)

Auto-configured Data JDBC Tests

@DataJdbcTest is similar to @JdbcTest but is for tests that use Spring Data JDBC repositories. By
default, it configures an in-memory embedded database, a JdbcTemplate, and Spring Data JDBC
repositories. Only AbstractJdbcConfiguration sub-classes are scanned when the @DataJdbcTest
annotation is used, regular @Component and @ConfigurationProperties beans are not scanned.
@EnableConfigurationProperties can be used to include @ConfigurationProperties beans.

A list of the auto-configurations that are enabled by @DataJdbcTest can be found in the
TIP
appendix.

By default, Data JDBC tests are transactional and roll back at the end of each test. See the relevant
section in the Spring Framework Reference Documentation for more details. If that is not what you
want, you can disable transaction management for a test or for the whole test class as shown in the
JDBC example.

If you prefer your test to run against a real database, you can use the @AutoConfigureTestDatabase
annotation in the same way as for DataJpaTest. (See "Auto-configured Data JPA Tests".)

Auto-configured jOOQ Tests

You can use @JooqTest in a similar fashion as @JdbcTest but for jOOQ-related tests. As jOOQ relies
heavily on a Java-based schema that corresponds with the database schema, the existing DataSource
is used. If you want to replace it with an in-memory database, you can use

135
@AutoConfigureTestDatabase to override those settings. (For more about using jOOQ with Spring
Boot, see "Using jOOQ", earlier in this chapter.) Regular @Component and @ConfigurationProperties
beans are not scanned when the @JooqTest annotation is used. @EnableConfigurationProperties can
be used to include @ConfigurationProperties beans.

A list of the auto-configurations that are enabled by @JooqTest can be found in the
TIP
appendix.

@JooqTest configures a DSLContext. The following example shows the @JooqTest annotation in use:

import org.jooq.DSLContext;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jooq.JooqTest;

@JooqTest
class MyJooqTests {

  @Autowired
  private DSLContext dslContext;

  // ...

JOOQ tests are transactional and roll back at the end of each test by default. If that is not what you
want, you can disable transaction management for a test or for the whole test class as shown in the
JDBC example.

Auto-configured Data MongoDB Tests

You can use @DataMongoTest to test MongoDB applications. By default, it configures an in-memory
embedded MongoDB (if available), configures a MongoTemplate, scans for @Document classes, and
configures Spring Data MongoDB repositories. Regular @Component and @ConfigurationProperties
beans are not scanned when the @DataMongoTest annotation is used. @EnableConfigurationProperties
can be used to include @ConfigurationProperties beans. (For more about using MongoDB with
Spring Boot, see "MongoDB", earlier in this chapter.)

A list of the auto-configuration settings that are enabled by @DataMongoTest can be

TIP
found in the appendix.

The following class shows the @DataMongoTest annotation in use:

136
 import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest;
import org.springframework.data.mongodb.core.MongoTemplate;

@DataMongoTest
class MyDataMongoDbTests {

  @Autowired
  private MongoTemplate mongoTemplate;

  // ...

In-memory embedded MongoDB generally works well for tests, since it is fast and does not require
any developer installation. If, however, you prefer to run tests against a real MongoDB server, you
should exclude the embedded MongoDB auto-configuration, as shown in the following example:

import
org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration;
import org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest;

@DataMongoTest(excludeAutoConfiguration = EmbeddedMongoAutoConfiguration.class)
class MyDataMongoDbTests {

  // ...

Auto-configured Data Neo4j Tests

You can use @DataNeo4jTest to test Neo4j applications. By default, it scans for @Node classes, and
configures Spring Data Neo4j repositories. Regular @Component and @ConfigurationProperties beans
are not scanned when the @DataNeo4jTest annotation is used. @EnableConfigurationProperties can be
used to include @ConfigurationProperties beans. (For more about using Neo4J with Spring Boot, see
"Neo4j", earlier in this chapter.)

A list of the auto-configuration settings that are enabled by @DataNeo4jTest can be

TIP
found in the appendix.

The following example shows a typical setup for using Neo4J tests in Spring Boot:

137
 import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest;

@DataNeo4jTest
class MyDataNeo4jTests {

  @Autowired
  private SomeRepository repository;

  // ...

By default, Data Neo4j tests are transactional and roll back at the end of each test. See the relevant
section in the Spring Framework Reference Documentation for more details. If that is not what you
want, you can disable transaction management for a test or for the whole class, as follows:

import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

@DataNeo4jTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyDataNeo4jTests {

Transactional tests are not supported with reactive access. If you are using this
NOTE
style, you must configure @DataNeo4jTest tests as described above.

Auto-configured Data Redis Tests

You can use @DataRedisTest to test Redis applications. By default, it scans for @RedisHash classes and
configures Spring Data Redis repositories. Regular @Component and @ConfigurationProperties beans
are not scanned when the @DataRedisTest annotation is used. @EnableConfigurationProperties can be
used to include @ConfigurationProperties beans. (For more about using Redis with Spring Boot, see
"Redis", earlier in this chapter.)

A list of the auto-configuration settings that are enabled by @DataRedisTest can be

TIP
found in the appendix.

The following example shows the @DataRedisTest annotation in use:

138
 import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.redis.DataRedisTest;

@DataRedisTest
class MyDataRedisTests {

  @Autowired
  private SomeRepository repository;

  // ...

Auto-configured Data LDAP Tests

You can use @DataLdapTest to test LDAP applications. By default, it configures an in-memory
embedded LDAP (if available), configures an LdapTemplate, scans for @Entry classes, and configures
Spring Data LDAP repositories. Regular @Component and @ConfigurationProperties beans are not
scanned when the @DataLdapTest annotation is used. @EnableConfigurationProperties can be used to
include @ConfigurationProperties beans. (For more about using LDAP with Spring Boot, see "LDAP",
earlier in this chapter.)

A list of the auto-configuration settings that are enabled by @DataLdapTest can be found
TIP
in the appendix.

The following example shows the @DataLdapTest annotation in use:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.ldap.DataLdapTest;
import org.springframework.ldap.core.LdapTemplate;

@DataLdapTest
class MyDataLdapTests {

  @Autowired
  private LdapTemplate ldapTemplate;

  // ...

In-memory embedded LDAP generally works well for tests, since it is fast and does not require any
developer installation. If, however, you prefer to run tests against a real LDAP server, you should
exclude the embedded LDAP auto-configuration, as shown in the following example:

139
 import
org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration;
import org.springframework.boot.test.autoconfigure.data.ldap.DataLdapTest;

@DataLdapTest(excludeAutoConfiguration = EmbeddedLdapAutoConfiguration.class)
class MyDataLdapTests {

  // ...

Auto-configured REST Clients

You can use the @RestClientTest annotation to test REST clients. By default, it auto-configures
Jackson, GSON, and Jsonb support, configures a RestTemplateBuilder, and adds support for
MockRestServiceServer. Regular @Component and @ConfigurationProperties beans are not scanned
when the @RestClientTest annotation is used. @EnableConfigurationProperties can be used to
include @ConfigurationProperties beans.

A list of the auto-configuration settings that are enabled by @RestClientTest can be

TIP
found in the appendix.

The specific beans that you want to test should be specified by using the value or components
attribute of @RestClientTest, as shown in the following example:

140
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.client.RestClientTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.client.MockRestServiceServer;

import static org.assertj.core.api.Assertions.assertThat;

import static
org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
import static
org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;

@RestClientTest(RemoteVehicleDetailsService.class)
class MyRestClientTests {

  @Autowired
  private RemoteVehicleDetailsService service;

  @Autowired
  private MockRestServiceServer server;

  @Test
  void getVehicleDetailsWhenResultIsSuccessShouldReturnDetails() throws Exception {
 
this.server.expect(requestTo("/greet/details")).andRespond(withSuccess("hello",
MediaType.TEXT_PLAIN));
  String greeting = this.service.callRestService();
  assertThat(greeting).isEqualTo("hello");
  }

Auto-configured Spring REST Docs Tests

You can use the @AutoConfigureRestDocs annotation to use Spring REST Docs in your tests with Mock
MVC, REST Assured, or WebTestClient. It removes the need for the JUnit extension in Spring REST
Docs.

@AutoConfigureRestDocs can be used to override the default output directory (target/generated-

snippets if you are using Maven or build/generated-snippets if you are using Gradle). It can also be
used to configure the host, scheme, and port that appears in any documented URIs.

Auto-configured Spring REST Docs Tests with Mock MVC

@AutoConfigureRestDocs customizes the MockMvc bean to use Spring REST Docs when testing servlet-
based web applications. You can inject it by using @Autowired and use it in your tests as you
normally would when using Mock MVC and Spring REST Docs, as shown in the following example:

141
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static
org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(UserController.class)
@AutoConfigureRestDocs
class MyUserDocumentationTests {

  @Autowired
  private MockMvc mvc;

  @Test
  void listUsers() throws Exception {
  this.mvc.perform(get("/users").accept(MediaType.TEXT_PLAIN))
  .andExpect(status().isOk())
  .andDo(document("list-users"));
  }

If you require more control over Spring REST Docs configuration than offered by the attributes of
@AutoConfigureRestDocs, you can use a RestDocsMockMvcConfigurationCustomizer bean, as shown in
the following example:

142
 import
org.springframework.boot.test.autoconfigure.restdocs.RestDocsMockMvcConfigurationCusto
mizer;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer;
import org.springframework.restdocs.templates.TemplateFormats;

@TestConfiguration(proxyBeanMethods = false)
public class MyRestDocsConfiguration implements RestDocsMockMvcConfigurationCustomizer
{

  @Override
  public void customize(MockMvcRestDocumentationConfigurer configurer) {
  configurer.snippets().withTemplateFormat(TemplateFormats.markdown());
  }

If you want to make use of Spring REST Docs support for a parameterized output directory, you can
create a RestDocumentationResultHandler bean. The auto-configuration calls alwaysDo with this result
handler, thereby causing each MockMvc call to automatically generate the default snippets. The
following example shows a RestDocumentationResultHandler being defined:

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler;

@TestConfiguration(proxyBeanMethods = false)
public class MyResultHandlerConfiguration {

  @Bean
  public RestDocumentationResultHandler restDocumentation() {
  return MockMvcRestDocumentation.document("{method-name}");
  }

Auto-configured Spring REST Docs Tests with WebTestClient

@AutoConfigureRestDocs can also be used with WebTestClient when testing reactive web applications.
You can inject it by using @Autowired and use it in your tests as you normally would when using
@WebFluxTest and Spring REST Docs, as shown in the following example:

143
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
import org.springframework.test.web.reactive.server.WebTestClient;

import static
org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;

@WebFluxTest
@AutoConfigureRestDocs
class MyUsersDocumentationTests {

  @Autowired
  private WebTestClient webTestClient;

  @Test
  void listUsers() {
  this.webTestClient
  .get().uri("/")
  .exchange()
  .expectStatus()
  .isOk()
  .expectBody()
  .consumeWith(document("list-users"));
  }

If you require more control over Spring REST Docs configuration than offered by the attributes of
@AutoConfigureRestDocs, you can use a RestDocsWebTestClientConfigurationCustomizer bean, as
shown in the following example:

144
 import
org.springframework.boot.test.autoconfigure.restdocs.RestDocsWebTestClientConfiguratio
nCustomizer;
import org.springframework.boot.test.context.TestConfiguration;
import
org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer;

@TestConfiguration(proxyBeanMethods = false)
public class MyRestDocsConfiguration implements
RestDocsWebTestClientConfigurationCustomizer {

  @Override
  public void customize(WebTestClientRestDocumentationConfigurer configurer) {
  configurer.snippets().withEncoding("UTF-8");
  }

If you want to make use of Spring REST Docs support for a parameterized output directory, you can
use a WebTestClientBuilderCustomizer to configure a consumer for every entity exchange result. The
following example shows such a WebTestClientBuilderCustomizer being defined:

import org.springframework.boot.test.context.TestConfiguration;
import
org.springframework.boot.test.web.reactive.server.WebTestClientBuilderCustomizer;
import org.springframework.context.annotation.Bean;

import static
org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;

@TestConfiguration(proxyBeanMethods = false)
public class MyWebTestClientBuilderCustomizerConfiguration {

  @Bean
  public WebTestClientBuilderCustomizer restDocumentation() {
  return (builder) -> builder.entityExchangeResultConsumer(document("{method-
name}"));
  }

Auto-configured Spring REST Docs Tests with REST Assured

@AutoConfigureRestDocs makes a RequestSpecification bean, preconfigured to use Spring REST Docs,

available to your tests. You can inject it by using @Autowired and use it in your tests as you normally
would when using REST Assured and Spring REST Docs, as shown in the following example:

145
 import io.restassured.specification.RequestSpecification;
import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.web.server.LocalServerPort;

import static io.restassured.RestAssured.given;

import static org.hamcrest.Matchers.is;
import static
org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@AutoConfigureRestDocs
class MyUserDocumentationTests {

  @Test
  void listUsers(@Autowired RequestSpecification documentationSpec, @LocalServerPort
int port) {
  given(documentationSpec)
  .filter(document("list-users"))
  .when()
  .port(port)
  .get("/")
  .then().assertThat()
  .statusCode(is(200));
  }

If you require more control over Spring REST Docs configuration than offered by the attributes of
@AutoConfigureRestDocs, a RestDocsRestAssuredConfigurationCustomizer bean can be used, as shown
in the following example:

146
 import
org.springframework.boot.test.autoconfigure.restdocs.RestDocsRestAssuredConfigurationC
ustomizer;
import org.springframework.boot.test.context.TestConfiguration;
import
org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer;
import org.springframework.restdocs.templates.TemplateFormats;

@TestConfiguration(proxyBeanMethods = false)
public class MyRestDocsConfiguration implements
RestDocsRestAssuredConfigurationCustomizer {

  @Override
  public void customize(RestAssuredRestDocumentationConfigurer configurer) {
  configurer.snippets().withTemplateFormat(TemplateFormats.markdown());
  }

Auto-configured Spring Web Services Tests

Auto-configured Spring Web Services Client Tests

You can use @WebServiceClientTest to test applications that call web services using the Spring Web
Services project. By default, it configures a mock WebServiceServer bean and automatically
customizes your WebServiceTemplateBuilder. (For more about using Web Services with Spring Boot,
see "Web Services", earlier in this chapter.)

A list of the auto-configuration settings that are enabled by @WebServiceClientTest can

TIP
be found in the appendix.

The following example shows the @WebServiceClientTest annotation in use:

147
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import
org.springframework.boot.test.autoconfigure.webservices.client.WebServiceClientTest;
import org.springframework.ws.test.client.MockWebServiceServer;
import org.springframework.xml.transform.StringSource;

import static org.assertj.core.api.Assertions.assertThat;

import static org.springframework.ws.test.client.RequestMatchers.payload;
import static org.springframework.ws.test.client.ResponseCreators.withPayload;

@WebServiceClientTest(SomeWebService.class)
class MyWebServiceClientTests {

  @Autowired
  private MockWebServiceServer server;

  @Autowired
  private SomeWebService someWebService;

  @Test
  void mockServerCall() {
  this.server
  .expect(payload(new StringSource("<request/>")))
  .andRespond(withPayload(new
StringSource("<response><status>200</status></response>")));
  assertThat(this.someWebService.test())
  .extracting(Response::getStatus)
  .isEqualTo(200);
  }

Auto-configured Spring Web Services Server Tests

You can use @WebServiceServerTest to test applications that implement web services using the
Spring Web Services project. By default, it configures a MockWebServiceClient bean that can be used
to call your web service endpoints. (For more about using Web Services with Spring Boot, see "Web
Services", earlier in this chapter.)

A list of the auto-configuration settings that are enabled by @WebServiceServerTest can

TIP
be found in the appendix.

The following example shows the @WebServiceServerTest annotation in use:

148
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import
org.springframework.boot.test.autoconfigure.webservices.server.WebServiceServerTest;
import org.springframework.ws.test.server.MockWebServiceClient;
import org.springframework.ws.test.server.RequestCreators;
import org.springframework.ws.test.server.ResponseMatchers;
import org.springframework.xml.transform.StringSource;

@WebServiceServerTest(ExampleEndpoint.class)
class MyWebServiceServerTests {

  @Autowired
  private MockWebServiceClient client;

  @Test
  void mockServerCall() {
  this.client
  .sendRequest(RequestCreators.withPayload(new
StringSource("<ExampleRequest/>")))
  .andExpect(ResponseMatchers.payload(new
StringSource("<ExampleResponse>42</ExampleResponse>")));
  }

Additional Auto-configuration and Slicing

Each slice provides one or more @AutoConfigure… annotations that namely defines the auto-
configurations that should be included as part of a slice. Additional auto-configurations can be
added on a test-by-test basis by creating a custom @AutoConfigure… annotation or by adding
@ImportAutoConfiguration to the test as shown in the following example:

import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import
org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration;
import org.springframework.boot.test.autoconfigure.jdbc.JdbcTest;

@JdbcTest
@ImportAutoConfiguration(IntegrationAutoConfiguration.class)
class MyJdbcTests {

Make sure to not use the regular @Import annotation to import auto-configurations
NOTE
as they are handled in a specific way by Spring Boot.

149
Alternatively, additional auto-configurations can be added for any use of a slice annotation by
registering them in META-INF/spring.factories as shown in the following example:

org.springframework.boot.test.autoconfigure.jdbc.JdbcTest=com.example.IntegrationAutoC
onfiguration

A slice or @AutoConfigure… annotation can be customized this way as long as it is meta-

TIP
annotated with @ImportAutoConfiguration.

User Configuration and Slicing

If you structure your code in a sensible way, your @SpringBootApplication class is used by default as
the configuration of your tests.

It then becomes important not to litter the application’s main class with configuration settings that
are specific to a particular area of its functionality.

Assume that you are using Spring Batch and you rely on the auto-configuration for it. You could
define your @SpringBootApplication as follows:

import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@EnableBatchProcessing
public class MyApplication {

  // ...

Because this class is the source configuration for the test, any slice test actually tries to start Spring
Batch, which is definitely not what you want to do. A recommended approach is to move that area-
specific configuration to a separate @Configuration class at the same level as your application, as
shown in the following example:

import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
@EnableBatchProcessing
public class MyBatchConfiguration {

  // ...

150
 Depending on the complexity of your application, you may either have a single
@Configuration class for your customizations or one class per domain area. The
NOTE
latter approach lets you enable it in one of your tests, if necessary, with the @Import
annotation.

Test slices exclude @Configuration classes from scanning. For example, for a @WebMvcTest, the
following configuration will not include the given WebMvcConfigurer bean in the application context
loaded by the test slice:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration(proxyBeanMethods = false)
public class MyWebConfiguration {

  @Bean
  public WebMvcConfigurer testConfigurer() {
  return new WebMvcConfigurer() {
  // ...
  };
  }

The configuration below will, however, cause the custom WebMvcConfigurer to be loaded by the test
slice.

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Component
public class MyWebMvcConfigurer implements WebMvcConfigurer {

  // ...

Another source of confusion is classpath scanning. Assume that, while you structured your code in
a sensible way, you need to scan an additional package. Your application may resemble the
following code:

151
 import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
@ComponentScan({ "com.example.app", "com.example.another" })
public class MyApplication {

  // ...

Doing so effectively overrides the default component scan directive with the side effect of scanning
those two packages regardless of the slice that you chose. For instance, a @DataJpaTest seems to
suddenly scan components and user configurations of your application. Again, moving the custom
directive to a separate class is a good way to fix this issue.

If this is not an option for you, you can create a @SpringBootConfiguration somewhere
TIP in the hierarchy of your test so that it is used instead. Alternatively, you can specify a
source for your test, which disables the behavior of finding a default one.

Using Spock to Test Spring Boot Applications

Spock 2.x can be used to test a Spring Boot application. To do so, add a dependency on Spock’s
spock-spring module to your application’s build. spock-spring integrates Spring’s test framework
into Spock. See the documentation for Spock’s Spring module for further details.

7.8.4. Test Utilities

A few test utility classes that are generally useful when testing your application are packaged as
part of spring-boot.

ConfigDataApplicationContextInitializer

ConfigDataApplicationContextInitializer is an ApplicationContextInitializer that you can apply to

your tests to load Spring Boot application.properties files. You can use it when you do not need the
full set of features provided by @SpringBootTest, as shown in the following example:

import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer;
import org.springframework.test.context.ContextConfiguration;

@ContextConfiguration(classes = Config.class, initializers =

ConfigDataApplicationContextInitializer.class)
class MyConfigFileTests {

  // ...

152
 Using ConfigDataApplicationContextInitializer alone does not provide support for
@Value("${…}") injection. Its only job is to ensure that application.properties files
NOTE are loaded into Spring’s Environment. For @Value support, you need to either
additionally configure a PropertySourcesPlaceholderConfigurer or use
@SpringBootTest, which auto-configures one for you.

TestPropertyValues

TestPropertyValues lets you quickly add properties to a ConfigurableEnvironment or

ConfigurableApplicationContext. You can call it with key=value strings, as follows:

import org.junit.jupiter.api.Test;

import org.springframework.boot.test.util.TestPropertyValues;
import org.springframework.mock.env.MockEnvironment;

import static org.assertj.core.api.Assertions.assertThat;

class MyEnvironmentTests {

  @Test
  void testPropertySources() {
  MockEnvironment environment = new MockEnvironment();
  TestPropertyValues.of("org=Spring", "name=Boot").applyTo(environment);
  assertThat(environment.getProperty("name")).isEqualTo("Boot");
  }

OutputCapture

OutputCapture is a JUnit Extension that you can use to capture System.out and System.err output. To
use add @ExtendWith(OutputCaptureExtension.class) and inject CapturedOutput as an argument to
your test class constructor or test method as follows:

153
 import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;

import static org.assertj.core.api.Assertions.assertThat;

@ExtendWith(OutputCaptureExtension.class)
class MyOutputCaptureTests {

  @Test
  void testName(CapturedOutput output) {
  System.out.println("Hello World!");
  assertThat(output).contains("World");
  }

TestRestTemplate

TestRestTemplate is a convenience alternative to Spring’s RestTemplate that is useful in integration

tests. You can get a vanilla template or one that sends Basic HTTP authentication (with a username
and password). In either case, the template is fault tolerant. This means that it behaves in a test-
friendly way by not throwing exceptions on 4xx and 5xx errors. Instead, such errors can be
detected through the returned ResponseEntity and its status code.

Spring Framework 5.0 provides a new WebTestClient that works for WebFlux
TIP integration tests and both WebFlux and MVC end-to-end testing. It provides a fluent
API for assertions, unlike TestRestTemplate.

It is recommended, but not mandatory, to use the Apache HTTP Client (version 4.3.2 or better). If
you have that on your classpath, the TestRestTemplate responds by configuring the client
appropriately. If you do use Apache’s HTTP client, some additional test-friendly features are
enabled:

• Redirects are not followed (so you can assert the response location).

• Cookies are ignored (so the template is stateless).

TestRestTemplate can be instantiated directly in your integration tests, as shown in the following
example:

154
 import org.junit.jupiter.api.Test;

import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.ResponseEntity;

import static org.assertj.core.api.Assertions.assertThat;

class MyTests {

  private TestRestTemplate template = new TestRestTemplate();

  @Test
  void testRequest() throws Exception {
  ResponseEntity<String> headers =
this.template.getForEntity("https://myhost.example.com/example", String.class);
  assertThat(headers.getHeaders().getLocation()).hasHost("other.example.com");
  }

Alternatively, if you use the @SpringBootTest annotation with WebEnvironment.RANDOM_PORT or

WebEnvironment.DEFINED_PORT, you can inject a fully configured TestRestTemplate and start using it. If
necessary, additional customizations can be applied through the RestTemplateBuilder bean. Any
URLs that do not specify a host and port automatically connect to the embedded server, as shown in
the following example:

155
 import java.time.Duration;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.http.HttpHeaders;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MySpringBootTests {

  @Autowired
  private TestRestTemplate template;

  @Test
  void testRequest() {
  HttpHeaders headers = this.template.getForEntity("/example",
String.class).getHeaders();
  assertThat(headers.getLocation()).hasHost("other.example.com");
  }

  @TestConfiguration(proxyBeanMethods = false)
  static class RestTemplateBuilderConfiguration {

  @Bean
  RestTemplateBuilder restTemplateBuilder() {
  return new RestTemplateBuilder().setConnectTimeout(Duration.ofSeconds(1))
  .setReadTimeout(Duration.ofSeconds(1));
  }

  }

7.9. Creating Your Own Auto-configuration

If you work in a company that develops shared libraries, or if you work on an open-source or
commercial library, you might want to develop your own auto-configuration. Auto-configuration
classes can be bundled in external jars and still be picked-up by Spring Boot.

Auto-configuration can be associated to a “starter” that provides the auto-configuration code as

well as the typical libraries that you would use with it. We first cover what you need to know to

156
build your own auto-configuration and then we move on to the typical steps required to create a
custom starter.

TIP A demo project is available to showcase how you can create a starter step-by-step.

7.9.1. Understanding Auto-configured Beans

Under the hood, auto-configuration is implemented with standard @Configuration classes.

Additional @Conditional annotations are used to constrain when the auto-configuration should
apply. Usually, auto-configuration classes use @ConditionalOnClass and @ConditionalOnMissingBean
annotations. This ensures that auto-configuration applies only when relevant classes are found and
when you have not declared your own @Configuration.

You can browse the source code of spring-boot-autoconfigure to see the @Configuration classes that
Spring provides (see the META-INF/spring.factories file).

7.9.2. Locating Auto-configuration Candidates

Spring Boot checks for the presence of a META-INF/spring.factories file within your published jar.
The file should list your configuration classes under the EnableAutoConfiguration key, as shown in
the following example:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.mycorp.libx.autoconfigure.LibXAutoConfiguration,\
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration

Auto-configurations must be loaded that way only. Make sure that they are defined
in a specific package space and that they are never the target of component
NOTE
scanning. Furthermore, auto-configuration classes should not enable component
scanning to find additional components. Specific @Imports should be used instead.

You can use the @AutoConfigureAfter or @AutoConfigureBefore annotations if your configuration

needs to be applied in a specific order. For example, if you provide web-specific configuration, your
class may need to be applied after WebMvcAutoConfiguration.

If you want to order certain auto-configurations that should not have any direct knowledge of each
other, you can also use @AutoConfigureOrder. That annotation has the same semantic as the regular
@Order annotation but provides a dedicated order for auto-configuration classes.

As with standard @Configuration classes, the order in which auto-configuration classes are applied
only affects the order in which their beans are defined. The order in which those beans are
subsequently created is unaffected and is determined by each bean’s dependencies and any
@DependsOn relationships.

7.9.3. Condition Annotations

You almost always want to include one or more @Conditional annotations on your auto-

157
configuration class. The @ConditionalOnMissingBean annotation is one common example that is used
to allow developers to override auto-configuration if they are not happy with your defaults.

Spring Boot includes a number of @Conditional annotations that you can reuse in your own code by
annotating @Configuration classes or individual @Bean methods. These annotations include:

• Class Conditions

• Bean Conditions

• Property Conditions

• Resource Conditions

• Web Application Conditions

• SpEL Expression Conditions

Class Conditions

The @ConditionalOnClass and @ConditionalOnMissingClass annotations let @Configuration classes be

included based on the presence or absence of specific classes. Due to the fact that annotation
metadata is parsed by using ASM, you can use the value attribute to refer to the real class, even
though that class might not actually appear on the running application classpath. You can also use
the name attribute if you prefer to specify the class name by using a String value.

This mechanism does not apply the same way to @Bean methods where typically the return type is
the target of the condition: before the condition on the method applies, the JVM will have loaded
the class and potentially processed method references which will fail if the class is not present.

To handle this scenario, a separate @Configuration class can be used to isolate the condition, as
shown in the following example:

158
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
// Some conditions ...
public class MyAutoConfiguration {

  // Auto-configured beans ...

  @Configuration(proxyBeanMethods = false)
  @ConditionalOnClass(SomeService.class)
  public static class SomeServiceConfiguration {

  @Bean
  @ConditionalOnMissingBean
  public SomeService someService() {
  return new SomeService();
  }

  }

If you use @ConditionalOnClass or @ConditionalOnMissingClass as a part of a meta-

TIP annotation to compose your own composed annotations, you must use name as
referring to the class in such a case is not handled.

Bean Conditions

The @ConditionalOnBean and @ConditionalOnMissingBean annotations let a bean be included based on

the presence or absence of specific beans. You can use the value attribute to specify beans by type
or name to specify beans by name. The search attribute lets you limit the ApplicationContext
hierarchy that should be considered when searching for beans.

When placed on a @Bean method, the target type defaults to the return type of the method, as shown
in the following example:

159
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyAutoConfiguration {

  @Bean
  @ConditionalOnMissingBean
  public SomeService someService() {
  return new SomeService();
  }

In the preceding example, the someService bean is going to be created if no bean of type SomeService
is already contained in the ApplicationContext.

You need to be very careful about the order in which bean definitions are added, as
these conditions are evaluated based on what has been processed so far. For this
TIP reason, we recommend using only @ConditionalOnBean and @ConditionalOnMissingBean
annotations on auto-configuration classes (since these are guaranteed to load after
any user-defined bean definitions have been added).

@ConditionalOnBean and @ConditionalOnMissingBean do not prevent @Configuration

classes from being created. The only difference between using these conditions at
NOTE the class level and marking each contained @Bean method with the annotation is that
the former prevents registration of the @Configuration class as a bean if the
condition does not match.

When declaring a @Bean method, provide as much type information as possible in the
method’s return type. For example, if your bean’s concrete class implements an
interface the bean method’s return type should be the concrete class and not the
TIP
interface. Providing as much type information as possible in @Bean methods is
particularly important when using bean conditions as their evaluation can only rely
upon to type information that is available in the method signature.

Property Conditions

The @ConditionalOnProperty annotation lets configuration be included based on a Spring

Environment property. Use the prefix and name attributes to specify the property that should be
checked. By default, any property that exists and is not equal to false is matched. You can also
create more advanced checks by using the havingValue and matchIfMissing attributes.

Resource Conditions

The @ConditionalOnResource annotation lets configuration be included only when a specific resource

160
is present. Resources can be specified by using the usual Spring conventions, as shown in the
following example: file:/home/user/test.dat.

Web Application Conditions

The @ConditionalOnWebApplication and @ConditionalOnNotWebApplication annotations let

configuration be included depending on whether the application is a “web application”. A servlet-
based web application is any application that uses a Spring WebApplicationContext, defines a session
scope, or has a ConfigurableWebEnvironment. A reactive web application is any application that uses a
ReactiveWebApplicationContext, or has a ConfigurableReactiveWebEnvironment.

The @ConditionalOnWarDeployment annotation lets configuration be included depending on whether

the application is a traditional WAR application that is deployed to a container. This condition will
not match for applications that are run with an embedded server.

SpEL Expression Conditions

The @ConditionalOnExpression annotation lets configuration be included based on the result of a

SpEL expression.

7.9.4. Testing your Auto-configuration

An auto-configuration can be affected by many factors: user configuration (@Bean definition and
Environment customization), condition evaluation (presence of a particular library), and others.
Concretely, each test should create a well defined ApplicationContext that represents a combination
of those customizations. ApplicationContextRunner provides a great way to achieve that.

ApplicationContextRunner is usually defined as a field of the test class to gather the base, common
configuration. The following example makes sure that MyServiceAutoConfiguration is always
invoked:

private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()

  .withConfiguration(AutoConfigurations.of(MyServiceAutoConfiguration.class));

If multiple auto-configurations have to be defined, there is no need to order their

TIP declarations as they are invoked in the exact same order as when running the
application.

Each test can use the runner to represent a particular use case. For instance, the sample below
invokes a user configuration (UserConfiguration) and checks that the auto-configuration backs off
properly. Invoking run provides a callback context that can be used with AssertJ.

161
 @Test
void defaultServiceBacksOff() {
  this.contextRunner.withUserConfiguration(UserConfiguration.class).run((context) ->
{
  assertThat(context).hasSingleBean(MyService.class);
 
assertThat(context).getBean("myCustomService").isSameAs(context.getBean(MyService.clas
s));
  });
}

@Configuration(proxyBeanMethods = false)
static class UserConfiguration {

  @Bean
  MyService myCustomService() {
  return new MyService("mine");
  }

It is also possible to easily customize the Environment, as shown in the following example:

@Test
void serviceNameCanBeConfigured() {
  this.contextRunner.withPropertyValues("user.name=test123").run((context) -> {
  assertThat(context).hasSingleBean(MyService.class);
  assertThat(context.getBean(MyService.class).getName()).isEqualTo("test123");
  });
}

The runner can also be used to display the ConditionEvaluationReport. The report can be printed at
INFO or DEBUG level. The following example shows how to use the
ConditionEvaluationReportLoggingListener to print the report in auto-configuration tests.

162
 import org.junit.jupiter.api.Test;

import
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListene
r;
import org.springframework.boot.logging.LogLevel;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;

class MyConditionEvaluationReportingTests {

  @Test
  void autoConfigTest() {
  new ApplicationContextRunner()
  .withInitializer(new
ConditionEvaluationReportLoggingListener(LogLevel.INFO))
  .run((context) -> {
  // Test something...
  });
  }

Simulating a Web Context

If you need to test an auto-configuration that only operates in a servlet or reactive web application
context, use the WebApplicationContextRunner or ReactiveWebApplicationContextRunner respectively.

Overriding the Classpath

It is also possible to test what happens when a particular class and/or package is not present at
runtime. Spring Boot ships with a FilteredClassLoader that can easily be used by the runner. In the
following example, we assert that if MyService is not present, the auto-configuration is properly
disabled:

@Test
void serviceIsIgnoredIfLibraryIsNotPresent() {
  this.contextRunner.withClassLoader(new FilteredClassLoader(MyService.class))
  .run((context) -> assertThat(context).doesNotHaveBean("myService"));
}

7.9.5. Creating Your Own Starter

A typical Spring Boot starter contains code to auto-configure and customize the infrastructure of a
given technology, let’s call that "acme". To make it easily extensible, a number of configuration keys
in a dedicated namespace can be exposed to the environment. Finally, a single "starter" dependency
is provided to help users get started as easily as possible.

Concretely, a custom starter can contain the following:

163
 • The autoconfigure module that contains the auto-configuration code for "acme".

• The starter module that provides a dependency to the autoconfigure module as well as "acme"
and any additional dependencies that are typically useful. In a nutshell, adding the starter
should provide everything needed to start using that library.

This separation in two modules is in no way necessary. If "acme" has several flavors, options or
optional features, then it is better to separate the auto-configuration as you can clearly express the
fact some features are optional. Besides, you have the ability to craft a starter that provides an
opinion about those optional dependencies. At the same time, others can rely only on the
autoconfigure module and craft their own starter with different opinions.

If the auto-configuration is relatively straightforward and does not have optional feature, merging
the two modules in the starter is definitely an option.

Naming

You should make sure to provide a proper namespace for your starter. Do not start your module
names with spring-boot, even if you use a different Maven groupId. We may offer official support
for the thing you auto-configure in the future.

As a rule of thumb, you should name a combined module after the starter. For example, assume
that you are creating a starter for "acme" and that you name the auto-configure module acme-
spring-boot and the starter acme-spring-boot-starter. If you only have one module that combines
the two, name it acme-spring-boot-starter.

Configuration keys

If your starter provides configuration keys, use a unique namespace for them. In particular, do not
include your keys in the namespaces that Spring Boot uses (such as server, management, spring, and
so on). If you use the same namespace, we may modify these namespaces in the future in ways that
break your modules. As a rule of thumb, prefix all your keys with a namespace that you own (for
example acme).

Make sure that configuration keys are documented by adding field javadoc for each property, as
shown in the following example:

164
 import java.time.Duration;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("acme")
public class AcmeProperties {

  /**
  * Whether to check the location of acme resources.
  */
  private boolean checkLocation = true;

  /**
  * Timeout for establishing a connection to the acme server.
  */
  private Duration loginTimeout = Duration.ofSeconds(3);

  public boolean isCheckLocation() {

  return this.checkLocation;
  }

  public void setCheckLocation(boolean checkLocation) {

  this.checkLocation = checkLocation;
  }

  public Duration getLoginTimeout() {

  return this.loginTimeout;
  }

  public void setLoginTimeout(Duration loginTimeout) {

  this.loginTimeout = loginTimeout;
  }

You should only use plain text with @ConfigurationProperties field Javadoc, since
NOTE
they are not processed before being added to the JSON.

Here are some rules we follow internally to make sure descriptions are consistent:

• Do not start the description by "The" or "A".

• For boolean types, start the description with "Whether" or "Enable".

• For collection-based types, start the description with "Comma-separated list"

• Use java.time.Duration rather than long and describe the default unit if it differs from
milliseconds, such as "If a duration suffix is not specified, seconds will be used".

• Do not provide the default value in the description unless it has to be determined at runtime.

165
Make sure to trigger meta-data generation so that IDE assistance is available for your keys as well.
You may want to review the generated metadata (META-INF/spring-configuration-metadata.json) to
make sure your keys are properly documented. Using your own starter in a compatible IDE is also a
good idea to validate that quality of the metadata.

The “autoconfigure” Module

The autoconfigure module contains everything that is necessary to get started with the library. It
may also contain configuration key definitions (such as @ConfigurationProperties) and any callback
interface that can be used to further customize how the components are initialized.

You should mark the dependencies to the library as optional so that you can include
TIP the autoconfigure module in your projects more easily. If you do it that way, the library
is not provided and, by default, Spring Boot backs off.

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. It is
recommended to add the following dependency in a module that contains auto-configurations:

<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 fat jar:

166
 <project>
  <build>
  <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <configuration>
  <excludes>
  <exclude>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-autoconfigure-
processor</artifactId>
  </exclude>
  </excludes>
  </configuration>
  </plugin>
  </plugins>
  </build>
</project>

With Gradle 4.5 and earlier, the dependency should be declared in the compileOnly configuration, as
shown in the following example:

dependencies {
  compileOnly "org.springframework.boot:spring-boot-autoconfigure-processor"
}

With Gradle 4.6 and later, the dependency should be declared in the annotationProcessor
configuration, as shown in the following example:

dependencies {
  annotationProcessor "org.springframework.boot:spring-boot-autoconfigure-processor"
}

Starter Module

The starter is really an empty jar. Its only purpose is to provide the necessary dependencies to work
with the library. You can think of it as an opinionated view of what is required to get started.

Do not make assumptions about the project in which your starter is added. If the library you are
auto-configuring typically requires other starters, mention them as well. Providing a proper set of
default dependencies may be hard if the number of optional dependencies is high, as you should
avoid including dependencies that are unnecessary for a typical usage of the library. In other
words, you should not include optional dependencies.

167
 Either way, your starter must reference the core Spring Boot starter (spring-boot-
starter) directly or indirectly (there is no need to add it if your starter relies on
NOTE
another starter). If a project is created with only your custom starter, Spring Boot’s
core features will be honoured by the presence of the core starter.

7.10. Kotlin support

Kotlin is a statically-typed language targeting the JVM (and other platforms) which allows writing
concise and elegant code while providing interoperability with existing libraries written in Java.

Spring Boot provides Kotlin support by leveraging the support in other Spring projects such as
Spring Framework, Spring Data, and Reactor. See the Spring Framework Kotlin support
documentation for more information.

The easiest way to start with Spring Boot and Kotlin is to follow this comprehensive tutorial. You
can create new Kotlin projects by using start.spring.io. Feel free to join the #spring channel of Kotlin
Slack or ask a question with the spring and kotlin tags on Stack Overflow if you need support.

7.10.1. Requirements

Spring Boot requires at least Kotlin 1.3.x and manages a suitable Kotlin version through
dependency management. To use Kotlin, org.jetbrains.kotlin:kotlin-stdlib and
org.jetbrains.kotlin:kotlin-reflect must be present on the classpath. The kotlin-stdlib variants
kotlin-stdlib-jdk7 and kotlin-stdlib-jdk8 can also be used.

Since Kotlin classes are final by default, you are likely to want to configure kotlin-spring plugin in
order to automatically open Spring-annotated classes so that they can be proxied.

Jackson’s Kotlin module is required for serializing / deserializing JSON data in Kotlin. It is
automatically registered when found on the classpath. A warning message is logged if Jackson and
Kotlin are present but the Jackson Kotlin module is not.

These dependencies and plugins are provided by default if one bootstraps a Kotlin
TIP
project on start.spring.io.

7.10.2. Null-safety

One of Kotlin’s key features is null-safety. It deals with null values at compile time rather than
deferring the problem to runtime and encountering a NullPointerException. This helps to eliminate
a common source of bugs without paying the cost of wrappers like Optional. Kotlin also allows using
functional constructs with nullable values as described in this comprehensive guide to null-safety
in Kotlin.

Although Java does not allow one to express null-safety in its type system, Spring Framework,
Spring Data, and Reactor now provide null-safety of their API through tooling-friendly annotations.
By default, types from Java APIs used in Kotlin are recognized as platform types for which null-
checks are relaxed. Kotlin’s support for JSR 305 annotations combined with nullability annotations
provide null-safety for the related Spring API in Kotlin.

168
The JSR 305 checks can be configured by adding the -Xjsr305 compiler flag with the following
options: -Xjsr305={strict|warn|ignore}. The default behavior is the same as -Xjsr305=warn. The
strict value is required to have null-safety taken in account in Kotlin types inferred from Spring
API but should be used with the knowledge that Spring API nullability declaration could evolve
even between minor releases and more checks may be added in the future).

Generic type arguments, varargs and array elements nullability are not yet
WARNING supported. See SPR-15942 for up-to-date information. Also be aware that
Spring Boot’s own API is not yet annotated.

7.10.3. Kotlin API

runApplication

Spring Boot provides an idiomatic way to run an application with

runApplication<MyApplication>(*args) as shown in the following example:

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {

  runApplication<MyApplication>(*args)
}

This is a drop-in replacement for SpringApplication.run(MyApplication::class.java, *args). It also

allows customization of the application as shown in the following example:

runApplication<MyApplication>(*args) {
  setBannerMode(OFF)
}

Extensions

Kotlin extensions provide the ability to extend existing classes with additional functionality. The
Spring Boot Kotlin API makes use of these extensions to add new Kotlin specific conveniences to
existing APIs.

TestRestTemplate extensions, similar to those provided by Spring Framework for RestOperations in

Spring Framework, are provided. Among other things, the extensions make it possible to take
advantage of Kotlin reified type parameters.

7.10.4. Dependency management

In order to avoid mixing different versions of Kotlin dependencies on the classpath, Spring Boot

169
imports the Kotlin BOM.

With Maven, the Kotlin version can be customized by setting the kotlin.version property and
plugin management is provided for kotlin-maven-plugin. With Gradle, the Spring Boot plugin
automatically aligns the kotlin.version with the version of the Kotlin plugin.

Spring Boot also manages the version of Coroutines dependencies by importing the Kotlin
Coroutines BOM. The version can be customized by setting the kotlin-coroutines.version property.

org.jetbrains.kotlinx:kotlinx-coroutines-reactor dependency is provided by default

TIP if one bootstraps a Kotlin project with at least one reactive dependency on
start.spring.io.

7.10.5. @ConfigurationProperties

@ConfigurationProperties when used in combination with @ConstructorBinding supports classes with

immutable val properties as shown in the following example:

@ConstructorBinding
@ConfigurationProperties("example.kotlin")
data class KotlinExampleProperties(
  val name: String,
  val description: String,
  val myService: MyService) {

  data class MyService(

  val apiToken: String,
  val uri: URI
  )
}

To generate your own metadata using the annotation processor, kapt should be
configured with the spring-boot-configuration-processor dependency. Note that some
TIP
features (such as detecting the default value or deprecated items) are not working due
to limitations in the model kapt provides.

7.10.6. Testing

While it is possible to use JUnit 4 to test Kotlin code, JUnit 5 is provided by default and is
recommended. JUnit 5 enables a test class to be instantiated once and reused for all of the class’s
tests. This makes it possible to use @BeforeAll and @AfterAll annotations on non-static methods,
which is a good fit for Kotlin.

To mock Kotlin classes, MockK is recommended. If you need the Mockk equivalent of the Mockito
specific @MockBean and @SpyBean annotations, you can use SpringMockK which provides similar
@MockkBean and @SpykBean annotations.

170
7.10.7. Resources

Further reading

• Kotlin language reference

• Kotlin Slack (with a dedicated #spring channel)

• Stackoverflow with spring and kotlin tags

• Try Kotlin in your browser

• Kotlin blog

• Awesome Kotlin

• Tutorial: building web applications with Spring Boot and Kotlin

• Developing Spring Boot applications with Kotlin

• A Geospatial Messenger with Kotlin, Spring Boot and PostgreSQL

• Introducing Kotlin support in Spring Framework 5.0

• Spring Framework 5 Kotlin APIs, the functional way

Examples

• spring-boot-kotlin-demo: regular Spring Boot + Spring Data JPA project

• mixit: Spring Boot 2 + WebFlux + Reactive Spring Data MongoDB

• spring-kotlin-fullstack: WebFlux Kotlin fullstack example with Kotlin2js for frontend instead of
JavaScript or TypeScript

• spring-petclinic-kotlin: Kotlin version of the Spring PetClinic Sample Application

• spring-kotlin-deepdive: a step by step migration for Boot 1.0 + Java to Boot 2.0 + Kotlin

• spring-boot-coroutines-demo: Coroutines sample project

7.11. What to Read Next

If you want to learn more about any of the classes discussed in this section, see the Spring Boot API
documentation or you can browse the source code directly. If you have specific questions, see the
how-to section.

If you are comfortable with Spring Boot’s core features, you can continue on and read about
production-ready features.

171
Chapter 8. Web
Spring Boot is well suited for web application development. You can create a self-contained HTTP
server by using embedded Tomcat, Jetty, Undertow, or Netty. Most web applications use the spring-
boot-starter-web module to get up and running quickly. You can also choose to build reactive web
applications by using the spring-boot-starter-webflux module.

If you have not yet developed a Spring Boot web application, you can follow the "Hello World!"
example in the Getting started section.

8.1. Servlet Web Applications

If you want to build servlet-based web applications, you can take advantage of Spring Boot’s auto-
configuration for Spring MVC.

8.1.1. The “Spring Web MVC Framework”

The Spring Web MVC framework (often referred to as “Spring MVC”) is a rich “model view
controller” web framework. Spring MVC lets you create special @Controller or @RestController
beans to handle incoming HTTP requests. Methods in your controller are mapped to HTTP by using
@RequestMapping annotations.

The following code shows a typical @RestController that serves JSON data:

172
 import java.util.List;

import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/users")
public class MyRestController {

  private final UserRepository userRepository;

  private final CustomerRepository customerRepository;

  public MyRestController(UserRepository userRepository, CustomerRepository

customerRepository) {
  this.userRepository = userRepository;
  this.customerRepository = customerRepository;
  }

  @GetMapping("/{user}")
  public User getUser(@PathVariable Long userId) {
  return this.userRepository.findById(userId).get();
  }

  @GetMapping("/{user}/customers")
  public List<Customer> getUserCustomers(@PathVariable Long userId) {
  return
this.userRepository.findById(userId).map(this.customerRepository::findByUser).get();
  }

  @DeleteMapping("/{user}")
  public void deleteUser(@PathVariable Long userId) {
  this.userRepository.deleteById(userId);
  }

Spring MVC is part of the core Spring Framework, and detailed information is available in the
reference documentation. There are also several guides that cover Spring MVC available at
spring.io/guides.

Spring MVC Auto-configuration

Spring Boot provides auto-configuration for Spring MVC that works well with most applications.

The auto-configuration adds the following features on top of Spring’s defaults:

173
 • Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.

• Support for serving static resources, including support for WebJars (covered later in this
document).

• Automatic registration of Converter, GenericConverter, and Formatter beans.

• Support for HttpMessageConverters (covered later in this document).

• Automatic registration of MessageCodesResolver (covered later in this document).

• Static index.html support.

• Automatic use of a ConfigurableWebBindingInitializer bean (covered later in this document).

If you want to keep those Spring Boot MVC customizations and make more MVC customizations
(interceptors, formatters, view controllers, and other features), you can add your own
@Configuration class of type WebMvcConfigurer but without @EnableWebMvc.

If you want to provide custom instances of RequestMappingHandlerMapping,

RequestMappingHandlerAdapter, or ExceptionHandlerExceptionResolver, and still keep the Spring Boot
MVC customizations, you can declare a bean of type WebMvcRegistrations and use it to provide
custom instances of those components.

If you want to take complete control of Spring MVC, you can add your own @Configuration
annotated with @EnableWebMvc, or alternatively add your own @Configuration-annotated
DelegatingWebMvcConfiguration as described in the Javadoc of @EnableWebMvc.

Spring MVC uses a different ConversionService to the one used to convert values
from your application.properties or application.yaml file. It means that Period,
Duration and DataSize converters are not available and that @DurationUnit and
@DataSizeUnit annotations will be ignored.
NOTE
If you want to customize the ConversionService used by Spring MVC, you can
provide a WebMvcConfigurer bean with an addFormatters method. From this method
you can register any converter that you like, or you can delegate to the static
methods available on ApplicationConversionService.

HttpMessageConverters

Spring MVC uses the HttpMessageConverter interface to convert HTTP requests and responses.
Sensible defaults are included out of the box. For example, objects can be automatically converted
to JSON (by using the Jackson library) or XML (by using the Jackson XML extension, if available, or
by using JAXB if the Jackson XML extension is not available). By default, strings are encoded in UTF-
8.

If you need to add or customize converters, you can use Spring Boot’s HttpMessageConverters class,
as shown in the following listing:

174
 import org.springframework.boot.autoconfigure.http.HttpMessageConverters;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;

@Configuration(proxyBeanMethods = false)
public class MyHttpMessageConvertersConfiguration {

  @Bean
  public HttpMessageConverters customConverters() {
  HttpMessageConverter<?> additional = new AdditionalHttpMessageConverter();
  HttpMessageConverter<?> another = new AnotherHttpMessageConverter();
  return new HttpMessageConverters(additional, another);
  }

Any HttpMessageConverter bean that is present in the context is added to the list of converters. You
can also override default converters in the same way.

Custom JSON Serializers and Deserializers

If you use Jackson to serialize and deserialize JSON data, you might want to write your own
JsonSerializer and JsonDeserializer classes. Custom serializers are usually registered with Jackson
through a module, but Spring Boot provides an alternative @JsonComponent annotation that makes it
easier to directly register Spring Beans.

You can use the @JsonComponent annotation directly on JsonSerializer, JsonDeserializer or

KeyDeserializer implementations. You can also use it on classes that contain
serializers/deserializers as inner classes, as shown in the following example:

175
 import java.io.IOException;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.ObjectCodec;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

import org.springframework.boot.jackson.JsonComponent;

@JsonComponent
public class MyJsonComponent {

  public static class Serializer extends JsonSerializer<MyObject> {

  @Override
  public void serialize(MyObject value, JsonGenerator jgen, SerializerProvider
serializers) throws IOException {
  jgen.writeStringField("name", value.getName());
  jgen.writeNumberField("age", value.getAge());
  }

  }

  public static class Deserializer extends JsonDeserializer<MyObject> {

  @Override
  public MyObject deserialize(JsonParser jsonParser, DeserializationContext
ctxt)
  throws IOException, JsonProcessingException {
  ObjectCodec codec = jsonParser.getCodec();
  JsonNode tree = codec.readTree(jsonParser);
  String name = tree.get("name").textValue();
  int age = tree.get("age").intValue();
  return new MyObject(name, age);
  }

  }

All @JsonComponent beans in the ApplicationContext are automatically registered with Jackson.
Because @JsonComponent is meta-annotated with @Component, the usual component-scanning rules
apply.

Spring Boot also provides JsonObjectSerializer and JsonObjectDeserializer base classes that

176
provide useful alternatives to the standard Jackson versions when serializing objects. See
JsonObjectSerializer and JsonObjectDeserializer in the Javadoc for details.

The example above can be rewritten to use JsonObjectSerializer/JsonObjectDeserializer as follows:

import java.io.IOException;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.ObjectCodec;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.SerializerProvider;

import org.springframework.boot.jackson.JsonComponent;
import org.springframework.boot.jackson.JsonObjectDeserializer;
import org.springframework.boot.jackson.JsonObjectSerializer;

@JsonComponent
public class MyJsonComponent {

  public static class Serializer extends JsonObjectSerializer<MyObject> {

  @Override
  protected void serializeObject(MyObject value, JsonGenerator jgen,
SerializerProvider provider)
  throws IOException {
  jgen.writeStringField("name", value.getName());
  jgen.writeNumberField("age", value.getAge());
  }

  }

  public static class Deserializer extends JsonObjectDeserializer<MyObject> {

  @Override
  protected MyObject deserializeObject(JsonParser jsonParser,
DeserializationContext context, ObjectCodec codec,
  JsonNode tree) throws IOException {
  String name = nullSafeValue(tree.get("name"), String.class);
  int age = nullSafeValue(tree.get("age"), Integer.class);
  return new MyObject(name, age);
  }

  }

177
MessageCodesResolver

Spring MVC has a strategy for generating error codes for rendering error messages from binding
errors: MessageCodesResolver. If you set the spring.mvc.message-codes-resolver-format property
PREFIX_ERROR_CODE or POSTFIX_ERROR_CODE, Spring Boot creates one for you (see the enumeration in
DefaultMessageCodesResolver.Format).

Static Content

By default, Spring Boot serves static content from a directory called /static (or /public or
/resources or /META-INF/resources) in the classpath or from the root of the ServletContext. It uses
the ResourceHttpRequestHandler from Spring MVC so that you can modify that behavior by adding
your own WebMvcConfigurer and overriding the addResourceHandlers method.

In a stand-alone web application, the default servlet from the container is also enabled and acts as
a fallback, serving content from the root of the ServletContext if Spring decides not to handle it.
Most of the time, this does not happen (unless you modify the default MVC configuration), because
Spring can always handle requests through the DispatcherServlet.

By default, resources are mapped on /**, but you can tune that with the spring.mvc.static-path-
pattern property. For instance, relocating all resources to /resources/** can be achieved as follows:

Properties

spring.mvc.static-path-pattern=/resources/**

Yaml

spring:
  mvc:
  static-path-pattern: "/resources/**"

You can also customize the static resource locations by using the spring.web.resources.static-
locations property (replacing the default values with a list of directory locations). The root servlet
context path, "/", is automatically added as a location as well.

In addition to the “standard” static resource locations mentioned earlier, a special case is made for
Webjars content. Any resources with a path in /webjars/** are served from jar files if they are
packaged in the Webjars format.

Do not use the src/main/webapp directory if your application is packaged as a jar.

TIP Although this directory is a common standard, it works only with war packaging, and
it is silently ignored by most build tools if you generate a jar.

Spring Boot also supports the advanced resource handling features provided by Spring MVC,
allowing use cases such as cache-busting static resources or using version agnostic URLs for
Webjars.

To use version agnostic URLs for Webjars, add the webjars-locator-core dependency. Then declare

178
your Webjar. Using jQuery as an example, adding "/webjars/jquery/jquery.min.js" results in
"/webjars/jquery/x.y.z/jquery.min.js" where x.y.z is the Webjar version.

If you use JBoss, you need to declare the webjars-locator-jboss-vfs dependency

NOTE
instead of the webjars-locator-core. Otherwise, all Webjars resolve as a 404.

To use cache busting, the following configuration configures a cache busting solution for all static
resources, effectively adding a content hash, such as <link href="/css/spring-
2a2d595e6ed9a0b24f027f2b63b134d6.css"/>, in URLs:

Properties

spring.web.resources.chain.strategy.content.enabled=true
spring.web.resources.chain.strategy.content.paths=/**

Yaml

spring:
  web:
  resources:
  chain:
  strategy:
  content:
  enabled: true
  paths: "/**"

Links to resources are rewritten in templates at runtime, thanks to a

ResourceUrlEncodingFilter that is auto-configured for Thymeleaf and FreeMarker.
NOTE You should manually declare this filter when using JSPs. Other template engines are
currently not automatically supported but can be with custom template
macros/helpers and the use of the ResourceUrlProvider.

When loading resources dynamically with, for example, a JavaScript module loader, renaming files
is not an option. That is why other strategies are also supported and can be combined. A "fixed"
strategy adds a static version string in the URL without changing the file name, as shown in the
following example:

Properties

spring.web.resources.chain.strategy.content.enabled=true
spring.web.resources.chain.strategy.content.paths=/**
spring.web.resources.chain.strategy.fixed.enabled=true
spring.web.resources.chain.strategy.fixed.paths=/js/lib/
spring.web.resources.chain.strategy.fixed.version=v12

179
Yaml

spring:
  web:
  resources:
  chain:
  strategy:
  content:
  enabled: true
  paths: "/**"
  fixed:
  enabled: true
  paths: "/js/lib/"
  version: "v12"

With this configuration, JavaScript modules located under "/js/lib/" use a fixed versioning
strategy ("/v12/js/lib/mymodule.js"), while other resources still use the content one (<link
href="/css/spring-2a2d595e6ed9a0b24f027f2b63b134d6.css"/>).

See WebProperties.Resources for more supported options.

This feature has been thoroughly described in a dedicated blog post and in Spring
TIP
Framework’s reference documentation.

Welcome Page

Spring Boot supports both static and templated welcome pages. It first looks for an index.html file in
the configured static content locations. If one is not found, it then looks for an index template. If
either is found, it is automatically used as the welcome page of the application.

Path Matching and Content Negotiation

Spring MVC can map incoming HTTP requests to handlers by looking at the request path and
matching it to the mappings defined in your application (for example, @GetMapping annotations on
Controller methods).

Spring Boot chooses to disable suffix pattern matching by default, which means that requests like
"GET /projects/spring-boot.json" will not be matched to @GetMapping("/projects/spring-boot")
mappings. This is considered as a best practice for Spring MVC applications. This feature was
mainly useful in the past for HTTP clients which did not send proper "Accept" request headers; we
needed to make sure to send the correct Content Type to the client. Nowadays, Content Negotiation
is much more reliable.

There are other ways to deal with HTTP clients that do not consistently send proper "Accept"
request headers. Instead of using suffix matching, we can use a query parameter to ensure that
requests like "GET /projects/spring-boot?format=json" will be mapped to
@GetMapping("/projects/spring-boot"):

180
Properties

spring.mvc.contentnegotiation.favor-parameter=true

Yaml

spring:
  mvc:
  contentnegotiation:
  favor-parameter: true

Or if you prefer to use a different parameter name:

Properties

spring.mvc.contentnegotiation.favor-parameter=true
spring.mvc.contentnegotiation.parameter-name=myparam

Yaml

spring:
  mvc:
  contentnegotiation:
  favor-parameter: true
  parameter-name: "myparam"

Most standard media types are supported out-of-the-box, but you can also define new ones:

Properties

spring.mvc.contentnegotiation.media-types.markdown=text/markdown

Yaml

spring:
  mvc:
  contentnegotiation:
  media-types:
  markdown: "text/markdown"

Suffix pattern matching is deprecated and will be removed in a future release. If you understand
the caveats and would still like your application to use suffix pattern matching, the following
configuration is required:

181
Properties

spring.mvc.contentnegotiation.favor-path-extension=true
spring.mvc.pathmatch.use-suffix-pattern=true

Yaml

spring:
  mvc:
  contentnegotiation:
  favor-path-extension: true
  pathmatch:
  use-suffix-pattern: true

Alternatively, rather than open all suffix patterns, it is more secure to only support registered suffix
patterns:

Properties

spring.mvc.contentnegotiation.favor-path-extension=true
spring.mvc.pathmatch.use-registered-suffix-pattern=true

Yaml

spring:
  mvc:
  contentnegotiation:
  favor-path-extension: true
  pathmatch:
  use-registered-suffix-pattern: true

As of Spring Framework 5.3, Spring MVC supports several implementation strategies for matching
request paths to Controller handlers. It was previously only supporting the AntPathMatcher strategy,
but it now also offers PathPatternParser. Spring Boot now provides a configuration property to
choose and opt in the new strategy:

Properties

spring.mvc.pathmatch.matching-strategy=path-pattern-parser

Yaml

spring:
  mvc:
  pathmatch:
  matching-strategy: "path-pattern-parser"

182
For more details on why you should consider this new implementation, see the dedicated blog post.

PathPatternParser is an optimized implementation but restricts usage of some path

patterns variants and is incompatible with suffix pattern matching
NOTE (spring.mvc.pathmatch.use-suffix-pattern, spring.mvc.pathmatch.use-registered-
suffix-pattern) or mapping the DispatcherServlet with a servlet prefix
(spring.mvc.servlet.path).

ConfigurableWebBindingInitializer

Spring MVC uses a WebBindingInitializer to initialize a WebDataBinder for a particular request. If you
create your own ConfigurableWebBindingInitializer @Bean, Spring Boot automatically configures
Spring MVC to use it.

Template Engines

As well as REST web services, you can also use Spring MVC to serve dynamic HTML content. Spring
MVC supports a variety of templating technologies, including Thymeleaf, FreeMarker, and JSPs.
Also, many other templating engines include their own Spring MVC integrations.

Spring Boot includes auto-configuration support for the following templating engines:

• FreeMarker

• Groovy

• Thymeleaf

• Mustache

If possible, JSPs should be avoided. There are several known limitations when using
TIP
them with embedded servlet containers.

When you use one of these templating engines with the default configuration, your templates are
picked up automatically from src/main/resources/templates.

Depending on how you run your application, your IDE may order the classpath
differently. Running your application in the IDE from its main method results in a
different ordering than when you run your application by using Maven or Gradle or
TIP
from its packaged jar. This can cause Spring Boot to fail to find the expected template.
If you have this problem, you can reorder the classpath in the IDE to place the
module’s classes and resources first.

Error Handling

By default, Spring Boot provides an /error mapping that handles all errors in a sensible way, and it
is registered as a “global” error page in the servlet container. For machine clients, it produces a
JSON response with details of the error, the HTTP status, and the exception message. For browser
clients, there is a “whitelabel” error view that renders the same data in HTML format (to customize
it, add a View that resolves to error).

183
There are a number of server.error properties that can be set if you want to customize the default
error handling behavior. See the “Server Properties” section of the Appendix.

To replace the default behavior completely, you can implement ErrorController and register a bean
definition of that type or add a bean of type ErrorAttributes to use the existing mechanism but
replace the contents.

The BasicErrorController can be used as a base class for a custom ErrorController.

This is particularly useful if you want to add a handler for a new content type (the
TIP default is to handle text/html specifically and provide a fallback for everything else).
To do so, extend BasicErrorController, add a public method with a @RequestMapping
that has a produces attribute, and create a bean of your new type.

You can also define a class annotated with @ControllerAdvice to customize the JSON document to
return for a particular controller and/or exception type, as shown in the following example:

import jakarta.servlet.RequestDispatcher;
import jakarta.servlet.http.HttpServletRequest;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import
org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

@ControllerAdvice(basePackageClasses = SomeController.class)
public class MyControllerAdvice extends ResponseEntityExceptionHandler {

  @ResponseBody
  @ExceptionHandler(MyException.class)
  public ResponseEntity<?> handleControllerException(HttpServletRequest request,
Throwable ex) {
  HttpStatus status = getStatus(request);
  return new ResponseEntity<>(new MyErrorBody(status.value(), ex.getMessage()),
status);
  }

  private HttpStatus getStatus(HttpServletRequest request) {

  Integer code = (Integer)
request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
  HttpStatus status = HttpStatus.resolve(code);
  return (status != null) ? status : HttpStatus.INTERNAL_SERVER_ERROR;
  }

In the preceding example, if YourException is thrown by a controller defined in the same package as

184
SomeController, a JSON representation of the CustomErrorType POJO is used instead of the
ErrorAttributes representation.

In some cases, errors handled at the controller level are not recorded by the metrics infrastructure.
Applications can ensure that such exceptions are recorded with the request metrics by setting the
handled exception as a request attribute:

import jakarta.servlet.http.HttpServletRequest;

import org.springframework.boot.web.servlet.error.ErrorAttributes;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;

@Controller
public class MyController {

  @ExceptionHandler(CustomException.class)
  String handleCustomException(HttpServletRequest request, CustomException ex) {
  request.setAttribute(ErrorAttributes.ERROR_ATTRIBUTE, ex);
  return "errorView";
  }

Custom Error Pages

If you want to display a custom HTML error page for a given status code, you can add a file to an
/error directory. Error pages can either be static HTML (that is, added under any of the static
resource directories) or be built by using templates. The name of the file should be the exact status
code or a series mask.

For example, to map 404 to a static HTML file, your directory structure would be as follows:

src/
 +- main/
  +- java/
  | + <source code>
  +- resources/
  +- public/
  +- error/
  | +- 404.html
  +- <other public assets>

To map all 5xx errors by using a FreeMarker template, your directory structure would be as follows:

185
 src/
 +- main/
  +- java/
  | + <source code>
  +- resources/
  +- templates/
  +- error/
  | +- 5xx.ftlh
  +- <other templates>

For more complex mappings, you can also add beans that implement the ErrorViewResolver
interface, as shown in the following example:

import java.util.Map;

import jakarta.servlet.http.HttpServletRequest;

import org.springframework.boot.autoconfigure.web.servlet.error.ErrorViewResolver;
import org.springframework.http.HttpStatus;
import org.springframework.web.servlet.ModelAndView;

public class MyErrorViewResolver implements ErrorViewResolver {

  @Override
  public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus
status, Map<String, Object> model) {
  // Use the request or status to optionally return a ModelAndView
  if (status == HttpStatus.INSUFFICIENT_STORAGE) {
  // We could add custom model values here
  new ModelAndView("myview");
  }
  return null;
  }

You can also use regular Spring MVC features such as @ExceptionHandler methods and
@ControllerAdvice. The ErrorController then picks up any unhandled exceptions.

Mapping Error Pages outside of Spring MVC

For applications that do not use Spring MVC, you can use the ErrorPageRegistrar interface to
directly register ErrorPages. This abstraction works directly with the underlying embedded servlet
container and works even if you do not have a Spring MVC DispatcherServlet.

186
import org.springframework.boot.web.server.ErrorPage;
import org.springframework.boot.web.server.ErrorPageRegistrar;
import org.springframework.boot.web.server.ErrorPageRegistry;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpStatus;

@Configuration(proxyBeanMethods = false)
public class MyErrorPagesConfiguration {

  @Bean
  public ErrorPageRegistrar errorPageRegistrar() {
  return this::registerErrorPages;
  }

  private void registerErrorPages(ErrorPageRegistry registry) {

  registry.addErrorPages(new ErrorPage(HttpStatus.BAD_REQUEST, "/400"));
  }

If you register an ErrorPage with a path that ends up being handled by a Filter (as is
common with some non-Spring web frameworks, like Jersey and Wicket), then the
NOTE
Filter has to be explicitly registered as an ERROR dispatcher, as shown in the
following example:

import java.util.EnumSet;

import jakarta.servlet.DispatcherType;

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyFilterConfiguration {

  @Bean
  public FilterRegistrationBean<MyFilter> myFilter() {
  FilterRegistrationBean<MyFilter> registration = new
FilterRegistrationBean<>(new MyFilter());
  // ...
  registration.setDispatcherTypes(EnumSet.allOf(DispatcherType.class));
  return registration;
  }

187
Note that the default FilterRegistrationBean does not include the ERROR dispatcher type.

Error handling in a war deployment

When deployed to a servlet container, Spring Boot uses its error page filter to forward a request
with an error status to the appropriate error page. This is necessary as the servlet specification does
not provide an API for registering error pages. Depending on the container that you are deploying
your war file to and the technologies that your application uses, some additional configuration may
be required.

The error page filter can only forward the request to the correct error page if the response has not
already been committed. By default, WebSphere Application Server 8.0 and later commits the
response upon successful completion of a servlet’s service method. You should disable this behavior
by setting com.ibm.ws.webcontainer.invokeFlushAfterService to false.

If you are using Spring Security and want to access the principal in an error page, you must
configure Spring Security’s filter to be invoked on error dispatches. To do so, set the
spring.security.filter.dispatcher-types property to async, error, forward, request.

CORS Support

Cross-origin resource sharing (CORS) is a W3C specification implemented by most browsers that
lets you specify in a flexible way what kind of cross-domain requests are authorized, instead of
using some less secure and less powerful approaches such as IFRAME or JSONP.

As of version 4.2, Spring MVC supports CORS. Using controller method CORS configuration with
@CrossOrigin annotations in your Spring Boot application does not require any specific
configuration. Global CORS configuration can be defined by registering a WebMvcConfigurer bean
with a customized addCorsMappings(CorsRegistry) method, as shown in the following example:

188
 import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration(proxyBeanMethods = false)
public class MyCorsConfiguration {

  @Bean
  public WebMvcConfigurer corsConfigurer() {
  return new WebMvcConfigurer() {

  @Override
  public void addCorsMappings(CorsRegistry registry) {
  registry.addMapping("/api/**");
  }

  };
  }

8.1.2. Embedded Servlet Container Support

For servlet application, Spring Boot includes support for embedded Tomcat, Jetty, and Undertow
servers. Most developers use the appropriate “Starter” to obtain a fully configured instance. By
default, the embedded server listens for HTTP requests on port 8080.

Servlets, Filters, and listeners

When using an embedded servlet container, you can register servlets, filters, and all the listeners
(such as HttpSessionListener) from the servlet spec, either by using Spring beans or by scanning for
servlet components.

Registering Servlets, Filters, and Listeners as Spring Beans

Any Servlet, Filter, or servlet *Listener instance that is a Spring bean is registered with the
embedded container. This can be particularly convenient if you want to refer to a value from your
application.properties during configuration.

By default, if the context contains only a single Servlet, it is mapped to /. In the case of multiple
servlet beans, the bean name is used as a path prefix. Filters map to /*.

If convention-based mapping is not flexible enough, you can use the ServletRegistrationBean,
FilterRegistrationBean, and ServletListenerRegistrationBean classes for complete control.

It is usually safe to leave filter beans unordered. If a specific order is required, you should annotate
the Filter with @Order or make it implement Ordered. You cannot configure the order of a Filter by
annotating its bean method with @Order. If you cannot change the Filter class to add @Order or

189
implement Ordered, you must define a FilterRegistrationBean for the Filter and set the registration
bean’s order using the setOrder(int) method. Avoid configuring a filter that reads the request body
at Ordered.HIGHEST_PRECEDENCE, since it might go against the character encoding configuration of
your application. If a servlet filter wraps the request, it should be configured with an order that is
less than or equal to OrderedFilter.REQUEST_WRAPPER_FILTER_MAX_ORDER.

To see the order of every Filter in your application, enable debug level logging for the
TIP web logging group (logging.level.web=debug). Details of the registered filters, including
their order and URL patterns, will then be logged at startup.

Take care when registering Filter beans since they are initialized very early in
WARNING the application lifecycle. If you need to register a Filter that interacts with
other beans, consider using a DelegatingFilterProxyRegistrationBean instead.

Servlet Context Initialization

Embedded servlet containers do not directly execute the

jakarta.servlet.ServletContainerInitializer interface or Spring’s
org.springframework.web.WebApplicationInitializer interface. This is an intentional design decision
intended to reduce the risk that third party libraries designed to run inside a war may break Spring
Boot applications.

If you need to perform servlet context initialization in a Spring Boot application, you should
register a bean that implements the
org.springframework.boot.web.servlet.ServletContextInitializer interface. The single onStartup
method provides access to the ServletContext and, if necessary, can easily be used as an adapter to
an existing WebApplicationInitializer.

Scanning for Servlets, Filters, and listeners

When using an embedded container, automatic registration of classes annotated with @WebServlet,
@WebFilter, and @WebListener can be enabled by using @ServletComponentScan.

@ServletComponentScan has no effect in a standalone container, where the container’s

TIP
built-in discovery mechanisms are used instead.

The ServletWebServerApplicationContext

Under the hood, Spring Boot uses a different type of ApplicationContext for embedded servlet
container support. The ServletWebServerApplicationContext is a special type of
WebApplicationContext that bootstraps itself by searching for a single ServletWebServerFactory bean.
Usually a TomcatServletWebServerFactory, JettyServletWebServerFactory, or
UndertowServletWebServerFactory has been auto-configured.

You usually do not need to be aware of these implementation classes. Most

NOTE applications are auto-configured, and the appropriate ApplicationContext and
ServletWebServerFactory are created on your behalf.

190
Customizing Embedded Servlet Containers

Common servlet container settings can be configured by using Spring Environment properties.
Usually, you would define the properties in your application.properties or application.yaml file.

Common server settings include:

• Network settings: Listen port for incoming HTTP requests (server.port), interface address to
bind to server.address, and so on.

• Session settings: Whether the session is persistent (server.servlet.session.persistent), session

timeout (server.servlet.session.timeout), location of session data
(server.servlet.session.store-dir), and session-cookie configuration
(server.servlet.session.cookie.*).

• Error management: Location of the error page (server.error.path) and so on.

• SSL

• HTTP compression

Spring Boot tries as much as possible to expose common settings, but this is not always possible. For
those cases, dedicated namespaces offer server-specific customizations (see server.tomcat and
server.undertow). For instance, access logs can be configured with specific features of the embedded
servlet container.

TIP See the ServerProperties class for a complete list.

SameSite Cookies

The SameSite cookie attribute can be used by web browsers to control if and how cookies are
submitted in cross-site requests. The attribute is particularly relevant for modern web browsers
which have started to change the default value that is used when the attribute is missing.

If you want to change the SameSite attribute of your session cookie, you can use the
server.servlet.session.cookie.same-site property. This property is supported by auto-configured
Tomcat, Jetty and Undertow servers. It is also used to configure Spring Session servlet based
SessionRepository beans.

For example, if you want your session cookie to have a SameSite attribute of None, you can add the
following to your application.properties or application.yaml file:

Properties

server.servlet.session.cookie.same-site=none

191
Yaml

server:
  servlet:
  session:
  cookie:
  same-site: "none"

If you want to change the SameSite attribute on other cookies added to your HttpServletResponse,
you can use a CookieSameSiteSupplier. The CookieSameSiteSupplier is passed a Cookie and may
return a SameSite value, or null.

There are a number of convenience factory and filter methods that you can use to quickly match
specific cookies. For example, adding the following bean will automatically apply a SameSite of Lax
for all cookies with a name that matches the regular expression myapp.*.

import org.springframework.boot.web.servlet.server.CookieSameSiteSupplier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MySameSiteConfiguration {

  @Bean
  public CookieSameSiteSupplier applicationCookieSameSiteSupplier() {
  return CookieSameSiteSupplier.ofLax().whenHasNameMatching("myapp.*");
  }

Programmatic Customization

If you need to programmatically configure your embedded servlet container, you can register a
Spring bean that implements the WebServerFactoryCustomizer interface. WebServerFactoryCustomizer
provides access to the ConfigurableServletWebServerFactory, which includes numerous
customization setter methods. The following example shows programmatically setting the port:

192
 import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import
org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory;
import org.springframework.stereotype.Component;

@Component
public class MyWebServerFactoryCustomizer implements
WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {

  @Override
  public void customize(ConfigurableServletWebServerFactory server) {
  server.setPort(9000);
  }

TomcatServletWebServerFactory, JettyServletWebServerFactory and UndertowServletWebServerFactory

are dedicated variants of ConfigurableServletWebServerFactory that have additional customization
setter methods for Tomcat, Jetty and Undertow respectively. The following example shows how to
customize TomcatServletWebServerFactory that provides access to Tomcat-specific configuration
options:

import java.time.Duration;

import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.stereotype.Component;

@Component
public class MyTomcatWebServerFactoryCustomizer implements
WebServerFactoryCustomizer<TomcatServletWebServerFactory> {

  @Override
  public void customize(TomcatServletWebServerFactory server) {
  server.addConnectorCustomizers((connector) ->
connector.setAsyncTimeout(Duration.ofSeconds(20).toMillis()));
  }

Customizing ConfigurableServletWebServerFactory Directly

For more advanced use cases that require you to extend from ServletWebServerFactory, you can
expose a bean of such type yourself.

Setters are provided for many configuration options. Several protected method “hooks” are also
provided should you need to do something more exotic. See the source code documentation for
details.

193
 Auto-configured customizers are still applied on your custom factory, so use that
NOTE
option carefully.

JSP Limitations

When running a Spring Boot application that uses an embedded servlet container (and is packaged
as an executable archive), there are some limitations in the JSP support.

• With Jetty and Tomcat, it should work if you use war packaging. An executable war will work
when launched with java -jar, and will also be deployable to any standard container. JSPs are
not supported when using an executable jar.

• Undertow does not support JSPs.

• Creating a custom error.jsp page does not override the default view for error handling. Custom
error pages should be used instead.

8.2. Reactive Web Applications

Spring Boot simplifies development of reactive web applications by providing auto-configuration
for Spring Webflux.

8.2.1. The “Spring WebFlux Framework”

Spring WebFlux is the new reactive web framework introduced in Spring Framework 5.0. Unlike
Spring MVC, it does not require the servlet API, is fully asynchronous and non-blocking, and
implements the Reactive Streams specification through the Reactor project.

Spring WebFlux comes in two flavors: functional and annotation-based. The annotation-based one
is quite close to the Spring MVC model, as shown in the following example:

194
 import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/users")
public class MyRestController {

  private final UserRepository userRepository;

  private final CustomerRepository customerRepository;

  public MyRestController(UserRepository userRepository, CustomerRepository

customerRepository) {
  this.userRepository = userRepository;
  this.customerRepository = customerRepository;
  }

  @GetMapping("/{user}")
  public Mono<User> getUser(@PathVariable Long userId) {
  return this.userRepository.findById(userId);
  }

  @GetMapping("/{user}/customers")
  public Flux<Customer> getUserCustomers(@PathVariable Long userId) {
  return
this.userRepository.findById(userId).flatMapMany(this.customerRepository::findByUser);
  }

  @DeleteMapping("/{user}")
  public void deleteUser(@PathVariable Long userId) {
  this.userRepository.deleteById(userId);
  }

“WebFlux.fn”, the functional variant, separates the routing configuration from the actual handling
of the requests, as shown in the following example:

195
 import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.web.reactive.function.server.RequestPredicate;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.ServerResponse;

import static
org.springframework.web.reactive.function.server.RequestPredicates.DELETE;
import static org.springframework.web.reactive.function.server.RequestPredicates.GET;
import static
org.springframework.web.reactive.function.server.RequestPredicates.accept;
import static org.springframework.web.reactive.function.server.RouterFunctions.route;

@Configuration(proxyBeanMethods = false)
public class MyRoutingConfiguration {

  private static final RequestPredicate ACCEPT_JSON =

accept(MediaType.APPLICATION_JSON);

  @Bean
  public RouterFunction<ServerResponse> monoRouterFunction(MyUserHandler
userHandler) {
  return route(
  GET("/{user}").and(ACCEPT_JSON), userHandler::getUser).andRoute(
  GET("/{user}/customers").and(ACCEPT_JSON),
userHandler::getUserCustomers).andRoute(
  DELETE("/{user}").and(ACCEPT_JSON), userHandler::deleteUser);
  }

196
 import reactor.core.publisher.Mono;

import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;

@Component
public class MyUserHandler {

  public Mono<ServerResponse> getUser(ServerRequest request) {

  ...
  }

  public Mono<ServerResponse> getUserCustomers(ServerRequest request) {

  ...
  }

  public Mono<ServerResponse> deleteUser(ServerRequest request) {

  ...
  }

WebFlux is part of the Spring Framework and detailed information is available in its reference
documentation.

You can define as many RouterFunction beans as you like to modularize the definition
TIP
of the router. Beans can be ordered if you need to apply a precedence.

To get started, add the spring-boot-starter-webflux module to your application.

Adding both spring-boot-starter-web and spring-boot-starter-webflux modules in

your application results in Spring Boot auto-configuring Spring MVC, not WebFlux.
This behavior has been chosen because many Spring developers add spring-boot-
NOTE
starter-webflux to their Spring MVC application to use the reactive WebClient. You
can still enforce your choice by setting the chosen application type to
SpringApplication.setWebApplicationType(WebApplicationType.REACTIVE).

“WebFlux.fn”, the functional variant, separates the routing configuration from the actual handling
of the requests, as shown in the following example:

197
 import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.web.reactive.function.server.RequestPredicate;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.ServerResponse;

import static
org.springframework.web.reactive.function.server.RequestPredicates.DELETE;
import static org.springframework.web.reactive.function.server.RequestPredicates.GET;
import static
org.springframework.web.reactive.function.server.RequestPredicates.accept;
import static org.springframework.web.reactive.function.server.RouterFunctions.route;

@Configuration(proxyBeanMethods = false)
public class MyRoutingConfiguration {

  private static final RequestPredicate ACCEPT_JSON =

accept(MediaType.APPLICATION_JSON);

  @Bean
  public RouterFunction<ServerResponse> monoRouterFunction(MyUserHandler
userHandler) {
  return route(
  GET("/{user}").and(ACCEPT_JSON), userHandler::getUser).andRoute(
  GET("/{user}/customers").and(ACCEPT_JSON),
userHandler::getUserCustomers).andRoute(
  DELETE("/{user}").and(ACCEPT_JSON), userHandler::deleteUser);
  }

198
 import reactor.core.publisher.Mono;

import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;

@Component
public class MyUserHandler {

  public Mono<ServerResponse> getUser(ServerRequest request) {

  ...
  }

  public Mono<ServerResponse> getUserCustomers(ServerRequest request) {

  ...
  }

  public Mono<ServerResponse> deleteUser(ServerRequest request) {

  ...
  }

WebFlux is part of the Spring Framework and detailed information is available in its reference
documentation.

You can define as many RouterFunction beans as you like to modularize the definition
TIP
of the router. Beans can be ordered if you need to apply a precedence.

To get started, add the spring-boot-starter-webflux module to your application.

Adding both spring-boot-starter-web and spring-boot-starter-webflux modules in

your application results in Spring Boot auto-configuring Spring MVC, not WebFlux.
This behavior has been chosen because many Spring developers add spring-boot-
NOTE
starter-webflux to their Spring MVC application to use the reactive WebClient. You
can still enforce your choice by setting the chosen application type to
SpringApplication.setWebApplicationType(WebApplicationType.REACTIVE).

Spring WebFlux Auto-configuration

Spring Boot provides auto-configuration for Spring WebFlux that works well with most
applications.

The auto-configuration adds the following features on top of Spring’s defaults:

• Configuring codecs for HttpMessageReader and HttpMessageWriter instances (described later in

this document).

• Support for serving static resources, including support for WebJars (described later in this

199
 document).

If you want to keep Spring Boot WebFlux features and you want to add additional WebFlux
configuration, you can add your own @Configuration class of type WebFluxConfigurer but without
@EnableWebFlux.

If you want to take complete control of Spring WebFlux, you can add your own @Configuration
annotated with @EnableWebFlux.

HTTP Codecs with HttpMessageReaders and HttpMessageWriters

Spring WebFlux uses the HttpMessageReader and HttpMessageWriter interfaces to convert HTTP
requests and responses. They are configured with CodecConfigurer to have sensible defaults by
looking at the libraries available in your classpath.

Spring Boot provides dedicated configuration properties for codecs, spring.codec.*. It also applies
further customization by using CodecCustomizer instances. For example, spring.jackson.*
configuration keys are applied to the Jackson codec.

If you need to add or customize codecs, you can create a custom CodecCustomizer component, as
shown in the following example:

import org.springframework.boot.web.codec.CodecCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.codec.ServerSentEventHttpMessageReader;

@Configuration(proxyBeanMethods = false)
public class MyCodecsConfiguration {

  @Bean
  public CodecCustomizer myCodecCustomizer() {
  return (configurer) -> {
  configurer.registerDefaults(false);
  configurer.customCodecs().register(new
ServerSentEventHttpMessageReader());
  // ...
  };
  }

You can also leverage Boot’s custom JSON serializers and deserializers.

Static Content

By default, Spring Boot serves static content from a directory called /static (or /public or
/resources or /META-INF/resources) in the classpath. It uses the ResourceWebHandler from Spring
WebFlux so that you can modify that behavior by adding your own WebFluxConfigurer and
overriding the addResourceHandlers method.

200
By default, resources are mapped on /**, but you can tune that by setting the
spring.webflux.static-path-pattern property. For instance, relocating all resources to /resources/**
can be achieved as follows:

Properties

spring.webflux.static-path-pattern=/resources/**

Yaml

spring:
  webflux:
  static-path-pattern: "/resources/**"

You can also customize the static resource locations by using spring.web.resources.static-
locations. Doing so replaces the default values with a list of directory locations. If you do so, the
default welcome page detection switches to your custom locations. So, if there is an index.html in
any of your locations on startup, it is the home page of the application.

In addition to the “standard” static resource locations listed earlier, a special case is made for
Webjars content. Any resources with a path in /webjars/** are served from jar files if they are
packaged in the Webjars format.

Spring WebFlux applications do not strictly depend on the servlet API, so they cannot
TIP
be deployed as war files and do not use the src/main/webapp directory.

Welcome Page

Spring Boot supports both static and templated welcome pages. It first looks for an index.html file in
the configured static content locations. If one is not found, it then looks for an index template. If
either is found, it is automatically used as the welcome page of the application.

Template Engines

As well as REST web services, you can also use Spring WebFlux to serve dynamic HTML content.
Spring WebFlux supports a variety of templating technologies, including Thymeleaf, FreeMarker,
and Mustache.

Spring Boot includes auto-configuration support for the following templating engines:

• FreeMarker

• Thymeleaf

• Mustache

When you use one of these templating engines with the default configuration, your templates are
picked up automatically from src/main/resources/templates.

201
Error Handling

Spring Boot provides a WebExceptionHandler that handles all errors in a sensible way. Its position in
the processing order is immediately before the handlers provided by WebFlux, which are
considered last. For machine clients, it produces a JSON response with details of the error, the HTTP
status, and the exception message. For browser clients, there is a “whitelabel” error handler that
renders the same data in HTML format. You can also provide your own HTML templates to display
errors (see the next section).

The first step to customizing this feature often involves using the existing mechanism but replacing
or augmenting the error contents. For that, you can add a bean of type ErrorAttributes.

To change the error handling behavior, you can implement ErrorWebExceptionHandler and register a
bean definition of that type. Because a ErrorWebExceptionHandler is quite low-level, Spring Boot also
provides a convenient AbstractErrorWebExceptionHandler to let you handle errors in a WebFlux
functional way, as shown in the following example:

202
 import reactor.core.publisher.Mono;

import org.springframework.boot.autoconfigure.web.WebProperties.Resources;
import
org.springframework.boot.autoconfigure.web.reactive.error.AbstractErrorWebExceptionHan
dler;
import org.springframework.boot.web.reactive.error.ErrorAttributes;
import org.springframework.context.ApplicationContext;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.RouterFunctions;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
import org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder;

@Component
public class MyErrorWebExceptionHandler extends AbstractErrorWebExceptionHandler {

  public MyErrorWebExceptionHandler(ErrorAttributes errorAttributes, Resources

resources,
  ApplicationContext applicationContext) {
  super(errorAttributes, resources, applicationContext);
  }

  @Override
  protected RouterFunction<ServerResponse> getRoutingFunction(ErrorAttributes
errorAttributes) {
  return RouterFunctions.route(this::acceptsXml, this::handleErrorAsXml);
  }

  private boolean acceptsXml(ServerRequest request) {

  return request.headers().accept().contains(MediaType.APPLICATION_XML);
  }

  public Mono<ServerResponse> handleErrorAsXml(ServerRequest request) {

  BodyBuilder builder = ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR);
  // ... additional builder calls
  return builder.build();
  }

For a more complete picture, you can also subclass DefaultErrorWebExceptionHandler directly and
override specific methods.

In some cases, errors handled at the controller or handler function level are not recorded by the
metrics infrastructure. Applications can ensure that such exceptions are recorded with the request

203
metrics by setting the handled exception as a request attribute:

import org.springframework.boot.web.reactive.error.ErrorAttributes;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.reactive.result.view.Rendering;
import org.springframework.web.server.ServerWebExchange;

@Controller
public class MyExceptionHandlingController {

  @GetMapping("/profile")
  public Rendering userProfile() {
  // ...
  throw new IllegalStateException();
  }

  @ExceptionHandler(IllegalStateException.class)
  public Rendering handleIllegalState(ServerWebExchange exchange,
IllegalStateException exc) {
  exchange.getAttributes().putIfAbsent(ErrorAttributes.ERROR_ATTRIBUTE, exc);
  return Rendering.view("errorView").modelAttribute("message",
exc.getMessage()).build();
  }

Custom Error Pages

If you want to display a custom HTML error page for a given status code, you can add a file to an
/error directory. Error pages can either be static HTML (that is, added under any of the static
resource directories) or built with templates. The name of the file should be the exact status code or
a series mask.

For example, to map 404 to a static HTML file, your directory structure would be as follows:

src/
 +- main/
  +- java/
  | + <source code>
  +- resources/
  +- public/
  +- error/
  | +- 404.html
  +- <other public assets>

To map all 5xx errors by using a Mustache template, your directory structure would be as follows:

204
 src/
 +- main/
  +- java/
  | + <source code>
  +- resources/
  +- templates/
  +- error/
  | +- 5xx.mustache
  +- <other templates>

Web Filters

Spring WebFlux provides a WebFilter interface that can be implemented to filter HTTP request-
response exchanges. WebFilter beans found in the application context will be automatically used to
filter each exchange.

Where the order of the filters is important they can implement Ordered or be annotated with @Order.
Spring Boot auto-configuration may configure web filters for you. When it does so, the orders
shown in the following table will be used:

Web Filter Order

MetricsWebFilter Ordered.HIGHEST_PRECEDENCE + 1

WebFilterChainProxy (Spring Security) -100

HttpTraceWebFilter Ordered.LOWEST_PRECEDENCE - 10

8.2.2. Embedded Reactive Server Support

Spring Boot includes support for the following embedded reactive web servers: Reactor Netty,
Tomcat, Jetty, and Undertow. Most developers use the appropriate “Starter” to obtain a fully
configured instance. By default, the embedded server listens for HTTP requests on port 8080.

8.2.3. Reactive Server Resources Configuration

When auto-configuring a Reactor Netty or Jetty server, Spring Boot will create specific beans that
will provide HTTP resources to the server instance: ReactorResourceFactory or JettyResourceFactory.

By default, those resources will be also shared with the Reactor Netty and Jetty clients for optimal
performances, given:

• the same technology is used for server and client

• the client instance is built using the WebClient.Builder bean auto-configured by Spring Boot

Developers can override the resource configuration for Jetty and Reactor Netty by providing a
custom ReactorResourceFactory or JettyResourceFactory bean - this will be applied to both clients
and servers.

You can learn more about the resource configuration on the client side in the WebClient Runtime

205
section.

8.3. Graceful Shutdown

Graceful shutdown is supported with all four embedded web servers (Jetty, Reactor Netty, Tomcat,
and Undertow) and with both reactive and servlet-based web applications. It occurs as part of
closing the application context and is performed in the earliest phase of stopping SmartLifecycle
beans. This stop processing uses a timeout which provides a grace period during which existing
requests will be allowed to complete but no new requests will be permitted. The exact way in which
new requests are not permitted varies depending on the web server that is being used. Jetty,
Reactor Netty, and Tomcat will stop accepting requests at the network layer. Undertow will accept
requests but respond immediately with a service unavailable (503) response.

NOTE Graceful shutdown with Tomcat requires Tomcat 9.0.33 or later.

To enable graceful shutdown, configure the server.shutdown property, as shown in the following
example:

Properties

server.shutdown=graceful

Yaml

server:
  shutdown: "graceful"

To configure the timeout period, configure the spring.lifecycle.timeout-per-shutdown-phase

property, as shown in the following example:

Properties

spring.lifecycle.timeout-per-shutdown-phase=20s

Yaml

spring:
  lifecycle:
  timeout-per-shutdown-phase: "20s"

Using graceful shutdown with your IDE may not work properly if it does not
IMPORTANT send a proper SIGTERM signal. See the documentation of your IDE for more
details.

206
8.4. Spring Security
If Spring Security is on the classpath, then web applications are secured by default. Spring Boot
relies on Spring Security’s content-negotiation strategy to determine whether to use httpBasic or
formLogin. To add method-level security to a web application, you can also add
@EnableGlobalMethodSecurity with your desired settings. Additional information can be found in the
Spring Security Reference Guide.

The default UserDetailsService has a single user. The user name is user, and the password is
random and is printed at INFO level when the application starts, as shown in the following
example:

Using generated security password: 78fa095d-3f4c-48b1-ad50-e24c31d5cf35

If you fine-tune your logging configuration, ensure that the

NOTE org.springframework.boot.autoconfigure.security category is set to log INFO-level
messages. Otherwise, the default password is not printed.

You can change the username and password by providing a spring.security.user.name and
spring.security.user.password.

The basic features you get by default in a web application are:

• A UserDetailsService (or ReactiveUserDetailsService in case of a WebFlux application) bean

with in-memory store and a single user with a generated password (see SecurityProperties.User
for the properties of the user).

• Form-based login or HTTP Basic security (depending on the Accept header in the request) for the
entire application (including actuator endpoints if actuator is on the classpath).

• A DefaultAuthenticationEventPublisher for publishing authentication events.

You can provide a different AuthenticationEventPublisher by adding a bean for it.

8.4.1. MVC Security

The default security configuration is implemented in SecurityAutoConfiguration and

UserDetailsServiceAutoConfiguration. SecurityAutoConfiguration imports
SpringBootWebSecurityConfiguration for web security and UserDetailsServiceAutoConfiguration
configures authentication, which is also relevant in non-web applications. To switch off the default
web application security configuration completely or to combine multiple Spring Security
components such as OAuth2 Client and Resource Server, add a bean of type SecurityFilterChain
(doing so does not disable the UserDetailsService configuration or Actuator’s security).

To also switch off the UserDetailsService configuration, you can add a bean of type
UserDetailsService, AuthenticationProvider, or AuthenticationManager.

Access rules can be overridden by adding a custom SecurityFilterChain or

WebSecurityConfigurerAdapter bean. Spring Boot provides convenience methods that can be used to

207
override access rules for actuator endpoints and static resources. EndpointRequest can be used to
create a RequestMatcher that is based on the management.endpoints.web.base-path property.
PathRequest can be used to create a RequestMatcher for resources in commonly used locations.

8.4.2. WebFlux Security

Similar to Spring MVC applications, you can secure your WebFlux applications by adding the
spring-boot-starter-security dependency. The default security configuration is implemented in
ReactiveSecurityAutoConfiguration and UserDetailsServiceAutoConfiguration.
ReactiveSecurityAutoConfiguration imports WebFluxSecurityConfiguration for web security and
UserDetailsServiceAutoConfiguration configures authentication, which is also relevant in non-web
applications. To switch off the default web application security configuration completely, you can
add a bean of type WebFilterChainProxy (doing so does not disable the UserDetailsService
configuration or Actuator’s security).

To also switch off the UserDetailsService configuration, you can add a bean of type
ReactiveUserDetailsService or ReactiveAuthenticationManager.

Access rules and the use of multiple Spring Security components such as OAuth 2 Client and
Resource Server can be configured by adding a custom SecurityWebFilterChain bean. Spring Boot
provides convenience methods that can be used to override access rules for actuator endpoints and
static resources. EndpointRequest can be used to create a ServerWebExchangeMatcher that is based on
the management.endpoints.web.base-path property.

PathRequest can be used to create a ServerWebExchangeMatcher for resources in commonly used

locations.

For example, you can customize your security configuration by adding something like:

208
 import org.springframework.boot.autoconfigure.security.reactive.PathRequest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.web.server.ServerHttpSecurity;
import org.springframework.security.web.server.SecurityWebFilterChain;

@Configuration(proxyBeanMethods = false)
public class MyWebFluxSecurityConfiguration {

  @Bean
  public SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
  http.authorizeExchange((spec) -> {
 
spec.matchers(PathRequest.toStaticResources().atCommonLocations()).permitAll();
  spec.pathMatchers("/foo", "/bar").authenticated();
  });
  http.formLogin();
  return http.build();
  }

8.4.3. OAuth2

OAuth2 is a widely used authorization framework that is supported by Spring.

Client

If you have spring-security-oauth2-client on your classpath, you can take advantage of some auto-
configuration to set up an OAuth2/Open ID Connect clients. This configuration makes use of the
properties under OAuth2ClientProperties. The same properties are applicable to both servlet and
reactive applications.

You can register multiple OAuth2 clients and providers under the spring.security.oauth2.client
prefix, as shown in the following example:

209
Properties

spring.security.oauth2.client.registration.my-client-1.client-id=abcd
spring.security.oauth2.client.registration.my-client-1.client-secret=password
spring.security.oauth2.client.registration.my-client-1.client-name=Client for user
scope
spring.security.oauth2.client.registration.my-client-1.provider=my-oauth-provider
spring.security.oauth2.client.registration.my-client-1.scope=user
spring.security.oauth2.client.registration.my-client-1.redirect-uri=https://my-
redirect-uri.com
spring.security.oauth2.client.registration.my-client-1.client-authentication-
method=basic
spring.security.oauth2.client.registration.my-client-1.authorization-grant-
type=authorization-code

spring.security.oauth2.client.registration.my-client-2.client-id=abcd
spring.security.oauth2.client.registration.my-client-2.client-secret=password
spring.security.oauth2.client.registration.my-client-2.client-name=Client for email
scope
spring.security.oauth2.client.registration.my-client-2.provider=my-oauth-provider
spring.security.oauth2.client.registration.my-client-2.scope=email
spring.security.oauth2.client.registration.my-client-2.redirect-uri=https://my-
redirect-uri.com
spring.security.oauth2.client.registration.my-client-2.client-authentication-
method=basic
spring.security.oauth2.client.registration.my-client-2.authorization-grant-
type=authorization_code

spring.security.oauth2.client.provider.my-oauth-provider.authorization-uri=https://my-
auth-server/oauth/authorize
spring.security.oauth2.client.provider.my-oauth-provider.token-uri=https://my-auth-
server/oauth/token
spring.security.oauth2.client.provider.my-oauth-provider.user-info-uri=https://my-
auth-server/userinfo
spring.security.oauth2.client.provider.my-oauth-provider.user-info-authentication-
method=header
spring.security.oauth2.client.provider.my-oauth-provider.jwk-set-uri=https://my-auth-
server/token_keys
spring.security.oauth2.client.provider.my-oauth-provider.user-name-attribute=name

210
Yaml

spring:
  security:
  oauth2:
  client:
  registration:
  my-client-1:
  client-id: "abcd"
  client-secret: "password"
  client-name: "Client for user scope"
  provider: "my-oauth-provider"
  scope: "user"
  redirect-uri: "https://my-redirect-uri.com"
  client-authentication-method: "basic"
  authorization-grant-type: "authorization-code"

  my-client-2:
  client-id: "abcd"
  client-secret: "password"
  client-name: "Client for email scope"
  provider: "my-oauth-provider"
  scope: "email"
  redirect-uri: "https://my-redirect-uri.com"
  client-authentication-method: "basic"
  authorization-grant-type: "authorization_code"

  provider:
  my-oauth-provider:
  authorization-uri: "https://my-auth-server/oauth/authorize"
  token-uri: "https://my-auth-server/oauth/token"
  user-info-uri: "https://my-auth-server/userinfo"
  user-info-authentication-method: "header"
  jwk-set-uri: "https://my-auth-server/token_keys"
  user-name-attribute: "name"

For OpenID Connect providers that support OpenID Connect discovery, the configuration can be
further simplified. The provider needs to be configured with an issuer-uri which is the URI that the
it asserts as its Issuer Identifier. For example, if the issuer-uri provided is "https://example.com",
then an OpenID Provider Configuration Request will be made to "https://example.com/.well-
known/openid-configuration". The result is expected to be an OpenID Provider Configuration
Response. The following example shows how an OpenID Connect Provider can be configured with
the issuer-uri:

Properties

spring.security.oauth2.client.provider.oidc-provider.issuer-uri=https://dev-
123456.oktapreview.com/oauth2/default/

211
Yaml

spring:
  security:
  oauth2:
  client:
  provider:
  oidc-provider:
  issuer-uri: "https://dev-123456.oktapreview.com/oauth2/default/"

By default, Spring Security’s OAuth2LoginAuthenticationFilter only processes URLs matching

/login/oauth2/code/*. If you want to customize the redirect-uri to use a different pattern, you need
to provide configuration to process that custom pattern. For example, for servlet applications, you
can add your own SecurityFilterChain that resembles the following:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.web.SecurityFilterChain;

@Configuration(proxyBeanMethods = false)
public class MyOAuthClientConfiguration {

  @Bean
  public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception
{
  http.authorizeRequests().anyRequest().authenticated();
  http.oauth2Login().redirectionEndpoint().baseUri("custom-callback");
  return http.build();
  }

Spring Boot auto-configures an InMemoryOAuth2AuthorizedClientService which is used

by Spring Security for the management of client registrations. The
InMemoryOAuth2AuthorizedClientService has limited capabilities and we recommend
TIP
using it only for development environments. For production environments, consider
using a JdbcOAuth2AuthorizedClientService or creating your own implementation of
OAuth2AuthorizedClientService.

OAuth2 client registration for common providers

For common OAuth2 and OpenID providers, including Google, Github, Facebook, and Okta, we
provide a set of provider defaults (google, github, facebook, and okta, respectively).

If you do not need to customize these providers, you can set the provider attribute to the one for
which you need to infer defaults. Also, if the key for the client registration matches a default
supported provider, Spring Boot infers that as well.

212
In other words, the two configurations in the following example use the Google provider:

Properties

spring.security.oauth2.client.registration.my-client.client-id=abcd
spring.security.oauth2.client.registration.my-client.client-secret=password
spring.security.oauth2.client.registration.my-client.provider=google
spring.security.oauth2.client.registration.google.client-id=abcd
spring.security.oauth2.client.registration.google.client-secret=password

Yaml

spring:
  security:
  oauth2:
  client:
  registration:
  my-client:
  client-id: "abcd"
  client-secret: "password"
  provider: "google"
  google:
  client-id: "abcd"
  client-secret: "password"

Resource Server

If you have spring-security-oauth2-resource-server on your classpath, Spring Boot can set up an

OAuth2 Resource Server. For JWT configuration, a JWK Set URI or OIDC Issuer URI needs to be
specified, as shown in the following examples:

Properties

spring.security.oauth2.resourceserver.jwt.jwk-set-
uri=https://example.com/oauth2/default/v1/keys

Yaml

spring:
  security:
  oauth2:
  resourceserver:
  jwt:
  jwk-set-uri: "https://example.com/oauth2/default/v1/keys"

213
Properties

spring.security.oauth2.resourceserver.jwt.issuer-uri=https://dev-
123456.oktapreview.com/oauth2/default/

Yaml

spring:
  security:
  oauth2:
  resourceserver:
  jwt:
  issuer-uri: "https://dev-123456.oktapreview.com/oauth2/default/"

If the authorization server does not support a JWK Set URI, you can configure the
resource server with the Public Key used for verifying the signature of the JWT. This
NOTE can be done using the spring.security.oauth2.resourceserver.jwt.public-key-
location property, where the value needs to point to a file containing the public key
in the PEM-encoded x509 format.

The same properties are applicable for both servlet and reactive applications.

Alternatively, you can define your own JwtDecoder bean for servlet applications or a
ReactiveJwtDecoder for reactive applications.

In cases where opaque tokens are used instead of JWTs, you can configure the following properties
to validate tokens through introspection:

Properties

spring.security.oauth2.resourceserver.opaquetoken.introspection-
uri=https://example.com/check-token
spring.security.oauth2.resourceserver.opaquetoken.client-id=my-client-id
spring.security.oauth2.resourceserver.opaquetoken.client-secret=my-client-secret

Yaml

spring:
  security:
  oauth2:
  resourceserver:
  opaquetoken:
  introspection-uri: "https://example.com/check-token"
  client-id: "my-client-id"
  client-secret: "my-client-secret"

Again, the same properties are applicable for both servlet and reactive applications.

214
Alternatively, you can define your own OpaqueTokenIntrospector bean for servlet applications or a
ReactiveOpaqueTokenIntrospector for reactive applications.

Authorization Server

Currently, Spring Security does not provide support for implementing an OAuth 2.0 Authorization
Server. However, this functionality is available from the Spring Security OAuth project, which will
eventually be superseded by Spring Security completely. Until then, you can use the spring-
security-oauth2-autoconfigure module to easily set up an OAuth 2.0 authorization server; see its
documentation for instructions.

8.4.4. SAML 2.0

Relying Party

If you have spring-security-saml2-service-provider on your classpath, you can take advantage of

some auto-configuration to set up a SAML 2.0 Relying Party. This configuration makes use of the
properties under Saml2RelyingPartyProperties.

A relying party registration represents a paired configuration between an Identity Provider, IDP,
and a Service Provider, SP. You can register multiple relying parties under the
spring.security.saml2.relyingparty prefix, as shown in the following example:

215
Properties

spring.security.saml2.relyingparty.registration.my-relying-
party1.signing.credentials[0].private-key-location=path-to-private-key
spring.security.saml2.relyingparty.registration.my-relying-
party1.signing.credentials[0].certificate-location=path-to-certificate
spring.security.saml2.relyingparty.registration.my-relying-
party1.decryption.credentials[0].private-key-location=path-to-private-key
spring.security.saml2.relyingparty.registration.my-relying-
party1.decryption.credentials[0].certificate-location=path-to-certificate
spring.security.saml2.relyingparty.registration.my-relying-
party1.identityprovider.verification.credentials[0].certificate-location=path-to-
verification-cert
spring.security.saml2.relyingparty.registration.my-relying-
party1.identityprovider.entity-id=remote-idp-entity-id1
spring.security.saml2.relyingparty.registration.my-relying-
party1.identityprovider.sso-url=https://remoteidp1.sso.url

spring.security.saml2.relyingparty.registration.my-relying-
party2.signing.credentials[0].private-key-location=path-to-private-key
spring.security.saml2.relyingparty.registration.my-relying-
party2.signing.credentials[0].certificate-location=path-to-certificate
spring.security.saml2.relyingparty.registration.my-relying-
party2.decryption.credentials[0].private-key-location=path-to-private-key
spring.security.saml2.relyingparty.registration.my-relying-
party2.decryption.credentials[0].certificate-location=path-to-certificate
spring.security.saml2.relyingparty.registration.my-relying-
party2.identityprovider.verification.credentials[0].certificate-location=path-to-
other-verification-cert
spring.security.saml2.relyingparty.registration.my-relying-
party2.identityprovider.entity-id=remote-idp-entity-id2
spring.security.saml2.relyingparty.registration.my-relying-
party2.identityprovider.sso-url=https://remoteidp2.sso.url

216
Yaml

spring:
  security:
  saml2:
  relyingparty:
  registration:
  my-relying-party1:
  signing:
  credentials:
  - private-key-location: "path-to-private-key"
  certificate-location: "path-to-certificate"
  decryption:
  credentials:
  - private-key-location: "path-to-private-key"
  certificate-location: "path-to-certificate"
  identityprovider:
  verification:
  credentials:
  - certificate-location: "path-to-verification-cert"
  entity-id: "remote-idp-entity-id1"
  sso-url: "https://remoteidp1.sso.url"

  my-relying-party2:
  signing:
  credentials:
  - private-key-location: "path-to-private-key"
  certificate-location: "path-to-certificate"
  decryption:
  credentials:
  - private-key-location: "path-to-private-key"
  certificate-location: "path-to-certificate"
  identityprovider:
  verification:
  credentials:
  - certificate-location: "path-to-other-verification-cert"
  entity-id: "remote-idp-entity-id2"
  sso-url: "https://remoteidp2.sso.url"

8.5. Spring Session

Spring Boot provides Spring Session auto-configuration for a wide range of data stores. When
building a servlet web application, the following stores can be auto-configured:

• JDBC

• Redis

• Hazelcast

• MongoDB

217
The servlet auto-configuration replaces the need to use @Enable*HttpSession.

When building a reactive web application, the following stores can be auto-configured:

• Redis

• MongoDB

The reactive auto-configuration replaces the need to use @Enable*WebSession.

If a single Spring Session module is present on the classpath, Spring Boot uses that store
implementation automatically. If you have more than one implementation, you must choose the
StoreType that you wish to use to store the sessions. For instance, to use JDBC as the back-end store,
you can configure your application as follows:

Properties

spring.session.store-type=jdbc

Yaml

spring:
  session:
  store-type: "jdbc"

TIP You can disable Spring Session by setting the store-type to none.

Each store has specific additional settings. For instance, it is possible to customize the name of the
table for the JDBC store, as shown in the following example:

Properties

spring.session.jdbc.table-name=SESSIONS

Yaml

spring:
  session:
  jdbc:
  table-name: "SESSIONS"

For setting the timeout of the session you can use the spring.session.timeout property. If that
property is not set with a servlet web application, the auto-configuration falls back to the value of
server.servlet.session.timeout.

You can take control over Spring Session’s configuration using @Enable*HttpSession (servlet) or
@Enable*WebSession (reactive). This will cause the auto-configuration to back off. Spring Session can
then be configured using the annotation’s attributes rather than the previously described
configuration properties.

218
8.6. Spring HATEOAS
If you develop a RESTful API that makes use of hypermedia, Spring Boot provides auto-
configuration for Spring HATEOAS that works well with most applications. The auto-configuration
replaces the need to use @EnableHypermediaSupport and registers a number of beans to ease building
hypermedia-based applications, including a LinkDiscoverers (for client side support) and an
ObjectMapper configured to correctly marshal responses into the desired representation. The
ObjectMapper is customized by setting the various spring.jackson.* properties or, if one exists, by a
Jackson2ObjectMapperBuilder bean.

You can take control of Spring HATEOAS’s configuration by using @EnableHypermediaSupport. Note
that doing so disables the ObjectMapper customization described earlier.

spring-boot-starter-hateoas is specific to Spring MVC and should not be

combined with Spring WebFlux. In order to use Spring HATEOAS with Spring
WARNING WebFlux, you can add a direct dependency on
org.springframework.hateoas:spring-hateoas along with spring-boot-starter-
webflux.

8.7. What to Read Next

You should now have a good understanding of how to develop web applications with Spring Boot.
The next few sections describe how Spring Boot integrates with various data technologies,
messaging systems, and other IO capabilities. You can pick any of these based on your application’s
needs.

219
Chapter 9. Data
Spring Boot integrates with a number of data technologies, both SQL and NoSQL.

9.1. SQL Databases

The Spring Framework provides extensive support for working with SQL databases, from direct
JDBC access using JdbcTemplate to complete “object relational mapping” technologies such as
Hibernate. Spring Data provides an additional level of functionality: creating Repository
implementations directly from interfaces and using conventions to generate queries from your
method names.

9.1.1. Configure a DataSource

Java’s javax.sql.DataSource interface provides a standard method of working with database

connections. Traditionally, a 'DataSource' uses a URL along with some credentials to establish a
database connection.

See the “How-to” section for more advanced examples, typically to take full control
TIP
over the configuration of the DataSource.

Embedded Database Support

It is often convenient to develop applications by using an in-memory embedded database.

Obviously, in-memory databases do not provide persistent storage. You need to populate your
database when your application starts and be prepared to throw away data when your application
ends.

TIP The “How-to” section includes a section on how to initialize a database.

Spring Boot can auto-configure embedded H2, HSQL, and Derby databases. You need not provide
any connection URLs. You need only include a build dependency to the embedded database that
you want to use. If there are multiple embedded databases on the classpath, set the
spring.datasource.embedded-database-connection configuration property to control which one is
used. Setting the property to none disables auto-configuration of an embedded database.

If you are using this feature in your tests, you may notice that the same database is
reused by your whole test suite regardless of the number of application contexts
NOTE
that you use. If you want to make sure that each context has a separate embedded
database, you should set spring.datasource.generate-unique-name to true.

For example, the typical POM dependencies would be as follows:

220
 <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
  <groupId>org.hsqldb</groupId>
  <artifactId>hsqldb</artifactId>
  <scope>runtime</scope>
</dependency>

You need a dependency on spring-jdbc for an embedded database to be auto-

NOTE configured. In this example, it is pulled in transitively through spring-boot-starter-
data-jpa.

If, for whatever reason, you do configure the connection URL for an embedded
database, take care to ensure that the database’s automatic shutdown is disabled. If
you use H2, you should use DB_CLOSE_ON_EXIT=FALSE to do so. If you use HSQLDB, you
TIP
should ensure that shutdown=true is not used. Disabling the database’s automatic
shutdown lets Spring Boot control when the database is closed, thereby ensuring that
it happens once access to the database is no longer needed.

Connection to a Production Database

Production database connections can also be auto-configured by using a pooling DataSource.

DataSource Configuration

DataSource configuration is controlled by external configuration properties in spring.datasource.*.

For example, you might declare the following section in application.properties:

Properties

spring.datasource.url=jdbc:mysql://localhost/test
spring.datasource.username=dbuser
spring.datasource.password=dbpass

Yaml

spring:
  datasource:
  url: "jdbc:mysql://localhost/test"
  username: "dbuser"
  password: "dbpass"

You should at least specify the URL by setting the spring.datasource.url property.
NOTE
Otherwise, Spring Boot tries to auto-configure an embedded database.

221
 Spring Boot can deduce the JDBC driver class for most databases from the URL. If you
TIP need to specify a specific class, you can use the spring.datasource.driver-class-name
property.

For a pooling DataSource to be created, we need to be able to verify that a valid

Driver class is available, so we check for that before doing anything. In other words,
NOTE
if you set spring.datasource.driver-class-name=com.mysql.jdbc.Driver, then that
class has to be loadable.

See DataSourceProperties for more of the supported options. These are the standard options that
work regardless of the actual implementation. It is also possible to fine-tune implementation-
specific settings by using their respective prefix (spring.datasource.hikari.*,
spring.datasource.tomcat.*, spring.datasource.dbcp2.*, and spring.datasource.oracleucp.*). See the
documentation of the connection pool implementation you are using for more details.

For instance, if you use the Tomcat connection pool, you could customize many additional settings,
as shown in the following example:

Properties

spring.datasource.tomcat.max-wait=10000
spring.datasource.tomcat.max-active=50
spring.datasource.tomcat.test-on-borrow=true

Yaml

spring:
  datasource:
  tomcat:
  max-wait: 10000
  max-active: 50
  test-on-borrow: true

This will set the pool to wait 10000ms before throwing an exception if no connection is available,
limit the maximum number of connections to 50 and validate the connection before borrowing it
from the pool.

Supported Connection Pools

Spring Boot uses the following algorithm for choosing a specific implementation:

1. We prefer HikariCP for its performance and concurrency. If HikariCP is available, we always
choose it.

2. Otherwise, if the Tomcat pooling DataSource is available, we use it.

3. Otherwise, if Commons DBCP2 is available, we use it.

4. If none of HikariCP, Tomcat, and DBCP2 are available and if Oracle UCP is available, we use it.

222
 If you use the spring-boot-starter-jdbc or spring-boot-starter-data-jpa “starters”,
NOTE
you automatically get a dependency to HikariCP.

You can bypass that algorithm completely and specify the connection pool to use by setting the
spring.datasource.type property. This is especially important if you run your application in a
Tomcat container, as tomcat-jdbc is provided by default.

Additional connection pools can always be configured manually, using DataSourceBuilder. If you
define your own DataSource bean, auto-configuration does not occur. The following connection
pools are supported by DataSourceBuilder:

• HikariCP

• Tomcat pooling Datasource

• Commons DBCP2

• Oracle UCP & OracleDataSource

• Spring Framework’s SimpleDriverDataSource

• H2 JdbcDataSource

• PostgreSQL PGSimpleDataSource

Connection to a JNDI DataSource

If you deploy your Spring Boot application to an Application Server, you might want to configure
and manage your DataSource by using your Application Server’s built-in features and access it by
using JNDI.

The spring.datasource.jndi-name property can be used as an alternative to the

spring.datasource.url, spring.datasource.username, and spring.datasource.password properties to
access the DataSource from a specific JNDI location. For example, the following section in
application.properties shows how you can access a JBoss AS defined DataSource:

Properties

spring.datasource.jndi-name=java:jboss/datasources/customers

Yaml

spring:
  datasource:
  jndi-name: "java:jboss/datasources/customers"

9.1.2. Using JdbcTemplate

Spring’s JdbcTemplate and NamedParameterJdbcTemplate classes are auto-configured, and you can
@Autowire them directly into your own beans, as shown in the following example:

223
 import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final JdbcTemplate jdbcTemplate;

  public MyBean(JdbcTemplate jdbcTemplate) {

  this.jdbcTemplate = jdbcTemplate;
  }

  public void doSomething() {

  this.jdbcTemplate ...
  }

You can customize some properties of the template by using the spring.jdbc.template.* properties,
as shown in the following example:

Properties

spring.jdbc.template.max-rows=500

Yaml

spring:
  jdbc:
  template:
  max-rows: 500

The NamedParameterJdbcTemplate reuses the same JdbcTemplate instance behind the

NOTE scenes. If more than one JdbcTemplate is defined and no primary candidate exists,
the NamedParameterJdbcTemplate is not auto-configured.

9.1.3. JPA and Spring Data JPA

The Java Persistence API is a standard technology that lets you “map” objects to relational
databases. The spring-boot-starter-data-jpa POM provides a quick way to get started. It provides
the following key dependencies:

• Hibernate: One of the most popular JPA implementations.

• Spring Data JPA: Helps you to implement JPA-based repositories.

• Spring ORM: Core ORM support from the Spring Framework.

224
 We do not go into too many details of JPA or Spring Data here. You can follow the
TIP “Accessing Data with JPA” guide from spring.io and read the Spring Data JPA and
Hibernate reference documentation.

Entity Classes

Traditionally, JPA “Entity” classes are specified in a persistence.xml file. With Spring Boot, this file is
not necessary and “Entity Scanning” is used instead. By default, all packages below your main
configuration class (the one annotated with @EnableAutoConfiguration or @SpringBootApplication)
are searched.

Any classes annotated with @Entity, @Embeddable, or @MappedSuperclass are considered. A typical
entity class resembles the following example:

225
 import java.io.Serializable;

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.Id;

@Entity
public class City implements Serializable {

  @Id
  @GeneratedValue
  private Long id;

  @Column(nullable = false)
  private String name;

  @Column(nullable = false)
  private String state;

  // ... additional members, often include @OneToMany mappings

  protected City() {
  // no-args constructor required by JPA spec
  // this one is protected since it should not be used directly
  }

  public City(String name, String state) {

  this.name = name;
  this.state = state;
  }

  public String getName() {

  return this.name;
  }

  public String getState() {

  return this.state;
  }

  // ... etc

You can customize entity scanning locations by using the @EntityScan annotation. See
TIP
the “Separate @Entity Definitions from Spring Configuration” how-to.

226
Spring Data JPA Repositories

Spring Data JPA repositories are interfaces that you can define to access data. JPA queries are
created automatically from your method names. For example, a CityRepository interface might
declare a findAllByState(String state) method to find all the cities in a given state.

For more complex queries, you can annotate your method with Spring Data’s Query annotation.

Spring Data repositories usually extend from the Repository or CrudRepository interfaces. If you use
auto-configuration, repositories are searched from the package containing your main configuration
class (the one annotated with @EnableAutoConfiguration or @SpringBootApplication) down.

The following example shows a typical Spring Data repository interface definition:

import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.City;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.repository.Repository;

public interface CityRepository extends Repository<City, Long> {

  Page<City> findAll(Pageable pageable);

  City findByNameAndStateAllIgnoringCase(String name, String state);

Spring Data JPA repositories support three different modes of bootstrapping: default, deferred, and
lazy. To enable deferred or lazy bootstrapping, set the spring.data.jpa.repositories.bootstrap-mode
property to deferred or lazy respectively. When using deferred or lazy bootstrapping, the auto-
configured EntityManagerFactoryBuilder will use the context’s AsyncTaskExecutor, if any, as the
bootstrap executor. If more than one exists, the one named applicationTaskExecutor will be used.

When using deferred or lazy bootstrapping, make sure to defer any access to the JPA
infrastructure after the application context bootstrap phase. You can use
NOTE SmartInitializingSingleton to invoke any initialization that requires the JPA
infrastructure. For JPA components (such as converters) that are created as Spring
beans, use ObjectProvider to delay the resolution of dependencies, if any.

We have barely scratched the surface of Spring Data JPA. For complete details, see the
TIP
Spring Data JPA reference documentation.

Spring Data Envers Repositories

If Spring Data Envers is available, JPA repositories are auto-configured to support typical Envers
queries.

To use Spring Data Envers, make sure your repository extends from RevisionRepository as show in
the following example:

227
 import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.Country;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.history.RevisionRepository;

public interface CountryRepository extends RevisionRepository<Country, Long, Integer>,

Repository<Country, Long> {

  Page<Country> findAll(Pageable pageable);

NOTE For more details, check the Spring Data Envers reference documentation.

Creating and Dropping JPA Databases

By default, JPA databases are automatically created only if you use an embedded database (H2,
HSQL, or Derby). You can explicitly configure JPA settings by using spring.jpa.* properties. For
example, to create and drop tables you can add the following line to your application.properties:

Properties

spring.jpa.hibernate.ddl-auto=create-drop

Yaml

spring:
  jpa:
  hibernate.ddl-auto: "create-drop"

Hibernate’s own internal property name for this (if you happen to remember it
better) is hibernate.hbm2ddl.auto. You can set it, along with other Hibernate native
NOTE properties, by using spring.jpa.properties.* (the prefix is stripped before adding
them to the entity manager). The following line shows an example of setting JPA
properties for Hibernate:

Properties

spring.jpa.properties.hibernate[globally_quoted_identifiers]=true

228
Yaml

spring:
  jpa:
  properties:
  hibernate:
  "globally_quoted_identifiers": "true"

The line in the preceding example passes a value of true for the
hibernate.globally_quoted_identifiers property to the Hibernate entity manager.

By default, the DDL execution (or validation) is deferred until the ApplicationContext has started.
There is also a spring.jpa.generate-ddl flag, but it is not used if Hibernate auto-configuration is
active, because the ddl-auto settings are more fine-grained.

Open EntityManager in View

If you are running a web application, Spring Boot by default registers

OpenEntityManagerInViewInterceptor to apply the “Open EntityManager in View” pattern, to allow
for lazy loading in web views. If you do not want this behavior, you should set spring.jpa.open-in-
view to false in your application.properties.

9.1.4. Spring Data JDBC

Spring Data includes repository support for JDBC and will automatically generate SQL for the
methods on CrudRepository. For more advanced queries, a @Query annotation is provided.

Spring Boot will auto-configure Spring Data’s JDBC repositories when the necessary dependencies
are on the classpath. They can be added to your project with a single dependency on spring-boot-
starter-data-jdbc. If necessary, you can take control of Spring Data JDBC’s configuration by adding
the @EnableJdbcRepositories annotation or a JdbcConfiguration subclass to your application.

TIP For complete details of Spring Data JDBC, see the reference documentation.

9.1.5. Using jOOQ

jOOQ Object Oriented Querying (jOOQ) is a popular product from Data Geekery which generates
Java code from your database and lets you build type-safe SQL queries through its fluent API. Both
the commercial and open source editions can be used with Spring Boot.

Code Generation

In order to use jOOQ type-safe queries, you need to generate Java classes from your database
schema. You can follow the instructions in the jOOQ user manual. If you use the jooq-codegen-maven
plugin and you also use the spring-boot-starter-parent “parent POM”, you can safely omit the
plugin’s <version> tag. You can also use Spring Boot-defined version variables (such as h2.version)
to declare the plugin’s database dependency. The following listing shows an example:

229
 <plugin>
  <groupId>org.jooq</groupId>
  <artifactId>jooq-codegen-maven</artifactId>
  <executions>
  ...
  </executions>
  <dependencies>
  <dependency>
  <groupId>com.h2database</groupId>
  <artifactId>h2</artifactId>
  <version>${h2.version}</version>
  </dependency>
  </dependencies>
  <configuration>
  <jdbc>
  <driver>org.h2.Driver</driver>
  <url>jdbc:h2:~/yourdatabase</url>
  </jdbc>
  <generator>
  ...
  </generator>
  </configuration>
</plugin>

Using DSLContext

The fluent API offered by jOOQ is initiated through the org.jooq.DSLContext interface. Spring Boot
auto-configures a DSLContext as a Spring Bean and connects it to your application DataSource. To use
the DSLContext, you can inject it, as shown in the following example:

230
 import java.util.GregorianCalendar;
import java.util.List;

import org.jooq.DSLContext;

import org.springframework.stereotype.Component;

import static org.springframework.boot.docs.data.sql.jooq.dslcontext.Tables.AUTHOR;

@Component
public class MyBean {

  private final DSLContext create;

  public MyBean(DSLContext dslContext) {

  this.create = dslContext;
  }

TIP The jOOQ manual tends to use a variable named create to hold the DSLContext.

You can then use the DSLContext to construct your queries, as shown in the following example:

public List<GregorianCalendar> authorsBornAfter1980() {

  return this.create.selectFrom(AUTHOR)
  .where(AUTHOR.DATE_OF_BIRTH.greaterThan(new GregorianCalendar(1980, 0,
1)))
  .fetch(AUTHOR.DATE_OF_BIRTH);

jOOQ SQL Dialect

Unless the spring.jooq.sql-dialect property has been configured, Spring Boot determines the SQL
dialect to use for your datasource. If Spring Boot could not detect the dialect, it uses DEFAULT.

Spring Boot can only auto-configure dialects supported by the open source version
NOTE
of jOOQ.

Customizing jOOQ

More advanced customizations can be achieved by defining your own

DefaultConfigurationCustomizer bean that will be invoked prior to creating the
org.jooq.Configuration @Bean. This takes precedence to anything that is applied by the auto-
configuration.

You can also create your own org.jooq.Configuration @Bean if you want to take complete control of

231
the jOOQ configuration.

9.1.6. Using R2DBC

The Reactive Relational Database Connectivity (R2DBC) project brings reactive programming APIs
to relational databases. R2DBC’s io.r2dbc.spi.Connection provides a standard method of working
with non-blocking database connections. Connections are provided by using a ConnectionFactory,
similar to a DataSource with jdbc.

ConnectionFactory configuration is controlled by external configuration properties in

spring.r2dbc.*. For example, you might declare the following section in application.properties:

Properties

spring.r2dbc.url=r2dbc:postgresql://localhost/test
spring.r2dbc.username=dbuser
spring.r2dbc.password=dbpass

Yaml

spring:
  r2dbc:
  url: "r2dbc:postgresql://localhost/test"
  username: "dbuser"
  password: "dbpass"

You do not need to specify a driver class name, since Spring Boot obtains the driver
TIP
from R2DBC’s Connection Factory discovery.

At least the url should be provided. Information specified in the URL takes
NOTE precedence over individual properties, that is name, username, password and pooling
options.

TIP The “How-to” section includes a section on how to initialize a database.

To customize the connections created by a ConnectionFactory, that is, set specific parameters that
you do not want (or cannot) configure in your central database configuration, you can use a
ConnectionFactoryOptionsBuilderCustomizer @Bean. The following example shows how to manually
override the database port while the rest of the options is taken from the application configuration:

232
 import io.r2dbc.spi.ConnectionFactoryOptions;

import
org.springframework.boot.autoconfigure.r2dbc.ConnectionFactoryOptionsBuilderCustomizer
;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyR2dbcConfiguration {

  @Bean
  public ConnectionFactoryOptionsBuilderCustomizer connectionFactoryPortCustomizer()
{
  return (builder) -> builder.option(ConnectionFactoryOptions.PORT, 5432);
  }

The following examples show how to set some PostgreSQL connection options:

import java.util.HashMap;
import java.util.Map;

import io.r2dbc.postgresql.PostgresqlConnectionFactoryProvider;

import
org.springframework.boot.autoconfigure.r2dbc.ConnectionFactoryOptionsBuilderCustomizer
;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyPostgresR2dbcConfiguration {

  @Bean
  public ConnectionFactoryOptionsBuilderCustomizer postgresCustomizer() {
  Map<String, String> options = new HashMap<>();
  options.put("lock_timeout", "30s");
  options.put("statement_timeout", "60s");
  return (builder) ->
builder.option(PostgresqlConnectionFactoryProvider.OPTIONS, options);
  }

When a ConnectionFactory bean is available, the regular JDBC DataSource auto-configuration backs
off. If you want to retain the JDBC DataSource auto-configuration, and are comfortable with the risk

233
of using the blocking JDBC API in a reactive application, add
@Import(DataSourceAutoConfiguration.class) on a @Configuration class in your application to re-
enable it.

Embedded Database Support

Similarly to the JDBC support, Spring Boot can automatically configure an embedded database for
reactive usage. You need not provide any connection URLs. You need only include a build
dependency to the embedded database that you want to use, as shown in the following example:

<dependency>
  <groupId>io.r2dbc</groupId>
  <artifactId>r2dbc-h2</artifactId>
  <scope>runtime</scope>
</dependency>

If you are using this feature in your tests, you may notice that the same database is
reused by your whole test suite regardless of the number of application contexts
NOTE
that you use. If you want to make sure that each context has a separate embedded
database, you should set spring.r2dbc.generate-unique-name to true.

Using DatabaseClient

A DatabaseClient bean is auto-configured, and you can @Autowire it directly into your own beans, as
shown in the following example:

import java.util.Map;

import reactor.core.publisher.Flux;

import org.springframework.r2dbc.core.DatabaseClient;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final DatabaseClient databaseClient;

  public MyBean(DatabaseClient databaseClient) {

  this.databaseClient = databaseClient;
  }

  public Flux<Map<String, Object>> someMethod() {

  return this.databaseClient.sql("select * from user").fetch().all();
  }

234
Spring Data R2DBC Repositories

Spring Data R2DBC repositories are interfaces that you can define to access data. Queries are
created automatically from your method names. For example, a CityRepository interface might
declare a findAllByState(String state) method to find all the cities in a given state.

For more complex queries, you can annotate your method with Spring Data’s Query annotation.

Spring Data repositories usually extend from the Repository or CrudRepository interfaces. If you use
auto-configuration, repositories are searched from the package containing your main configuration
class (the one annotated with @EnableAutoConfiguration or @SpringBootApplication) down.

The following example shows a typical Spring Data repository interface definition:

import reactor.core.publisher.Mono;

import org.springframework.data.repository.Repository;

public interface CityRepository extends Repository<City, Long> {

  Mono<City> findByNameAndStateAllIgnoringCase(String name, String state);

We have barely scratched the surface of Spring Data R2DBC. For complete details, see
TIP
the Spring Data R2DBC reference documentation.

9.2. Working with NoSQL Technologies

Spring Data provides additional projects that help you access a variety of NoSQL technologies,
including:

• MongoDB

• Neo4J

• Elasticsearch

• Redis

• GemFire or Geode

• Cassandra

• Couchbase

• LDAP

Spring Boot provides auto-configuration for Redis, MongoDB, Neo4j, Solr, Elasticsearch, Cassandra,
Couchbase, LDAP and InfluxDB. You can make use of the other projects, but you must configure
them yourself. See the appropriate reference documentation at spring.io/projects/spring-data.

235
9.2.1. Redis

Redis is a cache, message broker, and richly-featured key-value store. Spring Boot offers basic auto-
configuration for the Lettuce and Jedis client libraries and the abstractions on top of them provided
by Spring Data Redis.

There is a spring-boot-starter-data-redis “Starter” for collecting the dependencies in a convenient

way. By default, it uses Lettuce. That starter handles both traditional and reactive applications.

We also provide a spring-boot-starter-data-redis-reactive “Starter” for consistency

TIP
with the other stores with reactive support.

Connecting to Redis

You can inject an auto-configured RedisConnectionFactory, StringRedisTemplate, or vanilla

RedisTemplate instance as you would any other Spring Bean. By default, the instance tries to connect
to a Redis server at localhost:6379. The following listing shows an example of such a bean:

import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final StringRedisTemplate template;

  public MyBean(StringRedisTemplate template) {

  this.template = template;
  }

  public Boolean someMethod() {

  return this.template.hasKey("spring");
  }

You can also register an arbitrary number of beans that implement

LettuceClientConfigurationBuilderCustomizer for more advanced customizations.
ClientResources can also be customized using ClientResourcesBuilderCustomizer. If you
TIP use Jedis, JedisClientConfigurationBuilderCustomizer is also available. Alternatively,
you can register a bean of type RedisStandaloneConfiguration,
RedisSentinelConfiguration, or RedisClusterConfiguration to take full control over the
configuration.

If you add your own @Bean of any of the auto-configured types, it replaces the default (except in the
case of RedisTemplate, when the exclusion is based on the bean name, redisTemplate, not its type).

By default, a pooled connection factory is auto-configured if commons-pool2 is on the classpath.

236
9.2.2. MongoDB

MongoDB is an open-source NoSQL document database that uses a JSON-like schema instead of
traditional table-based relational data. Spring Boot offers several conveniences for working with
MongoDB, including the spring-boot-starter-data-mongodb and spring-boot-starter-data-mongodb-
reactive “Starters”.

Connecting to a MongoDB Database

To access MongoDB databases, you can inject an auto-configured

org.springframework.data.mongodb.MongoDatabaseFactory. By default, the instance tries to connect to
a MongoDB server at mongodb://localhost/test. The following example shows how to connect to a
MongoDB database:

import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoDatabase;
import org.bson.Document;

import org.springframework.data.mongodb.MongoDatabaseFactory;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final MongoDatabaseFactory mongo;

  public MyBean(MongoDatabaseFactory mongo) {

  this.mongo = mongo;
  }

  public MongoCollection<Document> someMethod() {

  MongoDatabase db = this.mongo.getMongoDatabase();
  return db.getCollection("users");
  }

If you have defined your own MongoClient, it will be used to auto-configure a suitable
MongoDatabaseFactory.

The auto-configured MongoClient is created using a MongoClientSettings bean. If you have defined
your own MongoClientSettings, it will be used without modification and the spring.data.mongodb
properties will be ignored. Otherwise a MongoClientSettings will be auto-configured and will have
the spring.data.mongodb properties applied to it. In either case, you can declare one or more
MongoClientSettingsBuilderCustomizer beans to fine-tune the MongoClientSettings configuration.
Each will be called in order with the MongoClientSettings.Builder that is used to build the
MongoClientSettings.

You can set the spring.data.mongodb.uri property to change the URL and configure additional

237
settings such as the replica set, as shown in the following example:

Properties

spring.data.mongodb.uri=mongodb://user:secret@mongo1.example.com:12345,mongo2.example.
com:23456/test

Yaml

spring:
  data:
  mongodb:
  uri:
"mongodb://user:secret@mongo1.example.com:12345,mongo2.example.com:23456/test"

Alternatively, you can specify connection details using discrete properties. For example, you might
declare the following settings in your application.properties:

Properties

spring.data.mongodb.host=mongoserver.example.com
spring.data.mongodb.port=27017
spring.data.mongodb.database=test
spring.data.mongodb.username=user
spring.data.mongodb.password=secret

Yaml

spring:
  data:
  mongodb:
  host: "mongoserver.example.com"
  port: 27017
  database: "test"
  username: "user"
  password: "secret"

If spring.data.mongodb.port is not specified, the default of 27017 is used. You could

TIP
delete this line from the example shown earlier.

If you do not use Spring Data MongoDB, you can inject a MongoClient bean instead of
using MongoDatabaseFactory. If you want to take complete control of establishing the
TIP
MongoDB connection, you can also declare your own MongoDatabaseFactory or
MongoClient bean.

238
 If you are using the reactive driver, Netty is required for SSL. The auto-
NOTE configuration configures this factory automatically if Netty is available and the
factory to use has not been customized already.

MongoTemplate

Spring Data MongoDB provides a MongoTemplate class that is very similar in its design to Spring’s
JdbcTemplate. As with JdbcTemplate, Spring Boot auto-configures a bean for you to inject the
template, as follows:

import com.mongodb.client.MongoCollection;
import org.bson.Document;

import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final MongoTemplate mongoTemplate;

  public MyBean(MongoTemplate mongoTemplate) {

  this.mongoTemplate = mongoTemplate;
  }

  public MongoCollection<Document> someMethod() {

  return this.mongoTemplate.getCollection("users");
  }

See the MongoOperations Javadoc for complete details.

Spring Data MongoDB Repositories

Spring Data includes repository support for MongoDB. As with the JPA repositories discussed
earlier, the basic principle is that queries are constructed automatically, based on method names.

In fact, both Spring Data JPA and Spring Data MongoDB share the same common infrastructure. You
could take the JPA example from earlier and, assuming that City is now a MongoDB data class
rather than a JPA @Entity, it works in the same way, as shown in the following example:

239
 import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.repository.Repository;

public interface CityRepository extends Repository<City, Long> {

  Page<City> findAll(Pageable pageable);

  City findByNameAndStateAllIgnoringCase(String name, String state);

TIP You can customize document scanning locations by using the @EntityScan annotation.

For complete details of Spring Data MongoDB, including its rich object mapping
TIP
technologies, see its reference documentation.

Embedded Mongo

Spring Boot offers auto-configuration for Embedded Mongo. To use it in your Spring Boot
application, add a dependency on de.flapdoodle.embed:de.flapdoodle.embed.mongo and set the
spring.mongodb.embedded.version property to match the version of MongoDB that your application
will use in production.

The default download configuration allows access to most of the versions listed in
Embedded Mongo’s Version class as well as some others. Configuring an
NOTE inaccessible version will result in an error when attempting to download the server.
Such an error can be corrected by defining an appropriately configured
DownloadConfigBuilderCustomizer bean.

The port that Mongo listens on can be configured by setting the spring.data.mongodb.port property.
To use a randomly allocated free port, use a value of 0. The MongoClient created by
MongoAutoConfiguration is automatically configured to use the randomly allocated port.

If you do not configure a custom port, the embedded support uses a random port
NOTE
(rather than 27017) by default.

If you have SLF4J on the classpath, the output produced by Mongo is automatically routed to a
logger named org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongo.

You can declare your own IMongodConfig and IRuntimeConfig beans to take control of the Mongo
instance’s configuration and logging routing. The download configuration can be customized by
declaring a DownloadConfigBuilderCustomizer bean.

9.2.3. Neo4j

Neo4j is an open-source NoSQL graph database that uses a rich data model of nodes connected by

240
first class relationships, which is better suited for connected big data than traditional RDBMS
approaches. Spring Boot offers several conveniences for working with Neo4j, including the spring-
boot-starter-data-neo4j “Starter”.

Connecting to a Neo4j Database

To access a Neo4j server, you can inject an auto-configured org.neo4j.driver.Driver. By default, the
instance tries to connect to a Neo4j server at localhost:7687 using the Bolt protocol. The following
example shows how to inject a Neo4j Driver that gives you access, amongst other things, to a
Session:

import org.neo4j.driver.Driver;
import org.neo4j.driver.Session;
import org.neo4j.driver.Values;

import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final Driver driver;

  public MyBean(Driver driver) {

  this.driver = driver;
  }

  public String someMethod(String message) {

  try (Session session = this.driver.session()) {
  return session.writeTransaction((transaction) -> transaction
  .run("CREATE (a:Greeting) SET a.message = $message RETURN
a.message + ', from node ' + id(a)",
  Values.parameters("message", message))
  .single().get(0).asString());
  }
  }

You can configure various aspects of the driver using spring.neo4j.* properties. The following
example shows how to configure the uri and credentials to use:

Properties

spring.neo4j.uri=bolt://my-server:7687
spring.neo4j.authentication.username=neo4j
spring.neo4j.authentication.password=secret

241
Yaml

spring:
  neo4j:
  uri: "bolt://my-server:7687"
  authentication:
  username: "neo4j"
  password: "secret"

The auto-configured Driver is created using ConfigBuilder. To fine-tune its configuration, declare
one or more ConfigBuilderCustomizer beans. Each will be called in order with the ConfigBuilder that
is used to build the Driver.

Spring Data Neo4j Repositories

Spring Data includes repository support for Neo4j. For complete details of Spring Data Neo4j, see
the reference documentation.

Spring Data Neo4j shares the common infrastructure with Spring Data JPA as many other Spring
Data modules do. You could take the JPA example from earlier and define City as Spring Data Neo4j
@Node rather than JPA @Entity and the repository abstraction works in the same way, as shown in
the following example:

import java.util.Optional;

import org.springframework.data.neo4j.repository.Neo4jRepository;

public interface CityRepository extends Neo4jRepository<City, Long> {

  Optional<City> findOneByNameAndState(String name, String state);

The spring-boot-starter-data-neo4j “Starter” enables the repository support as well as transaction

management. Spring Boot supports both classic and reactive Neo4j repositories, using the
Neo4jTemplate or ReactiveNeo4jTemplate beans. When Project Reactor is available on the classpath,
the reactive style is also auto-configured.

You can customize the locations to look for repositories and entities by using
@EnableNeo4jRepositories and @EntityScan respectively on a @Configuration-bean.

242
 In an application using the reactive style, a ReactiveTransactionManager is not auto-
configured. To enable transaction management, the following bean must be defined
in your configuration:

import org.neo4j.driver.Driver;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import
org.springframework.data.neo4j.core.ReactiveDatabaseSelectionProvider;
import
org.springframework.data.neo4j.core.transaction.ReactiveNeo4jTransaction
Manager;
NOTE

@Configuration(proxyBeanMethods = false)
public class MyNeo4jConfiguration {

  @Bean
  public ReactiveNeo4jTransactionManager
reactiveTransactionManager(Driver driver,
  ReactiveDatabaseSelectionProvider databaseNameProvider) {
  return new ReactiveNeo4jTransactionManager(driver,
databaseNameProvider);
  }

9.2.4. Solr

Apache Solr is a search engine. Spring Boot offers basic auto-configuration for the Solr 5 client
library.

Connecting to Solr

You can inject an auto-configured SolrClient instance as you would any other Spring bean. By
default, the instance tries to connect to a server at localhost:8983/solr. The following example
shows how to inject a Solr bean:

243
 import java.io.IOException;

import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.SolrServerException;
import org.apache.solr.client.solrj.response.SolrPingResponse;

import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final SolrClient solr;

  public MyBean(SolrClient solr) {

  this.solr = solr;
  }

  public SolrPingResponse someMethod() throws SolrServerException, IOException {

  return this.solr.ping("users");
  }

If you add your own @Bean of type SolrClient, it replaces the default.

9.2.5. Elasticsearch

Elasticsearch is an open source, distributed, RESTful search and analytics engine. Spring Boot offers
basic auto-configuration for Elasticsearch clients.

Spring Boot supports several clients:

• The official Java "Low Level" and "High Level" REST clients

• The ReactiveElasticsearchClient provided by Spring Data Elasticsearch

Spring Boot provides a dedicated “Starter”, spring-boot-starter-data-elasticsearch.

Connecting to Elasticsearch using REST clients

Elasticsearch ships two different REST clients that you can use to query a cluster: the "Low Level"
client and the "High Level" client. Spring Boot provides support for the "High Level" client, which
ships with org.elasticsearch.client:elasticsearch-rest-high-level-client. Additionally, Spring
Boot provides support for a reactive client, based on Spring Framework’s WebClient, that ships with
org.springframework.data:spring-data-elasticsearch. By default, the clients will target
localhost:9200. You can use spring.elasticsearch.* properties to further tune how the clients are
configured, as shown in the following example:

244
Properties

spring.elasticsearch.uris=https://search.example.com:9200
spring.elasticsearch.socket-timeout=10s
spring.elasticsearch.username=user
spring.elasticsearch.password=secret

Yaml

spring:
  elasticsearch:
  uris: "https://search.example.com:9200"
  socket-timeout: "10s"
  username: "user"
  password: "secret"

Connecting to Elasticsearch using RestHighLevelClient

If you have elasticsearch-rest-high-level-client on the classpath, Spring Boot will auto-configure

and register a RestHighLevelClient bean. In addition to the properties described previously, to fine-
tune the RestHighLevelClient, you can register an arbitrary number of beans that implement
RestClientBuilderCustomizer for more advanced customizations. To take full control over its
registration, define a RestClientBuilder bean.

If your application needs access to a "Low Level" RestClient, you can get it by calling
TIP
client.getLowLevelClient() on the auto-configured RestHighLevelClient.

Additionally, if elasticsearch-rest-client-sniffer is on the classpath, a Sniffer is auto-configured

to automatically discover nodes from a running Elasticsearch cluster and set them on the
RestHighLevelClient bean. You can further tune how Sniffer is configured, as shown in the
following example:

Properties

spring.elasticsearch.restclient.sniffer.interval=10m
spring.elasticsearch.restclient.sniffer.delay-after-failure=30s

Yaml

spring:
  elasticsearch:
  restclient:
  sniffer:
  interval: "10m"
  delay-after-failure: "30s"

245
Connecting to Elasticsearch using ReactiveElasticsearchClient

Spring Data Elasticsearch ships ReactiveElasticsearchClient for querying Elasticsearch instances in

a reactive fashion. It is built on top of WebFlux’s WebClient, so both spring-boot-starter-
elasticsearch and spring-boot-starter-webflux dependencies are useful to enable this support.

By default, Spring Boot will auto-configure and register a ReactiveElasticsearchClient. In addition

to the properties described previously, the spring.elasticsearch.webclient.* properties can be used
to configure reactive-specific settings, as shown in the following example:

Properties

spring.elasticsearch.webclient.max-in-memory-size=1MB

Yaml

spring:
  elasticsearch:
  webclient:
  max-in-memory-size: "1MB"

If the spring.elasticsearch. and spring.elasticsearch.webclient. configuration properties are not

enough and you’d like to fully control the client configuration, you can register a custom
ClientConfiguration bean.

Connecting to Elasticsearch by Using Spring Data

To connect to Elasticsearch, a RestHighLevelClient bean must be defined, auto-configured by Spring

Boot or manually provided by the application (see previous sections). With this configuration in
place, an ElasticsearchRestTemplate can be injected like any other Spring bean, as shown in the
following example:

246
 import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final ElasticsearchRestTemplate template;

  public MyBean(ElasticsearchRestTemplate template) {

  this.template = template;
  }

  public boolean someMethod(String id) {

  return this.template.exists(id, User.class);
  }

In the presence of spring-data-elasticsearch and the required dependencies for using a WebClient
(typically spring-boot-starter-webflux), Spring Boot can also auto-configure a
ReactiveElasticsearchClient and a ReactiveElasticsearchTemplate as beans. They are the reactive
equivalent of the other REST clients.

Spring Data Elasticsearch Repositories

Spring Data includes repository support for Elasticsearch. As with the JPA repositories discussed
earlier, the basic principle is that queries are constructed for you automatically based on method
names.

In fact, both Spring Data JPA and Spring Data Elasticsearch share the same common infrastructure.
You could take the JPA example from earlier and, assuming that City is now an Elasticsearch
@Document class rather than a JPA @Entity, it works in the same way.

TIP For complete details of Spring Data Elasticsearch, see the reference documentation.

Spring Boot supports both classic and reactive Elasticsearch repositories, using the
ElasticsearchRestTemplate or ReactiveElasticsearchTemplate beans. Most likely those beans are
auto-configured by Spring Boot given the required dependencies are present.

If you wish to use your own template for backing the Elasticsearch repositories, you can add your
own ElasticsearchRestTemplate or ElasticsearchOperations @Bean, as long as it is named
"elasticsearchTemplate". Same applies to ReactiveElasticsearchTemplate and
ReactiveElasticsearchOperations, with the bean name "reactiveElasticsearchTemplate".

You can choose to disable the repositories support with the following property:

247
Properties

spring.data.elasticsearch.repositories.enabled=false

Yaml

spring:
  data:
  elasticsearch:
  repositories:
  enabled: false

9.2.6. Cassandra

Cassandra is an open source, distributed database management system designed to handle large
amounts of data across many commodity servers. Spring Boot offers auto-configuration for
Cassandra and the abstractions on top of it provided by Spring Data Cassandra. There is a spring-
boot-starter-data-cassandra “Starter” for collecting the dependencies in a convenient way.

Connecting to Cassandra

You can inject an auto-configured CassandraTemplate or a Cassandra CqlSession instance as you

would with any other Spring Bean. The spring.data.cassandra.* properties can be used to
customize the connection. Generally, you provide keyspace-name and contact-points as well the local
datacenter name, as shown in the following example:

Properties

spring.data.cassandra.keyspace-name=mykeyspace
spring.data.cassandra.contact-points=cassandrahost1:9042,cassandrahost2:9042
spring.data.cassandra.local-datacenter=datacenter1

Yaml

spring:
  data:
  cassandra:
  keyspace-name: "mykeyspace"
  contact-points: "cassandrahost1:9042,cassandrahost2:9042"
  local-datacenter: "datacenter1"

If the port is the same for all your contact points you can use a shortcut and only specify the host
names, as shown in the following example:

248
Properties

spring.data.cassandra.keyspace-name=mykeyspace
spring.data.cassandra.contact-points=cassandrahost1,cassandrahost2
spring.data.cassandra.local-datacenter=datacenter1

Yaml

spring:
  data:
  cassandra:
  keyspace-name: "mykeyspace"
  contact-points: "cassandrahost1,cassandrahost2"
  local-datacenter: "datacenter1"

Those two examples are identical as the port default to 9042. If you need to configure
TIP
the port, use spring.data.cassandra.port.

The Cassandra driver has its own configuration infrastructure that loads an
application.conf at the root of the classpath.

Spring Boot does not look for such a file by default but can load one using
spring.data.cassandra.config. If a property is both present in
NOTE spring.data.cassandra.* and the configuration file, the value in
spring.data.cassandra.* takes precedence.

For more advanced driver customizations, you can register an arbitrary number of
beans that implement DriverConfigLoaderBuilderCustomizer. The CqlSession can be
customized with a bean of type CqlSessionBuilderCustomizer.

If you use CqlSessionBuilder to create multiple CqlSession beans, keep in mind the
NOTE
builder is mutable so make sure to inject a fresh copy for each session.

The following code listing shows how to inject a Cassandra bean:

249
 import org.springframework.data.cassandra.core.CassandraTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final CassandraTemplate template;

  public MyBean(CassandraTemplate template) {

  this.template = template;
  }

  public long someMethod() {

  return this.template.count(User.class);
  }

If you add your own @Bean of type CassandraTemplate, it replaces the default.

Spring Data Cassandra Repositories

Spring Data includes basic repository support for Cassandra. Currently, this is more limited than
the JPA repositories discussed earlier and needs to annotate finder methods with @Query.

TIP For complete details of Spring Data Cassandra, see the reference documentation.

9.2.7. Couchbase

Couchbase is an open-source, distributed, multi-model NoSQL document-oriented database that is

optimized for interactive applications. Spring Boot offers auto-configuration for Couchbase and the
abstractions on top of it provided by Spring Data Couchbase. There are spring-boot-starter-data-
couchbase and spring-boot-starter-data-couchbase-reactive “Starters” for collecting the
dependencies in a convenient way.

Connecting to Couchbase

You can get a Cluster by adding the Couchbase SDK and some configuration. The spring.couchbase.*
properties can be used to customize the connection. Generally, you provide the connection string,
username, and password, as shown in the following example:

Properties

spring.couchbase.connection-string=couchbase://192.168.1.123
spring.couchbase.username=user
spring.couchbase.password=secret

250
Yaml

spring:
  couchbase:
  connection-string: "couchbase://192.168.1.123"
  username: "user"
  password: "secret"

It is also possible to customize some of the ClusterEnvironment settings. For instance, the following
configuration changes the timeout to use to open a new Bucket and enables SSL support:

Properties

spring.couchbase.env.timeouts.connect=3s
spring.couchbase.env.ssl.key-store=/location/of/keystore.jks
spring.couchbase.env.ssl.key-store-password=secret

Yaml

spring:
  couchbase:
  env:
  timeouts:
  connect: "3s"
  ssl:
  key-store: "/location/of/keystore.jks"
  key-store-password: "secret"

Check the spring.couchbase.env.* properties for more details. To take more control,
TIP
one or more ClusterEnvironmentBuilderCustomizer beans can be used.

Spring Data Couchbase Repositories

Spring Data includes repository support for Couchbase. For complete details of Spring Data
Couchbase, see the reference documentation.

You can inject an auto-configured CouchbaseTemplate instance as you would with any other Spring
Bean, provided a CouchbaseClientFactory bean is available. This happens when a Cluster is
available, as described above, and a bucket name has been specified:

Properties

spring.data.couchbase.bucket-name=my-bucket

251
Yaml

spring:
  data:
  couchbase:
  bucket-name: "my-bucket"

The following examples shows how to inject a CouchbaseTemplate bean:

import org.springframework.data.couchbase.core.CouchbaseTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final CouchbaseTemplate template;

  public MyBean(CouchbaseTemplate template) {

  this.template = template;
  }

  public String someMethod() {

  return this.template.getBucketName();
  }

There are a few beans that you can define in your own configuration to override those provided by
the auto-configuration:

• A CouchbaseMappingContext @Bean with a name of couchbaseMappingContext.

• A CustomConversions @Bean with a name of couchbaseCustomConversions.

• A CouchbaseTemplate @Bean with a name of couchbaseTemplate.

To avoid hard-coding those names in your own config, you can reuse BeanNames provided by Spring
Data Couchbase. For instance, you can customize the converters to use, as follows:

252
 import org.assertj.core.util.Arrays;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.couchbase.config.BeanNames;
import org.springframework.data.couchbase.core.convert.CouchbaseCustomConversions;

@Configuration(proxyBeanMethods = false)
public class MyCouchbaseConfiguration {

  @Bean(BeanNames.COUCHBASE_CUSTOM_CONVERSIONS)
  public CouchbaseCustomConversions myCustomConversions() {
  return new CouchbaseCustomConversions(Arrays.asList(new MyConverter()));
  }

9.2.8. LDAP

LDAP (Lightweight Directory Access Protocol) is an open, vendor-neutral, industry standard

application protocol for accessing and maintaining distributed directory information services over
an IP network. Spring Boot offers auto-configuration for any compliant LDAP server as well as
support for the embedded in-memory LDAP server from UnboundID.

LDAP abstractions are provided by Spring Data LDAP. There is a spring-boot-starter-data-ldap

“Starter” for collecting the dependencies in a convenient way.

Connecting to an LDAP Server

To connect to an LDAP server, make sure you declare a dependency on the spring-boot-starter-
data-ldap “Starter” or spring-ldap-core and then declare the URLs of your server in your
application.properties, as shown in the following example:

Properties

spring.ldap.urls=ldap://myserver:1235
spring.ldap.username=admin
spring.ldap.password=secret

Yaml

spring:
  ldap:
  urls: "ldap://myserver:1235"
  username: "admin"
  password: "secret"

If you need to customize connection settings, you can use the spring.ldap.base and

253
spring.ldap.base-environment properties.

An LdapContextSource is auto-configured based on these settings. If a

DirContextAuthenticationStrategy bean is available, it is associated to the auto-configured
LdapContextSource. If you need to customize it, for instance to use a PooledContextSource, you can
still inject the auto-configured LdapContextSource. Make sure to flag your customized ContextSource
as @Primary so that the auto-configured LdapTemplate uses it.

Spring Data LDAP Repositories

Spring Data includes repository support for LDAP. For complete details of Spring Data LDAP, see the
reference documentation.

You can also inject an auto-configured LdapTemplate instance as you would with any other Spring
Bean, as shown in the following example:

import java.util.List;

import org.springframework.ldap.core.LdapTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final LdapTemplate template;

  public MyBean(LdapTemplate template) {

  this.template = template;
  }

  public List<User> someMethod() {

  return this.template.findAll(User.class);
  }

Embedded In-memory LDAP Server

For testing purposes, Spring Boot supports auto-configuration of an in-memory LDAP server from
UnboundID. To configure the server, add a dependency to com.unboundid:unboundid-ldapsdk and
declare a spring.ldap.embedded.base-dn property, as follows:

Properties

spring.ldap.embedded.base-dn=dc=spring,dc=io

254
Yaml

spring:
  ldap:
  embedded:
  base-dn: "dc=spring,dc=io"

It is possible to define multiple base-dn values, however, since distinguished names

usually contain commas, they must be defined using the correct notation.

In yaml files, you can use the yaml list notation. In properties files, you must
include the index as part of the property name:

Properties

NOTE spring.ldap.embedded.base-dn[0]=dc=spring,dc=io
spring.ldap.embedded.base-dn[1]=dc=pivotal,dc=io

Yaml

spring.ldap.embedded.base-dn:
  - "dc=spring,dc=io"
  - "dc=pivotal,dc=io"

By default, the server starts on a random port and triggers the regular LDAP support. There is no
need to specify a spring.ldap.urls property.

If there is a schema.ldif file on your classpath, it is used to initialize the server. If you want to load
the initialization script from a different resource, you can also use the spring.ldap.embedded.ldif
property.

By default, a standard schema is used to validate LDIF files. You can turn off validation altogether by
setting the spring.ldap.embedded.validation.enabled property. If you have custom attributes, you
can use spring.ldap.embedded.validation.schema to define your custom attribute types or object
classes.

9.2.9. InfluxDB

InfluxDB is an open-source time series database optimized for fast, high-availability storage and
retrieval of time series data in fields such as operations monitoring, application metrics, Internet-
of-Things sensor data, and real-time analytics.

Connecting to InfluxDB

Spring Boot auto-configures an InfluxDB instance, provided the influxdb-java client is on the
classpath and the URL of the database is set, as shown in the following example:

255
Properties

spring.influx.url=https://172.0.0.1:8086

Yaml

spring:
  influx:
  url: "https://172.0.0.1:8086"

If the connection to InfluxDB requires a user and password, you can set the spring.influx.user and
spring.influx.password properties accordingly.

InfluxDB relies on OkHttp. If you need to tune the http client InfluxDB uses behind the scenes, you
can register an InfluxDbOkHttpClientBuilderProvider bean.

If you need more control over the configuration, consider registering an InfluxDbCustomizer bean.

9.3. What to Read Next

You should now have a feeling for how to use Spring Boot with various data technologies. From
here, you can read about Spring Boot’s support for various messaging technologies and how to
enable them in your application.

256
Chapter 10. Messaging
The Spring Framework provides extensive support for integrating with messaging systems, from
simplified use of the JMS API using JmsTemplate to a complete infrastructure to receive messages
asynchronously. Spring AMQP provides a similar feature set for the Advanced Message Queuing
Protocol. Spring Boot also provides auto-configuration options for RabbitTemplate and RabbitMQ.
Spring WebSocket natively includes support for STOMP messaging, and Spring Boot has support for
that through starters and a small amount of auto-configuration. Spring Boot also has support for
Apache Kafka.

10.1. JMS
The javax.jms.ConnectionFactory interface provides a standard method of creating a
javax.jms.Connection for interacting with a JMS broker. Although Spring needs a ConnectionFactory
to work with JMS, you generally need not use it directly yourself and can instead rely on higher
level messaging abstractions. (See the relevant section of the Spring Framework reference
documentation for details.) Spring Boot also auto-configures the necessary infrastructure to send
and receive messages.

10.1.1. ActiveMQ Artemis Support

Spring Boot can auto-configure a ConnectionFactory when it detects that ActiveMQ Artemis is
available on the classpath. If the broker is present, an embedded broker is automatically started
and configured (unless the mode property has been explicitly set). The supported modes are
embedded (to make explicit that an embedded broker is required and that an error should occur if
the broker is not available on the classpath) and native (to connect to a broker using the netty
transport protocol). When the latter is configured, Spring Boot configures a ConnectionFactory that
connects to a broker running on the local machine with the default settings.

If you use spring-boot-starter-artemis, the necessary dependencies to connect to an

existing ActiveMQ Artemis instance are provided, as well as the Spring
NOTE
infrastructure to integrate with JMS. Adding org.apache.activemq:artemis-jms-
server to your application lets you use embedded mode.

ActiveMQ Artemis configuration is controlled by external configuration properties in

spring.artemis.*. For example, you might declare the following section in application.properties:

Properties

spring.artemis.mode=native
spring.artemis.broker-url=tcp://192.168.1.210:9876
spring.artemis.user=admin
spring.artemis.password=secret

257
Yaml

spring:
  artemis:
  mode: native
  broker-url: "tcp://192.168.1.210:9876"
  user: "admin"
  password: "secret"

When embedding the broker, you can choose if you want to enable persistence and list the
destinations that should be made available. These can be specified as a comma-separated list to
create them with the default options, or you can define bean(s) of type
org.apache.activemq.artemis.jms.server.config.JMSQueueConfiguration or
org.apache.activemq.artemis.jms.server.config.TopicConfiguration, for advanced queue and topic
configurations, respectively.

By default, a CachingConnectionFactory wraps the native ConnectionFactory with sensible settings

that you can control by external configuration properties in spring.jms.*:

Properties

spring.jms.cache.session-cache-size=5

Yaml

spring:
  jms:
  cache:
  session-cache-size: 5

No JNDI lookup is involved, and destinations are resolved against their names, using either the name
attribute in the Artemis configuration or the names provided through configuration.

10.1.2. Using a JNDI ConnectionFactory

If you are running your application in an application server, Spring Boot tries to locate a JMS
ConnectionFactory by using JNDI. By default, the java:/JmsXA and java:/XAConnectionFactory location
are checked. You can use the spring.jms.jndi-name property if you need to specify an alternative
location, as shown in the following example:

Properties

spring.jms.jndi-name=java:/MyConnectionFactory

258
Yaml

spring:
  jms:
  jndi-name: "java:/MyConnectionFactory"

10.1.3. Sending a Message

Spring’s JmsTemplate is auto-configured, and you can autowire it directly into your own beans, as
shown in the following example:

import org.springframework.jms.core.JmsTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final JmsTemplate jmsTemplate;

  public MyBean(JmsTemplate jmsTemplate) {

  this.jmsTemplate = jmsTemplate;
  }

  public void someMethod() {

  this.jmsTemplate.convertAndSend("hello");
  }

JmsMessagingTemplate can be injected in a similar manner. If a DestinationResolver

NOTE or a MessageConverter bean is defined, it is associated automatically to the auto-
configured JmsTemplate.

10.1.4. Receiving a Message

When the JMS infrastructure is present, any bean can be annotated with @JmsListener to create a
listener endpoint. If no JmsListenerContainerFactory has been defined, a default one is configured
automatically. If a DestinationResolver, a MessageConverter, or a javax.jms.ExceptionListener beans
are defined, they are associated automatically with the default factory.

By default, the default factory is transactional. If you run in an infrastructure where a

JtaTransactionManager is present, it is associated to the listener container by default. If not, the
sessionTransacted flag is enabled. In that latter scenario, you can associate your local data store
transaction to the processing of an incoming message by adding @Transactional on your listener
method (or a delegate thereof). This ensures that the incoming message is acknowledged, once the
local transaction has completed. This also includes sending response messages that have been
performed on the same JMS session.

259
The following component creates a listener endpoint on the someQueue destination:

import org.springframework.jms.annotation.JmsListener;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  @JmsListener(destination = "someQueue")
  public void processMessage(String content) {
  // ...
  }

TIP See the Javadoc of @EnableJms for more details.

If you need to create more JmsListenerContainerFactory instances or if you want to override the
default, Spring Boot provides a DefaultJmsListenerContainerFactoryConfigurer that you can use to
initialize a DefaultJmsListenerContainerFactory with the same settings as the one that is auto-
configured.

For instance, the following example exposes another factory that uses a specific MessageConverter:

260
 import jakarta.jms.ConnectionFactory;

import
org.springframework.boot.autoconfigure.jms.DefaultJmsListenerContainerFactoryConfigure
r;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jms.config.DefaultJmsListenerContainerFactory;

@Configuration(proxyBeanMethods = false)
public class MyJmsConfiguration {

  @Bean
  public DefaultJmsListenerContainerFactory
myFactory(DefaultJmsListenerContainerFactoryConfigurer configurer) {
  DefaultJmsListenerContainerFactory factory = new
DefaultJmsListenerContainerFactory();
  ConnectionFactory connectionFactory = getCustomConnectionFactory();
  configurer.configure(factory, connectionFactory);
  factory.setMessageConverter(new MyMessageConverter());
  return factory;
  }

  private ConnectionFactory getCustomConnectionFactory() {

  return ...
  }

Then you can use the factory in any @JmsListener-annotated method as follows:

import org.springframework.jms.annotation.JmsListener;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  @JmsListener(destination = "someQueue", containerFactory = "myFactory")

  public void processMessage(String content) {
  // ...
  }

10.2. AMQP
The Advanced Message Queuing Protocol (AMQP) is a platform-neutral, wire-level protocol for
message-oriented middleware. The Spring AMQP project applies core Spring concepts to the

261
development of AMQP-based messaging solutions. Spring Boot offers several conveniences for
working with AMQP through RabbitMQ, including the spring-boot-starter-amqp “Starter”.

10.2.1. RabbitMQ support

RabbitMQ is a lightweight, reliable, scalable, and portable message broker based on the AMQP
protocol. Spring uses RabbitMQ to communicate through the AMQP protocol.

RabbitMQ configuration is controlled by external configuration properties in spring.rabbitmq.*. For

example, you might declare the following section in application.properties:

Properties

spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=admin
spring.rabbitmq.password=secret

Yaml

spring:
  rabbitmq:
  host: "localhost"
  port: 5672
  username: "admin"
  password: "secret"

Alternatively, you could configure the same connection using the addresses attribute:

Properties

spring.rabbitmq.addresses=amqp://admin:secret@localhost

Yaml

spring:
  rabbitmq:
  addresses: "amqp://admin:secret@localhost"

When specifying addresses that way, the host and port properties are ignored. If the
NOTE
address uses the amqps protocol, SSL support is enabled automatically.

See RabbitProperties for more of the supported property-based configuration options. To configure
lower-level details of the RabbitMQ ConnectionFactory that is used by Spring AMQP, define a
ConnectionFactoryCustomizer bean.

If a ConnectionNameStrategy bean exists in the context, it will be automatically used to name

connections created by the auto-configured CachingConnectionFactory.

262
 TIP See Understanding AMQP, the protocol used by RabbitMQ for more details.

10.2.2. Sending a Message

Spring’s AmqpTemplate and AmqpAdmin are auto-configured, and you can autowire them directly into
your own beans, as shown in the following example:

import org.springframework.amqp.core.AmqpAdmin;
import org.springframework.amqp.core.AmqpTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final AmqpAdmin amqpAdmin;

  private final AmqpTemplate amqpTemplate;

  public MyBean(AmqpAdmin amqpAdmin, AmqpTemplate amqpTemplate) {

  this.amqpAdmin = amqpAdmin;
  this.amqpTemplate = amqpTemplate;
  }

  public void someMethod() {

  this.amqpAdmin.getQueueInfo("someQueue");
  }

  public void someOtherMethod() {

  this.amqpTemplate.convertAndSend("hello");
  }

RabbitMessagingTemplate can be injected in a similar manner. If a MessageConverter

NOTE
bean is defined, it is associated automatically to the auto-configured AmqpTemplate.

If necessary, any org.springframework.amqp.core.Queue that is defined as a bean is automatically

used to declare a corresponding queue on the RabbitMQ instance.

To retry operations, you can enable retries on the AmqpTemplate (for example, in the event that the
broker connection is lost):

Properties

spring.rabbitmq.template.retry.enabled=true
spring.rabbitmq.template.retry.initial-interval=2s

263
Yaml

spring:
  rabbitmq:
  template:
  retry:
  enabled: true
  initial-interval: "2s"

Retries are disabled by default. You can also customize the RetryTemplate programmatically by
declaring a RabbitRetryTemplateCustomizer bean.

If you need to create more RabbitTemplate instances or if you want to override the default, Spring
Boot provides a RabbitTemplateConfigurer bean that you can use to initialize a RabbitTemplate with
the same settings as the factories used by the auto-configuration.

10.2.3. Sending a Message To A Stream

To send a message to a particular stream, specify the name of the stream, as shown in the following
example:

Properties

spring.rabbitmq.stream.name=my-stream

Yaml

spring:
  rabbitmq:
  stream:
  name: "my-stream"

If a MessageConverter, StreamMessageConverter, or ProducerCustomizer bean is defined, it is associated

automatically to the auto-configured RabbitStreamTemplate.

If you need to create more RabbitStreamTemplate instances or if you want to override the default,
Spring Boot provides a RabbitStreamTemplateConfigurer bean that you can use to initialize a
RabbitStreamTemplate with the same settings as the factories used by the auto-configuration.

10.2.4. Receiving a Message

When the Rabbit infrastructure is present, any bean can be annotated with @RabbitListener to
create a listener endpoint. If no RabbitListenerContainerFactory has been defined, a default
SimpleRabbitListenerContainerFactory is automatically configured and you can switch to a direct
container using the spring.rabbitmq.listener.type property. If a MessageConverter or a
MessageRecoverer bean is defined, it is automatically associated with the default factory.

The following sample component creates a listener endpoint on the someQueue queue:

264
 import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  @RabbitListener(queues = "someQueue")
  public void processMessage(String content) {
  // ...
  }

TIP See the Javadoc of @EnableRabbit for more details.

If you need to create more RabbitListenerContainerFactory instances or if you want to override the
default, Spring Boot provides a SimpleRabbitListenerContainerFactoryConfigurer and a
DirectRabbitListenerContainerFactoryConfigurer that you can use to initialize a
SimpleRabbitListenerContainerFactory and a DirectRabbitListenerContainerFactory with the same
settings as the factories used by the auto-configuration.

It does not matter which container type you chose. Those two beans are exposed by
TIP
the auto-configuration.

For instance, the following configuration class exposes another factory that uses a specific
MessageConverter:

265
 import org.springframework.amqp.rabbit.config.SimpleRabbitListenerContainerFactory;
import org.springframework.amqp.rabbit.connection.ConnectionFactory;
import
org.springframework.boot.autoconfigure.amqp.SimpleRabbitListenerContainerFactoryConfig
urer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyRabbitConfiguration {

  @Bean
  public SimpleRabbitListenerContainerFactory
myFactory(SimpleRabbitListenerContainerFactoryConfigurer configurer) {
  SimpleRabbitListenerContainerFactory factory = new
SimpleRabbitListenerContainerFactory();
  ConnectionFactory connectionFactory = getCustomConnectionFactory();
  configurer.configure(factory, connectionFactory);
  factory.setMessageConverter(new MyMessageConverter());
  return factory;
  }

  private ConnectionFactory getCustomConnectionFactory() {

  return ...
  }

Then you can use the factory in any @RabbitListener-annotated method, as follows:

import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  @RabbitListener(queues = "someQueue", containerFactory = "myFactory")

  public void processMessage(String content) {
  // ...
  }

You can enable retries to handle situations where your listener throws an exception. By default,
RejectAndDontRequeueRecoverer is used, but you can define a MessageRecoverer of your own. When
retries are exhausted, the message is rejected and either dropped or routed to a dead-letter
exchange if the broker is configured to do so. By default, retries are disabled. You can also
customize the RetryTemplate programmatically by declaring a RabbitRetryTemplateCustomizer bean.

266
 By default, if retries are disabled and the listener throws an exception, the
delivery is retried indefinitely. You can modify this behavior in two ways: Set
the defaultRequeueRejected property to false so that zero re-deliveries are
IMPORTANT
attempted or throw an AmqpRejectAndDontRequeueException to signal the
message should be rejected. The latter is the mechanism used when retries
are enabled and the maximum number of delivery attempts is reached.

10.3. Apache Kafka Support

Apache Kafka is supported by providing auto-configuration of the spring-kafka project.

Kafka configuration is controlled by external configuration properties in spring.kafka.*. For

example, you might declare the following section in application.properties:

Properties

spring.kafka.bootstrap-servers=localhost:9092
spring.kafka.consumer.group-id=myGroup

Yaml

spring:
  kafka:
  bootstrap-servers: "localhost:9092"
  consumer:
  group-id: "myGroup"

To create a topic on startup, add a bean of type NewTopic. If the topic already exists, the
TIP
bean is ignored.

See KafkaProperties for more supported options.

10.3.1. Sending a Message

Spring’s KafkaTemplate is auto-configured, and you can autowire it directly in your own beans, as
shown in the following example:

267
 import org.springframework.kafka.core.KafkaTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final KafkaTemplate<String, String> kafkaTemplate;

  public MyBean(KafkaTemplate<String, String> kafkaTemplate) {

  this.kafkaTemplate = kafkaTemplate;
  }

  public void someMethod() {

  this.kafkaTemplate.send("someTopic", "Hello");
  }

If the property spring.kafka.producer.transaction-id-prefix is defined, a

KafkaTransactionManager is automatically configured. Also, if a
NOTE
RecordMessageConverter bean is defined, it is automatically associated to the auto-
configured KafkaTemplate.

10.3.2. Receiving a Message

When the Apache Kafka infrastructure is present, any bean can be annotated with @KafkaListener
to create a listener endpoint. If no KafkaListenerContainerFactory has been defined, a default one is
automatically configured with keys defined in spring.kafka.listener.*.

The following component creates a listener endpoint on the someTopic topic:

import org.springframework.kafka.annotation.KafkaListener;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

  @KafkaListener(topics = "someTopic")
  public void processMessage(String content) {
  // ...
  }

If a KafkaTransactionManager bean is defined, it is automatically associated to the container factory.

Similarly, if a RecordFilterStrategy, ErrorHandler, CommonErrorHandler, AfterRollbackProcessor or
ConsumerAwareRebalanceListener bean is defined, it is automatically associated to the default factory.

268
Depending on the listener type, a RecordMessageConverter or BatchMessageConverter bean is
associated to the default factory. If only a RecordMessageConverter bean is present for a batch
listener, it is wrapped in a BatchMessageConverter.

A custom ChainedKafkaTransactionManager must be marked @Primary as it usually

TIP
references the auto-configured KafkaTransactionManager bean.

10.3.3. Kafka Streams

Spring for Apache Kafka provides a factory bean to create a StreamsBuilder object and manage the
lifecycle of its streams. Spring Boot auto-configures the required KafkaStreamsConfiguration bean as
long as kafka-streams is on the classpath and Kafka Streams is enabled by the @EnableKafkaStreams
annotation.

Enabling Kafka Streams means that the application id and bootstrap servers must be set. The
former can be configured using spring.kafka.streams.application-id, defaulting to
spring.application.name if not set. The latter can be set globally or specifically overridden only for
streams.

Several additional properties are available using dedicated properties; other arbitrary Kafka
properties can be set using the spring.kafka.streams.properties namespace. See also Additional
Kafka Properties for more information.

To use the factory bean, wire StreamsBuilder into your @Bean as shown in the following example:

269
 import org.apache.kafka.common.serialization.Serdes;
import org.apache.kafka.streams.KeyValue;
import org.apache.kafka.streams.StreamsBuilder;
import org.apache.kafka.streams.kstream.KStream;
import org.apache.kafka.streams.kstream.Produced;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.kafka.annotation.EnableKafkaStreams;
import org.springframework.kafka.support.serializer.JsonSerde;

@Configuration(proxyBeanMethods = false)
@EnableKafkaStreams
public class MyKafkaStreamsConfiguration {

  @Bean
  public KStream<Integer, String> kStream(StreamsBuilder streamsBuilder) {
  KStream<Integer, String> stream = streamsBuilder.stream("ks1In");
  stream.map(this::uppercaseValue).to("ks1Out", Produced.with(Serdes.Integer(),
new JsonSerde<>()));
  return stream;
  }

  private KeyValue<Integer, String> uppercaseValue(Integer key, String value) {

  return new KeyValue<>(key, value.toUpperCase());
  }

By default, the streams managed by the StreamBuilder object it creates are started automatically.
You can customize this behavior using the spring.kafka.streams.auto-startup property.

10.3.4. Additional Kafka Properties

The properties supported by auto configuration are shown in Common Application Properties. Note
that, for the most part, these properties (hyphenated or camelCase) map directly to the Apache
Kafka dotted properties. See the Apache Kafka documentation for details.

The first few of these properties apply to all components (producers, consumers, admins, and
streams) but can be specified at the component level if you wish to use different values. Apache
Kafka designates properties with an importance of HIGH, MEDIUM, or LOW. Spring Boot auto-
configuration supports all HIGH importance properties, some selected MEDIUM and LOW
properties, and any properties that do not have a default value.

Only a subset of the properties supported by Kafka are available directly through the
KafkaProperties class. If you wish to configure the producer or consumer with additional properties
that are not directly supported, use the following properties:

270
Properties

spring.kafka.properties[prop.one]=first
spring.kafka.admin.properties[prop.two]=second
spring.kafka.consumer.properties[prop.three]=third
spring.kafka.producer.properties[prop.four]=fourth
spring.kafka.streams.properties[prop.five]=fifth

Yaml

spring:
  kafka:
  properties:
  "[prop.one]": "first"
  admin:
  properties:
  "[prop.two]": "second"
  consumer:
  properties:
  "[prop.three]": "third"
  producer:
  properties:
  "[prop.four]": "fourth"
  streams:
  properties:
  "[prop.five]": "fifth"

This sets the common prop.one Kafka property to first (applies to producers, consumers and
admins), the prop.two admin property to second, the prop.three consumer property to third, the
prop.four producer property to fourth and the prop.five streams property to fifth.

You can also configure the Spring Kafka JsonDeserializer as follows:

Properties

spring.kafka.consumer.value-
deserializer=org.springframework.kafka.support.serializer.JsonDeserializer
spring.kafka.consumer.properties[spring.json.value.default.type]=com.example.Invoice
spring.kafka.consumer.properties[spring.json.trusted.packages]=com.example.main,com.ex
ample.another

271
Yaml

spring:
  kafka:
  consumer:
  value-deserializer:
"org.springframework.kafka.support.serializer.JsonDeserializer"
  properties:
  "[spring.json.value.default.type]": "com.example.Invoice"
  "[spring.json.trusted.packages]": "com.example.main,com.example.another"

Similarly, you can disable the JsonSerializer default behavior of sending type information in
headers:

Properties

spring.kafka.producer.value-
serializer=org.springframework.kafka.support.serializer.JsonSerializer
spring.kafka.producer.properties[spring.json.add.type.headers]=false

Yaml

spring:
  kafka:
  producer:
  value-serializer: "org.springframework.kafka.support.serializer.JsonSerializer"
  properties:
  "[spring.json.add.type.headers]": false

Properties set in this way override any configuration item that Spring Boot
IMPORTANT
explicitly supports.

10.3.5. Testing with Embedded Kafka

Spring for Apache Kafka provides a convenient way to test projects with an embedded Apache
Kafka broker. To use this feature, annotate a test class with @EmbeddedKafka from the spring-kafka-
test module. For more information, please see the Spring for Apache Kafka reference manual.

To make Spring Boot auto-configuration work with the aforementioned embedded Apache Kafka
broker, you need to remap a system property for embedded broker addresses (populated by the
EmbeddedKafkaBroker) into the Spring Boot configuration property for Apache Kafka. There are
several ways to do that:

• Provide a system property to map embedded broker addresses into spring.kafka.bootstrap-

servers in the test class:

272
 static {
  System.setProperty(EmbeddedKafkaBroker.BROKER_LIST_PROPERTY,
"spring.kafka.bootstrap-servers");
}

• Configure a property name on the @EmbeddedKafka annotation:

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.kafka.test.context.EmbeddedKafka;

@SpringBootTest
@EmbeddedKafka(topics = "someTopic", bootstrapServersProperty =
"spring.kafka.bootstrap-servers")
class MyTest {

  // ...

• Use a placeholder in configuration properties:

Properties

spring.kafka.bootstrap-servers=${spring.embedded.kafka.brokers}

Yaml

spring:
  kafka:
  bootstrap-servers: "${spring.embedded.kafka.brokers}"

10.4. RSocket
RSocket is a binary protocol for use on byte stream transports. It enables symmetric interaction
models through async message passing over a single connection.

The spring-messaging module of the Spring Framework provides support for RSocket requesters
and responders, both on the client and on the server side. See the RSocket section of the Spring
Framework reference for more details, including an overview of the RSocket protocol.

10.4.1. RSocket Strategies Auto-configuration

Spring Boot auto-configures an RSocketStrategies bean that provides all the required infrastructure
for encoding and decoding RSocket payloads. By default, the auto-configuration will try to configure
the following (in order):

273
1. CBOR codecs with Jackson

2. JSON codecs with Jackson

The spring-boot-starter-rsocket starter provides both dependencies. See the Jackson support
section to know more about customization possibilities.

Developers can customize the RSocketStrategies component by creating beans that implement the
RSocketStrategiesCustomizer interface. Note that their @Order is important, as it determines the
order of codecs.

10.4.2. RSocket server Auto-configuration

Spring Boot provides RSocket server auto-configuration. The required dependencies are provided
by the spring-boot-starter-rsocket.

Spring Boot allows exposing RSocket over WebSocket from a WebFlux server, or standing up an
independent RSocket server. This depends on the type of application and its configuration.

For WebFlux application (that is of type WebApplicationType.REACTIVE), the RSocket server will be
plugged into the Web Server only if the following properties match:

Properties

spring.rsocket.server.mapping-path=/rsocket
spring.rsocket.server.transport=websocket

Yaml

spring:
  rsocket:
  server:
  mapping-path: "/rsocket"
  transport: "websocket"

Plugging RSocket into a web server is only supported with Reactor Netty, as
WARNING
RSocket itself is built with that library.

Alternatively, an RSocket TCP or websocket server is started as an independent, embedded server.

Besides the dependency requirements, the only required configuration is to define a port for that
server:

Properties

spring.rsocket.server.port=9898

274
Yaml

spring:
  rsocket:
  server:
  port: 9898

10.4.3. Spring Messaging RSocket support

Spring Boot will auto-configure the Spring Messaging infrastructure for RSocket.

This means that Spring Boot will create a RSocketMessageHandler bean that will handle RSocket
requests to your application.

10.4.4. Calling RSocket Services with RSocketRequester

Once the RSocket channel is established between server and client, any party can send or receive
requests to the other.

As a server, you can get injected with an RSocketRequester instance on any handler method of an
RSocket @Controller. As a client, you need to configure and establish an RSocket connection first.
Spring Boot auto-configures an RSocketRequester.Builder for such cases with the expected codecs
and applies any RSocketConnectorConfigurer bean.

The RSocketRequester.Builder instance is a prototype bean, meaning each injection point will
provide you with a new instance . This is done on purpose since this builder is stateful and you
should not create requesters with different setups using the same instance.

The following code shows a typical example:

275
 import reactor.core.publisher.Mono;

import org.springframework.messaging.rsocket.RSocketRequester;
import org.springframework.stereotype.Service;

@Service
public class MyService {

  private final RSocketRequester rsocketRequester;

  public MyService(RSocketRequester.Builder rsocketRequesterBuilder) {

  this.rsocketRequester = rsocketRequesterBuilder.tcp("example.org", 9898);
  }

  public Mono<User> someRSocketCall(String name) {

  return
this.rsocketRequester.route("user").data(name).retrieveMono(User.class);
  }

10.5. Spring Integration

Spring Boot offers several conveniences for working with Spring Integration, including the spring-
boot-starter-integration “Starter”. Spring Integration provides abstractions over messaging and
also other transports such as HTTP, TCP, and others. If Spring Integration is available on your
classpath, it is initialized through the @EnableIntegration annotation.

Spring Integration polling logic relies on the auto-configured TaskScheduler. The default
PollerMetadata (poll unbounded number of messages every second) can be customized with
spring.integration.poller.* configuration properties.

Spring Boot also configures some features that are triggered by the presence of additional Spring
Integration modules. If spring-integration-jmx is also on the classpath, message processing
statistics are published over JMX. If spring-integration-jdbc is available, the default database
schema can be created on startup, as shown in the following line:

Properties

spring.integration.jdbc.initialize-schema=always

Yaml

spring:
  integration:
  jdbc:
  initialize-schema: "always"

276
If spring-integration-rsocket is available, developers can configure an RSocket server using
"spring.rsocket.server.*" properties and let it use IntegrationRSocketEndpoint or
RSocketOutboundGateway components to handle incoming RSocket messages. This infrastructure can
handle Spring Integration RSocket channel adapters and @MessageMapping handlers (given
"spring.integration.rsocket.server.message-mapping-enabled" is configured).

Spring Boot can also auto-configure an ClientRSocketConnector using configuration properties:

Properties

# Connecting to a RSocket server over TCP

spring.integration.rsocket.client.host=example.org
spring.integration.rsocket.client.port=9898

Yaml

# Connecting to a RSocket server over TCP

spring:
  integration:
  rsocket:
  client:
  host: "example.org"
  port: 9898

Properties

# Connecting to a RSocket Server over WebSocket

spring.integration.rsocket.client.uri=ws://example.org

Yaml

# Connecting to a RSocket Server over WebSocket

spring:
  integration:
  rsocket:
  client:
  uri: "ws://example.org"

See the IntegrationAutoConfiguration and IntegrationProperties classes for more details.

10.6. What to Read Next

The next section describes how to enable IO capabilities in your application. You can read about
caching, mail, validation, rest clients and more in this section.

277
Chapter 11. IO
Most applications will need to deal with input and output concerns at some point. Spring Boot
provides utilities and integrations with a range of technologies to help when you need IO
capabilities. This section covers standard IO features such as caching and validation as well as more
advanced topics such as scheduling and distributed transactions. We will also cover calling remote
REST or SOAP services and sending email.

11.1. Caching
The Spring Framework provides support for transparently adding caching to an application. At its
core, the abstraction applies caching to methods, thus reducing the number of executions based on
the information available in the cache. The caching logic is applied transparently, without any
interference to the invoker. Spring Boot auto-configures the cache infrastructure as long as caching
support is enabled by using the @EnableCaching annotation.

NOTE Check the relevant section of the Spring Framework reference for more details.

In a nutshell, to add caching to an operation of your service add the relevant annotation to its
method, as shown in the following example:

import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Component;

@Component
public class MyMathService {

  @Cacheable("piDecimals")
  public int computePiDecimal(int precision) {
  ...
  }

This example demonstrates the use of caching on a potentially costly operation. Before invoking
computePiDecimal, the abstraction looks for an entry in the piDecimals cache that matches the i
argument. If an entry is found, the content in the cache is immediately returned to the caller, and
the method is not invoked. Otherwise, the method is invoked, and the cache is updated before
returning the value.

You can also use the standard JSR-107 (JCache) annotations (such as
CAUTION @CacheResult) transparently. However, we strongly advise you to not mix and
match the Spring Cache and JCache annotations.

If you do not add any specific cache library, Spring Boot auto-configures a simple provider that uses
concurrent maps in memory. When a cache is required (such as piDecimals in the preceding
example), this provider creates it for you. The simple provider is not really recommended for

278
production usage, but it is great for getting started and making sure that you understand the
features. When you have made up your mind about the cache provider to use, please make sure to
read its documentation to figure out how to configure the caches that your application uses. Nearly
all providers require you to explicitly configure every cache that you use in the application. Some
offer a way to customize the default caches defined by the spring.cache.cache-names property.

TIP It is also possible to transparently update or evict data from the cache.

11.1.1. Supported Cache Providers

The cache abstraction does not provide an actual store and relies on abstraction materialized by the
org.springframework.cache.Cache and org.springframework.cache.CacheManager interfaces.

If you have not defined a bean of type CacheManager or a CacheResolver named cacheResolver (see
CachingConfigurer), Spring Boot tries to detect the following providers (in the indicated order):

1. Generic

2. JCache (JSR-107) (Hazelcast and others)

3. Hazelcast

4. Couchbase

5. Redis

6. Caffeine

7. Simple

It is also possible to force a particular cache provider by setting the spring.cache.type

TIP property. Use this property if you need to disable caching altogether in certain
environments (such as tests).

Use the spring-boot-starter-cache “Starter” to quickly add basic caching

dependencies. The starter brings in spring-context-support. If you add dependencies
TIP
manually, you must include spring-context-support in order to use the JCache or
Caffeine support.

If the CacheManager is auto-configured by Spring Boot, you can further tune its configuration before
it is fully initialized by exposing a bean that implements the CacheManagerCustomizer interface. The
following example sets a flag to say that null values should not be passed down to the underlying
map:

279
 import org.springframework.boot.autoconfigure.cache.CacheManagerCustomizer;
import org.springframework.cache.concurrent.ConcurrentMapCacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyCacheManagerConfiguration {

  @Bean
  public CacheManagerCustomizer<ConcurrentMapCacheManager> cacheManagerCustomizer()
{
  return (cacheManager) -> cacheManager.setAllowNullValues(false);
  }

In the preceding example, an auto-configured ConcurrentMapCacheManager is

expected. If that is not the case (either you provided your own config or a different
NOTE cache provider was auto-configured), the customizer is not invoked at all. You can
have as many customizers as you want, and you can also order them by using
@Order or Ordered.

Generic

Generic caching is used if the context defines at least one org.springframework.cache.Cache bean. A
CacheManager wrapping all beans of that type is created.

JCache (JSR-107)

JCache is bootstrapped through the presence of a javax.cache.spi.CachingProvider on the classpath

(that is, a JSR-107 compliant caching library exists on the classpath), and the JCacheCacheManager is
provided by the spring-boot-starter-cache “Starter”. Various compliant libraries are available, and
Spring Boot provides dependency management for Ehcache 3 and Hazelcast. Any other compliant
library can be added as well.

It might happen that more than one provider is present, in which case the provider must be
explicitly specified. Even if the JSR-107 standard does not enforce a standardized way to define the
location of the configuration file, Spring Boot does its best to accommodate setting a cache with
implementation details, as shown in the following example:

Properties

# Only necessary if more than one provider is present

spring.cache.jcache.provider=com.example.MyCachingProvider
spring.cache.jcache.config=classpath:example.xml

280
Yaml

# Only necessary if more than one provider is present

spring:
  cache:
  jcache:
  provider: "com.example.MyCachingProvider"
  config: "classpath:example.xml"

When a cache library offers both a native implementation and JSR-107 support,
NOTE Spring Boot prefers the JSR-107 support, so that the same features are available if
you switch to a different JSR-107 implementation.

Spring Boot has general support for Hazelcast. If a single HazelcastInstance is

TIP available, it is automatically reused for the CacheManager as well, unless the
spring.cache.jcache.config property is specified.

There are two ways to customize the underlying javax.cache.cacheManager:

• Caches can be created on startup by setting the spring.cache.cache-names property. If a custom

javax.cache.configuration.Configuration bean is defined, it is used to customize them.

• org.springframework.boot.autoconfigure.cache.JCacheManagerCustomizer beans are invoked with

the reference of the CacheManager for full customization.

If a standard javax.cache.CacheManager bean is defined, it is wrapped automatically in

TIP an org.springframework.cache.CacheManager implementation that the abstraction
expects. No further customization is applied to it.

Hazelcast

Spring Boot has general support for Hazelcast. If a HazelcastInstance has been auto-configured, it is
automatically wrapped in a CacheManager.

Couchbase

If Spring Data Couchbase is available and Couchbase is configured, a CouchbaseCacheManager is auto-

configured. It is possible to create additional caches on startup by setting the spring.cache.cache-
names property and cache defaults can be configured by using spring.cache.couchbase.* properties.
For instance, the following configuration creates cache1 and cache2 caches with an entry expiration
of 10 minutes:

Properties

spring.cache.cache-names=cache1,cache2
spring.cache.couchbase.expiration=10m

281
Yaml

spring:
  cache:
  cache-names: "cache1,cache2"
  couchbase:
  expiration: "10m"

If you need more control over the configuration, consider registering a

CouchbaseCacheManagerBuilderCustomizer bean. The following example shows a customizer that
configures a specific entry expiration for cache1 and cache2:

import java.time.Duration;

import
org.springframework.boot.autoconfigure.cache.CouchbaseCacheManagerBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.couchbase.cache.CouchbaseCacheConfiguration;

@Configuration(proxyBeanMethods = false)
public class MyCouchbaseCacheManagerConfiguration {

  @Bean
  public CouchbaseCacheManagerBuilderCustomizer
myCouchbaseCacheManagerBuilderCustomizer() {
  return (builder) -> builder
  .withCacheConfiguration("cache1", CouchbaseCacheConfiguration
  .defaultCacheConfig().entryExpiry(Duration.ofSeconds(10)))
  .withCacheConfiguration("cache2", CouchbaseCacheConfiguration
  .defaultCacheConfig().entryExpiry(Duration.ofMinutes(1)));

  }

Redis

If Redis is available and configured, a RedisCacheManager is auto-configured. It is possible to create

additional caches on startup by setting the spring.cache.cache-names property and cache defaults
can be configured by using spring.cache.redis.* properties. For instance, the following
configuration creates cache1 and cache2 caches with a time to live of 10 minutes:

Properties

spring.cache.cache-names=cache1,cache2
spring.cache.redis.time-to-live=10m

282
Yaml

spring:
  cache:
  cache-names: "cache1,cache2"
  redis:
  time-to-live: "10m"

By default, a key prefix is added so that, if two separate caches use the same key,
NOTE Redis does not have overlapping keys and cannot return invalid values. We strongly
recommend keeping this setting enabled if you create your own RedisCacheManager.

You can take full control of the default configuration by adding a

TIP RedisCacheConfiguration @Bean of your own. This can be useful if you need to customize
the default serialization strategy.

If you need more control over the configuration, consider registering a

RedisCacheManagerBuilderCustomizer bean. The following example shows a customizer that
configures a specific time to live for cache1 and cache2:

import java.time.Duration;

import
org.springframework.boot.autoconfigure.cache.RedisCacheManagerBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;

@Configuration(proxyBeanMethods = false)
public class MyRedisCacheManagerConfiguration {

  @Bean
  public RedisCacheManagerBuilderCustomizer myRedisCacheManagerBuilderCustomizer() {
  return (builder) -> builder
  .withCacheConfiguration("cache1", RedisCacheConfiguration
  .defaultCacheConfig().entryTtl(Duration.ofSeconds(10)))
  .withCacheConfiguration("cache2", RedisCacheConfiguration
  .defaultCacheConfig().entryTtl(Duration.ofMinutes(1)));

  }

Caffeine

Caffeine is a Java 8 rewrite of Guava’s cache that supersedes support for Guava. If Caffeine is
present, a CaffeineCacheManager (provided by the spring-boot-starter-cache “Starter”) is auto-
configured. Caches can be created on startup by setting the spring.cache.cache-names property and

283
can be customized by one of the following (in the indicated order):

1. A cache spec defined by spring.cache.caffeine.spec

2. A com.github.benmanes.caffeine.cache.CaffeineSpec bean is defined

3. A com.github.benmanes.caffeine.cache.Caffeine bean is defined

For instance, the following configuration creates cache1 and cache2 caches with a maximum size of
500 and a time to live of 10 minutes

Properties

spring.cache.cache-names=cache1,cache2
spring.cache.caffeine.spec=maximumSize=500,expireAfterAccess=600s

Yaml

spring:
  cache:
  cache-names: "cache1,cache2"
  caffeine:
  spec: "maximumSize=500,expireAfterAccess=600s"

If a com.github.benmanes.caffeine.cache.CacheLoader bean is defined, it is automatically associated

to the CaffeineCacheManager. Since the CacheLoader is going to be associated with all caches managed
by the cache manager, it must be defined as CacheLoader<Object, Object>. The auto-configuration
ignores any other generic type.

Simple

If none of the other providers can be found, a simple implementation using a ConcurrentHashMap as
the cache store is configured. This is the default if no caching library is present in your application.
By default, caches are created as needed, but you can restrict the list of available caches by setting
the cache-names property. For instance, if you want only cache1 and cache2 caches, set the cache-
names property as follows:

Properties

spring.cache.cache-names=cache1,cache2

Yaml

spring:
  cache:
  cache-names: "cache1,cache2"

If you do so and your application uses a cache not listed, then it fails at runtime when the cache is
needed, but not on startup. This is similar to the way the "real" cache providers behave if you use

284
an undeclared cache.

None

When @EnableCaching is present in your configuration, a suitable cache configuration is expected as

well. If you need to disable caching altogether in certain environments, force the cache type to none
to use a no-op implementation, as shown in the following example:

Properties

spring.cache.type=none

Yaml

spring:
  cache:
  type: "none"

11.2. Hazelcast
If Hazelcast is on the classpath and a suitable configuration is found, Spring Boot auto-configures a
HazelcastInstance that you can inject in your application.

Spring Boot first attempts to create a client by checking the following configuration options:

• The presence of a com.hazelcast.client.config.ClientConfig bean.

• A configuration file defined by the spring.hazelcast.config property.

• The presence of the hazelcast.client.config system property.

• A hazelcast-client.xml in the working directory or at the root of the classpath.

• A hazelcast-client.yaml in the working directory or at the root of the classpath.

If a client can not be created, Spring Boot attempts to configure an embedded server. If you define a
com.hazelcast.config.Config bean, Spring Boot uses that. If your configuration defines an instance
name, Spring Boot tries to locate an existing instance rather than creating a new one.

You could also specify the Hazelcast configuration file to use through configuration, as shown in the
following example:

Properties

spring.hazelcast.config=classpath:config/my-hazelcast.xml

285
Yaml

spring:
  hazelcast:
  config: "classpath:config/my-hazelcast.xml"

Otherwise, Spring Boot tries to find the Hazelcast configuration from the default locations:
hazelcast.xml in the working directory or at the root of the classpath, or a .yaml counterpart in the
same locations. We also check if the hazelcast.config system property is set. See the Hazelcast
documentation for more details.

By default, @SpringAware on Hazelcast components is supported. The ManagementContext

TIP can be overridden by declaring a HazelcastConfigCustomizer bean with an @Order
higher than zero.

Spring Boot also has explicit caching support for Hazelcast. If caching is enabled,
NOTE
the HazelcastInstance is automatically wrapped in a CacheManager implementation.

11.3. Quartz Scheduler

Spring Boot offers several conveniences for working with the Quartz scheduler, including the
spring-boot-starter-quartz “Starter”. If Quartz is available, a Scheduler is auto-configured (through
the SchedulerFactoryBean abstraction).

Beans of the following types are automatically picked up and associated with the Scheduler:

• JobDetail: defines a particular Job. JobDetail instances can be built with the JobBuilder API.

• Calendar.

• Trigger: defines when a particular job is triggered.

By default, an in-memory JobStore is used. However, it is possible to configure a JDBC-based store if

a DataSource bean is available in your application and if the spring.quartz.job-store-type property
is configured accordingly, as shown in the following example:

Properties

spring.quartz.job-store-type=jdbc

Yaml

spring:
  quartz:
  job-store-type: "jdbc"

When the JDBC store is used, the schema can be initialized on startup, as shown in the following
example:

286
Properties

spring.quartz.jdbc.initialize-schema=always

Yaml

spring:
  quartz:
  jdbc:
  initialize-schema: "always"

By default, the database is detected and initialized by using the standard

scripts provided with the Quartz library. These scripts drop existing tables,
WARNING
deleting all triggers on every restart. It is also possible to provide a custom
script by setting the spring.quartz.jdbc.schema property.

To have Quartz use a DataSource other than the application’s main DataSource, declare a DataSource
bean, annotating its @Bean method with @QuartzDataSource. Doing so ensures that the Quartz-specific
DataSource is used by both the SchedulerFactoryBean and for schema initialization. Similarly, to have
Quartz use a TransactionManager other than the application’s main TransactionManager declare a
TransactionManager bean, annotating its @Bean method with @QuartzTransactionManager.

By default, jobs created by configuration will not overwrite already registered jobs that have been
read from a persistent job store. To enable overwriting existing job definitions set the
spring.quartz.overwrite-existing-jobs property.

Quartz Scheduler configuration can be customized using spring.quartz properties and

SchedulerFactoryBeanCustomizer beans, which allow programmatic SchedulerFactoryBean
customization. Advanced Quartz configuration properties can be customized using
spring.quartz.properties.*.

In particular, an Executor bean is not associated with the scheduler as Quartz offers
a way to configure the scheduler through spring.quartz.properties. If you need to
NOTE
customize the task executor, consider implementing
SchedulerFactoryBeanCustomizer.

Jobs can define setters to inject data map properties. Regular beans can also be injected in a similar
manner, as shown in the following example:

287
 import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import org.springframework.scheduling.quartz.QuartzJobBean;

public class MySampleJob extends QuartzJobBean {

  private MyService myService;

  private String name;

  // Inject "MyService" bean

  public void setMyService(MyService myService) {
  this.myService = myService;
  }

  // Inject the "name" job data property

  public void setName(String name) {
  this.name = name;
  }

  @Override
  protected void executeInternal(JobExecutionContext context) throws
JobExecutionException {
  this.myService.someMethod(context.getFireTime(), this.name);
  }

11.4. Sending Email

The Spring Framework provides an abstraction for sending email by using the JavaMailSender
interface, and Spring Boot provides auto-configuration for it as well as a starter module.

See the reference documentation for a detailed explanation of how you can use
TIP
JavaMailSender.

If spring.mail.host and the relevant libraries (as defined by spring-boot-starter-mail) are

available, a default JavaMailSender is created if none exists. The sender can be further customized
by configuration items from the spring.mail namespace. See MailProperties for more details.

In particular, certain default timeout values are infinite, and you may want to change that to avoid
having a thread blocked by an unresponsive mail server, as shown in the following example:

288
Properties

spring.mail.properties[mail.smtp.connectiontimeout]=5000
spring.mail.properties[mail.smtp.timeout]=3000
spring.mail.properties[mail.smtp.writetimeout]=5000

Yaml

spring:
  mail:
  properties:
  "[mail.smtp.connectiontimeout]": 5000
  "[mail.smtp.timeout]": 3000
  "[mail.smtp.writetimeout]": 5000

It is also possible to configure a JavaMailSender with an existing Session from JNDI:

Properties

spring.mail.jndi-name=mail/Session

Yaml

spring:
  mail:
  jndi-name: "mail/Session"

When a jndi-name is set, it takes precedence over all other Session-related settings.

11.5. Validation
The method validation feature supported by Bean Validation 1.1 is automatically enabled as long as
a JSR-303 implementation (such as Hibernate validator) is on the classpath. This lets bean methods
be annotated with javax.validation constraints on their parameters and/or on their return value.
Target classes with such annotated methods need to be annotated with the @Validated annotation at
the type level for their methods to be searched for inline constraint annotations.

For instance, the following service triggers the validation of the first argument, making sure its size
is between 8 and 10:

289
 import jakarta.validation.constraints.Size;

import org.springframework.stereotype.Service;
import org.springframework.validation.annotation.Validated;

@Service
@Validated
public class MyBean {

  public Archive findByCodeAndAuthor(@Size(min = 8, max = 10) String code, Author

author) {
  return ...
  }

The application’s MessageSource is used when resolving {parameters} in constraint messages. This
allows you to use your application’s messages.properties files for Bean Validation messages. Once
the parameters have been resolved, message interpolation is completed using Bean Validation’s
default interpolator.

11.6. Calling REST Services

If your application calls remote REST services, Spring Boot makes that very convenient using a
RestTemplate or a WebClient.

11.6.1. RestTemplate

If you need to call remote REST services from your application, you can use the Spring Framework’s
RestTemplate class. Since RestTemplate instances often need to be customized before being used,
Spring Boot does not provide any single auto-configured RestTemplate bean. It does, however, auto-
configure a RestTemplateBuilder, which can be used to create RestTemplate instances when needed.
The auto-configured RestTemplateBuilder ensures that sensible HttpMessageConverters are applied to
RestTemplate instances.

The following code shows a typical example:

290
 import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;

@Service
public class MyService {

  private final RestTemplate restTemplate;

  public MyService(RestTemplateBuilder restTemplateBuilder) {

  this.restTemplate = restTemplateBuilder.build();
  }

  public Details someRestCall(String name) {

  return this.restTemplate.getForObject("/{name}/details", Details.class, name);
  }

RestTemplateBuilder includes a number of useful methods that can be used to quickly

TIP configure a RestTemplate. For example, to add BASIC auth support, you can use
builder.basicAuthentication("user", "password").build().

RestTemplate Customization

There are three main approaches to RestTemplate customization, depending on how broadly you
want the customizations to apply.

To make the scope of any customizations as narrow as possible, inject the auto-configured
RestTemplateBuilder and then call its methods as required. Each method call returns a new
RestTemplateBuilder instance, so the customizations only affect this use of the builder.

To make an application-wide, additive customization, use a RestTemplateCustomizer bean. All such

beans are automatically registered with the auto-configured RestTemplateBuilder and are applied to
any templates that are built with it.

The following example shows a customizer that configures the use of a proxy for all hosts except
192.168.0.5:

291
 import org.apache.http.HttpException;
import org.apache.http.HttpHost;
import org.apache.http.HttpRequest;
import org.apache.http.client.HttpClient;
import org.apache.http.conn.routing.HttpRoutePlanner;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.conn.DefaultProxyRoutePlanner;
import org.apache.http.protocol.HttpContext;

import org.springframework.boot.web.client.RestTemplateCustomizer;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;

public class MyRestTemplateCustomizer implements RestTemplateCustomizer {

  @Override
  public void customize(RestTemplate restTemplate) {
  HttpRoutePlanner routePlanner = new CustomRoutePlanner(new
HttpHost("proxy.example.com"));
  HttpClient httpClient =
HttpClientBuilder.create().setRoutePlanner(routePlanner).build();
  restTemplate.setRequestFactory(new
HttpComponentsClientHttpRequestFactory(httpClient));
  }

  static class CustomRoutePlanner extends DefaultProxyRoutePlanner {

  CustomRoutePlanner(HttpHost proxy) {
  super(proxy);
  }

  @Override
  public HttpHost determineProxy(HttpHost target, HttpRequest request,
HttpContext context) throws HttpException {
  if (target.getHostName().equals("192.168.0.5")) {
  return null;
  }
  return super.determineProxy(target, request, context);
  }

  }

Finally, you can define your own RestTemplateBuilder bean. Doing so will replace the auto-
configured builder. If you want any RestTemplateCustomizer beans to be applied to your custom
builder, as the auto-configuration would have done, configure it using a
RestTemplateBuilderConfigurer. The following example exposes a RestTemplateBuilder that matches
what Spring Boot’s auto-configuration would have done, except that custom connect and read

292
timeouts are also specified:

import java.time.Duration;

import
org.springframework.boot.autoconfigure.web.client.RestTemplateBuilderConfigurer;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyRestTemplateBuilderConfiguration {

  @Bean
  public RestTemplateBuilder restTemplateBuilder(RestTemplateBuilderConfigurer
configurer) {
  return configurer.configure(new
RestTemplateBuilder()).setConnectTimeout(Duration.ofSeconds(5))
  .setReadTimeout(Duration.ofSeconds(2));
  }

The most extreme (and rarely used) option is to create your own RestTemplateBuilder bean without
using a configurer. In addition to replacing the auto-configured builder, this also prevents any
RestTemplateCustomizer beans from being used.

11.6.2. WebClient

If you have Spring WebFlux on your classpath, you can also choose to use WebClient to call remote
REST services. Compared to RestTemplate, this client has a more functional feel and is fully reactive.
You can learn more about the WebClient in the dedicated section in the Spring Framework docs.

Spring Boot creates and pre-configures a WebClient.Builder for you. It is strongly advised to inject it
in your components and use it to create WebClient instances. Spring Boot is configuring that builder
to share HTTP resources, reflect codecs setup in the same fashion as the server ones (see WebFlux
HTTP codecs auto-configuration), and more.

The following code shows a typical example:

293
 import org.neo4j.cypherdsl.core.Relationship.Details;
import reactor.core.publisher.Mono;

import org.springframework.stereotype.Service;
import org.springframework.web.reactive.function.client.WebClient;

@Service
public class MyService {

  private final WebClient webClient;

  public MyService(WebClient.Builder webClientBuilder) {

  this.webClient = webClientBuilder.baseUrl("https://example.org").build();
  }

  public Mono<Details> someRestCall(String name) {

  return this.webClient.get().uri("/{name}/details",
name).retrieve().bodyToMono(Details.class);
  }

WebClient Runtime

Spring Boot will auto-detect which ClientHttpConnector to use to drive WebClient, depending on the
libraries available on the application classpath. For now, Reactor Netty and Jetty RS client are
supported.

The spring-boot-starter-webflux starter depends on io.projectreactor.netty:reactor-netty by

default, which brings both server and client implementations. If you choose to use Jetty as a
reactive server instead, you should add a dependency on the Jetty Reactive HTTP client library,
org.eclipse.jetty:jetty-reactive-httpclient. Using the same technology for server and client has it
advantages, as it will automatically share HTTP resources between client and server.

Developers can override the resource configuration for Jetty and Reactor Netty by providing a
custom ReactorResourceFactory or JettyResourceFactory bean - this will be applied to both clients
and servers.

If you wish to override that choice for the client, you can define your own ClientHttpConnector bean
and have full control over the client configuration.

You can learn more about the WebClient configuration options in the Spring Framework reference
documentation.

WebClient Customization

There are three main approaches to WebClient customization, depending on how broadly you want
the customizations to apply.

294
To make the scope of any customizations as narrow as possible, inject the auto-configured
WebClient.Builder and then call its methods as required. WebClient.Builder instances are stateful:
Any change on the builder is reflected in all clients subsequently created with it. If you want to
create several clients with the same builder, you can also consider cloning the builder with
WebClient.Builder other = builder.clone();.

To make an application-wide, additive customization to all WebClient.Builder instances, you can

declare WebClientCustomizer beans and change the WebClient.Builder locally at the point of
injection.

Finally, you can fall back to the original API and use WebClient.create(). In that case, no auto-
configuration or WebClientCustomizer is applied.

11.7. Web Services

Spring Boot provides Web Services auto-configuration so that all you must do is define your
Endpoints.

The Spring Web Services features can be easily accessed with the spring-boot-starter-webservices
module.

SimpleWsdl11Definition and SimpleXsdSchema beans can be automatically created for your WSDLs
and XSDs respectively. To do so, configure their location, as shown in the following example:

Properties

spring.webservices.wsdl-locations=classpath:/wsdl

Yaml

spring:
  webservices:
  wsdl-locations: "classpath:/wsdl"

11.7.1. Calling Web Services with WebServiceTemplate

If you need to call remote Web services from your application, you can use the WebServiceTemplate
class. Since WebServiceTemplate instances often need to be customized before being used, Spring
Boot does not provide any single auto-configured WebServiceTemplate bean. It does, however, auto-
configure a WebServiceTemplateBuilder, which can be used to create WebServiceTemplate instances
when needed.

The following code shows a typical example:

295
 import org.springframework.boot.webservices.client.WebServiceTemplateBuilder;
import org.springframework.stereotype.Service;
import org.springframework.ws.client.core.WebServiceTemplate;
import org.springframework.ws.soap.client.core.SoapActionCallback;

@Service
public class MyService {

  private final WebServiceTemplate webServiceTemplate;

  public MyService(WebServiceTemplateBuilder webServiceTemplateBuilder) {

  this.webServiceTemplate = webServiceTemplateBuilder.build();
  }

  public SomeResponse someWsCall(SomeRequest detailsReq) {

  return (SomeResponse)
this.webServiceTemplate.marshalSendAndReceive(detailsReq,
  new SoapActionCallback("https://ws.example.com/action"));
  }

By default, WebServiceTemplateBuilder detects a suitable HTTP-based WebServiceMessageSender using

the available HTTP client libraries on the classpath. You can also customize read and connection
timeouts as follows:

import java.time.Duration;

import org.springframework.boot.webservices.client.HttpWebServiceMessageSenderBuilder;
import org.springframework.boot.webservices.client.WebServiceTemplateBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.ws.client.core.WebServiceTemplate;
import org.springframework.ws.transport.WebServiceMessageSender;

@Configuration(proxyBeanMethods = false)
public class MyWebServiceTemplateConfiguration {

  @Bean
  public WebServiceTemplate webServiceTemplate(WebServiceTemplateBuilder builder) {
  WebServiceMessageSender sender = new HttpWebServiceMessageSenderBuilder()
  .setConnectTimeout(Duration.ofSeconds(5))
  .setReadTimeout(Duration.ofSeconds(2))
  .build();
  return builder.messageSenders(sender).build();
  }

296
11.8. Distributed Transactions with JTA
Spring Boot supports distributed JTA transactions across multiple XA resources by using a
transaction manager retrieved from JNDI.

When a JTA environment is detected, Spring’s JtaTransactionManager is used to manage

transactions. Auto-configured JMS, DataSource, and JPA beans are upgraded to support XA
transactions. You can use standard Spring idioms, such as @Transactional, to participate in a
distributed transaction. If you are within a JTA environment and still want to use local transactions,
you can set the spring.jta.enabled property to false to disable the JTA auto-configuration.

11.8.1. Using a Jakarta EE Managed Transaction Manager

If you package your Spring Boot application as a war or ear file and deploy it to a Jakarta EE
application server, you can use your application server’s built-in transaction manager. Spring Boot
tries to auto-configure a transaction manager by looking at common JNDI locations
(java:comp/UserTransaction, java:comp/TransactionManager, and so on). When using a transaction
service provided by your application server, you generally also want to ensure that all resources
are managed by the server and exposed over JNDI. Spring Boot tries to auto-configure JMS by
looking for a ConnectionFactory at the JNDI path (java:/JmsXA or java:/XAConnectionFactory), and
you can use the spring.datasource.jndi-name property to configure your DataSource.

11.8.2. Mixing XA and Non-XA JMS Connections

When using JTA, the primary JMS ConnectionFactory bean is XA-aware and participates in
distributed transactions. You can inject into your bean without needing to use any @Qualifier:

public MyBean(ConnectionFactory connectionFactory) {

  // ...
}

In some situations, you might want to process certain JMS messages by using a non-XA
ConnectionFactory. For example, your JMS processing logic might take longer than the XA timeout.

If you want to use a non-XA ConnectionFactory, you can the nonXaJmsConnectionFactory bean:

public MyBean(@Qualifier("nonXaJmsConnectionFactory") ConnectionFactory

connectionFactory) {
  // ...
}

For consistency, the jmsConnectionFactory bean is also provided by using the bean alias
xaJmsConnectionFactory:

297
 public MyBean(@Qualifier("xaJmsConnectionFactory") ConnectionFactory
connectionFactory) {
  // ...
}

11.8.3. Supporting an Embedded Transaction Manager

The XAConnectionFactoryWrapper and XADataSourceWrapper interfaces can be used to support

embedded transaction managers. The interfaces are responsible for wrapping XAConnectionFactory
and XADataSource beans and exposing them as regular ConnectionFactory and DataSource beans,
which transparently enroll in the distributed transaction. DataSource and JMS auto-configuration
use JTA variants, provided you have a JtaTransactionManager bean and appropriate XA wrapper
beans registered within your ApplicationContext.

11.9. What to Read Next

You should now have a good understanding of Spring Boot’s core features and the various
technologies that Spring Boot provides support for via auto-configuration.

The next few sections go into detail about deploying applications to cloud platforms. You can read
about building container images in the next section or skip to the production-ready features
section.

298
Chapter 12. Container Images
Spring Boot applications can be containerized using Dockerfiles, or by using Cloud Native
Buildpacks to create optimized docker compatible container images that you can run anywhere.

12.1. Efficient container images

It is easily possible to package a Spring Boot fat jar as a docker image. However, there are various
downsides to copying and running the fat jar as is in the docker image. There’s always a certain
amount of overhead when running a fat jar without unpacking it, and in a containerized
environment this can be noticeable. The other issue is that putting your application’s code and all
its dependencies in one layer in the Docker image is sub-optimal. Since you probably recompile
your code more often than you upgrade the version of Spring Boot you use, it’s often better to
separate things a bit more. If you put jar files in the layer before your application classes, Docker
often only needs to change the very bottom layer and can pick others up from its cache.

12.1.1. Unpacking the fat jar

If you are running your application from a container, you can use an executable jar, but it is also
often an advantage to explode it and run it in a different way. Certain PaaS implementations may
also choose to unpack archives before they run. For example, Cloud Foundry operates this way. One
way to run an unpacked archive is by starting the appropriate launcher, as follows:

$ jar -xf myapp.jar

$ java org.springframework.boot.loader.JarLauncher

This is actually slightly faster on startup (depending on the size of the jar) than running from an
unexploded archive. At runtime you should not expect any differences.

Once you have unpacked the jar file, you can also get an extra boost to startup time by running the
app with its "natural" main method instead of the JarLauncher. For example:

$ jar -xf myapp.jar

$ java -cp BOOT-INF/classes:BOOT-INF/lib/* com.example.MyApplication

Using the JarLauncher over the application’s main method has the added benefit of a
NOTE predictable classpath order. The jar contains a classpath.idx file which is used by
the JarLauncher when constructing the classpath.

12.1.2. Layering Docker Images

To make it easier to create optimized Docker images, Spring Boot supports adding a layer index file
to the jar. It provides a list of layers and the parts of the jar that should be contained within them.
The list of layers in the index is ordered based on the order in which the layers should be added to
the Docker/OCI image. Out-of-the-box, the following layers are supported:

299
 • dependencies (for regular released dependencies)

• spring-boot-loader (for everything under org/springframework/boot/loader)

• snapshot-dependencies (for snapshot dependencies)

• application (for application classes and resources)

The following shows an example of a layers.idx file:

- "dependencies":
  - BOOT-INF/lib/library1.jar
  - BOOT-INF/lib/library2.jar
- "spring-boot-loader":
  - org/springframework/boot/loader/JarLauncher.class
  - org/springframework/boot/loader/jar/JarEntry.class
- "snapshot-dependencies":
  - BOOT-INF/lib/library3-SNAPSHOT.jar
- "application":
  - META-INF/MANIFEST.MF
  - BOOT-INF/classes/a/b/C.class

This layering is designed to separate code based on how likely it is to change between application
builds. Library code is less likely to change between builds, so it is placed in its own layers to allow
tooling to re-use the layers from cache. Application code is more likely to change between builds so
it is isolated in a separate layer.

Spring Boot also supports layering for war files with the help of a layers.idx.

For Maven, see the packaging layered jar or war section for more details on adding a layer index to
the archive. For Gradle, see the packaging layered jar or war section of the Gradle plugin
documentation.

12.2. Dockerfiles
While it is possible to convert a Spring Boot fat jar into a docker image with just a few lines in the
Dockerfile, we will use the layering feature to create an optimized docker image. When you create a
jar containing the layers index file, the spring-boot-jarmode-layertools jar will be added as a
dependency to your jar. With this jar on the classpath, you can launch your application in a special
mode which allows the bootstrap code to run something entirely different from your application,
for example, something that extracts the layers.

The layertools mode can not be used with a fully executable Spring Boot
CAUTION archive that includes a launch script. Disable launch script configuration when
building a jar file that is intended to be used with layertools.

Here’s how you can launch your jar with a layertools jar mode:

300
 $ java -Djarmode=layertools -jar my-app.jar

This will provide the following output:

Usage:
  java -Djarmode=layertools -jar my-app.jar

Available commands:
  list List layers from the jar that can be extracted
  extract Extracts layers from the jar for image creation
  help Help about any command

The extract command can be used to easily split the application into layers to be added to the
dockerfile. Here is an example of a Dockerfile using jarmode.

FROM adoptopenjdk:11-jre-hotspot as builder

WORKDIR application
ARG JAR_FILE=target/*.jar
COPY ${JAR_FILE} application.jar
RUN java -Djarmode=layertools -jar application.jar extract

FROM adoptopenjdk:11-jre-hotspot
WORKDIR application
COPY --from=builder application/dependencies/ ./
COPY --from=builder application/spring-boot-loader/ ./
COPY --from=builder application/snapshot-dependencies/ ./
COPY --from=builder application/application/ ./
ENTRYPOINT ["java", "org.springframework.boot.loader.JarLauncher"]

Assuming the above Dockerfile is in the current directory, your docker image can be built with
docker build ., or optionally specifying the path to your application jar, as shown in the following
example:

$ docker build --build-arg JAR_FILE=path/to/myapp.jar .

This is a multi-stage dockerfile. The builder stage extracts the directories that are needed later. Each
of the COPY commands relates to the layers extracted by the jarmode.

Of course, a Dockerfile can be written without using the jarmode. You can use some combination of
unzip and mv to move things to the right layer but jarmode simplifies that.

12.3. Cloud Native Buildpacks

Dockerfiles are just one way to build docker images. Another way to build docker images is directly
from your Maven or Gradle plugin, using buildpacks. If you’ve ever used an application platform

301
such as Cloud Foundry or Heroku then you’ve probably used a buildpack. Buildpacks are the part of
the platform that takes your application and converts it into something that the platform can
actually run. For example, Cloud Foundry’s Java buildpack will notice that you’re pushing a .jar file
and automatically add a relevant JRE.

With Cloud Native Buildpacks, you can create Docker compatible images that you can run
anywhere. Spring Boot includes buildpack support directly for both Maven and Gradle. This means
you can just type a single command and quickly get a sensible image into your locally running
Docker daemon.

See the individual plugin documentation on how to use buildpacks with Maven and Gradle.

The Paketo Spring Boot buildpack has also been updated to support the layers.idx
NOTE file so any customization that is applied to it will be reflected in the image created
by the buildpack.

In order to achieve reproducible builds and container image caching, Buildpacks

can manipulate the application resources metadata (such as the file "last modified"
information). You should ensure that your application does not rely on that
NOTE
metadata at runtime. Spring Boot can use that information when serving static
resources, but this can be disabled with spring.web.resources.cache.use-last-
modified

12.4. What to Read Next

Once you’ve learned how to build efficient container images, you can read about deploying
applications to a cloud platform, such as Kubernetes.

302
Chapter 13. Production-ready Features
Spring Boot includes a number of additional features to help you monitor and manage your
application when you push it to production. You can choose to manage and monitor your
application by using HTTP endpoints or with JMX. Auditing, health, and metrics gathering can also
be automatically applied to your application.

13.1. Enabling Production-ready Features

The spring-boot-actuator module provides all of Spring Boot’s production-ready features. The
recommended way to enable the features is to add a dependency on the spring-boot-starter-
actuator “Starter”.

Definition of Actuator

An actuator is a manufacturing term that refers to a mechanical device for moving or

controlling something. Actuators can generate a large amount of motion from a small change.

To add the actuator to a Maven-based project, add the following ‘Starter’ dependency:

<dependencies>
  <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
  </dependency>
</dependencies>

For Gradle, use the following declaration:

dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-actuator'
}

13.2. Endpoints
Actuator endpoints let you monitor and interact with your application. Spring Boot includes a
number of built-in endpoints and lets you add your own. For example, the health endpoint provides
basic application health information.

You can enable or disable each individual endpoint and expose them (make them remotely
accessible) over HTTP or JMX. An endpoint is considered to be available when it is both enabled
and exposed. The built-in endpoints are auto-configured only when they are available. Most
applications choose exposure over HTTP, where the ID of the endpoint and a prefix of /actuator is
mapped to a URL. For example, by default, the health endpoint is mapped to /actuator/health.

303
 To learn more about the Actuator’s endpoints and their request and response formats,
TIP
see the separate API documentation (HTML or PDF).

The following technology-agnostic endpoints are available:

ID Description
auditevents Exposes audit events information for the current application.
Requires an AuditEventRepository bean.
beans Displays a complete list of all the Spring beans in your application.
caches Exposes available caches.
conditions Shows the conditions that were evaluated on configuration and auto-
configuration classes and the reasons why they did or did not match.
configprops Displays a collated list of all @ConfigurationProperties.
env Exposes properties from Spring’s ConfigurableEnvironment.
flyway Shows any Flyway database migrations that have been applied.
Requires one or more Flyway beans.
health Shows application health information.
httptrace Displays HTTP trace information (by default, the last 100 HTTP
request-response exchanges). Requires an HttpTraceRepository bean.
info Displays arbitrary application info.
integrationgraph Shows the Spring Integration graph. Requires a dependency on
spring-integration-core.
loggers Shows and modifies the configuration of loggers in the application.
liquibase Shows any Liquibase database migrations that have been applied.
Requires one or more Liquibase beans.
metrics Shows “metrics” information for the current application.
mappings Displays a collated list of all @RequestMapping paths.
quartz Shows information about Quartz Scheduler jobs.
scheduledtasks Displays the scheduled tasks in your application.
sessions Allows retrieval and deletion of user sessions from a Spring Session-
backed session store. Requires a servlet-based web application that
uses Spring Session.
shutdown Lets the application be gracefully shutdown. Disabled by default.
startup Shows the startup steps data collected by the ApplicationStartup.
Requires the SpringApplication to be configured with a
BufferingApplicationStartup.
threaddump Performs a thread dump.

If your application is a web application (Spring MVC or Spring WebFlux), you can use the following

304
additional endpoints:

ID Description
heapdump Returns a heap dump file. On a HotSpot JVM, an HPROF-format file is
returned. On an OpenJ9 JVM, a PHD-format file is returned.
jolokia Exposes JMX beans over HTTP when Jolokia is on the classpath (not
available for WebFlux). Requires a dependency on jolokia-core.
logfile Returns the contents of the logfile (if the logging.file.name or the
logging.file.path property has been set). Supports the use of the
HTTP Range header to retrieve part of the log file’s content.
prometheus Exposes metrics in a format that can be scraped by a Prometheus
server. Requires a dependency on micrometer-registry-prometheus.

13.2.1. Enabling Endpoints

By default, all endpoints except for shutdown are enabled. To configure the enablement of an
endpoint, use its management.endpoint.<id>.enabled property. The following example enables the
shutdown endpoint:

Properties

management.endpoint.shutdown.enabled=true

Yaml

management:
  endpoint:
  shutdown:
  enabled: true

If you prefer endpoint enablement to be opt-in rather than opt-out, set the
management.endpoints.enabled-by-default property to false and use individual endpoint enabled
properties to opt back in. The following example enables the info endpoint and disables all other
endpoints:

Properties

management.endpoints.enabled-by-default=false
management.endpoint.info.enabled=true

305
Yaml

management:
  endpoints:
  enabled-by-default: false
  endpoint:
  info:
  enabled: true

Disabled endpoints are removed entirely from the application context. If you want
NOTE to change only the technologies over which an endpoint is exposed, use the include
and exclude properties instead.

13.2.2. Exposing Endpoints

Since Endpoints may contain sensitive information, you should carefully consider when to expose
them. The following table shows the default exposure for the built-in endpoints:

ID JMX Web
auditevents Yes No
beans Yes No
caches Yes No
conditions Yes No
configprops Yes No
env Yes No
flyway Yes No
health Yes Yes
heapdump N/A No
httptrace Yes No
info Yes No
integrationgraph Yes No
jolokia N/A No
logfile N/A No
loggers Yes No
liquibase Yes No
metrics Yes No
mappings Yes No
prometheus N/A No
quartz Yes No

306
ID JMX Web
scheduledtasks Yes No
sessions Yes No
shutdown Yes No
startup Yes No
threaddump Yes No

To change which endpoints are exposed, use the following technology-specific include and exclude
properties:

Property Default
management.endpoints.jmx.exposure.exclude
management.endpoints.jmx.exposure.include *
management.endpoints.web.exposure.exclude
management.endpoints.web.exposure.include health

The include property lists the IDs of the endpoints that are exposed. The exclude property lists the
IDs of the endpoints that should not be exposed. The exclude property takes precedence over the
include property. You can configure both the include and the exclude properties with a list of
endpoint IDs.

For example, to stop exposing all endpoints over JMX and only expose the health and info
endpoints, use the following property:

Properties

management.endpoints.jmx.exposure.include=health,info

Yaml

management:
  endpoints:
  jmx:
  exposure:
  include: "health,info"

* can be used to select all endpoints. For example, to expose everything over HTTP except the env
and beans endpoints, use the following properties:

Properties

management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env,beans

307
Yaml

management:
  endpoints:
  web:
  exposure:
  include: "*"
  exclude: "env,beans"

* has a special meaning in YAML, so be sure to add quotation marks if you want to
NOTE
include (or exclude) all endpoints.

If your application is exposed publicly, we strongly recommend that you also secure
NOTE
your endpoints.

If you want to implement your own strategy for when endpoints are exposed, you can
TIP
register an EndpointFilter bean.

13.2.3. Security

For security purposes, all actuators other than /health are disabled by default. You can use the
management.endpoints.web.exposure.include property to enable the actuators.

Before setting the management.endpoints.web.exposure.include, ensure that the

NOTE exposed actuators do not contain sensitive information, are secured by placing
them behind a firewall, or are secured by something like Spring Security.

If Spring Security is on the classpath and no other WebSecurityConfigurerAdapter or

SecurityFilterChain bean is present, all actuators other than /health are secured by Spring Boot
auto-configuration. If you define a custom WebSecurityConfigurerAdapter or SecurityFilterChain
bean, Spring Boot auto-configuration backs off and lets you fully control the actuator access rules.

If you wish to configure custom security for HTTP endpoints (for example, to allow only users with
a certain role to access them), Spring Boot provides some convenient RequestMatcher objects that
you can use in combination with Spring Security.

A typical Spring Security configuration might look something like the following example:

308
 import
org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.web.SecurityFilterChain;

@Configuration(proxyBeanMethods = false)
public class MySecurityConfiguration {

  @Bean
  public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception
{
  http.requestMatcher(EndpointRequest.toAnyEndpoint())
  .authorizeRequests((requests) ->
requests.anyRequest().hasRole("ENDPOINT_ADMIN"));
  http.httpBasic();
  return http.build();
  }

The preceding example uses EndpointRequest.toAnyEndpoint() to match a request to any endpoint

and then ensures that all have the ENDPOINT_ADMIN role. Several other matcher methods are also
available on EndpointRequest. See the API documentation (HTML or PDF) for details.

If you deploy applications behind a firewall, you may prefer that all your actuator endpoints can be
accessed without requiring authentication. You can do so by changing the
management.endpoints.web.exposure.include property, as follows:

Properties

management.endpoints.web.exposure.include=*

Yaml

management:
  endpoints:
  web:
  exposure:
  include: "*"

Additionally, if Spring Security is present, you would need to add custom security configuration that
allows unauthenticated access to the endpoints, as the following example shows:

309
 import
org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.web.SecurityFilterChain;

@Configuration(proxyBeanMethods = false)
public class MySecurityConfiguration {

  @Bean
  public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception
{
  http.requestMatcher(EndpointRequest.toAnyEndpoint())
  .authorizeRequests((requests) -> requests.anyRequest().permitAll());
  return http.build();
  }

In both of the preceding examples, the configuration applies only to the actuator
endpoints. Since Spring Boot’s security configuration backs off completely in the
NOTE
presence of any SecurityFilterChain bean, you need to configure an additional
SecurityFilterChain bean with rules that apply to the rest of the application.

Cross Site Request Forgery Protection

Since Spring Boot relies on Spring Security’s defaults, CSRF protection is turned on by default. This
means that the actuator endpoints that require a POST (shutdown and loggers endpoints), a PUT, or a
DELETE get a 403 (forbidden) error when the default security configuration is in use.

We recommend disabling CSRF protection completely only if you are creating a

NOTE
service that is used by non-browser clients.

You can find additional information about CSRF protection in the Spring Security Reference Guide.

13.2.4. Configuring Endpoints

Endpoints automatically cache responses to read operations that do not take any parameters. To
configure the amount of time for which an endpoint caches a response, use its cache.time-to-live
property. The following example sets the time-to-live of the beans endpoint’s cache to 10 seconds:

Properties

management.endpoint.beans.cache.time-to-live=10s

310
Yaml

management:
  endpoint:
  beans:
  cache:
  time-to-live: "10s"

The management.endpoint.<name> prefix uniquely identifies the endpoint that is being

NOTE
configured.

13.2.5. Hypermedia for Actuator Web Endpoints

A “discovery page” is added with links to all the endpoints. The “discovery page” is available on
/actuator by default.

To disable the “discovery page”, add the following property to your application properties:

Properties

management.endpoints.web.discovery.enabled=false

Yaml

management:
  endpoints:
  web:
  discovery:
  enabled: false

When a custom management context path is configured, the “discovery page” automatically moves
from /actuator to the root of the management context. For example, if the management context
path is /management, the discovery page is available from /management. When the management
context path is set to /, the discovery page is disabled to prevent the possibility of a clash with other
mappings.

13.2.6. CORS Support

Cross-origin resource sharing (CORS) is a W3C specification that lets you specify in a flexible way
what kind of cross-domain requests are authorized. If you use Spring MVC or Spring WebFlux, you
can configure Actuator’s web endpoints to support such scenarios.

CORS support is disabled by default and is only enabled once you have set the
management.endpoints.web.cors.allowed-origins property. The following configuration permits GET
and POST calls from the example.com domain:

311
Properties

management.endpoints.web.cors.allowed-origins=https://example.com
management.endpoints.web.cors.allowed-methods=GET,POST

Yaml

management:
  endpoints:
  web:
  cors:
  allowed-origins: "https://example.com"
  allowed-methods: "GET,POST"

TIP See CorsEndpointProperties for a complete list of options.

13.2.7. Implementing Custom Endpoints

If you add a @Bean annotated with @Endpoint, any methods annotated with @ReadOperation,
@WriteOperation, or @DeleteOperation are automatically exposed over JMX and, in a web application,
over HTTP as well. Endpoints can be exposed over HTTP by using Spring MVC, or Spring WebFlux.

The following example exposes a read operation that returns a custom object:

@ReadOperation
public CustomData getData() {
  return new CustomData("test", 5);
}

You can also write technology-specific endpoints by using @JmxEndpoint or @WebEndpoint. These
endpoints are restricted to their respective technologies. For example, @WebEndpoint is exposed only
over HTTP and not over JMX.

You can write technology-specific extensions by using @EndpointWebExtension and

@EndpointJmxExtension. These annotations let you provide technology-specific operations to
augment an existing endpoint.

Finally, if you need access to web-framework-specific functionality, you can implement servlet or
Spring @Controller and @RestController endpoints at the cost of them not being available over JMX
or when using a different web framework.

Receiving Input

Operations on an endpoint receive input through their parameters. When exposed over the web,
the values for these parameters are taken from the URL’s query parameters and from the JSON
request body. When exposed over JMX, the parameters are mapped to the parameters of the
MBean’s operations. Parameters are required by default. They can be made optional by annotating

312
them with either @javax.annotation.Nullable or @org.springframework.lang.Nullable.

You can map each root property in the JSON request body to a parameter of the endpoint. Consider
the following JSON request body:

{
  "name": "test",
  "counter": 42
}

You can use this to invoke a write operation that takes String name and int counter parameters, as
the following example shows:

@WriteOperation
public void updateData(String name, int counter) {
  // injects "test" and 42
}

Because endpoints are technology agnostic, only simple types can be specified in the
TIP method signature. In particular, declaring a single parameter with a CustomData type
that defines a name and counter properties is not supported.

To let the input be mapped to the operation method’s parameters, Java code that
implements an endpoint should be compiled with -parameters, and Kotlin code that
NOTE implements an endpoint should be compiled with -java-parameters. This will
happen automatically if you use Spring Boot’s Gradle plugin or if you use Maven
and spring-boot-starter-parent.

Input Type Conversion

The parameters passed to endpoint operation methods are, if necessary, automatically converted to
the required type. Before calling an operation method, the input received over JMX or HTTP is
converted to the required types by using an instance of ApplicationConversionService as well as any
Converter or GenericConverter beans qualified with @EndpointConverter.

Custom Web Endpoints

Operations on an @Endpoint, @WebEndpoint, or @EndpointWebExtension are automatically exposed over

HTTP using Spring MVC or Spring WebFlux.

Web Endpoint Request Predicates

A request predicate is automatically generated for each operation on a web-exposed endpoint.

Path

The path of the predicate is determined by the ID of the endpoint and the base path of the web-
exposed endpoints. The default base path is /actuator. For example, an endpoint with an ID of

313
sessions uses /actuator/sessions as its path in the predicate.

You can further customize the path by annotating one or more parameters of the operation method
with @Selector. Such a parameter is added to the path predicate as a path variable. The variable’s
value is passed into the operation method when the endpoint operation is invoked. If you want to
capture all remaining path elements, you can add @Selector(Match=ALL_REMAINING) to the last
parameter and make it a type that is conversion-compatible with a String[].

HTTP method

The HTTP method of the predicate is determined by the operation type, as shown in the following
table:

Operation HTTP method

@ReadOperation GET
@WriteOperation POST
@DeleteOperation DELETE

Consumes

For a @WriteOperation (HTTP POST) that uses the request body, the consumes clause of the predicate is
application/vnd.spring-boot.actuator.v2+json, application/json. For all other operations, the
consumes clause is empty.

Produces

The produces clause of the predicate can be determined by the produces attribute of the
@DeleteOperation, @ReadOperation, and @WriteOperation annotations. The attribute is optional. If it is
not used, the produces clause is determined automatically.

If the operation method returns void or Void, the produces clause is empty. If the operation method
returns a org.springframework.core.io.Resource, the produces clause is application/octet-stream.
For all other operations, the produces clause is application/vnd.spring-boot.actuator.v2+json,
application/json.

Web Endpoint Response Status

The default response status for an endpoint operation depends on the operation type (read, write,
or delete) and what, if anything, the operation returns.

If a @ReadOperation returns a value, the response status will be 200 (OK). If it does not return a
value, the response status will be 404 (Not Found).

If a @WriteOperation or @DeleteOperation returns a value, the response status will be 200 (OK). If it
does not return a value, the response status will be 204 (No Content).

If an operation is invoked without a required parameter or with a parameter that cannot be

converted to the required type, the operation method is not called, and the response status will be
400 (Bad Request).

314
Web Endpoint Range Requests

You can use an HTTP range request to request part of an HTTP resource. Operations that return a
org.springframework.core.io.Resource automatically support range requests.

Web Endpoint Security

An operation on a web endpoint or a web-specific endpoint extension can receive the current
java.security.Principal or org.springframework.boot.actuate.endpoint.SecurityContext as a
method parameter. The former is typically used in conjunction with @Nullable to provide different
behavior for authenticated and unauthenticated users. The latter is typically used to perform
authorization checks by using its isUserInRole(String) method.

Servlet Endpoints

A servlet can be exposed as an endpoint by implementing a class annotated with @ServletEndpoint

that also implements Supplier<EndpointServlet>. Servlet endpoints provide deeper integration with
the servlet container but at the expense of portability. They are intended to be used to expose an
existing servlet as an endpoint. For new endpoints, the @Endpoint and @WebEndpoint annotations
should be preferred whenever possible.

Controller Endpoints

You can use @ControllerEndpoint and @RestControllerEndpoint to implement an endpoint that is

exposed only by Spring MVC or Spring WebFlux. Methods are mapped by using the standard
annotations for Spring MVC and Spring WebFlux, such as @RequestMapping and @GetMapping, with the
endpoint’s ID being used as a prefix for the path. Controller endpoints provide deeper integration
with Spring’s web frameworks but at the expense of portability. The @Endpoint and @WebEndpoint
annotations should be preferred whenever possible.

13.2.8. Health Information

You can use health information to check the status of your running application. It is often used by
monitoring software to alert someone when a production system goes down. The information
exposed by the health endpoint depends on the management.endpoint.health.show-details and
management.endpoint.health.show-components properties, which can be configured with one of the
following values:

Name Description
never Details are never shown.
when-authorized Details are shown only to authorized users. Authorized roles can be
configured by using management.endpoint.health.roles.
always Details are shown to all users.

The default value is never. A user is considered to be authorized when they are in one or more of
the endpoint’s roles. If the endpoint has no configured roles (the default), all authenticated users
are considered to be authorized. You can configure the roles by using the
management.endpoint.health.roles property.

315
 If you have secured your application and wish to use always, your security
NOTE configuration must permit access to the health endpoint for both authenticated and
unauthenticated users.

Health information is collected from the content of a HealthContributorRegistry (by default, all
HealthContributor instances defined in your ApplicationContext). Spring Boot includes a number of
auto-configured HealthContributors, and you can also write your own.

A HealthContributor can be either a HealthIndicator or a CompositeHealthContributor. A

HealthIndicator provides actual health information, including a Status. A
CompositeHealthContributor provides a composite of other HealthContributors. Taken together,
contributors form a tree structure to represent the overall system health.

By default, the final system health is derived by a StatusAggregator, which sorts the statuses from
each HealthIndicator based on an ordered list of statuses. The first status in the sorted list is used as
the overall health status. If no HealthIndicator returns a status that is known to the
StatusAggregator, an UNKNOWN status is used.

You can use the HealthContributorRegistry to register and unregister health indicators
TIP
at runtime.

Auto-configured HealthIndicators

When appropriate, Spring Boot auto-configures the HealthIndicators listed in the following table.
You can also enable or disable selected indicators by configuring management.health.key.enabled,
with the key listed in the following table:

Key Name Description

cassandra CassandraDriverHealthIndicator Checks that a Cassandra database is up.

couchbase CouchbaseHealthIndicator Checks that a Couchbase cluster is up.

db DataSourceHealthIndicator Checks that a connection to DataSource can be
obtained.
diskspace DiskSpaceHealthIndicator Checks for low disk space.
elasticsearch ElasticsearchRestHealthIndicat Checks that an Elasticsearch cluster is up.
or
hazelcast HazelcastHealthIndicator Checks that a Hazelcast server is up.
influxdb InfluxDbHealthIndicator Checks that an InfluxDB server is up.
jms JmsHealthIndicator Checks that a JMS broker is up.
ldap LdapHealthIndicator Checks that an LDAP server is up.
mail MailHealthIndicator Checks that a mail server is up.
mongo MongoHealthIndicator Checks that a Mongo database is up.
neo4j Neo4jHealthIndicator Checks that a Neo4j database is up.
ping PingHealthIndicator Always responds with UP.

316
Key Name Description
rabbit RabbitHealthIndicator Checks that a Rabbit server is up.
redis RedisHealthIndicator Checks that a Redis server is up.
solr SolrHealthIndicator Checks that a Solr server is up.

TIP You can disable them all by setting the management.health.defaults.enabled property.

Additional HealthIndicators are available but are not enabled by default:

Key Name Description

livenessstate LivenessStateHealthIndicator Exposes the “Liveness” application
availability state.
readinessstate ReadinessStateHealthIndicato Exposes the “Readiness” application
r availability state.

Writing Custom HealthIndicators

To provide custom health information, you can register Spring beans that implement the
HealthIndicator interface. You need to provide an implementation of the health() method and
return a Health response. The Health response should include a status and can optionally include
additional details to be displayed. The following code shows a sample HealthIndicator
implementation:

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;

@Component
public class MyHealthIndicator implements HealthIndicator {

  @Override
  public Health health() {
  int errorCode = check();
  if (errorCode != 0) {
  return Health.down().withDetail("Error Code", errorCode).build();
  }
  return Health.up().build();
  }

  private int check() {

  // perform some specific health check
  return ...
  }

317
 The identifier for a given HealthIndicator is the name of the bean without the
NOTE HealthIndicator suffix, if it exists. In the preceding example, the health information
is available in an entry named my.

In addition to Spring Boot’s predefined Status types, Health can return a custom Status that
represents a new system state. In such cases, you also need to provide a custom implementation of
the StatusAggregator interface, or you must configure the default implementation by using the
management.endpoint.health.status.order configuration property.

For example, assume a new Status with a code of FATAL is being used in one of your HealthIndicator
implementations. To configure the severity order, add the following property to your application
properties:

Properties

management.endpoint.health.status.order=fatal,down,out-of-service,unknown,up

Yaml

management:
  endpoint:
  health:
  status:
  order: "fatal,down,out-of-service,unknown,up"

The HTTP status code in the response reflects the overall health status. By default, OUT_OF_SERVICE
and DOWN map to 503. Any unmapped health statuses, including UP, map to 200. You might also want
to register custom status mappings if you access the health endpoint over HTTP. Configuring a
custom mapping disables the defaults mappings for DOWN and OUT_OF_SERVICE. If you want to retain
the default mappings, you must explicitly configure them, alongside any custom mappings. For
example, the following property maps FATAL to 503 (service unavailable) and retains the default
mappings for DOWN and OUT_OF_SERVICE:

Properties

management.endpoint.health.status.http-mapping.down=503
management.endpoint.health.status.http-mapping.fatal=503
management.endpoint.health.status.http-mapping.out-of-service=503

318
Yaml

management:
  endpoint:
  health:
  status:
  http-mapping:
  down: 503
  fatal: 503
  out-of-service: 503

TIP If you need more control, you can define your own HttpCodeStatusMapper bean.

The following table shows the default status mappings for the built-in statuses:

Status Mapping
DOWN SERVICE_UNAVAILABLE (503)
OUT_OF_SERVICE SERVICE_UNAVAILABLE (503)
UP No mapping by default, so HTTP status is 200
UNKNOWN No mapping by default, so HTTP status is 200

Reactive Health Indicators

For reactive applications, such as those that use Spring WebFlux, ReactiveHealthContributor
provides a non-blocking contract for getting application health. Similar to a traditional
HealthContributor, health information is collected from the content of a
ReactiveHealthContributorRegistry (by default, all HealthContributor and ReactiveHealthContributor
instances defined in your ApplicationContext). Regular HealthContributors that do not check against
a reactive API are executed on the elastic scheduler.

In a reactive application, you should use the ReactiveHealthContributorRegistry to

TIP register and unregister health indicators at runtime. If you need to register a regular
HealthContributor, you should wrap it with ReactiveHealthContributor#adapt.

To provide custom health information from a reactive API, you can register Spring beans that
implement the ReactiveHealthIndicator interface. The following code shows a sample
ReactiveHealthIndicator implementation:

319
 import reactor.core.publisher.Mono;

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.ReactiveHealthIndicator;
import org.springframework.stereotype.Component;

@Component
public class MyReactiveHealthIndicator implements ReactiveHealthIndicator {

  @Override
  public Mono<Health> health() {
  return doHealthCheck().onErrorResume((exception) ->
  Mono.just(new Health.Builder().down(exception).build()));
  }

  private Mono<Health> doHealthCheck() {

  // perform some specific health check
  return ...
  }

To handle the error automatically, consider extending from

TIP
AbstractReactiveHealthIndicator.

Auto-configured ReactiveHealthIndicators

When appropriate, Spring Boot auto-configures the following ReactiveHealthIndicators:

Key Name Description

cassandra CassandraDriverReactiveHealthI Checks that a Cassandra database is up.
ndicator
couchbase CouchbaseReactiveHealthIndicat Checks that a Couchbase cluster is up.
or
elasticsearch ElasticsearchReactiveHealthInd Checks that an Elasticsearch cluster is up.
icator
mongo MongoReactiveHealthIndicator Checks that a Mongo database is up.
neo4j Neo4jReactiveHealthIndicator Checks that a Neo4j database is up.
redis RedisReactiveHealthIndicator Checks that a Redis server is up.

If necessary, reactive indicators replace the regular ones. Also, any HealthIndicator
TIP
that is not handled explicitly is wrapped automatically.

Health Groups

It is sometimes useful to organize health indicators into groups that you can use for different

320
purposes.

To create a health indicator group, you can use the management.endpoint.health.group.<name>

property and specify a list of health indicator IDs to include or exclude. For example, to create a
group that includes only database indicators you can define the following:

Properties

management.endpoint.health.group.custom.include=db

Yaml

management:
  endpoint:
  health:
  group:
  custom:
  include: "db"

You can then check the result by hitting localhost:8080/actuator/health/custom.

Similarly, to create a group that excludes the database indicators from the group and includes all
the other indicators, you can define the following:

Properties

management.endpoint.health.group.custom.exclude=db

Yaml

management:
  endpoint:
  health:
  group:
  custom:
  exclude: "db"

By default, groups inherit the same StatusAggregator and HttpCodeStatusMapper settings as the
system health. However, you can also define these on a per-group basis. You can also override the
show-details and roles properties if required:

Properties

management.endpoint.health.group.custom.show-details=when-authorized
management.endpoint.health.group.custom.roles=admin
management.endpoint.health.group.custom.status.order=fatal,up
management.endpoint.health.group.custom.status.http-mapping.fatal=500
management.endpoint.health.group.custom.status.http-mapping.out-of-service=500

321
Yaml

management:
  endpoint:
  health:
  group:
  custom:
  show-details: "when-authorized"
  roles: "admin"
  status:
  order: "fatal,up"
  http-mapping:
  fatal: 500
  out-of-service: 500

You can use @Qualifier("groupname") if you need to register custom StatusAggregator

TIP
or HttpCodeStatusMapper beans for use with the group.

A health group can also include/exclude a CompositeHealthContributor. You can also include/exclude
only a certain component of a CompositeHealthContributor. This can be done using the fully
qualified name of the component as follows:

management.endpoint.health.group.custom.include="test/primary"
management.endpoint.health.group.custom.exclude="test/primary/b"

In the example above, the custom group will include the HealthContributor with the name primary
which is a component of the composite test. Here, primary itself is a composite and the
HealthContributor with the name b will be excluded from the custom group.

Health groups can be made available at an additional path on either the main or management port.
This is useful in cloud environments such as Kubernetes, where it is quite common to use a
separate management port for the actuator endpoints for security purposes. Having a separate port
could lead to unreliable health checks because the main application might not work properly even
if the health check is successful. The health group can be configured with an additional path as
follows:

management.endpoint.health.group.live.additional-path="server:/healthz"

This would make the live health group available on the main server port at /healthz. The prefix is
mandatory and must be either server: (represents the main server port) or management: (represents
the management port, if configured.) The path must be a single path segment.

DataSource Health

The DataSource health indicator shows the health of both standard data sources and routing data
source beans. The health of a routing data source includes the health of each of its target data
sources. In the health endpoint’s response, each of a routing data source’s targets is named by using

322
its routing key. If you prefer not to include routing data sources in the indicator’s output, set
management.health.db.ignore-routing-data-sources to true.

13.2.9. Kubernetes Probes

Applications deployed on Kubernetes can provide information about their internal state with
Container Probes. Depending on your Kubernetes configuration, the kubelet calls those probes and
reacts to the result.

By default, Spring Boot manages your Application Availability State. If deployed in a Kubernetes
environment, actuator gathers the “Liveness” and “Readiness” information from the
ApplicationAvailability interface and uses that information in dedicated health indicators:
LivenessStateHealthIndicator and ReadinessStateHealthIndicator. These indicators are shown on
the global health endpoint ("/actuator/health"). They are also exposed as separate HTTP Probes by
using health groups: "/actuator/health/liveness" and "/actuator/health/readiness".

You can then configure your Kubernetes infrastructure with the following endpoint information:

livenessProbe:
  httpGet:
  path: "/actuator/health/liveness"
  port: <actuator-port>
  failureThreshold: ...
  periodSeconds: ...

readinessProbe:
  httpGet:
  path: "/actuator/health/readiness"
  port: <actuator-port>
  failureThreshold: ...
  periodSeconds: ...

<actuator-port> should be set to the port that the actuator endpoints are available
NOTE on. It could be the main web server port or a separate management port if the
"management.server.port" property has been set.

These health groups are automatically enabled only if the application runs in a Kubernetes
environment. You can enable them in any environment by using the
management.endpoint.health.probes.enabled configuration property.

If an application takes longer to start than the configured liveness period,

Kubernetes mentions the "startupProbe" as a possible solution. The "startupProbe"
NOTE is not necessarily needed here, as the "readinessProbe" fails until all startup tasks
are done. See the section that describes how probes behave during the application
lifecycle.

If your Actuator endpoints are deployed on a separate management context, the endpoints do not
use the same web infrastructure (port, connection pools, framework components) as the main

323
application. In this case, a probe check could be successful even if the main application does not
work properly (for example, it cannot accept new connections). For this reason, is it a good idea to
make the liveness and readiness health groups available on the main server port. This can be done
by setting the following property:

management.endpoint.health.probes.add-additional-paths=true

This would make liveness available at /livez and readiness at readyz on the main server port.

Checking External State with Kubernetes Probes

Actuator configures the “liveness” and “readiness” probes as Health Groups. This means that all the
health groups features are available for them. You can, for example, configure additional Health
Indicators:

Properties

management.endpoint.health.group.readiness.include=readinessState,customCheck

Yaml

management:
  endpoint:
  health:
  group:
  readiness:
  include: "readinessState,customCheck"

By default, Spring Boot does not add other health indicators to these groups.

The “liveness” probe should not depend on health checks for external systems. If the liveness state
of an application is broken, Kubernetes tries to solve that problem by restarting the application
instance. This means that if an external system (such as a database, a Web API, or an external
cache) fails, Kubernetes might restart all application instances and create cascading failures.

As for the “readiness” probe, the choice of checking external systems must be made carefully by the
application developers. For this reason, Spring Boot does not include any additional health checks
in the readiness probe. If the readiness state of an application instance is unready, Kubernetes does
not route traffic to that instance. Some external systems might not be shared by application
instances, in which case they could be included in a readiness probe. Other external systems might
not be essential to the application (the application could have circuit breakers and fallbacks), in
which case they definitely should not be included. Unfortunately, an external system that is shared
by all application instances is common, and you have to make a judgement call: Include it in the
readiness probe and expect that the application is taken out of service when the external service is
down or leave it out and deal with failures higher up the stack, perhaps by using a circuit breaker
in the caller.

324
 If all instances of an application are unready, a Kubernetes Service with
type=ClusterIP or NodePort does not accept any incoming connections. There is no
HTTP error response (503 and so on), since there is no connection. A service with
type=LoadBalancer might or might not accept connections, depending on the
NOTE
provider. A service that has an explicit ingress also responds in a way that depends
on the implementation — the ingress service itself has to decide how to handle the
“connection refused” from downstream. HTTP 503 is quite likely in the case of both
load balancer and ingress.

Also, if an application uses Kubernetes autoscaling, it may react differently to applications being
taken out of the load-balancer, depending on its autoscaler configuration.

Application Lifecycle and Probe States

An important aspect of the Kubernetes Probes support is its consistency with the application
lifecycle. There is a significant difference between the AvailabilityState (which is the in-memory,
internal state of the application) and the actual probe (which exposes that state). Depending on the
phase of application lifecycle, the probe might not be available.

Spring Boot publishes application events during startup and shutdown, and probes can listen to
such events and expose the AvailabilityState information.

The following tables show the AvailabilityState and the state of HTTP connectors at different
stages.

When a Spring Boot application starts:

Startup LivenessSta ReadinessSt HTTP server Notes

phase te ate

Starting BROKEN REFUSING_TRA Not started Kubernetes checks the "liveness"

FFIC Probe and restarts the application
if it takes too long.

Started CORRECT REFUSING_TRA Refuses requests The application context is

FFIC refreshed. The application
performs startup tasks and does
not receive traffic yet.

Ready CORRECT ACCEPTING_TR Accepts requests Startup tasks are finished. The
AFFIC application is receiving traffic.

When a Spring Boot application shuts down:

Shutdown Liveness Readiness HTTP server Notes

phase State State

Running CORRECT ACCEPTING_TR Accepts requests Shutdown has been requested.

AFFIC

Graceful CORRECT REFUSING_TRA New requests are If enabled, graceful shutdown

shutdown FFIC rejected processes in-flight requests.

325
Shutdown Liveness Readiness HTTP server Notes
phase State State

Shutdown N/A N/A Server is shut down The application context is closed
complete and the application is shut down.

See Kubernetes container lifecycle section for more information about Kubernetes
TIP
deployment.

13.2.10. Application Information

Application information exposes various information collected from all InfoContributor beans
defined in your ApplicationContext. Spring Boot includes a number of auto-configured
InfoContributor beans, and you can write your own.

Auto-configured InfoContributors

When appropriate, Spring auto-configures the following InfoContributor beans:

ID Name Description Prerequisites

buil BuildInfoContributor Exposes build information. A META-INF/build-
d info.properties
resource.
env EnvironmentInfoContri Exposes any property from the Environment None.
butor whose name starts with info..
git GitInfoContributor Exposes git information. A git.properties
resource.
java JavaInfoContributor Exposes Java runtime information. None.
os OsInfoContributor Exposes Operating System information. None.

Whether an individual contributor is enabled is controlled by its management.info.<id>.enabled

property. Different contributors have different defaults for this property, depending on their
prerequisites and the nature of the information that they expose.

With no prerequisites to indicate that they should be enabled, the env, java, and os contributors are
disabled by default. Each can be enabled by setting its management.info.<id>.enabled property to
true.

The build and git info contributors are enabled by default. Each can be disabled by setting its
management.info.<id>.enabled property to false. Alternatively, to disable every contributor that is
usually enabled by default, set the management.info.defaults.enabled property to false.

Custom Application Information

When the env contributor is enabled, you can customize the data exposed by the info endpoint by
setting info.* Spring properties. All Environment properties under the info key are automatically
exposed. For example, you could add the following settings to your application.properties file:

326
Properties

info.app.encoding=UTF-8
info.app.java.source=11
info.app.java.target=11

Yaml

info:
  app:
  encoding: "UTF-8"
  java:
  source: "11"
  target: "11"

Rather than hardcoding those values, you could also expand info properties at build
time.

Assuming you use Maven, you could rewrite the preceding example as follows:

Properties

info.app.encoding=@project.build.sourceEncoding@
info.app.java.source=@java.version@
info.app.java.target=@java.version@
TIP

Yaml

info:
  app:
  encoding: "@project.build.sourceEncoding@"
  java:
  source: "@java.version@"
  target: "@java.version@"

Git Commit Information

Another useful feature of the info endpoint is its ability to publish information about the state of
your git source code repository when the project was built. If a GitProperties bean is available, you
can use the info endpoint to expose these properties.

A GitProperties bean is auto-configured if a git.properties file is available at the root

TIP
of the classpath. See "how to generate git information" for more detail.

By default, the endpoint exposes git.branch, git.commit.id, and git.commit.time properties, if

present. If you do not want any of these properties in the endpoint response, they need to be
excluded from the git.properties file. If you want to display the full git information (that is, the full

327
content of git.properties), use the management.info.git.mode property, as follows:

Properties

management.info.git.mode=full

Yaml

management:
  info:
  git:
  mode: "full"

To disable the git commit information from the info endpoint completely, set the
management.info.git.enabled property to false, as follows:

Properties

management.info.git.enabled=false

Yaml

management:
  info:
  git:
  enabled: false

Build Information

If a BuildProperties bean is available, the info endpoint can also publish information about your
build. This happens if a META-INF/build-info.properties file is available in the classpath.

The Maven and Gradle plugins can both generate that file. See "how to generate build
TIP
information" for more details.

Java Information

The info endpoint publishes information about your Java runtime environment, see JavaInfo for
more details.

OS Information

The info endpoint publishes information about your Operating System, see OsInfo for more details.

Writing Custom InfoContributors

To provide custom application information, you can register Spring beans that implement the
InfoContributor interface.

328
The following example contributes an example entry with a single value:

import java.util.Collections;

import org.springframework.boot.actuate.info.Info;
import org.springframework.boot.actuate.info.InfoContributor;
import org.springframework.stereotype.Component;

@Component
public class MyInfoContributor implements InfoContributor {

  @Override
  public void contribute(Info.Builder builder) {
  builder.withDetail("example", Collections.singletonMap("key", "value"));
  }

If you reach the info endpoint, you should see a response that contains the following additional
entry:

{
  "example": {
  "key" : "value"
  }
}

13.3. Monitoring and Management over HTTP

If you are developing a web application, Spring Boot Actuator auto-configures all enabled
endpoints to be exposed over HTTP. The default convention is to use the id of the endpoint with a
prefix of /actuator as the URL path. For example, health is exposed as /actuator/health.

TIP Actuator is supported natively with Spring MVC and Spring WebFlux.

Jackson is a required dependency in order to get the correct JSON responses as

NOTE
documented in the API documentation (HTML or PDF).

13.3.1. Customizing the Management Endpoint Paths

Sometimes, it is useful to customize the prefix for the management endpoints. For example, your
application might already use /actuator for another purpose. You can use the
management.endpoints.web.base-path property to change the prefix for your management endpoint,
as the following example shows:

329
Properties

management.endpoints.web.base-path=/manage

Yaml

management:
  endpoints:
  web:
  base-path: "/manage"

The preceding application.properties example changes the endpoint from /actuator/{id} to

/manage/{id} (for example, /manage/info).

Unless the management port has been configured to expose endpoints by using a
different HTTP port, management.endpoints.web.base-path is relative to
NOTE server.servlet.context-path (for servlet web applications) or spring.webflux.base-
path (for reactive web applications). If management.server.port is configured,
management.endpoints.web.base-path is relative to management.server.base-path.

If you want to map endpoints to a different path, you can use the management.endpoints.web.path-
mapping property.

The following example remaps /actuator/health to /healthcheck:

Properties

management.endpoints.web.base-path=/
management.endpoints.web.path-mapping.health=healthcheck

Yaml

management:
  endpoints:
  web:
  base-path: "/"
  path-mapping:
  health: "healthcheck"

13.3.2. Customizing the Management Server Port

Exposing management endpoints by using the default HTTP port is a sensible choice for cloud-
based deployments. If, however, your application runs inside your own data center, you may prefer
to expose endpoints by using a different HTTP port.

You can set the management.server.port property to change the HTTP port, as the following example
shows:

330
Properties

management.server.port=8081

Yaml

management:
  server:
  port: 8081

On Cloud Foundry, by default, applications receive requests only on port 8080 for
both HTTP and TCP routing. If you want to use a custom management port on Cloud
NOTE
Foundry, you need to explicitly set up the application’s routes to forward traffic to
the custom port.

13.3.3. Configuring Management-specific SSL

When configured to use a custom port, you can also configure the management server with its own
SSL by using the various management.server.ssl.* properties. For example, doing so lets a
management server be available over HTTP while the main application uses HTTPS, as the
following property settings show:

Properties

server.port=8443
server.ssl.enabled=true
server.ssl.key-store=classpath:store.jks
server.ssl.key-password=secret
management.server.port=8080
management.server.ssl.enabled=false

Yaml

server:
  port: 8443
  ssl:
  enabled: true
  key-store: "classpath:store.jks"
  key-password: "secret"
management:
  server:
  port: 8080
  ssl:
  enabled: false

Alternatively, both the main server and the management server can use SSL but with different key
stores, as follows:

331
Properties

server.port=8443
server.ssl.enabled=true
server.ssl.key-store=classpath:main.jks
server.ssl.key-password=secret
management.server.port=8080
management.server.ssl.enabled=true
management.server.ssl.key-store=classpath:management.jks
management.server.ssl.key-password=secret

Yaml

server:
  port: 8443
  ssl:
  enabled: true
  key-store: "classpath:main.jks"
  key-password: "secret"
management:
  server:
  port: 8080
  ssl:
  enabled: true
  key-store: "classpath:management.jks"
  key-password: "secret"

13.3.4. Customizing the Management Server Address

You can customize the address on which the management endpoints are available by setting the
management.server.address property. Doing so can be useful if you want to listen only on an internal
or ops-facing network or to listen only for connections from localhost.

You can listen on a different address only when the port differs from the main
NOTE
server port.

The following example application.properties does not allow remote management connections:

Properties

management.server.port=8081
management.server.address=127.0.0.1

332
Yaml

management:
  server:
  port: 8081
  address: "127.0.0.1"

13.3.5. Disabling HTTP Endpoints

If you do not want to expose endpoints over HTTP, you can set the management port to -1, as the
following example shows:

Properties

management.server.port=-1

Yaml

management:
  server:
  port: -1

You can also achieve this by using the management.endpoints.web.exposure.exclude property, as the
following example shows:

Properties

management.endpoints.web.exposure.exclude=*

Yaml

management:
  endpoints:
  web:
  exposure:
  exclude: "*"

13.4. Monitoring and Management over JMX

Java Management Extensions (JMX) provide a standard mechanism to monitor and manage
applications. By default, this feature is not enabled. You can turn it on by setting the
spring.jmx.enabled configuration property to true. Spring Boot exposes the most suitable
MBeanServer as a bean with an ID of mbeanServer. Any of your beans that are annotated with Spring
JMX annotations (@ManagedResource, @ManagedAttribute, or @ManagedOperation) are exposed to it.

If your platform provides a standard MBeanServer, Spring Boot uses that and defaults to the VM
MBeanServer, if necessary. If all that fails, a new MBeanServer is created.

333
See the JmxAutoConfiguration class for more details.

By default, Spring Boot also exposes management endpoints as JMX MBeans under the
org.springframework.boot domain. To take full control over endpoint registration in the JMX
domain, consider registering your own EndpointObjectNameFactory implementation.

13.4.1. Customizing MBean Names

The name of the MBean is usually generated from the id of the endpoint. For example, the health
endpoint is exposed as org.springframework.boot:type=Endpoint,name=Health.

If your application contains more than one Spring ApplicationContext, you may find that names
clash. To solve this problem, you can set the spring.jmx.unique-names property to true so that MBean
names are always unique.

You can also customize the JMX domain under which endpoints are exposed. The following settings
show an example of doing so in application.properties:

Properties

spring.jmx.unique-names=true
management.endpoints.jmx.domain=com.example.myapp

Yaml

spring:
  jmx:
  unique-names: true
management:
  endpoints:
  jmx:
  domain: "com.example.myapp"

13.4.2. Disabling JMX Endpoints

If you do not want to expose endpoints over JMX, you can set the
management.endpoints.jmx.exposure.exclude property to *, as the following example shows:

Properties

management.endpoints.jmx.exposure.exclude=*

334
Yaml

management:
  endpoints:
  jmx:
  exposure:
  exclude: "*"

13.5. Loggers
Spring Boot Actuator includes the ability to view and configure the log levels of your application at
runtime. You can view either the entire list or an individual logger’s configuration, which is made
up of both the explicitly configured logging level as well as the effective logging level given to it by
the logging framework. These levels can be one of:

• TRACE

• DEBUG

• INFO

• WARN

• ERROR

• FATAL

• OFF

• null

null indicates that there is no explicit configuration.

13.5.1. Configure a Logger

To configure a given logger, POST a partial entity to the resource’s URI, as the following example
shows:

{
  "configuredLevel": "DEBUG"
}

To “reset” the specific level of the logger (and use the default configuration instead),
TIP
you can pass a value of null as the configuredLevel.

13.6. Metrics
Spring Boot Actuator provides dependency management and auto-configuration for Micrometer, an
application metrics facade that supports numerous monitoring systems, including:

• AppOptics

335
 • Atlas

• Datadog

• Dynatrace

• Elastic

• Ganglia

• Graphite

• Humio

• Influx

• JMX

• KairosDB

• New Relic

• Prometheus

• SignalFx

• Simple (in-memory)

• Stackdriver

• StatsD

• Wavefront

To learn more about Micrometer’s capabilities, see its reference documentation, in

TIP
particular the concepts section.

13.6.1. Getting started

Spring Boot auto-configures a composite MeterRegistry and adds a registry to the composite for
each of the supported implementations that it finds on the classpath. Having a dependency on
micrometer-registry-{system} in your runtime classpath is enough for Spring Boot to configure the
registry.

Most registries share common features. For instance, you can disable a particular registry even if
the Micrometer registry implementation is on the classpath. The following example disables
Datadog:

Properties

management.metrics.export.datadog.enabled=false

336
Yaml

management:
  metrics:
  export:
  datadog:
  enabled: false

You can also disable all registries unless stated otherwise by the registry-specific property, as the
following example shows:

Properties

management.metrics.export.defaults.enabled=false

Yaml

management:
  metrics:
  export:
  defaults:
  enabled: false

Spring Boot also adds any auto-configured registries to the global static composite registry on the
Metrics class, unless you explicitly tell it not to:

Properties

management.metrics.use-global-registry=false

Yaml

management:
  metrics:
  use-global-registry: false

You can register any number of MeterRegistryCustomizer beans to further configure the registry,
such as applying common tags, before any meters are registered with the registry:

337
 import io.micrometer.core.instrument.MeterRegistry;

import org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyMeterRegistryConfiguration {

  @Bean
  public MeterRegistryCustomizer<MeterRegistry> metricsCommonTags() {
  return (registry) -> registry.config().commonTags("region", "us-east-1");
  }

You can apply customizations to particular registry implementations by being more specific about
the generic type:

import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.config.NamingConvention;
import io.micrometer.graphite.GraphiteMeterRegistry;

import org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyMeterRegistryConfiguration {

  @Bean
  public MeterRegistryCustomizer<GraphiteMeterRegistry>
graphiteMetricsNamingConvention() {
  return (registry) -> registry.config().namingConvention(this::name);
  }

  private String name(String name, Meter.Type type, String baseUnit) {

  return ...
  }

Spring Boot also configures built-in instrumentation that you can control through configuration or
dedicated annotation markers.

13.6.2. Supported Monitoring Systems

This section briefly describes each of the supported monitoring systems.

338
AppOptics

By default, the AppOptics registry periodically pushes metrics to api.appoptics.com/v1/

measurements. To export metrics to SaaS AppOptics, your API token must be provided:

Properties

management.metrics.export.appoptics.api-token=YOUR_TOKEN

Yaml

management:
  metrics:
  export:
  appoptics:
  api-token: "YOUR_TOKEN"

Atlas

By default, metrics are exported to Atlas running on your local machine. You can provide the
location of the Atlas server:

Properties

management.metrics.export.atlas.uri=https://atlas.example.com:7101/api/v1/publish

Yaml

management:
  metrics:
  export:
  atlas:
  uri: "https://atlas.example.com:7101/api/v1/publish"

Datadog

A Datadog registry periodically pushes metrics to datadoghq. To export metrics to Datadog, you
must provide your API key:

Properties

management.metrics.export.datadog.api-key=YOUR_KEY

339
Yaml

management:
  metrics:
  export:
  datadog:
  api-key: "YOUR_KEY"

You can also change the interval at which metrics are sent to Datadog:

Properties

management.metrics.export.datadog.step=30s

Yaml

management:
  metrics:
  export:
  datadog:
  step: "30s"

Dynatrace

Dynatrace offers two metrics ingest APIs, both of which are implemented for Micrometer.
Configuration properties in the v1 namespace apply only when exporting to the Timeseries v1 API.
Configuration properties in the v2 namespace apply only when exporting to the Metrics v2 API.
Note that this integration can export only to either the v1 or v2 version of the API at a time. If the
device-id (required for v1 but not used in v2) is set in the v1 namespace, metrics are exported to the
v1 endpoint. Otherwise, v2 is assumed.

v2 API

You can use the v2 API in two ways.

If a local OneAgent is running on the host, metrics are automatically exported to the local OneAgent
ingest endpoint. The ingest endpoint forwards the metrics to the Dynatrace backend. This is the
default behavior and requires no special setup beyond a dependency on io.micrometer:micrometer-
registry-dynatrace.

If no local OneAgent is running, the endpoint of the Metrics v2 API and an API token are required.
The API token must have the “Ingest metrics” (metrics.ingest) permission set. We recommend
limiting the scope of the token to this one permission. You must ensure that the endpoint URI
contains the path (for example, /api/v2/metrics/ingest):

The URL of the Metrics API v2 ingest endpoint is different according to your deployment option:

• SaaS: https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/ingest

• Managed deployments: https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest

340
The example below configures metrics export using the example environment id:

Properties

management.metrics.export.dynatrace.uri=https://example.live.dynatrace.com/api/v2/metr
ics/ingest
management.metrics.export.dynatrace.api-token=YOUR_TOKEN

Yaml

management:
  metrics:
  export:
  dynatrace:
  uri: "https://example.live.dynatrace.com/api/v2/metrics/ingest"
  api-token: "YOUR_TOKEN"

When using the Dynatrace v2 API, the following optional features are available:

• Metric key prefix: Sets a prefix that is prepended to all exported metric keys.

• Enrich with Dynatrace metadata: If a OneAgent or Dynatrace operator is running, enrich

metrics with additional metadata (for example, about the host, process, or pod).

• Default dimensions: Specify key-value pairs that are added to all exported metrics. If tags with
the same key are specified with Micrometer, they overwrite the default dimensions.

It is possible to not specify a URI and API token, as shown in the following example. In this scenario,
the local OneAgent endpoint is used:

Properties

management.metrics.export.dynatrace.v2.metric-key-prefix=your.key.prefix
management.metrics.export.dynatrace.v2.enrich-with-dynatrace-metadata=true
management.metrics.export.dynatrace.v2.default-dimensions.key1=value1
management.metrics.export.dynatrace.v2.default-dimensions.key2=value2

Yaml

management:
  metrics:
  export:
  dynatrace:
  # Specify uri and api-token here if not using the local OneAgent endpoint.
  v2:
  metric-key-prefix: "your.key.prefix"
  enrich-with-dynatrace-metadata: true
  default-dimensions:
  key1: "value1"
  key2: "value2"

341
v1 API (Legacy)

The Dynatrace v1 API metrics registry pushes metrics to the configured URI periodically by using
the Timeseries v1 API. For backwards-compatibility with existing setups, when device-id is set
(required for v1, but not used in v2), metrics are exported to the Timeseries v1 endpoint. To export
metrics to Dynatrace, your API token, device ID, and URI must be provided:

Properties

management.metrics.export.dynatrace.uri=https://{your-environment-
id}.live.dynatrace.com
management.metrics.export.dynatrace.api-token=YOUR_TOKEN
management.metrics.export.dynatrace.v1.device-id=YOUR_DEVICE_ID

Yaml

management:
  metrics:
  export:
  dynatrace:
  uri: "https://{your-environment-id}.live.dynatrace.com"
  api-token: "YOUR_TOKEN"
  v1:
  device-id: "YOUR_DEVICE_ID"

For the v1 API, you must specify the base environment URI without a path, as the v1 endpoint path
is added automatically.

Version-independent Settings

In addition to the API endpoint and token, you can also change the interval at which metrics are
sent to Dynatrace. The default export interval is 60s. The following example sets the export interval
to 30 seconds:

Properties

management.metrics.export.dynatrace.step=30s

Yaml

management:
  metrics:
  export:
  dynatrace:
  step: "30s"

You can find more information on how to set up the Dynatrace exporter for Micrometer in the
Micrometer documentation.

342
Elastic

By default, metrics are exported to Elastic running on your local machine. You can provide the
location of the Elastic server to use by using the following property:

Properties

management.metrics.export.elastic.host=https://elastic.example.com:8086

Yaml

management:
  metrics:
  export:
  elastic:
  host: "https://elastic.example.com:8086"

Ganglia

By default, metrics are exported to Ganglia running on your local machine. You can provide the
Ganglia server host and port, as the following example shows:

Properties

management.metrics.export.ganglia.host=ganglia.example.com
management.metrics.export.ganglia.port=9649

Yaml

management:
  metrics:
  export:
  ganglia:
  host: "ganglia.example.com"
  port: 9649

Graphite

By default, metrics are exported to Graphite running on your local machine. You can provide the
Graphite server host and port, as the following example shows:

Properties

management.metrics.export.graphite.host=graphite.example.com
management.metrics.export.graphite.port=9004

343
Yaml

management:
  metrics:
  export:
  graphite:
  host: "graphite.example.com"
  port: 9004

Micrometer provides a default HierarchicalNameMapper that governs how a dimensional meter ID is

mapped to flat hierarchical names.

To take control over this behavior, define your GraphiteMeterRegistry and supply your
own HierarchicalNameMapper. An auto-configured GraphiteConfig and Clock beans are
provided unless you define your own:

import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.config.NamingConvention;
import io.micrometer.core.instrument.util.HierarchicalNameMapper;
import io.micrometer.graphite.GraphiteConfig;
import io.micrometer.graphite.GraphiteMeterRegistry;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
TIP
public class MyGraphiteConfiguration {

  @Bean
  public GraphiteMeterRegistry graphiteMeterRegistry(GraphiteConfig
config, Clock clock) {
  return new GraphiteMeterRegistry(config, clock,
this::toHierarchicalName);
  }

  private String toHierarchicalName(Meter.Id id, NamingConvention

convention) {
  return ...
  }

Humio

By default, the Humio registry periodically pushes metrics to cloud.humio.com. To export metrics to
SaaS Humio, you must provide your API token:

344
Properties

management.metrics.export.humio.api-token=YOUR_TOKEN

Yaml

management:
  metrics:
  export:
  humio:
  api-token: "YOUR_TOKEN"

You should also configure one or more tags to identify the data source to which metrics are pushed:

Properties

management.metrics.export.humio.tags.alpha=a
management.metrics.export.humio.tags.bravo=b

Yaml

management:
  metrics:
  export:
  humio:
  tags:
  alpha: "a"
  bravo: "b"

Influx

By default, metrics are exported to an Influx v1 instance running on your local machine with the
default configuration. To export metrics to InfluxDB v2, configure the org, bucket, and
authentication token for writing metrics. You can provide the location of the Influx server to use by
using:

Properties

management.metrics.export.influx.uri=https://influx.example.com:8086

Yaml

management:
  metrics:
  export:
  influx:
  uri: "https://influx.example.com:8086"

345
JMX

Micrometer provides a hierarchical mapping to JMX, primarily as a cheap and portable way to view
metrics locally. By default, metrics are exported to the metrics JMX domain. You can provide the
domain to use by using:

Properties

management.metrics.export.jmx.domain=com.example.app.metrics

Yaml

management:
  metrics:
  export:
  jmx:
  domain: "com.example.app.metrics"

Micrometer provides a default HierarchicalNameMapper that governs how a dimensional meter ID is

mapped to flat hierarchical names.

346
 To take control over this behavior, define your JmxMeterRegistry and supply your own
HierarchicalNameMapper. An auto-configured JmxConfig and Clock beans are provided
unless you define your own:

import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.config.NamingConvention;
import io.micrometer.core.instrument.util.HierarchicalNameMapper;
import io.micrometer.jmx.JmxConfig;
import io.micrometer.jmx.JmxMeterRegistry;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
TIP
public class MyJmxConfiguration {

  @Bean
  public JmxMeterRegistry jmxMeterRegistry(JmxConfig config, Clock
clock) {
  return new JmxMeterRegistry(config, clock,
this::toHierarchicalName);
  }

  private String toHierarchicalName(Meter.Id id, NamingConvention

convention) {
  return ...
  }

KairosDB

By default, metrics are exported to KairosDB running on your local machine. You can provide the
location of the KairosDB server to use by using:

Properties

management.metrics.export.kairos.uri=https://kairosdb.example.com:8080/api/v1/datapoin
ts

Yaml

management:
  metrics:
  export:
  kairos:
  uri: "https://kairosdb.example.com:8080/api/v1/datapoints"

347
New Relic

A New Relic registry periodically pushes metrics to New Relic. To export metrics to New Relic, you
must provide your API key and account ID:

Properties

management.metrics.export.newrelic.api-key=YOUR_KEY
management.metrics.export.newrelic.account-id=YOUR_ACCOUNT_ID

Yaml

management:
  metrics:
  export:
  newrelic:
  api-key: "YOUR_KEY"
  account-id: "YOUR_ACCOUNT_ID"

You can also change the interval at which metrics are sent to New Relic:

Properties

management.metrics.export.newrelic.step=30s

Yaml

management:
  metrics:
  export:
  newrelic:
  step: "30s"

By default, metrics are published through REST calls, but you can also use the Java Agent API if you
have it on the classpath:

Properties

management.metrics.export.newrelic.client-provider-type=insights-agent

Yaml

management:
  metrics:
  export:
  newrelic:
  client-provider-type: "insights-agent"

348
Finally, you can take full control by defining your own NewRelicClientProvider bean.

Prometheus

Prometheus expects to scrape or poll individual application instances for metrics. Spring Boot
provides an actuator endpoint at /actuator/prometheus to present a Prometheus scrape with the
appropriate format.

By default, the endpoint is not available and must be exposed. See exposing endpoints
TIP
for more details.

The following example scrape_config adds to prometheus.yml:

scrape_configs:
  - job_name: "spring"
  metrics_path: "/actuator/prometheus"
  static_configs:
  - targets: ["HOST:PORT"]

For ephemeral or batch jobs that may not exist long enough to be scraped, you can use Prometheus
Pushgateway support to expose the metrics to Prometheus. To enable Prometheus Pushgateway
support, add the following dependency to your project:

<dependency>
  <groupId>io.prometheus</groupId>
  <artifactId>simpleclient_pushgateway</artifactId>
</dependency>

When the Prometheus Pushgateway dependency is present on the classpath and the
management.metrics.export.prometheus.pushgateway.enabled property is set to true, a
PrometheusPushGatewayManager bean is auto-configured. This manages the pushing of metrics to a
Prometheus Pushgateway.

You can tune the PrometheusPushGatewayManager by using properties under

management.metrics.export.prometheus.pushgateway. For advanced configuration, you can also
provide your own PrometheusPushGatewayManager bean.

SignalFx

SignalFx registry periodically pushes metrics to SignalFx. To export metrics to SignalFx, you must
provide your access token:

Properties

management.metrics.export.signalfx.access-token=YOUR_ACCESS_TOKEN

349
Yaml

management:
  metrics:
  export:
  signalfx:
  access-token: "YOUR_ACCESS_TOKEN"

You can also change the interval at which metrics are sent to SignalFx:

Properties

management.metrics.export.signalfx.step=30s

Yaml

management:
  metrics:
  export:
  signalfx:
  step: "30s"

Simple

Micrometer ships with a simple, in-memory backend that is automatically used as a fallback if no
other registry is configured. This lets you see what metrics are collected in the metrics endpoint.

The in-memory backend disables itself as soon as you use any other available backend. You can also
disable it explicitly:

Properties

management.metrics.export.simple.enabled=false

Yaml

management:
  metrics:
  export:
  simple:
  enabled: false

Stackdriver

The Stackdriver registry periodically pushes metrics to Stackdriver. To export metrics to SaaS
Stackdriver, you must provide your Google Cloud project ID:

350
Properties

management.metrics.export.stackdriver.project-id=my-project

Yaml

management:
  metrics:
  export:
  stackdriver:
  project-id: "my-project"

You can also change the interval at which metrics are sent to Stackdriver:

Properties

management.metrics.export.stackdriver.step=30s

Yaml

management:
  metrics:
  export:
  stackdriver:
  step: "30s"

StatsD

The StatsD registry eagerly pushes metrics over UDP to a StatsD agent. By default, metrics are
exported to a StatsD agent running on your local machine. You can provide the StatsD agent host,
port, and protocol to use by using:

Properties

management.metrics.export.statsd.host=statsd.example.com
management.metrics.export.statsd.port=9125
management.metrics.export.statsd.protocol=udp

Yaml

management:
  metrics:
  export:
  statsd:
  host: "statsd.example.com"
  port: 9125
  protocol: "udp"

351
You can also change the StatsD line protocol to use (it defaults to Datadog):

Properties

management.metrics.export.statsd.flavor=etsy

Yaml

management:
  metrics:
  export:
  statsd:
  flavor: "etsy"

Wavefront

The Wavefront registry periodically pushes metrics to Wavefront. If you are exporting metrics to
Wavefront directly, you must provide your API token:

Properties

management.metrics.export.wavefront.api-token=YOUR_API_TOKEN

Yaml

management:
  metrics:
  export:
  wavefront:
  api-token: "YOUR_API_TOKEN"

Alternatively, you can use a Wavefront sidecar or an internal proxy in your environment to
forward metrics data to the Wavefront API host:

Properties

management.metrics.export.wavefront.uri=proxy://localhost:2878

Yaml

management:
  metrics:
  export:
  wavefront:
  uri: "proxy://localhost:2878"

352
 If you publish metrics to a Wavefront proxy (as described in the Wavefront
NOTE
documentation), the host must be in the proxy://HOST:PORT format.

You can also change the interval at which metrics are sent to Wavefront:

Properties

management.metrics.export.wavefront.step=30s

Yaml

management:
  metrics:
  export:
  wavefront:
  step: "30s"

13.6.3. Supported Metrics and Meters

Spring Boot provides automatic meter registration for a wide variety of technologies. In most
situations, the defaults provide sensible metrics that can be published to any of the supported
monitoring systems.

JVM Metrics

Auto-configuration enables JVM Metrics by using core Micrometer classes. JVM metrics are
published under the jvm. meter name.

The following JVM metrics are provided:

• Various memory and buffer pool details

• Statistics related to garbage collection

• Thread utilization

• The number of classes loaded and unloaded

System Metrics

Auto-configuration enables system metrics by using core Micrometer classes. System metrics are
published under the system., process., and disk. meter names.

The following system metrics are provided:

• CPU metrics

• File descriptor metrics

• Uptime metrics (both the amount of time the application has been running and a fixed gauge of
the absolute start time)

353
 • Disk space available

Application Startup Metrics

Auto-configuration exposes application startup time metrics:

• application.started.time: time taken to start the application.

• application.ready.time: time taken for the application to be ready to service requests.

Metrics are tagged by the fully qualified name of the application class.

Logger Metrics

Auto-configuration enables the event metrics for both Logback and Log4J2. The details are
published under the log4j2.events. or logback.events. meter names.

Task Execution and Scheduling Metrics

Auto-configuration enables the instrumentation of all available ThreadPoolTaskExecutor and

ThreadPoolTaskScheduler beans, as long as the underling ThreadPoolExecutor is available. Metrics are
tagged by the name of the executor, which is derived from the bean name.

Spring MVC Metrics

Auto-configuration enables the instrumentation of all requests handled by Spring MVC controllers
and functional handlers. By default, metrics are generated with the name, http.server.requests.
You can customize the name by setting the management.metrics.web.server.request.metric-name
property.

@Timed annotations are supported on @Controller classes and @RequestMapping methods (see @Timed
Annotation Support for details). If you do not want to record metrics for all Spring MVC requests,
you can set management.metrics.web.server.request.autotime.enabled to false and exclusively use
@Timed annotations instead.

By default, Spring MVC related metrics are tagged with the following information:

Tag Description
exception The simple class name of any exception that was
thrown while handling the request.
method The request’s method (for example, GET or POST)
outcome The request’s outcome, based on the status code
of the response. 1xx is INFORMATIONAL, 2xx is
SUCCESS, 3xx is REDIRECTION, 4xx is CLIENT_ERROR,
and 5xx is SERVER_ERROR
status The response’s HTTP status code (for example,
200 or 500)

354
Tag Description
uri The request’s URI template prior to variable
substitution, if possible (for example,
/api/person/{id})

To add to the default tags, provide one or more @Beans that implement WebMvcTagsContributor. To
replace the default tags, provide a @Bean that implements WebMvcTagsProvider.

In some cases, exceptions handled in web controllers are not recorded as request
TIP metrics tags. Applications can opt in and record exceptions by setting handled
exceptions as request attributes.

By default, all requests are handled. To customize the filter, provide a @Bean that implements
FilterRegistrationBean<WebMvcMetricsFilter>.

Spring WebFlux Metrics

Auto-configuration enables the instrumentation of all requests handled by Spring WebFlux

controllers and functional handlers. By default, metrics are generated with the name,
http.server.requests. You can customize the name by setting the
management.metrics.web.server.request.metric-name property.

@Timed annotations are supported on @Controller classes and @RequestMapping methods (see @Timed
Annotation Support for details). If you do not want to record metrics for all Spring WebFlux
requests, you can set management.metrics.web.server.request.autotime.enabled to false and
exclusively use @Timed annotations instead.

By default, WebFlux related metrics are tagged with the following information:

Tag Description
exception The simple class name of any exception that was
thrown while handling the request.
method The request’s method (for example, GET or POST)
outcome The request’s outcome, based on the status code
of the response. 1xx is INFORMATIONAL, 2xx is
SUCCESS, 3xx is REDIRECTION, 4xx is CLIENT_ERROR,
and 5xx is SERVER_ERROR
status The response’s HTTP status code (for example,
200 or 500)
uri The request’s URI template prior to variable
substitution, if possible (for example,
/api/person/{id})

To add to the default tags, provide one or more beans that implement WebFluxTagsContributor. To
replace the default tags, provide a bean that implements WebFluxTagsProvider.

355
 In some cases, exceptions handled in controllers and handler functions are not
TIP recorded as request metrics tags. Applications can opt in and record exceptions by
setting handled exceptions as request attributes.

HTTP Client Metrics

Spring Boot Actuator manages the instrumentation of both RestTemplate and WebClient. For that,
you have to inject the auto-configured builder and use it to create instances:

• RestTemplateBuilder for RestTemplate

• WebClient.Builder for WebClient

You can also manually apply the customizers responsible for this instrumentation, namely
MetricsRestTemplateCustomizer and MetricsWebClientCustomizer.

By default, metrics are generated with the name, http.client.requests. You can customize the name
by setting the management.metrics.web.client.request.metric-name property.

By default, metrics generated by an instrumented client are tagged with the following information:

Tag Description
clientName The host portion of the URI
method The request’s method (for example, GET or POST)
outcome The request’s outcome, based on the status code
of the response. 1xx is INFORMATIONAL, 2xx is
SUCCESS, 3xx is REDIRECTION, 4xx is CLIENT_ERROR,
and 5xx is SERVER_ERROR. Otherwise, it is UNKNOWN.
status The response’s HTTP status code if available (for
example, 200 or 500) or IO_ERROR in case of I/O
issues. Otherwise, it is CLIENT_ERROR.
uri The request’s URI template prior to variable
substitution, if possible (for example,
/api/person/{id})

To customize the tags, and depending on your choice of client, you can provide a @Bean that
implements RestTemplateExchangeTagsProvider or WebClientExchangeTagsProvider. There are
convenience static functions in RestTemplateExchangeTags and WebClientExchangeTags.

Tomcat Metrics

Auto-configuration enables the instrumentation of Tomcat only when an MBeanRegistry is enabled.

By default, the MBeanRegistry is disabled, but you can enable it by setting
server.tomcat.mbeanregistry.enabled to true.

Tomcat metrics are published under the tomcat. meter name.

356
Cache Metrics

Auto-configuration enables the instrumentation of all available Cache instances on startup, with
metrics prefixed with cache. Cache instrumentation is standardized for a basic set of metrics.
Additional, cache-specific metrics are also available.

The following cache libraries are supported:

• Caffeine

• Hazelcast

• Any compliant JCache (JSR-107) implementation

• Redis

Metrics are tagged by the name of the cache and by the name of the CacheManager, which is derived
from the bean name.

Only caches that are configured on startup are bound to the registry. For caches not
defined in the cache’s configuration, such as caches created on the fly or
NOTE
programmatically after the startup phase, an explicit registration is required. A
CacheMetricsRegistrar bean is made available to make that process easier.

DataSource Metrics

Auto-configuration enables the instrumentation of all available DataSource objects with metrics
prefixed with jdbc.connections. Data source instrumentation results in gauges that represent the
currently active, idle, maximum allowed, and minimum allowed connections in the pool.

Metrics are also tagged by the name of the DataSource computed based on the bean name.

By default, Spring Boot provides metadata for all supported data sources. You can add
TIP additional DataSourcePoolMetadataProvider beans if your favorite data source is not
supported. See DataSourcePoolMetadataProvidersConfiguration for examples.

Also, Hikari-specific metrics are exposed with a hikaricp prefix. Each metric is tagged by the name
of the pool (you can control it with spring.datasource.name).

Spring Data Repository Metrics

Auto-configuration enables the instrumentation of all Spring Data Repository method invocations.
By default, metrics are generated with the name, spring.data.repository.invocations. You can
customize the name by setting the management.metrics.data.repository.metric-name property.

@Timed annotations are supported on Repository classes and methods (see @Timed Annotation
Support for details). If you do not want to record metrics for all Repository invocations, you can set
management.metrics.data.repository.autotime.enabled to false and exclusively use @Timed
annotations instead.

By default, repository invocation related metrics are tagged with the following information:

357
Tag Description
repository The simple class name of the source Repository.
method The name of the Repository method that was
invoked.
state The result state (SUCCESS, ERROR, CANCELED, or
RUNNING).
exception The simple class name of any exception that was
thrown from the invocation.

To replace the default tags, provide a @Bean that implements RepositoryTagsProvider.

RabbitMQ Metrics

Auto-configuration enables the instrumentation of all available RabbitMQ connection factories with
a metric named rabbitmq.

Spring Integration Metrics

Spring Integration automatically provides Micrometer support whenever a MeterRegistry bean is

available. Metrics are published under the spring.integration. meter name.

Kafka Metrics

Auto-configuration registers a MicrometerConsumerListener and MicrometerProducerListener for the

auto-configured consumer factory and producer factory, respectively. It also registers a
KafkaStreamsMicrometerListener for StreamsBuilderFactoryBean. For more detail, see the Micrometer
Native Metrics section of the Spring Kafka documentation.

MongoDB Metrics

This section briefly describes the available metrics for MongoDB.

MongoDB Command Metrics

Auto-configuration registers a MongoMetricsCommandListener with the auto-configured MongoClient.

A timer metric named mongodb.driver.commands is created for each command issued to the
underlying MongoDB driver. Each metric is tagged with the following information by default:

Tag Description
command The name of the command issued.
cluster.id The identifier of the cluster to which the
command was sent.
server.address The address of the server to which the command
was sent.

358
Tag Description
status The outcome of the command (SUCCESS or
FAILED).

To replace the default metric tags, define a MongoCommandTagsProvider bean, as the following
example shows:

import io.micrometer.core.instrument.binder.mongodb.MongoCommandTagsProvider;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyCommandTagsProviderConfiguration {

  @Bean
  public MongoCommandTagsProvider customCommandTagsProvider() {
  return new CustomCommandTagsProvider();
  }

To disable the auto-configured command metrics, set the following property:

Properties

management.metrics.mongo.command.enabled=false

Yaml

management:
  metrics:
  mongo:
  command:
  enabled: false

MongoDB Connection Pool Metrics

Auto-configuration registers a MongoMetricsConnectionPoolListener with the auto-configured

MongoClient.

The following gauge metrics are created for the connection pool:

• mongodb.driver.pool.size reports the current size of the connection pool, including idle and and
in-use members.

• mongodb.driver.pool.checkedout reports the count of connections that are currently in use.

• mongodb.driver.pool.waitqueuesize reports the current size of the wait queue for a connection

359
 from the pool.

Each metric is tagged with the following information by default:

Tag Description
cluster.id The identifier of the cluster to which the
connection pool corresponds.
server.address The address of the server to which the
connection pool corresponds.

To replace the default metric tags, define a MongoConnectionPoolTagsProvider bean:

import io.micrometer.core.instrument.binder.mongodb.MongoConnectionPoolTagsProvider;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyConnectionPoolTagsProviderConfiguration {

  @Bean
  public MongoConnectionPoolTagsProvider customConnectionPoolTagsProvider() {
  return new CustomConnectionPoolTagsProvider();
  }

To disable the auto-configured connection pool metrics, set the following property:

Properties

management.metrics.mongo.connectionpool.enabled=false

Yaml

management:
  metrics:
  mongo:
  connectionpool:
  enabled: false

Jetty Metrics

Auto-configuration binds metrics for Jetty’s ThreadPool by using Micrometer’s

JettyServerThreadPoolMetrics. Metrics for Jetty’s Connector instances are bound by using
Micrometer’s JettyConnectionMetrics and, when server.ssl.enabled is set to true, Micrometer’s
JettySslHandshakeMetrics.

360
@Timed Annotation Support

You can use the @Timed annotation from the io.micrometer.core.annotation package with several of
the supported technologies described earlier. If supported, you can use the annotation at either the
class level or the method level.

For example, the following code shows how you can use the annotation to instrument all request
mappings in a @RestController:

import java.util.List;

import io.micrometer.core.annotation.Timed;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Timed
public class MyController {

  @GetMapping("/api/addresses")
  public List<Address> listAddress() {
  return ...
  }

  @GetMapping("/api/people")
  public List<Person> listPeople() {
  return ...
  }

If you want only to instrument a single mapping, you can use the annotation on the method instead
of the class:

361
 import java.util.List;

import io.micrometer.core.annotation.Timed;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

  @GetMapping("/api/addresses")
  public List<Address> listAddress() {
  return ...
  }

  @GetMapping("/api/people")
  @Timed
  public List<Person> listPeople() {
  return ...
  }

You can also combine class-level and method-level annotations if you want to change the timing
details for a specific method:

362
 import java.util.List;

import io.micrometer.core.annotation.Timed;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Timed
public class MyController {

  @GetMapping("/api/addresses")
  public List<Address> listAddress() {
  return ...
  }

  @GetMapping("/api/people")
  @Timed(extraTags = { "region", "us-east-1" })
  @Timed(value = "all.people", longTask = true)
  public List<Person> listPeople() {
  return ...
  }

A @Timed annotation with longTask = true enables a long task timer for the method.
NOTE Long task timers require a separate metric name and can be stacked with a short
task timer.

Redis Metrics

Auto-configuration registers a MicrometerCommandLatencyRecorder for the auto-configured

LettuceConnectionFactory. For more detail, see the Micrometer Metrics section of the Lettuce
documentation.

13.6.4. Registering Custom Metrics

To register custom metrics, inject MeterRegistry into your component:

363
 import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tags;

import org.springframework.stereotype.Component;

@Component
public class MyBean {

  private final Dictionary dictionary;

  public MyBean(MeterRegistry registry) {

  this.dictionary = Dictionary.load();
  registry.gauge("dictionary.size", Tags.empty(),
this.dictionary.getWords().size());
  }

If your metrics depend on other beans, we recommend that you use a MeterBinder to register them:

import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.binder.MeterBinder;

import org.springframework.context.annotation.Bean;

public class MyMeterBinderConfiguration {

  @Bean
  public MeterBinder queueSize(Queue queue) {
  return (registry) -> Gauge.builder("queueSize",
queue::size).register(registry);
  }

Using a MeterBinder ensures that the correct dependency relationships are set up and that the bean
is available when the metric’s value is retrieved. A MeterBinder implementation can also be useful if
you find that you repeatedly instrument a suite of metrics across components or applications.

By default, metrics from all MeterBinder beans are automatically bound to the
NOTE
Spring-managed MeterRegistry.

13.6.5. Customizing Individual Metrics

If you need to apply customizations to specific Meter instances, you can use the
io.micrometer.core.instrument.config.MeterFilter interface.

For example, if you want to rename the mytag.region tag to mytag.area for all meter IDs beginning

364
with com.example, you can do the following:

import io.micrometer.core.instrument.config.MeterFilter;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyMetricsFilterConfiguration {

  @Bean
  public MeterFilter renameRegionTagMeterFilter() {
  return MeterFilter.renameTag("com.example", "mytag.region", "mytag.area");
  }

By default, all MeterFilter beans are automatically bound to the Spring-managed

MeterRegistry. Make sure to register your metrics by using the Spring-managed
NOTE
MeterRegistry and not any of the static methods on Metrics. These use the global
registry that is not Spring-managed.

Common Tags

Common tags are generally used for dimensional drill-down on the operating environment, such as
host, instance, region, stack, and others. Commons tags are applied to all meters and can be
configured, as the following example shows:

Properties

management.metrics.tags.region=us-east-1
management.metrics.tags.stack=prod

Yaml

management:
  metrics:
  tags:
  region: "us-east-1"
  stack: "prod"

The preceding example adds region and stack tags to all meters with a value of us-east-1 and prod,
respectively.

The order of common tags is important if you use Graphite. As the order of common
NOTE tags cannot be guaranteed by using this approach, Graphite users are advised to
define a custom MeterFilter instead.

365
Per-meter Properties

In addition to MeterFilter beans, you can apply a limited set of customization on a per-meter basis
by using properties. Per-meter customizations apply to any meter IDs that start with the given
name. The following example disables any meters that have an ID starting with example.remote

Properties

management.metrics.enable.example.remote=false

Yaml

management:
  metrics:
  enable:
  example:
  remote: false

The following properties allow per-meter customization:

Table 9. Per-meter customizations

Property Description
management.metrics.enable Whether to prevent meters from emitting any
metrics.
management.metrics.distribution.percentiles- Whether to publish a histogram suitable for
histogram computing aggregable (across dimension)
percentile approximations.
management.metrics.distribution.minimum- Publish fewer histogram buckets by clamping
expected-value, the range of expected values.
management.metrics.distribution.maximum-
expected-value
management.metrics.distribution.percentiles Publish percentile values computed in your
application

management.metrics.distribution.expiry, Give greater weight to recent samples by

management.metrics.distribution.buffer-length accumulating them in ring buffers which rotate
after a configurable expiry, with a configurable
buffer length.
management.metrics.distribution.slo Publish a cumulative histogram with buckets
defined by your service-level objectives.

For more details on the concepts behind percentiles-histogram, percentiles, and slo, see the
“Histograms and percentiles” section of the Micrometer documentation.

13.6.6. Metrics Endpoint

Spring Boot provides a metrics endpoint that you can use diagnostically to examine the metrics

366
collected by an application. The endpoint is not available by default and must be exposed. See
exposing endpoints for more details.

Navigating to /actuator/metrics displays a list of available meter names. You can drill down to view
information about a particular meter by providing its name as a selector — for example,
/actuator/metrics/jvm.memory.max.

The name you use here should match the name used in the code, not the name after it
has been naming-convention normalized for a monitoring system to which it is
TIP shipped. In other words, if jvm.memory.max appears as jvm_memory_max in Prometheus
because of its snake case naming convention, you should still use jvm.memory.max as the
selector when inspecting the meter in the metrics endpoint.

You can also add any number of tag=KEY:VALUE query parameters to the end of the URL to
dimensionally drill down on a meter — for example,
/actuator/metrics/jvm.memory.max?tag=area:nonheap.

The reported measurements are the sum of the statistics of all meters that match the
meter name and any tags that have been applied. In the preceding example, the
returned Value statistic is the sum of the maximum memory footprints of the “Code
TIP Cache”, “Compressed Class Space”, and “Metaspace” areas of the heap. If you wanted
to see only the maximum size for the “Metaspace”, you could add an additional
tag=id:Metaspace — that is,
/actuator/metrics/jvm.memory.max?tag=area:nonheap&tag=id:Metaspace.

13.7. Auditing
Once Spring Security is in play, Spring Boot Actuator has a flexible audit framework that publishes
events (by default, “authentication success”, “failure” and “access denied” exceptions). This feature
can be very useful for reporting and for implementing a lock-out policy based on authentication
failures.

You can enable auditing by providing a bean of type AuditEventRepository in your application’s
configuration. For convenience, Spring Boot offers an InMemoryAuditEventRepository.
InMemoryAuditEventRepository has limited capabilities, and we recommend using it only for
development environments. For production environments, consider creating your own alternative
AuditEventRepository implementation.

13.7.1. Custom Auditing

To customize published security events, you can provide your own implementations of
AbstractAuthenticationAuditListener and AbstractAuthorizationAuditListener.

You can also use the audit services for your own business events. To do so, either inject the
AuditEventRepository bean into your own components and use that directly or publish an
AuditApplicationEvent with the Spring ApplicationEventPublisher (by implementing
ApplicationEventPublisherAware).

367
13.8. HTTP Tracing
You can enable HTTP Tracing by providing a bean of type HttpTraceRepository in your application’s
configuration. For convenience, Spring Boot offers InMemoryHttpTraceRepository, which stores traces
for the last 100 (the default) request-response exchanges. InMemoryHttpTraceRepository is limited
compared to other tracing solutions, and we recommend using it only for development
environments. For production environments, we recommend using a production-ready tracing or
observability solution, such as Zipkin or Spring Cloud Sleuth. Alternatively, you can create your
own HttpTraceRepository.

You can use the httptrace endpoint to obtain information about the request-response exchanges
that are stored in the HttpTraceRepository.

13.8.1. Custom HTTP tracing

To customize the items that are included in each trace, use the management.trace.http.include
configuration property. For advanced customization, consider registering your own
HttpExchangeTracer implementation.

13.9. Process Monitoring

In the spring-boot module, you can find two classes to create files that are often useful for process
monitoring:

• ApplicationPidFileWriter creates a file that contains the application PID (by default, in the
application directory with a file name of application.pid).

• WebServerPortFileWriter creates a file (or files) that contain the ports of the running web server
(by default, in the application directory with a file name of application.port).

By default, these writers are not activated, but you can enable them:

• By Extending Configuration

• Programmatically Enabling Process Monitoring

13.9.1. Extending Configuration

In the META-INF/spring.factories file, you can activate the listener (or listeners) that writes a PID
file:

org.springframework.context.ApplicationListener=\
org.springframework.boot.context.ApplicationPidFileWriter,\
org.springframework.boot.web.context.WebServerPortFileWriter

13.9.2. Programmatically Enabling Process Monitoring

You can also activate a listener by invoking the SpringApplication.addListeners(…) method and
passing the appropriate Writer object. This method also lets you customize the file name and path

368
in the Writer constructor.

13.10. Cloud Foundry Support

Spring Boot’s actuator module includes additional support that is activated when you deploy to a
compatible Cloud Foundry instance. The /cloudfoundryapplication path provides an alternative
secured route to all @Endpoint beans.

The extended support lets Cloud Foundry management UIs (such as the web application that you
can use to view deployed applications) be augmented with Spring Boot actuator information. For
example, an application status page can include full health information instead of the typical
“running” or “stopped” status.

The /cloudfoundryapplication path is not directly accessible to regular users. To use

NOTE
the endpoint, you must pass a valid UAA token with the request.

13.10.1. Disabling Extended Cloud Foundry Actuator Support

If you want to fully disable the /cloudfoundryapplication endpoints, you can add the following
setting to your application.properties file:

Properties

management.cloudfoundry.enabled=false

Yaml

management:
  cloudfoundry:
  enabled: false

13.10.2. Cloud Foundry Self-signed Certificates

By default, the security verification for /cloudfoundryapplication endpoints makes SSL calls to
various Cloud Foundry services. If your Cloud Foundry UAA or Cloud Controller services use self-
signed certificates, you need to set the following property:

Properties

management.cloudfoundry.skip-ssl-validation=true

Yaml

management:
  cloudfoundry:
  skip-ssl-validation: true

369
13.10.3. Custom Context Path

If the server’s context-path has been configured to anything other than /, the Cloud Foundry
endpoints are not available at the root of the application. For example, if server.servlet.context-
path=/app, Cloud Foundry endpoints are available at /app/cloudfoundryapplication/*.

If you expect the Cloud Foundry endpoints to always be available at /cloudfoundryapplication/*,

regardless of the server’s context-path, you need to explicitly configure that in your application.
The configuration differs, depending on the web server in use. For Tomcat, you can add the
following configuration:

import java.io.IOException;
import java.util.Collections;

import jakarta.servlet.GenericServlet;
import jakarta.servlet.Servlet;
import jakarta.servlet.ServletContainerInitializer;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;

import org.apache.catalina.Host;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.startup.Tomcat;

import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.servlet.ServletContextInitializer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyCloudFoundryConfiguration {

  @Bean
  public TomcatServletWebServerFactory servletWebServerFactory() {
  return new TomcatServletWebServerFactory() {

  @Override
  protected void prepareContext(Host host, ServletContextInitializer[]
initializers) {
  super.prepareContext(host, initializers);
  StandardContext child = new StandardContext();
  child.addLifecycleListener(new Tomcat.FixContextListener());
  child.setPath("/cloudfoundryapplication");
  ServletContainerInitializer initializer =
getServletContextInitializer(getContextPath());
  child.addServletContainerInitializer(initializer,
Collections.emptySet());
  child.setCrossContext(true);

370
   host.addChild(child);
  }

  };
  }

  private ServletContainerInitializer getServletContextInitializer(String

contextPath) {
  return (classes, context) -> {
  Servlet servlet = new GenericServlet() {

  @Override
  public void service(ServletRequest req, ServletResponse res) throws
ServletException, IOException {
  ServletContext context =
req.getServletContext().getContext(contextPath);
 
context.getRequestDispatcher("/cloudfoundryapplication").forward(req, res);
  }

  };
  context.addServlet("cloudfoundry", servlet).addMapping("/*");
  };
  }

13.11. What to Read Next

You might want to read about graphing tools such as Graphite.

Otherwise, you can continue on to read about “deployment options” or jump ahead for some in-
depth information about Spring Boot’s build tool plugins.

371
Chapter 14. Deploying Spring Boot
Applications
Spring Boot’s flexible packaging options provide a great deal of choice when it comes to deploying
your application. You can deploy Spring Boot applications to a variety of cloud platforms, to
virtual/real machines, or make them fully executable for Unix systems.

This section covers some of the more common deployment scenarios.

14.1. Deploying to the Cloud

Spring Boot’s executable jars are ready-made for most popular cloud PaaS (Platform-as-a-Service)
providers. These providers tend to require that you “bring your own container”. They manage
application processes (not Java applications specifically), so they need an intermediary layer that
adapts your application to the cloud’s notion of a running process.

Two popular cloud providers, Heroku and Cloud Foundry, employ a “buildpack” approach. The
buildpack wraps your deployed code in whatever is needed to start your application. It might be a
JDK and a call to java, an embedded web server, or a full-fledged application server. A buildpack is
pluggable, but ideally you should be able to get by with as few customizations to it as possible. This
reduces the footprint of functionality that is not under your control. It minimizes divergence
between development and production environments.

Ideally, your application, like a Spring Boot executable jar, has everything that it needs to run
packaged within it.

In this section, we look at what it takes to get the application that we developed in the “Getting
Started” section up and running in the Cloud.

14.1.1. Cloud Foundry

Cloud Foundry provides default buildpacks that come into play if no other buildpack is specified.
The Cloud Foundry Java buildpack has excellent support for Spring applications, including Spring
Boot. You can deploy stand-alone executable jar applications as well as traditional .war packaged
applications.

Once you have built your application (by using, for example, mvn clean package) and have installed
the cf command line tool, deploy your application by using the cf push command, substituting the
path to your compiled .jar. Be sure to have logged in with your cf command line client before
pushing an application. The following line shows using the cf push command to deploy an
application:

$ cf push acloudyspringtime -p target/demo-0.0.1-SNAPSHOT.jar

In the preceding example, we substitute acloudyspringtime for whatever value you

NOTE
give cf as the name of your application.

372
See the cf push documentation for more options. If there is a Cloud Foundry manifest.yml file
present in the same directory, it is considered.

At this point, cf starts uploading your application, producing output similar to the following
example:

Uploading acloudyspringtime... OK
Preparing to start acloudyspringtime... OK
-----> Downloaded app package (8.9M)
-----> Java Buildpack Version: v3.12 (offline) | https://github.com/cloudfoundry/java-
buildpack.git#6f25b7e
-----> Downloading Open Jdk JRE 1.8.0_121 from https://java-
buildpack.cloudfoundry.org/openjdk/trusty/x86_64/openjdk-1.8.0_121.tar.gz (found in
cache)
  Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.6s)
-----> Downloading Open JDK Like Memory Calculator 2.0.2_RELEASE from https://java-
buildpack.cloudfoundry.org/memory-calculator/trusty/x86_64/memory-calculator-
2.0.2_RELEASE.tar.gz (found in cache)
  Memory Settings: -Xss349K -Xmx681574K -XX:MaxMetaspaceSize=104857K -Xms681574K
-XX:MetaspaceSize=104857K
-----> Downloading Container Certificate Trust Store 1.0.0_RELEASE from https://java-
buildpack.cloudfoundry.org/container-certificate-trust-store/container-certificate-
trust-store-1.0.0_RELEASE.jar (found in cache)
  Adding certificates to .java-
buildpack/container_certificate_trust_store/truststore.jks (0.6s)
-----> Downloading Spring Auto Reconfiguration 1.10.0_RELEASE from https://java-
buildpack.cloudfoundry.org/auto-reconfiguration/auto-reconfiguration-
1.10.0_RELEASE.jar (found in cache)
Checking status of app 'acloudyspringtime'...
  0 of 1 instances running (1 starting)
  ...
  0 of 1 instances running (1 starting)
  ...
  0 of 1 instances running (1 starting)
  ...
  1 of 1 instances running (1 running)

App started

Congratulations! The application is now live!

Once your application is live, you can verify the status of the deployed application by using the cf
apps command, as shown in the following example:

373
 $ cf apps
Getting applications in ...
OK

name requested state instances memory disk urls

...
acloudyspringtime started 1/1 512M 1G
acloudyspringtime.cfapps.io
...

Once Cloud Foundry acknowledges that your application has been deployed, you should be able to
find the application at the URI given. In the preceding example, you could find it at
https://acloudyspringtime.cfapps.io/.

Binding to Services

By default, metadata about the running application as well as service connection information is
exposed to the application as environment variables (for example: $VCAP_SERVICES). This
architecture decision is due to Cloud Foundry’s polyglot (any language and platform can be
supported as a buildpack) nature. Process-scoped environment variables are language agnostic.

Environment variables do not always make for the easiest API, so Spring Boot automatically
extracts them and flattens the data into properties that can be accessed through Spring’s
Environment abstraction, as shown in the following example:

import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class MyBean implements EnvironmentAware {

  private String instanceId;

  @Override
  public void setEnvironment(Environment environment) {
  this.instanceId = environment.getProperty("vcap.application.instance_id");
  }

  // ...

All Cloud Foundry properties are prefixed with vcap. You can use vcap properties to access
application information (such as the public URL of the application) and service information (such
as database credentials). See the ‘CloudFoundryVcapEnvironmentPostProcessor’ Javadoc for
complete details.

374
 TIP The Java CFEnv project is a better fit for tasks such as configuring a DataSource.

14.1.2. Kubernetes

Spring Boot auto-detects Kubernetes deployment environments by checking the environment for
"*_SERVICE_HOST" and "*_SERVICE_PORT" variables. You can override this detection with the
spring.main.cloud-platform configuration property.

Spring Boot helps you to manage the state of your application and export it with HTTP Kubernetes
Probes using Actuator.

Kubernetes Container Lifecycle

When Kubernetes deletes an application instance, the shutdown process involves several
subsystems concurrently: shutdown hooks, unregistering the service, removing the instance from
the load-balancer… Because this shutdown processing happens in parallel (and due to the nature of
distributed systems), there is a window during which traffic can be routed to a pod that has also
begun its shutdown processing.

You can configure a sleep execution in a preStop handler to avoid requests being routed to a pod
that has already begun shutting down. This sleep should be long enough for new requests to stop
being routed to the pod and its duration will vary from deployment to deployment. The preStop
handler can be configured by using the PodSpec in the pod’s configuration file as follows:

spec:
  containers:
  - name: "example-container"
  image: "example-image"
  lifecycle:
  preStop:
  exec:
  command: ["sh", "-c", "sleep 10"]

Once the pre-stop hook has completed, SIGTERM will be sent to the container and graceful
shutdown will begin, allowing any remaining in-flight requests to complete.

When Kubernetes sends a SIGTERM signal to the pod, it waits for a specified time
called the termination grace period (the default for which is 30 seconds). If the
containers are still running after the grace period, they are sent the SIGKILL signal
NOTE and forcibly removed. If the pod takes longer than 30 seconds to shut down, which
could be because you have increased spring.lifecycle.timeout-per-shutdown-phase,
make sure to increase the termination grace period by setting the
terminationGracePeriodSeconds option in the Pod YAML.

14.1.3. Heroku

Heroku is another popular PaaS platform. To customize Heroku builds, you provide a Procfile,

375
which provides the incantation required to deploy an application. Heroku assigns a port for the
Java application to use and then ensures that routing to the external URI works.

You must configure your application to listen on the correct port. The following example shows the
Procfile for our starter REST application:

web: java -Dserver.port=$PORT -jar target/demo-0.0.1-SNAPSHOT.jar

Spring Boot makes -D arguments available as properties accessible from a Spring Environment
instance. The server.port configuration property is fed to the embedded Tomcat, Jetty, or Undertow
instance, which then uses the port when it starts up. The $PORT environment variable is assigned to
us by the Heroku PaaS.

This should be everything you need. The most common deployment workflow for Heroku
deployments is to git push the code to production, as shown in the following example:

$ git push heroku main

Which will result in the following:

376
 Initializing repository, done.
Counting objects: 95, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (78/78), done.
Writing objects: 100% (95/95), 8.66 MiB | 606.00 KiB/s, done.
Total 95 (delta 31), reused 0 (delta 0)

-----> Java app detected

-----> Installing OpenJDK 1.8... done
-----> Installing Maven 3.3.1... done
-----> Installing settings.xml... done
-----> Executing: mvn -B -DskipTests=true clean install

  [INFO] Scanning for projects...

  Downloading: https://repo.spring.io/...
  Downloaded: https://repo.spring.io/... (818 B at 1.8 KB/sec)
  ....
  Downloaded: https://s3pository.heroku.com/jvm/... (152 KB at 595.3 KB/sec)
  [INFO] Installing /tmp/build_0c35a5d2-a067-4abc-a232-14b1fb7a8229/target/...
  [INFO] Installing /tmp/build_0c35a5d2-a067-4abc-a232-14b1fb7a8229/pom.xml ...
  [INFO] ------------------------------------------------------------------------
  [INFO] BUILD SUCCESS
  [INFO] ------------------------------------------------------------------------
  [INFO] Total time: 59.358s
  [INFO] Finished at: Fri Mar 07 07:28:25 UTC 2014
  [INFO] Final Memory: 20M/493M
  [INFO] ------------------------------------------------------------------------

-----> Discovering process types

  Procfile declares types -> web

-----> Compressing... done, 70.4MB

-----> Launching... done, v6
  https://agile-sierra-1405.herokuapp.com/ deployed to Heroku

To git@heroku.com:agile-sierra-1405.git
 * [new branch] main -> main

Your application should now be up and running on Heroku. For more details, see Deploying Spring
Boot Applications to Heroku.

14.1.4. OpenShift

OpenShift has many resources describing how to deploy Spring Boot applications, including:

• Using the S2I builder

• Architecture guide

• Running as a traditional web application on Wildfly

377
 • OpenShift Commons Briefing

14.1.5. Amazon Web Services (AWS)

Amazon Web Services offers multiple ways to install Spring Boot-based applications, either as
traditional web applications (war) or as executable jar files with an embedded web server. The
options include:

• AWS Elastic Beanstalk

• AWS Code Deploy

• AWS OPS Works

• AWS Cloud Formation

• AWS Container Registry

Each has different features and pricing models. In this document, we describe to approach using
AWS Elastic Beanstalk.

AWS Elastic Beanstalk

As described in the official Elastic Beanstalk Java guide, there are two main options to deploy a Java
application. You can either use the “Tomcat Platform” or the “Java SE platform”.

Using the Tomcat Platform

This option applies to Spring Boot projects that produce a war file. No special configuration is
required. You need only follow the official guide.

Using the Java SE Platform

This option applies to Spring Boot projects that produce a jar file and run an embedded web
container. Elastic Beanstalk environments run an nginx instance on port 80 to proxy the actual
application, running on port 5000. To configure it, add the following line to your
application.properties file:

server.port=5000

Upload binaries instead of sources

By default, Elastic Beanstalk uploads sources and compiles them in AWS. However, it
is best to upload the binaries instead. To do so, add lines similar to the following to
your .elasticbeanstalk/config.yml file:
TIP

deploy:
  artifact: target/demo-0.0.1-SNAPSHOT.jar

378
 Reduce costs by setting the environment type
By default an Elastic Beanstalk environment is load balanced. The load balancer has a
significant cost. To avoid that cost, set the environment type to “Single instance”, as
described in the Amazon documentation. You can also create single instance
TIP
environments by using the CLI and the following command:

eb create -s

Summary

This is one of the easiest ways to get to AWS, but there are more things to cover, such as how to
integrate Elastic Beanstalk into any CI / CD tool, use the Elastic Beanstalk Maven plugin instead of
the CLI, and others. There is a blog post covering these topics more in detail.

14.1.6. CloudCaptain and Amazon Web Services

CloudCaptain works by turning your Spring Boot executable jar or war into a minimal VM image
that can be deployed unchanged either on VirtualBox or on AWS. CloudCaptain comes with deep
integration for Spring Boot and uses the information from your Spring Boot configuration file to
automatically configure ports and health check URLs. CloudCaptain leverages this information both
for the images it produces as well as for all the resources it provisions (instances, security groups,
elastic load balancers, and so on).

Once you have created a CloudCaptain account, connected it to your AWS account, installed the
latest version of the CloudCaptain Client, and ensured that the application has been built by Maven
or Gradle (by using, for example, mvn clean package), you can deploy your Spring Boot application
to AWS with a command similar to the following:

$ boxfuse run myapp-1.0.jar -env=prod

See the boxfuse run documentation for more options. If there is a boxfuse.conf file present in the
current directory, it is considered.

By default, CloudCaptain activates a Spring profile named boxfuse on startup. If your

TIP executable jar or war contains an application-boxfuse.properties file, CloudCaptain
bases its configuration on the properties it contains.

At this point, CloudCaptain creates an image for your application, uploads it, and configures and
starts the necessary resources on AWS, resulting in output similar to the following example:

379
 Fusing Image for myapp-1.0.jar ...
Image fused in 00:06.838s (53937 K) -> axelfontaine/myapp:1.0
Creating axelfontaine/myapp ...
Pushing axelfontaine/myapp:1.0 ...
Verifying axelfontaine/myapp:1.0 ...
Creating Elastic IP ...
Mapping myapp-axelfontaine.boxfuse.io to 52.28.233.167 ...
Waiting for AWS to create an AMI for axelfontaine/myapp:1.0 in eu-central-1 (this may
take up to 50 seconds) ...
AMI created in 00:23.557s -> ami-d23f38cf
Creating security group boxfuse-sg_axelfontaine/myapp:1.0 ...
Launching t2.micro instance of axelfontaine/myapp:1.0 (ami-d23f38cf) in eu-central-1
...
Instance launched in 00:30.306s -> i-92ef9f53
Waiting for AWS to boot Instance i-92ef9f53 and Payload to start at
https://52.28.235.61/ ...
Payload started in 00:29.266s -> https://52.28.235.61/
Remapping Elastic IP 52.28.233.167 to i-92ef9f53 ...
Waiting 15s for AWS to complete Elastic IP Zero Downtime transition ...
Deployment completed successfully. axelfontaine/myapp:1.0 is up and running at
https://myapp-axelfontaine.boxfuse.io/

Your application should now be up and running on AWS.

See the blog post on deploying Spring Boot apps on EC2 as well as the documentation for the
CloudCaptain Spring Boot integration to get started with a Maven build to run the app.

14.1.7. Azure

This Getting Started guide walks you through deploying your Spring Boot application to either
Azure Spring Cloud or Azure App Service.

14.1.8. Google Cloud

Google Cloud has several options that can be used to launch Spring Boot applications. The easiest to
get started with is probably App Engine, but you could also find ways to run Spring Boot in a
container with Container Engine or on a virtual machine with Compute Engine.

To run in App Engine, you can create a project in the UI first, which sets up a unique identifier for
you and also sets up HTTP routes. Add a Java app to the project and leave it empty and then use the
Google Cloud SDK to push your Spring Boot app into that slot from the command line or CI build.

App Engine Standard requires you to use WAR packaging. Follow these steps to deploy App Engine
Standard application to Google Cloud.

Alternatively, App Engine Flex requires you to create an app.yaml file to describe the resources your
app requires. Normally, you put this file in src/main/appengine, and it should resemble the following
file:

380
 service: "default"

runtime: "java"
env: "flex"

runtime_config:
  jdk: "openjdk8"

handlers:
- url: "/.*"
  script: "this field is required, but ignored"

manual_scaling:
  instances: 1

health_check:
  enable_health_check: false

env_variables:
  ENCRYPT_KEY: "your_encryption_key_here"

You can deploy the app (for example, with a Maven plugin) by adding the project ID to the build
configuration, as shown in the following example:

<plugin>
  <groupId>com.google.cloud.tools</groupId>
  <artifactId>appengine-maven-plugin</artifactId>
  <version>1.3.0</version>
  <configuration>
  <project>myproject</project>
  </configuration>
</plugin>

Then deploy with mvn appengine:deploy (if you need to authenticate first, the build fails).

14.2. Installing Spring Boot Applications

In addition to running Spring Boot applications by using java -jar, it is also possible to make fully
executable applications for Unix systems. A fully executable jar can be executed like any other
executable binary or it can be registered with init.d or systemd. This helps when installing and
managing Spring Boot applications in common production environments.

381
 Fully executable jars work by embedding an extra script at the front of the file.
Currently, some tools do not accept this format, so you may not always be able
to use this technique. For example, jar -xf may silently fail to extract a jar or
CAUTION
war that has been made fully executable. It is recommended that you make
your jar or war fully executable only if you intend to execute it directly, rather
than running it with java -jar or deploying it to a servlet container.

A zip64-format jar file cannot be made fully executable. Attempting to do so will

result in a jar file that is reported as corrupt when executed directly or with
CAUTION
java -jar. A standard-format jar file that contains one or more zip64-format
nested jars can be fully executable.

To create a ‘fully executable’ jar with Maven, use the following plugin configuration:

<plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <configuration>
  <executable>true</executable>
  </configuration>
</plugin>

The following example shows the equivalent Gradle configuration:

bootJar {
  launchScript()
}

You can then run your application by typing ./my-application.jar (where my-application is the
name of your artifact). The directory containing the jar is used as your application’s working
directory.

14.2.1. Supported Operating Systems

The default script supports most Linux distributions and is tested on CentOS and Ubuntu. Other
platforms, such as OS X and FreeBSD, require the use of a custom embeddedLaunchScript.

14.2.2. Unix/Linux Services

Spring Boot application can be easily started as Unix/Linux services by using either init.d or
systemd.

Installation as an init.d Service (System V)

If you configured Spring Boot’s Maven or Gradle plugin to generate a fully executable jar, and you
do not use a custom embeddedLaunchScript, your application can be used as an init.d service. To do

382
so, symlink the jar to init.d to support the standard start, stop, restart, and status commands.

The script supports the following features:

• Starts the services as the user that owns the jar file

• Tracks the application’s PID by using /var/run/<appname>/<appname>.pid

• Writes console logs to /var/log/<appname>.log

Assuming that you have a Spring Boot application installed in /var/myapp, to install a Spring Boot
application as an init.d service, create a symlink, as follows:

$ sudo ln -s /var/myapp/myapp.jar /etc/init.d/myapp

Once installed, you can start and stop the service in the usual way. For example, on a Debian-based
system, you could start it with the following command:

$ service myapp start

If your application fails to start, check the log file written to /var/log/<appname>.log for
TIP
errors.

You can also flag the application to start automatically by using your standard operating system
tools. For example, on Debian, you could use the following command:

$ update-rc.d myapp defaults <priority>

Securing an init.d Service

The following is a set of guidelines on how to secure a Spring Boot application that
NOTE runs as an init.d service. It is not intended to be an exhaustive list of everything that
should be done to harden an application and the environment in which it runs.

When executed as root, as is the case when root is being used to start an init.d service, the default
executable script runs the application as the user specified in the RUN_AS_USER environment
variable. When the environment variable is not set, the user who owns the jar file is used instead.
You should never run a Spring Boot application as root, so RUN_AS_USER should never be root and
your application’s jar file should never be owned by root. Instead, create a specific user to run your
application and set the RUN_AS_USER environment variable or use chown to make it the owner of the
jar file, as shown in the following example:

$ chown bootapp:bootapp your-app.jar

In this case, the default executable script runs the application as the bootapp user.

383
 To reduce the chances of the application’s user account being compromised, you
TIP should consider preventing it from using a login shell. For example, you can set the
account’s shell to /usr/sbin/nologin.

You should also take steps to prevent the modification of your application’s jar file. Firstly,
configure its permissions so that it cannot be written and can only be read or executed by its
owner, as shown in the following example:

$ chmod 500 your-app.jar

Second, you should also take steps to limit the damage if your application or the account that is
running it is compromised. If an attacker does gain access, they could make the jar file writable and
change its contents. One way to protect against this is to make it immutable by using chattr, as
shown in the following example:

$ sudo chattr +i your-app.jar

This will prevent any user, including root, from modifying the jar.

If root is used to control the application’s service and you use a .conf file to customize its startup,
the .conf file is read and evaluated by the root user. It should be secured accordingly. Use chmod so
that the file can only be read by the owner and use chown to make root the owner, as shown in the
following example:

$ chmod 400 your-app.conf

$ sudo chown root:root your-app.conf

Installation as a systemd Service

systemd is the successor of the System V init system and is now being used by many modern Linux
distributions. Although you can continue to use init.d scripts with systemd, it is also possible to
launch Spring Boot applications by using systemd ‘service’ scripts.

Assuming that you have a Spring Boot application installed in /var/myapp, to install a Spring Boot
application as a systemd service, create a script named myapp.service and place it in
/etc/systemd/system directory. The following script offers an example:

384
 [Unit]
Description=myapp
After=syslog.target

[Service]
User=myapp
ExecStart=/var/myapp/myapp.jar
SuccessExitStatus=143

[Install]
WantedBy=multi-user.target

Remember to change the Description, User, and ExecStart fields for your
IMPORTANT
application.

The ExecStart field does not declare the script action command, which means that
NOTE
the run command is used by default.

Note that, unlike when running as an init.d service, the user that runs the application, the PID file,
and the console log file are managed by systemd itself and therefore must be configured by using
appropriate fields in the ‘service’ script. Consult the service unit configuration man page for more
details.

To flag the application to start automatically on system boot, use the following command:

$ systemctl enable myapp.service

Run man systemctl for more details.

Customizing the Startup Script

The default embedded startup script written by the Maven or Gradle plugin can be customized in a
number of ways. For most people, using the default script along with a few customizations is
usually enough. If you find you cannot customize something that you need to, use the
embeddedLaunchScript option to write your own file entirely.

Customizing the Start Script When It Is Written

It often makes sense to customize elements of the start script as it is written into the jar file. For
example, init.d scripts can provide a “description”. Since you know the description up front (and it
need not change), you may as well provide it when the jar is generated.

To customize written elements, use the embeddedLaunchScriptProperties option of the Spring Boot
Maven plugin or the properties property of the Spring Boot Gradle plugin’s launchScript.

The following property substitutions are supported with the default script:

385
Name Description Gradle default Maven default
mode The script mode. auto auto

initInfo The Provides section of “INIT ${task.baseName} ${project.artifactId}

Provides INFO”

initInfo Required-Start section of $remote_fs $syslog $network $remote_fs $syslog $network

Required “INIT INFO”.
Start
initInfo Required-Stop section of $remote_fs $syslog $network $remote_fs $syslog $network
Required “INIT INFO”.
Stop
initInfo Default-Start section of 2 3 4 5 2 3 4 5
DefaultS “INIT INFO”.
tart
initInfo Default-Stop section of “INIT 0 1 6 0 1 6
DefaultS INFO”.
top
initInfo Short-Description section of Single-line version of ${project.name}
ShortDes “INIT INFO”. ${project.description}
cription
(falling back to
${task.baseName})
initInfo Description section of “INIT ${project.description} ${project.description}
Descript INFO”. (falling back to (falling back to
ion
${task.baseName}) ${project.name})
initInfo chkconfig section of “INIT 2345 99 01 2345 99 01
Chkconfi INFO”
g
confFold The default value for Folder containing the jar Folder containing the jar
er CONF_FOLDER
inlinedC Reference to a file script that
onfScrip should be inlined in the
t
default launch script. This
can be used to set
environmental variables
such as JAVA_OPTS before any
external config files are
loaded
logFolde Default value for LOG_FOLDER.
r Only valid for an init.d
service
logFilen Default value for
ame LOG_FILENAME. Only valid for
an init.d service
pidFolde Default value for PID_FOLDER.
r Only valid for an init.d
service

386
Name Description Gradle default Maven default
pidFilen Default value for the name
ame of the PID file in PID_FOLDER.
Only valid for an init.d
service
useStart Whether the start-stop- true true
StopDaem daemon command, when it is
on
available, should be used to
control the process
stopWait Default value for 60 60
Time STOP_WAIT_TIME in seconds.
Only valid for an init.d
service

Customizing a Script When It Runs

For items of the script that need to be customized after the jar has been written, you can use
environment variables or a config file.

The following environment properties are supported with the default script:

Variable Description
MODE The “mode” of operation. The default depends on the way the jar was built but is
usually auto (meaning it tries to guess if it is an init script by checking if it is a
symlink in a directory called init.d). You can explicitly set it to service so that the
stop|start|status|restart commands work or to run if you want to run the script in
the foreground.
RUN_AS_USER The user that will be used to run the application. When not set, the user that owns
the jar file will be used.
USE_START_ST Whether the start-stop-daemon command, when it is available, should be used to
OP_DAEMON control the process. Defaults to true.
PID_FOLDER The root name of the pid folder (/var/run by default).
LOG_FOLDER The name of the folder in which to put log files (/var/log by default).
CONF_FOLDER The name of the folder from which to read .conf files (same folder as jar-file by
default).
LOG_FILENAME The name of the log file in the LOG_FOLDER (<appname>.log by default).

APP_NAME The name of the app. If the jar is run from a symlink, the script guesses the app
name. If it is not a symlink or you want to explicitly set the app name, this can be
useful.
RUN_ARGS The arguments to pass to the program (the Spring Boot app).
JAVA_HOME The location of the java executable is discovered by using the PATH by default, but
you can set it explicitly if there is an executable file at $JAVA_HOME/bin/java.

387
Variable Description
JAVA_OPTS Options that are passed to the JVM when it is launched.
JARFILE The explicit location of the jar file, in case the script is being used to launch a jar
that it is not actually embedded.
DEBUG If not empty, sets the -x flag on the shell process, allowing you to see the logic in the
script.
STOP_WAIT_TI The time in seconds to wait when stopping the application before forcing a
ME shutdown (60 by default).

The PID_FOLDER, LOG_FOLDER, and LOG_FILENAME variables are only valid for an init.d
NOTE service. For systemd, the equivalent customizations are made by using the ‘service’
script. See the service unit configuration man page for more details.

With the exception of JARFILE and APP_NAME, the settings listed in the preceding section can be
configured by using a .conf file. The file is expected to be next to the jar file and have the same
name but suffixed with .conf rather than .jar. For example, a jar named /var/myapp/myapp.jar uses
the configuration file named /var/myapp/myapp.conf, as shown in the following example:

myapp.conf

JAVA_OPTS=-Xmx1024M
LOG_FOLDER=/custom/log/folder

If you do not like having the config file next to the jar file, you can set a CONF_FOLDER
TIP
environment variable to customize the location of the config file.

To learn about securing this file appropriately, see the guidelines for securing an init.d service.

14.2.3. Microsoft Windows Services

A Spring Boot application can be started as a Windows service by using winsw.

A (separately maintained sample) describes step-by-step how you can create a Windows service for
your Spring Boot application.

14.3. What to Read Next

See the Cloud Foundry, Heroku, OpenShift, and Boxfuse web sites for more information about the
kinds of features that a PaaS can offer. These are just four of the most popular Java PaaS providers.
Since Spring Boot is so amenable to cloud-based deployment, you can freely consider other
providers as well.

The next section goes on to cover the Spring Boot CLI, or you can jump ahead to read about build
tool plugins.

388
Chapter 15. Spring Boot CLI
The Spring Boot CLI is a command line tool that you can use if you want to quickly develop a Spring
application. It lets you run Groovy scripts, which means that you have a familiar Java-like syntax
without so much boilerplate code. You can also bootstrap a new project or write your own
command for it.

15.1. Installing the CLI

The Spring Boot CLI (Command-Line Interface) can be installed manually by using SDKMAN! (the
SDK Manager) or by using Homebrew or MacPorts if you are an OSX user. See Installing the Spring
Boot CLI in the “Getting started” section for comprehensive installation instructions.

15.2. Using the CLI

Once you have installed the CLI, you can run it by typing spring and pressing Enter at the command
line. If you run spring without any arguments, a help screen is displayed, as follows:

$ spring
usage: spring [--help] [--version]
  <command> [<args>]

Available commands are:

  run [options] <files> [--] [args]

  Run a spring groovy script

  _... more command help is shown here_

You can type spring help to get more details about any of the supported commands, as shown in the
following example:

389
 $ spring help run
spring run - Run a spring groovy script

usage: spring run [options] <files> [--] [args]

Option Description
------ -----------
--autoconfigure [Boolean] Add autoconfigure compiler
  transformations (default: true)
--classpath, -cp Additional classpath entries
--no-guess-dependencies Do not attempt to guess dependencies
--no-guess-imports Do not attempt to guess imports
-q, --quiet Quiet logging
-v, --verbose Verbose logging of dependency
  resolution
--watch Watch the specified file for changes

The version command provides a quick way to check which version of Spring Boot you are using, as
follows:

$ spring version
Spring CLI v3.0.0-SNAPSHOT

15.2.1. Running Applications with the CLI

You can compile and run Groovy source code by using the run command. The Spring Boot CLI is
completely self-contained, so you do not need any external Groovy installation.

The following example shows a “hello world” web application written in Groovy:

hello.groovy

@RestController
class WebApplication {

  @RequestMapping("/")
  String home() {
  "Hello World!"
  }

To compile and run the application, type the following command:

$ spring run hello.groovy

390
To pass command-line arguments to the application, use -- to separate the commands from the
“spring” command arguments, as shown in the following example:

$ spring run hello.groovy -- --server.port=9000

To set JVM command line arguments, you can use the JAVA_OPTS environment variable, as shown in
the following example:

$ JAVA_OPTS=-Xmx1024m spring run hello.groovy

When setting JAVA_OPTS on Microsoft Windows, make sure to quote the entire
NOTE instruction, such as set "JAVA_OPTS=-Xms256m -Xmx2048m". Doing so ensures the
values are properly passed to the process.

Deduced “grab” Dependencies

Standard Groovy includes a @Grab annotation, which lets you declare dependencies on third-party
libraries. This useful technique lets Groovy download jars in the same way as Maven or Gradle
would but without requiring you to use a build tool.

Spring Boot extends this technique further and tries to deduce which libraries to “grab” based on
your code. For example, since the WebApplication code shown previously uses @RestController
annotations, Spring Boot grabs "Tomcat" and "Spring MVC".

The following items are used as “grab hints”:

Items Grabs

JdbcTemplate, NamedParameterJdbcTemplate, JDBC Application.

DataSource
@EnableJms JMS Application.
@EnableCaching Caching abstraction.
@Test JUnit.
@EnableRabbit RabbitMQ.

extends Specification Spock test.

@EnableBatchProcessing Spring Batch.

@MessageEndpoint @EnableIntegration Spring Integration.

@Controller @RestController @EnableWebMvc Spring MVC + Embedded Tomcat.

@EnableWebSecurity Spring Security.
@EnableTransactionManagement Spring Transaction Management.

See subclasses of CompilerAutoConfiguration in the Spring Boot CLI source code to

TIP
understand exactly how customizations are applied.

391
Deduced “grab” Coordinates

Spring Boot extends Groovy’s standard @Grab support by letting you specify a dependency without a
group or version (for example, @Grab('freemarker')). Doing so consults Spring Boot’s default
dependency metadata to deduce the artifact’s group and version.

The default metadata is tied to the version of the CLI that you use. It changes only
when you move to a new version of the CLI, putting you in control of when the
NOTE versions of your dependencies may change. A table showing the dependencies and
their versions that are included in the default metadata can be found in the
appendix.

Default Import Statements

To help reduce the size of your Groovy code, several import statements are automatically included.
Notice how the preceding example refers to @Component, @RestController, and @RequestMapping
without needing to use fully-qualified names or import statements.

Many Spring annotations work without using import statements. Try running your
TIP
application to see what fails before adding imports.

Automatic Main Method

Unlike the equivalent Java application, you do not need to include a public static void
main(String[] args) method with your Groovy scripts. A SpringApplication is automatically created,
with your compiled code acting as the source.

Custom Dependency Management

By default, the CLI uses the dependency management declared in spring-boot-dependencies when
resolving @Grab dependencies. Additional dependency management, which overrides the default
dependency management, can be configured by using the @DependencyManagementBom annotation. The
annotation’s value should specify the coordinates (groupId:artifactId:version) of one or more
Maven BOMs.

For example, consider the following declaration:

@DependencyManagementBom("com.example.custom-bom:1.0.0")

The preceding declaration picks up custom-bom-1.0.0.pom in a Maven repository under

com/example/custom-versions/1.0.0/.

When you specify multiple BOMs, they are applied in the order in which you declare them, as
shown in the following example:

392
 @DependencyManagementBom([
  "com.example.custom-bom:1.0.0",
  "com.example.another-bom:1.0.0"])

The preceding example indicates that the dependency management in another-bom overrides the
dependency management in custom-bom.

You can use @DependencyManagementBom anywhere that you can use @Grab. However, to ensure
consistent ordering of the dependency management, you can use @DependencyManagementBom at most
once in your application.

15.2.2. Applications with Multiple Source Files

You can use “shell globbing” with all commands that accept file input. Doing so lets you use
multiple files from a single directory, as shown in the following example:

$ spring run *.groovy

15.2.3. Packaging Your Application

You can use the jar command to package your application into a self-contained executable jar file,
as shown in the following example:

$ spring jar my-app.jar *.groovy

The resulting jar contains the classes produced by compiling the application and all of the
application’s dependencies so that it can then be run by using java -jar. The jar file also contains
entries from the application’s classpath. You can add and remove explicit paths to the jar by using
--include and --exclude. Both are comma-separated, and both accept prefixes, in the form of “+”
and “-”, to signify that they should be removed from the defaults. The default includes are as
follows:

public/**, resources/**, static/**, templates/**, META-INF/**, *

The default excludes are as follows:

.*, repository/**, build/**, target/**, **/*.jar, **/*.groovy

Type spring help jar on the command line for more information.

15.2.4. Initialize a New Project

The init command lets you create a new project by using start.spring.io without leaving the shell,
as shown in the following example:

393
 $ spring init --dependencies=web,data-jpa my-project
Using service at https://start.spring.io
Project extracted to '/Users/developer/example/my-project'

The preceding example creates a my-project directory with a Maven-based project that uses spring-
boot-starter-web and spring-boot-starter-data-jpa. You can list the capabilities of the service by
using the --list flag, as shown in the following example:

$ spring init --list

=======================================
Capabilities of https://start.spring.io
=======================================

Available dependencies:
-----------------------
actuator - Actuator: Production ready features to help you monitor and manage your
application
...
web - Web: Support for full-stack web development, including Tomcat and spring-webmvc
websocket - Websocket: Support for WebSocket development
ws - WS: Support for Spring Web Services

Available project types:

------------------------
gradle-build - Gradle Config [format:build, build:gradle]
gradle-project - Gradle Project [format:project, build:gradle]
maven-build - Maven POM [format:build, build:maven]
maven-project - Maven Project [format:project, build:maven] (default)

...

The init command supports many options. See the help output for more details. For instance, the
following command creates a Gradle project that uses Java 8 and war packaging:

$ spring init --build=gradle --java-version=1.8 --dependencies=websocket

--packaging=war sample-app.zip
Using service at https://start.spring.io
Content saved to 'sample-app.zip'

15.2.5. Using the Embedded Shell

Spring Boot includes command-line completion scripts for the BASH and zsh shells. If you do not
use either of these shells (perhaps you are a Windows user), you can use the shell command to
launch an integrated shell, as shown in the following example:

394
 $ spring shell
Spring Boot (v3.0.0-SNAPSHOT)
Hit TAB to complete. Type \'help' and hit RETURN for help, and \'exit' to quit.

From inside the embedded shell, you can run other commands directly:

$ version
Spring CLI v3.0.0-SNAPSHOT

The embedded shell supports ANSI color output as well as tab completion. If you need to run a
native command, you can use the ! prefix. To exit the embedded shell, press ctrl-c.

15.2.6. Adding Extensions to the CLI

You can add extensions to the CLI by using the install command. The command takes one or more
sets of artifact coordinates in the format group:artifact:version, as shown in the following
example:

$ spring install com.example:spring-boot-cli-extension:1.0.0.RELEASE

In addition to installing the artifacts identified by the coordinates you supply, all of the artifacts'
dependencies are also installed.

To uninstall a dependency, use the uninstall command. As with the install command, it takes one
or more sets of artifact coordinates in the format of group:artifact:version, as shown in the
following example:

$ spring uninstall com.example:spring-boot-cli-extension:1.0.0.RELEASE

It uninstalls the artifacts identified by the coordinates you supply and their dependencies.

To uninstall all additional dependencies, you can use the --all option, as shown in the following
example:

$ spring uninstall --all

15.3. Developing Applications with the Groovy Beans

DSL
Spring Framework 4.0 has native support for a beans{} “DSL” (borrowed from Grails), and you can
embed bean definitions in your Groovy application scripts by using the same format. This is
sometimes a good way to include external features like middleware declarations, as shown in the
following example:

395
 @Configuration(proxyBeanMethods = false)
class Application implements CommandLineRunner {

  @Autowired
  SharedService service

  @Override
  void run(String... args) {
  println service.message
  }

import my.company.SharedService

beans {
  service(SharedService) {
  message = "Hello World"
  }
}

You can mix class declarations with beans{} in the same file as long as they stay at the top level, or,
if you prefer, you can put the beans DSL in a separate file.

15.4. Configuring the CLI with settings.xml

The Spring Boot CLI uses Maven Resolver, Maven’s dependency resolution engine, to resolve
dependencies. The CLI makes use of the Maven configuration found in ~/.m2/settings.xml to
configure Maven Resolver. The following configuration settings are honored by the CLI:

• Offline

• Mirrors

• Servers

• Proxies

• Profiles

◦ Activation

◦ Repositories

• Active profiles

See Maven’s settings documentation for further information.

15.5. What to Read Next

There are some sample groovy scripts available from the GitHub repository that you can use to try
out the Spring Boot CLI. There is also extensive Javadoc throughout the source code.

396
If you find that you reach the limit of the CLI tool, you probably want to look at converting your
application to a full Gradle or Maven built “Groovy project”. The next section covers Spring Boot’s
"Build tool plugins", which you can use with Gradle or Maven.

397
Chapter 16. Build Tool Plugins
Spring Boot provides build tool plugins for Maven and Gradle. The plugins offer a variety of
features, including the packaging of executable jars. This section provides more details on both
plugins as well as some help should you need to extend an unsupported build system. If you are
just getting started, you might want to read “Build Systems” from the “Developing with Spring Boot”
section first.

16.1. Spring Boot Maven Plugin

The Spring Boot Maven Plugin provides Spring Boot support in Maven, letting you package
executable jar or war archives and run an application “in-place”. To use it, you must use Maven 3.2
(or later).

See the plugin’s documentation to learn more:

• Reference (HTML and PDF)

• API

16.2. Spring Boot Gradle Plugin

The Spring Boot Gradle Plugin provides Spring Boot support in Gradle, letting you package
executable jar or war archives, run Spring Boot applications, and use the dependency management
provided by spring-boot-dependencies. It requires Gradle 7.x (7.3 or later). See the plugin’s
documentation to learn more:

• Reference (HTML and PDF)

• API

16.3. Spring Boot AntLib Module

The Spring Boot AntLib module provides basic Spring Boot support for Apache Ant. You can use the
module to create executable jars. To use the module, you need to declare an additional spring-boot
namespace in your build.xml, as shown in the following example:

<project xmlns:ivy="antlib:org.apache.ivy.ant"
  xmlns:spring-boot="antlib:org.springframework.boot.ant"
  name="myapp" default="build">
  ...
</project>

You need to remember to start Ant using the -lib option, as shown in the following example:

$ ant -lib <directory containing spring-boot-antlib-3.0.0-SNAPSHOT.jar>

398
 The “Using Spring Boot” section includes a more complete example of using Apache
TIP
Ant with spring-boot-antlib.

16.3.1. Spring Boot Ant Tasks

Once the spring-boot-antlib namespace has been declared, the following additional tasks are
available:

• Using the “exejar” Task

• Using the “findmainclass” Task

Using the “exejar” Task

You can use the exejar task to create a Spring Boot executable jar. The following attributes are
supported by the task:

Attribute Description Required

destfile The destination jar file to create Yes
classes The root directory of Java class files Yes
start-class The main application class to run No (the default is the first class found
that declares a main method)

The following nested elements can be used with the task:

Element Description
resources One or more Resource Collections describing a set of Resources that should be
added to the content of the created jar file.
lib One or more Resource Collections that should be added to the set of jar
libraries that make up the runtime dependency classpath of the application.

Examples

This section shows two examples of Ant tasks.

Specify start-class

<spring-boot:exejar destfile="target/my-application.jar"
  classes="target/classes" start-class="com.example.MyApplication">
  <resources>
  <fileset dir="src/main/resources" />
  </resources>
  <lib>
  <fileset dir="lib" />
  </lib>
</spring-boot:exejar>

399
Detect start-class

<exejar destfile="target/my-application.jar" classes="target/classes">

  <lib>
  <fileset dir="lib" />
  </lib>
</exejar>

16.3.2. Using the “findmainclass” Task

The findmainclass task is used internally by exejar to locate a class declaring a main. If necessary,
you can also use this task directly in your build. The following attributes are supported:

Attribute Description Required

classesroot The root directory of Java class files Yes (unless mainclass is specified)
mainclass Can be used to short-circuit the main No
class search
property The Ant property that should be set No (result will be logged if unspecified)
with the result

Examples

This section contains three examples of using findmainclass.

Find and log

<findmainclass classesroot="target/classes" />

Find and set

<findmainclass classesroot="target/classes" property="main-class" />

Override and set

<findmainclass mainclass="com.example.MainClass" property="main-class" />

16.4. Supporting Other Build Systems

If you want to use a build tool other than Maven, Gradle, or Ant, you likely need to develop your
own plugin. Executable jars need to follow a specific format and certain entries need to be written
in an uncompressed form (see the “executable jar format” section in the appendix for details).

The Spring Boot Maven and Gradle plugins both make use of spring-boot-loader-tools to actually
generate jars. If you need to, you may use this library directly.

400
16.4.1. Repackaging Archives

To repackage an existing archive so that it becomes a self-contained executable archive, use

org.springframework.boot.loader.tools.Repackager. The Repackager class takes a single constructor
argument that refers to an existing jar or war archive. Use one of the two available repackage()
methods to either replace the original file or write to a new destination. Various settings can also be
configured on the repackager before it is run.

16.4.2. Nested Libraries

When repackaging an archive, you can include references to dependency files by using the
org.springframework.boot.loader.tools.Libraries interface. We do not provide any concrete
implementations of Libraries here as they are usually build-system-specific.

If your archive already includes libraries, you can use Libraries.NONE.

16.4.3. Finding a Main Class

If you do not use Repackager.setMainClass() to specify a main class, the repackager uses ASM to
read class files and tries to find a suitable class with a public static void main(String[] args)
method. An exception is thrown if more than one candidate is found.

16.4.4. Example Repackage Implementation

The following example shows a typical repackage implementation:

401
 import java.io.File;
import java.io.IOException;
import java.util.List;

import org.springframework.boot.loader.tools.Library;
import org.springframework.boot.loader.tools.LibraryCallback;
import org.springframework.boot.loader.tools.LibraryScope;
import org.springframework.boot.loader.tools.Repackager;

public class MyBuildTool {

  public void build() throws IOException {

  File sourceJarFile = ...
  Repackager repackager = new Repackager(sourceJarFile);
  repackager.setBackupSource(false);
  repackager.repackage(this::getLibraries);
  }

  private void getLibraries(LibraryCallback callback) throws IOException {

  // Build system specific implementation, callback for each dependency
  for (File nestedJar : getCompileScopeJars()) {
  callback.library(new Library(nestedJar, LibraryScope.COMPILE));
  }
  // ...
  }

  private List<File> getCompileScopeJars() {

  return ...
  }

16.5. What to Read Next

If you are interested in how the build tool plugins work, you can look at the spring-boot-tools
module on GitHub. More technical details of the executable jar format are covered in the appendix.

If you have specific build-related questions, see the “how-to” guides.

402
Chapter 17. “How-to” Guides
This section provides answers to some common ‘how do I do that…’ questions that often arise when
using Spring Boot. Its coverage is not exhaustive, but it does cover quite a lot.

If you have a specific problem that we do not cover here, you might want to check
stackoverflow.com to see if someone has already provided an answer. This is also a great place to
ask new questions (please use the spring-boot tag).

We are also more than happy to extend this section. If you want to add a ‘how-to’, send us a pull
request.

17.1. Spring Boot Application

This section includes topics relating directly to Spring Boot applications.

17.1.1. Create Your Own FailureAnalyzer

FailureAnalyzer is a great way to intercept an exception on startup and turn it into a human-
readable message, wrapped in a FailureAnalysis. Spring Boot provides such an analyzer for
application-context-related exceptions, JSR-303 validations, and more. You can also create your
own.

AbstractFailureAnalyzer is a convenient extension of FailureAnalyzer that checks the presence of a

specified exception type in the exception to handle. You can extend from that so that your
implementation gets a chance to handle the exception only when it is actually present. If, for
whatever reason, you cannot handle the exception, return null to give another implementation a
chance to handle the exception.

FailureAnalyzer implementations must be registered in META-INF/spring.factories. The following

example registers ProjectConstraintViolationFailureAnalyzer:

org.springframework.boot.diagnostics.FailureAnalyzer=\
com.example.ProjectConstraintViolationFailureAnalyzer

If you need access to the BeanFactory or the Environment, your FailureAnalyzer can
NOTE
implement BeanFactoryAware or EnvironmentAware respectively.

17.1.2. Troubleshoot Auto-configuration

The Spring Boot auto-configuration tries its best to “do the right thing”, but sometimes things fail,
and it can be hard to tell why.

There is a really useful ConditionEvaluationReport available in any Spring Boot ApplicationContext.

You can see it if you enable DEBUG logging output. If you use the spring-boot-actuator (see the
Actuator chapter), there is also a conditions endpoint that renders the report in JSON. Use that
endpoint to debug the application and see what features have been added (and which have not

403
been added) by Spring Boot at runtime.

Many more questions can be answered by looking at the source code and the Javadoc. When
reading the code, remember the following rules of thumb:

• Look for classes called *AutoConfiguration and read their sources. Pay special attention to the
@Conditional* annotations to find out what features they enable and when. Add --debug to the
command line or a System property -Ddebug to get a log on the console of all the auto-
configuration decisions that were made in your app. In a running application with actuator
enabled, look at the conditions endpoint (/actuator/conditions or the JMX equivalent) for the
same information.

• Look for classes that are @ConfigurationProperties (such as ServerProperties) and read from
there the available external configuration options. The @ConfigurationProperties annotation has
a name attribute that acts as a prefix to external properties. Thus, ServerProperties has
prefix="server" and its configuration properties are server.port, server.address, and others. In
a running application with actuator enabled, look at the configprops endpoint.

• Look for uses of the bind method on the Binder to pull configuration values explicitly out of the
Environment in a relaxed manner. It is often used with a prefix.

• Look for @Value annotations that bind directly to the Environment.

• Look for @ConditionalOnExpression annotations that switch features on and off in response to
SpEL expressions, normally evaluated with placeholders resolved from the Environment.

17.1.3. Customize the Environment or ApplicationContext Before It Starts

A SpringApplication has ApplicationListeners and ApplicationContextInitializers that are used to

apply customizations to the context or environment. Spring Boot loads a number of such
customizations for use internally from META-INF/spring.factories. There is more than one way to
register additional customizations:

• Programmatically, per application, by calling the addListeners and addInitializers methods on

SpringApplication before you run it.

• Declaratively, per application, by setting the context.initializer.classes or

context.listener.classes properties.

• Declaratively, for all applications, by adding a META-INF/spring.factories and packaging a jar

file that the applications all use as a library.

The SpringApplication sends some special ApplicationEvents to the listeners (some even before the
context is created) and then registers the listeners for events published by the ApplicationContext as
well. See “Application Events and Listeners” in the ‘Spring Boot features’ section for a complete list.

It is also possible to customize the Environment before the application context is refreshed by using
EnvironmentPostProcessor. Each implementation should be registered in META-INF/spring.factories,
as shown in the following example:

org.springframework.boot.env.EnvironmentPostProcessor=com.example.YourEnvironmentPostP
rocessor

404
The implementation can load arbitrary files and add them to the Environment. For instance, the
following example loads a YAML configuration file from the classpath:

import java.io.IOException;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.util.Assert;

public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor {

  private final YamlPropertySourceLoader loader = new YamlPropertySourceLoader();

  @Override
  public void postProcessEnvironment(ConfigurableEnvironment environment,
SpringApplication application) {
  Resource path = new ClassPathResource("com/example/myapp/config.yml");
  PropertySource<?> propertySource = loadYaml(path);
  environment.getPropertySources().addLast(propertySource);
  }

  private PropertySource<?> loadYaml(Resource path) {

  Assert.isTrue(path.exists(), () -> "Resource " + path + " does not exist");
  try {
  return this.loader.load("custom-resource", path).get(0);
  }
  catch (IOException ex) {
  throw new IllegalStateException("Failed to load yaml configuration from "
+ path, ex);
  }
  }

The Environment has already been prepared with all the usual property sources that
Spring Boot loads by default. It is therefore possible to get the location of the file from
TIP the environment. The preceding example adds the custom-resource property source at
the end of the list so that a key defined in any of the usual other locations takes
precedence. A custom implementation may define another order.

405
 While using @PropertySource on your @SpringBootApplication may seem to be a
convenient way to load a custom resource in the Environment, we do not
recommend it. Such property sources are not added to the Environment until the
CAUTION
application context is being refreshed. This is too late to configure certain
properties such as logging.* and spring.main.* which are read before refresh
begins.

17.1.4. Build an ApplicationContext Hierarchy (Adding a Parent or Root

Context)

You can use the ApplicationBuilder class to create parent/child ApplicationContext hierarchies. See
“Fluent Builder API” in the ‘Spring Boot features’ section for more information.

17.1.5. Create a Non-web Application

Not all Spring applications have to be web applications (or web services). If you want to execute
some code in a main method but also bootstrap a Spring application to set up the infrastructure to
use, you can use the SpringApplication features of Spring Boot. A SpringApplication changes its
ApplicationContext class, depending on whether it thinks it needs a web application or not. The first
thing you can do to help it is to leave server-related dependencies (such as the servlet API) off the
classpath. If you cannot do that (for example, you run two applications from the same code base)
then you can explicitly call setWebApplicationType(WebApplicationType.NONE) on your
SpringApplication instance or set the applicationContextClass property (through the Java API or
with external properties). Application code that you want to run as your business logic can be
implemented as a CommandLineRunner and dropped into the context as a @Bean definition.

17.2. Properties and Configuration

This section includes topics about setting and reading properties and configuration settings and
their interaction with Spring Boot applications.

17.2.1. Automatically Expand Properties at Build Time

Rather than hardcoding some properties that are also specified in your project’s build
configuration, you can automatically expand them by instead using the existing build
configuration. This is possible in both Maven and Gradle.

Automatic Property Expansion Using Maven

You can automatically expand properties from the Maven project by using resource filtering. If you
use the spring-boot-starter-parent, you can then refer to your Maven ‘project properties’ with @..@
placeholders, as shown in the following example:

Properties

app.encoding=@project.build.sourceEncoding@
app.java.version=@java.version@

406
Yaml

app:
  encoding: "@project.build.sourceEncoding@"
  java:
  version: "@java.version@"

Only production configuration is filtered that way (in other words, no filtering is
NOTE
applied on src/test/resources).

If you enable the addResources flag, the spring-boot:run goal can add
src/main/resources directly to the classpath (for hot reloading purposes). Doing so
TIP circumvents the resource filtering and this feature. Instead, you can use the exec:java
goal or customize the plugin’s configuration. See the plugin usage page for more
details.

If you do not use the starter parent, you need to include the following element inside the <build/>
element of your pom.xml:

<resources>
  <resource>
  <directory>src/main/resources</directory>
  <filtering>true</filtering>
  </resource>
</resources>

You also need to include the following element inside <plugins/>:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-resources-plugin</artifactId>
  <version>2.7</version>
  <configuration>
  <delimiters>
  <delimiter>@</delimiter>
  </delimiters>
  <useDefaultDelimiters>false</useDefaultDelimiters>
  </configuration>
</plugin>

The useDefaultDelimiters property is important if you use standard Spring

NOTE placeholders (such as ${placeholder}) in your configuration. If that property is not
set to false, these may be expanded by the build.

407
Automatic Property Expansion Using Gradle

You can automatically expand properties from the Gradle project by configuring the Java plugin’s
processResources task to do so, as shown in the following example:

processResources {
  expand(project.properties)
}

You can then refer to your Gradle project’s properties by using placeholders, as shown in the
following example:

Properties

app.name=${name}
app.description=${description}

Yaml

app:
  name: "${name}"
  description: "${description}"

Gradle’s expand method uses Groovy’s SimpleTemplateEngine, which transforms ${..}

tokens. The ${..} style conflicts with Spring’s own property placeholder
NOTE
mechanism. To use Spring property placeholders together with automatic
expansion, escape the Spring property placeholders as follows: \${..}.

17.2.2. Externalize the Configuration of SpringApplication

A SpringApplication has bean property setters, so you can use its Java API as you create the
application to modify its behavior. Alternatively, you can externalize the configuration by setting
properties in spring.main.*. For example, in application.properties, you might have the following
settings:

Properties

spring.main.web-application-type=none
spring.main.banner-mode=off

Yaml

spring:
  main:
  web-application-type: "none"
  banner-mode: "off"

408
Then the Spring Boot banner is not printed on startup, and the application is not starting an
embedded web server.

Properties defined in external configuration override and replace the values specified with the Java
API, with the notable exception of the primary sources. Primary sources are those provided to the
SpringApplication constructor:

import org.springframework.boot.Banner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

  public static void main(String[] args) {

  SpringApplication application = new SpringApplication(MyApplication.class);
  application.setBannerMode(Banner.Mode.OFF);
  application.run(args);
  }

Or to sources(…) method of a SpringApplicationBuilder:

import org.springframework.boot.Banner;
import org.springframework.boot.builder.SpringApplicationBuilder;

public class MyApplication {

  public static void main(String[] args) {

  new SpringApplicationBuilder()
  .bannerMode(Banner.Mode.OFF)
  .sources(MyApplication.class)
  .run(args);
  }

Given the examples above, if we have the following configuration:

Properties

spring.main.sources=com.example.MyDatabaseConfig,com.example.MyJmsConfig
spring.main.banner-mode=console

409
Yaml

spring:
  main:
  sources: "com.example.MyDatabaseConfig,com.example.MyJmsConfig"
  banner-mode: "console"

The actual application will show the banner (as overridden by configuration) and uses three
sources for the ApplicationContext. The application sources are:

1. MyApplication (from the code)

2. MyDatabaseConfig (from the external config)

3. MyJmsConfig(from the external config)

17.2.3. Change the Location of External Properties of an Application

By default, properties from different sources are added to the Spring Environment in a defined order
(see “Externalized Configuration” in the ‘Spring Boot features’ section for the exact order).

You can also provide the following System properties (or environment variables) to change the
behavior:

• spring.config.name (SPRING_CONFIG_NAME): Defaults to application as the root of the file name.

• spring.config.location (SPRING_CONFIG_LOCATION): The file to load (such as a classpath resource

or a URL). A separate Environment property source is set up for this document and it can be
overridden by system properties, environment variables, or the command line.

No matter what you set in the environment, Spring Boot always loads application.properties as
described above. By default, if YAML is used, then files with the ‘.yml’ extension are also added to
the list.

Spring Boot logs the configuration files that are loaded at the DEBUG level and the candidates it has
not found at TRACE level.

See ConfigFileApplicationListener for more detail.

17.2.4. Use ‘Short’ Command Line Arguments

Some people like to use (for example) --port=9000 instead of --server.port=9000 to set configuration
properties on the command line. You can enable this behavior by using placeholders in
application.properties, as shown in the following example:

Properties

server.port=${port:8080}

410
Yaml

server:
  port: "${port:8080}"

If you inherit from the spring-boot-starter-parent POM, the default filter token of the
maven-resources-plugins has been changed from ${*} to @ (that is, @maven.token@
TIP instead of ${maven.token}) to prevent conflicts with Spring-style placeholders. If you
have enabled Maven filtering for the application.properties directly, you may want to
also change the default filter token to use other delimiters.

In this specific case, the port binding works in a PaaS environment such as Heroku
or Cloud Foundry. In those two platforms, the PORT environment variable is set
NOTE
automatically and Spring can bind to capitalized synonyms for Environment
properties.

17.2.5. Use YAML for External Properties

YAML is a superset of JSON and, as such, is a convenient syntax for storing external properties in a
hierarchical format, as shown in the following example:

spring:
  application:
  name: "cruncher"
  datasource:
  driver-class-name: "com.mysql.jdbc.Driver"
  url: "jdbc:mysql://localhost/test"
server:
  port: 9000

Create a file called application.yml and put it in the root of your classpath. Then add snakeyaml to
your dependencies (Maven coordinates org.yaml:snakeyaml, already included if you use the spring-
boot-starter). A YAML file is parsed to a Java Map<String,Object> (like a JSON object), and Spring
Boot flattens the map so that it is one level deep and has period-separated keys, as many people are
used to with Properties files in Java.

The preceding example YAML corresponds to the following application.properties file:

spring.application.name=cruncher
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost/test
server.port=9000

See “Working with YAML” in the ‘Spring Boot features’ section for more information about YAML.

411
17.2.6. Set the Active Spring Profiles

The Spring Environment has an API for this, but you would normally set a System property
(spring.profiles.active) or an OS environment variable (SPRING_PROFILES_ACTIVE). Also, you can
launch your application with a -D argument (remember to put it before the main class or jar
archive), as follows:

$ java -jar -Dspring.profiles.active=production demo-0.0.1-SNAPSHOT.jar

In Spring Boot, you can also set the active profile in application.properties, as shown in the
following example:

Properties

spring.profiles.active=production

Yaml

spring:
  profiles:
  active: "production"

A value set this way is replaced by the System property or environment variable setting but not by
the SpringApplicationBuilder.profiles() method. Thus, the latter Java API can be used to augment
the profiles without changing the defaults.

See “Profiles” in the “Spring Boot features” section for more information.

17.2.7. Set the Default Profile Name

The default profile is a profile that is enabled if no profile is active. By default, the name of the
default profile is default, but it could be changed using a System property (spring.profiles.default)
or an OS environment variable (SPRING_PROFILES_DEFAULT).

In Spring Boot, you can also set the default profile name in application.properties, as shown in the
following example:

Properties

spring.profiles.default=dev

Yaml

spring:
  profiles:
  default: "dev"

412
See “Profiles” in the “Spring Boot features” section for more information.

17.2.8. Change Configuration Depending on the Environment

Spring Boot supports multi-document YAML and Properties files (see Working with Multi-Document
Files for details) which can be activated conditionally based on the active profiles.

If a document contains a spring.config.activate.on-profile key, then the profiles value (a comma-

separated list of profiles or a profile expression) is fed into the Spring
Environment.acceptsProfiles() method. If the profile expression matches then that document is
included in the final merge (otherwise, it is not), as shown in the following example:

Properties

server.port=9000
#---
spring.config.activate.on-profile=development
server.port=9001
#---
spring.config.activate.on-profile=production
server.port=0

Yaml

server:
  port: 9000
---
spring:
  config:
  activate:
  on-profile: "development"
server:
  port: 9001
---
spring:
  config:
  activate:
  on-profile: "production"
server:
  port: 0

In the preceding example, the default port is 9000. However, if the Spring profile called
‘development’ is active, then the port is 9001. If ‘production’ is active, then the port is 0.

The documents are merged in the order in which they are encountered. Later
NOTE
values override earlier values.

413
17.2.9. Discover Built-in Options for External Properties

Spring Boot binds external properties from application.properties (or .yml files and other places)
into an application at runtime. There is not (and technically cannot be) an exhaustive list of all
supported properties in a single location, because contributions can come from additional jar files
on your classpath.

A running application with the Actuator features has a configprops endpoint that shows all the
bound and bindable properties available through @ConfigurationProperties.

The appendix includes an application.properties example with a list of the most common
properties supported by Spring Boot. The definitive list comes from searching the source code for
@ConfigurationProperties and @Value annotations as well as the occasional use of Binder. For more
about the exact ordering of loading properties, see "Externalized Configuration".

17.3. Embedded Web Servers

Each Spring Boot web application includes an embedded web server. This feature leads to a
number of how-to questions, including how to change the embedded server and how to configure
the embedded server. This section answers those questions.

17.3.1. Use Another Web Server

Many Spring Boot starters include default embedded containers.

• For servlet stack applications, the spring-boot-starter-web includes Tomcat by including spring-
boot-starter-tomcat, but you can use spring-boot-starter-jetty or spring-boot-starter-
undertow instead.

• For reactive stack applications, the spring-boot-starter-webflux includes Reactor Netty by

including spring-boot-starter-reactor-netty, but you can use spring-boot-starter-tomcat,
spring-boot-starter-jetty, or spring-boot-starter-undertow instead.

When switching to a different HTTP server, you need to swap the default dependencies for those
that you need instead. To help with this process, Spring Boot provides a separate starter for each of
the supported HTTP servers.

The following Maven example shows how to exclude Tomcat and include Jetty for Spring MVC:

414
 <properties>
  <servlet-api.version>3.1.0</servlet-api.version>
</properties>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <exclusions>
  <!-- Exclude the Tomcat dependency -->
  <exclusion>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-tomcat</artifactId>
  </exclusion>
  </exclusions>
</dependency>
<!-- Use Jetty instead -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-jetty</artifactId>
</dependency>

The version of the servlet API has been overridden as, unlike Tomcat 9 and
Undertow 2, Jetty 9.4 does not support servlet 4.0. If you wish to use Jetty 10, which
NOTE
does support servlet 4.0, override the jetty.version property rather than the
servlet-api.version property.

The following Gradle example configures the necessary dependencies and a module replacement to
use Undertow in place of Reactor Netty for Spring WebFlux:

dependencies {
  implementation "org.springframework.boot:spring-boot-starter-undertow"
  implementation "org.springframework.boot:spring-boot-starter-webflux"
  modules {
  module("org.springframework.boot:spring-boot-starter-reactor-netty") {
  replacedBy("org.springframework.boot:spring-boot-starter-undertow", "Use
Undertow instead of Reactor Netty")
  }
  }
}

spring-boot-starter-reactor-netty is required to use the WebClient class, so you may

NOTE need to keep a dependency on Netty even when you need to include a different
HTTP server.

17.3.2. Disabling the Web Server

If your classpath contains the necessary bits to start a web server, Spring Boot will automatically
start it. To disable this behavior configure the WebApplicationType in your application.properties, as

415
shown in the following example:

Properties

spring.main.web-application-type=none

Yaml

spring:
  main:
  web-application-type: "none"

17.3.3. Change the HTTP Port

In a standalone application, the main HTTP port defaults to 8080 but can be set with server.port (for
example, in application.properties or as a System property). Thanks to relaxed binding of
Environment values, you can also use SERVER_PORT (for example, as an OS environment variable).

To switch off the HTTP endpoints completely but still create a WebApplicationContext, use
server.port=-1 (doing so is sometimes useful for testing).

For more details, see “Customizing Embedded Servlet Containers” in the ‘Spring Boot Features’
section, or the ServerProperties source code.

17.3.4. Use a Random Unassigned HTTP Port

To scan for a free port (using OS natives to prevent clashes) use server.port=0.

17.3.5. Discover the HTTP Port at Runtime

You can access the port the server is running on from log output or from the
WebServerApplicationContext through its WebServer. The best way to get that and be sure it has been
initialized is to add a @Bean of type ApplicationListener<WebServerInitializedEvent> and pull the
container out of the event when it is published.

Tests that use @SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT) can also inject the

actual port into a field by using the @LocalServerPort annotation, as shown in the following
example:

416
 import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.web.server.LocalServerPort;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
public class MyWebIntegrationTests {

  @LocalServerPort
  int port;

  // ...

@LocalServerPort is a meta-annotation for @Value("${local.server.port}"). Do not

try to inject the port in a regular application. As we just saw, the value is set only
NOTE
after the container has been initialized. Contrary to a test, application code
callbacks are processed early (before the value is actually available).

17.3.6. Enable HTTP Response Compression

HTTP response compression is supported by Jetty, Tomcat, and Undertow. It can be enabled in
application.properties, as follows:

Properties

server.compression.enabled=true

Yaml

server:
  compression:
  enabled: true

By default, responses must be at least 2048 bytes in length for compression to be performed. You
can configure this behavior by setting the server.compression.min-response-size property.

By default, responses are compressed only if their content type is one of the following:

• text/html

• text/xml

• text/plain

• text/css

• text/javascript

• application/javascript

417
 • application/json

• application/xml

You can configure this behavior by setting the server.compression.mime-types property.

17.3.7. Configure SSL

SSL can be configured declaratively by setting the various server.ssl.* properties, typically in
application.properties or application.yml. The following example shows setting SSL properties in
application.properties:

Properties

server.port=8443
server.ssl.key-store=classpath:keystore.jks
server.ssl.key-store-password=secret
server.ssl.key-password=another-secret

Yaml

server:
  port: 8443
  ssl:
  key-store: "classpath:keystore.jks"
  key-store-password: "secret"
  key-password: "another-secret"

See Ssl for details of all of the supported properties.

Using configuration such as the preceding example means the application no longer supports a
plain HTTP connector at port 8080. Spring Boot does not support the configuration of both an HTTP
connector and an HTTPS connector through application.properties. If you want to have both, you
need to configure one of them programmatically. We recommend using application.properties to
configure HTTPS, as the HTTP connector is the easier of the two to configure programmatically.

17.3.8. Configure HTTP/2

You can enable HTTP/2 support in your Spring Boot application with the server.http2.enabled
configuration property. Both h2 (HTTP/2 over TLS) and h2c (HTTP/2 over TCP) are supported. To use
h2, SSL must also be enabled. When SSL is not enabled, h2c will be used. The details of the h2
support depend on the chosen web server and the application environment, since that protocol is
not supported out-of-the-box by all JDK 8 releases.

HTTP/2 with Tomcat

Spring Boot ships by default with Tomcat 9.0.x which supports h2c out of the box and h2 out of the
box when using JDK 9 or later. Alternatively, h2 can be used on JDK 8 if the libtcnative library and
its dependencies are installed on the host operating system.

418
The library directory must be made available, if not already, to the JVM library path. You can do so
with a JVM argument such as -Djava.library.path=/usr/local/opt/tomcat-native/lib. More on this
in the official Tomcat documentation.

Starting Tomcat 9.0.x on JDK 8 with HTTP/2 and SSL enabled but without that native support logs
the following error:

ERROR 8787 --- [ main] o.a.coyote.http11.Http11NioProtocol : The

upgrade handler [org.apache.coyote.http2.Http2Protocol] for [h2] only supports upgrade
via ALPN but has been configured for the ["https-jsse-nio-8443"] connector that does
not support ALPN.

This error is not fatal, and the application still starts with HTTP/1.1 SSL support.

HTTP/2 with Jetty

For HTTP/2 support, Jetty requires the additional org.eclipse.jetty.http2:http2-server

dependency. To use h2c no other dependencies are required. To use h2, you also need to choose one
of the following dependencies, depending on your deployment:

• org.eclipse.jetty:jetty-alpn-java-server for applications running on JDK9+

• org.eclipse.jetty:jetty-alpn-openjdk8-server for applications running on JDK8u252+

• org.eclipse.jetty:jetty-alpn-conscrypt-server and the Conscrypt library with no JDK

requirement

HTTP/2 with Reactor Netty

The spring-boot-webflux-starter is using by default Reactor Netty as a server. Reactor Netty

supports h2c using JDK 8 or later with no additional dependencies. Reactor Netty supports h2 using
the JDK support with JDK 9 or later. For JDK 8 environments, or for optimal runtime performance,
this server also supports h2 with native libraries. To enable that, your application needs to have an
additional dependency.

Spring Boot manages the version for the io.netty:netty-tcnative-boringssl-static "uber jar",
containing native libraries for all platforms. Developers can choose to import only the required
dependencies using a classifier (see the Netty official documentation).

HTTP/2 with Undertow

As of Undertow 1.4.0+, both h2 and h2c are supported on JDK 8 without any additional
dependencies.

17.3.9. Configure the Web Server

Generally, you should first consider using one of the many available configuration keys and
customize your web server by adding new entries in your application.properties or
application.yml file. See “Discover Built-in Options for External Properties”). The server.*
namespace is quite useful here, and it includes namespaces like server.tomcat.*, server.jetty.*

419
and others, for server-specific features. See the list of Common Application Properties.

The previous sections covered already many common use cases, such as compression, SSL or
HTTP/2. However, if a configuration key does not exist for your use case, you should then look at
WebServerFactoryCustomizer. You can declare such a component and get access to the server factory
relevant to your choice: you should select the variant for the chosen Server (Tomcat, Jetty, Reactor
Netty, Undertow) and the chosen web stack (servlet or reactive).

The example below is for Tomcat with the spring-boot-starter-web (servlet stack):

import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.stereotype.Component;

@Component
public class MyTomcatWebServerCustomizer implements
WebServerFactoryCustomizer<TomcatServletWebServerFactory> {

  @Override
  public void customize(TomcatServletWebServerFactory factory) {
  // customize the factory here
  }

Spring Boot uses that infrastructure internally to auto-configure the server. Auto-
configured WebServerFactoryCustomizer beans have an order of 0 and will be
NOTE
processed before any user-defined customizers, unless it has an explicit order that
states otherwise.

Once you have got access to a WebServerFactory using the customizer, you can use it to configure
specific parts, like connectors, server resources, or the server itself - all using server-specific APIs.

In addition Spring Boot provides:

Server Servlet stack Reactive stack

Tomcat TomcatServletWebServerFactory TomcatReactiveWebServerFactory

Jetty JettyServletWebServerFactory JettyReactiveWebServerFactory

Undertow UndertowServletWebServerFactory UndertowReactiveWebServerFactory

Reactor N/A NettyReactiveWebServerFactory

As a last resort, you can also declare your own WebServerFactory bean, which will override the one
provided by Spring Boot. When you do so, auto-configured customizers are still applied on your
custom factory, so use that option carefully.

420
17.3.10. Add a Servlet, Filter, or Listener to an Application

In a servlet stack application, that is with the spring-boot-starter-web, there are two ways to add
Servlet, Filter, ServletContextListener, and the other listeners supported by the Servlet API to your
application:

• Add a Servlet, Filter, or Listener by Using a Spring Bean

• Add Servlets, Filters, and Listeners by Using Classpath Scanning

Add a Servlet, Filter, or Listener by Using a Spring Bean

To add a Servlet, Filter, or servlet *Listener by using a Spring bean, you must provide a @Bean
definition for it. Doing so can be very useful when you want to inject configuration or
dependencies. However, you must be very careful that they do not cause eager initialization of too
many other beans, because they have to be installed in the container very early in the application
lifecycle. (For example, it is not a good idea to have them depend on your DataSource or JPA
configuration.) You can work around such restrictions by initializing the beans lazily when first
used instead of on initialization.

In the case of filters and servlets, you can also add mappings and init parameters by adding a
FilterRegistrationBean or a ServletRegistrationBean instead of or in addition to the underlying
component.

If no dispatcherType is specified on a filter registration, REQUEST is used. This aligns

NOTE
with the servlet specification’s default dispatcher type.

Like any other Spring bean, you can define the order of servlet filter beans; please make sure to
check the “Registering Servlets, Filters, and Listeners as Spring Beans” section.

Disable Registration of a Servlet or Filter

As described earlier, any Servlet or Filter beans are registered with the servlet container
automatically. To disable registration of a particular Filter or Servlet bean, create a registration
bean for it and mark it as disabled, as shown in the following example:

421
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyFilterConfiguration {

  @Bean
  public FilterRegistrationBean<MyFilter> registration(MyFilter filter) {
  FilterRegistrationBean<MyFilter> registration = new
FilterRegistrationBean<>(filter);
  registration.setEnabled(false);
  return registration;
  }

Add Servlets, Filters, and Listeners by Using Classpath Scanning

@WebServlet, @WebFilter, and @WebListener annotated classes can be automatically registered with an
embedded servlet container by annotating a @Configuration class with @ServletComponentScan and
specifying the package(s) containing the components that you want to register. By default,
@ServletComponentScan scans from the package of the annotated class.

17.3.11. Configure Access Logging

Access logs can be configured for Tomcat, Undertow, and Jetty through their respective
namespaces.

For instance, the following settings log access on Tomcat with a custom pattern.

Properties

server.tomcat.basedir=my-tomcat
server.tomcat.accesslog.enabled=true
server.tomcat.accesslog.pattern=%t %a %r %s (%D ms)

Yaml

server:
  tomcat:
  basedir: "my-tomcat"
  accesslog:
  enabled: true
  pattern: "%t %a %r %s (%D ms)"

422
 The default location for logs is a logs directory relative to the Tomcat base directory.
By default, the logs directory is a temporary directory, so you may want to fix
NOTE Tomcat’s base directory or use an absolute path for the logs. In the preceding
example, the logs are available in my-tomcat/logs relative to the working directory
of the application.

Access logging for Undertow can be configured in a similar fashion, as shown in the following
example:

Properties

server.undertow.accesslog.enabled=true
server.undertow.accesslog.pattern=%t %a %r %s (%D ms)

Yaml

server:
  undertow:
  accesslog:
  enabled: true
  pattern: "%t %a %r %s (%D ms)"

Logs are stored in a logs directory relative to the working directory of the application. You can
customize this location by setting the server.undertow.accesslog.dir property.

Finally, access logging for Jetty can also be configured as follows:

Properties

server.jetty.accesslog.enabled=true
server.jetty.accesslog.filename=/var/log/jetty-access.log

Yaml

server:
  jetty:
  accesslog:
  enabled: true
  filename: "/var/log/jetty-access.log"

By default, logs are redirected to System.err. For more details, see the Jetty documentation.

17.3.12. Running Behind a Front-end Proxy Server

If your application is running behind a proxy, a load-balancer or in the cloud, the request
information (like the host, port, scheme…) might change along the way. Your application may be
running on 10.10.10.10:8080, but HTTP clients should only see example.org.

423
RFC7239 "Forwarded Headers" defines the Forwarded HTTP header; proxies can use this header to
provide information about the original request. You can configure your application to read those
headers and automatically use that information when creating links and sending them to clients in
HTTP 302 responses, JSON documents or HTML pages. There are also non-standard headers, like X-
Forwarded-Host, X-Forwarded-Port, X-Forwarded-Proto, X-Forwarded-Ssl, and X-Forwarded-Prefix.

If the proxy adds the commonly used X-Forwarded-For and X-Forwarded-Proto headers, setting
server.forward-headers-strategy to NATIVE is enough to support those. With this option, the Web
servers themselves natively support this feature; you can check their specific documentation to
learn about specific behavior.

If this is not enough, Spring Framework provides a ForwardedHeaderFilter. You can register it as a
servlet filter in your application by setting server.forward-headers-strategy is set to FRAMEWORK.

If you are using Tomcat and terminating SSL at the proxy, server.tomcat.redirect-
TIP context-root should be set to false. This allows the X-Forwarded-Proto header to be
honored before any redirects are performed.

If your application runs in Cloud Foundry or Heroku, the server.forward-headers-

NOTE
strategy property defaults to NATIVE. In all other instances, it defaults to NONE.

Customize Tomcat’s Proxy Configuration

If you use Tomcat, you can additionally configure the names of the headers used to carry
“forwarded” information, as shown in the following example:

Properties

server.tomcat.remoteip.remote-ip-header=x-your-remote-ip-header
server.tomcat.remoteip.protocol-header=x-your-protocol-header

Yaml

server:
  tomcat:
  remoteip:
  remote-ip-header: "x-your-remote-ip-header"
  protocol-header: "x-your-protocol-header"

Tomcat is also configured with a default regular expression that matches internal proxies that are
to be trusted. By default, IP addresses in 10/8, 192.168/16, 169.254/16 and 127/8 are trusted. You can
customize the valve’s configuration by adding an entry to application.properties, as shown in the
following example:

Properties

server.tomcat.remoteip.internal-proxies=192\\.168\\.\\d{1,3}\\.\\d{1,3}

424
Yaml

server:
  tomcat:
  remoteip:
  internal-proxies: "192\\.168\\.\\d{1,3}\\.\\d{1,3}"

You can trust all proxies by setting the internal-proxies to empty (but do not do so
NOTE
in production).

You can take complete control of the configuration of Tomcat’s RemoteIpValve by switching the
automatic one off (to do so, set server.forward-headers-strategy=NONE) and adding a new valve
instance using a WebServerFactoryCustomizer bean.

17.3.13. Enable Multiple Connectors with Tomcat

You can add an org.apache.catalina.connector.Connector to the TomcatServletWebServerFactory,

which can allow multiple connectors, including HTTP and HTTPS connectors, as shown in the
following example:

import org.apache.catalina.connector.Connector;

import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyTomcatConfiguration {

  @Bean
  public WebServerFactoryCustomizer<TomcatServletWebServerFactory>
sslConnectorCustomizer() {
  return (tomcat) ->
tomcat.addAdditionalTomcatConnectors(createConnectorConnector());
  }

  private Connector createConnectorConnector() {

  Connector connector = new
Connector("org.apache.coyote.http11.Http11NioProtocol");
  connector.setPort(8080);
  return connector;
  }

425
17.3.14. Use Tomcat’s LegacyCookieProcessor

By default, the embedded Tomcat used by Spring Boot does not support "Version 0" of the Cookie
format, so you may see the following error:

java.lang.IllegalArgumentException: An invalid character [32] was present in the

Cookie value

If at all possible, you should consider updating your code to only store values compliant with later
Cookie specifications. If, however, you cannot change the way that cookies are written, you can
instead configure Tomcat to use a LegacyCookieProcessor. To switch to the LegacyCookieProcessor,
use an WebServerFactoryCustomizer bean that adds a TomcatContextCustomizer, as shown in the
following example:

import org.apache.tomcat.util.http.LegacyCookieProcessor;

import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyLegacyCookieProcessorConfiguration {

  @Bean
  public WebServerFactoryCustomizer<TomcatServletWebServerFactory>
cookieProcessorCustomizer() {
  return (factory) -> factory
  .addContextCustomizers((context) -> context.setCookieProcessor(new
LegacyCookieProcessor()));
  }

17.3.15. Enable Tomcat’s MBean Registry

Embedded Tomcat’s MBean registry is disabled by default. This minimizes Tomcat’s memory
footprint. If you want to use Tomcat’s MBeans, for example so that they can be used by Micrometer
to expose metrics, you must use the server.tomcat.mbeanregistry.enabled property to do so, as
shown in the following example:

Properties

server.tomcat.mbeanregistry.enabled=true

426
Yaml

server:
  tomcat:
  mbeanregistry:
  enabled: true

17.3.16. Enable Multiple Listeners with Undertow

Add an UndertowBuilderCustomizer to the UndertowServletWebServerFactory and add a listener to the

Builder, as shown in the following example:

import io.undertow.Undertow.Builder;

import org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyUndertowConfiguration {

  @Bean
  public WebServerFactoryCustomizer<UndertowServletWebServerFactory>
undertowListenerCustomizer() {
  return (factory) -> factory.addBuilderCustomizers(this::addHttpListener);
  }

  private Builder addHttpListener(Builder builder) {

  return builder.addHttpListener(8080, "0.0.0.0");
  }

17.3.17. Create WebSocket Endpoints Using @ServerEndpoint

If you want to use @ServerEndpoint in a Spring Boot application that used an embedded container,
you must declare a single ServerEndpointExporter @Bean, as shown in the following example:

427
 import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration(proxyBeanMethods = false)
public class MyWebSocketConfiguration {

  @Bean
  public ServerEndpointExporter serverEndpointExporter() {
  return new ServerEndpointExporter();
  }

The bean shown in the preceding example registers any @ServerEndpoint annotated beans with the
underlying WebSocket container. When deployed to a standalone servlet container, this role is
performed by a servlet container initializer, and the ServerEndpointExporter bean is not required.

17.4. Spring MVC

Spring Boot has a number of starters that include Spring MVC. Note that some starters include a
dependency on Spring MVC rather than include it directly. This section answers common questions
about Spring MVC and Spring Boot.

17.4.1. Write a JSON REST Service

Any Spring @RestController in a Spring Boot application should render JSON response by default as
long as Jackson2 is on the classpath, as shown in the following example:

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

  @RequestMapping("/thing")
  public MyThing thing() {
  return new MyThing();
  }

As long as MyThing can be serialized by Jackson2 (true for a normal POJO or Groovy object), then
localhost:8080/thing serves a JSON representation of it by default. Note that, in a browser, you
might sometimes see XML responses, because browsers tend to send accept headers that prefer
XML.

428
17.4.2. Write an XML REST Service

If you have the Jackson XML extension (jackson-dataformat-xml) on the classpath, you can use it to
render XML responses. The previous example that we used for JSON would work. To use the
Jackson XML renderer, add the following dependency to your project:

<dependency>
  <groupId>com.fasterxml.jackson.dataformat</groupId>
  <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

If Jackson’s XML extension is not available and JAXB is available, XML can be rendered with the
additional requirement of having MyThing annotated as @XmlRootElement, as shown in the following
example:

import jakarta.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class MyThing {

  private String name;

  public String getName() {

  return this.name;
  }

  public void setName(String name) {

  this.name = name;
  }

JAXB is only available out of the box with Java 8. If you use a more recent Java generation, add the
following dependency to your project:

<dependency>
  <groupId>org.glassfish.jaxb</groupId>
  <artifactId>jaxb-runtime</artifactId>
</dependency>

To get the server to render XML instead of JSON, you might have to send an Accept:
NOTE
text/xml header (or use a browser).

17.4.3. Customize the Jackson ObjectMapper

Spring MVC (client and server side) uses HttpMessageConverters to negotiate content conversion in

429
an HTTP exchange. If Jackson is on the classpath, you already get the default converter(s) provided
by Jackson2ObjectMapperBuilder, an instance of which is auto-configured for you.

The ObjectMapper (or XmlMapper for Jackson XML converter) instance (created by default) has the
following customized properties:

• MapperFeature.DEFAULT_VIEW_INCLUSION is disabled

• DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES is disabled

• SerializationFeature.WRITE_DATES_AS_TIMESTAMPS is disabled

Spring Boot also has some features to make it easier to customize this behavior.

You can configure the ObjectMapper and XmlMapper instances by using the environment. Jackson
provides an extensive suite of on/off features that can be used to configure various aspects of its
processing. These features are described in six enums (in Jackson) that map onto properties in the
environment:

Enum Property Values

com.fasterxml.jackson.databind spring.jackson.deserialization true, false
.DeserializationFeature .<feature_name>
com.fasterxml.jackson.core.Jso spring.jackson.generator.<feat true, false
nGenerator.Feature ure_name>
com.fasterxml.jackson.databind spring.jackson.mapper.<feature true, false
.MapperFeature _name>
com.fasterxml.jackson.core.Jso spring.jackson.parser.<feature true, false
nParser.Feature _name>
com.fasterxml.jackson.databind spring.jackson.serialization.< true, false
.SerializationFeature feature_name>
com.fasterxml.jackson.annotati spring.jackson.default- always, non_null, non_absent,
on.JsonInclude.Include property-inclusion non_default, non_empty

For example, to enable pretty print, set spring.jackson.serialization.indent_output=true. Note that,

thanks to the use of relaxed binding, the case of indent_output does not have to match the case of
the corresponding enum constant, which is INDENT_OUTPUT.

This environment-based configuration is applied to the auto-configured

Jackson2ObjectMapperBuilder bean and applies to any mappers created by using the builder,
including the auto-configured ObjectMapper bean.

The context’s Jackson2ObjectMapperBuilder can be customized by one or more

Jackson2ObjectMapperBuilderCustomizer beans. Such customizer beans can be ordered (Boot’s own
customizer has an order of 0), letting additional customization be applied both before and after
Boot’s customization.

Any beans of type com.fasterxml.jackson.databind.Module are automatically registered with the

auto-configured Jackson2ObjectMapperBuilder and are applied to any ObjectMapper instances that it
creates. This provides a global mechanism for contributing custom modules when you add new
features to your application.

430
If you want to replace the default ObjectMapper completely, either define a @Bean of that type and
mark it as @Primary or, if you prefer the builder-based approach, define a
Jackson2ObjectMapperBuilder @Bean. Note that, in either case, doing so disables all auto-configuration
of the ObjectMapper.

If you provide any @Beans of type MappingJackson2HttpMessageConverter, they replace the default
value in the MVC configuration. Also, a convenience bean of type HttpMessageConverters is provided
(and is always available if you use the default MVC configuration). It has some useful methods to
access the default and user-enhanced message converters.

See the “Customize the @ResponseBody Rendering” section and the WebMvcAutoConfiguration source
code for more details.

17.4.4. Customize the @ResponseBody Rendering

Spring uses HttpMessageConverters to render @ResponseBody (or responses from @RestController). You
can contribute additional converters by adding beans of the appropriate type in a Spring Boot
context. If a bean you add is of a type that would have been included by default anyway (such as
MappingJackson2HttpMessageConverter for JSON conversions), it replaces the default value. A
convenience bean of type HttpMessageConverters is provided and is always available if you use the
default MVC configuration. It has some useful methods to access the default and user-enhanced
message converters (For example, it can be useful if you want to manually inject them into a
custom RestTemplate).

As in normal MVC usage, any WebMvcConfigurer beans that you provide can also contribute
converters by overriding the configureMessageConverters method. However, unlike with normal
MVC, you can supply only additional converters that you need (because Spring Boot uses the same
mechanism to contribute its defaults). Finally, if you opt out of the Spring Boot default MVC
configuration by providing your own @EnableWebMvc configuration, you can take control completely
and do everything manually by using getMessageConverters from WebMvcConfigurationSupport.

See the WebMvcAutoConfiguration source code for more details.

17.4.5. Handling Multipart File Uploads

Spring Boot embraces the servlet 5 jakarta.servlet.http.Part API to support uploading files. By
default, Spring Boot configures Spring MVC with a maximum size of 1MB per file and a maximum
of 10MB of file data in a single request. You may override these values, the location to which
intermediate data is stored (for example, to the /tmp directory), and the threshold past which data is
flushed to disk by using the properties exposed in the MultipartProperties class. For example, if you
want to specify that files be unlimited, set the spring.servlet.multipart.max-file-size property to
-1.

The multipart support is helpful when you want to receive multipart encoded file data as a
@RequestParam-annotated parameter of type MultipartFile in a Spring MVC controller handler
method.

See the MultipartAutoConfiguration source for more details.

431
 It is recommended to use the container’s built-in support for multipart uploads
NOTE rather than introducing an additional dependency such as Apache Commons File
Upload.

17.4.6. Switch Off the Spring MVC DispatcherServlet

By default, all content is served from the root of your application (/). If you would rather map to a
different path, you can configure one as follows:

Properties

spring.mvc.servlet.path=/mypath

Yaml

spring:
  mvc:
  servlet:
  path: "/mypath"

If you have additional servlets you can declare a @Bean of type Servlet or ServletRegistrationBean
for each and Spring Boot will register them transparently to the container. Because servlets are
registered that way, they can be mapped to a sub-context of the DispatcherServlet without invoking
it.

Configuring the DispatcherServlet yourself is unusual but if you really need to do it, a @Bean of type
DispatcherServletPath must be provided as well to provide the path of your custom
DispatcherServlet.

17.4.7. Switch off the Default MVC Configuration

The easiest way to take complete control over MVC configuration is to provide your own
@Configuration with the @EnableWebMvc annotation. Doing so leaves all MVC configuration in your
hands.

17.4.8. Customize ViewResolvers

A ViewResolver is a core component of Spring MVC, translating view names in @Controller to actual
View implementations. Note that ViewResolvers are mainly used in UI applications, rather than
REST-style services (a View is not used to render a @ResponseBody). There are many implementations
of ViewResolver to choose from, and Spring on its own is not opinionated about which ones you
should use. Spring Boot, on the other hand, installs one or two for you, depending on what it finds
on the classpath and in the application context. The DispatcherServlet uses all the resolvers it finds
in the application context, trying each one in turn until it gets a result. If you add your own, you
have to be aware of the order and in which position your resolver is added.

WebMvcAutoConfiguration adds the following ViewResolvers to your context:

432
 • An InternalResourceViewResolver named ‘defaultViewResolver’. This one locates physical
resources that can be rendered by using the DefaultServlet (including static resources and JSP
pages, if you use those). It applies a prefix and a suffix to the view name and then looks for a
physical resource with that path in the servlet context (the defaults are both empty but are
accessible for external configuration through spring.mvc.view.prefix and
spring.mvc.view.suffix). You can override it by providing a bean of the same type.

• A BeanNameViewResolver named ‘beanNameViewResolver’. This is a useful member of the view

resolver chain and picks up any beans with the same name as the View being resolved. It should
not be necessary to override or replace it.

• A ContentNegotiatingViewResolver named ‘viewResolver’ is added only if there are actually

beans of type View present. This is a composite resolver, delegating to all the others and
attempting to find a match to the ‘Accept’ HTTP header sent by the client. There is a useful blog
about ContentNegotiatingViewResolver that you might like to study to learn more, and you might
also look at the source code for detail. You can switch off the auto-configured
ContentNegotiatingViewResolver by defining a bean named ‘viewResolver’.

• If you use Thymeleaf, you also have a ThymeleafViewResolver named ‘thymeleafViewResolver’. It

looks for resources by surrounding the view name with a prefix and suffix. The prefix is
spring.thymeleaf.prefix, and the suffix is spring.thymeleaf.suffix. The values of the prefix and
suffix default to ‘classpath:/templates/’ and ‘.html’, respectively. You can override
ThymeleafViewResolver by providing a bean of the same name.

• If you use FreeMarker, you also have a FreeMarkerViewResolver named

‘freeMarkerViewResolver’. It looks for resources in a loader path (which is externalized to
spring.freemarker.templateLoaderPath and has a default value of ‘classpath:/templates/’) by
surrounding the view name with a prefix and a suffix. The prefix is externalized to
spring.freemarker.prefix, and the suffix is externalized to spring.freemarker.suffix. The default
values of the prefix and suffix are empty and ‘.ftlh’, respectively. You can override
FreeMarkerViewResolver by providing a bean of the same name.

• If you use Groovy templates (actually, if groovy-templates is on your classpath), you also have a
GroovyMarkupViewResolver named ‘groovyMarkupViewResolver’. It looks for resources in a
loader path by surrounding the view name with a prefix and suffix (externalized to
spring.groovy.template.prefix and spring.groovy.template.suffix). The prefix and suffix have
default values of ‘classpath:/templates/’ and ‘.tpl’, respectively. You can override
GroovyMarkupViewResolver by providing a bean of the same name.

• If you use Mustache, you also have a MustacheViewResolver named ‘mustacheViewResolver’. It

looks for resources by surrounding the view name with a prefix and suffix. The prefix is
spring.mustache.prefix, and the suffix is spring.mustache.suffix. The values of the prefix and
suffix default to ‘classpath:/templates/’ and ‘.mustache’, respectively. You can override
MustacheViewResolver by providing a bean of the same name.

For more detail, see the following sections:

• WebMvcAutoConfiguration

• ThymeleafAutoConfiguration

• FreeMarkerAutoConfiguration

• GroovyTemplateAutoConfiguration

433
17.5. HTTP Clients
Spring Boot offers a number of starters that work with HTTP clients. This section answers questions
related to using them.

17.5.1. Configure RestTemplate to Use a Proxy

As described in RestTemplate Customization, you can use a RestTemplateCustomizer with

RestTemplateBuilder to build a customized RestTemplate. This is the recommended approach for
creating a RestTemplate configured to use a proxy.

The exact details of the proxy configuration depend on the underlying client request factory that is
being used.

17.5.2. Configure the TcpClient used by a Reactor Netty-based WebClient

When Reactor Netty is on the classpath a Reactor Netty-based WebClient is auto-configured. To

customize the client’s handling of network connections, provide a ClientHttpConnector bean. The
following example configures a 60 second connect timeout and adds a ReadTimeoutHandler:

import io.netty.channel.ChannelOption;
import io.netty.handler.timeout.ReadTimeoutHandler;
import reactor.netty.http.client.HttpClient;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.reactive.ClientHttpConnector;
import org.springframework.http.client.reactive.ReactorClientHttpConnector;
import org.springframework.http.client.reactive.ReactorResourceFactory;

@Configuration(proxyBeanMethods = false)
public class MyReactorNettyClientConfiguration {

  @Bean
  ClientHttpConnector clientHttpConnector(ReactorResourceFactory resourceFactory) {
  HttpClient httpClient =
HttpClient.create(resourceFactory.getConnectionProvider())
  .runOn(resourceFactory.getLoopResources())
  .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 60000)
  .doOnConnected((connection) -> connection.addHandlerLast(new
ReadTimeoutHandler(60)));
  return new ReactorClientHttpConnector(httpClient);
  }

434
 Note the use of ReactorResourceFactory for the connection provider and event loop
TIP resources. This ensures efficient sharing of resources for the server receiving requests
and the client making requests.

17.6. Logging
Spring Boot has no mandatory logging dependency, except for the Commons Logging API, which is
typically provided by Spring Framework’s spring-jcl module. To use Logback, you need to include
it and spring-jcl on the classpath. The recommended way to do that is through the starters, which
all depend on spring-boot-starter-logging. For a web application, you need only spring-boot-
starter-web, since it depends transitively on the logging starter. If you use Maven, the following
dependency adds logging for you:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>

Spring Boot has a LoggingSystem abstraction that attempts to configure logging based on the content
of the classpath. If Logback is available, it is the first choice.

If the only change you need to make to logging is to set the levels of various loggers, you can do so
in application.properties by using the "logging.level" prefix, as shown in the following example:

Properties

logging.level.org.springframework.web=debug
logging.level.org.hibernate=error

Yaml

logging:
  level:
  org.springframework.web: "debug"
  org.hibernate: "error"

You can also set the location of a file to which to write the log (in addition to the console) by using
logging.file.name.

To configure the more fine-grained settings of a logging system, you need to use the native
configuration format supported by the LoggingSystem in question. By default, Spring Boot picks up
the native configuration from its default location for the system (such as classpath:logback.xml for
Logback), but you can set the location of the config file by using the logging.config property.

435
17.6.1. Configure Logback for Logging

If you need to apply customizations to logback beyond those that can be achieved with
application.properties, you will need to add a standard logback configuration file. You can add a
logback.xml file to the root of your classpath for logback to find. You can also use logback-spring.xml
if you want to use the Spring Boot Logback extensions.

The Logback documentation has a dedicated section that covers configuration in some
TIP
detail.

Spring Boot provides a number of logback configurations that be included from your own
configuration. These includes are designed to allow certain common Spring Boot conventions to be
re-applied.

The following files are provided under org/springframework/boot/logging/logback/:

• defaults.xml - Provides conversion rules, pattern properties and common logger configurations.

• console-appender.xml - Adds a ConsoleAppender using the CONSOLE_LOG_PATTERN.

• file-appender.xml - Adds a RollingFileAppender using the FILE_LOG_PATTERN and

ROLLING_FILE_NAME_PATTERN with appropriate settings.

In addition, a legacy base.xml file is provided for compatibility with earlier versions of Spring Boot.

A typical custom logback.xml file would look something like this:

<?xml version="1.0" encoding="UTF-8"?>

<configuration>
  <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
  <include resource="org/springframework/boot/logging/logback/console-appender.xml"
/>
  <root level="INFO">
  <appender-ref ref="CONSOLE" />
  </root>
  <logger name="org.springframework.web" level="DEBUG"/>
</configuration>

Your logback configuration file can also make use of System properties that the LoggingSystem takes
care of creating for you:

• ${PID}: The current process ID.

• ${LOG_FILE}: Whether logging.file.name was set in Boot’s external configuration.

• ${LOG_PATH}: Whether logging.file.path (representing a directory for log files to live in) was set
in Boot’s external configuration.

• ${LOG_EXCEPTION_CONVERSION_WORD}: Whether logging.exception-conversion-word was set in Boot’s

external configuration.

• ${ROLLING_FILE_NAME_PATTERN}: Whether logging.pattern.rolling-file-name was set in Boot’s

436
 external configuration.

Spring Boot also provides some nice ANSI color terminal output on a console (but not in a log file)
by using a custom Logback converter. See the CONSOLE_LOG_PATTERN in the defaults.xml configuration
for an example.

If Groovy is on the classpath, you should be able to configure Logback with logback.groovy as well.
If present, this setting is given preference.

Spring extensions are not supported with Groovy configuration. Any logback-
NOTE
spring.groovy files will not be detected.

Configure Logback for File-only Output

If you want to disable console logging and write output only to a file, you need a custom logback-
spring.xml that imports file-appender.xml but not console-appender.xml, as shown in the following
example:

<?xml version="1.0" encoding="UTF-8"?>

<configuration>
  <include resource="org/springframework/boot/logging/logback/defaults.xml" />
  <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-
${java.io.tmpdir:-/tmp}}/}spring.log}"/>
  <include resource="org/springframework/boot/logging/logback/file-appender.xml" />
  <root level="INFO">
  <appender-ref ref="FILE" />
  </root>
</configuration>

You also need to add logging.file.name to your application.properties or application.yaml, as

shown in the following example:

Properties

logging.file.name=myapplication.log

Yaml

logging:
  file:
  name: "myapplication.log"

17.6.2. Configure Log4j for Logging

Spring Boot supports Log4j 2 for logging configuration if it is on the classpath. If you use the starters
for assembling dependencies, you have to exclude Logback and then include log4j 2 instead. If you
do not use the starters, you need to provide (at least) spring-jcl in addition to Log4j 2.

437
The recommended path is through the starters, even though it requires some jiggling. The following
example shows how to set up the starters in Maven:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
  <exclusions>
  <exclusion>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-logging</artifactId>
  </exclusion>
  </exclusions>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

Gradle provides a few different ways to set up the starters. One way is to use a module
replacement. To do so, declare a dependency on the Log4j 2 starter and tell Gradle that any
occurrences of the default logging starter should be replaced by the Log4j 2 starter, as shown in the
following example:

dependencies {
  implementation "org.springframework.boot:spring-boot-starter-log4j2"
  modules {
  module("org.springframework.boot:spring-boot-starter-logging") {
  replacedBy("org.springframework.boot:spring-boot-starter-log4j2", "Use
Log4j2 instead of Logback")
  }
  }
}

The Log4j starters gather together the dependencies for common logging
NOTE requirements (such as having Tomcat use java.util.logging but configuring the
output using Log4j 2).

To ensure that debug logging performed using java.util.logging is routed into

NOTE Log4j 2, configure its JDK logging adapter by setting the java.util.logging.manager
system property to org.apache.logging.log4j.jul.LogManager.

438
Use YAML or JSON to Configure Log4j 2

In addition to its default XML configuration format, Log4j 2 also supports YAML and JSON
configuration files. To configure Log4j 2 to use an alternative configuration file format, add the
appropriate dependencies to the classpath and name your configuration files to match your chosen
file format, as shown in the following example:

Format Dependencies File names

YAML com.fasterxml.jackson.core:jackson-databind + log4j2.yaml +

com.fasterxml.jackson.dataformat:jackson-dataformat-yaml log4j2.yml

JSON com.fasterxml.jackson.core:jackson-databind log4j2.json +

log4j2.jsn

Use Composite Configuration to Configure Log4j 2

Log4j 2 has support for combining multiple configuration files into a single composite
configuration. To use this support in Spring Boot, configure logging.log4j2.config.override with
the locations of one or more secondary configuration files. The secondary configuration files will be
merged with the primary configuration, whether the primary’s source is Spring Boot’s defaults, a
standard location such as log4j.xml, or the location configured by the logging.config property.

17.7. Data Access

Spring Boot includes a number of starters for working with data sources. This section answers
questions related to doing so.

17.7.1. Configure a Custom DataSource

To configure your own DataSource, define a @Bean of that type in your configuration. Spring Boot
reuses your DataSource anywhere one is required, including database initialization. If you need to
externalize some settings, you can bind your DataSource to the environment (see “Third-party
Configuration”).

The following example shows how to define a data source in a bean:

439
 import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyDataSourceConfiguration {

  @Bean
  @ConfigurationProperties(prefix = "app.datasource")
  public SomeDataSource dataSource() {
  return new SomeDataSource();
  }

The following example shows how to define a data source by setting properties:

Properties

app.datasource.url=jdbc:h2:mem:mydb
app.datasource.username=sa
app.datasource.pool-size=30

Yaml

app:
  datasource:
  url: "jdbc:h2:mem:mydb"
  username: "sa"
  pool-size: 30

Assuming that SomeDataSource has regular JavaBean properties for the URL, the username, and the
pool size, these settings are bound automatically before the DataSource is made available to other
components.

Spring Boot also provides a utility builder class, called DataSourceBuilder, that can be used to create
one of the standard data sources (if it is on the classpath). The builder can detect the one to use
based on what is available on the classpath. It also auto-detects the driver based on the JDBC URL.

The following example shows how to create a data source by using a DataSourceBuilder:

440
 import javax.sql.DataSource;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyDataSourceConfiguration {

  @Bean
  @ConfigurationProperties("app.datasource")
  public DataSource dataSource() {
  return DataSourceBuilder.create().build();
  }

To run an app with that DataSource, all you need is the connection information. Pool-specific
settings can also be provided. Check the implementation that is going to be used at runtime for
more details.

The following example shows how to define a JDBC data source by setting properties:

Properties

app.datasource.url=jdbc:mysql://localhost/test
app.datasource.username=dbuser
app.datasource.password=dbpass
app.datasource.pool-size=30

Yaml

app:
  datasource:
  url: "jdbc:mysql://localhost/test"
  username: "dbuser"
  password: "dbpass"
  pool-size: 30

However, there is a catch. Because the actual type of the connection pool is not exposed, no keys are
generated in the metadata for your custom DataSource and no completion is available in your IDE
(because the DataSource interface exposes no properties). Also, if you happen to have Hikari on the
classpath, this basic setup does not work, because Hikari has no url property (but does have a
jdbcUrl property). In that case, you must rewrite your configuration as follows:

441
Properties

app.datasource.jdbc-url=jdbc:mysql://localhost/test
app.datasource.username=dbuser
app.datasource.password=dbpass
app.datasource.pool-size=30

Yaml

app:
  datasource:
  jdbc-url: "jdbc:mysql://localhost/test"
  username: "dbuser"
  password: "dbpass"
  pool-size: 30

You can fix that by forcing the connection pool to use and return a dedicated implementation
rather than DataSource. You cannot change the implementation at runtime, but the list of options
will be explicit.

The following example shows how create a HikariDataSource with DataSourceBuilder:

import com.zaxxer.hikari.HikariDataSource;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyDataSourceConfiguration {

  @Bean
  @ConfigurationProperties("app.datasource")
  public HikariDataSource dataSource() {
  return DataSourceBuilder.create().type(HikariDataSource.class).build();
  }

You can even go further by leveraging what DataSourceProperties does for you — that is, by
providing a default embedded database with a sensible username and password if no URL is
provided. You can easily initialize a DataSourceBuilder from the state of any DataSourceProperties
object, so you could also inject the DataSource that Spring Boot creates automatically. However, that
would split your configuration into two namespaces: url, username, password, type, and driver on
spring.datasource and the rest on your custom namespace (app.datasource). To avoid that, you can
redefine a custom DataSourceProperties on your custom namespace, as shown in the following
example:

442
 import com.zaxxer.hikari.HikariDataSource;

import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;

@Configuration(proxyBeanMethods = false)
public class MyDataSourceConfiguration {

  @Bean
  @Primary
  @ConfigurationProperties("app.datasource")
  public DataSourceProperties dataSourceProperties() {
  return new DataSourceProperties();
  }

  @Bean
  @ConfigurationProperties("app.datasource.configuration")
  public HikariDataSource dataSource(DataSourceProperties properties) {
  return
properties.initializeDataSourceBuilder().type(HikariDataSource.class).build();
  }

This setup puts you in sync with what Spring Boot does for you by default, except that a dedicated
connection pool is chosen (in code) and its settings are exposed in the app.datasource.configuration
sub namespace. Because DataSourceProperties is taking care of the url/jdbcUrl translation for you,
you can configure it as follows:

Properties

app.datasource.url=jdbc:mysql://localhost/test
app.datasource.username=dbuser
app.datasource.password=dbpass
app.datasource.configuration.maximum-pool-size=30

Yaml

app:
  datasource:
  url: "jdbc:mysql://localhost/test"
  username: "dbuser"
  password: "dbpass"
  configuration:
  maximum-pool-size: 30

443
 Spring Boot will expose Hikari-specific settings to spring.datasource.hikari. This
TIP example uses a more generic configuration sub namespace as the example does not
support multiple datasource implementations.

Because your custom configuration chooses to go with Hikari, app.datasource.type

NOTE has no effect. In practice, the builder is initialized with whatever value you might
set there and then overridden by the call to .type().

See “Configure a DataSource” in the “Spring Boot features” section and the
DataSourceAutoConfiguration class for more details.

17.7.2. Configure Two DataSources

If you need to configure multiple data sources, you can apply the same tricks that are described in
the previous section. You must, however, mark one of the DataSource instances as @Primary, because
various auto-configurations down the road expect to be able to get one by type.

If you create your own DataSource, the auto-configuration backs off. In the following example, we
provide the exact same feature set as the auto-configuration provides on the primary data source:

444
 import com.zaxxer.hikari.HikariDataSource;
import org.apache.commons.dbcp2.BasicDataSource;

import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;

@Configuration(proxyBeanMethods = false)
public class MyDataSourcesConfiguration {

  @Bean
  @Primary
  @ConfigurationProperties("app.datasource.first")
  public DataSourceProperties firstDataSourceProperties() {
  return new DataSourceProperties();
  }

  @Bean
  @Primary
  @ConfigurationProperties("app.datasource.first.configuration")
  public HikariDataSource firstDataSource(DataSourceProperties
firstDataSourceProperties) {
  return
firstDataSourceProperties.initializeDataSourceBuilder().type(HikariDataSource.class).b
uild();
  }

  @Bean
  @ConfigurationProperties("app.datasource.second")
  public BasicDataSource secondDataSource() {
  return DataSourceBuilder.create().type(BasicDataSource.class).build();
  }

firstDataSourceProperties has to be flagged as @Primary so that the database initializer

TIP
feature uses your copy (if you use the initializer).

Both data sources are also bound for advanced customizations. For instance, you could configure
them as follows:

445
Properties

app.datasource.first.url=jdbc:mysql://localhost/first
app.datasource.first.username=dbuser
app.datasource.first.password=dbpass
app.datasource.first.configuration.maximum-pool-size=30

app.datasource.second.url=jdbc:mysql://localhost/second
app.datasource.second.username=dbuser
app.datasource.second.password=dbpass
app.datasource.second.max-total=30

Yaml

app:
  datasource:
  first:
  url: "jdbc:mysql://localhost/first"
  username: "dbuser"
  password: "dbpass"
  configuration:
  maximum-pool-size: 30

  second:
  url: "jdbc:mysql://localhost/second"
  username: "dbuser"
  password: "dbpass"
  max-total: 30

You can apply the same concept to the secondary DataSource as well, as shown in the following
example:

446
 import com.zaxxer.hikari.HikariDataSource;
import org.apache.commons.dbcp2.BasicDataSource;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;

@Configuration(proxyBeanMethods = false)
public class MyCompleteDataSourcesConfiguration {

  @Bean
  @Primary
  @ConfigurationProperties("app.datasource.first")
  public DataSourceProperties firstDataSourceProperties() {
  return new DataSourceProperties();
  }

  @Bean
  @Primary
  @ConfigurationProperties("app.datasource.first.configuration")
  public HikariDataSource firstDataSource(DataSourceProperties
firstDataSourceProperties) {
  return
firstDataSourceProperties.initializeDataSourceBuilder().type(HikariDataSource.class).b
uild();
  }

  @Bean
  @ConfigurationProperties("app.datasource.second")
  public DataSourceProperties secondDataSourceProperties() {
  return new DataSourceProperties();
  }

  @Bean
  @ConfigurationProperties("app.datasource.second.configuration")
  public BasicDataSource secondDataSource(
  @Qualifier("secondDataSourceProperties") DataSourceProperties
secondDataSourceProperties) {
  return
secondDataSourceProperties.initializeDataSourceBuilder().type(BasicDataSource.class).b
uild();
  }

The preceding example configures two data sources on custom namespaces with the same logic as
Spring Boot would use in auto-configuration. Note that each configuration sub namespace provides

447
advanced settings based on the chosen implementation.

17.7.3. Use Spring Data Repositories

Spring Data can create implementations of @Repository interfaces of various flavors. Spring Boot
handles all of that for you, as long as those @Repositories are included in the same package (or a
sub-package) of your @EnableAutoConfiguration class.

For many applications, all you need is to put the right Spring Data dependencies on your classpath.
There is a spring-boot-starter-data-jpa for JPA, spring-boot-starter-data-mongodb for Mongodb,
and various other starters for supported technologies. To get started, create some repository
interfaces to handle your @Entity objects.

Spring Boot tries to guess the location of your @Repository definitions, based on the
@EnableAutoConfiguration it finds. To get more control, use the @EnableJpaRepositories annotation
(from Spring Data JPA).

For more about Spring Data, see the Spring Data project page.

17.7.4. Separate @Entity Definitions from Spring Configuration

Spring Boot tries to guess the location of your @Entity definitions, based on the
@EnableAutoConfiguration it finds. To get more control, you can use the @EntityScan annotation, as
shown in the following example:

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
@EnableAutoConfiguration
@EntityScan(basePackageClasses = City.class)
public class MyApplication {

  // ...

17.7.5. Configure JPA Properties

Spring Data JPA already provides some vendor-independent configuration options (such as those
for SQL logging), and Spring Boot exposes those options and a few more for Hibernate as external
configuration properties. Some of them are automatically detected according to the context so you
should not have to set them.

The spring.jpa.hibernate.ddl-auto is a special case, because, depending on runtime conditions, it

has different defaults. If an embedded database is used and no schema manager (such as Liquibase
or Flyway) is handling the DataSource, it defaults to create-drop. In all other cases, it defaults to none.

448
The dialect to use is detected by the JPA provider. If you prefer to set the dialect yourself, set the
spring.jpa.database-platform property.

The most common options to set are shown in the following example:

Properties

spring.jpa.hibernate.naming.physical-strategy=com.example.MyPhysicalNamingStrategy
spring.jpa.show-sql=true

Yaml

spring:
  jpa:
  hibernate:
  naming:
  physical-strategy: "com.example.MyPhysicalNamingStrategy"
  show-sql: true

In addition, all properties in spring.jpa.properties.* are passed through as normal JPA properties
(with the prefix stripped) when the local EntityManagerFactory is created.

You need to ensure that names defined under spring.jpa.properties.* exactly

match those expected by your JPA provider. Spring Boot will not attempt any
kind of relaxed binding for these entries.
WARNING
For example, if you want to configure Hibernate’s batch size you must use
spring.jpa.properties.hibernate.jdbc.batch_size. If you use other forms, such
as batchSize or batch-size, Hibernate will not apply the setting.

If you need to apply advanced customization to Hibernate properties, consider

registering a HibernatePropertiesCustomizer bean that will be invoked prior to creating
TIP
the EntityManagerFactory. This takes precedence to anything that is applied by the
auto-configuration.

17.7.6. Configure Hibernate Naming Strategy

Hibernate uses two different naming strategies to map names from the object model to the
corresponding database names. The fully qualified class name of the physical and the implicit
strategy implementations can be configured by setting the spring.jpa.hibernate.naming.physical-
strategy and spring.jpa.hibernate.naming.implicit-strategy properties, respectively. Alternatively,
if ImplicitNamingStrategy or PhysicalNamingStrategy beans are available in the application context,
Hibernate will be automatically configured to use them.

By default, Spring Boot configures the physical naming strategy with SpringPhysicalNamingStrategy.
This implementation provides the same table structure as Hibernate 4: all dots are replaced by
underscores and camel casing is replaced by underscores as well. Additionally, by default, all table
names are generated in lower case. For example, a TelephoneNumber entity is mapped to the

449
telephone_number table. If your schema requires mixed-case identifiers, define a custom
SpringPhysicalNamingStrategy bean, as shown in the following example:

import org.hibernate.boot.model.naming.CamelCaseToUnderscoresNamingStrategy;
import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyHibernateConfiguration {

  @Bean
  public CamelCaseToUnderscoresNamingStrategy caseSensitivePhysicalNamingStrategy()
{
  return new CamelCaseToUnderscoresNamingStrategy() {

  @Override
  protected boolean isCaseInsensitive(JdbcEnvironment jdbcEnvironment) {
  return false;
  }

  };
  }

If you prefer to use Hibernate 5’s default instead, set the following property:

spring.jpa.hibernate.naming.physical-
strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl

Alternatively, you can configure the following bean:

450
 import org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
class MyHibernateConfiguration {

  @Bean
  PhysicalNamingStrategyStandardImpl caseSensitivePhysicalNamingStrategy() {
  return new PhysicalNamingStrategyStandardImpl();
  }

See HibernateJpaAutoConfiguration and JpaBaseConfiguration for more details.

17.7.7. Configure Hibernate Second-Level Caching

Hibernate second-level cache can be configured for a range of cache providers. Rather than
configuring Hibernate to lookup the cache provider again, it is better to provide the one that is
available in the context whenever possible.

To do this with JCache, first make sure that org.hibernate:hibernate-jcache is available on the
classpath. Then, add a HibernatePropertiesCustomizer bean as shown in the following example:

import org.hibernate.cache.jcache.ConfigSettings;

import org.springframework.boot.autoconfigure.orm.jpa.HibernatePropertiesCustomizer;
import org.springframework.cache.jcache.JCacheCacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyHibernateSecondLevelCacheConfiguration {

  @Bean
  public HibernatePropertiesCustomizer
hibernateSecondLevelCacheCustomizer(JCacheCacheManager cacheManager) {
  return (properties) -> properties.put(ConfigSettings.CACHE_MANAGER,
cacheManager.getCacheManager());
  }

This customizer will configure Hibernate to use the same CacheManager as the one that the
application uses. It is also possible to use separate CacheManager instances. For details, see the
Hibernate user guide.

451
17.7.8. Use Dependency Injection in Hibernate Components

By default, Spring Boot registers a BeanContainer implementation that uses the BeanFactory so that
converters and entity listeners can use regular dependency injection.

You can disable or tune this behavior by registering a HibernatePropertiesCustomizer that removes
or changes the hibernate.resource.beans.container property.

17.7.9. Use a Custom EntityManagerFactory

To take full control of the configuration of the EntityManagerFactory, you need to add a @Bean named
‘entityManagerFactory’. Spring Boot auto-configuration switches off its entity manager in the
presence of a bean of that type.

17.7.10. Using Multiple EntityManagerFactories

If you need to use JPA against multiple data sources, you likely need one EntityManagerFactory per
data source. The LocalContainerEntityManagerFactoryBean from Spring ORM allows you to configure
an EntityManagerFactory for your needs. You can also reuse JpaProperties to bind settings for each
EntityManagerFactory, as shown in the following example:

452
 import javax.sql.DataSource;

import org.springframework.boot.autoconfigure.orm.jpa.JpaProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.orm.jpa.EntityManagerFactoryBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.orm.jpa.JpaVendorAdapter;
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;

@Configuration(proxyBeanMethods = false)
public class MyEntityManagerFactoryConfiguration {

  @Bean
  @ConfigurationProperties("app.jpa.first")
  public JpaProperties firstJpaProperties() {
  return new JpaProperties();
  }

  @Bean
  public LocalContainerEntityManagerFactoryBean firstEntityManagerFactory(DataSource
firstDataSource,
  JpaProperties firstJpaProperties) {
  EntityManagerFactoryBuilder builder =
createEntityManagerFactoryBuilder(firstJpaProperties);
  return
builder.dataSource(firstDataSource).packages(Order.class).persistenceUnit("firstDs").b
uild();
  }

  private EntityManagerFactoryBuilder
createEntityManagerFactoryBuilder(JpaProperties jpaProperties) {
  JpaVendorAdapter jpaVendorAdapter = createJpaVendorAdapter(jpaProperties);
  return new EntityManagerFactoryBuilder(jpaVendorAdapter,
jpaProperties.getProperties(), null);
  }

  private JpaVendorAdapter createJpaVendorAdapter(JpaProperties jpaProperties) {

  // ... map JPA properties as needed
  return new HibernateJpaVendorAdapter();
  }

The example above creates an EntityManagerFactory using a DataSource bean named

firstDataSource. It scans entities located in the same package as Order. It is possible to map
additional JPA properties using the app.first.jpa namespace.

453
 When you create a bean for LocalContainerEntityManagerFactoryBean yourself, any
customization that was applied during the creation of the auto-configured
LocalContainerEntityManagerFactoryBean is lost. For example, in case of Hibernate,
any properties under the spring.jpa.hibernate prefix will not be automatically
NOTE
applied to your LocalContainerEntityManagerFactoryBean. If you were relying on
these properties for configuring things like the naming strategy or the DDL mode,
you will need to explicitly configure that when creating the
LocalContainerEntityManagerFactoryBean bean.

You should provide a similar configuration for any additional data sources for which you need JPA
access. To complete the picture, you need to configure a JpaTransactionManager for each
EntityManagerFactory as well. Alternatively, you might be able to use a JTA transaction manager that
spans both.

If you use Spring Data, you need to configure @EnableJpaRepositories accordingly, as shown in the
following examples:

import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

@Configuration(proxyBeanMethods = false)
@EnableJpaRepositories(basePackageClasses = Order.class, entityManagerFactoryRef =
"firstEntityManagerFactory")
public class OrderConfiguration {

import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

@Configuration(proxyBeanMethods = false)
@EnableJpaRepositories(basePackageClasses = Customer.class, entityManagerFactoryRef =
"secondEntityManagerFactory")
public class CustomerConfiguration {

17.7.11. Use a Traditional persistence.xml File

Spring Boot will not search for or use a META-INF/persistence.xml by default. If you prefer to use a
traditional persistence.xml, you need to define your own @Bean of type
LocalEntityManagerFactoryBean (with an ID of ‘entityManagerFactory’) and set the persistence unit
name there.

See JpaBaseConfiguration for the default settings.

454
17.7.12. Use Spring Data JPA and Mongo Repositories

Spring Data JPA and Spring Data Mongo can both automatically create Repository implementations
for you. If they are both present on the classpath, you might have to do some extra configuration to
tell Spring Boot which repositories to create. The most explicit way to do that is to use the standard
Spring Data @EnableJpaRepositories and @EnableMongoRepositories annotations and provide the
location of your Repository interfaces.

There are also flags (spring.data.*.repositories.enabled and spring.data.*.repositories.type) that

you can use to switch the auto-configured repositories on and off in external configuration. Doing
so is useful, for instance, in case you want to switch off the Mongo repositories and still use the
auto-configured MongoTemplate.

The same obstacle and the same features exist for other auto-configured Spring Data repository
types (Elasticsearch, Solr, and others). To work with them, change the names of the annotations and
flags accordingly.

17.7.13. Customize Spring Data’s Web Support

Spring Data provides web support that simplifies the use of Spring Data repositories in a web
application. Spring Boot provides properties in the spring.data.web namespace for customizing its
configuration. Note that if you are using Spring Data REST, you must use the properties in the
spring.data.rest namespace instead.

17.7.14. Expose Spring Data Repositories as REST Endpoint

Spring Data REST can expose the Repository implementations as REST endpoints for you, provided
Spring MVC has been enabled for the application.

Spring Boot exposes a set of useful properties (from the spring.data.rest namespace) that
customize the RepositoryRestConfiguration. If you need to provide additional customization, you
should use a RepositoryRestConfigurer bean.

If you do not specify any order on your custom RepositoryRestConfigurer, it runs

NOTE after the one Spring Boot uses internally. If you need to specify an order, make sure
it is higher than 0.

17.7.15. Configure a Component that is Used by JPA

If you want to configure a component that JPA uses, then you need to ensure that the component is
initialized before JPA. When the component is auto-configured, Spring Boot takes care of this for
you. For example, when Flyway is auto-configured, Hibernate is configured to depend upon Flyway
so that Flyway has a chance to initialize the database before Hibernate tries to use it.

If you are configuring a component yourself, you can use an

EntityManagerFactoryDependsOnPostProcessor subclass as a convenient way of setting up the
necessary dependencies. For example, if you use Hibernate Search with Elasticsearch as its index
manager, any EntityManagerFactory beans must be configured to depend on the elasticsearchClient
bean, as shown in the following example:

455
 import jakarta.persistence.EntityManagerFactory;

import
org.springframework.boot.autoconfigure.orm.jpa.EntityManagerFactoryDependsOnPostProces
sor;
import org.springframework.stereotype.Component;

/**
 * {@link EntityManagerFactoryDependsOnPostProcessor} that ensures that
 * {@link EntityManagerFactory} beans depend on the {@code elasticsearchClient} bean.
 */
@Component
public class ElasticsearchEntityManagerFactoryDependsOnPostProcessor
  extends EntityManagerFactoryDependsOnPostProcessor {

  public ElasticsearchEntityManagerFactoryDependsOnPostProcessor() {
  super("elasticsearchClient");
  }

17.7.16. Configure jOOQ with Two DataSources

If you need to use jOOQ with multiple data sources, you should create your own DSLContext for each
one. See JooqAutoConfiguration for more details.

In particular, JooqExceptionTranslator and SpringTransactionProvider can be reused to

TIP
provide similar features to what the auto-configuration does with a single DataSource.

17.8. Database Initialization

An SQL database can be initialized in different ways depending on what your stack is. Of course,
you can also do it manually, provided the database is a separate process. It is recommended to use a
single mechanism for schema generation.

17.8.1. Initialize a Database Using JPA

JPA has features for DDL generation, and these can be set up to run on startup against the database.
This is controlled through two external properties:

• spring.jpa.generate-ddl (boolean) switches the feature on and off and is vendor independent.

• spring.jpa.hibernate.ddl-auto (enum) is a Hibernate feature that controls the behavior in a

more fine-grained way. This feature is described in more detail later in this guide.

17.8.2. Initialize a Database Using Hibernate

You can set spring.jpa.hibernate.ddl-auto explicitly and the standard Hibernate property values

456
are none, validate, update, create, and create-drop. Spring Boot chooses a default value for you
based on whether it thinks your database is embedded. It defaults to create-drop if no schema
manager has been detected or none in all other cases. An embedded database is detected by looking
at the Connection type and JDBC url. hsqldb, h2, and derby are candidates, and others are not. Be
careful when switching from in-memory to a ‘real’ database that you do not make assumptions
about the existence of the tables and data in the new platform. You either have to set ddl-auto
explicitly or use one of the other mechanisms to initialize the database.

You can output the schema creation by enabling the org.hibernate.SQL logger. This
NOTE
is done for you automatically if you enable the debug mode.

In addition, a file named import.sql in the root of the classpath is executed on startup if Hibernate
creates the schema from scratch (that is, if the ddl-auto property is set to create or create-drop).
This can be useful for demos and for testing if you are careful but is probably not something you
want to be on the classpath in production. It is a Hibernate feature (and has nothing to do with
Spring).

17.8.3. Initialize a Database Using Basic SQL Scripts

Spring Boot can automatically create the schema (DDL scripts) of your JDBC DataSource or R2DBC
ConnectionFactory and initialize it (DML scripts). It loads SQL from the standard root classpath
locations: schema.sql and data.sql, respectively. In addition, Spring Boot processes the schema-
${platform}.sql and data-${platform}.sql files (if present), where platform is the value of
spring.sql.init.platform. This allows you to switch to database-specific scripts if necessary. For
example, you might choose to set it to the vendor name of the database (hsqldb, h2, oracle, mysql,
postgresql, and so on). By default, SQL database initialization is only performed when using an
embedded in-memory database. To always initialize an SQL database, irrespective of its type, set
spring.sql.init.mode to always. Similarly, to disable initialization, set spring.sql.init.mode to never.
By default, Spring Boot enables the fail-fast feature of its script-based database initializer. This
means that, if the scripts cause exceptions, the application fails to start. You can tune that behavior
by setting spring.sql.init.continue-on-error.

Script-based DataSource initialization is performed, by default, before any JPA EntityManagerFactory

beans are created. schema.sql can be used to create the schema for JPA-managed entities and
data.sql can be used to populate it. While we do not recommend using multiple data source
initialization technologies, if you want script-based DataSource initialization to be able to build upon
the schema creation performed by Hibernate, set spring.jpa.defer-datasource-initialization to
true. This will defer data source initialization until after any EntityManagerFactory beans have been
created and initialized. schema.sql can then be used to make additions to any schema creation
performed by Hibernate and data.sql can be used to populate it.

If you are using a Higher-level Database Migration Tool, like Flyway or Liquibase, you should use
them alone to create and initialize the schema. Using the basic schema.sql and data.sql scripts
alongside Flyway or Liquibase is not recommended and support will be removed in a future
release.

457
17.8.4. Initialize a Spring Batch Database

If you use Spring Batch, it comes pre-packaged with SQL initialization scripts for most popular
database platforms. Spring Boot can detect your database type and execute those scripts on startup.
If you use an embedded database, this happens by default. You can also enable it for any database
type, as shown in the following example:

Properties

spring.batch.jdbc.initialize-schema=always

Yaml

spring:
  batch:
  jdbc:
  initialize-schema: "always"

You can also switch off the initialization explicitly by setting spring.batch.jdbc.initialize-schema to
never.

17.8.5. Use a Higher-level Database Migration Tool

Spring Boot supports two higher-level migration tools: Flyway and Liquibase.

Execute Flyway Database Migrations on Startup

To automatically run Flyway database migrations on startup, add the org.flywaydb:flyway-core to

your classpath.

Typically, migrations are scripts in the form V<VERSION>__<NAME>.sql (with <VERSION> an underscore-
separated version, such as ‘1’ or ‘2_1’). By default, they are in a directory called
classpath:db/migration, but you can modify that location by setting spring.flyway.locations. This is
a comma-separated list of one or more classpath: or filesystem: locations. For example, the
following configuration would search for scripts in both the default classpath location and the
/opt/migration directory:

Properties

spring.flyway.locations=classpath:db/migration,filesystem:/opt/migration

Yaml

spring:
  flyway:
  locations: "classpath:db/migration,filesystem:/opt/migration"

You can also add a special {vendor} placeholder to use vendor-specific scripts. Assume the

458
following:

Properties

spring.flyway.locations=classpath:db/migration/{vendor}

Yaml

spring:
  flyway:
  locations: "classpath:db/migration/{vendor}"

Rather than using db/migration, the preceding configuration sets the directory to use according to
the type of the database (such as db/migration/mysql for MySQL). The list of supported databases is
available in DatabaseDriver.

Migrations can also be written in Java. Flyway will be auto-configured with any beans that
implement JavaMigration.

FlywayProperties provides most of Flyway’s settings and a small set of additional properties that can
be used to disable the migrations or switch off the location checking. If you need more control over
the configuration, consider registering a FlywayConfigurationCustomizer bean.

Spring Boot calls Flyway.migrate() to perform the database migration. If you would like more
control, provide a @Bean that implements FlywayMigrationStrategy.

Flyway supports SQL and Java callbacks. To use SQL-based callbacks, place the callback scripts in
the classpath:db/migration directory. To use Java-based callbacks, create one or more beans that
implement Callback. Any such beans are automatically registered with Flyway. They can be ordered
by using @Order or by implementing Ordered. Beans that implement the deprecated FlywayCallback
interface can also be detected, however they cannot be used alongside Callback beans.

By default, Flyway autowires the (@Primary) DataSource in your context and uses that for migrations.
If you like to use a different DataSource, you can create one and mark its @Bean as @FlywayDataSource.
If you do so and want two data sources, remember to create another one and mark it as @Primary.
Alternatively, you can use Flyway’s native DataSource by setting spring.flyway.[url,user,password]
in external properties. Setting either spring.flyway.url or spring.flyway.user is sufficient to cause
Flyway to use its own DataSource. If any of the three properties has not been set, the value of its
equivalent spring.datasource property will be used.

You can also use Flyway to provide data for specific scenarios. For example, you can place test-
specific migrations in src/test/resources and they are run only when your application starts for
testing. Also, you can use profile-specific configuration to customize spring.flyway.locations so that
certain migrations run only when a particular profile is active. For example, in application-
dev.properties, you might specify the following setting:

459
Properties

spring.flyway.locations=classpath:/db/migration,classpath:/dev/db/migration

Yaml

spring:
  flyway:
  locations: "classpath:/db/migration,classpath:/dev/db/migration"

With that setup, migrations in dev/db/migration run only when the dev profile is active.

Execute Liquibase Database Migrations on Startup

To automatically run Liquibase database migrations on startup, add the org.liquibase:liquibase-

core to your classpath.

When you add the org.liquibase:liquibase-core to your classpath, database

migrations run by default for both during application startup and before your tests
run. This behavior can be customized by using the spring.liquibase.enabled
NOTE
property, setting different values in the main and test configurations. It is not
possible to use two different ways to initialize the database (for example Liquibase
for application startup, JPA for test runs).

By default, the master change log is read from db/changelog/db.changelog-master.yaml, but you can
change the location by setting spring.liquibase.change-log. In addition to YAML, Liquibase also
supports JSON, XML, and SQL change log formats.

By default, Liquibase autowires the (@Primary) DataSource in your context and uses that for
migrations. If you need to use a different DataSource, you can create one and mark its @Bean as
@LiquibaseDataSource. If you do so and you want two data sources, remember to create another one
and mark it as @Primary. Alternatively, you can use Liquibase’s native DataSource by setting
spring.liquibase.[driver-class-name,url,user,password] in external properties. Setting either
spring.liquibase.url or spring.liquibase.user is sufficient to cause Liquibase to use its own
DataSource. If any of the three properties has not been set, the value of its equivalent
spring.datasource property will be used.

See LiquibaseProperties for details about available settings such as contexts, the default schema,
and others.

17.8.6. Depend Upon an Initialized Database

Database initialization is performed while the application is starting up as part of application

context refresh. To allow an initialized database to be accessed during startup, beans that act as
database initializers and beans that require that database to have been initialized are detected
automatically. Beans whose initialization depends upon the database having been initialized are
configured to depend upon those that initialize it. If, during startup, your application tries to access
the database and it has not been initialized, you can configure additional detection of beans that

460
initialize the database and require the database to have been initialized.

Detect a Database Initializer

Spring Boot will automatically detect beans of the following types that initialize an SQL database:

• DataSourceScriptDatabaseInitializer

• EntityManagerFactory

• Flyway

• FlywayMigrationInitializer

• R2dbcScriptDatabaseInitializer

• SpringLiquibase

If you are using a third-party starter for a database initialization library, it may provide a detector
such that beans of other types are also detected automatically. To have other beans be detected,
register an implementation of DatabaseInitializerDetector in META-INF/spring-factories.

Detect a Bean That Depends On Database Initialization

Spring Boot will automatically detect beans of the following types that depends upon database
initialization:

• AbstractEntityManagerFactoryBean (unless spring.jpa.defer-datasource-initialization is set to

true)

• DSLContext (jOOQ)

• EntityManagerFactory (unless spring.jpa.defer-datasource-initialization is set to true)

• JdbcOperations

• NamedParameterJdbcOperations

If you are using a third-party starter data access library, it may provide a detector such that beans
of other types are also detected automatically. To have other beans be detected, register an
implementation of DependsOnDatabaseInitializationDetector in META-INF/spring-factories.
Alternatively, annotate the bean’s class or its @Bean method with @DependsOnDatabaseInitialization.

17.9. Messaging
Spring Boot offers a number of starters to support messaging. This section answers questions that
arise from using messaging with Spring Boot.

17.9.1. Disable Transacted JMS Session

If your JMS broker does not support transacted sessions, you have to disable the support of
transactions altogether. If you create your own JmsListenerContainerFactory, there is nothing to do,
since, by default it cannot be transacted. If you want to use the
DefaultJmsListenerContainerFactoryConfigurer to reuse Spring Boot’s default, you can disable
transacted sessions, as follows:

461
 import jakarta.jms.ConnectionFactory;

import
org.springframework.boot.autoconfigure.jms.DefaultJmsListenerContainerFactoryConfigure
r;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jms.config.DefaultJmsListenerContainerFactory;

@Configuration(proxyBeanMethods = false)
public class MyJmsConfiguration {

  @Bean
  public DefaultJmsListenerContainerFactory
jmsListenerContainerFactory(ConnectionFactory connectionFactory,
  DefaultJmsListenerContainerFactoryConfigurer configurer) {
  DefaultJmsListenerContainerFactory listenerFactory = new
DefaultJmsListenerContainerFactory();
  configurer.configure(listenerFactory, connectionFactory);
  listenerFactory.setTransactionManager(null);
  listenerFactory.setSessionTransacted(false);
  return listenerFactory;
  }

The preceding example overrides the default factory, and it should be applied to any other factory
that your application defines, if any.

17.10. Batch Applications

A number of questions often arise when people use Spring Batch from within a Spring Boot
application. This section addresses those questions.

17.10.1. Specifying a Batch Data Source

By default, batch applications require a DataSource to store job details. Spring Batch expects a single
DataSource by default. To have it use a DataSource other than the application’s main DataSource,
declare a DataSource bean, annotating its @Bean method with @BatchDataSource. If you do so and want
two data sources, remember to mark the other one @Primary. To take greater control, implement
BatchConfigurer. See The Javadoc of @EnableBatchProcessing for more details.

For more info about Spring Batch, see the Spring Batch project page.

17.10.2. Running Spring Batch Jobs on Startup

Spring Batch auto-configuration is enabled by adding @EnableBatchProcessing to one of your

@Configuration classes.

462
By default, it executes all Jobs in the application context on startup (see
JobLauncherApplicationRunner for details). You can narrow down to a specific job or jobs by
specifying spring.batch.job.names (which takes a comma-separated list of job name patterns).

See BatchAutoConfiguration and @EnableBatchProcessing for more details.

17.10.3. Running from the Command Line

Spring Boot converts any command line argument starting with -- to a property to add to the
Environment, see accessing command line properties. This should not be used to pass arguments to
batch jobs. To specify batch arguments on the command line, use the regular format (that is
without --), as shown in the following example:

$ java -jar myapp.jar someParameter=someValue anotherParameter=anotherValue

If you specify a property of the Environment on the command line, it is ignored by the job. Consider
the following command:

$ java -jar myapp.jar --server.port=7070 someParameter=someValue

This provides only one argument to the batch job: someParameter=someValue.

17.10.4. Storing the Job Repository

Spring Batch requires a data store for the Job repository. If you use Spring Boot, you must use an
actual database. Note that it can be an in-memory database, see Configuring a Job Repository.

17.11. Actuator
Spring Boot includes the Spring Boot Actuator. This section answers questions that often arise from
its use.

17.11.1. Change the HTTP Port or Address of the Actuator Endpoints

In a standalone application, the Actuator HTTP port defaults to the same as the main HTTP port. To
make the application listen on a different port, set the external property: management.server.port. To
listen on a completely different network address (such as when you have an internal network for
management and an external one for user applications), you can also set management.server.address
to a valid IP address to which the server is able to bind.

For more detail, see the ManagementServerProperties source code and “Customizing the Management
Server Port” in the “Production-ready features” section.

17.11.2. Customize the ‘whitelabel’ Error Page

Spring Boot installs a ‘whitelabel’ error page that you see in a browser client if you encounter a
server error (machine clients consuming JSON and other media types should see a sensible

463
response with the right error code).

Set server.error.whitelabel.enabled=false to switch the default error page off.

Doing so restores the default of the servlet container that you are using. Note that
NOTE
Spring Boot still tries to resolve the error view, so you should probably add your
own error page rather than disabling it completely.

Overriding the error page with your own depends on the templating technology that you use. For
example, if you use Thymeleaf, you can add an error.html template. If you use FreeMarker, you can
add an error.ftlh template. In general, you need a View that resolves with a name of error or a
@Controller that handles the /error path. Unless you replaced some of the default configuration,
you should find a BeanNameViewResolver in your ApplicationContext, so a @Bean named error would
be one way of doing that. See ErrorMvcAutoConfiguration for more options.

See also the section on “Error Handling” for details of how to register handlers in the servlet
container.

17.11.3. Sanitize Sensitive Values

Information returned by the env and configprops endpoints can be somewhat sensitive so keys
matching certain patterns are sanitized by default (that is their values are replaced by ******).
Spring Boot uses sensible defaults for such keys: any key ending with the word "password", "secret",
"key", "token", "vcap_services", "sun.java.command" is entirely sanitized. Additionally, any key that
holds the word credentials (configured as a regular expression, that is *credentials.*) as part of
the key is also entirely sanitized.

Furthermore, Spring Boot sanitizes the sensitive portion of URI-like values for keys with one of the
following endings:

• address

• addresses

• uri

• uris

• url

• urls

The sensitive portion of the URI is identified using the format

<scheme>://<username>:<password>@<host>:<port>/. For example, for the property
myclient.uri=http://user1:password1@localhost:8081, the resulting sanitized value is
http://user1:******@localhost:8081.

The default patterns used by the env and configprops endpoints can be replaced using
management.endpoint.env.keys-to-sanitize and management.endpoint.configprops.keys-to-sanitize
respectively. Alternatively, additional patterns can be configured using
management.endpoint.env.additional-keys-to-sanitize and
management.endpoint.configprops.additional-keys-to-sanitize.

464
17.11.4. Map Health Indicators to Micrometer Metrics

Spring Boot health indicators return a Status type to indicate the overall system health. If you want
to monitor or alert on levels of health for a particular application, you can export these statuses as
metrics with Micrometer. By default, the status codes “UP”, “DOWN”, “OUT_OF_SERVICE” and
“UNKNOWN” are used by Spring Boot. To export these, you will need to convert these states to some
set of numbers so that they can be used with a Micrometer Gauge.

The following example shows one way to write such an exporter:

import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;

import org.springframework.boot.actuate.health.HealthEndpoint;
import org.springframework.boot.actuate.health.Status;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyHealthMetricsExportConfiguration {

  public MyHealthMetricsExportConfiguration(MeterRegistry registry, HealthEndpoint

healthEndpoint) {
  // This example presumes common tags (such as the app) are applied elsewhere
  Gauge.builder("health", healthEndpoint,
this::getStatusCode).strongReference(true).register(registry);
  }

  private int getStatusCode(HealthEndpoint health) {

  Status status = health.health().getStatus();
  if (Status.UP.equals(status)) {
  return 3;
  }
  if (Status.OUT_OF_SERVICE.equals(status)) {
  return 2;
  }
  if (Status.DOWN.equals(status)) {
  return 1;
  }
  return 0;
  }

17.12. Security
This section addresses questions about security when working with Spring Boot, including
questions that arise from using Spring Security with Spring Boot.

For more about Spring Security, see the Spring Security project page.

465
17.12.1. Switch off the Spring Boot Security Configuration

If you define a @Configuration with a WebSecurityConfigurerAdapter or a SecurityFilterChain bean in

your application, it switches off the default webapp security settings in Spring Boot.

17.12.2. Change the UserDetailsService and Add User Accounts

If you provide a @Bean of type AuthenticationManager, AuthenticationProvider, or UserDetailsService,

the default @Bean for InMemoryUserDetailsManager is not created. This means you have the full feature
set of Spring Security available (such as various authentication options).

The easiest way to add user accounts is to provide your own UserDetailsService bean.

17.12.3. Enable HTTPS When Running behind a Proxy Server

Ensuring that all your main endpoints are only available over HTTPS is an important chore for any
application. If you use Tomcat as a servlet container, then Spring Boot adds Tomcat’s own
RemoteIpValve automatically if it detects some environment settings, and you should be able to rely
on the HttpServletRequest to report whether it is secure or not (even downstream of a proxy server
that handles the real SSL termination). The standard behavior is determined by the presence or
absence of certain request headers (x-forwarded-for and x-forwarded-proto), whose names are
conventional, so it should work with most front-end proxies. You can switch on the valve by adding
some entries to application.properties, as shown in the following example:

Properties

server.tomcat.remoteip.remote-ip-header=x-forwarded-for
server.tomcat.remoteip.protocol-header=x-forwarded-proto

Yaml

server:
  tomcat:
  remoteip:
  remote-ip-header: "x-forwarded-for"
  protocol-header: "x-forwarded-proto"

(The presence of either of those properties switches on the valve. Alternatively, you can add the
RemoteIpValve by customizing the TomcatServletWebServerFactory using a WebServerFactoryCustomizer
bean.)

To configure Spring Security to require a secure channel for all (or some) requests, consider adding
your own SecurityFilterChain bean that adds the following HttpSecurity configuration:

466
 import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.web.SecurityFilterChain;

@Configuration
public class MySecurityConfig {

  @Bean
  public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception
{
  // Customize the application security ...
  http.requiresChannel().anyRequest().requiresSecure();
  return http.build();
  }

17.13. Hot Swapping

Spring Boot supports hot swapping. This section answers questions about how it works.

17.13.1. Reload Static Content

There are several options for hot reloading. The recommended approach is to use spring-boot-
devtools, as it provides additional development-time features, such as support for fast application
restarts and LiveReload as well as sensible development-time configuration (such as template
caching). Devtools works by monitoring the classpath for changes. This means that static resource
changes must be "built" for the change to take effect. By default, this happens automatically in
Eclipse when you save your changes. In IntelliJ IDEA, the Make Project command triggers the
necessary build. Due to the default restart exclusions, changes to static resources do not trigger a
restart of your application. They do, however, trigger a live reload.

Alternatively, running in an IDE (especially with debugging on) is a good way to do development
(all modern IDEs allow reloading of static resources and usually also allow hot-swapping of Java
class changes).

Finally, the Maven and Gradle plugins can be configured (see the addResources property) to support
running from the command line with reloading of static files directly from source. You can use that
with an external css/js compiler process if you are writing that code with higher-level tools.

17.13.2. Reload Templates without Restarting the Container

Most of the templating technologies supported by Spring Boot include a configuration option to
disable caching (described later in this document). If you use the spring-boot-devtools module,
these properties are automatically configured for you at development time.

467
Thymeleaf Templates

If you use Thymeleaf, set spring.thymeleaf.cache to false. See ThymeleafAutoConfiguration for other
Thymeleaf customization options.

FreeMarker Templates

If you use FreeMarker, set spring.freemarker.cache to false. See FreeMarkerAutoConfiguration for

other FreeMarker customization options.

Groovy Templates

If you use Groovy templates, set spring.groovy.template.cache to false. See

GroovyTemplateAutoConfiguration for other Groovy customization options.

17.13.3. Fast Application Restarts

The spring-boot-devtools module includes support for automatic application restarts. While not as
fast as technologies such as JRebel it is usually significantly faster than a “cold start”. You should
probably give it a try before investigating some of the more complex reload options discussed later
in this document.

For more details, see the Developer Tools section.

17.13.4. Reload Java Classes without Restarting the Container

Many modern IDEs (Eclipse, IDEA, and others) support hot swapping of bytecode. Consequently, if
you make a change that does not affect class or method signatures, it should reload cleanly with no
side effects.

17.14. Testing
Spring Boot includes a number of testing utilities and support classes as well as a dedicated starter
that provides common test dependencies. This section answers common questions about testing.

17.14.1. Testing With Spring Security

Spring Security provides support for running tests as a specific user. For example, the test in the
snippet below will run with an authenticated user that has the ADMIN role.

468
 import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.security.test.context.support.WithMockUser;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;

@WebMvcTest(UserController.class)
class MySecurityTests {

  @Autowired
  private MockMvc mvc;

  @Test
  @WithMockUser(roles = "ADMIN")
  void requestProtectedUrlWithUser() throws Exception {
  this.mvc.perform(get("/"));
  }

Spring Security provides comprehensive integration with Spring MVC Test and this can also be used
when testing controllers using the @WebMvcTest slice and MockMvc.

For additional details on Spring Security’s testing support, see Spring Security’s reference
documentation.

17.14.2. Use Testcontainers for Integration Testing

The Testcontainers library provides a way to manage services running inside Docker containers. It
integrates with JUnit, allowing you to write a test class that can start up a container before any of
the tests run. Testcontainers is especially useful for writing integration tests that talk to a real
backend service such as MySQL, MongoDB, Cassandra and others. Testcontainers can be used in a
Spring Boot test as follows:

469
 import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
@Testcontainers
class MyIntegrationTests {

  @Container
  static Neo4jContainer<?> neo4j = new Neo4jContainer<>("neo4j:4.2");

  @Test
  void myTest() {
  // ...
  }

This will start up a docker container running Neo4j (if Docker is running locally) before any of the
tests are run. In most cases, you will need to configure the application using details from the
running container, such as container IP or port.

This can be done with a static @DynamicPropertySource method that allows adding dynamic property
values to the Spring Environment.

470
 import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;

@SpringBootTest
@Testcontainers
class MyIntegrationTests {

  @Container
  static Neo4jContainer<?> neo4j = new Neo4jContainer<>("neo4j:4.2");

  @Test
  void myTest() {
  // ...
  }

  @DynamicPropertySource
  static void neo4jProperties(DynamicPropertyRegistry registry) {
  registry.add("spring.neo4j.uri", neo4j::getBoltUrl);
  }

The above configuration allows Neo4j-related beans in the application to communicate with Neo4j
running inside the Testcontainers-managed Docker container.

17.15. Build
Spring Boot includes build plugins for Maven and Gradle. This section answers common questions
about these plugins.

17.15.1. Generate Build Information

Both the Maven plugin and the Gradle plugin allow generating build information containing the
coordinates, name, and version of the project. The plugins can also be configured to add additional
properties through configuration. When such a file is present, Spring Boot auto-configures a
BuildProperties bean.

To generate build information with Maven, add an execution for the build-info goal, as shown in
the following example:

471
 <build>
  <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <version>3.0.0-SNAPSHOT</version>
  <executions>
  <execution>
  <goals>
  <goal>build-info</goal>
  </goals>
  </execution>
  </executions>
  </plugin>
  </plugins>
</build>

TIP See the Spring Boot Maven Plugin documentation for more details.

The following example does the same with Gradle:

springBoot {
  buildInfo()
}

TIP See the Spring Boot Gradle Plugin documentation for more details.

17.15.2. Generate Git Information

Both Maven and Gradle allow generating a git.properties file containing information about the
state of your git source code repository when the project was built.

For Maven users, the spring-boot-starter-parent POM includes a pre-configured plugin to generate
a git.properties file. To use it, add the following declaration for the Git Commit Id Plugin to your
POM:

<build>
  <plugins>
  <plugin>
  <groupId>io.github.git-commit-id</groupId>
  <artifactId>git-commit-id-maven-plugin</artifactId>
  </plugin>
  </plugins>
</build>

Gradle users can achieve the same result by using the gradle-git-properties plugin, as shown in the

472
following example:

plugins {
  id "com.gorylenko.gradle-git-properties" version "2.3.2"
}

Both the Maven and Gradle plugins allow the properties that are included in git.properties to be
configured.

The commit time in git.properties is expected to match the following format: yyyy-MM-
dd’T’HH:mm:ssZ. This is the default format for both plugins listed above. Using this
TIP
format lets the time be parsed into a Date and its format, when serialized to JSON, to
be controlled by Jackson’s date serialization configuration settings.

17.15.3. Customize Dependency Versions

The spring-boot-dependencies POM manages the versions of common dependencies. The Spring
Boot plugins for Maven and Gradle allow these managed dependency versions to be customized
using build properties.

Each Spring Boot release is designed and tested against this specific set of
WARNING
third-party dependencies. Overriding versions may cause compatibility issues.

To override dependency versions with Maven, see this section of the Maven plugin’s
documentation.

To override dependency versions in Gradle, see this section of the Gradle plugin’s documentation.

17.15.4. Create an Executable JAR with Maven

The spring-boot-maven-plugin can be used to create an executable “fat” JAR. If you use the spring-
boot-starter-parent POM, you can declare the plugin and your jars are repackaged as follows:

<build>
  <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  </plugin>
  </plugins>
</build>

If you do not use the parent POM, you can still use the plugin. However, you must additionally add
an <executions> section, as follows:

473
 <build>
  <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <version>{spring-boot-version}</version>
  <executions>
  <execution>
  <goals>
  <goal>repackage</goal>
  </goals>
  </execution>
  </executions>
  </plugin>
  </plugins>
</build>

See the plugin documentation for full usage details.

17.15.5. Use a Spring Boot Application as a Dependency

Like a war file, a Spring Boot application is not intended to be used as a dependency. If your
application contains classes that you want to share with other projects, the recommended approach
is to move that code into a separate module. The separate module can then be depended upon by
your application and other projects.

If you cannot rearrange your code as recommended above, Spring Boot’s Maven and Gradle plugins
must be configured to produce a separate artifact that is suitable for use as a dependency. The
executable archive cannot be used as a dependency as the executable jar format packages
application classes in BOOT-INF/classes. This means that they cannot be found when the executable
jar is used as a dependency.

To produce the two artifacts, one that can be used as a dependency and one that is executable, a
classifier must be specified. This classifier is applied to the name of the executable archive, leaving
the default archive for use as a dependency.

To configure a classifier of exec in Maven, you can use the following configuration:

474
 <build>
  <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <configuration>
  <classifier>exec</classifier>
  </configuration>
  </plugin>
  </plugins>
</build>

17.15.6. Extract Specific Libraries When an Executable Jar Runs

Most nested libraries in an executable jar do not need to be unpacked in order to run. However,
certain libraries can have problems. For example, JRuby includes its own nested jar support, which
assumes that the jruby-complete.jar is always directly available as a file in its own right.

To deal with any problematic libraries, you can flag that specific nested jars should be
automatically unpacked when the executable jar first runs. Such nested jars are written beneath
the temporary directory identified by the java.io.tmpdir system property.

Care should be taken to ensure that your operating system is configured so that
WARNING it will not delete the jars that have been unpacked to the temporary directory
while the application is still running.

For example, to indicate that JRuby should be flagged for unpacking by using the Maven Plugin, you
would add the following configuration:

<build>
  <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <configuration>
  <requiresUnpack>
  <dependency>
  <groupId>org.jruby</groupId>
  <artifactId>jruby-complete</artifactId>
  </dependency>
  </requiresUnpack>
  </configuration>
  </plugin>
  </plugins>
</build>

475
17.15.7. Create a Non-executable JAR with Exclusions

Often, if you have an executable and a non-executable jar as two separate build products, the
executable version has additional configuration files that are not needed in a library jar. For
example, the application.yml configuration file might be excluded from the non-executable JAR.

In Maven, the executable jar must be the main artifact and you can add a classified jar for the
library, as follows:

<build>
  <plugins>
  <plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  </plugin>
  <plugin>
  <artifactId>maven-jar-plugin</artifactId>
  <executions>
  <execution>
  <id>lib</id>
  <phase>package</phase>
  <goals>
  <goal>jar</goal>
  </goals>
  <configuration>
  <classifier>lib</classifier>
  <excludes>
  <exclude>application.yml</exclude>
  </excludes>
  </configuration>
  </execution>
  </executions>
  </plugin>
  </plugins>
</build>

17.15.8. Remote Debug a Spring Boot Application Started with Maven

To attach a remote debugger to a Spring Boot application that was started with Maven, you can use
the jvmArguments property of the maven plugin.

See this example for more details.

17.15.9. Build an Executable Archive from Ant without Using spring-boot-

antlib

To build with Ant, you need to grab dependencies, compile, and then create a jar or war archive. To
make it executable, you can either use the spring-boot-antlib module or you can follow these
instructions:

476
1. If you are building a jar, package the application’s classes and resources in a nested BOOT-
INF/classes directory. If you are building a war, package the application’s classes in a nested
WEB-INF/classes directory as usual.

2. Add the runtime dependencies in a nested BOOT-INF/lib directory for a jar or WEB-INF/lib for a
war. Remember not to compress the entries in the archive.

3. Add the provided (embedded container) dependencies in a nested BOOT-INF/lib directory for a
jar or WEB-INF/lib-provided for a war. Remember not to compress the entries in the archive.

4. Add the spring-boot-loader classes at the root of the archive (so that the Main-Class is available).

5. Use the appropriate launcher (such as JarLauncher for a jar file) as a Main-Class attribute in the
manifest and specify the other properties it needs as manifest entries — principally, by setting a
Start-Class property.

The following example shows how to build an executable archive with Ant:

<target name="build" depends="compile">

  <jar destfile="target/${ant.project.name}-${spring-boot.version}.jar"
compress="false">
  <mappedresources>
  <fileset dir="target/classes" />
  <globmapper from="*" to="BOOT-INF/classes/*"/>
  </mappedresources>
  <mappedresources>
  <fileset dir="src/main/resources" erroronmissingdir="false"/>
  <globmapper from="*" to="BOOT-INF/classes/*"/>
  </mappedresources>
  <mappedresources>
  <fileset dir="${lib.dir}/runtime" />
  <globmapper from="*" to="BOOT-INF/lib/*"/>
  </mappedresources>
  <zipfileset src="${lib.dir}/loader/spring-boot-loader-jar-${spring-
boot.version}.jar" />
  <manifest>
  <attribute name="Main-Class"
value="org.springframework.boot.loader.JarLauncher" />
  <attribute name="Start-Class" value="${start-class}" />
  </manifest>
  </jar>
</target>

17.16. Traditional Deployment

Spring Boot supports traditional deployment as well as more modern forms of deployment. This
section answers common questions about traditional deployment.

477
17.16.1. Create a Deployable War File

Because Spring WebFlux does not strictly depend on the servlet API and
WARNING applications are deployed by default on an embedded Reactor Netty server,
War deployment is not supported for WebFlux applications.

The first step in producing a deployable war file is to provide a SpringBootServletInitializer

subclass and override its configure method. Doing so makes use of Spring Framework’s servlet 3.0
support and lets you configure your application when it is launched by the servlet container.
Typically, you should update your application’s main class to extend SpringBootServletInitializer,
as shown in the following example:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

@SpringBootApplication
public class MyApplication extends SpringBootServletInitializer {

  @Override
  protected SpringApplicationBuilder configure(SpringApplicationBuilder application)
{
  return application.sources(MyApplication.class);
  }

  public static void main(String[] args) {

  SpringApplication.run(MyApplication.class, args);
  }

The next step is to update your build configuration such that your project produces a war file
rather than a jar file. If you use Maven and spring-boot-starter-parent (which configures Maven’s
war plugin for you), all you need to do is to modify pom.xml to change the packaging to war, as
follows:

<packaging>war</packaging>

If you use Gradle, you need to modify build.gradle to apply the war plugin to the project, as follows:

apply plugin: 'war'

The final step in the process is to ensure that the embedded servlet container does not interfere
with the servlet container to which the war file is deployed. To do so, you need to mark the
embedded servlet container dependency as being provided.

478
If you use Maven, the following example marks the servlet container (Tomcat, in this case) as being
provided:

<dependencies>
  <!-- ... -->
  <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-tomcat</artifactId>
  <scope>provided</scope>
  </dependency>
  <!-- ... -->
</dependencies>

If you use Gradle, the following example marks the servlet container (Tomcat, in this case) as being
provided:

dependencies {
  // ...
  providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
  // ...
}

providedRuntime is preferred to Gradle’s compileOnly configuration. Among other

TIP limitations, compileOnly dependencies are not on the test classpath, so any web-based
integration tests fail.

If you use the Spring Boot build tools, marking the embedded servlet container dependency as
provided produces an executable war file with the provided dependencies packaged in a lib-
provided directory. This means that, in addition to being deployable to a servlet container, you can
also run your application by using java -jar on the command line.

17.16.2. Convert an Existing Application to Spring Boot

To convert an existing non-web Spring application to a Spring Boot application, replace the code
that creates your ApplicationContext and replace it with calls to SpringApplication or
SpringApplicationBuilder. Spring MVC web applications are generally amenable to first creating a
deployable war application and then migrating it later to an executable war or jar. See the Getting
Started Guide on Converting a jar to a war.

To create a deployable war by extending SpringBootServletInitializer (for example, in a class

called Application) and adding the Spring Boot @SpringBootApplication annotation, use code similar
to that shown in the following example:

479
 import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

@SpringBootApplication
public class MyApplication extends SpringBootServletInitializer {

  @Override
  protected SpringApplicationBuilder configure(SpringApplicationBuilder application)
{
  // Customize the application or call application.sources(...) to add sources
  // Since our example is itself a @Configuration class (via
@SpringBootApplication)
  // we actually do not need to override this method.
  return application;
  }

Remember that, whatever you put in the sources is merely a Spring ApplicationContext. Normally,
anything that already works should work here. There might be some beans you can remove later
and let Spring Boot provide its own defaults for them, but it should be possible to get something
working before you need to do that.

Static resources can be moved to /public (or /static or /resources or /META-INF/resources) in the
classpath root. The same applies to messages.properties (which Spring Boot automatically detects in
the root of the classpath).

Vanilla usage of Spring DispatcherServlet and Spring Security should require no further changes. If
you have other features in your application (for instance, using other servlets or filters), you may
need to add some configuration to your Application context, by replacing those elements from the
web.xml, as follows:

• A @Bean of type Servlet or ServletRegistrationBean installs that bean in the container as if it

were a <servlet/> and <servlet-mapping/> in web.xml.

• A @Bean of type Filter or FilterRegistrationBean behaves similarly (as a <filter/> and <filter-
mapping/>).

• An ApplicationContext in an XML file can be added through an @ImportResource in your

Application. Alternatively, cases where annotation configuration is heavily used already can be
recreated in a few lines as @Bean definitions.

Once the war file is working, you can make it executable by adding a main method to your
Application, as shown in the following example:

480
 public static void main(String[] args) {
  SpringApplication.run(MyApplication.class, args);
}

If you intend to start your application as a war or as an executable application, you

need to share the customizations of the builder in a method that is both available to
the SpringBootServletInitializer callback and in the main method in a class similar
to the following:

import org.springframework.boot.Banner;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import
org.springframework.boot.web.servlet.support.SpringBootServletInitialize
r;

@SpringBootApplication
public class MyApplication extends SpringBootServletInitializer {

  @Override
NOTE
  protected SpringApplicationBuilder
configure(SpringApplicationBuilder builder) {
  return customizerBuilder(builder);
  }

  public static void main(String[] args) {

  customizerBuilder(new SpringApplicationBuilder()).run(args);
  }

  private static SpringApplicationBuilder

customizerBuilder(SpringApplicationBuilder builder) {
  return
builder.sources(MyApplication.class).bannerMode(Banner.Mode.OFF);
  }

Applications can fall into more than one category:

• Servlet 3.0+ applications with no web.xml.

• Applications with a web.xml.

• Applications with a context hierarchy.

• Applications without a context hierarchy.

All of these should be amenable to translation, but each might require slightly different techniques.

Servlet 3.0+ applications might translate pretty easily if they already use the Spring Servlet 3.0+

481
initializer support classes. Normally, all the code from an existing WebApplicationInitializer can be
moved into a SpringBootServletInitializer. If your existing application has more than one
ApplicationContext (for example, if it uses AbstractDispatcherServletInitializer) then you might be
able to combine all your context sources into a single SpringApplication. The main complication you
might encounter is if combining does not work and you need to maintain the context hierarchy. See
the entry on building a hierarchy for examples. An existing parent context that contains web-
specific features usually needs to be broken up so that all the ServletContextAware components are
in the child context.

Applications that are not already Spring applications might be convertible to Spring Boot
applications, and the previously mentioned guidance may help. However, you may yet encounter
problems. In that case, we suggest asking questions on Stack Overflow with a tag of spring-boot.

17.16.3. Deploying a WAR to WebLogic

To deploy a Spring Boot application to WebLogic, you must ensure that your servlet initializer
directly implements WebApplicationInitializer (even if you extend from a base class that already
implements it).

A typical initializer for WebLogic should resemble the following example:

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import org.springframework.web.WebApplicationInitializer;

@SpringBootApplication
public class MyApplication extends SpringBootServletInitializer implements
WebApplicationInitializer {

If you use Logback, you also need to tell WebLogic to prefer the packaged version rather than the
version that was pre-installed with the server. You can do so by adding a WEB-INF/weblogic.xml file
with the following contents:

482
<?xml version="1.0" encoding="UTF-8"?>
<wls:weblogic-web-app
  xmlns:wls="http://xmlns.oracle.com/weblogic/weblogic-web-app"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
  https://java.sun.com/xml/ns/javaee/ejb-jar_3_0.xsd
  http://xmlns.oracle.com/weblogic/weblogic-web-app
  https://xmlns.oracle.com/weblogic/weblogic-web-app/1.4/weblogic-web-app.xsd">
  <wls:container-descriptor>
  <wls:prefer-application-packages>
  <wls:package-name>org.slf4j</wls:package-name>
  </wls:prefer-application-packages>
  </wls:container-descriptor>
</wls:weblogic-web-app>

483
Appendices

484
Appendix A: Common Application
Properties
Various properties can be specified inside your application.properties file, inside your
application.yml file, or as command line switches. This appendix provides a list of common Spring
Boot properties and references to the underlying classes that consume them.

Spring Boot provides various conversion mechanism with advanced value formatting,
TIP
make sure to review the properties conversion section.

Property contributions can come from additional jar files on your classpath, so you
NOTE should not consider this an exhaustive list. Also, you can define your own
properties.

A.1. Core Properties

Name Description Default Value

debug Enable debug logs. false

info.* Arbitrary properties to add

to the info endpoint.

logging.charset.console Charset to use for console

output.

logging.charset.file Charset to use for file

output.

logging.config Location of the logging

configuration file. For
instance,
`classpath:logback.xml` for
Logback.

logging.exception-conversion-word Conversion word used when %wEx

logging exceptions.

logging.file.name Log file name (for instance,

`myapp.log`). Names can be
an exact location or relative
to the current directory.

logging.file.path Location of the log file. For

instance, `/var/log`.

485
Name Description Default Value

logging.group.* Log groups to quickly

change multiple loggers at
the same time. For instance,
`logging.group.db=org.hiber
nate,org.springframework.jd
bc`.

logging.level.* Log levels severity mapping.

For instance,
`logging.level.org.springfra
mework=DEBUG`.

logging.log4j2.config.override Overriding configuration

files used to create a
composite configuration.

logging.logback.rollingpolicy.clean- Whether to clean the false

history-on-start archive log files on startup.

logging.logback.rollingpolicy.file- Pattern for rolled-over log ${LOG_FILE}.%d{yyyy-MM-

name-pattern file names. dd}.%i.gz

logging.logback.rollingpolicy.max- Maximum log file size. 10MB

file-size

logging.logback.rollingpolicy.max- Maximum number of 7

history archive log files to keep.

logging.logback.rollingpolicy.total- Total size of log backups to 0B

size-cap be kept.

logging.pattern.console Appender pattern for output %clr(%d{${LOG_DATEFORMAT_PA

to the console. Supported TTERN:-yyyy-MM-dd
HH:mm:ss.SSS}}){faint}
only with the default %clr(${LOG_LEVEL_PATTERN:-
Logback setup. %5p}) %clr(${PID:-
}){magenta} %clr(---
){faint}
%clr([%15.15t]){faint}
%clr(%-
40.40logger{39}){cyan}
%clr(:){faint}
%m%n${LOG_EXCEPTION_CONVERS
ION_WORD:-%wEx}

logging.pattern.dateformat Appender pattern for log yyyy-MM-dd HH:mm:ss.SSS

date format. Supported only
with the default Logback
setup.

486
Name Description Default Value

logging.pattern.file Appender pattern for output %d{${LOG_DATEFORMAT_PATTERN

to a file. Supported only :-yyyy-MM-dd HH:mm:ss.SSS}}
${LOG_LEVEL_PATTERN:-%5p}
with the default Logback ${PID:- } --- [%t] %-
setup. 40.40logger{39} :
%m%n${LOG_EXCEPTION_CONVERS
ION_WORD:-%wEx}

logging.pattern.level Appender pattern for log %5p

level. Supported only with
the default Logback setup.

logging.register-shutdown-hook Register a shutdown hook true

for the logging system when
it is initialized. Disabled
automatically when
deployed as a war file.

spring.aop.auto Add true

@EnableAspectJAutoProxy.

spring.aop.proxy-target-class Whether subclass-based true

(CGLIB) proxies are to be
created (true), as opposed to
standard Java interface-
based proxies (false).

spring.application.admin.enabled Whether to enable admin false

features for the application.

spring.application.admin.jmx-name JMX name of the application org.springframework.boot:ty

admin MBean. pe=Admin,name=SpringApplica
tion

spring.application.name Application name.

spring.autoconfigure.exclude Auto-configuration classes to

exclude.

spring.banner.charset Banner file encoding. UTF-8

spring.banner.image.bitdepth Bit depth to use for ANSI 4

colors. Supported values are
4 (16 color) or 8 (256 color).

spring.banner.image.height Height of the banner image

in chars (default based on
image height).

spring.banner.image.invert Whether images should be false

inverted for dark terminal
themes.

spring.banner.image.location Banner image file location classpath:banner.gif

(jpg or png can also be used).

487
Name Description Default Value

spring.banner.image.margin Left hand image margin in 2

chars.

spring.banner.image.pixelmode Pixel mode to use when TEXT

rendering the image.

spring.banner.image.width Width of the banner image 76

in chars.

spring.banner.location Banner text resource classpath:banner.txt

location.

spring.beaninfo.ignore Whether to skip search of true

BeanInfo classes.

spring.codec.log-request-details Whether to log form data at false

DEBUG level, and headers at
TRACE level.

spring.codec.max-in-memory-size Limit on the number of

bytes that can be buffered
whenever the input stream
needs to be aggregated. This
applies only to the auto-
configured WebFlux server
and WebClient instances. By
default this is not set, in
which case individual codec
defaults apply. Most codecs
are limited to 256K by
default.

spring.config.activate.on-cloud- Required cloud platform for

platform the document to be
included.

spring.config.activate.on-profile Profile expressions that

should match for the
document to be included.

spring.config.additional-location Config file locations used in

addition to the defaults.

spring.config.import Import additional config

data.

spring.config.location Config file locations that

replace the defaults.

spring.config.name Config file name. application

spring.info.build.encoding File encoding. UTF-8

488
Name Description Default Value

spring.info.build.location Location of the generated classpath:META-INF/build-

build-info.properties file. info.properties

spring.info.git.encoding File encoding. UTF-8

spring.info.git.location Location of the generated classpath:git.properties

git.properties file.

spring.jmx.default-domain JMX domain name.

spring.jmx.enabled Expose management beans false

to the JMX domain.

spring.jmx.server MBeanServer bean name. mbeanServer

spring.jmx.unique-names Whether unique runtime false

object names should be
ensured.

spring.lifecycle.timeout-per- Timeout for the shutdown of 30s

shutdown-phase any phase (group of
SmartLifecycle beans with
the same 'phase' value).

spring.main.allow-bean-definition- Whether bean definition false

overriding overriding, by registering a
definition with the same
name as an existing
definition, is allowed.

spring.main.allow-circular-references Whether to allow circular false

references between beans
and automatically try to
resolve them.

spring.main.banner-mode Mode used to display the console

banner when the
application runs.

spring.main.cloud-platform Override the Cloud Platform

auto-detection.

spring.main.lazy-initialization Whether initialization false

should be performed lazily.

spring.main.log-startup-info Whether to log information true

about the application when
it starts.

spring.main.register-shutdown-hook Whether the application true

should have a shutdown
hook registered.

489
Name Description Default Value

spring.main.sources Sources (class names,

package names, or XML
resource locations) to
include in the
ApplicationContext.

spring.main.web-application-type Flag to explicitly request a

specific type of web
application. If not set, auto-
detected based on the
classpath.

spring.mandatory-file-encoding Expected character encoding

the application must use.

spring.messages.always-use-message- Whether to always apply the false

format MessageFormat rules,
parsing even messages
without arguments.

spring.messages.basename Comma-separated list of messages

basenames (essentially a
fully-qualified classpath
location), each following the
ResourceBundle convention
with relaxed support for
slash based locations. If it
doesn't contain a package
qualifier (such as
"org.mypackage"), it will be
resolved from the classpath
root.

spring.messages.cache-duration Loaded resource bundle

files cache duration. When
not set, bundles are cached
forever. If a duration suffix
is not specified, seconds will
be used.

spring.messages.encoding Message bundles encoding. UTF-8

spring.messages.fallback-to-system- Whether to fall back to the true

locale system Locale if no files for
a specific Locale have been
found. if this is turned off,
the only fallback will be the
default file (e.g.
"messages.properties" for
basename "messages").

490
Name Description Default Value

spring.messages.use-code-as-default- Whether to use the message false

message code as the default message
instead of throwing a
"NoSuchMessageException".
Recommended during
development only.

spring.output.ansi.enabled Configures the ANSI output. detect

spring.pid.fail-on-write-error Fails if
ApplicationPidFileWriter is
used but it cannot write the
PID file.

spring.pid.file Location of the PID file to

write (if
ApplicationPidFileWriter is
used).

spring.profiles.active Comma-separated list of

active profiles. Can be
overridden by a command
line switch.

spring.profiles.default Name of the profile to default

enable if no profile is active.

spring.profiles.group.* Profile groups to define a

logical name for a related
group of profiles.

spring.profiles.include Unconditionally activate the

specified comma-separated
list of profiles (or list of
profiles if using YAML).

spring.quartz.auto-startup Whether to automatically true

start the scheduler after
initialization.

spring.quartz.jdbc.comment-prefix Prefixes for single-line [#, --]

comments in SQL
initialization scripts.

spring.quartz.jdbc.initialize-schema Database schema embedded

initialization mode.

spring.quartz.jdbc.platform Platform to use in

initialization scripts if the
@@platform@@
placeholder is used. Auto-
detected by default.

491
Name Description Default Value

spring.quartz.jdbc.schema Path to the SQL file to use to classpath:org/quartz/impl/j

initialize the database dbcjobstore/tables_@@platfo
rm@@.sql
schema.

spring.quartz.job-store-type Quartz job store type. memory

spring.quartz.overwrite-existing-jobs Whether configured jobs false

should overwrite existing
job definitions.

spring.quartz.properties.* Additional Quartz Scheduler

properties.

spring.quartz.scheduler-name Name of the scheduler. quartzScheduler

spring.quartz.startup-delay Delay after which the 0s

scheduler is started once
initialization completes.
Setting this property makes
sense if no jobs should be
run before the entire
application has started up.

spring.quartz.wait-for-jobs-to- Whether to wait for running false

complete-on-shutdown jobs to complete on
shutdown.

spring.reactor.debug-agent.enabled Whether the Reactor Debug true

Agent should be enabled
when reactor-tools is
present.

spring.task.execution.pool.allow- Whether core threads are true

core-thread-timeout allowed to time out. This
enables dynamic growing
and shrinking of the pool.

spring.task.execution.pool.core-size Core number of threads. 8

spring.task.execution.pool.keep-alive Time limit for which threads 60s

may remain idle before
being terminated.

spring.task.execution.pool.max-size Maximum allowed number

of threads. If tasks are filling
up the queue, the pool can
expand up to that size to
accommodate the load.
Ignored if the queue is
unbounded.

492
Name Description Default Value

spring.task.execution.pool.queue- Queue capacity. An

capacity unbounded capacity does
not increase the pool and
therefore ignores the "max-
size" property.

spring.task.execution.shutdown.await- Whether the executor false

termination should wait for scheduled
tasks to complete on
shutdown.

spring.task.execution.shutdown.await- Maximum time the executor

termination-period should wait for remaining
tasks to complete.

spring.task.execution.thread-name- Prefix to use for the names task-

prefix of newly created threads.

spring.task.scheduling.pool.size Maximum allowed number 1

of threads.

spring.task.scheduling.shutdown.await Whether the executor false

-termination should wait for scheduled
tasks to complete on
shutdown.

spring.task.scheduling.shutdown.await Maximum time the executor

-termination-period should wait for remaining
tasks to complete.

spring.task.scheduling.thread-name- Prefix to use for the names scheduling-

prefix of newly created threads.

trace Enable trace logs. false

A.2. Cache Properties

Name Description Default Value

spring.cache.cache-names Comma-separated list of

cache names to create if
supported by the underlying
cache manager. Usually, this
disables the ability to create
additional caches on-the-fly.

spring.cache.caffeine.spec The spec to use to create

caches. See CaffeineSpec for
more details on the spec
format.

493
Name Description Default Value

spring.cache.couchbase.expiration Entry expiration. By default

the entries never expire.
Note that this value is
ultimately converted to
seconds.

spring.cache.jcache.config The location of the

configuration file to use to
initialize the cache manager.
The configuration file is
dependent of the underlying
cache implementation.

spring.cache.jcache.provider Fully qualified name of the

CachingProvider
implementation to use to
retrieve the JSR-107
compliant cache manager.
Needed only if more than
one JSR-107 implementation
is available on the classpath.

spring.cache.redis.cache-null-values Allow caching null values. true

spring.cache.redis.enable-statistics Whether to enable cache false

statistics.

spring.cache.redis.key-prefix Key prefix.

spring.cache.redis.time-to-live Entry expiration. By default

the entries never expire.

spring.cache.redis.use-key-prefix Whether to use the key true

prefix when writing to
Redis.

spring.cache.type Cache type. By default, auto-

detected according to the
environment.

A.3. Mail Properties

Name Description Default Value

spring.mail.default-encoding Default MimeMessage UTF-8

encoding.

spring.mail.host SMTP server host. For

instance,
'smtp.example.com'.

494
Name Description Default Value

spring.mail.jndi-name Session JNDI name. When

set, takes precedence over
other Session settings.

spring.mail.password Login password of the SMTP

server.

spring.mail.port SMTP server port.

spring.mail.properties.* Additional JavaMail Session

properties.

spring.mail.protocol Protocol used by the SMTP smtp

server.

spring.mail.test-connection Whether to test that the mail false

server is available on
startup.

spring.mail.username Login user of the SMTP

server.

spring.sendgrid.api-key SendGrid API key.

spring.sendgrid.proxy.host SendGrid proxy host.

spring.sendgrid.proxy.port SendGrid proxy port.

A.4. JSON Properties

Name Description Default Value

spring.gson.date-format Format to use when

serializing Date objects.

spring.gson.disable-html-escaping Whether to disable the

escaping of HTML
characters such as '<', '>', etc.

spring.gson.disable-inner-class- Whether to exclude inner

serialization classes during serialization.

spring.gson.enable-complex-map-key- Whether to enable

serialization serialization of complex
map keys (i.e. non-
primitives).

spring.gson.exclude-fields-without- Whether to exclude all fields

expose-annotation from consideration for
serialization or
deserialization that do not
have the "Expose"
annotation.

495
Name Description Default Value

spring.gson.field-naming-policy Naming policy that should

be applied to an object's
field during serialization
and deserialization.

spring.gson.generate-non-executable- Whether to generate non

json executable JSON by
prefixing the output with
some special text.

spring.gson.lenient Whether to be lenient about

parsing JSON that doesn't
conform to RFC 4627.

spring.gson.long-serialization-policy Serialization policy for Long

and long types.

spring.gson.pretty-printing Whether to output serialized

JSON that fits in a page for
pretty printing.

spring.gson.serialize-nulls Whether to serialize null

fields.

spring.jackson.constructor-detector Strategy to use to auto-detect default

constructor, and in
particular behavior with
single-argument
constructors.

spring.jackson.date-format Date format string or a fully-

qualified date format class
name. For instance, 'yyyy-
MM-dd HH:mm:ss'.

spring.jackson.default-leniency Global default setting (if

any) for leniency.

spring.jackson.default-property- Controls the inclusion of

inclusion properties during
serialization. Configured
with one of the values in
Jackson's
JsonInclude.Include
enumeration.

spring.jackson.deserialization.* Jackson on/off features that

affect the way Java objects
are deserialized.

spring.jackson.generator.* Jackson on/off features for

generators.

496
Name Description Default Value

spring.jackson.locale Locale used for formatting.

spring.jackson.mapper.* Jackson general purpose

on/off features.

spring.jackson.parser.* Jackson on/off features for

parsers.

spring.jackson.property-naming- One of the constants on

strategy Jackson's
PropertyNamingStrategies.
Can also be a fully-qualified
class name of a
PropertyNamingStrategy
implementation.

spring.jackson.serialization.* Jackson on/off features that

affect the way Java objects
are serialized.

spring.jackson.time-zone Time zone used when

formatting dates. For
instance,
"America/Los_Angeles" or
"GMT+10".

spring.jackson.visibility.* Jackson visibility thresholds

that can be used to limit
which methods (and fields)
are auto-detected.

A.5. Data Properties

Name Description Default Value

spring.couchbase.connection-string Connection string used to

locate the Couchbase cluster.

spring.couchbase.env.io.idle-http- Length of time an HTTP 4500ms

connection-timeout connection may remain idle
before it is closed and
removed from the pool.

spring.couchbase.env.io.max-endpoints Maximum number of 12

sockets per node.

spring.couchbase.env.io.min-endpoints Minimum number of sockets 1

per node.

497
Name Description Default Value

spring.couchbase.env.ssl.enabled Whether to enable SSL

support. Enabled
automatically if a "keyStore"
is provided unless specified
otherwise.

spring.couchbase.env.ssl.key-store Path to the JVM key store

that holds the certificates.

spring.couchbase.env.ssl.key-store- Password used to access the

password key store.

spring.couchbase.env.timeouts.analyti Timeout for the analytics 75s

cs service.

spring.couchbase.env.timeouts.connect Bucket connect timeout. 10s

spring.couchbase.env.timeouts.disconn Bucket disconnect timeout. 10s

ect

spring.couchbase.env.timeouts.key- Timeout for operations on a 2500ms

value specific key-value.

spring.couchbase.env.timeouts.key- Timeout for operations on a 10s

value-durable specific key-value with a
durability level.

spring.couchbase.env.timeouts.managem Timeout for the 75s

ent management operations.

spring.couchbase.env.timeouts.query N1QL query operations 75s

timeout.

spring.couchbase.env.timeouts.search Timeout for the search 75s

service.

spring.couchbase.env.timeouts.view Regular and geospatial view 75s

operations timeout.

spring.couchbase.password Cluster password.

spring.couchbase.username Cluster username.

spring.dao.exceptiontranslation.enabl Whether to enable the true

ed PersistenceExceptionTransla
tionPostProcessor.

spring.data.cassandra.compression Compression supported by none

the Cassandra binary
protocol.

spring.data.cassandra.config Location of the

configuration file to use.

spring.data.cassandra.connection.conn Timeout to use when

ect-timeout establishing driver
connections.

498
Name Description Default Value

spring.data.cassandra.connection.conn 5s
ection-timeout

spring.data.cassandra.connection.init Timeout to use for internal 5s

-query-timeout queries that run as part of
the initialization process,
just after a connection is
opened.

spring.data.cassandra.contact-points Cluster node addresses in [127.0.0.1:9042]

the form 'host:port', or a
simple 'host' to use the
configured port.

spring.data.cassandra.controlconnecti Timeout to use for control 5s

on.timeout queries.

spring.data.cassandra.keyspace-name Keyspace name to use.

spring.data.cassandra.local- Datacenter that is

datacenter considered "local". Contact
points should be from this
datacenter.

spring.data.cassandra.password Login password of the

server.

spring.data.cassandra.pool.heartbeat- Heartbeat interval after 30s

interval which a message is sent on
an idle connection to make
sure it's still alive.

spring.data.cassandra.pool.idle- Idle timeout before an idle 5s

timeout connection is removed.

spring.data.cassandra.port Port to use if a contact point 9042

does not specify one.

spring.data.cassandra.repositories.ty Type of Cassandra auto

pe repositories to enable.

spring.data.cassandra.request.consist Queries consistency level.

ency

spring.data.cassandra.request.page- How many rows will be 5000

size retrieved simultaneously in
a single network roundtrip.

spring.data.cassandra.request.serial- Queries serial consistency

consistency level.

499
Name Description Default Value

spring.data.cassandra.request.throttl How often the throttler

er.drain-interval attempts to dequeue
requests. Set this high
enough that each attempt
will process multiple entries
in the queue, but not delay
requests too much.

spring.data.cassandra.request.throttl Maximum number of 0

er.max-concurrent-requests requests that are allowed to
execute in parallel.

spring.data.cassandra.request.throttl Maximum number of 0

er.max-queue-size requests that can be
enqueued when the
throttling threshold is
exceeded.

spring.data.cassandra.request.throttl Maximum allowed request 0

er.max-requests-per-second rate.

spring.data.cassandra.request.throttl Request throttling type. none

er.type

spring.data.cassandra.request.timeout How long the driver waits 2s

for a request to complete.

spring.data.cassandra.schema-action Schema action to take at none

startup.

spring.data.cassandra.session-name Name of the Cassandra

session.

spring.data.cassandra.ssl Enable SSL support. false

spring.data.cassandra.username Login user of the server.

spring.data.couchbase.auto-index Automatically create views false

and indexes. Use the meta-
data provided by
"@ViewIndexed",
"@N1qlPrimaryIndexed"
and
"@N1qlSecondaryIndexed".

spring.data.couchbase.bucket-name Name of the bucket to

connect to.

spring.data.couchbase.field-naming- Fully qualified name of the

strategy FieldNamingStrategy to use.

spring.data.couchbase.repositories.ty Type of Couchbase auto

pe repositories to enable.

500
Name Description Default Value

spring.data.couchbase.scope-name Name of the scope used for

all collection access.

spring.data.couchbase.type-key Name of the field that stores _class

the type information for
complex types when using
"MappingCouchbaseConvert
er".

spring.data.elasticsearch.client.reac [localhost:9200]
tive.endpoints

spring.data.elasticsearch.repositorie Whether to enable true

s.enabled Elasticsearch repositories.

spring.data.jdbc.repositories.enabled Whether to enable JDBC true

repositories.

spring.data.jpa.repositories.bootstra Bootstrap mode for JPA default

p-mode repositories.

spring.data.jpa.repositories.enabled Whether to enable JPA true

repositories.

spring.data.ldap.repositories.enabled Whether to enable LDAP true

repositories.

spring.data.mongodb.authentication- Authentication database

database name.

spring.data.mongodb.auto-index- Whether to enable auto-

creation index creation.

spring.data.mongodb.database Database name.

spring.data.mongodb.field-naming- Fully qualified name of the

strategy FieldNamingStrategy to use.

spring.data.mongodb.gridfs.bucket GridFS bucket name.

spring.data.mongodb.gridfs.database GridFS database name.

spring.data.mongodb.host Mongo server host. Cannot

be set with URI.

spring.data.mongodb.password Login password of the

mongo server. Cannot be set
with URI.

spring.data.mongodb.port Mongo server port. Cannot

be set with URI.

spring.data.mongodb.replica-set-name Required replica set name

for the cluster. Cannot be set
with URI.

501
Name Description Default Value

spring.data.mongodb.repositories.type Type of Mongo repositories auto

to enable.

spring.data.mongodb.uri Mongo database URI. Cannot mongodb://localhost/test

be set with host, port,
credentials and replica set
name.

spring.data.mongodb.username Login user of the mongo

server. Cannot be set with
URI.

spring.data.mongodb.uuid- Representation to use when java-legacy

representation converting a UUID to a BSON
binary value.

spring.data.neo4j.database Database name to use. By

default, the server decides
the default database to use.

spring.data.neo4j.repositories.type Type of Neo4j repositories to auto

enable.

spring.data.r2dbc.repositories.enable Whether to enable R2DBC true

d repositories.

spring.data.redis.repositories.enable Whether to enable Redis true

d repositories.

spring.data.rest.base-path Base path to be used by

Spring Data REST to expose
repository resources.

spring.data.rest.default-media-type Content type to use as a

default when none is
specified.

spring.data.rest.default-page-size Default size of pages.

spring.data.rest.detection-strategy Strategy to use to determine default

which repositories get
exposed.

spring.data.rest.enable-enum- Whether to enable enum

translation value translation through
the Spring Data REST default
resource bundle.

spring.data.rest.limit-param-name Name of the URL query

string parameter that
indicates how many results
to return at once.

spring.data.rest.max-page-size Maximum size of pages.

502
Name Description Default Value

spring.data.rest.page-param-name Name of the URL query

string parameter that
indicates what page to
return.

spring.data.rest.return-body-on- Whether to return a

create response body after creating
an entity.

spring.data.rest.return-body-on- Whether to return a

update response body after
updating an entity.

spring.data.rest.sort-param-name Name of the URL query

string parameter that
indicates what direction to
sort results.

spring.data.solr.host Solr host. Ignored if "zk- http://127.0.0.1:8983/solr

host" is set.

spring.data.solr.zk-host ZooKeeper host address in

the form HOST:PORT.

spring.data.web.pageable.default- Default page size. 20

page-size

spring.data.web.pageable.max-page- Maximum page size to be 2000

size accepted.

spring.data.web.pageable.one-indexed- Whether to expose and false

parameters assume 1-based page
number indexes. Defaults to
"false", meaning a page
number of 0 in the request
equals the first page.

spring.data.web.pageable.page- Page index parameter name. page

parameter

spring.data.web.pageable.prefix General prefix to be

prepended to the page
number and page size
parameters.

spring.data.web.pageable.qualifier- Delimiter to be used _

delimiter between the qualifier and
the actual page number and
size properties.

spring.data.web.pageable.size- Page size parameter name. size

parameter

spring.data.web.sort.sort-parameter Sort parameter name. sort

503
Name Description Default Value

spring.datasource.dbcp2.abandoned- Commons DBCP2 specific

usage-tracking settings bound to an
spring.datasource.dbcp2.access-to- instance of DBCP2's
underlying-connection-allowed BasicDataSource
spring.datasource.dbcp2.auto-commit-
on-return
spring.datasource.dbcp2.cache-state
spring.datasource.dbcp2.clear-
statement-pool-on-return
spring.datasource.dbcp2.connection-
factory-class-name
spring.datasource.dbcp2.connection-
init-sqls
spring.datasource.dbcp2.default-auto-
commit
spring.datasource.dbcp2.default-
catalog
spring.datasource.dbcp2.default-
query-timeout
spring.datasource.dbcp2.default-read-
only
spring.datasource.dbcp2.default-
schema
spring.datasource.dbcp2.default-
transaction-isolation
spring.datasource.dbcp2.disconnection
-sql-codes
spring.datasource.dbcp2.driver
spring.datasource.dbcp2.driver-class-
name
spring.datasource.dbcp2.eviction-
policy-class-name
spring.datasource.dbcp2.fast-fail-
validation
spring.datasource.dbcp2.initial-size
spring.datasource.dbcp2.jmx-name
spring.datasource.dbcp2.lifo
spring.datasource.dbcp2.log-abandoned
spring.datasource.dbcp2.log-expired-
connections
spring.datasource.dbcp2.login-timeout
spring.datasource.dbcp2.max-conn-
lifetime-millis
spring.datasource.dbcp2.max-idle
spring.datasource.dbcp2.max-open-
prepared-statements
spring.datasource.dbcp2.max-total
spring.datasource.dbcp2.max-wait-
504
Name Description Default Value

spring.datasource.driver-class-name Fully qualified name of the

JDBC driver. Auto-detected
based on the URL by default.

spring.datasource.embedded-database- Connection details for an

connection embedded database.
Defaults to the most suitable
embedded database that is
available on the classpath.

spring.datasource.generate-unique- Whether to generate a true

name random datasource name.

505
Name Description Default Value

spring.datasource.hikari.allow-pool- Hikari specific settings

suspension bound to an instance of
spring.datasource.hikari.auto-commit Hikari's HikariDataSource
spring.datasource.hikari.catalog
spring.datasource.hikari.connection-
init-sql
spring.datasource.hikari.connection-
test-query
spring.datasource.hikari.connection-
timeout
spring.datasource.hikari.data-source-
class-name
spring.datasource.hikari.data-source-
j-n-d-i
spring.datasource.hikari.data-source-
properties
spring.datasource.hikari.driver-
class-name
spring.datasource.hikari.exception-
override-class-name
spring.datasource.hikari.health-
check-properties
spring.datasource.hikari.health-
check-registry
spring.datasource.hikari.idle-timeout
spring.datasource.hikari.initializati
on-fail-timeout
spring.datasource.hikari.isolate-
internal-queries
spring.datasource.hikari.jdbc-url
spring.datasource.hikari.keepalive-
time
spring.datasource.hikari.leak-
detection-threshold
spring.datasource.hikari.login-
timeout
spring.datasource.hikari.max-lifetime
spring.datasource.hikari.maximum-
pool-size
spring.datasource.hikari.metric-
registry
spring.datasource.hikari.metrics-
tracker-factory
spring.datasource.hikari.minimum-idle
spring.datasource.hikari.password
spring.datasource.hikari.pool-name
spring.datasource.hikari.read-only
spring.datasource.hikari.register-
506
Name Description Default Value

spring.datasource.initialization-mode embedded

spring.datasource.jndi-name JNDI location of the

datasource. Class, url,
username and password are
ignored when set.

spring.datasource.name Datasource name to use if

"generate-unique-name" is
false. Defaults to "testdb"
when using an embedded
database, otherwise null.

507
Name Description Default Value

spring.datasource.oracleucp.abandoned Oracle UCP specific settings

-connection-timeout bound to an instance of
spring.datasource.oracleucp.connectio Oracle UCP's PoolDataSource
n-factory-class-name
spring.datasource.oracleucp.connectio
n-factory-properties
spring.datasource.oracleucp.connectio
n-harvest-max-count
spring.datasource.oracleucp.connectio
n-harvest-trigger-count
spring.datasource.oracleucp.connectio
n-labeling-high-cost
spring.datasource.oracleucp.connectio
n-pool-name
spring.datasource.oracleucp.connectio
n-properties
spring.datasource.oracleucp.connectio
n-repurpose-threshold
spring.datasource.oracleucp.connectio
n-validation-timeout
spring.datasource.oracleucp.connectio
n-wait-timeout
spring.datasource.oracleucp.data-
source-name
spring.datasource.oracleucp.database-
name
spring.datasource.oracleucp.descripti
on
spring.datasource.oracleucp.fast-
connection-failover-enabled
spring.datasource.oracleucp.high-
cost-connection-reuse-threshold
spring.datasource.oracleucp.inactive-
connection-timeout
spring.datasource.oracleucp.initial-
pool-size
spring.datasource.oracleucp.login-
timeout
spring.datasource.oracleucp.max-
connection-reuse-count
spring.datasource.oracleucp.max-
connection-reuse-time
spring.datasource.oracleucp.max-
connections-per-shard
spring.datasource.oracleucp.max-idle-
time
spring.datasource.oracleucp.max-pool-
size
508
Name Description Default Value

spring.datasource.password Login password of the

database.

509
Name Description Default Value

spring.datasource.tomcat.abandon- Tomcat datasource specific

when-percentage-full settings bound to an
spring.datasource.tomcat.access-to- instance of Tomcat JDBC's
underlying-connection-allowed DataSource
spring.datasource.tomcat.alternate-
username-allowed
spring.datasource.tomcat.commit-on-
return
spring.datasource.tomcat.connection-
properties
spring.datasource.tomcat.data-source
spring.datasource.tomcat.data-source-
j-n-d-i
spring.datasource.tomcat.db-
properties
spring.datasource.tomcat.default-
auto-commit
spring.datasource.tomcat.default-
catalog
spring.datasource.tomcat.default-
read-only
spring.datasource.tomcat.default-
transaction-isolation
spring.datasource.tomcat.driver-
class-name
spring.datasource.tomcat.fair-queue
spring.datasource.tomcat.ignore-
exception-on-pre-load
spring.datasource.tomcat.init-s-q-l
spring.datasource.tomcat.initial-size
spring.datasource.tomcat.jdbc-
interceptors
spring.datasource.tomcat.jmx-enabled
spring.datasource.tomcat.log-
abandoned
spring.datasource.tomcat.log-
validation-errors
spring.datasource.tomcat.login-
timeout
spring.datasource.tomcat.max-active
spring.datasource.tomcat.max-age
spring.datasource.tomcat.max-idle
spring.datasource.tomcat.max-wait
spring.datasource.tomcat.min-
evictable-idle-time-millis
spring.datasource.tomcat.min-idle
spring.datasource.tomcat.name
spring.datasource.tomcat.num-tests-
510
Name Description Default Value

spring.datasource.type Fully qualified name of the

connection pool
implementation to use. By
default, it is auto-detected
from the classpath.

spring.datasource.url JDBC URL of the database.

spring.datasource.username Login username of the

database.

spring.datasource.xa.data-source- XA datasource fully

class-name qualified name.

spring.datasource.xa.properties.* Properties to pass to the XA

data source.

spring.elasticsearch.connection- Connection timeout used 1s

timeout when communicating with
Elasticsearch.

spring.elasticsearch.password Password for authentication

with Elasticsearch.

spring.elasticsearch.path-prefix Prefix added to the path of

every request sent to
Elasticsearch.

spring.elasticsearch.rest.uris [http://localhost:9200]

spring.elasticsearch.restclient.sniff Delay of a sniff execution 1m

er.delay-after-failure scheduled after a failure.

spring.elasticsearch.restclient.sniff Interval between 5m

er.interval consecutive ordinary sniff
executions.

spring.elasticsearch.socket-timeout Socket timeout used when 30s

communicating with
Elasticsearch.

spring.elasticsearch.uris Comma-separated list of the [http://localhost:9200]

Elasticsearch instances to
use.

spring.elasticsearch.username Username for authentication

with Elasticsearch.

spring.elasticsearch.webclient.max- Limit on the number of

in-memory-size bytes that can be buffered
whenever the input stream
needs to be aggregated.

spring.influx.password Login password.

511
Name Description Default Value

spring.influx.url URL of the InfluxDB

instance to which to
connect.

spring.influx.user Login user.

spring.jdbc.template.fetch-size Number of rows that should -1

be fetched from the
database when more rows
are needed. Use -1 to use the
JDBC driver's default
configuration.

spring.jdbc.template.max-rows Maximum number of rows. -1

Use -1 to use the JDBC
driver's default
configuration.

spring.jdbc.template.query-timeout Query timeout. Default is to

use the JDBC driver's default
configuration. If a duration
suffix is not specified,
seconds will be used.

spring.jooq.sql-dialect SQL dialect to use. Auto-

detected by default.

spring.jpa.database Target database to operate

on, auto-detected by default.
Can be alternatively set
using the
"databasePlatform"
property.

spring.jpa.database-platform Name of the target database

to operate on, auto-detected
by default. Can be
alternatively set using the
"Database" enum.

spring.jpa.defer-datasource- false
initialization

spring.jpa.generate-ddl Whether to initialize the false

schema on startup.

512
Name Description Default Value

spring.jpa.hibernate.ddl-auto DDL mode. This is actually a

shortcut for the
"hibernate.hbm2ddl.auto"
property. Defaults to "create-
drop" when using an
embedded database and no
schema manager was
detected. Otherwise, defaults
to "none".

spring.jpa.hibernate.naming.implicit- Fully qualified name of the

strategy implicit naming strategy.

spring.jpa.hibernate.naming.physical- Fully qualified name of the

strategy physical naming strategy.

spring.jpa.hibernate.use-new-id- Whether to use Hibernate's

generator-mappings newer IdentifierGenerator
for AUTO, TABLE and
SEQUENCE. This is actually a
shortcut for the
"hibernate.id.new_generator
_mappings" property. When
not specified will default to
"true".

spring.jpa.mapping-resources Mapping resources

(equivalent to "mapping-file"
entries in persistence.xml).

spring.jpa.open-in-view Register true

OpenEntityManagerInViewI
nterceptor. Binds a JPA
EntityManager to the thread
for the entire processing of
the request.

spring.jpa.properties.* Additional native properties

to set on the JPA provider.

spring.jpa.show-sql Whether to enable logging false

of SQL statements.

spring.ldap.anonymous-read-only Whether read-only

operations should use an
anonymous environment.
Disabled by default unless a
username is set.

spring.ldap.base Base suffix from which all

operations should originate.

513
Name Description Default Value

spring.ldap.base-environment.* LDAP specification settings.

spring.ldap.embedded.base-dn List of base DNs.

spring.ldap.embedded.credential.passw Embedded LDAP password.

ord

spring.ldap.embedded.credential.usern Embedded LDAP username.

ame

spring.ldap.embedded.ldif Schema (LDIF) script classpath:schema.ldif

resource reference.

spring.ldap.embedded.port Embedded LDAP port. 0

spring.ldap.embedded.validation.enabl Whether to enable LDAP true

ed schema validation.

spring.ldap.embedded.validation.schem Path to the custom schema.

a

spring.ldap.password Login password of the

server.

spring.ldap.template.ignore-name-not- Whether false

found-exception NameNotFoundException
should be ignored in
searches via the
LdapTemplate.

spring.ldap.template.ignore-partial- Whether false

result-exception PartialResultException
should be ignored in
searches via the
LdapTemplate.

spring.ldap.template.ignore-size- Whether true

limit-exceeded-exception SizeLimitExceededException
should be ignored in
searches via the
LdapTemplate.

spring.ldap.urls LDAP URLs of the server.

spring.ldap.username Login username of the

server.

spring.mongodb.embedded.features Comma-separated list of [sync_delay]

features to enable. Uses the
defaults of the configured
version by default.

spring.mongodb.embedded.storage.datab Directory used for data

ase-dir storage.

spring.mongodb.embedded.storage.oplog Maximum size of the oplog.

-size

514
Name Description Default Value

spring.mongodb.embedded.storage.repl- Name of the replica set.

set-name

spring.mongodb.embedded.version Version of Mongo to use.

spring.neo4j.authentication.kerberos- Kerberos ticket for

ticket connecting to the database.
Mutual exclusive with a
given username.

spring.neo4j.authentication.password Login password of the

server.

spring.neo4j.authentication.realm Realm to connect to.

spring.neo4j.authentication.username Login user of the server.

spring.neo4j.connection-timeout Timeout for borrowing 30s

connections from the pool.

spring.neo4j.max-transaction-retry- Maximum time transactions 30s

time are allowed to retry.

spring.neo4j.pool.connection- Acquisition of new 60s

acquisition-timeout connections will be
attempted for at most
configured timeout.

spring.neo4j.pool.idle-time-before- Pooled connections that

connection-test have been idle in the pool
for longer than this
threshold will be tested
before they are used again.

spring.neo4j.pool.log-leaked-sessions Whether to log leaked false

sessions.

spring.neo4j.pool.max-connection- Pooled connections older 1h

lifetime than this threshold will be
closed and removed from
the pool.

spring.neo4j.pool.max-connection- Maximum amount of 100

pool-size connections in the
connection pool towards a
single database.

spring.neo4j.pool.metrics-enabled Whether to enable metrics. false

spring.neo4j.security.cert-file Path to the file that holds the

trusted certificates.

spring.neo4j.security.encrypted Whether the driver should false

use encrypted traffic.

515
Name Description Default Value

spring.neo4j.security.hostname- Whether hostname true

verification-enabled verification is required.

spring.neo4j.security.trust-strategy Trust strategy to use. trust-system-ca-signed-

certificates

spring.neo4j.uri URI used by the driver. bolt://localhost:7687

spring.r2dbc.generate-unique-name Whether to generate a false

random database name.
Ignore any configured name
when enabled.

spring.r2dbc.name Database name. Set if no

name is specified in the url.
Default to "testdb" when
using an embedded
database.

spring.r2dbc.password Login password of the

database. Set if no password
is specified in the url.

spring.r2dbc.pool.enabled Whether pooling is enabled. true

Requires r2dbc-pool.

spring.r2dbc.pool.initial-size Initial connection pool size. 10

spring.r2dbc.pool.max-acquire-time Maximum time to acquire a

connection from the pool. By
default, wait indefinitely.

spring.r2dbc.pool.max-create- Maximum time to wait to

connection-time create a new connection. By
default, wait indefinitely.

spring.r2dbc.pool.max-idle-time Maximum amount of time 30m

that a connection is allowed
to sit idle in the pool.

spring.r2dbc.pool.max-life-time Maximum lifetime of a

connection in the pool. By
default, connections have an
infinite lifetime.

spring.r2dbc.pool.max-size Maximal connection pool 10

size.

spring.r2dbc.pool.validation-depth Validation depth. local

spring.r2dbc.pool.validation-query Validation query.

spring.r2dbc.properties.* Additional R2DBC options.

516
Name Description Default Value

spring.r2dbc.url R2DBC URL of the database.

database name, username,
password and pooling
options specified in the url
take precedence over
individual options.

spring.r2dbc.username Login username of the

database. Set if no username
is specified in the url.

spring.redis.client-name Client name to be set on

connections with CLIENT
SETNAME.

spring.redis.client-type Type of client to use. By

default, auto-detected
according to the classpath.

spring.redis.cluster.max-redirects Maximum number of

redirects to follow when
executing commands across
the cluster.

spring.redis.cluster.nodes Comma-separated list of

"host:port" pairs to
bootstrap from. This
represents an "initial" list of
cluster nodes and is
required to have at least one
entry.

spring.redis.connect-timeout Connection timeout.

spring.redis.database Database index used by the 0

connection factory.

spring.redis.host Redis server host. localhost

spring.redis.jedis.pool.enabled Whether to enable the pool.

Enabled automatically if
"commons-pool2" is
available. With Jedis,
pooling is implicitly enabled
in sentinel mode and this
setting only applies to single
node setup.

517
Name Description Default Value

spring.redis.jedis.pool.max-active Maximum number of 8

connections that can be
allocated by the pool at a
given time. Use a negative
value for no limit.

spring.redis.jedis.pool.max-idle Maximum number of "idle" 8

connections in the pool. Use
a negative value to indicate
an unlimited number of idle
connections.

spring.redis.jedis.pool.max-wait Maximum amount of time a -1ms

connection allocation should
block before throwing an
exception when the pool is
exhausted. Use a negative
value to block indefinitely.

spring.redis.jedis.pool.min-idle Target for the minimum 0

number of idle connections
to maintain in the pool. This
setting only has an effect if
both it and time between
eviction runs are positive.

spring.redis.jedis.pool.time-between- Time between runs of the

eviction-runs idle object evictor thread.
When positive, the idle
object evictor thread starts,
otherwise no idle object
eviction is performed.

spring.redis.lettuce.cluster.refresh. Whether adaptive topology false

adaptive refreshing using all
available refresh triggers
should be used.

spring.redis.lettuce.cluster.refresh. Whether to discover and true

dynamic-refresh-sources query all cluster nodes for
obtaining the cluster
topology. When set to false,
only the initial seed nodes
are used as sources for
topology discovery.

spring.redis.lettuce.cluster.refresh. Cluster topology refresh

period period.

518
Name Description Default Value

spring.redis.lettuce.pool.enabled Whether to enable the pool.

Enabled automatically if
"commons-pool2" is
available. With Jedis,
pooling is implicitly enabled
in sentinel mode and this
setting only applies to single
node setup.

spring.redis.lettuce.pool.max-active Maximum number of 8

connections that can be
allocated by the pool at a
given time. Use a negative
value for no limit.

spring.redis.lettuce.pool.max-idle Maximum number of "idle" 8

connections in the pool. Use
a negative value to indicate
an unlimited number of idle
connections.

spring.redis.lettuce.pool.max-wait Maximum amount of time a -1ms

connection allocation should
block before throwing an
exception when the pool is
exhausted. Use a negative
value to block indefinitely.

spring.redis.lettuce.pool.min-idle Target for the minimum 0

number of idle connections
to maintain in the pool. This
setting only has an effect if
both it and time between
eviction runs are positive.

spring.redis.lettuce.pool.time- Time between runs of the

between-eviction-runs idle object evictor thread.
When positive, the idle
object evictor thread starts,
otherwise no idle object
eviction is performed.

spring.redis.lettuce.shutdown-timeout Shutdown timeout. 100ms

spring.redis.password Login password of the redis

server.

spring.redis.port Redis server port. 6379

spring.redis.sentinel.master Name of the Redis server.

519
Name Description Default Value

spring.redis.sentinel.nodes Comma-separated list of

"host:port" pairs.

spring.redis.sentinel.password Password for authenticating

with sentinel(s).

spring.redis.ssl Whether to enable SSL false

support.

spring.redis.timeout Read timeout.

spring.redis.url Connection URL. Overrides

host, port, and password.
User is ignored. Example:
redis://user:password@exam
ple.com:6379

spring.redis.username Login username of the redis

server.

A.6. Transaction Properties

Name Description Default Value

spring.jta.atomikos.connectionfactory Timeout, in seconds, for 30

.borrow-connection-timeout borrowing connections from
the pool.

spring.jta.atomikos.connectionfactory Whether to ignore the true

.ignore-session-transacted-flag transacted flag when
creating session.

spring.jta.atomikos.connectionfactory Whether local transactions false

.local-transaction-mode are desired.

spring.jta.atomikos.connectionfactory Time, in seconds, between 60

.maintenance-interval runs of the pool's
maintenance thread.

spring.jta.atomikos.connectionfactory Time, in seconds, after 60

.max-idle-time which connections are
cleaned up from the pool.

spring.jta.atomikos.connectionfactory Time, in seconds, that a 0

.max-lifetime connection can be pooled
for before being destroyed. 0
denotes no limit.

spring.jta.atomikos.connectionfactory Maximum size of the pool. 1

.max-pool-size

spring.jta.atomikos.connectionfactory Minimum size of the pool. 1

.min-pool-size

520
Name Description Default Value

spring.jta.atomikos.connectionfactory Reap timeout, in seconds, for 0

.reap-timeout borrowed connections. 0
denotes no limit.

spring.jta.atomikos.connectionfactory Unique name used to jmsConnectionFactory

.unique-resource-name identify the resource during
recovery.

spring.jta.atomikos.connectionfactory Vendor-specific
.xa-connection-factory-class-name implementation of
XAConnectionFactory.

spring.jta.atomikos.connectionfactory Vendor-specific XA
.xa-properties properties.

spring.jta.atomikos.datasource.borrow Timeout, in seconds, for 30

-connection-timeout borrowing connections from
the pool.

spring.jta.atomikos.datasource.concur Whether to use concurrent true

rent-connection-validation connection validation.

spring.jta.atomikos.datasource.defaul Default isolation level of

t-isolation-level connections provided by the
pool.

spring.jta.atomikos.datasource.login- Timeout, in seconds, for 0

timeout establishing a database
connection.

spring.jta.atomikos.datasource.mainte Time, in seconds, between 60

nance-interval runs of the pool's
maintenance thread.

spring.jta.atomikos.datasource.max- Time, in seconds, after 60

idle-time which connections are
cleaned up from the pool.

spring.jta.atomikos.datasource.max- Time, in seconds, that a 0

lifetime connection can be pooled
for before being destroyed. 0
denotes no limit.

spring.jta.atomikos.datasource.max- Maximum size of the pool. 1

pool-size

spring.jta.atomikos.datasource.min- Minimum size of the pool. 1

pool-size

spring.jta.atomikos.datasource.reap- Reap timeout, in seconds, for 0

timeout borrowed connections. 0
denotes no limit.

521
Name Description Default Value

spring.jta.atomikos.datasource.test- SQL query or statement used

query to validate a connection
before returning it.

spring.jta.atomikos.datasource.unique Unique name used to dataSource

-resource-name identify the resource during
recovery.

spring.jta.atomikos.datasource.xa- Vendor-specific
data-source-class-name implementation of
XAConnectionFactory.

spring.jta.atomikos.datasource.xa- Vendor-specific XA
properties properties.

spring.jta.enabled Whether to enable JTA true

support.

spring.transaction.default-timeout Default transaction timeout.

If a duration suffix is not
specified, seconds will be
used.

spring.transaction.rollback-on- Whether to roll back on

commit-failure commit failures.

A.7. Data Migration Properties

Name Description Default Value

spring.flyway.baseline-description Description to tag an << Flyway Baseline >>

existing schema with when
applying a baseline.

spring.flyway.baseline-migration- Filename prefix for baseline B

prefix migrations. Requires Flyway
Teams.

spring.flyway.baseline-on-migrate Whether to automatically false

call baseline when migrating
a non-empty schema.

spring.flyway.baseline-version Version to tag an existing 1

schema with when
executing baseline.

spring.flyway.batch Whether to batch SQL

statements when executing
them. Requires Flyway
Teams.

522
Name Description Default Value

spring.flyway.cherry-pick Migrations that Flyway

should consider when
migrating or undoing. When
empty all available
migrations are considered.
Requires Flyway Teams.

spring.flyway.clean-disabled Whether to disable cleaning false

of the database.

spring.flyway.clean-on-validation- Whether to automatically false

error call clean when a validation
error occurs.

spring.flyway.connect-retries Maximum number of retries 0

when attempting to connect
to the database.

spring.flyway.connect-retries- Maximum time between 120

interval retries when attempting to
connect to the database. If a
duration suffix is not
specified, seconds will be
used.

spring.flyway.create-schemas Whether Flyway should true

attempt to create the
schemas specified in the
schemas property.

spring.flyway.default-schema Default schema name

managed by Flyway (case-
sensitive).

spring.flyway.detect-encoding Whether to attempt to

automatically detect SQL
migration file encoding.
Requires Flyway Teams.

spring.flyway.driver-class-name Fully qualified name of the

JDBC driver. Auto-detected
based on the URL by default.

spring.flyway.enabled Whether to enable flyway. true

spring.flyway.encoding Encoding of SQL migrations. UTF-8

spring.flyway.error-overrides Rules for the built-in error

handling to override specific
SQL states and error codes.
Requires Flyway Teams.

523
Name Description Default Value

spring.flyway.fail-on-missing- Whether to fail if a location false

locations of migration scripts doesn't
exist.

spring.flyway.group Whether to group all false

pending migrations together
in the same transaction
when applying them.

spring.flyway.ignore-migration- Ignore migrations that

patterns match this comma-separated
list of patterns when
validating migrations.
Requires Flyway Teams.

spring.flyway.init-sqls SQL statements to execute to

initialize a connection
immediately after obtaining
it.

spring.flyway.installed-by Username recorded in the

schema history table as
having applied the
migration.

spring.flyway.jdbc-properties.* Properties to pass to the

JDBC driver. Requires
Flyway Teams.

spring.flyway.kerberos-config-file Path of the Kerberos config

file. Requires Flyway Teams.

spring.flyway.license-key Licence key for Flyway

Teams.

spring.flyway.locations Locations of migrations [classpath:db/migration]

scripts. Can contain the
special "{vendor}"
placeholder to use vendor-
specific locations.

spring.flyway.lock-retry-count Maximum number of retries 50

when trying to obtain a lock.

spring.flyway.mixed Whether to allow mixing false

transactional and non-
transactional statements
within the same migration.

spring.flyway.oracle-kerberos-cache- Path of the Oracle Kerberos

file cache file. Requires Flyway
Teams.

524
Name Description Default Value

spring.flyway.oracle-sqlplus Whether to enable support

for Oracle SQL*Plus
commands. Requires Flyway
Teams.

spring.flyway.oracle-sqlplus-warn Whether to issue a warning

rather than an error when a
not-yet-supported Oracle
SQL*Plus statement is
encountered. Requires
Flyway Teams.

spring.flyway.oracle-wallet-location Location of the Oracle

Wallet, used to sign-in to the
database automatically.
Requires Flyway Teams.

spring.flyway.out-of-order Whether to allow migrations false

to be run out of order.

spring.flyway.output-query-results Whether Flyway should

output a table with the
results of queries when
executing migrations.
Requires Flyway Teams.

spring.flyway.password Login password of the

database to migrate.

spring.flyway.placeholder-prefix Prefix of placeholders in ${

migration scripts.

spring.flyway.placeholder-replacement Perform placeholder true

replacement in migration
scripts.

spring.flyway.placeholder-suffix Suffix of placeholders in }

migration scripts.

spring.flyway.placeholders.* Placeholders and their

replacements to apply to sql
migration scripts.

spring.flyway.repeatable-sql- File name prefix for R

migration-prefix repeatable SQL migrations.

spring.flyway.schemas Scheme names managed by

Flyway (case-sensitive).

spring.flyway.script-placeholder- Prefix of placeholders in FP__

prefix migration scripts.

spring.flyway.script-placeholder- Suffix of placeholders in __

suffix migration scripts.

525
Name Description Default Value

spring.flyway.skip-default-callbacks Whether to skip default false

callbacks. If true, only
custom callbacks are used.

spring.flyway.skip-default-resolvers Whether to skip default false

resolvers. If true, only
custom resolvers are used.

spring.flyway.skip-executing- Whether Flyway should skip

migrations executing the contents of the
migrations and only update
the schema history table.
Requires Flyway teams.

spring.flyway.sql-migration-prefix File name prefix for SQL V

migrations.

spring.flyway.sql-migration-separator File name separator for SQL __

migrations.

spring.flyway.sql-migration-suffixes File name suffix for SQL [.sql]

migrations.

spring.flyway.sql-server-kerberos- Path to the SQL Server

login-file Kerberos login file. Requires
Flyway Teams.

spring.flyway.stream Whether to stream SQL

migrations when executing
them. Requires Flyway
Teams.

spring.flyway.table Name of the schema history flyway_schema_history

table that will be used by
Flyway.

spring.flyway.tablespace Tablespace in which the

schema history table is
created. Ignored when using
a database that does not
support tablespaces.
Defaults to the default
tablespace of the connection
used by Flyway.

spring.flyway.target Target version up to which

migrations should be
considered.

spring.flyway.url JDBC url of the database to

migrate. If not set, the
primary configured data
source is used.

526
Name Description Default Value

spring.flyway.user Login user of the database to

migrate.

spring.flyway.validate-migration- Whether to validate false

naming migrations and callbacks
whose scripts do not obey
the correct naming
convention.

spring.flyway.validate-on-migrate Whether to automatically true

call validate when
performing a migration.

spring.liquibase.change-log Change log configuration classpath:/db/changelog/db.

path. changelog-master.yaml

spring.liquibase.clear-checksums Whether to clear all false

checksums in the current
changelog, so they will be
recalculated upon the next
update.

spring.liquibase.contexts Comma-separated list of

runtime contexts to use.

spring.liquibase.database-change-log- Name of table to use for DATABASECHANGELOGLOCK

lock-table tracking concurrent
Liquibase usage.

spring.liquibase.database-change-log- Name of table to use for DATABASECHANGELOG

table tracking change history.

spring.liquibase.default-schema Default database schema.

spring.liquibase.driver-class-name Fully qualified name of the

JDBC driver. Auto-detected
based on the URL by default.

spring.liquibase.drop-first Whether to first drop the false

database schema.

spring.liquibase.enabled Whether to enable true

Liquibase support.

spring.liquibase.labels Comma-separated list of

runtime labels to use.

spring.liquibase.liquibase-schema Schema to use for Liquibase

objects.

spring.liquibase.liquibase-tablespace Tablespace to use for

Liquibase objects.

spring.liquibase.parameters.* Change log parameters.

527
Name Description Default Value

spring.liquibase.password Login password of the

database to migrate.

spring.liquibase.rollback-file File to which rollback SQL is

written when an update is
performed.

spring.liquibase.tag Tag name to use when

applying database changes.
Can also be used with
"rollbackFile" to generate a
rollback script for all
existing changes associated
with that tag.

spring.liquibase.test-rollback-on- Whether rollback should be false

update tested before update is
performed.

spring.liquibase.url JDBC URL of the database to

migrate. If not set, the
primary configured data
source is used.

spring.liquibase.user Login user of the database to

migrate.

spring.sql.init.continue-on-error Whether initialization false

should continue when an
error occurs.

spring.sql.init.data-locations Locations of the data (DML)

scripts to apply to the
database.

spring.sql.init.encoding Encoding of the schema and

data scripts.

spring.sql.init.mode Mode to apply when embedded

determining whether
initialization should be
performed.

spring.sql.init.password Password of the database to

use when applying
initialization scripts (if
different).

spring.sql.init.platform Platform to use in the all

default schema or data
script locations, schema-
${platform}.sql and data-
${platform}.sql.

528
Name Description Default Value

spring.sql.init.schema-locations Locations of the schema

(DDL) scripts to apply to the
database.

spring.sql.init.separator Statement separator in the ;

schema and data scripts.

spring.sql.init.username Username of the database to

use when applying
initialization scripts (if
different).

A.8. Integration Properties

Name Description Default Value

spring.artemis.broker-url Artemis broker port. tcp://localhost:61616

spring.artemis.embedded.cluster- Cluster password. Randomly

password generated on startup by
default.

spring.artemis.embedded.data- Journal file directory. Not

directory necessary if persistence is
turned off.

spring.artemis.embedded.enabled Whether to enable true

embedded mode if the
Artemis server APIs are
available.

spring.artemis.embedded.persistent Whether to enable false

persistent store.

spring.artemis.embedded.queues Comma-separated list of []

queues to create on startup.

spring.artemis.embedded.server-id Server ID. By default, an 0

auto-incremented counter is
used.

spring.artemis.embedded.topics Comma-separated list of []

topics to create on startup.

spring.artemis.mode Artemis deployment mode,

auto-detected by default.

spring.artemis.password Login password of the

broker.

spring.artemis.user Login user of the broker.

spring.batch.jdbc.initialize-schema Database schema embedded

initialization mode.

529
Name Description Default Value

spring.batch.jdbc.isolation-level- Transaction isolation level to

for-create use when creating job meta-
data for new jobs. Auto-
detected based on whether
JPA is being used or not.

spring.batch.jdbc.platform Platform to use in

initialization scripts if the
@@platform@@
placeholder is used. Auto-
detected by default.

spring.batch.jdbc.schema Path to the SQL file to use to classpath:org/springframewo

initialize the database rk/batch/core/schema-
@@platform@@.sql
schema.

spring.batch.jdbc.table-prefix Table prefix for all the batch

meta-data tables.

spring.batch.job.enabled Execute all Spring Batch jobs true

in the context on startup.

spring.batch.job.names Comma-separated list of job

names to execute on startup
(for instance, 'job1,job2'). By
default, all Jobs found in the
context are executed.

spring.hazelcast.config The location of the

configuration file to use to
initialize Hazelcast.

spring.integration.channel.auto- Whether to create input true

create channels if necessary.

spring.integration.channel.max- Default number of

broadcast-subscribers subscribers allowed on, for
example, a
'PublishSubscribeChannel'.

spring.integration.channel.max- Default number of

unicast-subscribers subscribers allowed on, for
example, a 'DirectChannel'.

spring.integration.endpoint.no-auto- A comma-separated list of

startup endpoint bean names
patterns that should not be
started automatically during
application startup.

530
Name Description Default Value

spring.integration.endpoint.read- A comma-separated list of

only-headers message header names that
should not be populated into
Message instances during a
header copying operation.

spring.integration.endpoint.throw- Whether to throw an false

exception-on-late-reply exception when a reply is
not expected anymore by a
gateway.

spring.integration.error.ignore- Whether to ignore failures true

failures for one or more of the
handlers of the global
'errorChannel'.

spring.integration.error.require- Whether to not silently true

subscribers ignore messages on the
global 'errorChannel' when
they are no subscribers.

spring.integration.jdbc.initialize- Database schema embedded

schema initialization mode.

spring.integration.jdbc.platform Platform to use in

initialization scripts if the
@@platform@@
placeholder is used. Auto-
detected by default.

spring.integration.jdbc.schema Path to the SQL file to use to classpath:org/springframewo

initialize the database rk/integration/jdbc/schema-
@@platform@@.sql
schema.

spring.integration.management.default Whether Spring Integration true

-logging-enabled components should perform
logging in the main message
flow. When disabled, such
logging will be skipped
without checking the logging
level. When enabled, such
logging is controlled as
normal by the logging
system's log level
configuration.

spring.integration.poller.cron Cron expression for polling.

Mutually exclusive with
'fixedDelay' and 'fixedRate'.

531
Name Description Default Value

spring.integration.poller.fixed-delay Polling delay period.

Mutually exclusive with
'cron' and 'fixedRate'.

spring.integration.poller.fixed-rate Polling rate period. Mutually

exclusive with 'fixedDelay'
and 'cron'.

spring.integration.poller.initial- Polling initial delay. Applied

delay for 'fixedDelay' and
'fixedRate'; ignored for
'cron'.

spring.integration.poller.max- Maximum number of

messages-per-poll messages to poll per polling
cycle.

spring.integration.poller.receive- How long to wait for 1s

timeout messages on poll.

spring.integration.rsocket.client.hos TCP RSocket server host to

t connect to.

spring.integration.rsocket.client.por TCP RSocket server port to

t connect to.

spring.integration.rsocket.client.uri WebSocket RSocket server

uri to connect to.

spring.integration.rsocket.server.mes Whether to handle message false

sage-mapping-enabled mapping for RSocket via
Spring Integration.

spring.jms.cache.consumers Whether to cache message false

consumers.

spring.jms.cache.enabled Whether to cache sessions. true

spring.jms.cache.producers Whether to cache message true

producers.

spring.jms.cache.session-cache-size Size of the session cache 1

(per JMS Session type).

spring.jms.jndi-name Connection factory JNDI

name. When set, takes
precedence to others
connection factory auto-
configurations.

spring.jms.listener.acknowledge-mode Acknowledge mode of the

container. By default, the
listener is transacted with
automatic acknowledgment.

532
Name Description Default Value

spring.jms.listener.auto-startup Start the container true

automatically on startup.

spring.jms.listener.concurrency Minimum number of

concurrent consumers.

spring.jms.listener.max-concurrency Maximum number of

concurrent consumers.

spring.jms.listener.receive-timeout Timeout to use for receive 1s

calls. Use -1 for a no-wait
receive or 0 for no timeout
at all. The latter is only
feasible if not running
within a transaction
manager and is generally
discouraged since it
prevents clean shutdown.

spring.jms.pub-sub-domain Whether the default false

destination type is topic.

spring.jms.template.default- Default destination to use on

destination send and receive operations
that do not have a
destination parameter.

spring.jms.template.delivery-delay Delivery delay to use for

send calls.

spring.jms.template.delivery-mode Delivery mode. Enables QoS

(Quality of Service) when
set.

spring.jms.template.priority Priority of a message when

sending. Enables QoS
(Quality of Service) when
set.

spring.jms.template.qos-enabled Whether to enable explicit

QoS (Quality of Service)
when sending a message.
When enabled, the delivery
mode, priority and time-to-
live properties will be used
when sending a message.
QoS is automatically enabled
when at least one of those
settings is customized.

spring.jms.template.receive-timeout Timeout to use for receive

calls.

533
Name Description Default Value

spring.jms.template.time-to-live Time-to-live of a message

when sending. Enables QoS
(Quality of Service) when
set.

spring.kafka.admin.client-id ID to pass to the server

when making requests. Used
for server-side logging.

spring.kafka.admin.fail-fast Whether to fail fast if the false

broker is not available on
startup.

spring.kafka.admin.properties.* Additional admin-specific

properties used to configure
the client.

spring.kafka.admin.security.protocol Security protocol used to

communicate with brokers.

spring.kafka.admin.ssl.key-password Password of the private key

in either key store key or
key store file.

spring.kafka.admin.ssl.key-store- Certificate chain in PEM

certificate-chain format with a list of X.509
certificates.

spring.kafka.admin.ssl.key-store-key Private key in PEM format

with PKCS#8 keys.

spring.kafka.admin.ssl.key-store- Location of the key store file.

location

spring.kafka.admin.ssl.key-store- Store password for the key

password store file.

spring.kafka.admin.ssl.key-store-type Type of the key store.

spring.kafka.admin.ssl.protocol SSL protocol to use.

spring.kafka.admin.ssl.trust-store- Trusted certificates in PEM

certificates format with X.509
certificates.

spring.kafka.admin.ssl.trust-store- Location of the trust store

location file.

spring.kafka.admin.ssl.trust-store- Store password for the trust

password store file.

spring.kafka.admin.ssl.trust-store- Type of the trust store.

type

534
Name Description Default Value

spring.kafka.bootstrap-servers Comma-delimited list of

host:port pairs to use for
establishing the initial
connections to the Kafka
cluster. Applies to all
components unless
overridden.

spring.kafka.client-id ID to pass to the server

when making requests. Used
for server-side logging.

spring.kafka.consumer.auto-commit- Frequency with which the

interval consumer offsets are auto-
committed to Kafka if
'enable.auto.commit' is set to
true.

spring.kafka.consumer.auto-offset- What to do when there is no

reset initial offset in Kafka or if
the current offset no longer
exists on the server.

spring.kafka.consumer.bootstrap- Comma-delimited list of

servers host:port pairs to use for
establishing the initial
connections to the Kafka
cluster. Overrides the global
property, for consumers.

spring.kafka.consumer.client-id ID to pass to the server

when making requests. Used
for server-side logging.

spring.kafka.consumer.enable-auto- Whether the consumer's

commit offset is periodically
committed in the
background.

spring.kafka.consumer.fetch-max-wait Maximum amount of time

the server blocks before
answering the fetch request
if there isn't sufficient data
to immediately satisfy the
requirement given by "fetch-
min-size".

spring.kafka.consumer.fetch-min-size Minimum amount of data

the server should return for
a fetch request.

535
Name Description Default Value

spring.kafka.consumer.group-id Unique string that identifies

the consumer group to
which this consumer
belongs.

spring.kafka.consumer.heartbeat- Expected time between

interval heartbeats to the consumer
coordinator.

spring.kafka.consumer.isolation-level Isolation level for reading read-uncommitted

messages that have been
written transactionally.

spring.kafka.consumer.key- Deserializer class for keys.

deserializer

spring.kafka.consumer.max-poll- Maximum number of

records records returned in a single
call to poll().

spring.kafka.consumer.properties.* Additional consumer-

specific properties used to
configure the client.

spring.kafka.consumer.security.protoc Security protocol used to

ol communicate with brokers.

spring.kafka.consumer.ssl.key- Password of the private key

password in either key store key or
key store file.

spring.kafka.consumer.ssl.key-store- Certificate chain in PEM

certificate-chain format with a list of X.509
certificates.

spring.kafka.consumer.ssl.key-store- Private key in PEM format

key with PKCS#8 keys.

spring.kafka.consumer.ssl.key-store- Location of the key store file.

location

spring.kafka.consumer.ssl.key-store- Store password for the key

password store file.

spring.kafka.consumer.ssl.key-store- Type of the key store.

type

spring.kafka.consumer.ssl.protocol SSL protocol to use.

spring.kafka.consumer.ssl.trust- Trusted certificates in PEM

store-certificates format with X.509
certificates.

spring.kafka.consumer.ssl.trust- Location of the trust store

store-location file.

536
Name Description Default Value

spring.kafka.consumer.ssl.trust- Store password for the trust

store-password store file.

spring.kafka.consumer.ssl.trust- Type of the trust store.

store-type

spring.kafka.consumer.value- Deserializer class for values.

deserializer

spring.kafka.jaas.control-flag Control flag for login required

configuration.

spring.kafka.jaas.enabled Whether to enable JAAS false

configuration.

spring.kafka.jaas.login-module Login module. com.sun.security.auth.modul

e.Krb5LoginModule

spring.kafka.jaas.options.* Additional JAAS options.

spring.kafka.listener.ack-count Number of records between

offset commits when
ackMode is "COUNT" or
"COUNT_TIME".

spring.kafka.listener.ack-mode Listener AckMode. See the

spring-kafka documentation.

spring.kafka.listener.ack-time Time between offset

commits when ackMode is
"TIME" or "COUNT_TIME".

spring.kafka.listener.client-id Prefix for the listener's

consumer client.id property.

spring.kafka.listener.concurrency Number of threads to run in

the listener containers.

spring.kafka.listener.idle-between- Sleep interval between 0

polls Consumer.poll(Duration)
calls.

spring.kafka.listener.idle-event- Time between publishing

interval idle consumer events (no
data received).

spring.kafka.listener.idle-partition- Time between publishing

event-interval idle partition consumer
events (no data received for
partition).

spring.kafka.listener.log-container- Whether to log the container

config configuration during
initialization (INFO level).

537
Name Description Default Value

spring.kafka.listener.missing-topics- Whether the container false

fatal should fail to start if at least
one of the configured topics
are not present on the
broker.

spring.kafka.listener.monitor- Time between checks for

interval non-responsive consumers.
If a duration suffix is not
specified, seconds will be
used.

spring.kafka.listener.no-poll- Multiplier applied to

threshold "pollTimeout" to determine
if a consumer is non-
responsive.

spring.kafka.listener.only-log- Whether to suppress the true

record-metadata entire record from being
written to the log when
retries are being attempted.

spring.kafka.listener.poll-timeout Timeout to use when polling

the consumer.

spring.kafka.listener.type Listener type. single

spring.kafka.producer.acks Number of
acknowledgments the
producer requires the leader
to have received before
considering a request
complete.

spring.kafka.producer.batch-size Default batch size. A small

batch size will make
batching less common and
may reduce throughput (a
batch size of zero disables
batching entirely).

spring.kafka.producer.bootstrap- Comma-delimited list of

servers host:port pairs to use for
establishing the initial
connections to the Kafka
cluster. Overrides the global
property, for producers.

538
Name Description Default Value

spring.kafka.producer.buffer-memory Total memory size the

producer can use to buffer
records waiting to be sent to
the server.

spring.kafka.producer.client-id ID to pass to the server

when making requests. Used
for server-side logging.

spring.kafka.producer.compression- Compression type for all

type data generated by the
producer.

spring.kafka.producer.key-serializer Serializer class for keys.

spring.kafka.producer.properties.* Additional producer-specific

properties used to configure
the client.

spring.kafka.producer.retries When greater than zero,

enables retrying of failed
sends.

spring.kafka.producer.security.protoc Security protocol used to

ol communicate with brokers.

spring.kafka.producer.ssl.key- Password of the private key

password in either key store key or
key store file.

spring.kafka.producer.ssl.key-store- Certificate chain in PEM

certificate-chain format with a list of X.509
certificates.

spring.kafka.producer.ssl.key-store- Private key in PEM format

key with PKCS#8 keys.

spring.kafka.producer.ssl.key-store- Location of the key store file.

location

spring.kafka.producer.ssl.key-store- Store password for the key

password store file.

spring.kafka.producer.ssl.key-store- Type of the key store.

type

spring.kafka.producer.ssl.protocol SSL protocol to use.

spring.kafka.producer.ssl.trust- Trusted certificates in PEM

store-certificates format with X.509
certificates.

spring.kafka.producer.ssl.trust- Location of the trust store

store-location file.

539
Name Description Default Value

spring.kafka.producer.ssl.trust- Store password for the trust

store-password store file.

spring.kafka.producer.ssl.trust- Type of the trust store.

store-type

spring.kafka.producer.transaction-id- When non empty, enables

prefix transaction support for
producer.

spring.kafka.producer.value- Serializer class for values.

serializer

spring.kafka.properties.* Additional properties,

common to producers and
consumers, used to
configure the client.

spring.kafka.security.protocol Security protocol used to

communicate with brokers.

spring.kafka.ssl.key-password Password of the private key

in either key store key or
key store file.

spring.kafka.ssl.key-store- Certificate chain in PEM

certificate-chain format with a list of X.509
certificates.

spring.kafka.ssl.key-store-key Private key in PEM format

with PKCS#8 keys.

spring.kafka.ssl.key-store-location Location of the key store file.

spring.kafka.ssl.key-store-password Store password for the key

store file.

spring.kafka.ssl.key-store-type Type of the key store.

spring.kafka.ssl.protocol SSL protocol to use.

spring.kafka.ssl.trust-store- Trusted certificates in PEM

certificates format with X.509
certificates.

spring.kafka.ssl.trust-store-location Location of the trust store

file.

spring.kafka.ssl.trust-store-password Store password for the trust

store file.

spring.kafka.ssl.trust-store-type Type of the trust store.

spring.kafka.streams.application-id Kafka streams application.id

property; default
spring.application.name.

540
Name Description Default Value

spring.kafka.streams.auto-startup Whether or not to auto-start true

the streams factory bean.

spring.kafka.streams.bootstrap- Comma-delimited list of

servers host:port pairs to use for
establishing the initial
connections to the Kafka
cluster. Overrides the global
property, for streams.

spring.kafka.streams.cache-max-size- Maximum memory size to

buffering be used for buffering across
all threads.

spring.kafka.streams.cleanup.on- Cleanup the application’s false

shutdown local state directory on
shutdown.

spring.kafka.streams.cleanup.on- Cleanup the application’s false

startup local state directory on
startup.

spring.kafka.streams.client-id ID to pass to the server

when making requests. Used
for server-side logging.

spring.kafka.streams.properties.* Additional Kafka properties

used to configure the
streams.

spring.kafka.streams.replication- The replication factor for

factor change log topics and
repartition topics created by
the stream processing
application.

spring.kafka.streams.security.protoco Security protocol used to

l communicate with brokers.

spring.kafka.streams.ssl.key-password Password of the private key

in either key store key or
key store file.

spring.kafka.streams.ssl.key-store- Certificate chain in PEM

certificate-chain format with a list of X.509
certificates.

spring.kafka.streams.ssl.key-store- Private key in PEM format

key with PKCS#8 keys.

spring.kafka.streams.ssl.key-store- Location of the key store file.

location

541
Name Description Default Value

spring.kafka.streams.ssl.key-store- Store password for the key

password store file.

spring.kafka.streams.ssl.key-store- Type of the key store.

type

spring.kafka.streams.ssl.protocol SSL protocol to use.

spring.kafka.streams.ssl.trust-store- Trusted certificates in PEM

certificates format with X.509
certificates.

spring.kafka.streams.ssl.trust-store- Location of the trust store

location file.

spring.kafka.streams.ssl.trust-store- Store password for the trust

password store file.

spring.kafka.streams.ssl.trust-store- Type of the trust store.

type

spring.kafka.streams.state-dir Directory location for the

state store.

spring.kafka.template.default-topic Default topic to which

messages are sent.

spring.kafka.template.transaction-id- Transaction id prefix,

prefix override the transaction id
prefix in the producer
factory.

spring.rabbitmq.address-shuffle-mode Mode used to shuffle none

configured addresses.

spring.rabbitmq.addresses Comma-separated list of

addresses to which the client
should connect. When set,
the host and port are
ignored.

spring.rabbitmq.cache.channel.checkou Duration to wait to obtain a

t-timeout channel if the cache size has
been reached. If 0, always
create a new channel.

spring.rabbitmq.cache.channel.size Number of channels to

retain in the cache. When
"check-timeout" > 0, max
channels per connection.

spring.rabbitmq.cache.connection.mode Connection factory cache channel

mode.

542
Name Description Default Value

spring.rabbitmq.cache.connection.size Number of connections to

cache. Only applies when
mode is CONNECTION.

spring.rabbitmq.channel-rpc-timeout Continuation timeout for 10m

RPC calls in channels. Set it
to zero to wait forever.

spring.rabbitmq.connection-timeout Connection timeout. Set it to

zero to wait forever.

spring.rabbitmq.dynamic Whether to create an true

AmqpAdmin bean.

spring.rabbitmq.host RabbitMQ host. Ignored if an localhost

address is set.

spring.rabbitmq.listener.direct.ackno Acknowledge mode of

wledge-mode container.

spring.rabbitmq.listener.direct.auto- Whether to start the true

startup container automatically on
startup.

spring.rabbitmq.listener.direct.consu Number of consumers per

mers-per-queue queue.

spring.rabbitmq.listener.direct.de- Whether the container true

batching-enabled should present batched
messages as discrete
messages or call the listener
with the batch.

spring.rabbitmq.listener.direct.defau Whether rejected deliveries

lt-requeue-rejected are re-queued by default.

spring.rabbitmq.listener.direct.idle- How often idle container

event-interval events should be published.

spring.rabbitmq.listener.direct.missi Whether to fail if the queues false

ng-queues-fatal declared by the container
are not available on the
broker.

spring.rabbitmq.listener.direct.prefe Maximum number of

tch unacknowledged messages
that can be outstanding at
each consumer.

spring.rabbitmq.listener.direct.retry Whether publishing retries false

.enabled are enabled.

543
Name Description Default Value

spring.rabbitmq.listener.direct.retry Duration between the first 1000ms

.initial-interval and second attempt to
deliver a message.

spring.rabbitmq.listener.direct.retry Maximum number of 3

.max-attempts attempts to deliver a
message.

spring.rabbitmq.listener.direct.retry Maximum duration between 10000ms

.max-interval attempts.

spring.rabbitmq.listener.direct.retry Multiplier to apply to the 1

.multiplier previous retry interval.

spring.rabbitmq.listener.direct.retry Whether retries are stateless true

.stateless or stateful.

spring.rabbitmq.listener.simple.ackno Acknowledge mode of

wledge-mode container.

spring.rabbitmq.listener.simple.auto- Whether to start the true

startup container automatically on
startup.

spring.rabbitmq.listener.simple.batch Batch size, expressed as the

-size number of physical
messages, to be used by the
container.

spring.rabbitmq.listener.simple.concu Minimum number of

rrency listener invoker threads.

spring.rabbitmq.listener.simple.consu Whether the container false

mer-batch-enabled creates a batch of messages
based on the 'receive-
timeout' and 'batch-size'.
Coerces 'de-batching-
enabled' to true to include
the contents of a producer
created batch in the batch as
discrete records.

spring.rabbitmq.listener.simple.de- Whether the container true

batching-enabled should present batched
messages as discrete
messages or call the listener
with the batch.

spring.rabbitmq.listener.simple.defau Whether rejected deliveries

lt-requeue-rejected are re-queued by default.

spring.rabbitmq.listener.simple.idle- How often idle container

event-interval events should be published.

544
Name Description Default Value

spring.rabbitmq.listener.simple.max- Maximum number of

concurrency listener invoker threads.

spring.rabbitmq.listener.simple.missi Whether to fail if the queues true

ng-queues-fatal declared by the container
are not available on the
broker and/or whether to
stop the container if one or
more queues are deleted at
runtime.

spring.rabbitmq.listener.simple.prefe Maximum number of

tch unacknowledged messages
that can be outstanding at
each consumer.

spring.rabbitmq.listener.simple.retry Whether publishing retries false

.enabled are enabled.

spring.rabbitmq.listener.simple.retry Duration between the first 1000ms

.initial-interval and second attempt to
deliver a message.

spring.rabbitmq.listener.simple.retry Maximum number of 3

.max-attempts attempts to deliver a
message.

spring.rabbitmq.listener.simple.retry Maximum duration between 10000ms

.max-interval attempts.

spring.rabbitmq.listener.simple.retry Multiplier to apply to the 1

.multiplier previous retry interval.

spring.rabbitmq.listener.simple.retry Whether retries are stateless true

.stateless or stateful.

spring.rabbitmq.listener.stream.auto- Whether to start the true

startup container automatically on
startup.

spring.rabbitmq.listener.stream.nativ Whether the container will false

e-listener support listeners that
consume native stream
messages instead of Spring
AMQP messages.

spring.rabbitmq.listener.type Listener container type. simple

spring.rabbitmq.password Login to authenticate guest

against the broker.

545
Name Description Default Value

spring.rabbitmq.port RabbitMQ port. Ignored if an

address is set. Default to
5672, or 5671 if SSL is
enabled.

spring.rabbitmq.publisher-confirm- Type of publisher confirms

type to use.

spring.rabbitmq.publisher-returns Whether to enable publisher false

returns.

spring.rabbitmq.requested-channel-max Number of channels per 2047

connection requested by the
client. Use 0 for unlimited.

spring.rabbitmq.requested-heartbeat Requested heartbeat

timeout; zero for none. If a
duration suffix is not
specified, seconds will be
used.

spring.rabbitmq.ssl.algorithm SSL algorithm to use. By

default, configured by the
Rabbit client library.

spring.rabbitmq.ssl.enabled Whether to enable SSL

support. Determined
automatically if an address
is provided with the
protocol (amqp:// vs.
amqps://).

spring.rabbitmq.ssl.key-store Path to the key store that

holds the SSL certificate.

spring.rabbitmq.ssl.key-store- Key store algorithm. SunX509

algorithm

spring.rabbitmq.ssl.key-store- Password used to access the

password key store.

spring.rabbitmq.ssl.key-store-type Key store type. PKCS12

spring.rabbitmq.ssl.trust-store Trust store that holds SSL

certificates.

spring.rabbitmq.ssl.trust-store- Trust store algorithm. SunX509

algorithm

spring.rabbitmq.ssl.trust-store- Password used to access the

password trust store.

spring.rabbitmq.ssl.trust-store-type Trust store type. JKS

546
Name Description Default Value

spring.rabbitmq.ssl.validate-server- Whether to enable server true

certificate side certificate validation.

spring.rabbitmq.ssl.verify-hostname Whether to enable true

hostname verification.

spring.rabbitmq.stream.host Host of a RabbitMQ instance localhost

with the Stream plugin
enabled.

spring.rabbitmq.stream.name Name of the stream.

spring.rabbitmq.stream.password Login password to

authenticate to the broker.
When not set
spring.rabbitmq.password is
used.

spring.rabbitmq.stream.port Stream port of a RabbitMQ

instance with the Stream
plugin enabled.

spring.rabbitmq.stream.username Login user to authenticate to

the broker. When not set,
spring.rabbitmq.username
is used.

spring.rabbitmq.template.default- Name of the default queue

receive-queue to receive messages from
when none is specified
explicitly.

spring.rabbitmq.template.exchange Name of the default

exchange to use for send
operations.

spring.rabbitmq.template.mandatory Whether to enable

mandatory messages.

spring.rabbitmq.template.receive- Timeout for receive()

timeout operations.

spring.rabbitmq.template.reply- Timeout for

timeout sendAndReceive()
operations.

spring.rabbitmq.template.retry.enable Whether publishing retries false

d are enabled.

spring.rabbitmq.template.retry.initia Duration between the first 1000ms

l-interval and second attempt to
deliver a message.

547
Name Description Default Value

spring.rabbitmq.template.retry.max- Maximum number of 3

attempts attempts to deliver a
message.

spring.rabbitmq.template.retry.max- Maximum duration between 10000ms

interval attempts.

spring.rabbitmq.template.retry.multip Multiplier to apply to the 1

lier previous retry interval.

spring.rabbitmq.template.routing-key Value of a default routing

key to use for send
operations.

spring.rabbitmq.username Login user to authenticate to guest

the broker.

spring.rabbitmq.virtual-host Virtual host to use when

connecting to the broker.

spring.webservices.path Path that serves as the base /services

URI for the services.

spring.webservices.servlet.init.* Servlet init parameters to

pass to Spring Web Services.

spring.webservices.servlet.load-on- Load on startup priority of -1

startup the Spring Web Services
servlet.

spring.webservices.wsdl-locations Comma-separated list of

locations of WSDLs and
accompanying XSDs to be
exposed as beans.

A.9. Web Properties

Name Description Default Value

spring.hateoas.use-hal-as-default- Whether true

json-media-type application/hal+json
responses should be sent to
requests that accept
application/json.

spring.mvc.async.request-timeout Amount of time before

asynchronous request
handling times out. If this
value is not set, the default
timeout of the underlying
implementation is used.

548
Name Description Default Value

spring.mvc.contentnegotiation.favor- Whether a request false

parameter parameter ("format" by
default) should be used to
determine the requested
media type.

spring.mvc.contentnegotiation.media- Map file extensions to media

types.* types for content
negotiation. For instance,
yml to text/yaml.

spring.mvc.contentnegotiation.paramet Query parameter name to

er-name use when "favor-parameter"
is enabled.

spring.mvc.converters.preferred-json- Preferred JSON mapper to

mapper use for HTTP message
conversion. By default, auto-
detected according to the
environment.

spring.mvc.dispatch-options-request Whether to dispatch true

OPTIONS requests to the
FrameworkServlet
doService method.

spring.mvc.dispatch-trace-request Whether to dispatch TRACE false

requests to the
FrameworkServlet
doService method.

spring.mvc.format.date Date format to use, for

example 'dd/MM/yyyy'.

spring.mvc.format.date-time Date-time format to use, for

example 'yyyy-MM-dd
HH:mm:ss'.

spring.mvc.format.time Time format to use, for

example 'HH:mm:ss'.

spring.mvc.formcontent.filter.enabled Whether to enable Spring's true

FormContentFilter.

spring.mvc.hiddenmethod.filter.enable Whether to enable Spring's false

d HiddenHttpMethodFilter.

spring.mvc.ignore-default-model-on- Whether the content of the true

redirect "default" model should be
ignored during redirect
scenarios.

549
Name Description Default Value

spring.mvc.log-request-details Whether logging of false

(potentially sensitive)
request details at DEBUG
and TRACE level is allowed.

spring.mvc.log-resolved-exception Whether to enable warn false

logging of exceptions
resolved by a
"HandlerExceptionResolver"
, except for
"DefaultHandlerExceptionRe
solver".

spring.mvc.message-codes-resolver- Formatting strategy for

format message codes. For instance,
'PREFIX_ERROR_CODE'.

spring.mvc.pathmatch.matching- Choice of strategy for path-pattern-parser

strategy matching request paths
against registered mappings.

spring.mvc.publish-request-handled- Whether to publish a true

events ServletRequestHandledEven
t at the end of each request.

spring.mvc.servlet.load-on-startup Load on startup priority of -1

the dispatcher servlet.

spring.mvc.servlet.path Path of the dispatcher /

servlet. Setting a custom
value for this property is not
compatible with the
PathPatternParser matching
strategy.

spring.mvc.static-path-pattern Path pattern used for static /**

resources.

spring.mvc.throw-exception-if-no- Whether a false

handler-found "NoHandlerFoundException
" should be thrown if no
Handler was found to
process a request.

spring.mvc.view.prefix Spring MVC view prefix.

spring.mvc.view.suffix Spring MVC view suffix.

spring.netty.leak-detection Level of leak detection for simple

reference-counted buffers.

spring.servlet.multipart.enabled Whether to enable support true

of multipart uploads.

550
Name Description Default Value

spring.servlet.multipart.file-size- Threshold after which files 0B

threshold are written to disk.

spring.servlet.multipart.location Intermediate location of

uploaded files.

spring.servlet.multipart.max-file- Max file size. 1MB

size

spring.servlet.multipart.max-request- Max request size. 10MB

size

spring.servlet.multipart.resolve- Whether to resolve the false

lazily multipart request lazily at
the time of file or parameter
access.

spring.session.hazelcast.flush-mode Sessions flush mode. on-save

Determines when session
changes are written to the
session store.

spring.session.hazelcast.map-name Name of the map used to spring:session:sessions

store sessions.

spring.session.hazelcast.save-mode Sessions save mode. on-set-attribute

Determines how session
changes are tracked and
saved to the session store.

spring.session.jdbc.cleanup-cron Cron expression for expired 0 * * * * *

session cleanup job.

spring.session.jdbc.flush-mode Sessions flush mode. on-save

Determines when session
changes are written to the
session store.

spring.session.jdbc.initialize-schema Database schema embedded

initialization mode.

spring.session.jdbc.platform Platform to use in

initialization scripts if the
@@platform@@
placeholder is used. Auto-
detected by default.

spring.session.jdbc.save-mode Sessions save mode. on-set-attribute

Determines how session
changes are tracked and
saved to the session store.

551
Name Description Default Value

spring.session.jdbc.schema Path to the SQL file to use to classpath:org/springframewo

initialize the database rk/session/jdbc/schema-
@@platform@@.sql
schema.

spring.session.jdbc.table-name Name of the database table SPRING_SESSION

used to store sessions.

spring.session.mongodb.collection- Collection name used to sessions

name store sessions.

spring.session.redis.cleanup-cron Cron expression for expired 0 * * * * *

session cleanup job.

spring.session.redis.configure-action The configure action to notify-keyspace-events

apply when no user defined
ConfigureRedisAction bean
is present.

spring.session.redis.flush-mode Sessions flush mode. on-save

Determines when session
changes are written to the
session store.

spring.session.redis.namespace Namespace for keys used to spring:session

store sessions.

spring.session.redis.save-mode Sessions save mode. on-set-attribute

Determines how session
changes are tracked and
saved to the session store.

spring.session.servlet.filter- Session repository filter [async, error, request]

dispatcher-types dispatcher types.

spring.session.servlet.filter-order Session repository filter

order.

spring.session.store-type Session store type.

spring.session.timeout Session timeout. If a

duration suffix is not
specified, seconds will be
used.

spring.web.locale Locale to use. By default, this

locale is overridden by the
"Accept-Language" header.

spring.web.locale-resolver Define how the locale should accept-header

be resolved.

spring.web.resources.add-mappings Whether to enable default true

resource handling.

552
Name Description Default Value

spring.web.resources.cache.cachecontr Indicate that the response

ol.cache-private message is intended for a
single user and must not be
stored by a shared cache.

spring.web.resources.cache.cachecontr Indicate that any cache may

ol.cache-public store the response.

spring.web.resources.cache.cachecontr Maximum time the response

ol.max-age should be cached, in seconds
if no duration suffix is not
specified.

spring.web.resources.cache.cachecontr Indicate that once it has

ol.must-revalidate become stale, a cache must
not use the response without
re-validating it with the
server.

spring.web.resources.cache.cachecontr Indicate that the cached

ol.no-cache response can be reused only
if re-validated with the
server.

spring.web.resources.cache.cachecontr Indicate to not cache the

ol.no-store response in any case.

spring.web.resources.cache.cachecontr Indicate intermediaries

ol.no-transform (caches and others) that they
should not transform the
response content.

spring.web.resources.cache.cachecontr Same meaning as the "must-

ol.proxy-revalidate revalidate" directive, except
that it does not apply to
private caches.

spring.web.resources.cache.cachecontr Maximum time the response

ol.s-max-age should be cached by shared
caches, in seconds if no
duration suffix is not
specified.

spring.web.resources.cache.cachecontr Maximum time the response

ol.stale-if-error may be used when errors
are encountered, in seconds
if no duration suffix is not
specified.

553
Name Description Default Value

spring.web.resources.cache.cachecontr Maximum time the response

ol.stale-while-revalidate can be served after it
becomes stale, in seconds if
no duration suffix is not
specified.

spring.web.resources.cache.period Cache period for the

resources served by the
resource handler. If a
duration suffix is not
specified, seconds will be
used. Can be overridden by
the
'spring.web.resources.cache.
cachecontrol' properties.

spring.web.resources.cache.use-last- Whether we should use the true

modified "lastModified" metadata of
the files in HTTP caching
headers.

spring.web.resources.chain.cache Whether to enable caching true

in the Resource chain.

spring.web.resources.chain.compressed Whether to enable false

resolution of already
compressed resources (gzip,
brotli). Checks for a resource
name with the '.gz' or '.br'
file extensions.

spring.web.resources.chain.enabled Whether to enable the

Spring Resource Handling
chain. By default, disabled
unless at least one strategy
has been enabled.

spring.web.resources.chain.strategy.c Whether to enable the false

ontent.enabled content Version Strategy.

spring.web.resources.chain.strategy.c Comma-separated list of [/**]

ontent.paths patterns to apply to the
content Version Strategy.

spring.web.resources.chain.strategy.f Whether to enable the fixed false

ixed.enabled Version Strategy.

spring.web.resources.chain.strategy.f Comma-separated list of [/**]

ixed.paths patterns to apply to the fixed
Version Strategy.

554
Name Description Default Value

spring.web.resources.chain.strategy.f Version string to use for the

ixed.version fixed Version Strategy.

spring.web.resources.static-locations Locations of static resources. [classpath:/META-

Defaults to INF/resources/,
classpath:/resources/,
classpath:[/META- classpath:/static/,
INF/resources/, /resources/, classpath:/public/]
/static/, /public/].

spring.webflux.base-path Base path for all web

handlers.

spring.webflux.format.date Date format to use, for

example 'dd/MM/yyyy'.

spring.webflux.format.date-time Date-time format to use, for

example 'yyyy-MM-dd
HH:mm:ss'.

spring.webflux.format.time Time format to use, for

example 'HH:mm:ss'.

spring.webflux.hiddenmethod.filter.en Whether to enable Spring's false

abled HiddenHttpMethodFilter.

spring.webflux.multipart.file- Directory used to store file

storage-directory parts larger than
'maxInMemorySize'. Default
is a directory named 'spring-
multipart' created under the
system temporary directory.
Ignored when streaming is
enabled.

spring.webflux.multipart.headers- Character set used to decode UTF-8

charset headers.

spring.webflux.multipart.max-disk- Maximum amount of disk -1B

usage-per-part space allowed per part.
Default is -1 which enforces
no limits. Ignored when
streaming is enabled.

spring.webflux.multipart.max-headers- Maximum amount of 10KB

size memory allowed per
headers section of each part.
Set to -1 to enforce no limits.

555
Name Description Default Value

spring.webflux.multipart.max-in- Maximum amount of 256KB

memory-size memory allowed per part
before it's written to disk.
Set to -1 to store all contents
in memory. Ignored when
streaming is enabled.

spring.webflux.multipart.max-parts Maximum number of parts -1

allowed in a given multipart
request. Default is -1 which
enforces no limits.

spring.webflux.multipart.streaming Whether to stream directly false

from the parsed input buffer
stream without storing in
memory nor file. Default is
non-streaming.

spring.webflux.session.timeout 30m

spring.webflux.static-path-pattern Path pattern used for static /**

resources.

A.10. Templating Properties

Name Description Default Value

spring.freemarker.allow-request- Whether HttpServletRequest false

override attributes are allowed to
override (hide) controller
generated model attributes
of the same name.

spring.freemarker.allow-session- Whether HttpSession false

override attributes are allowed to
override (hide) controller
generated model attributes
of the same name.

spring.freemarker.cache Whether to enable template false

caching.

spring.freemarker.charset Template encoding. UTF-8

spring.freemarker.check-template- Whether to check that the true

location templates location exists.

spring.freemarker.content-type Content-Type value. text/html

spring.freemarker.enabled Whether to enable MVC true

view resolution for this
technology.

556
Name Description Default Value

spring.freemarker.expose-request- Whether all request false

attributes attributes should be added
to the model prior to
merging with the template.

spring.freemarker.expose-session- Whether all HttpSession false

attributes attributes should be added
to the model prior to
merging with the template.

spring.freemarker.expose-spring- Whether to expose a true

macro-helpers RequestContext for use by
Spring's macro library,
under the name
"springMacroRequestContex
t".

spring.freemarker.prefer-file-system- Whether to prefer file false

access system access for template
loading to enable hot
detection of template
changes. When a template
path is detected as a
directory, templates are
loaded from the directory
only and other matching
classpath locations will not
be considered.

spring.freemarker.prefix Prefix that gets prepended

to view names when
building a URL.

spring.freemarker.request-context- Name of the RequestContext

attribute attribute for all views.

spring.freemarker.settings.* Well-known FreeMarker

keys which are passed to
FreeMarker's Configuration.

spring.freemarker.suffix Suffix that gets appended to .ftlh

view names when building a
URL.

spring.freemarker.template-loader- Comma-separated list of [classpath:/templates/]

path template paths.

spring.freemarker.view-names View names that can be

resolved.

557
Name Description Default Value

spring.groovy.template.allow-request- Whether HttpServletRequest false

override attributes are allowed to
override (hide) controller
generated model attributes
of the same name.

spring.groovy.template.allow-session- Whether HttpSession false

override attributes are allowed to
override (hide) controller
generated model attributes
of the same name.

spring.groovy.template.cache Whether to enable template false

caching.

spring.groovy.template.charset Template encoding. UTF-8

spring.groovy.template.check- Whether to check that the true

template-location templates location exists.

spring.groovy.template.configuration. See
auto-escape GroovyMarkupConfigurer
spring.groovy.template.configuration.
auto-indent
spring.groovy.template.configuration.
auto-indent-string
spring.groovy.template.configuration.
auto-new-line
spring.groovy.template.configuration.
base-template-class
spring.groovy.template.configuration.
cache-templates
spring.groovy.template.configuration.
declaration-encoding
spring.groovy.template.configuration.
expand-empty-elements
spring.groovy.template.configuration.
locale
spring.groovy.template.configuration.
new-line-string
spring.groovy.template.configuration.
resource-loader-path
spring.groovy.template.configuration.
use-double-quotes

spring.groovy.template.content-type Content-Type value. text/html

558
Name Description Default Value

spring.groovy.template.enabled Whether to enable MVC true

view resolution for this
technology.

spring.groovy.template.expose- Whether all request false

request-attributes attributes should be added
to the model prior to
merging with the template.

spring.groovy.template.expose- Whether all HttpSession false

session-attributes attributes should be added
to the model prior to
merging with the template.

spring.groovy.template.expose-spring- Whether to expose a true

macro-helpers RequestContext for use by
Spring's macro library,
under the name
"springMacroRequestContex
t".

spring.groovy.template.prefix Prefix that gets prepended

to view names when
building a URL.

spring.groovy.template.request- Name of the RequestContext

context-attribute attribute for all views.

spring.groovy.template.resource- Template path. classpath:/templates/

loader-path

spring.groovy.template.suffix Suffix that gets appended to .tpl

view names when building a
URL.

spring.groovy.template.view-names View names that can be

resolved.

spring.mustache.allow-request- Whether HttpServletRequest false

override attributes are allowed to
override (hide) controller
generated model attributes
of the same name.

spring.mustache.allow-session- Whether HttpSession false

override attributes are allowed to
override (hide) controller
generated model attributes
of the same name.

spring.mustache.cache Whether to enable template false

caching.

559
Name Description Default Value

spring.mustache.charset Template encoding. UTF-8

spring.mustache.check-template- Whether to check that the true

location templates location exists.

spring.mustache.content-type Content-Type value. text/html

spring.mustache.enabled Whether to enable MVC true

view resolution for this
technology.

spring.mustache.expose-request- Whether all request false

attributes attributes should be added
to the model prior to
merging with the template.

spring.mustache.expose-session- Whether all HttpSession false

attributes attributes should be added
to the model prior to
merging with the template.

spring.mustache.expose-spring-macro- Whether to expose a true

helpers RequestContext for use by
Spring's macro library,
under the name
"springMacroRequestContex
t".

spring.mustache.prefix Prefix to apply to template classpath:/templates/

names.

spring.mustache.request-context- Name of the RequestContext

attribute attribute for all views.

spring.mustache.suffix Suffix to apply to template .mustache

names.

spring.mustache.view-names View names that can be

resolved.

spring.thymeleaf.cache Whether to enable template true

caching.

spring.thymeleaf.check-template Whether to check that the true

template exists before
rendering it.

spring.thymeleaf.check-template- Whether to check that the true

location templates location exists.

spring.thymeleaf.enable-spring-el- Enable the SpringEL false

compiler compiler in SpringEL
expressions.

560
Name Description Default Value

spring.thymeleaf.enabled Whether to enable true

Thymeleaf view resolution
for Web frameworks.

spring.thymeleaf.encoding Template files encoding. UTF-8

spring.thymeleaf.excluded-view-names Comma-separated list of

view names (patterns
allowed) that should be
excluded from resolution.

spring.thymeleaf.mode Template mode to be HTML

applied to templates. See
also Thymeleaf's
TemplateMode enum.

spring.thymeleaf.prefix Prefix that gets prepended classpath:/templates/

to view names when
building a URL.

spring.thymeleaf.reactive.chunked- Comma-separated list of

mode-view-names view names (patterns
allowed) that should be the
only ones executed in
CHUNKED mode when a
max chunk size is set.

spring.thymeleaf.reactive.full-mode- Comma-separated list of

view-names view names (patterns
allowed) that should be
executed in FULL mode
even if a max chunk size is
set.

spring.thymeleaf.reactive.max-chunk- Maximum size of data 0B

size buffers used for writing to
the response. Templates will
execute in CHUNKED mode
by default if this is set.

spring.thymeleaf.reactive.media-types Media types supported by

the view technology.

spring.thymeleaf.render-hidden- Whether hidden form inputs false

markers-before-checkboxes acting as markers for
checkboxes should be
rendered before the
checkbox element itself.

spring.thymeleaf.servlet.content-type Content-Type value written text/html

to HTTP responses.

561
Name Description Default Value

spring.thymeleaf.servlet.produce- Whether Thymeleaf should true

partial-output-while-processing start writing partial output
as soon as possible or buffer
until template processing is
finished.

spring.thymeleaf.suffix Suffix that gets appended to .html

view names when building a
URL.

spring.thymeleaf.template-resolver- Order of the template

order resolver in the chain. By
default, the template
resolver is first in the chain.
Order start at 1 and should
only be set if you have
defined additional
"TemplateResolver" beans.

spring.thymeleaf.view-names Comma-separated list of

view names (patterns
allowed) that can be
resolved.

A.11. Server Properties

Name Description Default Value

server.address Network address to which

the server should bind.

server.compression.enabled Whether response false

compression is enabled.

server.compression.excluded-user- Comma-separated list of

agents user agents for which
responses should not be
compressed.

server.compression.mime-types Comma-separated list of [text/html, text/xml,

MIME types that should be text/plain, text/css,
text/javascript,
compressed. application/javascript,
application/json,
application/xml]

server.compression.min-response-size Minimum "Content-Length" 2KB

value that is required for
compression to be
performed.

562
Name Description Default Value

server.error.include-binding-errors When to include "errors" never

attribute.

server.error.include-exception Include the "exception" false

attribute.

server.error.include-message When to include "message" never

attribute.

server.error.include-stacktrace When to include the "trace" never

attribute.

server.error.path Path of the error controller. /error

server.error.whitelabel.enabled Whether to enable the true

default error page displayed
in browsers in case of a
server error.

server.forward-headers-strategy Strategy for handling X-

Forwarded-* headers.

server.http2.enabled Whether to enable HTTP/2 false

support, if the current
environment supports it.

server.jetty.accesslog.append Append to log. false

server.jetty.accesslog.custom-format Custom log format, see

org.eclipse.jetty.server.Custo
mRequestLog. If defined,
overrides the "format"
configuration key.

server.jetty.accesslog.enabled Enable access log. false

server.jetty.accesslog.file-date- Date format to place in log

format file name.

server.jetty.accesslog.filename Log filename. If not

specified, logs redirect to
"System.err".

server.jetty.accesslog.format Log format. ncsa

server.jetty.accesslog.ignore-paths Request paths that should

not be logged.

server.jetty.accesslog.retention- Number of days before 31

period rotated log files are deleted.

server.jetty.connection-idle-timeout Time that the connection

can be idle before it is
closed.

563
Name Description Default Value

server.jetty.max-http-form-post-size Maximum size of the form 200000B

content in any HTTP post
request.

server.jetty.threads.acceptors Number of acceptor threads -1

to use. When the value is -1,
the default, the number of
acceptors is derived from
the operating environment.

server.jetty.threads.idle-timeout Maximum thread idle time. 60000ms

server.jetty.threads.max Maximum number of 200

threads.

server.jetty.threads.max-queue- Maximum capacity of the

capacity thread pool's backing queue.
A default is computed based
on the threading
configuration.

server.jetty.threads.min Minimum number of 8

threads.

server.jetty.threads.selectors Number of selector threads -1

to use. When the value is -1,
the default, the number of
selectors is derived from the
operating environment.

server.max-http-header-size Maximum size of the HTTP 8KB

message header.

server.netty.connection-timeout Connection timeout of the

Netty channel.

server.netty.h2c-max-content-length Maximum content length of 0B

an H2C upgrade request.

server.netty.idle-timeout Idle timeout of the Netty

channel. When not
specified, an infinite timeout
is used.

server.netty.initial-buffer-size Initial buffer size for HTTP 128B

request decoding.

server.netty.max-chunk-size Maximum chunk size that 8KB

can be decoded for an HTTP
request.

server.netty.max-initial-line-length Maximum length that can be 4KB

decoded for an HTTP
request's initial line.

564
Name Description Default Value

server.netty.max-keep-alive-requests Maximum number of

requests that can be made
per connection. By default, a
connection serves unlimited
number of requests.

server.netty.validate-headers Whether to validate headers true

when decoding requests.

server.port Server HTTP port. 8080

server.reactive.session.timeout Session timeout. If a 30m

duration suffix is not
specified, seconds will be
used.

server.server-header Value to use for the Server

response header (if empty,
no header is sent).

server.servlet.application-display- Display name of the application

name application.

server.servlet.context-parameters.* Servlet context init

parameters.

server.servlet.context-path Context path of the

application.

server.servlet.encoding.charset

server.servlet.encoding.enabled Whether to enable http true

encoding support.

server.servlet.encoding.force

server.servlet.encoding.force-request

server.servlet.encoding.force-
response

server.servlet.encoding.mapping.*

server.servlet.jsp.class-name Class name of the servlet to org.apache.jasper.servlet.J

use for JSPs. If registered is spServlet
true and this class * is on the
classpath then it will be
registered.

server.servlet.jsp.init-parameters.* Init parameters used to

configure the JSP servlet.

server.servlet.jsp.registered Whether the JSP servlet is true

registered.

565
Name Description Default Value

server.servlet.register-default- Whether to register the false

servlet default Servlet with the
container.

server.servlet.session.cookie.comment

server.servlet.session.cookie.domain

server.servlet.session.cookie.http-
only

server.servlet.session.cookie.max-age

server.servlet.session.cookie.name

server.servlet.session.cookie.path

server.servlet.session.cookie.same-
site

server.servlet.session.cookie.secure

server.servlet.session.persistent Whether to persist session false

data between restarts.

server.servlet.session.store-dir Directory used to store

session data.

server.servlet.session.timeout Session timeout. If a 30m

duration suffix is not
specified, seconds will be
used.

server.servlet.session.tracking-modes Session tracking modes.

server.shutdown Type of shutdown that the immediate

server will support.

server.ssl.ciphers Supported SSL ciphers.

server.ssl.client-auth Client authentication mode.

Requires a trust store.

server.ssl.enabled Whether to enable SSL true

support.

server.ssl.enabled-protocols Enabled SSL protocols.

server.ssl.key-alias Alias that identifies the key

in the key store.

server.ssl.key-password Password used to access the

key in the key store.

server.ssl.key-store Path to the key store that

holds the SSL certificate
(typically a jks file).

566
Name Description Default Value

server.ssl.key-store-password Password used to access the

key store.

server.ssl.key-store-provider Provider for the key store.

server.ssl.key-store-type Type of the key store.

server.ssl.protocol SSL protocol to use. TLS

server.ssl.trust-store Trust store that holds SSL

certificates.

server.ssl.trust-store-password Password used to access the

trust store.

server.ssl.trust-store-provider Provider for the trust store.

server.ssl.trust-store-type Type of the trust store.

server.tomcat.accept-count Maximum queue length for 100

incoming connection
requests when all possible
request processing threads
are in use.

server.tomcat.accesslog.buffered Whether to buffer output true

such that it is flushed only
periodically.

server.tomcat.accesslog.check-exists Whether to check for log file false

existence so it can be
recreated it if an external
process has renamed it.

server.tomcat.accesslog.condition-if Whether logging of the

request will only be enabled
if
"ServletRequest.getAttribute
(conditionIf)" does not yield
null.

server.tomcat.accesslog.condition- Whether logging of the

unless request will only be enabled
if
"ServletRequest.getAttribute
(conditionUnless)" yield null.

server.tomcat.accesslog.directory Directory in which log files logs

are created. Can be absolute
or relative to the Tomcat
base dir.

server.tomcat.accesslog.enabled Enable access log. false

567
Name Description Default Value

server.tomcat.accesslog.encoding Character set used by the log

file. Default to the system
default character set.

server.tomcat.accesslog.file-date- Date format to place in the .yyyy-MM-dd

format log file name.

server.tomcat.accesslog.ipv6- Whether to use IPv6 false

canonical canonical representation
format as defined by RFC
5952.

server.tomcat.accesslog.locale Locale used to format

timestamps in log entries
and in log file name suffix.
Default to the default locale
of the Java process.

server.tomcat.accesslog.max-days Number of days to retain the -1

access log files before they
are removed.

server.tomcat.accesslog.pattern Format pattern for access common

logs.

server.tomcat.accesslog.prefix Log file name prefix. access_log

server.tomcat.accesslog.rename-on- Whether to defer inclusion false

rotate of the date stamp in the file
name until rotate time.

server.tomcat.accesslog.request- Set request attributes for the false

attributes-enabled IP address, Hostname,
protocol, and port used for
the request.

server.tomcat.accesslog.rotate Whether to enable access true

log rotation.

server.tomcat.accesslog.suffix Log file name suffix. .log

server.tomcat.additional-tld-skip- Comma-separated list of

patterns additional patterns that
match jars to ignore for TLD
scanning. The special '?' and
'*' characters can be used in
the pattern to match one
and only one character and
zero or more characters
respectively.

568
Name Description Default Value

server.tomcat.background-processor- Delay between the 10s

delay invocation of
backgroundProcess
methods. If a duration suffix
is not specified, seconds will
be used.

server.tomcat.basedir Tomcat base directory. If not

specified, a temporary
directory is used.

server.tomcat.connection-timeout Amount of time the

connector will wait, after
accepting a connection, for
the request URI line to be
presented.

server.tomcat.keep-alive-timeout Time to wait for another

HTTP request before the
connection is closed. When
not set the
connectionTimeout is used.
When set to -1 there will be
no timeout.

server.tomcat.max-connections Maximum number of 8192

connections that the server
accepts and processes at any
given time. Once the limit
has been reached, the
operating system may still
accept connections based on
the "acceptCount" property.

server.tomcat.max-http-form-post-size Maximum size of the form 2MB

content in any HTTP post
request.

server.tomcat.max-keep-alive-requests Maximum number of HTTP 100

requests that can be
pipelined before the
connection is closed. When
set to 0 or 1, keep-alive and
pipelining are disabled.
When set to -1, an unlimited
number of pipelined or
keep-alive requests are
allowed.

569
Name Description Default Value

server.tomcat.max-swallow-size Maximum amount of 2MB

request body to swallow.

server.tomcat.mbeanregistry.enabled Whether Tomcat's MBean false

Registry should be enabled.

server.tomcat.processor-cache Maximum number of idle 200

processors that will be
retained in the cache and
reused with a subsequent
request. When set to -1 the
cache will be unlimited with
a theoretical maximum size
equal to the maximum
number of connections.

server.tomcat.redirect-context-root Whether requests to the true

context root should be
redirected by appending a /
to the path. When using SSL
terminated at a proxy, this
property should be set to
false.

server.tomcat.reject-illegal-header Whether to reject requests true

with illegal header names or
values.

server.tomcat.relaxed-path-chars Comma-separated list of

additional unencoded
characters that should be
allowed in URI paths. Only
"< > [ \ ] ^ ` { | }" are
allowed.

server.tomcat.relaxed-query-chars Comma-separated list of

additional unencoded
characters that should be
allowed in URI query
strings. Only "< > [ \ ] ^ ` { |
}" are allowed.

server.tomcat.remoteip.host-header Name of the HTTP header X-Forwarded-Host

from which the remote host
is extracted.

570
Name Description Default Value

server.tomcat.remoteip.internal- Regular expression that 10\\.\\d{1,3}\\.\\d{1,3}\\.

proxies matches proxies that are to \\d{1,3}|192\\.168\\.\\d{1,
3}\\.\\d{1,3}|169\\.254\\.\
be trusted. \d{1,3}\\.\\d{1,3}|127\\.\\
d{1,3}\\.\\d{1,3}\\.\\d{1,3
}|172\\.1[6-
9]{1}\\.\\d{1,3}\\.\\d{1,3}
|172\\.2[0-
9]{1}\\.\\d{1,3}\\.\\d{1,3}
|172\\.3[0-
1]{1}\\.\\d{1,3}\\.\\d{1,3}
|0:0:0:0:0:0:0:1|::1

server.tomcat.remoteip.port-header Name of the HTTP header X-Forwarded-Port

used to override the original
port value.

server.tomcat.remoteip.protocol- Header that holds the

header incoming protocol, usually
named "X-Forwarded-Proto".

server.tomcat.remoteip.protocol- Value of the protocol header https

header-https-value indicating whether the
incoming request uses SSL.

server.tomcat.remoteip.remote-ip- Name of the HTTP header

header from which the remote IP is
extracted. For instance, 'X-
FORWARDED-FOR'.

server.tomcat.resource.allow-caching Whether static resource true

caching is permitted for this
web application.

server.tomcat.resource.cache-ttl Time-to-live of the static

resource cache.

server.tomcat.threads.max Maximum amount of 200

worker threads.

server.tomcat.threads.min-spare Minimum amount of worker 10

threads.

server.tomcat.uri-encoding Character encoding to use to UTF-8

decode the URI.

server.tomcat.use-relative-redirects Whether HTTP 1.1 and later false

location headers generated
by a call to sendRedirect will
use relative or absolute
redirects.

server.undertow.accesslog.dir Undertow access log

directory.

571
Name Description Default Value

server.undertow.accesslog.enabled Whether to enable the false

access log.

server.undertow.accesslog.pattern Format pattern for access common

logs.

server.undertow.accesslog.prefix Log file name prefix. access_log.

server.undertow.accesslog.rotate Whether to enable access true

log rotation.

server.undertow.accesslog.suffix Log file name suffix. log

server.undertow.allow-encoded-slash Whether the server should false

decode percent encoded
slash characters. Enabling
encoded slashes can have
security implications due to
different servers
interpreting the slash
differently. Only enable this
if you have a legacy
application that requires it.

server.undertow.always-set-keep-alive Whether the 'Connection: true

keep-alive' header should be
added to all responses, even
if not required by the HTTP
specification.

server.undertow.buffer-size Size of each buffer. The

default is derived from the
maximum amount of
memory that is available to
the JVM.

server.undertow.decode-url Whether the URL should be true

decoded. When disabled,
percent-encoded characters
in the URL will be left as-is.

server.undertow.direct-buffers Whether to allocate buffers

outside the Java heap. The
default is derived from the
maximum amount of
memory that is available to
the JVM.

server.undertow.eager-filter-init Whether servlet filters true

should be initialized on
startup.

572
Name Description Default Value

server.undertow.max-cookies Maximum number of 200

cookies that are allowed.
This limit exists to prevent
hash collision based DOS
attacks.

server.undertow.max-headers Maximum number of

headers that are allowed.
This limit exists to prevent
hash collision based DOS
attacks.

server.undertow.max-http-post-size Maximum size of the HTTP -1B

post content. When the
value is -1, the default, the
size is unlimited.

server.undertow.max-parameters Maximum number of query

or path parameters that are
allowed. This limit exists to
prevent hash collision based
DOS attacks.

server.undertow.no-request-timeout Amount of time a

connection can sit idle
without processing a
request, before it is closed
by the server.

server.undertow.options.server.*

server.undertow.options.socket.*

server.undertow.preserve-path-on- Whether to preserve the false

forward path of a request when it is
forwarded.

server.undertow.threads.io Number of I/O threads to

create for the worker. The
default is derived from the
number of available
processors.

server.undertow.threads.worker Number of worker threads.

The default is 8 times the
number of I/O threads.

server.undertow.url-charset Charset used to decode UTF-8

URLs.

573
A.12. Security Properties
Name Description Default Value

spring.security.filter.dispatcher- Security filter chain [async, error, request]

types dispatcher types.

spring.security.filter.order Security filter chain order. -100

spring.security.oauth2.client.provide OAuth provider details.

r.*

spring.security.oauth2.client.registr OAuth client registrations.

ation.*

spring.security.oauth2.resourceserver URI that can either be an

.jwt.issuer-uri OpenID Connect discovery
endpoint or an OAuth 2.0
Authorization Server
Metadata endpoint defined
by RFC 8414.

spring.security.oauth2.resourceserver JSON Web Key URI to use to

.jwt.jwk-set-uri verify the JWT token.

spring.security.oauth2.resourceserver JSON Web Algorithm used RS256

.jwt.jws-algorithm for verifying the digital
signatures.

spring.security.oauth2.resourceserver Location of the file

.jwt.public-key-location containing the public key
used to verify a JWT.

spring.security.oauth2.resourceserver Client id used to

.opaquetoken.client-id authenticate with the token
introspection endpoint.

spring.security.oauth2.resourceserver Client secret used to

.opaquetoken.client-secret authenticate with the token
introspection endpoint.

spring.security.oauth2.resourceserver OAuth 2.0 endpoint through

.opaquetoken.introspection-uri which token introspection is
accomplished.

spring.security.saml2.relyingparty.re SAML2 relying party

gistration.* registrations.

spring.security.user.name Default user name. user

spring.security.user.password Password for the default

user name.

spring.security.user.roles Granted roles for the default

user name.

574
A.13. RSocket Properties
Name Description Default Value

spring.rsocket.server.address Network address to which

the server should bind.

spring.rsocket.server.fragment-size Maximum transmission

unit. Frames larger than the
specified value are
fragmented.

spring.rsocket.server.mapping-path Path under which RSocket

handles requests (only
works with websocket
transport).

spring.rsocket.server.port Server port.

spring.rsocket.server.ssl.ciphers

spring.rsocket.server.ssl.client-auth

spring.rsocket.server.ssl.enabled

spring.rsocket.server.ssl.enabled-
protocols

spring.rsocket.server.ssl.key-alias

spring.rsocket.server.ssl.key-
password

spring.rsocket.server.ssl.key-store

spring.rsocket.server.ssl.key-store-
password

spring.rsocket.server.ssl.key-store-
provider

spring.rsocket.server.ssl.key-store-
type

spring.rsocket.server.ssl.protocol

spring.rsocket.server.ssl.trust-store

spring.rsocket.server.ssl.trust-
store-password

spring.rsocket.server.ssl.trust-
store-provider

spring.rsocket.server.ssl.trust-
store-type

spring.rsocket.server.transport RSocket transport protocol. tcp

575
A.14. Actuator Properties
Name Description Default Value

management.auditevents.enabled Whether to enable storage true

of audit events.

management.cloudfoundry.enabled Whether to enable extended true

Cloud Foundry actuator
endpoints.

management.cloudfoundry.skip-ssl- Whether to skip SSL false

validation verification for Cloud
Foundry actuator endpoint
security calls.

management.endpoint.auditevents.cache Maximum time that a 0ms

.time-to-live response can be cached.

management.endpoint.auditevents.enabl Whether to enable the true

ed auditevents endpoint.

management.endpoint.beans.cache.time- Maximum time that a 0ms

to-live response can be cached.

management.endpoint.beans.enabled Whether to enable the beans true

endpoint.

management.endpoint.caches.cache.time Maximum time that a 0ms

-to-live response can be cached.

management.endpoint.caches.enabled Whether to enable the true

caches endpoint.

management.endpoint.conditions.cache. Maximum time that a 0ms

time-to-live response can be cached.

management.endpoint.conditions.enable Whether to enable the true

d conditions endpoint.

management.endpoint.configprops.addit Keys that should be

ional-keys-to-sanitize sanitized in addition to
those already configured.
Keys can be simple strings
that the property ends with
or regular expressions.

management.endpoint.configprops.cache Maximum time that a 0ms

.time-to-live response can be cached.

management.endpoint.configprops.enabl Whether to enable the true

ed configprops endpoint.

576
Name Description Default Value

management.endpoint.configprops.keys- Keys that should be [password, secret, key,

to-sanitize sanitized. Keys can be token, .*credentials.*,
vcap_services,
simple strings that the sun.java.command]
property ends with or
regular expressions.

management.endpoint.env.additional- Keys that should be

keys-to-sanitize sanitized in addition to
those already configured.
Keys can be simple strings
that the property ends with
or regular expressions.

management.endpoint.env.cache.time- Maximum time that a 0ms

to-live response can be cached.

management.endpoint.env.enabled Whether to enable the env true

endpoint.

management.endpoint.env.keys-to- Keys that should be [password, secret, key,

sanitize sanitized. Keys can be token, .*credentials.*,
vcap_services,
simple strings that the sun.java.command]
property ends with or
regular expressions.

management.endpoint.flyway.cache.time Maximum time that a 0ms

-to-live response can be cached.

management.endpoint.flyway.enabled Whether to enable the true

flyway endpoint.

management.endpoint.health.cache.time Maximum time that a 0ms

-to-live response can be cached.

management.endpoint.health.enabled Whether to enable the true

health endpoint.

management.endpoint.health.group.* Health endpoint groups.

management.endpoint.health.probes.ena Whether to enable liveness false

bled and readiness probes.

management.endpoint.health.roles Roles used to determine

whether or not a user is
authorized to be shown
details. When empty, all
authenticated users are
authorized.

management.endpoint.health.show- When to show components.

components If not specified the 'show-
details' setting will be used.

577
Name Description Default Value

management.endpoint.health.show- When to show full health never

details details.

management.endpoint.health.status.htt Mapping of health statuses

p-mapping.* to HTTP status codes. By
default, registered health
statuses map to sensible
defaults (for example, UP
maps to 200).

management.endpoint.health.status.ord Comma-separated list of [DOWN, OUT_OF_SERVICE, UP,

er health statuses in order of UNKNOWN]
severity.

management.endpoint.heapdump.cache.ti Maximum time that a 0ms

me-to-live response can be cached.

management.endpoint.heapdump.enabled Whether to enable the true

heapdump endpoint.

management.endpoint.httptrace.cache.t Maximum time that a 0ms

ime-to-live response can be cached.

management.endpoint.httptrace.enabled Whether to enable the true

httptrace endpoint.

management.endpoint.info.cache.time- Maximum time that a 0ms

to-live response can be cached.

management.endpoint.info.enabled Whether to enable the info true

endpoint.

management.endpoint.integrationgraph. Maximum time that a 0ms

cache.time-to-live response can be cached.

management.endpoint.integrationgraph. Whether to enable the true

enabled integrationgraph endpoint.

management.endpoint.liquibase.cache.t Maximum time that a 0ms

ime-to-live response can be cached.

management.endpoint.liquibase.enabled Whether to enable the true

liquibase endpoint.

management.endpoint.logfile.cache.tim Maximum time that a 0ms

e-to-live response can be cached.

management.endpoint.logfile.enabled Whether to enable the true

logfile endpoint.

management.endpoint.logfile.external- External Logfile to be

file accessed. Can be used if the
logfile is written by output
redirect and not by the
logging system itself.

578
Name Description Default Value

management.endpoint.loggers.cache.tim Maximum time that a 0ms

e-to-live response can be cached.

management.endpoint.loggers.enabled Whether to enable the true

loggers endpoint.

management.endpoint.mappings.cache.ti Maximum time that a 0ms

me-to-live response can be cached.

management.endpoint.mappings.enabled Whether to enable the true

mappings endpoint.

management.endpoint.metrics.cache.tim Maximum time that a 0ms

e-to-live response can be cached.

management.endpoint.metrics.enabled Whether to enable the true

metrics endpoint.

management.endpoint.prometheus.enable Whether to enable the true

d prometheus endpoint.

management.endpoint.quartz.cache.time Maximum time that a 0ms

-to-live response can be cached.

management.endpoint.quartz.enabled Whether to enable the true

quartz endpoint.

management.endpoint.scheduledtasks.ca Maximum time that a 0ms

che.time-to-live response can be cached.

management.endpoint.scheduledtasks.en Whether to enable the true

abled scheduledtasks endpoint.

management.endpoint.sessions.enabled Whether to enable the true

sessions endpoint.

management.endpoint.shutdown.enabled Whether to enable the false

shutdown endpoint.

management.endpoint.startup.cache.tim Maximum time that a 0ms

e-to-live response can be cached.

management.endpoint.startup.enabled Whether to enable the true

startup endpoint.

management.endpoint.threaddump.cache. Maximum time that a 0ms

time-to-live response can be cached.

management.endpoint.threaddump.enable Whether to enable the true

d threaddump endpoint.

management.endpoints.enabled-by- Whether to enable or

default disable all endpoints by
default.

579
Name Description Default Value

management.endpoints.jmx.domain Endpoints JMX domain org.springframework.boot

name. Fallback to
'spring.jmx.default-domain'
if set.

management.endpoints.jmx.exposure.exc Endpoint IDs that should be

lude excluded or '*' for all.

management.endpoints.jmx.exposure.inc Endpoint IDs that should be *

lude included or '*' for all.

management.endpoints.jmx.static-names Additional static properties

to append to all
ObjectNames of MBeans
representing Endpoints.

management.endpoints.migrate-legacy- Whether to transparently false

ids migrate legacy endpoint IDs.

management.endpoints.web.base-path Base path for Web /actuator

endpoints. Relative to the
servlet context path
(server.servlet.context-path)
or WebFlux base path
(spring.webflux.base-path)
when the management
server is sharing the main
server port. Relative to the
management server base
path
(management.server.base-
path) when a separate
management server port
(management.server.port) is
configured.

management.endpoints.web.cors.allow- Whether credentials are

credentials supported. When not set,
credentials are not
supported.

management.endpoints.web.cors.allowed Comma-separated list of

-headers headers to allow in a
request. '*' allows all
headers.

management.endpoints.web.cors.allowed Comma-separated list of

-methods methods to allow. '*' allows
all methods. When not set,
defaults to GET.

580
Name Description Default Value

management.endpoints.web.cors.allowed Comma-separated list of

-origin-patterns origin patterns to allow.
Unlike allowed origins
which only supports '*',
origin patterns are more
flexible (for example
'https://*.example.com') and
can be used when
credentials are allowed.
When no allowed origin
patterns or allowed origins
are set, CORS support is
disabled.

management.endpoints.web.cors.allowed Comma-separated list of

-origins origins to allow. '*' allows all
origins. When credentials
are allowed, '*' cannot be
used and origin patterns
should be configured
instead. When no allowed
origins or allowed origin
patterns are set, CORS
support is disabled.

management.endpoints.web.cors.exposed Comma-separated list of

-headers headers to include in a
response.

management.endpoints.web.cors.max-age How long the response from 1800s

a pre-flight request can be
cached by clients. If a
duration suffix is not
specified, seconds will be
used.

management.endpoints.web.discovery.en Whether the discovery page true

abled is enabled.

management.endpoints.web.exposure.exc Endpoint IDs that should be

lude excluded or '*' for all.

management.endpoints.web.exposure.inc Endpoint IDs that should be [health]

lude included or '*' for all.

management.endpoints.web.path- Mapping between endpoint

mapping.* IDs and the path that should
expose them.

management.health.cassandra.enabled Whether to enable true

Cassandra health check.

581
Name Description Default Value

management.health.couchbase.enabled Whether to enable true

Couchbase health check.

management.health.db.enabled Whether to enable database true

health check.

management.health.db.ignore-routing- Whether to ignore false

data-sources AbstractRoutingDataSources
when creating database
health indicators.

management.health.defaults.enabled Whether to enable default true

health indicators.

management.health.diskspace.enabled Whether to enable disk true

space health check.

management.health.diskspace.path Path used to compute the

available disk space.

management.health.diskspace.threshold Minimum disk space that 10MB

should be available.

management.health.elasticsearch.enabl Whether to enable true

ed Elasticsearch health check.

management.health.influxdb.enabled Whether to enable InfluxDB true

health check.

management.health.jms.enabled Whether to enable JMS true

health check.

management.health.ldap.enabled Whether to enable LDAP true

health check.

management.health.livenessstate.enabl Whether to enable liveness false

ed state health check.

management.health.mail.enabled Whether to enable Mail true

health check.

management.health.mongo.enabled Whether to enable MongoDB true

health check.

management.health.neo4j.enabled Whether to enable Neo4j true

health check.

management.health.ping.enabled Whether to enable ping true

health check.

management.health.rabbit.enabled Whether to enable true

RabbitMQ health check.

management.health.readinessstate.enab Whether to enable readiness false

led state health check.

582
Name Description Default Value

management.health.redis.enabled Whether to enable Redis true

health check.

management.health.solr.enabled Whether to enable Solr true

health check.

management.health.status.order [DOWN, OUT_OF_SERVICE, UP,

UNKNOWN]

management.info.build.enabled Whether to enable build true

info.

management.info.defaults.enabled Whether to enable default true

info contributors.

management.info.env.enabled Whether to enable false

environment info.

management.info.git.enabled Whether to enable git info. true

management.info.git.mode Mode to use to expose git simple

information.

management.info.java.enabled Whether to enable Java info. false

management.info.os.enabled Whether to enable false

Operating System info.

management.metrics.data.repository.au true
totime.enabled

management.metrics.data.repository.au
totime.percentiles

management.metrics.data.repository.au false
totime.percentiles-histogram

management.metrics.data.repository.me Name of the metric for sent spring.data.repository.invo

tric-name requests. cations

management.metrics.distribution.buffe Number of histograms for

r-length.* meter IDs starting with the
specified name to keep in
the ring buffer. The longest
match wins, the key `all`
can also be used to
configure all meters.

583
Name Description Default Value

management.metrics.distribution.expir Maximum amount of time

y.* that samples for meter IDs
starting with the specified
name are accumulated to
decaying distribution
statistics before they are
reset and rotated. The
longest match wins, the key
`all` can also be used to
configure all meters.

management.metrics.distribution.maxim Maximum value that meter

um-expected-value.* IDs starting with the
specified name are expected
to observe. The longest
match wins. Values can be
specified as a double or as a
Duration value (for timer
meters, defaulting to ms if
no unit specified).

management.metrics.distribution.minim Minimum value that meter

um-expected-value.* IDs starting with the
specified name are expected
to observe. The longest
match wins. Values can be
specified as a double or as a
Duration value (for timer
meters, defaulting to ms if
no unit specified).

management.metrics.distribution.perce Specific computed non-

ntiles.* aggregable percentiles to
ship to the backend for
meter IDs starting-with the
specified name. The longest
match wins, the key 'all' can
also be used to configure all
meters.

584
Name Description Default Value

management.metrics.distribution.perce Whether meter IDs starting

ntiles-histogram.* with the specified name
should publish percentile
histograms. For monitoring
systems that support
aggregable percentile
calculation based on a
histogram, this can be set to
true. For other systems, this
has no effect. The longest
match wins, the key 'all' can
also be used to configure all
meters.

management.metrics.distribution.slo.* Specific service-level

objective boundaries for
meter IDs starting with the
specified name. The longest
match wins. Counters will be
published for each specified
boundary. Values can be
specified as a double or as a
Duration value (for timer
meters, defaulting to ms if
no unit specified).

management.metrics.enable.* Whether meter IDs starting

with the specified name
should be enabled. The
longest match wins, the key
'all' can also be used to
configure all meters.

management.metrics.export.appoptics.a AppOptics API token.

pi-token

management.metrics.export.appoptics.b Number of measurements 500

atch-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.appoptics.c Connection timeout for 5s

onnect-timeout requests to this backend.

management.metrics.export.appoptics.e Whether exporting of true

nabled metrics to this backend is
enabled.

585
Name Description Default Value

management.metrics.export.appoptics.f Whether to ship a floored false

loor-times time, useful when sending
measurements from
multiple hosts to align them
on a given time boundary.

management.metrics.export.appoptics.h Tag that will be mapped to instance

ost-tag "@host" when shipping
metrics to AppOptics.

management.metrics.export.appoptics.r Read timeout for requests to 10s

ead-timeout this backend.

management.metrics.export.appoptics.s Step size (i.e. reporting 1m

tep frequency) to use.

management.metrics.export.appoptics.u URI to ship metrics to. https://api.appoptics.com/v

ri 1/measurements

management.metrics.export.atlas.batch Number of measurements 10000

-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.atlas.confi Frequency for refreshing 10s

g-refresh-frequency config settings from the LWC
service.

management.metrics.export.atlas.confi Time to live for 150s

g-time-to-live subscriptions from the LWC
service.

management.metrics.export.atlas.confi URI for the Atlas LWC http://localhost:7101/lwc/a

g-uri endpoint to retrieve current pi/v1/expressions/local-dev
subscriptions.

management.metrics.export.atlas.conne Connection timeout for 1s

ct-timeout requests to this backend.

management.metrics.export.atlas.enabl Whether exporting of true

ed metrics to this backend is
enabled.

management.metrics.export.atlas.eval- URI for the Atlas LWC http://localhost:7101/lwc/a

uri endpoint to evaluate the pi/v1/evaluate
data for a subscription.

management.metrics.export.atlas.lwc- Whether to enable false

enabled streaming to Atlas LWC.

586
Name Description Default Value

management.metrics.export.atlas.meter Time to live for meters that 15m

-time-to-live do not have any activity.
After this period the meter
will be considered expired
and will not get reported.

management.metrics.export.atlas.num- Number of threads to use 4

threads with the metrics publishing
scheduler.

management.metrics.export.atlas.read- Read timeout for requests to 10s

timeout this backend.

management.metrics.export.atlas.step Step size (i.e. reporting 1m

frequency) to use.

management.metrics.export.atlas.uri URI of the Atlas server. http://localhost:7101/api/v

1/publish

management.metrics.export.datadog.api Datadog API key.

-key

management.metrics.export.datadog.app Datadog application key. Not

lication-key strictly required, but
improves the Datadog
experience by sending meter
descriptions, types, and base
units to Datadog.

management.metrics.export.datadog.bat Number of measurements 10000

ch-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.datadog.con Connection timeout for 1s

nect-timeout requests to this backend.

management.metrics.export.datadog.des Whether to publish true

criptions descriptions metadata to
Datadog. Turn this off to
minimize the amount of
metadata sent.

management.metrics.export.datadog.ena Whether exporting of true

bled metrics to this backend is
enabled.

management.metrics.export.datadog.hos Tag that will be mapped to instance

t-tag "host" when shipping
metrics to Datadog.

587
Name Description Default Value

management.metrics.export.datadog.rea Read timeout for requests to 10s

d-timeout this backend.

management.metrics.export.datadog.ste Step size (i.e. reporting 1m

p frequency) to use.

management.metrics.export.datadog.uri URI to ship metrics to. If you https://api.datadoghq.com

need to publish metrics to
an internal proxy en-route
to Datadog, you can define
the location of the proxy
with this.

management.metrics.export.defaults.en Whether to enable default true

abled metrics exporters.

management.metrics.export.dynatrace.a Dynatrace authentication

pi-token token.

management.metrics.export.dynatrace.b Number of measurements 10000

atch-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.dynatrace.c Connection timeout for 1s

onnect-timeout requests to this backend.

management.metrics.export.dynatrace.e Whether exporting of true

nabled metrics to this backend is
enabled.

management.metrics.export.dynatrace.r Read timeout for requests to 10s

ead-timeout this backend.

management.metrics.export.dynatrace.s Step size (i.e. reporting 1m

tep frequency) to use.

management.metrics.export.dynatrace.u URI to ship metrics to.

ri Should be used for SaaS, self
managed instances or to en-
route through an internal
proxy.

management.metrics.export.dynatrace.v ID of the custom device that

1.device-id is exporting metrics to
Dynatrace.

management.metrics.export.dynatrace.v Group for exported metrics.

1.group Used to specify custom
device group name in the
Dynatrace UI.

588
Name Description Default Value

management.metrics.export.dynatrace.v Technology type for java

1.technology-type exported metrics. Used to
group metrics under a
logical technology name in
the Dynatrace UI.

management.metrics.export.dynatrace.v Default dimensions that are

2.default-dimensions.* added to all metrics in the
form of key-value pairs.
These are overwritten by
Micrometer tags if they use
the same key.

management.metrics.export.dynatrace.v Whether to enable true

2.enrich-with-dynatrace-metadata Dynatrace metadata export.

management.metrics.export.dynatrace.v Prefix string that is added to

2.metric-key-prefix all exported metrics.

management.metrics.export.elastic.api Base64-encoded credentials

-key-credentials string. Mutually exclusive
with user-name and
password.

management.metrics.export.elastic.aut Whether to create the index true

o-create-index automatically if it does not
exist.

management.metrics.export.elastic.bat Number of measurements 10000

ch-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.elastic.con Connection timeout for 1s

nect-timeout requests to this backend.

management.metrics.export.elastic.ena Whether exporting of true

bled metrics to this backend is
enabled.

management.metrics.export.elastic.hos Host to export metrics to. http://localhost:9200

t

management.metrics.export.elastic.ind Index to export metrics to. micrometer-metrics

ex

management.metrics.export.elastic.ind Index date format used for yyyy-MM

ex-date-format rolling indices. Appended to
the index name.

589
Name Description Default Value

management.metrics.export.elastic.ind Prefix to separate the index -

ex-date-separator name from the date format
used for rolling indices.

management.metrics.export.elastic.pas Login password of the

sword Elastic server. Mutually
exclusive with api-key-
credentials.

management.metrics.export.elastic.pip Ingest pipeline name. By

eline default, events are not pre-
processed.

management.metrics.export.elastic.rea Read timeout for requests to 10s

d-timeout this backend.

management.metrics.export.elastic.ste Step size (i.e. reporting 1m

p frequency) to use.

management.metrics.export.elastic.tim Name of the timestamp field. @timestamp

estamp-field-name

management.metrics.export.elastic.use Login user of the Elastic

r-name server. Mutually exclusive
with api-key-credentials.

management.metrics.export.ganglia.add UDP addressing mode, multicast

ressing-mode either unicast or multicast.

management.metrics.export.ganglia.dur Base time unit used to milliseconds

ation-units report durations.

management.metrics.export.ganglia.ena Whether exporting of true

bled metrics to Ganglia is
enabled.

management.metrics.export.ganglia.hos Host of the Ganglia server to localhost

t receive exported metrics.

management.metrics.export.ganglia.por Port of the Ganglia server to 8649

t receive exported metrics.

management.metrics.export.ganglia.ste Step size (i.e. reporting 1m

p frequency) to use.

management.metrics.export.ganglia.tim Time to live for metrics on 1

e-to-live Ganglia. Set the multi-cast
Time-To-Live to be one
greater than the number of
hops (routers) between the
hosts.

management.metrics.export.graphite.du Base time unit used to milliseconds

ration-units report durations.

590
Name Description Default Value

management.metrics.export.graphite.en Whether exporting of true

abled metrics to Graphite is
enabled.

management.metrics.export.graphite.gr Whether Graphite tags

aphite-tags-enabled should be used, as opposed
to a hierarchical naming
convention. Enabled by
default unless "tagsAsPrefix"
is set.

management.metrics.export.graphite.ho Host of the Graphite server localhost

st to receive exported metrics.

management.metrics.export.graphite.po Port of the Graphite server 2004

rt to receive exported metrics.

management.metrics.export.graphite.pr Protocol to use while pickled

otocol shipping data to Graphite.

management.metrics.export.graphite.ra Base time unit used to seconds

te-units report rates.

management.metrics.export.graphite.st Step size (i.e. reporting 1m

ep frequency) to use.

management.metrics.export.graphite.ta For the hierarchical naming []

gs-as-prefix convention, turn the
specified tag keys into part
of the metric prefix. Ignored
if "graphiteTagsEnabled" is
true.

management.metrics.export.humio.api- Humio API token.

token

management.metrics.export.humio.batch Number of measurements 10000

-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.humio.conne Connection timeout for 5s

ct-timeout requests to this backend.

management.metrics.export.humio.enabl Whether exporting of true

ed metrics to this backend is
enabled.

management.metrics.export.humio.read- Read timeout for requests to 10s

timeout this backend.

591
Name Description Default Value

management.metrics.export.humio.step Step size (i.e. reporting 1m

frequency) to use.

management.metrics.export.humio.tags. Humio tags describing the

* data source in which metrics
will be stored. Humio tags
are a distinct concept from
Micrometer's tags.
Micrometer's tags are used
to divide metrics along
dimensional boundaries.

management.metrics.export.humio.uri URI to ship metrics to. If you https://cloud.humio.com

need to publish metrics to
an internal proxy en-route
to Humio, you can define the
location of the proxy with
this.

management.metrics.export.influx.api- API version of InfluxDB to

version use. Defaults to 'v1' unless
an org is configured. If an
org is configured, defaults to
'v2'.

management.metrics.export.influx.auto Whether to create the Influx true

-create-db database if it does not exist
before attempting to publish
metrics to it. InfluxDB v1
only.

management.metrics.export.influx.batc Number of measurements 10000

h-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.influx.buck Bucket for metrics. Use

et either the bucket name or
ID. Defaults to the value of
the db property if not set.
InfluxDB v2 only.

management.metrics.export.influx.comp Whether to enable GZIP true

ressed compression of metrics
batches published to Influx.

management.metrics.export.influx.conn Connection timeout for 1s

ect-timeout requests to this backend.

592
Name Description Default Value

management.metrics.export.influx.cons Write consistency for each one

istency point.

management.metrics.export.influx.db Database to send metrics to. mydb

InfluxDB v1 only.

management.metrics.export.influx.enab Whether exporting of true

led metrics to this backend is
enabled.

management.metrics.export.influx.org Org to write metrics to.

InfluxDB v2 only.

management.metrics.export.influx.pass Login password of the Influx

word server. InfluxDB v1 only.

management.metrics.export.influx.read Read timeout for requests to 10s

-timeout this backend.

management.metrics.export.influx.rete Time period for which

ntion-duration Influx should retain data in
the current database. For
instance 7d, check the influx
documentation for more
details on the duration
format. InfluxDB v1 only.

management.metrics.export.influx.rete Retention policy to use

ntion-policy (Influx writes to the
DEFAULT retention policy if
one is not specified).
InfluxDB v1 only.

management.metrics.export.influx.rete How many copies of the data

ntion-replication-factor are stored in the cluster.
Must be 1 for a single node
instance. InfluxDB v1 only.

management.metrics.export.influx.rete Time range covered by a

ntion-shard-duration shard group. For instance
2w, check the influx
documentation for more
details on the duration
format. InfluxDB v1 only.

management.metrics.export.influx.step Step size (i.e. reporting 1m

frequency) to use.

593
Name Description Default Value

management.metrics.export.influx.toke Authentication token to use

n with calls to the InfluxDB
backend. For InfluxDB v1,
the Bearer scheme is used.
For v2, the Token scheme is
used.

management.metrics.export.influx.uri URI of the Influx server. http://localhost:8086

management.metrics.export.influx.user Login user of the Influx

-name server. InfluxDB v1 only.

management.metrics.export.jmx.domain Metrics JMX domain name. metrics

management.metrics.export.jmx.enabled Whether exporting of true

metrics to JMX is enabled.

management.metrics.export.jmx.step Step size (i.e. reporting 1m

frequency) to use.

management.metrics.export.kairos.batc Number of measurements 10000

h-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.kairos.conn Connection timeout for 1s

ect-timeout requests to this backend.

management.metrics.export.kairos.enab Whether exporting of true

led metrics to this backend is
enabled.

management.metrics.export.kairos.pass Login password of the

word KairosDB server.

management.metrics.export.kairos.read Read timeout for requests to 10s

-timeout this backend.

management.metrics.export.kairos.step Step size (i.e. reporting 1m

frequency) to use.

management.metrics.export.kairos.uri URI of the KairosDB server. http://localhost:8080/api/v

1/datapoints

management.metrics.export.kairos.user Login user of the KairosDB

-name server.

management.metrics.export.newrelic.ac New Relic account ID.

count-id

management.metrics.export.newrelic.ap New Relic API key.

i-key

594
Name Description Default Value

management.metrics.export.newrelic.ba Number of measurements 10000

tch-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.newrelic.cl Client provider type to use.

ient-provider-type

management.metrics.export.newrelic.co Connection timeout for 1s

nnect-timeout requests to this backend.

management.metrics.export.newrelic.en Whether exporting of true

abled metrics to this backend is
enabled.

management.metrics.export.newrelic.ev The event type that should SpringBootSample

ent-type be published. This property
will be ignored if 'meter-
name-event-type-enabled' is
set to 'true'.

management.metrics.export.newrelic.me Whether to send the meter false

ter-name-event-type-enabled name as the event type
instead of using the 'event-
type' configuration property
value. Can be set to 'true' if
New Relic guidelines are not
being followed or event
types consistent with
previous Spring Boot
releases are required.

management.metrics.export.newrelic.re Read timeout for requests to 10s

ad-timeout this backend.

management.metrics.export.newrelic.st Step size (i.e. reporting 1m

ep frequency) to use.

management.metrics.export.newrelic.ur URI to ship metrics to. https://insights-

i collector.newrelic.com

management.metrics.export.prometheus. Whether to enable true

descriptions publishing descriptions as
part of the scrape payload to
Prometheus. Turn this off to
minimize the amount of
data sent on each scrape.

595
Name Description Default Value

management.metrics.export.prometheus. Whether exporting of true

enabled metrics to Prometheus is
enabled.

management.metrics.export.prometheus. Histogram type for backing prometheus

histogram-flavor DistributionSummary and
Timer.

management.metrics.export.prometheus. Base URL for the http://localhost:9091

pushgateway.base-url Pushgateway.

management.metrics.export.prometheus. Enable publishing via a false

pushgateway.enabled Prometheus Pushgateway.

management.metrics.export.prometheus. Grouping key for the pushed

pushgateway.grouping-key.* metrics.

management.metrics.export.prometheus. Job identifier for this

pushgateway.job application instance.

management.metrics.export.prometheus. Login password of the

pushgateway.password Prometheus Pushgateway.

management.metrics.export.prometheus. Frequency with which to 1m

pushgateway.push-rate push metrics.

management.metrics.export.prometheus. Operation that should be none

pushgateway.shutdown-operation performed on shutdown.

management.metrics.export.prometheus. Login user of the

pushgateway.username Prometheus Pushgateway.

management.metrics.export.prometheus. Step size (i.e. reporting 1m

step frequency) to use.

management.metrics.export.signalfx.ac SignalFX access token.

cess-token

management.metrics.export.signalfx.ba Number of measurements 10000

tch-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.signalfx.co Connection timeout for 1s

nnect-timeout requests to this backend.

management.metrics.export.signalfx.en Whether exporting of true

abled metrics to this backend is
enabled.

management.metrics.export.signalfx.re Read timeout for requests to 10s

ad-timeout this backend.

596
Name Description Default Value

management.metrics.export.signalfx.so Uniquely identifies the app

urce instance that is publishing
metrics to SignalFx. Defaults
to the local host name.

management.metrics.export.signalfx.st Step size (i.e. reporting 10s

ep frequency) to use.

management.metrics.export.signalfx.ur URI to ship metrics to. https://ingest.signalfx.com

i

management.metrics.export.simple.enab Whether, in the absence of true

led any other exporter,
exporting of metrics to an
in-memory backend is
enabled.

management.metrics.export.simple.mode Counting mode. cumulative

management.metrics.export.simple.step Step size (i.e. reporting 1m

frequency) to use.

management.metrics.export.stackdriver Number of measurements 10000

.batch-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

management.metrics.export.stackdriver Connection timeout for 1s

.connect-timeout requests to this backend.

management.metrics.export.stackdriver Whether exporting of true

.enabled metrics to this backend is
enabled.

management.metrics.export.stackdriver Identifier of the Google

.project-id Cloud project to monitor.

management.metrics.export.stackdriver Read timeout for requests to 10s

.read-timeout this backend.

management.metrics.export.stackdriver Monitored resource's labels.

.resource-labels.*

management.metrics.export.stackdriver Monitored resource type. global

.resource-type

management.metrics.export.stackdriver Step size (i.e. reporting 1m

.step frequency) to use.

597
Name Description Default Value

management.metrics.export.stackdriver Whether to use semantically false

.use-semantic-metric-types correct metric types. When
false, counter metrics are
published as the GAUGE
MetricKind. When true,
counter metrics are
published as the
CUMULATIVE MetricKind.

management.metrics.export.statsd.enab Whether exporting of true

led metrics to StatsD is enabled.

management.metrics.export.statsd.flav StatsD line protocol to use. datadog

or

management.metrics.export.statsd.host Host of the StatsD server to localhost

receive exported metrics.

management.metrics.export.statsd.max- Total length of a single 1400

packet-length payload should be kept
within your network's MTU.

management.metrics.export.statsd.poll How often gauges will be 10s

ing-frequency polled. When a gauge is
polled, its value is
recalculated and if the value
has changed (or
publishUnchangedMeters is
true), it is sent to the StatsD
server.

management.metrics.export.statsd.port Port of the StatsD server to 8125

receive exported metrics.

management.metrics.export.statsd.prot Protocol of the StatsD server udp

ocol to receive exported metrics.

management.metrics.export.statsd.publ Whether to send unchanged true

ish-unchanged-meters meters to the StatsD server.

management.metrics.export.wavefront.a API token used when

pi-token publishing metrics directly
to the Wavefront API host.

management.metrics.export.wavefront.b Number of measurements 10000

atch-size per request to use for this
backend. If more
measurements are found,
then multiple requests will
be made.

598
Name Description Default Value

management.metrics.export.wavefront.e Whether exporting of true

nabled metrics to this backend is
enabled.

management.metrics.export.wavefront.g Global prefix to separate

lobal-prefix metrics originating from this
app's white box
instrumentation from those
originating from other
Wavefront integrations
when viewed in the
Wavefront UI.

management.metrics.export.wavefront.s 1s
ender.flush-interval

management.metrics.export.wavefront.s 50000
ender.max-queue-size

management.metrics.export.wavefront.s
ender.message-size

management.metrics.export.wavefront.s Unique identifier for the app

ource instance that is the source of
metrics being published to
Wavefront. Defaults to the
local host name.

management.metrics.export.wavefront.s Step size (i.e. reporting 1m

tep frequency) to use.

management.metrics.export.wavefront.u URI to ship metrics to. https://longboard.wavefront

ri .com

management.metrics.mongo.command.enab Whether to enable Mongo true

led client command metrics.

management.metrics.mongo.connectionpo Whether to enable Mongo true

ol.enabled connection pool metrics.

management.metrics.system.diskspace.p Comma-separated list of [.]

aths paths to report disk metrics
for.

management.metrics.tags.* Common tags that are

applied to every meter.

599
Name Description Default Value

management.metrics.use-global- Whether auto-configured true

registry MeterRegistry
implementations should be
bound to the global static
registry on Metrics. For
testing, set this to 'false' to
maximize test
independence.

management.metrics.web.client.max- Maximum number of 100

uri-tags unique URI tag values
allowed. After the max
number of tag values is
reached, metrics with
additional tag values are
denied by filter.

management.metrics.web.client.request Whether to automatically true

.autotime.enabled time web client requests.

management.metrics.web.client.request Computed non-aggregable

.autotime.percentiles percentiles to publish.

management.metrics.web.client.request Whether percentile false

.autotime.percentiles-histogram histograms should be
published.

management.metrics.web.client.request Name of the metric for sent http.client.requests

.metric-name requests.

management.metrics.web.server.max- Maximum number of 100

uri-tags unique URI tag values
allowed. After the max
number of tag values is
reached, metrics with
additional tag values are
denied by filter.

management.metrics.web.server.request Whether to automatically true

.autotime.enabled time web server requests.

management.metrics.web.server.request Computed non-aggregable

.autotime.percentiles percentiles to publish.

management.metrics.web.server.request Whether percentile false

.autotime.percentiles-histogram histograms should be
published.

management.metrics.web.server.request Whether the trailing slash true

.ignore-trailing-slash should be ignored when
recording metrics.

600
Name Description Default Value

management.metrics.web.server.request Name of the metric for http.server.requests

.metric-name received requests.

management.server.add-application- Add the "X-Application- false

context-header Context" HTTP header in
each response.

management.server.address Network address to which

the management endpoints
should bind. Requires a
custom
management.server.port.

management.server.base-path Management endpoint base

path (for instance,
'/management'). Requires a
custom
management.server.port.

management.server.port Management endpoint HTTP

port (uses the same port as
the application by default).
Configure a different port to
use management-specific
SSL.

management.server.ssl.ciphers Supported SSL ciphers.

management.server.ssl.client-auth Client authentication mode.

Requires a trust store.

management.server.ssl.enabled Whether to enable SSL true

support.

management.server.ssl.enabled- Enabled SSL protocols.

protocols

management.server.ssl.key-alias Alias that identifies the key

in the key store.

management.server.ssl.key-password Password used to access the

key in the key store.

management.server.ssl.key-store Path to the key store that

holds the SSL certificate
(typically a jks file).

management.server.ssl.key-store- Password used to access the

password key store.

management.server.ssl.key-store- Provider for the key store.

provider

management.server.ssl.key-store-type Type of the key store.

601
Name Description Default Value

management.server.ssl.protocol SSL protocol to use. TLS

management.server.ssl.trust-store Trust store that holds SSL

certificates.

management.server.ssl.trust-store- Password used to access the

password trust store.

management.server.ssl.trust-store- Provider for the trust store.

provider

management.server.ssl.trust-store- Type of the trust store.

type

management.trace.http.enabled Whether to enable HTTP true

request-response tracing.

management.trace.http.include Items to be included in the [request-headers, response-

trace. Defaults to request headers, errors]
headers (excluding
Authorization and Cookie),
response headers (excluding
Set-Cookie), and time taken.

A.15. Devtools Properties

Name Description Default Value

spring.devtools.add-properties Whether to enable true

development property
defaults.

spring.devtools.livereload.enabled Whether to enable a true

livereload.com-compatible
server.

spring.devtools.livereload.port Server port. 35729

spring.devtools.remote.context-path Context path used to handle /.~~spring-boot!~

the remote connection.

spring.devtools.remote.proxy.host The host of the proxy to use

to connect to the remote
application.

spring.devtools.remote.proxy.port The port of the proxy to use

to connect to the remote
application.

spring.devtools.remote.restart.enable Whether to enable remote true

d restart.

602
Name Description Default Value

spring.devtools.remote.secret A shared secret required to

establish a connection
(required to enable remote
support).

spring.devtools.remote.secret-header- HTTP header used to X-AUTH-TOKEN

name transfer the shared secret.

spring.devtools.restart.additional- Additional patterns that

exclude should be excluded from
triggering a full restart.

spring.devtools.restart.additional- Additional paths to watch

paths for changes.

spring.devtools.restart.enabled Whether to enable true

automatic restart.

spring.devtools.restart.exclude Patterns that should be META-INF/maven/**,META-

excluded from triggering a INF/resources/**,resources/
**,static/**,public/**,temp
full restart. lates/**,**/*Test.class,**/
*Tests.class,git.properties
,META-INF/build-
info.properties

spring.devtools.restart.log- Whether to log the condition true

condition-evaluation-delta evaluation delta upon
restart.

spring.devtools.restart.poll-interval Amount of time to wait 1s

between polling for
classpath changes.

spring.devtools.restart.quiet-period Amount of quiet time 400ms

required without any
classpath changes before a
restart is triggered.

spring.devtools.restart.trigger-file Name of a specific file that,

when changed, triggers the
restart check. Must be a
simple name (without any
path) of a file that appears
on your classpath. If not
specified, any classpath file
change triggers the restart.

A.16. Testing Properties

603
Name Description Default Value

spring.test.database.replace Type of existing DataSource any

to replace.

spring.test.mockmvc.print MVC Print option. default

604
Appendix B: Configuration Metadata
Spring Boot jars include metadata files that provide details of all supported configuration
properties. The files are designed to let IDE developers offer contextual help and “code completion”
as users are working with application.properties or application.yml files.

The majority of the metadata file is generated automatically at compile time by processing all items
annotated with @ConfigurationProperties. However, it is possible to write part of the metadata
manually for corner cases or more advanced use cases.

B.1. Metadata Format

Configuration metadata files are located inside jars under META-INF/spring-configuration-
metadata.json. They use a JSON format with items categorized under either “groups” or “properties”
and additional values hints categorized under "hints", as shown in the following example:

{"groups": [
  {
  "name": "server",
  "type": "org.springframework.boot.autoconfigure.web.ServerProperties",
  "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
  },
  {
  "name": "spring.jpa.hibernate",
  "type":
"org.springframework.boot.autoconfigure.orm.jpa.JpaProperties$Hibernate",
  "sourceType": "org.springframework.boot.autoconfigure.orm.jpa.JpaProperties",
  "sourceMethod": "getHibernate()"
  }
  ...
],"properties": [
  {
  "name": "server.port",
  "type": "java.lang.Integer",
  "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
  },
  {
  "name": "server.address",
  "type": "java.net.InetAddress",
  "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
  },
  {
  "name": "spring.jpa.hibernate.ddl-auto",
  "type": "java.lang.String",
  "description": "DDL mode. This is actually a shortcut for the
\"hibernate.hbm2ddl.auto\" property.",
  "sourceType":
"org.springframework.boot.autoconfigure.orm.jpa.JpaProperties$Hibernate"
  }

605
   ...
],"hints": [
  {
  "name": "spring.jpa.hibernate.ddl-auto",
  "values": [
  {
  "value": "none",
  "description": "Disable DDL handling."
  },
  {
  "value": "validate",
  "description": "Validate the schema, make no changes to the database."
  },
  {
  "value": "update",
  "description": "Update the schema if necessary."
  },
  {
  "value": "create",
  "description": "Create the schema and destroy previous data."
  },
  {
  "value": "create-drop",
  "description": "Create and then destroy the schema at the end of the
session."
  }
  ]
  }
]}

Each “property” is a configuration item that the user specifies with a given value. For example,
server.port and server.address might be specified in your application.properties/application.yaml,
as follows:

Properties

server.port=9090
server.address=127.0.0.1

Yaml

server:
  port: 9090
  address: 127.0.0.1

The “groups” are higher level items that do not themselves specify a value but instead provide a
contextual grouping for properties. For example, the server.port and server.address properties are
part of the server group.

606
 It is not required that every “property” has a “group”. Some properties might exist
NOTE
in their own right.

Finally, “hints” are additional information used to assist the user in configuring a given property.
For example, when a developer is configuring the spring.jpa.hibernate.ddl-auto property, a tool
can use the hints to offer some auto-completion help for the none, validate, update, create, and
create-drop values.

B.1.1. Group Attributes

The JSON object contained in the groups array can contain the attributes shown in the following
table:

Name Type Purpose

name String The full name of the group. This attribute is mandatory.
type String The class name of the data type of the group. For example, if the
group were based on a class annotated with
@ConfigurationProperties, the attribute would contain the fully
qualified name of that class. If it were based on a @Bean method, it
would be the return type of that method. If the type is not known,
the attribute may be omitted.
description String A short description of the group that can be displayed to users. If
no description is available, it may be omitted. It is recommended
that descriptions be short paragraphs, with the first line
providing a concise summary. The last line in the description
should end with a period (.).
sourceType String The class name of the source that contributed this group. For
example, if the group were based on a @Bean method annotated
with @ConfigurationProperties, this attribute would contain the
fully qualified name of the @Configuration class that contains the
method. If the source type is not known, the attribute may be
omitted.
sourceMethod String The full name of the method (include parenthesis and argument
types) that contributed this group (for example, the name of a
@ConfigurationProperties annotated @Bean method). If the source
method is not known, it may be omitted.

B.1.2. Property Attributes

The JSON object contained in the properties array can contain the attributes described in the
following table:

607
Name Type Purpose
name String The full name of the property. Names are in lower-case period-
separated form (for example, server.address). This attribute is
mandatory.
type String The full signature of the data type of the property (for example,
java.lang.String) but also a full generic type (such as
java.util.Map<java.lang.String,com.example.MyEnum>). You can
use this attribute to guide the user as to the types of values that
they can enter. For consistency, the type of a primitive is
specified by using its wrapper counterpart (for example, boolean
becomes java.lang.Boolean). Note that this class may be a
complex type that gets converted from a String as values are
bound. If the type is not known, it may be omitted.
description String A short description of the property that can be displayed to users.
If no description is available, it may be omitted. It is
recommended that descriptions be short paragraphs, with the
first line providing a concise summary. The last line in the
description should end with a period (.).
sourceType String The class name of the source that contributed this property. For
example, if the property were from a class annotated with
@ConfigurationProperties, this attribute would contain the fully
qualified name of that class. If the source type is unknown, it
may be omitted.
defaultValue Object The default value, which is used if the property is not specified. If
the type of the property is an array, it can be an array of value(s).
If the default value is unknown, it may be omitted.
deprecation Deprecation Specify whether the property is deprecated. If the field is not
deprecated or if that information is not known, it may be
omitted. The next table offers more detail about the deprecation
attribute.

The JSON object contained in the deprecation attribute of each properties element can contain the
following attributes:

Name Type Purpose

level String The level of deprecation, which can be either warning (the
default) or error. When a property has a warning deprecation
level, it should still be bound in the environment. However,
when it has an error deprecation level, the property is no longer
managed and is not bound.

608
Name Type Purpose
reason String A short description of the reason why the property was
deprecated. If no reason is available, it may be omitted. It is
recommended that descriptions be short paragraphs, with the
first line providing a concise summary. The last line in the
description should end with a period (.).
replacement String The full name of the property that replaces this deprecated
property. If there is no replacement for this property, it may be
omitted.

Prior to Spring Boot 1.3, a single deprecated boolean attribute can be used instead of
the deprecation element. This is still supported in a deprecated fashion and should
NOTE
no longer be used. If no reason and replacement are available, an empty
deprecation object should be set.

Deprecation can also be specified declaratively in code by adding the

@DeprecatedConfigurationProperty annotation to the getter exposing the deprecated property. For
instance, assume that the my.app.target property was confusing and was renamed to my.app.name.
The following example shows how to handle that situation:

609
 import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;

@ConfigurationProperties("my.app")
public class MyProperties {

  private String name;

  public String getName() {

  return this.name;
  }

  public void setName(String name) {

  this.name = name;
  }

  @Deprecated
  @DeprecatedConfigurationProperty(replacement = "my.app.name")
  public String getTarget() {
  return this.name;
  }

  @Deprecated
  public void setTarget(String target) {
  this.name = target;
  }

There is no way to set a level. warning is always assumed, since code is still handling
NOTE
the property.

The preceding code makes sure that the deprecated property still works (delegating to the name
property behind the scenes). Once the getTarget and setTarget methods can be removed from your
public API, the automatic deprecation hint in the metadata goes away as well. If you want to keep a
hint, adding manual metadata with an error deprecation level ensures that users are still informed
about that property. Doing so is particularly useful when a replacement is provided.

B.1.3. Hint Attributes

The JSON object contained in the hints array can contain the attributes shown in the following
table:

610
Name Type Purpose
name String The full name of the property to which this hint refers. Names
are in lower-case period-separated form (such as
spring.mvc.servlet.path). If the property refers to a map (such as
system.contexts), the hint either applies to the keys of the map
(system.contexts.keys) or the values (system.contexts.values) of
the map. This attribute is mandatory.
values ValueHint[] A list of valid values as defined by the ValueHint object (described
in the next table). Each entry defines the value and may have a
description.
providers ValueProvider[ A list of providers as defined by the ValueProvider object
] (described later in this document). Each entry defines the name
of the provider and its parameters, if any.

The JSON object contained in the values attribute of each hint element can contain the attributes
described in the following table:

Name Type Purpose

value Object A valid value for the element to which the hint refers. If the type
of the property is an array, it can also be an array of value(s).
This attribute is mandatory.
description String A short description of the value that can be displayed to users. If
no description is available, it may be omitted. It is recommended
that descriptions be short paragraphs, with the first line
providing a concise summary. The last line in the description
should end with a period (.).

The JSON object contained in the providers attribute of each hint element can contain the attributes
described in the following table:

Name Type Purpose

name String The name of the provider to use to offer additional content
assistance for the element to which the hint refers.
parameters JSON object Any additional parameter that the provider supports (check the
documentation of the provider for more details).

B.1.4. Repeated Metadata Items

Objects with the same “property” and “group” name can appear multiple times within a metadata
file. For example, you could bind two separate classes to the same prefix, with each having
potentially overlapping property names. While the same names appearing in the metadata multiple
times should not be common, consumers of metadata should take care to ensure that they support
it.

611
B.2. Providing Manual Hints
To improve the user experience and further assist the user in configuring a given property, you can
provide additional metadata that:

• Describes the list of potential values for a property.

• Associates a provider, to attach a well defined semantic to a property, so that a tool can discover
the list of potential values based on the project’s context.

B.2.1. Value Hint

The name attribute of each hint refers to the name of a property. In the initial example shown earlier,
we provide five values for the spring.jpa.hibernate.ddl-auto property: none, validate, update,
create, and create-drop. Each value may have a description as well.

If your property is of type Map, you can provide hints for both the keys and the values (but not for
the map itself). The special .keys and .values suffixes must refer to the keys and the values,
respectively.

Assume a my.contexts maps magic String values to an integer, as shown in the following example:

import java.util.Map;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my")
public class MyProperties {

  private Map<String, Integer> contexts;

  public Map<String, Integer> getContexts() {

  return this.contexts;
  }

  public void setContexts(Map<String, Integer> contexts) {

  this.contexts = contexts;
  }

The magic values are (in this example) are sample1 and sample2. In order to offer additional content
assistance for the keys, you could add the following JSON to the manual metadata of the module:

612
 {"hints": [
  {
  "name": "my.contexts.keys",
  "values": [
  {
  "value": "sample1"
  },
  {
  "value": "sample2"
  }
  ]
  }
]}

We recommend that you use an Enum for those two values instead. If your IDE supports
TIP
it, this is by far the most effective approach to auto-completion.

B.2.2. Value Providers

Providers are a powerful way to attach semantics to a property. In this section, we define the
official providers that you can use for your own hints. However, your favorite IDE may implement
some of these or none of them. Also, it could eventually provide its own.

As this is a new feature, IDE vendors must catch up with how it works. Adoption
NOTE
times naturally vary.

The following table summarizes the list of supported providers:

Name Description
any Permits any additional value to be provided.
class-reference Auto-completes the classes available in the project. Usually
constrained by a base class that is specified by the target
parameter.
handle-as Handles the property as if it were defined by the type defined by
the mandatory target parameter.
logger-name Auto-completes valid logger names and logger groups. Typically,
package and class names available in the current project can be
auto-completed as well as defined groups.
spring-bean-reference Auto-completes the available bean names in the current project.
Usually constrained by a base class that is specified by the target
parameter.
spring-profile-name Auto-completes the available Spring profile names in the project.

613
 Only one provider can be active for a given property, but you can specify several
providers if they can all manage the property in some way. Make sure to place the
TIP most powerful provider first, as the IDE must use the first one in the JSON section that
it can handle. If no provider for a given property is supported, no special content
assistance is provided, either.

Any

The special any provider value permits any additional values to be provided. Regular value
validation based on the property type should be applied if this is supported.

This provider is typically used if you have a list of values and any extra values should still be
considered as valid.

The following example offers on and off as auto-completion values for system.state:

{"hints": [
  {
  "name": "system.state",
  "values": [
  {
  "value": "on"
  },
  {
  "value": "off"
  }
  ],
  "providers": [
  {
  "name": "any"
  }
  ]
  }
]}

Note that, in the preceding example, any other value is also allowed.

Class Reference

The class-reference provider auto-completes classes available in the project. This provider
supports the following parameters:

614
Parameter Type Default value Description
target String none The fully qualified name of the class that should
(Class) be assignable to the chosen value. Typically used
to filter out-non candidate classes. Note that this
information can be provided by the type itself by
exposing a class with the appropriate upper
bound.
concrete boolean true Specify whether only concrete classes are to be
considered as valid candidates.

The following metadata snippet corresponds to the standard server.servlet.jsp.class-name

property that defines the JspServlet class name to use:

{"hints": [
  {
  "name": "server.servlet.jsp.class-name",
  "providers": [
  {
  "name": "class-reference",
  "parameters": {
  "target": "jakarta.servlet.http.HttpServlet"
  }
  }
  ]
  }
]}

Handle As

The handle-as provider lets you substitute the type of the property to a more high-level type. This
typically happens when the property has a java.lang.String type, because you do not want your
configuration classes to rely on classes that may not be on the classpath. This provider supports the
following parameters:

Parameter Type Default value Description

target String none The fully qualified name of the type to consider
(Class) for the property. This parameter is mandatory.

The following types can be used:

• Any java.lang.Enum: Lists the possible values for the property. (We recommend defining the
property with the Enum type, as no further hint should be required for the IDE to auto-complete
the values)

• java.nio.charset.Charset: Supports auto-completion of charset/encoding values (such as UTF-8)

• java.util.Locale: auto-completion of locales (such as en_US)

• org.springframework.util.MimeType: Supports auto-completion of content type values (such as

615
 text/plain)

• org.springframework.core.io.Resource: Supports auto-completion of Spring’s Resource

abstraction to refer to a file on the filesystem or on the classpath (such as
classpath:/sample.properties)

If multiple values can be provided, use a Collection or Array type to teach the IDE
TIP
about it.

The following metadata snippet corresponds to the standard spring.liquibase.change-log property

that defines the path to the changelog to use. It is actually used internally as a
org.springframework.core.io.Resource but cannot be exposed as such, because we need to keep the
original String value to pass it to the Liquibase API.

{"hints": [
  {
  "name": "spring.liquibase.change-log",
  "providers": [
  {
  "name": "handle-as",
  "parameters": {
  "target": "org.springframework.core.io.Resource"
  }
  }
  ]
  }
]}

Logger Name

The logger-name provider auto-completes valid logger names and logger groups. Typically,
package and class names available in the current project can be auto-completed. If groups are
enabled (default) and if a custom logger group is identified in the configuration, auto-completion
for it should be provided. Specific frameworks may have extra magic logger names that can be
supported as well.

This provider supports the following parameters:

Parameter Type Default value Description

group boolean true Specify whether known groups should be
considered.

Since a logger name can be any arbitrary name, this provider should allow any value but could
highlight valid package and class names that are not available in the project’s classpath.

The following metadata snippet corresponds to the standard logging.level property. Keys are
logger names, and values correspond to the standard log levels or any custom level. As Spring Boot
defines a few logger groups out-of-the-box, dedicated value hints have been added for those.

616
{"hints": [
  {
  "name": "logging.level.keys",
  "values": [
  {
  "value": "root",
  "description": "Root logger used to assign the default logging level."
  },
  {
  "value": "sql",
  "description": "SQL logging group including Hibernate SQL logger."
  },
  {
  "value": "web",
  "description": "Web logging group including codecs."
  }
  ],
  "providers": [
  {
  "name": "logger-name"
  }
  ]
  },
  {
  "name": "logging.level.values",
  "values": [
  {
  "value": "trace"
  },
  {
  "value": "debug"
  },
  {
  "value": "info"
  },
  {
  "value": "warn"
  },
  {
  "value": "error"
  },
  {
  "value": "fatal"
  },
  {
  "value": "off"
  }

  ],
  "providers": [
  {

617
   "name": "any"
  }
  ]
  }
]}

Spring Bean Reference

The spring-bean-reference provider auto-completes the beans that are defined in the
configuration of the current project. This provider supports the following parameters:

Parameter Type Default value Description

target String none The fully qualified name of the bean class that
(Class) should be assignable to the candidate. Typically
used to filter out non-candidate beans.

The following metadata snippet corresponds to the standard spring.jmx.server property that
defines the name of the MBeanServer bean to use:

{"hints": [
  {
  "name": "spring.jmx.server",
  "providers": [
  {
  "name": "spring-bean-reference",
  "parameters": {
  "target": "javax.management.MBeanServer"
  }
  }
  ]
  }
]}

The binder is not aware of the metadata. If you provide that hint, you still need to
NOTE transform the bean name into an actual Bean reference using by the
ApplicationContext.

Spring Profile Name

The spring-profile-name provider auto-completes the Spring profiles that are defined in the
configuration of the current project.

The following metadata snippet corresponds to the standard spring.profiles.active property that
defines the name of the Spring profile(s) to enable:

618
 {"hints": [
  {
  "name": "spring.profiles.active",
  "providers": [
  {
  "name": "spring-profile-name"
  }
  ]
  }
]}

B.3. Generating Your Own Metadata by Using the

Annotation Processor
You can easily generate your own configuration metadata file from items annotated with
@ConfigurationProperties by using the spring-boot-configuration-processor jar. The jar includes a
Java annotation processor which is invoked as your project is compiled.

B.3.1. Configuring the Annotation Processor

To use the processor, include a dependency on spring-boot-configuration-processor.

With Maven the dependency should be declared as optional, as shown in the following example:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

With Gradle, the dependency should be declared in the annotationProcessor configuration, as

shown in the following example:

dependencies {
  annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
}

If you are using an additional-spring-configuration-metadata.json file, the compileJava task should

be configured to depend on the processResources task, as shown in the following example:

compileJava.inputs.files(processResources)

This dependency ensures that the additional metadata is available when the annotation processor
runs during compilation.

619
 If you are using AspectJ in your project, you need to make sure that the annotation
processor runs only once. There are several ways to do this. With Maven, you can
configure the maven-apt-plugin explicitly and add the dependency to the annotation
processor only there. You could also let the AspectJ plugin run all the processing
and disable annotation processing in the maven-compiler-plugin configuration, as
follows:

NOTE
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-compiler-plugin</artifactId>
  <configuration>
  <proc>none</proc>
  </configuration>
</plugin>

B.3.2. Automatic Metadata Generation

The processor picks up both classes and methods that are annotated with @ConfigurationProperties.

If the class is also annotated with @ConstructorBinding, a single constructor is expected and one
property is created per constructor parameter. Otherwise, properties are discovered through the
presence of standard getters and setters with special handling for collection and map types (that is
detected even if only a getter is present). The annotation processor also supports the use of the
@Data, @Value, @Getter, and @Setter lombok annotations.

Consider the following example:

620
 import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "my.server")
public class MyServerProperties {

  /**
  * Name of the server.
  */
  private String name;

  /**
  * IP address to listen to.
  */
  private String ip = "127.0.0.1";

  /**
  * Port to listener to.
  */
  private int port = 9797;

  public String getName() {

  return this.name;
  }

  public void setName(String name) {

  this.name = name;
  }

  public String getIp() {

  return this.ip;
  }

  public void setIp(String ip) {

  this.ip = ip;
  }

  public int getPort() {

  return this.port;
  }

  public void setPort(int port) {

  this.port = port;
  }
  // fold:off

This exposes three properties where my.server.name has no default and my.server.ip and
my.server.port defaults to "127.0.0.1" and 9797 respectively. The Javadoc on fields is used to

621
populate the description attribute. For instance, the description of my.server.ip is "IP address to
listen to.".

You should only use plain text with @ConfigurationProperties field Javadoc, since
NOTE
they are not processed before being added to the JSON.

The annotation processor applies a number of heuristics to extract the default value from the
source model. Default values have to be provided statically. In particular, do not refer to a constant
defined in another class. Also, the annotation processor cannot auto-detect default values for Enums
and Collectionss.

For cases where the default value could not be detected, manual metadata should be provided.
Consider the following example:

622
 import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "my.messaging")
public class MyMessagingProperties {

  private List<String> addresses = new ArrayList<>(Arrays.asList("a", "b"));

  private ContainerType containerType = ContainerType.SIMPLE;

  public List<String> getAddresses() {

  return this.addresses;
  }

  public void setAddresses(List<String> addresses) {

  this.addresses = addresses;
  }

  public ContainerType getContainerType() {

  return this.containerType;
  }

  public void setContainerType(ContainerType containerType) {

  this.containerType = containerType;
  }

  public enum ContainerType {

  SIMPLE, DIRECT

  }

In order to document default values for properties in the class above, you could add the following
content to the manual metadata of the module:

623
 {"properties": [
  {
  "name": "my.messaging.addresses",
  "defaultValue": ["a", "b"]
  },
  {
  "name": "my.messaging.container-type",
  "defaultValue": "simple"
  }
]}

Only the name of the property is required to document additional metadata for
NOTE
existing properties.

Nested Properties

The annotation processor automatically considers inner classes as nested properties. Rather than
documenting the ip and port at the root of the namespace, we could create a sub-namespace for it.
Consider the updated example:

624
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "my.server")
public class MyServerProperties {

  private String name;

  private Host host;

  public String getName() {

  return this.name;
  }

  public void setName(String name) {

  this.name = name;
  }

  public Host getHost() {

  return this.host;
  }

  public void setHost(Host host) {

  this.host = host;
  }

  public static class Host {

  private String ip;

  private int port;

  public String getIp() {

  return this.ip;
  }

  public void setIp(String ip) {

  this.ip = ip;
  }

  public int getPort() {

  return this.port;
  }

  public void setPort(int port) {

  this.port = port;
  }

  }

625
The preceding example produces metadata information for my.server.name, my.server.host.ip, and
my.server.host.port properties. You can use the @NestedConfigurationProperty annotation on a field
to indicate that a regular (non-inner) class should be treated as if it were nested.

This has no effect on collections and maps, as those types are automatically identified,
TIP
and a single metadata property is generated for each of them.

B.3.3. Adding Additional Metadata

Spring Boot’s configuration file handling is quite flexible, and it is often the case that properties
may exist that are not bound to a @ConfigurationProperties bean. You may also need to tune some
attributes of an existing key. To support such cases and let you provide custom "hints", the
annotation processor automatically merges items from META-INF/additional-spring-configuration-
metadata.json into the main metadata file.

If you refer to a property that has been detected automatically, the description, default value, and
deprecation information are overridden, if specified. If the manual property declaration is not
identified in the current module, it is added as a new property.

The format of the additional-spring-configuration-metadata.json file is exactly the same as the

regular spring-configuration-metadata.json. The additional properties file is optional. If you do not
have any additional properties, do not add the file.

626
Appendix C: Auto-configuration Classes
This appendix contains details of all of the auto-configuration classes provided by Spring Boot, with
links to documentation and source code. Remember to also look at the conditions report in your
application for more details of which features are switched on. (To do so, start the app with --debug
or -Ddebug or, in an Actuator application, use the conditions endpoint).

C.1. spring-boot-autoconfigure
The following auto-configuration classes are from the spring-boot-autoconfigure module:

Configuration Class Links

AopAutoConfiguration javadoc
ApplicationAvailabilityAutoConfiguration javadoc
ArtemisAutoConfiguration javadoc
BatchAutoConfiguration javadoc
CacheAutoConfiguration javadoc
CassandraAutoConfiguration javadoc
CassandraDataAutoConfiguration javadoc
CassandraReactiveDataAutoConfiguration javadoc
CassandraReactiveRepositoriesAutoConfiguration javadoc
CassandraRepositoriesAutoConfiguration javadoc
ClientHttpConnectorAutoConfiguration javadoc
CodecsAutoConfiguration javadoc
ConfigurationPropertiesAutoConfiguration javadoc
CouchbaseAutoConfiguration javadoc
CouchbaseDataAutoConfiguration javadoc
CouchbaseReactiveDataAutoConfiguration javadoc
CouchbaseReactiveRepositoriesAutoConfiguration javadoc
CouchbaseRepositoriesAutoConfiguration javadoc
DataSourceAutoConfiguration javadoc
DataSourceTransactionManagerAutoConfiguration javadoc
DispatcherServletAutoConfiguration javadoc
ElasticsearchDataAutoConfiguration javadoc
ElasticsearchRepositoriesAutoConfiguration javadoc
ElasticsearchRestClientAutoConfiguration javadoc
EmbeddedLdapAutoConfiguration javadoc

627
Configuration Class Links
EmbeddedMongoAutoConfiguration javadoc
EmbeddedWebServerFactoryCustomizerAutoConfiguration javadoc
ErrorMvcAutoConfiguration javadoc
ErrorWebFluxAutoConfiguration javadoc
FlywayAutoConfiguration javadoc
FreeMarkerAutoConfiguration javadoc
GroovyTemplateAutoConfiguration javadoc
GsonAutoConfiguration javadoc
HazelcastAutoConfiguration javadoc
HazelcastJpaDependencyAutoConfiguration javadoc
HibernateJpaAutoConfiguration javadoc
HttpEncodingAutoConfiguration javadoc
HttpHandlerAutoConfiguration javadoc
HttpMessageConvertersAutoConfiguration javadoc
HypermediaAutoConfiguration javadoc
InfluxDbAutoConfiguration javadoc
IntegrationAutoConfiguration javadoc
JacksonAutoConfiguration javadoc
JdbcRepositoriesAutoConfiguration javadoc
JdbcTemplateAutoConfiguration javadoc
JmsAutoConfiguration javadoc
JmxAutoConfiguration javadoc
JndiConnectionFactoryAutoConfiguration javadoc
JndiDataSourceAutoConfiguration javadoc
JooqAutoConfiguration javadoc
JpaRepositoriesAutoConfiguration javadoc
JsonbAutoConfiguration javadoc
JtaAutoConfiguration javadoc
KafkaAutoConfiguration javadoc
LdapAutoConfiguration javadoc
LdapRepositoriesAutoConfiguration javadoc
LifecycleAutoConfiguration javadoc
LiquibaseAutoConfiguration javadoc

628
Configuration Class Links
MailSenderAutoConfiguration javadoc
MailSenderValidatorAutoConfiguration javadoc
MessageSourceAutoConfiguration javadoc
MongoAutoConfiguration javadoc
MongoDataAutoConfiguration javadoc
MongoReactiveAutoConfiguration javadoc
MongoReactiveDataAutoConfiguration javadoc
MongoReactiveRepositoriesAutoConfiguration javadoc
MongoRepositoriesAutoConfiguration javadoc
MultipartAutoConfiguration javadoc
MustacheAutoConfiguration javadoc
Neo4jAutoConfiguration javadoc
Neo4jDataAutoConfiguration javadoc
Neo4jReactiveDataAutoConfiguration javadoc
Neo4jReactiveRepositoriesAutoConfiguration javadoc
Neo4jRepositoriesAutoConfiguration javadoc
NettyAutoConfiguration javadoc
OAuth2ClientAutoConfiguration javadoc
OAuth2ResourceServerAutoConfiguration javadoc
PersistenceExceptionTranslationAutoConfiguration javadoc
ProjectInfoAutoConfiguration javadoc
PropertyPlaceholderAutoConfiguration javadoc
QuartzAutoConfiguration javadoc
R2dbcAutoConfiguration javadoc
R2dbcDataAutoConfiguration javadoc
R2dbcRepositoriesAutoConfiguration javadoc
R2dbcTransactionManagerAutoConfiguration javadoc
RSocketMessagingAutoConfiguration javadoc
RSocketRequesterAutoConfiguration javadoc
RSocketSecurityAutoConfiguration javadoc
RSocketServerAutoConfiguration javadoc
RSocketStrategiesAutoConfiguration javadoc
RabbitAutoConfiguration javadoc

629
Configuration Class Links
ReactiveElasticsearchRepositoriesAutoConfiguration javadoc
ReactiveElasticsearchRestClientAutoConfiguration javadoc
ReactiveMultipartAutoConfiguration javadoc
ReactiveOAuth2ClientAutoConfiguration javadoc
ReactiveOAuth2ResourceServerAutoConfiguration javadoc
ReactiveSecurityAutoConfiguration javadoc
ReactiveUserDetailsServiceAutoConfiguration javadoc
ReactiveWebServerFactoryAutoConfiguration javadoc
RedisAutoConfiguration javadoc
RedisReactiveAutoConfiguration javadoc
RedisRepositoriesAutoConfiguration javadoc
RepositoryRestMvcAutoConfiguration javadoc
RestTemplateAutoConfiguration javadoc
Saml2RelyingPartyAutoConfiguration javadoc
SecurityAutoConfiguration javadoc
SecurityFilterAutoConfiguration javadoc
SendGridAutoConfiguration javadoc
ServletWebServerFactoryAutoConfiguration javadoc
SessionAutoConfiguration javadoc
SolrAutoConfiguration javadoc
SpringApplicationAdminJmxAutoConfiguration javadoc
SpringDataWebAutoConfiguration javadoc
SqlInitializationAutoConfiguration javadoc
TaskExecutionAutoConfiguration javadoc
TaskSchedulingAutoConfiguration javadoc
ThymeleafAutoConfiguration javadoc
TransactionAutoConfiguration javadoc
UserDetailsServiceAutoConfiguration javadoc
ValidationAutoConfiguration javadoc
WebClientAutoConfiguration javadoc
WebFluxAutoConfiguration javadoc
WebMvcAutoConfiguration javadoc
WebServiceTemplateAutoConfiguration javadoc

630
Configuration Class Links
WebServicesAutoConfiguration javadoc
WebSessionIdResolverAutoConfiguration javadoc
WebSocketMessagingAutoConfiguration javadoc
WebSocketReactiveAutoConfiguration javadoc
WebSocketServletAutoConfiguration javadoc
XADataSourceAutoConfiguration javadoc

C.2. spring-boot-actuator-autoconfigure
The following auto-configuration classes are from the spring-boot-actuator-autoconfigure module:

Configuration Class Links

AppOpticsMetricsExportAutoConfiguration javadoc
AtlasMetricsExportAutoConfiguration javadoc
AuditAutoConfiguration javadoc
AuditEventsEndpointAutoConfiguration javadoc
AvailabilityHealthContributorAutoConfiguration javadoc
AvailabilityProbesAutoConfiguration javadoc
BeansEndpointAutoConfiguration javadoc
CacheMetricsAutoConfiguration javadoc
CachesEndpointAutoConfiguration javadoc
CassandraHealthContributorAutoConfiguration javadoc
CassandraReactiveHealthContributorAutoConfiguration javadoc
CloudFoundryActuatorAutoConfiguration javadoc
CompositeMeterRegistryAutoConfiguration javadoc
ConditionsReportEndpointAutoConfiguration javadoc
ConfigurationPropertiesReportEndpointAutoConfiguration javadoc
ConnectionFactoryHealthContributorAutoConfiguration javadoc
ConnectionPoolMetricsAutoConfiguration javadoc
CouchbaseHealthContributorAutoConfiguration javadoc
CouchbaseReactiveHealthContributorAutoConfiguration javadoc
DataSourceHealthContributorAutoConfiguration javadoc
DataSourcePoolMetricsAutoConfiguration javadoc
DatadogMetricsExportAutoConfiguration javadoc
DiskSpaceHealthContributorAutoConfiguration javadoc

631
Configuration Class Links
DynatraceMetricsExportAutoConfiguration javadoc
ElasticMetricsExportAutoConfiguration javadoc
ElasticSearchReactiveHealthContributorAutoConfiguration javadoc
ElasticSearchRestHealthContributorAutoConfiguration javadoc
EndpointAutoConfiguration javadoc
EnvironmentEndpointAutoConfiguration javadoc
FlywayEndpointAutoConfiguration javadoc
GangliaMetricsExportAutoConfiguration javadoc
GraphiteMetricsExportAutoConfiguration javadoc
HazelcastHealthContributorAutoConfiguration javadoc
HealthContributorAutoConfiguration javadoc
HealthEndpointAutoConfiguration javadoc
HeapDumpWebEndpointAutoConfiguration javadoc
HttpClientMetricsAutoConfiguration javadoc
HttpTraceAutoConfiguration javadoc
HttpTraceEndpointAutoConfiguration javadoc
HumioMetricsExportAutoConfiguration javadoc
InfluxDbHealthContributorAutoConfiguration javadoc
InfluxMetricsExportAutoConfiguration javadoc
InfoContributorAutoConfiguration javadoc
InfoEndpointAutoConfiguration javadoc
IntegrationGraphEndpointAutoConfiguration javadoc
JettyMetricsAutoConfiguration javadoc
JmsHealthContributorAutoConfiguration javadoc
JmxEndpointAutoConfiguration javadoc
JmxMetricsExportAutoConfiguration javadoc
JvmMetricsAutoConfiguration javadoc
KafkaMetricsAutoConfiguration javadoc
KairosMetricsExportAutoConfiguration javadoc
LdapHealthContributorAutoConfiguration javadoc
LettuceMetricsAutoConfiguration javadoc
LiquibaseEndpointAutoConfiguration javadoc
Log4J2MetricsAutoConfiguration javadoc

632
Configuration Class Links
LogFileWebEndpointAutoConfiguration javadoc
LogbackMetricsAutoConfiguration javadoc
LoggersEndpointAutoConfiguration javadoc
MailHealthContributorAutoConfiguration javadoc
ManagementContextAutoConfiguration javadoc
ManagementWebSecurityAutoConfiguration javadoc
MappingsEndpointAutoConfiguration javadoc
MetricsAutoConfiguration javadoc
MetricsEndpointAutoConfiguration javadoc
MongoHealthContributorAutoConfiguration javadoc
MongoMetricsAutoConfiguration javadoc
MongoReactiveHealthContributorAutoConfiguration javadoc
Neo4jHealthContributorAutoConfiguration javadoc
NewRelicMetricsExportAutoConfiguration javadoc
PrometheusMetricsExportAutoConfiguration javadoc
QuartzEndpointAutoConfiguration javadoc
RabbitHealthContributorAutoConfiguration javadoc
RabbitMetricsAutoConfiguration javadoc
ReactiveCloudFoundryActuatorAutoConfiguration javadoc
ReactiveManagementContextAutoConfiguration javadoc
ReactiveManagementWebSecurityAutoConfiguration javadoc
RedisHealthContributorAutoConfiguration javadoc
RedisReactiveHealthContributorAutoConfiguration javadoc
RepositoryMetricsAutoConfiguration javadoc
ScheduledTasksEndpointAutoConfiguration javadoc
ServletManagementContextAutoConfiguration javadoc
SessionsEndpointAutoConfiguration javadoc
ShutdownEndpointAutoConfiguration javadoc
SignalFxMetricsExportAutoConfiguration javadoc
SimpleMetricsExportAutoConfiguration javadoc
SolrHealthContributorAutoConfiguration javadoc
StackdriverMetricsExportAutoConfiguration javadoc
StartupEndpointAutoConfiguration javadoc

633
Configuration Class Links
StartupTimeMetricsListenerAutoConfiguration javadoc
StatsdMetricsExportAutoConfiguration javadoc
SystemMetricsAutoConfiguration javadoc
TaskExecutorMetricsAutoConfiguration javadoc
ThreadDumpEndpointAutoConfiguration javadoc
TomcatMetricsAutoConfiguration javadoc
WavefrontMetricsExportAutoConfiguration javadoc
WebEndpointAutoConfiguration javadoc
WebFluxMetricsAutoConfiguration javadoc
WebMvcMetricsAutoConfiguration javadoc

634
Appendix D: Test Auto-configuration
Annotations
This appendix describes the @…Test auto-configuration annotations that Spring Boot provides to
test slices of your application.

D.1. Test Slices

The following table lists the various @…Test annotations that can be used to test slices of your
application and the auto-configuration that they import by default:

Test slice Imported auto-configuration

@DataCassandraTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.cassand
ra.CassandraAutoConfiguration
org.springframework.boot.autoconfigure.data.ca
ssandra.CassandraDataAutoConfiguration
org.springframework.boot.autoconfigure.data.ca
ssandra.CassandraReactiveDataAutoConfiguration
org.springframework.boot.autoconfigure.data.ca
ssandra.CassandraReactiveRepositoriesAutoConfi
guration
org.springframework.boot.autoconfigure.data.ca
ssandra.CassandraRepositoriesAutoConfiguration

@DataJdbcTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.data.jd
bc.JdbcRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.flyway.
FlywayAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Da
taSourceAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Da
taSourceTransactionManagerAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Jd
bcTemplateAutoConfiguration
org.springframework.boot.autoconfigure.liquiba
se.LiquibaseAutoConfiguration
org.springframework.boot.autoconfigure.sql.ini
t.SqlInitializationAutoConfiguration
org.springframework.boot.autoconfigure.transac
tion.TransactionAutoConfiguration
org.springframework.boot.test.autoconfigure.jd
bc.TestDatabaseAutoConfiguration

635
Test slice Imported auto-configuration
@DataJpaTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.data.jp
a.JpaRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.flyway.
FlywayAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Da
taSourceAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Da
taSourceTransactionManagerAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Jd
bcTemplateAutoConfiguration
org.springframework.boot.autoconfigure.liquiba
se.LiquibaseAutoConfiguration
org.springframework.boot.autoconfigure.orm.jpa
.HibernateJpaAutoConfiguration
org.springframework.boot.autoconfigure.sql.ini
t.SqlInitializationAutoConfiguration
org.springframework.boot.autoconfigure.transac
tion.TransactionAutoConfiguration
org.springframework.boot.test.autoconfigure.jd
bc.TestDatabaseAutoConfiguration
org.springframework.boot.test.autoconfigure.or
m.jpa.TestEntityManagerAutoConfiguration

@DataLdapTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.data.ld
ap.LdapRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.ldap.Ld
apAutoConfiguration
org.springframework.boot.autoconfigure.ldap.em
bedded.EmbeddedLdapAutoConfiguration

636
Test slice Imported auto-configuration
@DataMongoTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.data.mo
ngo.MongoDataAutoConfiguration
org.springframework.boot.autoconfigure.data.mo
ngo.MongoReactiveDataAutoConfiguration
org.springframework.boot.autoconfigure.data.mo
ngo.MongoReactiveRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.data.mo
ngo.MongoRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.mongo.M
ongoAutoConfiguration
org.springframework.boot.autoconfigure.mongo.M
ongoReactiveAutoConfiguration
org.springframework.boot.autoconfigure.mongo.e
mbedded.EmbeddedMongoAutoConfiguration
org.springframework.boot.autoconfigure.transac
tion.TransactionAutoConfiguration

@DataNeo4jTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.data.ne
o4j.Neo4jDataAutoConfiguration
org.springframework.boot.autoconfigure.data.ne
o4j.Neo4jReactiveDataAutoConfiguration
org.springframework.boot.autoconfigure.data.ne
o4j.Neo4jReactiveRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.data.ne
o4j.Neo4jRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.neo4j.N
eo4jAutoConfiguration
org.springframework.boot.autoconfigure.transac
tion.TransactionAutoConfiguration

@DataR2dbcTest org.springframework.boot.autoconfigure.data.r2
dbc.R2dbcDataAutoConfiguration
org.springframework.boot.autoconfigure.data.r2
dbc.R2dbcRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.flyway.
FlywayAutoConfiguration
org.springframework.boot.autoconfigure.liquiba
se.LiquibaseAutoConfiguration
org.springframework.boot.autoconfigure.r2dbc.R
2dbcAutoConfiguration
org.springframework.boot.autoconfigure.r2dbc.R
2dbcTransactionManagerAutoConfiguration
org.springframework.boot.autoconfigure.sql.ini
t.SqlInitializationAutoConfiguration
org.springframework.boot.autoconfigure.transac
tion.TransactionAutoConfiguration

637
Test slice Imported auto-configuration
@DataRedisTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.data.re
dis.RedisAutoConfiguration
org.springframework.boot.autoconfigure.data.re
dis.RedisReactiveAutoConfiguration
org.springframework.boot.autoconfigure.data.re
dis.RedisRepositoriesAutoConfiguration

@JdbcTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.flyway.
FlywayAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Da
taSourceAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Da
taSourceTransactionManagerAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Jd
bcTemplateAutoConfiguration
org.springframework.boot.autoconfigure.liquiba
se.LiquibaseAutoConfiguration
org.springframework.boot.autoconfigure.sql.ini
t.SqlInitializationAutoConfiguration
org.springframework.boot.autoconfigure.transac
tion.TransactionAutoConfiguration
org.springframework.boot.test.autoconfigure.jd
bc.TestDatabaseAutoConfiguration

@JooqTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.flyway.
FlywayAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Da
taSourceAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.Da
taSourceTransactionManagerAutoConfiguration
org.springframework.boot.autoconfigure.jooq.Jo
oqAutoConfiguration
org.springframework.boot.autoconfigure.liquiba
se.LiquibaseAutoConfiguration
org.springframework.boot.autoconfigure.sql.ini
t.SqlInitializationAutoConfiguration
org.springframework.boot.autoconfigure.transac
tion.TransactionAutoConfiguration

638
Test slice Imported auto-configuration
@JsonTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.gson.Gs
onAutoConfiguration
org.springframework.boot.autoconfigure.jackson
.JacksonAutoConfiguration
org.springframework.boot.autoconfigure.jsonb.J
sonbAutoConfiguration
org.springframework.boot.test.autoconfigure.js
on.JsonTestersAutoConfiguration

@RestClientTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.gson.Gs
onAutoConfiguration
org.springframework.boot.autoconfigure.http.Ht
tpMessageConvertersAutoConfiguration
org.springframework.boot.autoconfigure.http.co
dec.CodecsAutoConfiguration
org.springframework.boot.autoconfigure.jackson
.JacksonAutoConfiguration
org.springframework.boot.autoconfigure.jsonb.J
sonbAutoConfiguration
org.springframework.boot.autoconfigure.web.cli
ent.RestTemplateAutoConfiguration
org.springframework.boot.autoconfigure.web.rea
ctive.function.client.WebClientAutoConfigurati
on
org.springframework.boot.test.autoconfigure.we
b.client.MockRestServiceServerAutoConfiguratio
n
org.springframework.boot.test.autoconfigure.we
b.client.WebClientRestTemplateAutoConfiguratio
n

639
Test slice Imported auto-configuration
@WebFluxTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.context
.MessageSourceAutoConfiguration
org.springframework.boot.autoconfigure.freemar
ker.FreeMarkerAutoConfiguration
org.springframework.boot.autoconfigure.gson.Gs
onAutoConfiguration
org.springframework.boot.autoconfigure.http.co
dec.CodecsAutoConfiguration
org.springframework.boot.autoconfigure.jackson
.JacksonAutoConfiguration
org.springframework.boot.autoconfigure.jsonb.J
sonbAutoConfiguration
org.springframework.boot.autoconfigure.mustach
e.MustacheAutoConfiguration
org.springframework.boot.autoconfigure.securit
y.oauth2.client.reactive.ReactiveOAuth2ClientA
utoConfiguration
org.springframework.boot.autoconfigure.securit
y.oauth2.resource.reactive.ReactiveOAuth2Resou
rceServerAutoConfiguration
org.springframework.boot.autoconfigure.securit
y.reactive.ReactiveSecurityAutoConfiguration
org.springframework.boot.autoconfigure.securit
y.reactive.ReactiveUserDetailsServiceAutoConfi
guration
org.springframework.boot.autoconfigure.thymele
af.ThymeleafAutoConfiguration
org.springframework.boot.autoconfigure.validat
ion.ValidationAutoConfiguration
org.springframework.boot.autoconfigure.web.rea
ctive.WebFluxAutoConfiguration
org.springframework.boot.autoconfigure.web.rea
ctive.error.ErrorWebFluxAutoConfiguration
org.springframework.boot.test.autoconfigure.we
b.reactive.WebTestClientAutoConfiguration

640
Test slice Imported auto-configuration
@WebMvcTest org.springframework.boot.autoconfigure.cache.C
acheAutoConfiguration
org.springframework.boot.autoconfigure.context
.MessageSourceAutoConfiguration
org.springframework.boot.autoconfigure.data.we
b.SpringDataWebAutoConfiguration
org.springframework.boot.autoconfigure.freemar
ker.FreeMarkerAutoConfiguration
org.springframework.boot.autoconfigure.groovy.
template.GroovyTemplateAutoConfiguration
org.springframework.boot.autoconfigure.gson.Gs
onAutoConfiguration
org.springframework.boot.autoconfigure.hateoas
.HypermediaAutoConfiguration
org.springframework.boot.autoconfigure.http.Ht
tpMessageConvertersAutoConfiguration
org.springframework.boot.autoconfigure.jackson
.JacksonAutoConfiguration
org.springframework.boot.autoconfigure.jsonb.J
sonbAutoConfiguration
org.springframework.boot.autoconfigure.mustach
e.MustacheAutoConfiguration
org.springframework.boot.autoconfigure.securit
y.oauth2.client.servlet.OAuth2ClientAutoConfig
uration
org.springframework.boot.autoconfigure.securit
y.oauth2.resource.servlet.OAuth2ResourceServer
AutoConfiguration
org.springframework.boot.autoconfigure.securit
y.servlet.SecurityAutoConfiguration
org.springframework.boot.autoconfigure.securit
y.servlet.SecurityFilterAutoConfiguration
org.springframework.boot.autoconfigure.securit
y.servlet.UserDetailsServiceAutoConfiguration
org.springframework.boot.autoconfigure.task.Ta
skExecutionAutoConfiguration
org.springframework.boot.autoconfigure.thymele
af.ThymeleafAutoConfiguration
org.springframework.boot.autoconfigure.validat
ion.ValidationAutoConfiguration
org.springframework.boot.autoconfigure.web.ser
vlet.HttpEncodingAutoConfiguration
org.springframework.boot.autoconfigure.web.ser
vlet.WebMvcAutoConfiguration
org.springframework.boot.autoconfigure.web.ser
vlet.error.ErrorMvcAutoConfiguration
org.springframework.boot.test.autoconfigure.we
b.reactive.WebTestClientAutoConfiguration
org.springframework.boot.test.autoconfigure.we
b.servlet.MockMvcAutoConfiguration
org.springframework.boot.test.autoconfigure.we
b.servlet.MockMvcSecurityConfiguration
org.springframework.boot.test.autoconfigure.we
b.servlet.MockMvcWebClientAutoConfiguration 641
Test slice Imported auto-configuration
@WebServiceClientTest org.springframework.boot.test.autoconfigure.we
org.springframework.boot.autoconfigure.cache.C
b.servlet.MockMvcWebDriverAutoConfiguration
acheAutoConfiguration
org.springframework.boot.autoconfigure.webserv
ices.client.WebServiceTemplateAutoConfiguratio
n
org.springframework.boot.test.autoconfigure.we
bservices.client.MockWebServiceServerAutoConfi
guration
org.springframework.boot.test.autoconfigure.we
bservices.client.WebServiceClientTemplateAutoC
onfiguration

@WebServiceServerTest org.springframework.boot.autoconfigure.webserv
ices.WebServicesAutoConfiguration
org.springframework.boot.test.autoconfigure.we
bservices.server.MockWebServiceClientAutoConfi
guration

642
Appendix E: The Executable Jar Format
The spring-boot-loader modules lets Spring Boot support executable jar and war files. If you use the
Maven plugin or the Gradle plugin, executable jars are automatically generated, and you generally
do not need to know the details of how they work.

If you need to create executable jars from a different build system or if you are just curious about
the underlying technology, this appendix provides some background.

E.1. Nested JARs

Java does not provide any standard way to load nested jar files (that is, jar files that are themselves
contained within a jar). This can be problematic if you need to distribute a self-contained
application that can be run from the command line without unpacking.

To solve this problem, many developers use “shaded” jars. A shaded jar packages all classes, from
all jars, into a single “uber jar”. The problem with shaded jars is that it becomes hard to see which
libraries are actually in your application. It can also be problematic if the same filename is used
(but with different content) in multiple jars. Spring Boot takes a different approach and lets you
actually nest jars directly.

E.1.1. The Executable Jar File Structure

Spring Boot Loader-compatible jar files should be structured in the following way:

example.jar
 |
 +-META-INF
 | +-MANIFEST.MF
 +-org
 | +-springframework
 | +-boot
 | +-loader
 | +-<spring boot loader classes>
 +-BOOT-INF
  +-classes
  | +-mycompany
  | +-project
  | +-YourClasses.class
  +-lib
  +-dependency1.jar
  +-dependency2.jar

Application classes should be placed in a nested BOOT-INF/classes directory. Dependencies should

be placed in a nested BOOT-INF/lib directory.

643
E.1.2. The Executable War File Structure

Spring Boot Loader-compatible war files should be structured in the following way:

example.war
 |
 +-META-INF
 | +-MANIFEST.MF
 +-org
 | +-springframework
 | +-boot
 | +-loader
 | +-<spring boot loader classes>
 +-WEB-INF
  +-classes
  | +-com
  | +-mycompany
  | +-project
  | +-YourClasses.class
  +-lib
  | +-dependency1.jar
  | +-dependency2.jar
  +-lib-provided
  +-servlet-api.jar
  +-dependency3.jar

Dependencies should be placed in a nested WEB-INF/lib directory. Any dependencies that are
required when running embedded but are not required when deploying to a traditional web
container should be placed in WEB-INF/lib-provided.

E.1.3. Index Files

Spring Boot Loader-compatible jar and war archives can include additional index files under the
BOOT-INF/ directory. A classpath.idx file can be provided for both jars and wars, and it provides the
ordering that jars should be added to the classpath. The layers.idx file can be used only for jars,
and it allows a jar to be split into logical layers for Docker/OCI image creation.

Index files follow a YAML compatible syntax so that they can be easily parsed by third-party tools.
These files, however, are not parsed internally as YAML and they must be written in exactly the
formats described below in order to be used.

E.1.4. Classpath Index

The classpath index file can be provided in BOOT-INF/classpath.idx. It provides a list of jar names
(including the directory) in the order that they should be added to the classpath. Each line must
start with dash space ("-·") and names must be in double quotes.

For example, given the following jar:

644
 example.jar
 |
 +-META-INF
 | +-...
 +-BOOT-INF
  +-classes
  | +...
  +-lib
  +-dependency1.jar
  +-dependency2.jar

The index file would look like this:

- "BOOT-INF/lib/dependency2.jar"
- "BOOT-INF/lib/dependency1.jar"

E.1.5. Layer Index

The layers index file can be provided in BOOT-INF/layers.idx. It provides a list of layers and the
parts of the jar that should be contained within them. Layers are written in the order that they
should be added to the Docker/OCI image. Layers names are written as quoted strings prefixed with
dash space ("-·") and with a colon (":") suffix. Layer content is either a file or directory name
written as a quoted string prefixed by space space dash space ("··-·"). A directory name ends with
/, a file name does not. When a directory name is used it means that all files inside that directory
are in the same layer.

A typical example of a layers index would be:

- "dependencies":
  - "BOOT-INF/lib/dependency1.jar"
  - "BOOT-INF/lib/dependency2.jar"
- "application":
  - "BOOT-INF/classes/"
  - "META-INF/"

E.2. Spring Boot’s “JarFile” Class

The core class used to support loading nested jars is org.springframework.boot.loader.jar.JarFile.
It lets you load jar content from a standard jar file or from nested child jar data. When first loaded,
the location of each JarEntry is mapped to a physical file offset of the outer jar, as shown in the
following example:

645
 myapp.jar
+-------------------+-------------------------+
| /BOOT-INF/classes | /BOOT-INF/lib/mylib.jar |
|+-----------------+||+-----------+----------+|
|| A.class ||| B.class | C.class ||
|+-----------------+||+-----------+----------+|
+-------------------+-------------------------+
 ^ ^ ^
 0063 3452 3980

The preceding example shows how A.class can be found in /BOOT-INF/classes in myapp.jar at
position 0063. B.class from the nested jar can actually be found in myapp.jar at position 3452, and
C.class is at position 3980.

Armed with this information, we can load specific nested entries by seeking to the appropriate part
of the outer jar. We do not need to unpack the archive, and we do not need to read all entry data
into memory.

E.2.1. Compatibility with the Standard Java “JarFile”

Spring Boot Loader strives to remain compatible with existing code and libraries.
org.springframework.boot.loader.jar.JarFile extends from java.util.jar.JarFile and should work
as a drop-in replacement. The getURL() method returns a URL that opens a connection compatible
with java.net.JarURLConnection and can be used with Java’s URLClassLoader.

E.3. Launching Executable Jars

The org.springframework.boot.loader.Launcher class is a special bootstrap class that is used as an
executable jar’s main entry point. It is the actual Main-Class in your jar file, and it is used to setup
an appropriate URLClassLoader and ultimately call your main() method.

There are three launcher subclasses (JarLauncher, WarLauncher, and PropertiesLauncher). Their
purpose is to load resources (.class files and so on) from nested jar files or war files in directories
(as opposed to those explicitly on the classpath). In the case of JarLauncher and WarLauncher, the
nested paths are fixed. JarLauncher looks in BOOT-INF/lib/, and WarLauncher looks in WEB-INF/lib/
and WEB-INF/lib-provided/. You can add extra jars in those locations if you want more. The
PropertiesLauncher looks in BOOT-INF/lib/ in your application archive by default. You can add
additional locations by setting an environment variable called LOADER_PATH or loader.path in
loader.properties (which is a comma-separated list of directories, archives, or directories within
archives).

E.3.1. Launcher Manifest

You need to specify an appropriate Launcher as the Main-Class attribute of META-INF/MANIFEST.MF. The
actual class that you want to launch (that is, the class that contains a main method) should be
specified in the Start-Class attribute.

The following example shows a typical MANIFEST.MF for an executable jar file:

646
 Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.mycompany.project.MyApplication

For a war file, it would be as follows:

Main-Class: org.springframework.boot.loader.WarLauncher
Start-Class: com.mycompany.project.MyApplication

You need not specify Class-Path entries in your manifest file. The classpath is
NOTE
deduced from the nested jars.

E.4. PropertiesLauncher Features

PropertiesLauncher has a few special features that can be enabled with external properties (System
properties, environment variables, manifest entries, or loader.properties). The following table
describes these properties:

Key Purpose
loader.path Comma-separated Classpath, such as
lib,${HOME}/app/lib. Earlier entries take
precedence, like a regular -classpath on the
javac command line.
loader.home Used to resolve relative paths in loader.path. For
example, given loader.path=lib, then
${loader.home}/lib is a classpath location (along
with all jar files in that directory). This property
is also used to locate a loader.properties file, as
in the following example /opt/app It defaults to
${user.dir}.
loader.args Default arguments for the main method (space
separated).
loader.main Name of main class to launch (for example,
com.app.Application).
loader.config.name Name of properties file (for example, launcher).
It defaults to loader.
loader.config.location Path to properties file (for example,
classpath:loader.properties). It defaults to
loader.properties.
loader.system Boolean flag to indicate that all properties
should be added to System properties. It defaults
to false.

647
When specified as environment variables or manifest entries, the following names should be used:

Key Manifest entry Environment variable

loader.path Loader-Path LOADER_PATH
loader.home Loader-Home LOADER_HOME
loader.args Loader-Args LOADER_ARGS
loader.main Start-Class LOADER_MAIN
loader.config.location Loader-Config-Location LOADER_CONFIG_LOCATION
loader.system Loader-System LOADER_SYSTEM

Build plugins automatically move the Main-Class attribute to Start-Class when the fat
TIP jar is built. If you use that, specify the name of the class to launch by using the Main-
Class attribute and leaving out Start-Class.

The following rules apply to working with PropertiesLauncher:

• loader.properties is searched for in loader.home, then in the root of the classpath, and then in
classpath:/BOOT-INF/classes. The first location where a file with that name exists is used.

• loader.home is the directory location of an additional properties file (overriding the default) only
when loader.config.location is not specified.

• loader.path can contain directories (which are scanned recursively for jar and zip files), archive
paths, a directory within an archive that is scanned for jar files (for example,
dependencies.jar!/lib), or wildcard patterns (for the default JVM behavior). Archive paths can
be relative to loader.home or anywhere in the file system with a jar:file: prefix.

• loader.path (if empty) defaults to BOOT-INF/lib (meaning a local directory or a nested one if
running from an archive). Because of this, PropertiesLauncher behaves the same as JarLauncher
when no additional configuration is provided.

• loader.path can not be used to configure the location of loader.properties (the classpath used to
search for the latter is the JVM classpath when PropertiesLauncher is launched).

• Placeholder replacement is done from System and environment variables plus the properties
file itself on all values before use.

• The search order for properties (where it makes sense to look in more than one place) is
environment variables, system properties, loader.properties, the exploded archive manifest,
and the archive manifest.

E.5. Executable Jar Restrictions

You need to consider the following restrictions when working with a Spring Boot Loader packaged
application:

• Zip entry compression: The ZipEntry for a nested jar must be saved by using the ZipEntry.STORED
method. This is required so that we can seek directly to individual content within the nested jar.
The content of the nested jar file itself can still be compressed, as can any other entries in the
outer jar.

648
 • System classLoader: Launched applications should use Thread.getContextClassLoader() when
loading classes (most libraries and frameworks do so by default). Trying to load nested jar
classes with ClassLoader.getSystemClassLoader() fails. java.util.Logging always uses the system
classloader. For this reason, you should consider a different logging implementation.

E.6. Alternative Single Jar Solutions

If the preceding restrictions mean that you cannot use Spring Boot Loader, consider the following
alternatives:

• Maven Shade Plugin

• JarClassLoader

• OneJar

• Gradle Shadow Plugin

649
Appendix F: Dependency Versions
This appendix provides details of the dependencies that are managed by Spring Boot.

F.1. Managed Dependency Coordinates

The following table provides details of all of the dependency versions that are provided by Spring
Boot in its CLI (Command Line Interface), Maven dependency management, and Gradle plugin.
When you declare a dependency on one of these artifacts without declaring a version, the version
listed in the table is used.

Group ID Artifact ID Version

antlr antlr 2.7.7
ch.qos.logback logback-access 1.2.10
ch.qos.logback logback-classic 1.2.10
ch.qos.logback logback-core 1.2.10
com.couchbase.client java-client 3.2.4
com.datastax.oss java-driver-core 4.13.0
com.datastax.oss java-driver-core-shaded 4.13.0
com.datastax.oss java-driver-mapper-processor 4.13.0
com.datastax.oss java-driver-mapper-runtime 4.13.0
com.datastax.oss java-driver-metrics-micrometer 4.13.0
com.datastax.oss java-driver-metrics- 4.13.0
microprofile
com.datastax.oss java-driver-query-builder 4.13.0
com.datastax.oss java-driver-shaded-guava 25.1-jre-graal-sub-1
com.datastax.oss java-driver-test-infra 4.13.0
com.datastax.oss native-protocol 1.5.0
com.fasterxml classmate 1.5.1
com.fasterxml.jackson.core jackson-annotations 2.13.1
com.fasterxml.jackson.core jackson-core 2.13.1
com.fasterxml.jackson.core jackson-databind 2.13.1
com.fasterxml.jackson.dataform jackson-dataformat-avro 2.13.1
at
com.fasterxml.jackson.dataform jackson-dataformat-cbor 2.13.1
at
com.fasterxml.jackson.dataform jackson-dataformat-csv 2.13.1
at
com.fasterxml.jackson.dataform jackson-dataformat-ion 2.13.1
at
com.fasterxml.jackson.dataform jackson-dataformat-properties 2.13.1
at

650
Group ID Artifact ID Version
com.fasterxml.jackson.dataform jackson-dataformat-protobuf 2.13.1
at
com.fasterxml.jackson.dataform jackson-dataformat-smile 2.13.1
at
com.fasterxml.jackson.dataform jackson-dataformat-toml 2.13.1
at
com.fasterxml.jackson.dataform jackson-dataformat-xml 2.13.1
at
com.fasterxml.jackson.dataform jackson-dataformat-yaml 2.13.1
at
com.fasterxml.jackson.datatype jackson-datatype-eclipse- 2.13.1
collections
com.fasterxml.jackson.datatype jackson-datatype-guava 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-hibernate4 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-hibernate5 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-hibernate5- 2.13.1
jakarta
com.fasterxml.jackson.datatype jackson-datatype-hppc 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-jakarta-jsonp 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-jaxrs 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-jdk8 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-joda 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-joda-money 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-json-org 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-jsr310 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-jsr353 2.13.1
com.fasterxml.jackson.datatype jackson-datatype-pcollections 2.13.1
com.fasterxml.jackson.jakarta. jackson-jakarta-rs-base 2.13.1
rs
com.fasterxml.jackson.jakarta. jackson-jakarta-rs-cbor- 2.13.1
rs provider
com.fasterxml.jackson.jakarta. jackson-jakarta-rs-json- 2.13.1
rs provider
com.fasterxml.jackson.jakarta. jackson-jakarta-rs-smile- 2.13.1
rs provider
com.fasterxml.jackson.jakarta. jackson-jakarta-rs-xml- 2.13.1
rs provider
com.fasterxml.jackson.jakarta. jackson-jakarta-rs-yaml- 2.13.1
rs provider
com.fasterxml.jackson.jaxrs jackson-jaxrs-base 2.13.1
com.fasterxml.jackson.jaxrs jackson-jaxrs-cbor-provider 2.13.1
com.fasterxml.jackson.jaxrs jackson-jaxrs-json-provider 2.13.1

651
Group ID Artifact ID Version
com.fasterxml.jackson.jaxrs jackson-jaxrs-smile-provider 2.13.1
com.fasterxml.jackson.jaxrs jackson-jaxrs-xml-provider 2.13.1
com.fasterxml.jackson.jaxrs jackson-jaxrs-yaml-provider 2.13.1
com.fasterxml.jackson.jr jackson-jr-all 2.13.1
com.fasterxml.jackson.jr jackson-jr-annotation-support 2.13.1
com.fasterxml.jackson.jr jackson-jr-objects 2.13.1
com.fasterxml.jackson.jr jackson-jr-retrofit2 2.13.1
com.fasterxml.jackson.jr jackson-jr-stree 2.13.1
com.fasterxml.jackson.module jackson-module-afterburner 2.13.1
com.fasterxml.jackson.module jackson-module-blackbird 2.13.1
com.fasterxml.jackson.module jackson-module-guice 2.13.1
com.fasterxml.jackson.module jackson-module-jakarta- 2.13.1
xmlbind-annotations
com.fasterxml.jackson.module jackson-module-jaxb- 2.13.1
annotations
com.fasterxml.jackson.module jackson-module-jsonSchema 2.13.1
com.fasterxml.jackson.module jackson-module-kotlin 2.13.1
com.fasterxml.jackson.module jackson-module-mrbean 2.13.1
com.fasterxml.jackson.module jackson-module-no-ctor-deser 2.13.1
com.fasterxml.jackson.module jackson-module-osgi 2.13.1
com.fasterxml.jackson.module jackson-module-parameter-names 2.13.1
com.fasterxml.jackson.module jackson-module-paranamer 2.13.1
com.fasterxml.jackson.module jackson-module-scala_2.11 2.13.1
com.fasterxml.jackson.module jackson-module-scala_2.12 2.13.1
com.fasterxml.jackson.module jackson-module-scala_2.13 2.13.1
com.fasterxml.jackson.module jackson-module-scala_3 2.13.1
com.github.ben-manes.caffeine caffeine 3.0.5
com.github.ben-manes.caffeine guava 3.0.5
com.github.ben-manes.caffeine jcache 3.0.5
com.github.ben-manes.caffeine simulator 3.0.5
com.github.mxab.thymeleaf.extr thymeleaf-extras-data- 2.0.1
as attribute
com.google.appengine appengine-api-1.0-sdk 1.9.93
com.google.cloud cloud-spanner-r2dbc 1.1.0
com.google.code.gson gson 2.8.9
com.h2database h2 1.4.200
com.hazelcast hazelcast 5.0.2
com.hazelcast hazelcast-hibernate52 2.2.1
com.hazelcast hazelcast-hibernate53 2.2.1

652
Group ID Artifact ID Version
com.hazelcast hazelcast-spring 5.0.2
com.ibm.db2 jcc 11.5.7.0
com.jayway.jsonpath json-path 2.6.0
com.jayway.jsonpath json-path-assert 2.6.0
com.microsoft.sqlserver mssql-jdbc 9.4.1.jre8
com.oracle.database.ha ons 21.4.0.0.1
com.oracle.database.ha simplefan 21.4.0.0.1
com.oracle.database.jdbc ojdbc11 21.4.0.0.1
com.oracle.database.jdbc ojdbc11-production 21.4.0.0.1
com.oracle.database.jdbc ojdbc8 21.4.0.0.1
com.oracle.database.jdbc ojdbc8-production 21.4.0.0.1
com.oracle.database.jdbc rsi 21.4.0.0.1
com.oracle.database.jdbc ucp 21.4.0.0.1
com.oracle.database.jdbc ucp11 21.4.0.0.1
com.oracle.database.jdbc.debug ojdbc11-debug 21.4.0.0.1
com.oracle.database.jdbc.debug ojdbc11-observability-debug 21.4.0.0.1
com.oracle.database.jdbc.debug ojdbc11_g 21.4.0.0.1
com.oracle.database.jdbc.debug ojdbc11dms_g 21.4.0.0.1
com.oracle.database.jdbc.debug ojdbc8-debug 21.4.0.0.1
com.oracle.database.jdbc.debug ojdbc8-observability-debug 21.4.0.0.1
com.oracle.database.jdbc.debug ojdbc8_g 21.4.0.0.1
com.oracle.database.jdbc.debug ojdbc8dms_g 21.4.0.0.1
com.oracle.database.nls orai18n 21.4.0.0.1
com.oracle.database.observabil dms 21.4.0.0.1
ity
com.oracle.database.observabil ojdbc11-observability 21.4.0.0.1
ity
com.oracle.database.observabil ojdbc11dms 21.4.0.0.1
ity
com.oracle.database.observabil ojdbc8-observability 21.4.0.0.1
ity
com.oracle.database.observabil ojdbc8dms 21.4.0.0.1
ity
com.oracle.database.r2dbc oracle-r2dbc 0.1.0
com.oracle.database.security oraclepki 21.4.0.0.1
com.oracle.database.security osdt_cert 21.4.0.0.1
com.oracle.database.security osdt_core 21.4.0.0.1
com.oracle.database.xml xdb 21.4.0.0.1
com.oracle.database.xml xmlparserv2 21.4.0.0.1
com.querydsl querydsl-apt 5.0.0

653
Group ID Artifact ID Version
com.querydsl querydsl-codegen 5.0.0
com.querydsl querydsl-codegen-utils 5.0.0
com.querydsl querydsl-collections 5.0.0
com.querydsl querydsl-core 5.0.0
com.querydsl querydsl-guava 5.0.0
com.querydsl querydsl-hibernate-search 5.0.0
com.querydsl querydsl-jdo 5.0.0
com.querydsl querydsl-jpa 5.0.0
com.querydsl querydsl-jpa-codegen 5.0.0
com.querydsl querydsl-kotlin 5.0.0
com.querydsl querydsl-kotlin-codegen 5.0.0
com.querydsl querydsl-lucene3 5.0.0
com.querydsl querydsl-lucene4 5.0.0
com.querydsl querydsl-lucene5 5.0.0
com.querydsl querydsl-mongodb 5.0.0
com.querydsl querydsl-scala 5.0.0
com.querydsl querydsl-spatial 5.0.0
com.querydsl querydsl-sql 5.0.0
com.querydsl querydsl-sql-codegen 5.0.0
com.querydsl querydsl-sql-spatial 5.0.0
com.querydsl querydsl-sql-spring 5.0.0
com.rabbitmq amqp-client 5.14.1
com.rabbitmq stream-client 0.4.0
com.samskivert jmustache 1.15
com.sendgrid sendgrid-java 4.8.2
com.squareup.okhttp3 logging-interceptor 3.14.9
com.squareup.okhttp3 mockwebserver 3.14.9
com.squareup.okhttp3 okcurl 3.14.9
com.squareup.okhttp3 okhttp 3.14.9
com.squareup.okhttp3 okhttp-dnsoverhttps 3.14.9
com.squareup.okhttp3 okhttp-sse 3.14.9
com.squareup.okhttp3 okhttp-testing-support 3.14.9
com.squareup.okhttp3 okhttp-tls 3.14.9
com.squareup.okhttp3 okhttp-urlconnection 3.14.9
com.sun.activation jakarta.activation 2.0.1
com.sun.mail jakarta.mail 2.0.1
com.sun.xml.messaging.saaj saaj-impl 2.0.1
com.unboundid unboundid-ldapsdk 4.0.14

654
Group ID Artifact ID Version
com.zaxxer HikariCP 5.0.1
commons-codec commons-codec 1.15
commons-pool commons-pool 1.6
de.flapdoodle.embed de.flapdoodle.embed.mongo 3.2.8
dev.miku r2dbc-mysql 0.8.2.RELEASE
io.dropwizard.metrics metrics-annotation 4.2.7
io.dropwizard.metrics metrics-caffeine 4.2.7
io.dropwizard.metrics metrics-caffeine3 4.2.7
io.dropwizard.metrics metrics-collectd 4.2.7
io.dropwizard.metrics metrics-core 4.2.7
io.dropwizard.metrics metrics-ehcache 4.2.7
io.dropwizard.metrics metrics-graphite 4.2.7
io.dropwizard.metrics metrics-healthchecks 4.2.7
io.dropwizard.metrics metrics-httpasyncclient 4.2.7
io.dropwizard.metrics metrics-httpclient 4.2.7
io.dropwizard.metrics metrics-httpclient5 4.2.7
io.dropwizard.metrics metrics-jakarta-servlet 4.2.7
io.dropwizard.metrics metrics-jakarta-servlets 4.2.7
io.dropwizard.metrics metrics-jcache 4.2.7
io.dropwizard.metrics metrics-jdbi 4.2.7
io.dropwizard.metrics metrics-jdbi3 4.2.7
io.dropwizard.metrics metrics-jersey2 4.2.7
io.dropwizard.metrics metrics-jersey3 4.2.7
io.dropwizard.metrics metrics-jetty10 4.2.7
io.dropwizard.metrics metrics-jetty11 4.2.7
io.dropwizard.metrics metrics-jetty9 4.2.7
io.dropwizard.metrics metrics-jmx 4.2.7
io.dropwizard.metrics metrics-json 4.2.7
io.dropwizard.metrics metrics-jvm 4.2.7
io.dropwizard.metrics metrics-log4j2 4.2.7
io.dropwizard.metrics metrics-logback 4.2.7
io.dropwizard.metrics metrics-servlet 4.2.7
io.dropwizard.metrics metrics-servlets 4.2.7
io.lettuce lettuce-core 6.1.6.RELEASE
io.micrometer micrometer-core 2.0.0-M1
io.micrometer micrometer-registry-appoptics 2.0.0-M1
io.micrometer micrometer-registry-atlas 2.0.0-M1
io.micrometer micrometer-registry-azure- 2.0.0-M1
monitor

655
Group ID Artifact ID Version
io.micrometer micrometer-registry-cloudwatch 2.0.0-M1
io.micrometer micrometer-registry- 2.0.0-M1
cloudwatch2
io.micrometer micrometer-registry-datadog 2.0.0-M1
io.micrometer micrometer-registry-dynatrace 2.0.0-M1
io.micrometer micrometer-registry-elastic 2.0.0-M1
io.micrometer micrometer-registry-ganglia 2.0.0-M1
io.micrometer micrometer-registry-graphite 2.0.0-M1
io.micrometer micrometer-registry-health 2.0.0-M1
io.micrometer micrometer-registry-humio 2.0.0-M1
io.micrometer micrometer-registry-influx 2.0.0-M1
io.micrometer micrometer-registry-jmx 2.0.0-M1
io.micrometer micrometer-registry-kairos 2.0.0-M1
io.micrometer micrometer-registry-new-relic 2.0.0-M1
io.micrometer micrometer-registry-opentsdb 2.0.0-M1
io.micrometer micrometer-registry-prometheus 2.0.0-M1
io.micrometer micrometer-registry-signalfx 2.0.0-M1
io.micrometer micrometer-registry- 2.0.0-M1
stackdriver
io.micrometer micrometer-registry-statsd 2.0.0-M1
io.micrometer micrometer-registry-wavefront 2.0.0-M1
io.micrometer micrometer-test 2.0.0-M1
io.netty netty-all 4.1.73.Final
io.netty netty-buffer 4.1.73.Final
io.netty netty-codec 4.1.73.Final
io.netty netty-codec-dns 4.1.73.Final
io.netty netty-codec-haproxy 4.1.73.Final
io.netty netty-codec-http 4.1.73.Final
io.netty netty-codec-http2 4.1.73.Final
io.netty netty-codec-memcache 4.1.73.Final
io.netty netty-codec-mqtt 4.1.73.Final
io.netty netty-codec-redis 4.1.73.Final
io.netty netty-codec-smtp 4.1.73.Final
io.netty netty-codec-socks 4.1.73.Final
io.netty netty-codec-stomp 4.1.73.Final
io.netty netty-codec-xml 4.1.73.Final
io.netty netty-common 4.1.73.Final
io.netty netty-dev-tools 4.1.73.Final
io.netty netty-example 4.1.73.Final

656
Group ID Artifact ID Version
io.netty netty-handler 4.1.73.Final
io.netty netty-handler-proxy 4.1.73.Final
io.netty netty-resolver 4.1.73.Final
io.netty netty-resolver-dns 4.1.73.Final
io.netty netty-resolver-dns-classes- 4.1.73.Final
macos
io.netty netty-resolver-dns-native- 4.1.73.Final
macos
io.netty netty-tcnative 2.0.46.Final
io.netty netty-tcnative-boringssl- 2.0.46.Final
static
io.netty netty-tcnative-classes 2.0.46.Final
io.netty netty-transport 4.1.73.Final
io.netty netty-transport-classes-epoll 4.1.73.Final
io.netty netty-transport-classes-kqueue 4.1.73.Final
io.netty netty-transport-native-epoll 4.1.73.Final
io.netty netty-transport-native-kqueue 4.1.73.Final
io.netty netty-transport-native-unix- 4.1.73.Final
common
io.netty netty-transport-rxtx 4.1.73.Final
io.netty netty-transport-sctp 4.1.73.Final
io.netty netty-transport-udt 4.1.73.Final
io.projectreactor reactor-core 3.4.14
io.projectreactor reactor-test 3.4.14
io.projectreactor reactor-tools 3.4.14
io.projectreactor.addons reactor-adapter 3.4.6
io.projectreactor.addons reactor-extra 3.4.6
io.projectreactor.addons reactor-pool 0.2.7
io.projectreactor.kafka reactor-kafka 1.3.9
io.projectreactor.kotlin reactor-kotlin-extensions 1.1.5
io.projectreactor.netty reactor-netty 1.0.15
io.projectreactor.netty reactor-netty-core 1.0.15
io.projectreactor.netty reactor-netty-http 1.0.15
io.projectreactor.netty reactor-netty-http-brave 1.0.15
io.projectreactor.rabbitmq reactor-rabbitmq 1.5.4
io.prometheus simpleclient 0.14.1
io.prometheus simpleclient_caffeine 0.14.1
io.prometheus simpleclient_common 0.14.1
io.prometheus simpleclient_dropwizard 0.14.1
io.prometheus simpleclient_graphite_bridge 0.14.1

657
Group ID Artifact ID Version
io.prometheus simpleclient_guava 0.14.1
io.prometheus simpleclient_hibernate 0.14.1
io.prometheus simpleclient_hotspot 0.14.1
io.prometheus simpleclient_httpserver 0.14.1
io.prometheus simpleclient_jetty 0.14.1
io.prometheus simpleclient_jetty_jdk8 0.14.1
io.prometheus simpleclient_log4j 0.14.1
io.prometheus simpleclient_log4j2 0.14.1
io.prometheus simpleclient_logback 0.14.1
io.prometheus simpleclient_pushgateway 0.14.1
io.prometheus simpleclient_servlet 0.14.1
io.prometheus simpleclient_servlet_jakarta 0.14.1
io.prometheus simpleclient_spring_boot 0.14.1
io.prometheus simpleclient_spring_web 0.14.1
io.prometheus simpleclient_tracer_otel 0.14.1
io.prometheus simpleclient_tracer_otel_agent 0.14.1
io.prometheus simpleclient_vertx 0.14.1
io.r2dbc r2dbc-h2 0.8.5.RELEASE
io.r2dbc r2dbc-mssql 0.8.8.RELEASE
io.r2dbc r2dbc-pool 0.8.8.RELEASE
io.r2dbc r2dbc-postgresql 0.8.11.RELEASE
io.r2dbc r2dbc-proxy 0.8.8.RELEASE
io.r2dbc r2dbc-spi 0.8.6.RELEASE
io.reactivex rxjava 1.3.8
io.reactivex rxjava-reactive-streams 1.2.1
io.reactivex.rxjava2 rxjava 2.2.21
io.rest-assured json-path 4.5.0
io.rest-assured json-schema-validator 4.5.0
io.rest-assured rest-assured 4.5.0
io.rest-assured scala-support 4.5.0
io.rest-assured spring-mock-mvc 4.5.0
io.rest-assured spring-web-test-client 4.5.0
io.rest-assured xml-path 4.5.0
io.rsocket rsocket-core 1.1.1
io.rsocket rsocket-load-balancer 1.1.1
io.rsocket rsocket-micrometer 1.1.1
io.rsocket rsocket-test 1.1.1
io.rsocket rsocket-transport-local 1.1.1

658
Group ID Artifact ID Version
io.rsocket rsocket-transport-netty 1.1.1
io.spring.gradle dependency-management-plugin 1.0.11.RELEASE
io.undertow undertow-core 2.2.14.Final
io.undertow undertow-servlet-jakarta 2.2.14.Final
io.undertow undertow-websockets-jsr- 2.2.14.Final
jakarta
jakarta.activation jakarta.activation-api 2.0.1
jakarta.annotation jakarta.annotation-api 2.0.0
jakarta.jms jakarta.jms-api 3.0.0
jakarta.json jakarta.json-api 2.0.1
jakarta.json.bind jakarta.json.bind-api 2.0.0
jakarta.mail jakarta.mail-api 2.0.1
jakarta.management.j2ee jakarta.management.j2ee-api 1.1.4
jakarta.persistence jakarta.persistence-api 3.0.0
jakarta.servlet jakarta.servlet-api 5.0.0
jakarta.servlet.jsp.jstl jakarta.servlet.jsp.jstl-api 2.0.0
jakarta.transaction jakarta.transaction-api 2.0.0
jakarta.validation jakarta.validation-api 3.0.1
jakarta.websocket jakarta.websocket-api 2.0.0
jakarta.ws.rs jakarta.ws.rs-api 3.0.0
jakarta.xml.bind jakarta.xml.bind-api 3.0.1
jakarta.xml.soap jakarta.xml.soap-api 2.0.1
jakarta.xml.ws jakarta.xml.ws-api 3.0.1
javax.cache cache-api 1.1.1
javax.money money-api 1.1
javax.servlet javax.servlet-api 4.0.1
javax.servlet jstl 1.2
jaxen jaxen 1.2.0
junit junit 4.13.2
mysql mysql-connector-java 8.0.28
net.bytebuddy byte-buddy 1.12.7
net.bytebuddy byte-buddy-agent 1.12.7
net.minidev json-smart 2.4.7
net.sourceforge.htmlunit htmlunit 2.56.0
net.sourceforge.jtds jtds 1.3.1
net.sourceforge.nekohtml nekohtml 1.9.22
nz.net.ultraq.thymeleaf thymeleaf-layout-dialect 3.0.0
org.apache.activemq artemis-amqp-protocol 2.20.0
org.apache.activemq artemis-commons 2.20.0

659
Group ID Artifact ID Version
org.apache.activemq artemis-core-client 2.20.0
org.apache.activemq artemis-jakarta-client 2.20.0
org.apache.activemq artemis-jakarta-server 2.20.0
org.apache.activemq artemis-journal 2.20.0
org.apache.activemq artemis-selector 2.20.0
org.apache.activemq artemis-server 2.20.0
org.apache.activemq artemis-service-extensions 2.20.0
org.apache.commons commons-dbcp2 2.9.0
org.apache.commons commons-lang3 3.12.0
org.apache.commons commons-pool2 2.11.1
org.apache.derby derby 10.15.2.0
org.apache.derby derbyclient 10.15.2.0
org.apache.derby derbyshared 10.15.2.0
org.apache.derby derbytools 10.15.2.0
org.apache.httpcomponents fluent-hc 4.5.13
org.apache.httpcomponents httpasyncclient 4.1.5
org.apache.httpcomponents httpclient 4.5.13
org.apache.httpcomponents httpclient-cache 4.5.13
org.apache.httpcomponents httpclient-osgi 4.5.13
org.apache.httpcomponents httpclient-win 4.5.13
org.apache.httpcomponents httpcore 4.4.15
org.apache.httpcomponents httpcore-nio 4.4.15
org.apache.httpcomponents httpmime 4.5.13
org.apache.httpcomponents.clie httpclient5 5.1.2
nt5
org.apache.httpcomponents.clie httpclient5-cache 5.1.2
nt5
org.apache.httpcomponents.clie httpclient5-fluent 5.1.2
nt5
org.apache.httpcomponents.clie httpclient5-win 5.1.2
nt5
org.apache.httpcomponents.core httpcore5 5.1.3
5
org.apache.httpcomponents.core httpcore5-h2 5.1.3
5
org.apache.httpcomponents.core httpcore5-reactive 5.1.3
5
org.apache.kafka connect-api 3.0.0
org.apache.kafka connect-basic-auth-extension 3.0.0
org.apache.kafka connect-file 3.0.0
org.apache.kafka connect-json 3.0.0

660
Group ID Artifact ID Version
org.apache.kafka connect-runtime 3.0.0
org.apache.kafka connect-transforms 3.0.0
org.apache.kafka kafka-clients 3.0.0
org.apache.kafka kafka-log4j-appender 3.0.0
org.apache.kafka kafka-metadata 3.0.0
org.apache.kafka kafka-streams 3.0.0
org.apache.kafka kafka-streams-scala_2.12 3.0.0
org.apache.kafka kafka-streams-scala_2.13 3.0.0
org.apache.kafka kafka-streams-test-utils 3.0.0
org.apache.kafka kafka-tools 3.0.0
org.apache.kafka kafka_2.12 3.0.0
org.apache.kafka kafka_2.13 3.0.0
org.apache.logging.log4j log4j-1.2-api 2.17.1
org.apache.logging.log4j log4j-api 2.17.1
org.apache.logging.log4j log4j-appserver 2.17.1
org.apache.logging.log4j log4j-cassandra 2.17.1
org.apache.logging.log4j log4j-core 2.17.1
org.apache.logging.log4j log4j-couchdb 2.17.1
org.apache.logging.log4j log4j-docker 2.17.1
org.apache.logging.log4j log4j-flume-ng 2.17.1
org.apache.logging.log4j log4j-iostreams 2.17.1
org.apache.logging.log4j log4j-jcl 2.17.1
org.apache.logging.log4j log4j-jmx-gui 2.17.1
org.apache.logging.log4j log4j-jpa 2.17.1
org.apache.logging.log4j log4j-jpl 2.17.1
org.apache.logging.log4j log4j-jul 2.17.1
org.apache.logging.log4j log4j-kubernetes 2.17.1
org.apache.logging.log4j log4j-layout-template-json 2.17.1
org.apache.logging.log4j log4j-liquibase 2.17.1
org.apache.logging.log4j log4j-mongodb3 2.17.1
org.apache.logging.log4j log4j-mongodb4 2.17.1
org.apache.logging.log4j log4j-slf4j-impl 2.17.1
org.apache.logging.log4j log4j-slf4j18-impl 2.17.1
org.apache.logging.log4j log4j-spring-boot 2.17.1
org.apache.logging.log4j log4j-spring-cloud-config- 2.17.1
client
org.apache.logging.log4j log4j-taglib 2.17.1
org.apache.logging.log4j log4j-to-slf4j 2.17.1
org.apache.logging.log4j log4j-web 2.17.1

661
Group ID Artifact ID Version
org.apache.solr solr-analysis-extras 8.11.1
org.apache.solr solr-analytics 8.11.1
org.apache.solr solr-cell 8.11.1
org.apache.solr solr-core 8.11.1
org.apache.solr solr-dataimporthandler 8.11.1
org.apache.solr solr-dataimporthandler-extras 8.11.1
org.apache.solr solr-gcs-repository 8.11.1
org.apache.solr solr-jaegertracer-configurator 8.11.1
org.apache.solr solr-langid 8.11.1
org.apache.solr solr-ltr 8.11.1
org.apache.solr solr-prometheus-exporter 8.11.1
org.apache.solr solr-s3-repository 8.11.1
org.apache.solr solr-solrj 8.11.1
org.apache.solr solr-test-framework 8.11.1
org.apache.solr solr-velocity 8.11.1
org.apache.tomcat tomcat-annotations-api 10.0.16
org.apache.tomcat tomcat-jdbc 10.0.16
org.apache.tomcat tomcat-jsp-api 10.0.16
org.apache.tomcat.embed tomcat-embed-core 10.0.16
org.apache.tomcat.embed tomcat-embed-el 10.0.16
org.apache.tomcat.embed tomcat-embed-jasper 10.0.16
org.apache.tomcat.embed tomcat-embed-websocket 10.0.16
org.aspectj aspectjrt 1.9.7
org.aspectj aspectjtools 1.9.7
org.aspectj aspectjweaver 1.9.7
org.assertj assertj-core 3.22.0
org.awaitility awaitility 4.1.1
org.awaitility awaitility-groovy 4.1.1
org.awaitility awaitility-kotlin 4.1.1
org.awaitility awaitility-scala 4.1.1
org.codehaus.groovy groovy 3.0.9
org.codehaus.groovy groovy-ant 3.0.9
org.codehaus.groovy groovy-astbuilder 3.0.9
org.codehaus.groovy groovy-bsf 3.0.9
org.codehaus.groovy groovy-cli-commons 3.0.9
org.codehaus.groovy groovy-cli-picocli 3.0.9
org.codehaus.groovy groovy-console 3.0.9
org.codehaus.groovy groovy-datetime 3.0.9

662
Group ID Artifact ID Version
org.codehaus.groovy groovy-dateutil 3.0.9
org.codehaus.groovy groovy-docgenerator 3.0.9
org.codehaus.groovy groovy-groovydoc 3.0.9
org.codehaus.groovy groovy-groovysh 3.0.9
org.codehaus.groovy groovy-jaxb 3.0.9
org.codehaus.groovy groovy-jmx 3.0.9
org.codehaus.groovy groovy-json 3.0.9
org.codehaus.groovy groovy-jsr223 3.0.9
org.codehaus.groovy groovy-macro 3.0.9
org.codehaus.groovy groovy-nio 3.0.9
org.codehaus.groovy groovy-servlet 3.0.9
org.codehaus.groovy groovy-sql 3.0.9
org.codehaus.groovy groovy-swing 3.0.9
org.codehaus.groovy groovy-templates 3.0.9
org.codehaus.groovy groovy-test 3.0.9
org.codehaus.groovy groovy-test-junit5 3.0.9
org.codehaus.groovy groovy-testng 3.0.9
org.codehaus.groovy groovy-xml 3.0.9
org.codehaus.groovy groovy-yaml 3.0.9
org.codehaus.janino commons-compiler 3.1.6
org.codehaus.janino commons-compiler-jdk 3.1.6
org.codehaus.janino janino 3.1.6
org.eclipse yasson 2.0.4
org.eclipse.jetty apache-jsp 11.0.7
org.eclipse.jetty glassfish-jstl 11.0.7
org.eclipse.jetty infinispan-common 11.0.7
org.eclipse.jetty infinispan-embedded-query 11.0.7
org.eclipse.jetty infinispan-remote-query 11.0.7
org.eclipse.jetty jetty-alpn-client 11.0.7
org.eclipse.jetty jetty-alpn-conscrypt-client 11.0.7
org.eclipse.jetty jetty-alpn-conscrypt-server 11.0.7
org.eclipse.jetty jetty-alpn-java-client 11.0.7
org.eclipse.jetty jetty-alpn-java-server 11.0.7
org.eclipse.jetty jetty-alpn-server 11.0.7
org.eclipse.jetty jetty-annotations 11.0.7
org.eclipse.jetty jetty-ant 11.0.7
org.eclipse.jetty jetty-cdi 10.0.3-SNAPSHOT
org.eclipse.jetty jetty-client 11.0.7

663
Group ID Artifact ID Version
org.eclipse.jetty jetty-deploy 11.0.7
org.eclipse.jetty jetty-hazelcast 11.0.7
org.eclipse.jetty jetty-home 11.0.7
org.eclipse.jetty jetty-http 11.0.7
org.eclipse.jetty jetty-http-spi 11.0.7
org.eclipse.jetty jetty-io 11.0.7
org.eclipse.jetty jetty-jaas 11.0.7
org.eclipse.jetty jetty-jaspi 11.0.7
org.eclipse.jetty jetty-jmx 11.0.7
org.eclipse.jetty jetty-jndi 11.0.7
org.eclipse.jetty jetty-nosql 11.0.7
org.eclipse.jetty jetty-openid 11.0.7
org.eclipse.jetty jetty-plus 11.0.7
org.eclipse.jetty jetty-proxy 11.0.7
org.eclipse.jetty jetty-quickstart 11.0.7
org.eclipse.jetty jetty-reactive-httpclient 3.0.4
org.eclipse.jetty jetty-rewrite 11.0.7
org.eclipse.jetty jetty-security 11.0.7
org.eclipse.jetty jetty-server 11.0.7
org.eclipse.jetty jetty-servlet 11.0.7
org.eclipse.jetty jetty-servlets 11.0.7
org.eclipse.jetty jetty-unixsocket-client 11.0.7
org.eclipse.jetty jetty-unixsocket-common 11.0.7
org.eclipse.jetty jetty-unixsocket-server 11.0.7
org.eclipse.jetty jetty-util 11.0.7
org.eclipse.jetty jetty-util-ajax 11.0.7
org.eclipse.jetty jetty-webapp 11.0.7
org.eclipse.jetty jetty-xml 11.0.7
org.eclipse.jetty.fcgi fcgi-client 11.0.7
org.eclipse.jetty.fcgi fcgi-server 11.0.7
org.eclipse.jetty.gcloud jetty-gcloud-session-manager 11.0.7
org.eclipse.jetty.http2 http2-client 11.0.7
org.eclipse.jetty.http2 http2-common 11.0.7
org.eclipse.jetty.http2 http2-hpack 11.0.7
org.eclipse.jetty.http2 http2-http-client-transport 11.0.7
org.eclipse.jetty.http2 http2-server 11.0.7
org.eclipse.jetty.memcached jetty-memcached-sessions 11.0.7
org.eclipse.jetty.osgi jetty-httpservice 11.0.7

664
Group ID Artifact ID Version
org.eclipse.jetty.osgi jetty-osgi-boot 11.0.7
org.eclipse.jetty.osgi jetty-osgi-boot-jsp 11.0.7
org.eclipse.jetty.osgi jetty-osgi-boot-warurl 11.0.7
org.eclipse.jetty.websocket websocket-core-client 11.0.7
org.eclipse.jetty.websocket websocket-core-common 11.0.7
org.eclipse.jetty.websocket websocket-core-server 11.0.7
org.eclipse.jetty.websocket websocket-jakarta-client 11.0.7
org.eclipse.jetty.websocket websocket-jakarta-common 11.0.7
org.eclipse.jetty.websocket websocket-jakarta-server 11.0.7
org.eclipse.jetty.websocket websocket-jetty-api 11.0.7
org.eclipse.jetty.websocket websocket-jetty-client 11.0.7
org.eclipse.jetty.websocket websocket-jetty-common 11.0.7
org.eclipse.jetty.websocket websocket-jetty-server 11.0.7
org.eclipse.jetty.websocket websocket-servlet 11.0.7
org.elasticsearch elasticsearch 7.16.2
org.elasticsearch.client elasticsearch-rest-client 7.16.2
org.elasticsearch.client elasticsearch-rest-client- 7.16.2
sniffer
org.elasticsearch.client elasticsearch-rest-high-level- 7.16.2
client
org.elasticsearch.client transport 7.16.2
org.elasticsearch.distribution elasticsearch 7.16.2
.integ-test-zip
org.elasticsearch.plugin transport-netty4-client 7.16.2
org.firebirdsql.jdbc jaybird 4.0.5.java8
org.firebirdsql.jdbc jaybird-jdk18 4.0.5.java8
org.flywaydb flyway-core 8.4.2
org.flywaydb flyway-firebird 8.4.2
org.flywaydb flyway-mysql 8.4.2
org.flywaydb flyway-sqlserver 8.4.2
org.freemarker freemarker 2.3.31
org.glassfish jakarta.el 4.0.2
org.glassfish.jaxb codemodel 3.0.2
org.glassfish.jaxb codemodel-annotation-compiler 3.0.2
org.glassfish.jaxb jaxb-jxc 3.0.2
org.glassfish.jaxb jaxb-runtime 3.0.2
org.glassfish.jaxb jaxb-xjc 3.0.2
org.glassfish.jaxb txw2 3.0.2
org.glassfish.jaxb txwc2 3.0.2

665
Group ID Artifact ID Version
org.glassfish.jaxb xsom 3.0.2
org.glassfish.web jakarta.servlet.jsp.jstl 2.0.0
org.hamcrest hamcrest 2.2
org.hamcrest hamcrest-core 2.2
org.hamcrest hamcrest-library 2.2
org.hibernate hibernate-c3p0 5.6.4.Final
org.hibernate hibernate-core-jakarta 5.6.4.Final
org.hibernate hibernate-ehcache 5.6.4.Final
org.hibernate hibernate-entitymanager 5.6.4.Final
org.hibernate hibernate-envers-jakarta 5.6.4.Final
org.hibernate hibernate-hikaricp 5.6.4.Final
org.hibernate hibernate-java8 5.6.4.Final
org.hibernate hibernate-jcache 5.6.4.Final
org.hibernate hibernate-jpamodelgen-jakarta 5.6.4.Final
org.hibernate hibernate-micrometer 5.6.4.Final
org.hibernate hibernate-proxool 5.6.4.Final
org.hibernate hibernate-spatial 5.6.4.Final
org.hibernate hibernate-testing-jakarta 5.6.4.Final
org.hibernate hibernate-vibur 5.6.4.Final
org.hibernate.validator hibernate-validator 7.0.1.Final
org.hibernate.validator hibernate-validator- 7.0.1.Final
annotation-processor
org.hsqldb hsqldb 2.6.1
org.influxdb influxdb-java 2.22
org.jboss.logging jboss-logging 3.4.3.Final
org.jdom jdom2 2.0.6.1
org.jetbrains.kotlin kotlin-compiler 1.6.0
org.jetbrains.kotlin kotlin-compiler-embeddable 1.6.0
org.jetbrains.kotlin kotlin-daemon-client 1.6.0
org.jetbrains.kotlin kotlin-main-kts 1.6.0
org.jetbrains.kotlin kotlin-osgi-bundle 1.6.0
org.jetbrains.kotlin kotlin-reflect 1.6.0
org.jetbrains.kotlin kotlin-script-runtime 1.6.0
org.jetbrains.kotlin kotlin-script-util 1.6.0
org.jetbrains.kotlin kotlin-scripting-common 1.6.0
org.jetbrains.kotlin kotlin-scripting-ide-services 1.6.0
org.jetbrains.kotlin kotlin-scripting-jvm 1.6.0
org.jetbrains.kotlin kotlin-scripting-jvm-host 1.6.0
org.jetbrains.kotlin kotlin-stdlib 1.6.0

666
Group ID Artifact ID Version
org.jetbrains.kotlin kotlin-stdlib-common 1.6.0
org.jetbrains.kotlin kotlin-stdlib-jdk7 1.6.0
org.jetbrains.kotlin kotlin-stdlib-jdk8 1.6.0
org.jetbrains.kotlin kotlin-stdlib-js 1.6.0
org.jetbrains.kotlin kotlin-test 1.6.0
org.jetbrains.kotlin kotlin-test-annotations-common 1.6.0
org.jetbrains.kotlin kotlin-test-common 1.6.0
org.jetbrains.kotlin kotlin-test-js 1.6.0
org.jetbrains.kotlin kotlin-test-junit 1.6.0
org.jetbrains.kotlin kotlin-test-junit5 1.6.0
org.jetbrains.kotlin kotlin-test-testng 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-android 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-core 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-core-jvm 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-debug 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-guava 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-javafx 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-jdk8 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-jdk9 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-play- 1.6.0
services
org.jetbrains.kotlinx kotlinx-coroutines-reactive 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-reactor 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-rx2 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-rx3 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-slf4j 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-swing 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-test 1.6.0
org.jetbrains.kotlinx kotlinx-coroutines-test-jvm 1.6.0
org.jooq jooq 3.16.2
org.jooq jooq-codegen 3.16.2
org.jooq jooq-kotlin 3.16.2
org.jooq jooq-meta 3.16.2
org.junit.jupiter junit-jupiter 5.8.2
org.junit.jupiter junit-jupiter-api 5.8.2
org.junit.jupiter junit-jupiter-engine 5.8.2
org.junit.jupiter junit-jupiter-migrationsupport 5.8.2
org.junit.jupiter junit-jupiter-params 5.8.2
org.junit.platform junit-platform-commons 1.8.2

667
Group ID Artifact ID Version
org.junit.platform junit-platform-console 1.8.2
org.junit.platform junit-platform-engine 1.8.2
org.junit.platform junit-platform-jfr 1.8.2
org.junit.platform junit-platform-launcher 1.8.2
org.junit.platform junit-platform-reporting 1.8.2
org.junit.platform junit-platform-runner 1.8.2
org.junit.platform junit-platform-suite 1.8.2
org.junit.platform junit-platform-suite-api 1.8.2
org.junit.platform junit-platform-suite-commons 1.8.2
org.junit.platform junit-platform-suite-engine 1.8.2
org.junit.platform junit-platform-testkit 1.8.2
org.junit.vintage junit-vintage-engine 5.8.2
org.jvnet.mimepull mimepull 1.9.15
org.liquibase liquibase-core 4.7.0
org.mariadb r2dbc-mariadb 1.0.3
org.mariadb.jdbc mariadb-java-client 2.7.5
org.mockito mockito-core 4.2.0
org.mockito mockito-inline 4.2.0
org.mockito mockito-junit-jupiter 4.2.0
org.mongodb bson 4.4.1
org.mongodb mongodb-driver-core 4.4.1
org.mongodb mongodb-driver-legacy 4.4.1
org.mongodb mongodb-driver-reactivestreams 4.4.1
org.mongodb mongodb-driver-sync 4.4.1
org.mortbay.jasper apache-el 10.0.7
org.neo4j.driver neo4j-java-driver 4.4.2
org.postgresql postgresql 42.3.1
org.projectlombok lombok 1.18.22
org.quartz-scheduler quartz 2.3.2
org.quartz-scheduler quartz-jobs 2.3.2
org.reactivestreams reactive-streams 1.0.3
org.seleniumhq.selenium htmlunit-driver 3.56.0
org.seleniumhq.selenium selenium-api 4.1.1
org.seleniumhq.selenium selenium-chrome-driver 4.1.1
org.seleniumhq.selenium selenium-edge-driver 4.1.1
org.seleniumhq.selenium selenium-firefox-driver 4.1.1
org.seleniumhq.selenium selenium-ie-driver 4.1.1
org.seleniumhq.selenium selenium-java 4.1.1

668
Group ID Artifact ID Version
org.seleniumhq.selenium selenium-opera-driver 4.1.1
org.seleniumhq.selenium selenium-remote-driver 4.1.1
org.seleniumhq.selenium selenium-safari-driver 4.1.1
org.seleniumhq.selenium selenium-support 4.1.1
org.skyscreamer jsonassert 1.5.0
org.slf4j jcl-over-slf4j 1.7.33
org.slf4j jul-to-slf4j 1.7.33
org.slf4j log4j-over-slf4j 1.7.33
org.slf4j slf4j-api 1.7.33
org.slf4j slf4j-ext 1.7.33
org.slf4j slf4j-jcl 1.7.33
org.slf4j slf4j-jdk14 1.7.33
org.slf4j slf4j-log4j12 1.7.33
org.slf4j slf4j-nop 1.7.33
org.slf4j slf4j-simple 1.7.33
org.springframework spring-aop 6.0.0-M2
org.springframework spring-aspects 6.0.0-M2
org.springframework spring-beans 6.0.0-M2
org.springframework spring-context 6.0.0-M2
org.springframework spring-context-indexer 6.0.0-M2
org.springframework spring-context-support 6.0.0-M2
org.springframework spring-core 6.0.0-M2
org.springframework spring-expression 6.0.0-M2
org.springframework spring-instrument 6.0.0-M2
org.springframework spring-jcl 6.0.0-M2
org.springframework spring-jdbc 6.0.0-M2
org.springframework spring-jms 6.0.0-M2
org.springframework spring-messaging 6.0.0-M2
org.springframework spring-orm 6.0.0-M2
org.springframework spring-oxm 6.0.0-M2
org.springframework spring-r2dbc 6.0.0-M2
org.springframework spring-test 6.0.0-M2
org.springframework spring-tx 6.0.0-M2
org.springframework spring-web 6.0.0-M2
org.springframework spring-webflux 6.0.0-M2
org.springframework spring-webmvc 6.0.0-M2
org.springframework spring-websocket 6.0.0-M2
org.springframework.amqp spring-amqp 3.0.0-M1

669
Group ID Artifact ID Version
org.springframework.amqp spring-rabbit 3.0.0-M1
org.springframework.amqp spring-rabbit-junit 3.0.0-M1
org.springframework.amqp spring-rabbit-stream 3.0.0-M1
org.springframework.amqp spring-rabbit-test 3.0.0-M1
org.springframework.batch spring-batch-core 5.0.0-M1
org.springframework.batch spring-batch-infrastructure 5.0.0-M1
org.springframework.batch spring-batch-integration 5.0.0-M1
org.springframework.batch spring-batch-test 5.0.0-M1
org.springframework.boot spring-boot 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-actuator 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-actuator- 3.0.0-SNAPSHOT
autoconfigure
org.springframework.boot spring-boot-autoconfigure 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-autoconfigure- 3.0.0-SNAPSHOT
processor
org.springframework.boot spring-boot-buildpack-platform 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-configuration- 3.0.0-SNAPSHOT
metadata
org.springframework.boot spring-boot-configuration- 3.0.0-SNAPSHOT
processor
org.springframework.boot spring-boot-devtools 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-jarmode-layertools 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-loader 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-loader-tools 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-properties- 3.0.0-SNAPSHOT
migrator
org.springframework.boot spring-boot-starter 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-activemq 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-actuator 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-amqp 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-aop 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-artemis 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-batch 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-cache 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-data- 3.0.0-SNAPSHOT
cassandra
org.springframework.boot spring-boot-starter-data- 3.0.0-SNAPSHOT
cassandra-reactive
org.springframework.boot spring-boot-starter-data- 3.0.0-SNAPSHOT
couchbase

670
Group ID Artifact ID Version
org.springframework.boot spring-boot-starter-data- 3.0.0-SNAPSHOT
couchbase-reactive
org.springframework.boot spring-boot-starter-data- 3.0.0-SNAPSHOT
elasticsearch
org.springframework.boot spring-boot-starter-data-jdbc 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-data-jpa 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-data-ldap 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-data- 3.0.0-SNAPSHOT
mongodb
org.springframework.boot spring-boot-starter-data- 3.0.0-SNAPSHOT
mongodb-reactive
org.springframework.boot spring-boot-starter-data-neo4j 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-data-r2dbc 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-data-redis 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-data- 3.0.0-SNAPSHOT
redis-reactive
org.springframework.boot spring-boot-starter-data-rest 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-freemarker 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-groovy- 3.0.0-SNAPSHOT
templates
org.springframework.boot spring-boot-starter-hateoas 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter- 3.0.0-SNAPSHOT
integration
org.springframework.boot spring-boot-starter-jdbc 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-jetty 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-jooq 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-json 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-jta- 3.0.0-SNAPSHOT
atomikos
org.springframework.boot spring-boot-starter-log4j2 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-logging 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-mail 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-mustache 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-oauth2- 3.0.0-SNAPSHOT
client
org.springframework.boot spring-boot-starter-oauth2- 3.0.0-SNAPSHOT
resource-server
org.springframework.boot spring-boot-starter-quartz 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-reactor- 3.0.0-SNAPSHOT
netty
org.springframework.boot spring-boot-starter-rsocket 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-security 3.0.0-SNAPSHOT

671
Group ID Artifact ID Version
org.springframework.boot spring-boot-starter-test 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-thymeleaf 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-tomcat 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-undertow 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-validation 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-web 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-web- 3.0.0-SNAPSHOT
services
org.springframework.boot spring-boot-starter-webflux 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-starter-websocket 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-test 3.0.0-SNAPSHOT
org.springframework.boot spring-boot-test-autoconfigure 3.0.0-SNAPSHOT
org.springframework.data spring-data-cassandra 4.0.0-M1
org.springframework.data spring-data-commons 3.0.0-M1
org.springframework.data spring-data-couchbase 5.0.0-M1
org.springframework.data spring-data-elasticsearch 5.0.0-M1
org.springframework.data spring-data-envers 3.0.0-M1
org.springframework.data spring-data-geode 3.0.0-M1
org.springframework.data spring-data-jdbc 3.0.0-M1
org.springframework.data spring-data-jpa 3.0.0-M1
org.springframework.data spring-data-keyvalue 3.0.0-M1
org.springframework.data spring-data-ldap 3.0.0-M1
org.springframework.data spring-data-mongodb 4.0.0-M1
org.springframework.data spring-data-neo4j 7.0.0-M1
org.springframework.data spring-data-r2dbc 3.0.0-M1
org.springframework.data spring-data-redis 3.0.0-M1
org.springframework.data spring-data-relational 3.0.0-M1
org.springframework.data spring-data-rest-core 4.0.0-M1
org.springframework.data spring-data-rest-hal-explorer 4.0.0-M1
org.springframework.data spring-data-rest-webmvc 4.0.0-M1
org.springframework.hateoas spring-hateoas 2.0.0-M1
org.springframework.integratio spring-integration-amqp 6.0.0-M1
n
org.springframework.integratio spring-integration-core 6.0.0-M1
n
org.springframework.integratio spring-integration-event 6.0.0-M1
n
org.springframework.integratio spring-integration-feed 6.0.0-M1
n

672
Group ID Artifact ID Version
org.springframework.integratio spring-integration-file 6.0.0-M1
n
org.springframework.integratio spring-integration-ftp 6.0.0-M1
n
org.springframework.integratio spring-integration-gemfire 6.0.0-M1
n
org.springframework.integratio spring-integration-groovy 6.0.0-M1
n
org.springframework.integratio spring-integration-http 6.0.0-M1
n
org.springframework.integratio spring-integration-ip 6.0.0-M1
n
org.springframework.integratio spring-integration-jdbc 6.0.0-M1
n
org.springframework.integratio spring-integration-jms 6.0.0-M1
n
org.springframework.integratio spring-integration-jmx 6.0.0-M1
n
org.springframework.integratio spring-integration-jpa 6.0.0-M1
n
org.springframework.integratio spring-integration-kafka 6.0.0-M1
n
org.springframework.integratio spring-integration-mail 6.0.0-M1
n
org.springframework.integratio spring-integration-mongodb 6.0.0-M1
n
org.springframework.integratio spring-integration-mqtt 6.0.0-M1
n
org.springframework.integratio spring-integration-r2dbc 6.0.0-M1
n
org.springframework.integratio spring-integration-redis 6.0.0-M1
n
org.springframework.integratio spring-integration-rsocket 6.0.0-M1
n
org.springframework.integratio spring-integration-scripting 6.0.0-M1
n
org.springframework.integratio spring-integration-security 6.0.0-M1
n
org.springframework.integratio spring-integration-sftp 6.0.0-M1
n
org.springframework.integratio spring-integration-stomp 6.0.0-M1
n
org.springframework.integratio spring-integration-stream 6.0.0-M1
n
org.springframework.integratio spring-integration-syslog 6.0.0-M1
n

673
Group ID Artifact ID Version
org.springframework.integratio spring-integration-test 6.0.0-M1
n
org.springframework.integratio spring-integration-test- 6.0.0-M1
n support
org.springframework.integratio spring-integration-webflux 6.0.0-M1
n
org.springframework.integratio spring-integration-websocket 6.0.0-M1
n
org.springframework.integratio spring-integration-ws 6.0.0-M1
n
org.springframework.integratio spring-integration-xml 6.0.0-M1
n
org.springframework.integratio spring-integration-xmpp 6.0.0-M1
n
org.springframework.integratio spring-integration-zeromq 6.0.0-M1
n
org.springframework.integratio spring-integration-zookeeper 6.0.0-M1
n
org.springframework.kafka spring-kafka 3.0.0-M1
org.springframework.kafka spring-kafka-test 3.0.0-M1
org.springframework.ldap spring-ldap-core 3.0.0-M1
org.springframework.ldap spring-ldap-core-tiger 3.0.0-M1
org.springframework.ldap spring-ldap-ldif-batch 3.0.0-M1
org.springframework.ldap spring-ldap-ldif-core 3.0.0-M1
org.springframework.ldap spring-ldap-odm 3.0.0-M1
org.springframework.ldap spring-ldap-test 3.0.0-M1
org.springframework.restdocs spring-restdocs-asciidoctor 3.0.0-SNAPSHOT
org.springframework.restdocs spring-restdocs-core 3.0.0-SNAPSHOT
org.springframework.restdocs spring-restdocs-mockmvc 3.0.0-SNAPSHOT
org.springframework.restdocs spring-restdocs-restassured 3.0.0-SNAPSHOT
org.springframework.restdocs spring-restdocs-webtestclient 3.0.0-SNAPSHOT
org.springframework.retry spring-retry 1.3.1
org.springframework.security spring-security-acl 6.0.0-M1
org.springframework.security spring-security-aspects 6.0.0-M1
org.springframework.security spring-security-config 6.0.0-M1
org.springframework.security spring-security-core 6.0.0-M1
org.springframework.security spring-security-crypto 6.0.0-M1
org.springframework.security spring-security-data 6.0.0-M1
org.springframework.security spring-security-ldap 6.0.0-M1
org.springframework.security spring-security-messaging 6.0.0-M1
org.springframework.security spring-security-oauth2-client 6.0.0-M1

674
Group ID Artifact ID Version
org.springframework.security spring-security-oauth2-core 6.0.0-M1
org.springframework.security spring-security-oauth2-jose 6.0.0-M1
org.springframework.security spring-security-oauth2- 6.0.0-M1
resource-server
org.springframework.security spring-security-openid 6.0.0-M1
org.springframework.security spring-security-rsocket 6.0.0-M1
org.springframework.security spring-security-saml2-service- 6.0.0-M1
provider
org.springframework.security spring-security-taglibs 6.0.0-M1
org.springframework.security spring-security-test 6.0.0-M1
org.springframework.security spring-security-web 6.0.0-M1
org.springframework.session spring-session-core 3.0.0-M1
org.springframework.session spring-session-data-geode 3.0.0-M1
org.springframework.session spring-session-data-mongodb 3.0.0-M1
org.springframework.session spring-session-data-redis 3.0.0-M1
org.springframework.session spring-session-hazelcast 3.0.0-M1
org.springframework.session spring-session-jdbc 3.0.0-M1
org.springframework.ws spring-ws-core 4.0.0-M1
org.springframework.ws spring-ws-security 4.0.0-M1
org.springframework.ws spring-ws-support 4.0.0-M1
org.springframework.ws spring-ws-test 4.0.0-M1
org.springframework.ws spring-xml 4.0.0-M1
org.testcontainers azure 1.16.2
org.testcontainers cassandra 1.16.2
org.testcontainers clickhouse 1.16.2
org.testcontainers cockroachdb 1.16.2
org.testcontainers couchbase 1.16.2
org.testcontainers database-commons 1.16.2
org.testcontainers db2 1.16.2
org.testcontainers dynalite 1.16.2
org.testcontainers elasticsearch 1.16.2
org.testcontainers gcloud 1.16.2
org.testcontainers influxdb 1.16.2
org.testcontainers jdbc 1.16.2
org.testcontainers junit-jupiter 1.16.2
org.testcontainers kafka 1.16.2
org.testcontainers localstack 1.16.2
org.testcontainers mariadb 1.16.2
org.testcontainers mockserver 1.16.2

675
Group ID Artifact ID Version
org.testcontainers mongodb 1.16.2
org.testcontainers mssqlserver 1.16.2
org.testcontainers mysql 1.16.2
org.testcontainers neo4j 1.16.2
org.testcontainers nginx 1.16.2
org.testcontainers oracle-xe 1.16.2
org.testcontainers orientdb 1.16.2
org.testcontainers postgresql 1.16.2
org.testcontainers presto 1.16.2
org.testcontainers pulsar 1.16.2
org.testcontainers r2dbc 1.16.2
org.testcontainers rabbitmq 1.16.2
org.testcontainers selenium 1.16.2
org.testcontainers solr 1.16.2
org.testcontainers spock 1.16.2
org.testcontainers testcontainers 1.16.2
org.testcontainers toxiproxy 1.16.2
org.testcontainers trino 1.16.2
org.testcontainers vault 1.16.2
org.thymeleaf thymeleaf 3.1.0.M1
org.thymeleaf thymeleaf-spring6 3.1.0.M1
org.thymeleaf.extras thymeleaf-extras-java8time 3.0.4.RELEASE
org.thymeleaf.extras thymeleaf-extras- 3.1.0.M1
springsecurity6
org.webjars webjars-locator-core 0.48
org.xerial sqlite-jdbc 3.36.0.3
org.xmlunit xmlunit-assertj 2.8.4
org.xmlunit xmlunit-core 2.8.4
org.xmlunit xmlunit-legacy 2.8.4
org.xmlunit xmlunit-matchers 2.8.4
org.xmlunit xmlunit-placeholders 2.8.4
org.yaml snakeyaml 1.30
redis.clients jedis 3.8.0
wsdl4j wsdl4j 1.6.3

F.2. Version Properties

The following table provides all properties that can be used to override the versions managed by
Spring Boot. Browse the spring-boot-dependencies build.gradle for a complete list of dependencies.

676
You can learn how to customize these versions in your application in the Build Tool Plugins
documentation.

Library Version Property

ANTLR2 antlr2.version
AppEngine SDK appengine-sdk.version
Artemis artemis.version
AspectJ aspectj.version
AssertJ assertj.version
Awaitility awaitility.version
Build Helper Maven Plugin build-helper-maven-plugin.version
Byte Buddy byte-buddy.version
Caffeine caffeine.version
Cassandra Driver cassandra-driver.version
Classmate classmate.version
Commons Codec commons-codec.version
Commons DBCP2 commons-dbcp2.version
Commons Lang3 commons-lang3.version
Commons Pool commons-pool.version
Commons Pool2 commons-pool2.version
Couchbase Client couchbase-client.version
DB2 JDBC db2-jdbc.version
Dependency Management Plugin dependency-management-plugin.version
Derby derby.version
Dropwizard Metrics dropwizard-metrics.version
Elasticsearch elasticsearch.version
Embedded Mongo embedded-mongo.version
Flyway flyway.version
FreeMarker freemarker.version
Git Commit ID Plugin git-commit-id-plugin.version
Glassfish EL glassfish-el.version
Glassfish JAXB glassfish-jaxb.version
Glassfish JSTL glassfish-jstl.version
Groovy groovy.version
Gson gson.version
H2 h2.version
Hamcrest hamcrest.version
Hazelcast hazelcast.version
Hazelcast Hibernate5 hazelcast-hibernate5.version
Hibernate hibernate.version

677
Library Version Property
Hibernate Validator hibernate-validator.version
HikariCP hikaricp.version
HSQLDB hsqldb.version
HtmlUnit htmlunit.version
HttpAsyncClient httpasyncclient.version
HttpClient httpclient.version
HttpClient5 httpclient5.version
HttpCore httpcore.version
HttpCore5 httpcore5.version
InfluxDB Java influxdb-java.version
Jackson Bom jackson-bom.version
Jakarta Activation jakarta-activation.version
Jakarta Annotation jakarta-annotation.version
Jakarta JMS jakarta-jms.version
Jakarta Json jakarta-json.version
Jakarta Json Bind jakarta-json-bind.version
Jakarta Mail jakarta-mail.version
Jakarta Management jakarta-management.version
Jakarta Persistence jakarta-persistence.version
Jakarta Servlet jakarta-servlet.version
Jakarta Servlet JSP JSTL jakarta-servlet-jsp-jstl.version
Jakarta Transaction jakarta-transaction.version
Jakarta Validation jakarta-validation.version
Jakarta WebSocket jakarta-websocket.version
Jakarta WS RS jakarta-ws-rs.version
Jakarta XML Bind jakarta-xml-bind.version
Jakarta XML SOAP jakarta-xml-soap.version
Jakarta XML WS jakarta-xml-ws.version
Janino janino.version
Javax Cache javax-cache.version
Javax Money javax-money.version
Jaxen jaxen.version
Jaybird jaybird.version
JBoss Logging jboss-logging.version
JDOM2 jdom2.version
Jedis jedis.version
Jetty jetty.version
Jetty EL jetty-el.version

678
Library Version Property
Jetty Reactive HTTPClient jetty-reactive-httpclient.version
JMustache jmustache.version
jOOQ jooq.version
Json Path json-path.version
Json-smart json-smart.version
JsonAssert jsonassert.version
JSTL jstl.version
JTDS jtds.version
JUnit junit.version
JUnit Jupiter junit-jupiter.version
Kafka kafka.version
Kotlin kotlin.version
Kotlin Coroutines kotlin-coroutines.version
Lettuce lettuce.version
Liquibase liquibase.version
Log4j2 log4j2.version
Logback logback.version
Lombok lombok.version
MariaDB mariadb.version
Maven AntRun Plugin maven-antrun-plugin.version
Maven Assembly Plugin maven-assembly-plugin.version
Maven Clean Plugin maven-clean-plugin.version
Maven Compiler Plugin maven-compiler-plugin.version
Maven Dependency Plugin maven-dependency-plugin.version
Maven Deploy Plugin maven-deploy-plugin.version
Maven Enforcer Plugin maven-enforcer-plugin.version
Maven Failsafe Plugin maven-failsafe-plugin.version
Maven Help Plugin maven-help-plugin.version
Maven Install Plugin maven-install-plugin.version
Maven Invoker Plugin maven-invoker-plugin.version
Maven Jar Plugin maven-jar-plugin.version
Maven Javadoc Plugin maven-javadoc-plugin.version
Maven Resources Plugin maven-resources-plugin.version
Maven Shade Plugin maven-shade-plugin.version
Maven Source Plugin maven-source-plugin.version
Maven Surefire Plugin maven-surefire-plugin.version
Maven War Plugin maven-war-plugin.version
Micrometer micrometer.version

679
Library Version Property
MIMEPull mimepull.version
Mockito mockito.version
MongoDB mongodb.version
MSSQL JDBC mssql-jdbc.version
MySQL mysql.version
NekoHTML nekohtml.version
Neo4j Java Driver neo4j-java-driver.version
Netty netty.version
Netty tcNative netty-tcnative.version
OkHttp3 okhttp3.version
Oracle Database oracle-database.version
Postgresql postgresql.version
Prometheus Client prometheus-client.version
Quartz quartz.version
QueryDSL querydsl.version
R2DBC Bom r2dbc-bom.version
Rabbit AMQP Client rabbit-amqp-client.version
Rabbit Stream Client rabbit-stream-client.version
Reactive Streams reactive-streams.version
Reactor Bom reactor-bom.version
REST Assured rest-assured.version
RSocket rsocket.version
RxJava rxjava.version
RxJava Adapter rxjava-adapter.version
RxJava2 rxjava2.version
SAAJ Impl saaj-impl.version
Selenium selenium.version
Selenium HtmlUnit selenium-htmlunit.version
SendGrid sendgrid.version
Servlet API servlet-api.version
SLF4J slf4j.version
SnakeYAML snakeyaml.version
Solr solr.version
Spring AMQP spring-amqp.version
Spring Batch spring-batch.version
Spring Data Bom spring-data-bom.version
Spring Framework spring-framework.version
Spring HATEOAS spring-hateoas.version

680
Library Version Property
Spring Integration spring-integration.version
Spring Kafka spring-kafka.version
Spring LDAP spring-ldap.version
Spring RESTDocs spring-restdocs.version
Spring Retry spring-retry.version
Spring Security spring-security.version
Spring Session Bom spring-session-bom.version
Spring WS spring-ws.version
SQLite JDBC sqlite-jdbc.version
Sun Mail sun-mail.version
Thymeleaf thymeleaf.version
Thymeleaf Extras Data Attribute thymeleaf-extras-data-attribute.version
Thymeleaf Extras Java8Time thymeleaf-extras-java8time.version
Thymeleaf Extras SpringSecurity thymeleaf-extras-springsecurity.version
Thymeleaf Layout Dialect thymeleaf-layout-dialect.version
Tomcat tomcat.version
UnboundID LDAPSDK unboundid-ldapsdk.version
Undertow undertow.version
Versions Maven Plugin versions-maven-plugin.version
WebJars Locator Core webjars-locator-core.version
WSDL4j wsdl4j.version
XML Maven Plugin xml-maven-plugin.version
XmlUnit2 xmlunit2.version
Yasson yasson.version

681