Spring Boot

2/20/2017 Spring Boot Reference Guide
Spring Boot Reference Guide
Authors
Phillip Webb, Dave Syer, Josh Long, Stphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Dupuis, Sbastien Deleuze,
Michael Simons
2.0.0.BUILD-SNAPSHOT
Copyright 2012-2017
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.
Table of Contents
I. Spring Boot Documentation

1. About the documentation
2. Getting help
3. First steps
4. Working with Spring Boot
5. Learning about Spring Boot features

6. Moving to production
7. Advanced topics
II. Getting started

8. Introducing Spring Boot
9. System Requirements
9.1. Servlet containers
10. Installing Spring Boot

10.1. Installation instructions for the Java developer
10.1.1. Maven installation
10.1.2. Gradle installation
10.2. Installing the Spring Boot CLI

10.2.1. Manual installation
10.2.2. Installation with SDKMAN!
10.2.3. OSX Homebrew installation
10.2.4. MacPorts installation
10.2.5. Command-line completion
10.2.6. Quick start Spring CLI example
10.3. Upgrading from an earlier version of Spring Boot
11. Developing your rst Spring Boot application

11.1. Creating the POM
11.2. Adding classpath dependencies
11.3. Writing the code
11.3.1. The @RestController and @RequestMapping annotations
11.3.2. The @EnableAutoConguration annotation
http://docs.spring.io/spring-boot/docs/2.0.0.BUILD-SNAPSHOT/reference/htmlsingle/ 1/237
11.3.3. The main method
11.4. Running the example

11.5. Creating an executable jar
12. What to read next
III. Using Spring Boot

13. Build systems
13.1. Dependency management
13.2. Maven
13.2.1. Inheriting the starter parent
13.2.2. Using Spring Boot without the parent POM
13.2.3. Using the Spring Boot Maven plugin
13.3. Gradle
13.4. Ant
13.5. Starters
14. Structuring your code

14.1. Using the default package
14.2. Locating the main application class
15. Conguration classes

15.1. Importing additional conguration classes
15.2. Importing XML conguration
16. Auto-conguration
16.1. Gradually replacing auto-conguration
16.2. Disabling specic auto-conguration
17. Spring Beans and dependency injection

18. Using the @SpringBootApplication annotation
19. Running your application

19.1. Running from an IDE
19.2. Running as a packaged application
19.3. Using the Maven plugin
19.4. Using the Gradle plugin
19.5. Hot swapping
20. Developer tools

20.1. Property defaults
20.2. Automatic restart
20.2.1. Excluding resources
20.2.2. Watching additional paths
20.2.3. Disabling restart
20.2.4. Using a trigger le
20.2.5. Customizing the restart classloader
20.2.6. Known limitations
20.3. LiveReload
20.4. Global settings
20.5. Remote applications
20.5.1. Running the remote client application
20.5.2. Remote update
20.5.3. Remote debug tunnel
21. Packaging your application for production
IV. Spring Boot features

23. SpringApplication
23.1. Startup failure
23.2. Customizing the Banner
23.3. Customizing SpringApplication
23.4. Fluent builder API
23.5. Application events and listeners
23.6. Web environment
23.7. Accessing application arguments
23.8. Using the ApplicationRunner or CommandLineRunner
23.9. Application exit
23.10. Admin features
24. Externalized Conguration

24.1. Conguring random values
24.2. Accessing command line properties
24.3. Application property les
24.4. Prole-specic properties
24.5. Placeholders in properties
24.6. Using YAML instead of Properties
24.6.1. Loading YAML
24.6.2. Exposing YAML as properties in the Spring Environment
24.6.3. Multi-prole YAML documents
24.6.4. YAML shortcomings
24.6.5. Merging YAML lists
24.7. Type-safe Conguration Properties

24.7.1. Third-party conguration
24.7.2. Relaxed binding
24.7.3. Properties conversion
24.7.4. @CongurationProperties Validation
24.7.5. @CongurationProperties vs. @Value
25. Proles
25.1. Adding active proles
25.2. Programmatically setting proles
25.3. Prole-specic conguration les
26. Logging
26.1. Log format
26.2. Console output
26.2.1. Color-coded output
26.3. File output

26.4. Log Levels
26.5. Custom log conguration
26.6. Logback extensions
26.6.1. Prole-specic conguration
26.6.2. Environment properties
27. Developing web applications

27.1. The Spring Web MVC framework
27.1.1. Spring MVC auto-conguration
27.1.2. HttpMessageConverters
27.1.3. Custom JSON Serializers and Deserializers
27.1.4. MessageCodesResolver
27.1.5. Static Content
27.1.6. Custom Favicon
27.1.7. CongurableWebBindingInitializer
27.1.8. Template engines
27.1.9. Error Handling
Custom error pages
Mapping error pages outside of Spring MVC
Error Handling on WebSphere Application Server
27.1.10. Spring HATEOAS
27.1.11. CORS support
27.2. JAX-RS and Jersey

27.3. Embedded servlet container support
27.3.1. Servlets, Filters, and listeners
Registering Servlets, Filters, and listeners as Spring beans
27.3.2. Servlet Context Initialization
Scanning for Servlets, Filters, and listeners
27.3.3. The EmbeddedWebApplicationContext
27.3.4. Customizing embedded servlet containers
Programmatic customization
Customizing CongurableEmbeddedServletContainer directly
27.3.5. JSP limitations
28. Security
28.1. OAuth2
28.1.1. Authorization Server
28.1.2. Resource Server
28.2. Token Type in User Info

28.3. Customizing the User Info RestTemplate
28.3.1. Client
28.3.2. Single Sign On
28.4. Actuator Security
29. Working with SQL databases

29.1. Congure a DataSource
29.1.1. Embedded Database Support
29.1.2. Connection to a production database
29.1.3. Connection to a JNDI DataSource
29.2. Using JdbcTemplate

29.3. JPA and Spring Data
29.3.1. Entity Classes
29.3.2. Spring Data JPA Repositories
29.3.3. Creating and dropping JPA databases
29.3.4. Open EntityManager in View
29.4. Using H2s web console

29.4.1. Changing the H2 consoles path
29.4.2. Securing the H2 console
29.5. Using jOOQ

29.5.1. Code Generation
29.5.2. Using DSLContext
29.5.3. Customizing jOOQ
30. Working with NoSQL technologies

30.1. Redis
30.1.1. Connecting to Redis
30.2. MongoDB
30.2.1. Connecting to a MongoDB database
30.2.2. MongoTemplate
30.2.3. Spring Data MongoDB repositories
30.2.4. Embedded Mongo
30.3. Neo4j
30.3.1. Connecting to a Neo4j database
30.3.2. Using the embedded mode
30.3.3. Neo4jSession
30.3.4. Spring Data Neo4j repositories
30.3.5. Repository example
30.4. Gemre
30.5. Solr
30.5.1. Connecting to Solr
30.5.2. Spring Data Solr repositories
30.6. Elasticsearch
30.6.1. Connecting to Elasticsearch using Jest
30.6.2. Connecting to Elasticsearch using Spring Data
30.6.3. Spring Data Elasticsearch repositories
30.7. Cassandra
30.7.1. Connecting to Cassandra
30.7.2. Spring Data Cassandra repositories
30.8. Couchbase
30.8.1. Connecting to Couchbase
30.8.2. Spring Data Couchbase repositories
30.9. LDAP
30.9.1. Connecting to an LDAP server
30.9.2. Spring Data LDAP repositories
30.9.3. Embedded in-memory LDAP server
31. Caching
31.1. Supported cache providers
31.1.1. Generic
31.1.2. JCache (JSR-107)
31.1.3. EhCache 2.x
31.1.4. Hazelcast
31.1.5. Innispan
31.1.6. Couchbase
31.1.7. Redis
31.1.8. Caffeine
31.1.9. Simple
31.1.10. None
32. Messaging
32.1. JMS
32.1.1. ActiveMQ support
32.1.2. Artemis support
32.1.3. Using a JNDI ConnectionFactory
32.1.4. Sending a message
32.1.5. Receiving a message
32.2. AMQP
32.2.1. RabbitMQ support
32.2.2. Sending a message
32.2.3. Receiving a message
32.3. Apache Kafka Support

32.3.1. Sending a Message
32.3.2. Receiving a Message
32.3.3. Additional Kafka Properties
33. Calling REST services

33.1. RestTemplate customization
34. Validation
35. Sending email
36. Distributed Transactions with JTA

36.1. Using an Atomikos transaction manager
36.2. Using a Bitronix transaction manager
36.3. Using a Narayana transaction manager
36.4. Using a Java EE managed transaction manager
36.5. Mixing XA and non-XA JMS connections
36.6. Supporting an alternative embedded transaction manager
37. Hazelcast
38. Spring Integration
39. Spring Session

40. Monitoring and management over JMX
41. Testing
41.1. Test scope dependencies
41.2. Testing Spring applications
41.3. Testing Spring Boot applications
41.3.1. Detecting test conguration
41.3.2. Excluding test conguration
41.3.3. Working with random ports
41.3.4. Mocking and spying beans
41.3.5. Auto-congured tests
41.3.6. Auto-congured JSON tests
41.3.7. Auto-congured Spring MVC tests
41.3.8. Auto-congured Data JPA tests
41.3.9. Auto-congured JDBC tests
41.3.10. Auto-congured Data MongoDB tests
41.3.11. Auto-congured REST clients
41.3.12. Auto-congured Spring REST Docs tests
41.3.13. Using Spock to test Spring Boot applications
41.4. Test utilities

41.4.1. CongFileApplicationContextInitializer
41.4.2. EnvironmentTestUtils
41.4.3. OutputCapture
41.4.4. TestRestTemplate
42. WebSockets
43. Web Services
44. Creating your own auto-conguration
44.1. Understanding auto-congured beans
44.2. Locating auto-conguration candidates
44.3. Condition annotations
44.3.1. Class conditions
44.3.2. Bean conditions
44.3.3. Property conditions
44.3.4. Resource conditions
44.3.5. Web application conditions
44.3.6. SpEL expression conditions
44.4. Creating your own starter

44.4.1. Naming
44.4.2. Autocongure module
44.4.3. Starter module
V. Spring Boot Actuator: Production-ready features

46. Enabling production-ready features
47. Endpoints
47.1. Customizing endpoints
47.2. Hypermedia for actuator MVC endpoints
47.3. CORS support
47.4. Adding custom endpoints
47.5. Health information
47.6. Security with HealthIndicators
47.6.1. Auto-congured HealthIndicators
47.6.2. Writing custom HealthIndicators
47.7. Application information

47.7.1. Auto-congured InfoContributors
47.7.2. Custom application info information
47.7.3. Git commit information
47.7.4. Build information
47.7.5. Writing custom InfoContributors
48. Monitoring and management over HTTP

48.1. Accessing sensitive endpoints
48.2. Customizing the management endpoint paths
48.3. Customizing the management server port
48.4. Conguring management-specic SSL
48.5. Customizing the management server address
48.6. Disabling HTTP endpoints
48.7. HTTP health endpoint access restrictions
49. Monitoring and management over JMX

49.1. Customizing MBean names
49.2. Disabling JMX endpoints
49.3. Using Jolokia for JMX over HTTP
49.3.1. Customizing Jolokia
49.3.2. Disabling Jolokia
50. Loggers
50.1. Congure a Logger
51. Metrics
51.1. System metrics
51.2. DataSource metrics
51.3. Cache metrics
51.4. Tomcat session metrics
51.5. Recording your own metrics
51.6. Adding your own public metrics
51.7. Metric writers, exporters and aggregation
51.7.1. Example: Export to Redis
51.7.2. Example: Export to Open TSDB
51.7.3. Example: Export to Statsd
51.7.4. Example: Export to JMX
51.8. Aggregating metrics from multiple sources

51.9. Dropwizard Metrics
51.10. Message channel integration
52. Auditing
53. Tracing
53.1. Custom tracing
54. Process monitoring

54.1. Extend conguration
54.2. Programmatically
55. Cloud Foundry support

55.1. Disabling extended Cloud Foundry actuator support
55.2. Cloud Foundry self signed certicates
55.3. Custom security conguration
VI. Deploying Spring Boot applications

57. Deploying to the cloud
57.1. Cloud Foundry
57.1.1. Binding to services
57.2. Heroku
57.3. OpenShift
57.4. Amazon Web Services (AWS)
57.4.1. AWS Elastic Beanstalk
Using the Tomcat platform
Using the Java SE platform
Best practices
57.4.2. Summary
57.5. Boxfuse and Amazon Web Services

57.6. Google App Engine
58. Installing Spring Boot applications

58.1. Unix/Linux services
58.1.1. Installation as an init.d service (System V)
Securing an init.d service
58.1.2. Installation as a systemd service
58.1.3. Customizing the startup script
Customizing script when its written
Customizing script when it runs
58.2. Microsoft Windows services
VII. Spring Boot CLI

60. Installing the CLI
61. Using the CLI
61.1. Running applications using the CLI
61.1.1. Deduced grab dependencies
61.1.2. Deduced grab coordinates
61.1.3. Default import statements
61.1.4. Automatic main method
61.1.5. Custom dependency management
61.2. Testing your code

61.3. Applications with multiple source les
61.4. Packaging your application
61.5. Initialize a new project
61.6. Using the embedded shell
61.7. Adding extensions to the CLI
62. Developing application with the Groovy beans DSL

63. Conguring the CLI with settings.xml
VIII. Build tool plugins

65. Spring Boot Maven plugin

65.1. Including the plugin
65.2. Packaging executable jar and war les
66. Spring Boot Gradle plugin

66.1. Including the plugin
66.2. Gradle dependency management
66.3. Packaging executable jar and war les
66.4. Running a project in-place
66.5. Spring Boot plugin conguration
66.6. Repackage conguration
66.7. Repackage with custom Gradle conguration
66.7.1. Conguration options
66.7.2. Available layouts
66.7.3. Using a custom layout
66.8. Understanding how the Gradle plugin works

66.9. Publishing artifacts to a Maven repository using Gradle
66.9.1. Conguring Gradle to produce a pom that inherits dependency management
66.9.2. Conguring Gradle to produce a pom that imports dependency management
67. Spring Boot AntLib module

67.1. Spring Boot Ant tasks
67.1.1. spring-boot:exejar
67.1.2. Examples
67.2. spring-boot:ndmainclass
67.2.1. Examples
68. Supporting other build systems

68.1. Repackaging archives
68.2. Nested libraries
68.3. Finding a main class
68.4. Example repackage implementation
IX. How-to guides

70. Spring Boot application
70.1. Create your own FailureAnalyzer
70.2. Troubleshoot auto-conguration
70.3. Customize the Environment or ApplicationContext before it starts
70.4. Build an ApplicationContext hierarchy (adding a parent or root context)
70.5. Create a non-web application
71. Properties & conguration

71.1. Automatically expand properties at build time
71.1.1. Automatic property expansion using Maven
71.1.2. Automatic property expansion using Gradle
71.2. Externalize the conguration of SpringApplication

71.3. Change the location of external properties of an application
71.4. Use short command line arguments
71.5. Use YAML for external properties
71.6. Set the active Spring proles
71.7. Change conguration depending on the environment
71.8. Discover built-in options for external properties
72. Embedded servlet containers

72.1. Add a Servlet, Filter or Listener to an application
72.1.1. Add a Servlet, Filter or Listener using a Spring bean
Disable registration of a Servlet or Filter
72.1.2. Add Servlets, Filters, and Listeners using classpath scanning
72.2. Change the HTTP port

72.3. Use a random unassigned HTTP port
72.4. Discover the HTTP port at runtime
72.5. Congure SSL
72.6. Congure Access Logging
72.7. Use behind a front-end proxy server
72.7.1. Customize Tomcats proxy conguration
72.8. Congure Tomcat

72.9. Enable Multiple Connectors with Tomcat
72.10. Use Tomcats LegacyCookieProcessor
72.11. Use Jetty instead of Tomcat
72.12. Congure Jetty
72.13. Use Undertow instead of Tomcat
72.14. Congure Undertow
72.15. Enable Multiple Listeners with Undertow
72.16. Create WebSocket endpoints using @ServerEndpoint
72.17. Enable HTTP response compression
73. Spring MVC

73.1. Write a JSON REST service
73.2. Write an XML REST service
73.3. Customize the Jackson ObjectMapper
73.4. Customize the @ResponseBody rendering
73.5. Handling Multipart File Uploads
73.6. Switch off the Spring MVC DispatcherServlet
73.7. Switch off the Default MVC conguration
73.8. Customize ViewResolvers
74. HTTP clients

74.1. Congure RestTemplate to use a proxy
75. Logging
75.1. Congure Logback for logging
75.1.1. Congure logback for le only output
75.2. Congure Log4j for logging

75.2.1. Use YAML or JSON to congure Log4j 2
76. Data Access

76.1. Congure a custom DataSource
76.2. Congure Two DataSources
76.3. Use Spring Data repositories
76.4. Separate @Entity denitions from Spring conguration
76.5. Congure JPA properties
76.6. Use a custom EntityManagerFactory
76.7. Use Two EntityManagers
76.8. Use a traditional persistence.xml
76.9. Use Spring Data JPA and Mongo repositories
76.10. Expose Spring Data repositories as REST endpoint
76.11. Congure a component that is used by JPA
77. Database initialization

77.1. Initialize a database using JPA
77.2. Initialize a database using Hibernate
77.3. Initialize a database using Spring JDBC
77.4. Initialize a Spring Batch database
77.5. Use a higher-level database migration tool
77.5.1. Execute Flyway database migrations on startup
77.5.2. Execute Liquibase database migrations on startup
78. Messaging
78.1. Disable transacted JMS session
79. Batch applications

79.1. Execute Spring Batch jobs on startup
80. Actuator
80.1. Change the HTTP port or address of the actuator endpoints
80.2. Customize the whitelabel error page
80.3. Actuator and Jersey
81. Security
81.1. Switch off the Spring Boot security conguration
81.2. Change the AuthenticationManager and add user accounts
81.3. Enable HTTPS when running behind a proxy server
82. Hot swapping

82.1. Reload static content
82.2. Reload templates without restarting the container
82.2.1. Thymeleaf templates
82.2.2. FreeMarker templates
82.2.3. Groovy templates
82.3. Fast application restarts

82.4. Reload Java classes without restarting the container
82.4.1. Conguring Spring Loaded for use with Maven
82.4.2. Conguring Spring Loaded for use with Gradle and IntelliJ IDEA
83. Build
83.1. Generate build information
83.2. Generate git information
83.3. Customize dependency versions
83.4. Create an executable JAR with Maven
83.5. Use a Spring Boot application as a dependency
83.6. Extract specic libraries when an executable jar runs
83.7. Create a non-executable JAR with exclusions
83.8. Remote debug a Spring Boot application started with Maven
83.9. Remote debug a Spring Boot application started with Gradle
83.10. Build an executable archive from Ant without using spring-boot-antlib
84. Traditional deployment

84.1. Create a deployable war le
84.2. Create a deployable war le for older servlet containers
84.3. Convert an existing application to Spring Boot
84.4. Deploying a WAR to WebLogic
84.5. Deploying a WAR in an Old (Servlet 2.5) Container
X. Appendices
A. Common application properties
B. Conguration meta-data
B.1. Meta-data format
B.1.1. Group Attributes
B.1.2. Property Attributes
B.1.3. Hint Attributes
B.1.4. Repeated meta-data items
B.2. Providing manual hints

B.2.1. Value hint
B.2.2. Value provider
Any
Class reference
Handle As
Logger name
Spring bean reference
Spring prole name
B.3. Generating your own meta-data using the annotation processor

B.3.1. Nested properties
B.3.2. Adding additional meta-data
C. Auto-conguration classes
C.1. From the spring-boot-autocongure module
C.2. From the spring-boot-actuator module
D. Test auto-conguration annotations

E. The executable jar format
E.1. Nested JARs
E.1.1. The executable jar le structure
E.1.2. The executable war le structure
E.2. Spring Boots JarFile class

E.2.1. Compatibility with the standard Java JarFile
E.3. Launching executable jars

E.3.1. Launcher manifest
E.3.2. Exploded archives
E.4. PropertiesLauncher Features

E.5. Executable jar restrictions
E.5.1. Zip entry compression
E.5.2. System ClassLoader
E.6. Alternative single jar solutions
F. Dependency versions
PartI.Spring Boot Documentation
This section provides a brief overview of Spring Boot reference documentation. Think of it as map for the rest of the document. You can read
this reference guide in a linear fashion, or you can skip sections if something doesnt interest you.
1.About the documentation

The Spring Boot reference guide is available as html, pdf and epub documents. The latest copy is available at docs.spring.io/spring-
boot/docs/current/reference.
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.Getting help
Having trouble with Spring Boot, Wed like to help!
Try the How-tosthey provide solutions to the most common questions.

Learn the Spring basicsSpring Boot builds on many other Spring projects, check the spring.io web-site for a wealth of reference
documentation. If you are just starting out with Spring, try one of the guides.
Ask a question - we monitor stackoverow.com for questions tagged with springboot .
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 nd problems with the docs; or if you just want to improve
them, please get involved.
3.First steps
If youre just getting started with Spring Boot, or 'Spring' in general, this is the place to start!
From scratch: Overview | Requirements | Installation

Tutorial: Part 1 | Part 2
Running your example: Part 1 | Part 2
4.Working with Spring Boot

Ready to actually start using Spring Boot? Weve got you covered.
Build systems: Maven | Gradle | Ant | Starters

Best practices: Code Structure | @Conguration | @EnableAutoConguration | Beans and Dependency Injection
Running your code IDE | Packaged | Maven | Gradle
Packaging your app: Production jars
Spring Boot CLI: Using the CLI
5.Learning about Spring Boot features

Need more details about Spring Boots core features? This is for you!
Core Features: SpringApplication | External Conguration | Proles | Logging

Web Applications: MVC | Embedded Containers
Working with data: SQL | NO-SQL
Messaging: Overview | JMS
Testing: Overview | Boot Applications | Utils
Extending: Auto-conguration | @Conditions
6.Moving to production
When youre ready to push your Spring Boot application to production, weve got some tricks that you might like!
Management endpoints: Overview | Customization

Connection options: HTTP | JMX |
Monitoring: Metrics | Auditing | Tracing | Process
7.Advanced topics
Lastly, we have a few topics for the more advanced user.
Deploy Spring Boot Applications: Cloud Deployment | OS Service

Build tool plugins: Maven | Gradle
Appendix: Application Properties | Auto-conguration classes | Executable Jars
PartII.Getting started
If youre just getting started with Spring Boot, or 'Spring' in general, this is the section for you! Here we answer the basic what?, how? and
why? questions. Youll nd a gentle introduction to Spring Boot along with installation instructions. Well then build our rst Spring Boot
application, discussing some core principles as we go.
8.Introducing Spring Boot

Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can just run. We take an opinionated
view of the Spring platform and third-party libraries so you can get started with minimum fuss. Most Spring Boot applications need very little
Spring conguration.
You can use Spring Boot to create Java applications that can be started using javajar 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 (e.g. embedded servers, security, metrics, health
checks, externalized conguration).
Absolutely no code generation and no requirement for XML conguration.
9.System Requirements
Spring Boot 2.0.0.BUILD-SNAPSHOT requires Java 8 and Spring Framework 5.0.0.BUILD-SNAPSHOT or above. Explicit build support is
provided for Maven (3.2+), and Gradle 2 (2.9 or later) and 3.
9.1Servlet containers
The following embedded servlet containers are supported out of the box:
Name Servlet Version Tomcat 8.5
3.1 Jetty 9.4 3.1
You can also deploy Spring Boot applications to any Servlet 3.0+ compatible container.
10.Installing Spring Boot

Spring Boot can be used with classic Java development tools or installed as a command line tool. Regardless, you will need Java SDK v1.8 or
higher. You should check your current Java installation before you begin:
$javaversion
If you are new to Java development, or if you just want to experiment with Spring Boot you might want to try the Spring Boot CLI rst, otherwise,
read on for classic installation instructions.
10.1Installation instructions for the Java developer
You can use Spring Boot in the same way as any standard Java library. Simply include the appropriate springboot*.jar les on your
classpath. Spring Boot does not require any special tools integration, so you can use any IDE or text editor; and there is nothing special about a
Spring Boot application, so you can run and debug as you would any other Java program.
Although you could just copy Spring Boot jars, we generally recommend that you use a build tool that supports dependency management (such
as Maven or Gradle).
10.1.1Maven installation
Spring Boot is compatible with Apache Maven 3.2 or above. If you dont already have Maven installed you can follow the instructions at
maven.apache.org.
On many operating systems Maven can be installed via a package manager. If youre an OSX Homebrew user try
brewinstallmaven . Ubuntu users can run sudoaptgetinstallmaven .
Spring Boot dependencies use the org.springframework.boot groupId . Typically your Maven POM le will inherit from the
springbootstarterparent project and declare dependencies to one or more Starters. Spring Boot also provides an optional Maven
plugin to create executable jars.
Here is a typical pom.xml le:
<?xmlversion="1.0"encoding="UTF8"?>
<projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0http://maven.apache.org/xsd/maven4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>myproject</artifactId>
<version>0.0.1SNAPSHOT</version>
<!InheritdefaultsfromSpringBoot>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>springbootstarterparent</artifactId>
<version>2.0.0.BUILDSNAPSHOT</version>
</parent>
<!Addtypicaldependenciesforawebapplication>
<dependencies>
<dependency>
<artifactId>springbootstarterweb</artifactId>
</dependency>
</dependencies>
<!Packageasanexecutablejar>
<build>
<plugins>
<plugin>
<artifactId>springbootmavenplugin</artifactId>
</plugin>
</plugins>
</build>
<!AddSpringrepositories>
<!(youdon'tneedthisifyouareusinga.RELEASEversion)>
<repositories>
<repository>
<id>springsnapshots</id>
<url>http://repo.spring.io/snapshot</url>
<snapshots><enabled>true</enabled></snapshots>
</repository>
<repository>
<id>springmilestones</id>
<url>http://repo.spring.io/milestone</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
</pluginRepository>
<pluginRepository>
</pluginRepository>
</pluginRepositories>
</project>
The springbootstarterparent is a great way to use Spring Boot, but it might not be suitable all of the time. Sometimes
you may need to inherit from a different parent POM, or you might just not like our default settings. See Section13.2.2, Using
Spring Boot without the parent POM for an alternative solution that uses an import scope.
10.1.2Gradle installation
Spring Boot is compatible with Gradle 2 (2.9 or later) and Gradle 3. If you dont already have Gradle installed you can follow the instructions at
www.gradle.org/.
Spring Boot dependencies can be declared using the org.springframework.boot group . Typically your project will declare 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. Its a small script and library that you
commit alongside your code to bootstrap the build process. See docs.gradle.org/2.14.1/userguide/gradle_wrapper.html for details.
Here is a typical build.gradle le:
buildscript{
repositories{
jcenter()
maven{url'http://repo.spring.io/snapshot'}
maven{url'http://repo.spring.io/milestone'}
}
dependencies{
classpath'org.springframework.boot:springbootgradleplugin:2.0.0.BUILDSNAPSHOT'
}
}
applyplugin:'java'
applyplugin:'org.springframework.boot'
jar{
baseName='myproject'
version='0.0.1SNAPSHOT'
}
repositories{
jcenter()
maven{url"http://repo.spring.io/snapshot"}
maven{url"http://repo.spring.io/milestone"}
}
dependencies{
compile("org.springframework.boot:springbootstarterweb")
testCompile("org.springframework.boot:springbootstartertest")
}
10.2Installing the Spring Boot CLI

The Spring Boot CLI is a command line tool that can be used if you want to quickly prototype with Spring. It allows you to run Groovy scripts,
which means that you have a familiar Java-like syntax, without so much boilerplate code.
You dont need to use the CLI to work with Spring Boot but its denitely the quickest way to get a Spring application off the ground.
10.2.1Manual installation
You can download the Spring CLI distribution from the Spring software repository:
spring-boot-cli-2.0.0.BUILD-SNAPSHOT-bin.zip
spring-boot-cli-2.0.0.BUILD-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 le, or alternatively you can use javajar with the .jar le (the script helps you to be sure that
the classpath is set correctly).
10.2.2Installation 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 with
$sdkinstallspringboot
$springversion
SpringBootv2.0.0.BUILDSNAPSHOT
If you are developing features for the CLI and want easy access to the version you just built, follow these extra instructions.
$sdkinstallspringbootdev/path/to/springboot/springbootcli/target/springbootcli2.0.0.BUILDSNAPSHOTbin/spring2.0.0.BUILD
$sdkdefaultspringbootdev
$springversion
SpringCLIv2.0.0.BUILDSNAPSHOT
This will 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 will be up-to-date.
You can see it by doing this:
$sdklsspringboot
================================================================================
AvailableSpringbootVersions
================================================================================
>+dev
*2.0.0.BUILDSNAPSHOT
================================================================================
+localversion
*installed
>currentlyinuse
================================================================================
10.2.3OSX Homebrew installation

If you are on a Mac and using Homebrew, all you need to do to install the Spring Boot CLI is:
$brewtappivotal/tap
$brewinstallspringboot
Homebrew will install spring to /usr/local/bin .
If you dont see the formula, your installation of brew might be out-of-date. Just execute brewupdate and try again.
10.2.4MacPorts installation
If you are on a Mac and using MacPorts, all you need to do to install the Spring Boot CLI is:
$sudoportinstallspringbootcli
10.2.5Command-line completion
Spring Boot CLI ships with scripts that provide command completion for 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 /shellcompletion/bash and all scripts in that directory are executed when a new shell starts. To run the script manually, e.g. if you have
installed using SDKMAN!
$.~/.sdkman/candidates/springboot/current/shellcompletion/bash/spring
$spring<HITTABHERE>
grabhelpjarruntestversion
If you install Spring Boot CLI using Homebrew or MacPorts, the command-line completion scripts are automatically registered with
your shell.
10.2.6Quick start Spring CLI example

Heres a really simple web application that you can use to test your installation. Create a le called app.groovy :
@RestController
classThisWillActuallyRun{
@RequestMapping("/")
Stringhome(){
"HelloWorld!"
}
Then simply run it from a shell:
$springrunapp.groovy
It will take some time when you rst run the application as dependencies are downloaded. Subsequent runs will be much quicker.
Open localhost:8080 in your favorite web browser and you should see the following output:
HelloWorld!
10.3Upgrading from an earlier version of Spring Boot

If you are upgrading from an earlier release of Spring Boot check the release notes hosted on the project wiki. Youll nd upgrade instructions
along with a list of new and noteworthy features for each release.
To upgrade an existing CLI installation use the appropriate package manager command (for example brewupgrade ) or, if you manually
installed the CLI, follow the standard instructions remembering to update your PATH environment variable to remove any older references.
11.Developing your rst Spring Boot application

Lets develop a simple Hello World! web application in Java that highlights some of Spring Boots key features. Well 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 youre looking to solve a specic problem;
check there rst.
You can shortcut the steps below by going to start.spring.io and choosing the web starter from the dependencies searcher. This
will automatically generate a new project structure so that you can start coding right away. Check the documentation for more
details.
Before we begin, open a terminal to check that you have valid versions of Java and Maven installed.
$javaversion
javaversion"1.8.0_102"
Java(TM)SERuntimeEnvironment(build1.8.0_102b14)
JavaHotSpot(TM)64BitServerVM(build25.102b14,mixedmode)
$mvnv
ApacheMaven3.3.9(bb52d8502b132ec0a5a3f4c09453c07478323dc5;20151110T16:41:47+00:00)
Mavenhome:/usr/local/Cellar/maven/3.3.9/libexec
Javaversion:1.8.0_102,vendor:OracleCorporation
This sample needs to be created in its own folder. Subsequent instructions assume that you have created a suitable folder and
that it is your current directory.
11.1Creating the POM

We need to start by creating a Maven pom.xml le. The pom.xml is the recipe that will be used to build your project. Open your favorite text
editor and add the following:
<groupId>com.example</groupId>
<artifactId>myproject</artifactId>
<version>0.0.1SNAPSHOT</version>
<parent>
</parent>
<!Additionallinestobeaddedhere...>
<!(youdon'tneedthisifyouareusinga.RELEASEversion)>
<repositories>
<repository>
<snapshots><enabled>true</enabled></snapshots>
</repository>
<repository>
</repository>
</repositories>
<pluginRepository>
</pluginRepository>
<pluginRepository>
</pluginRepository>
</project>
This should give you a working build, you can test it out by running mvnpackage (you can ignore the jar will be empty - no content was
marked for inclusion! warning for now).
At this point you could import the project into an IDE (most modern Java IDEs include built-in support for Maven). For simplicity,
we will continue to use a plain text editor for this example.
11.2Adding classpath dependencies
Spring Boot provides a number of Starters that make easy to add jars to your classpath. Our sample application has already used
springbootstarterparent in the parent section of the POM. The springbootstarterparent is a special starter that provides
useful Maven defaults. It also provides a dependencymanagement section so that you can omit version tags for blessed dependencies.
Other Starters simply provide dependencies that you are likely to need when developing a specic type of application. Since we are
developing a web application, we will add a springbootstarterweb dependencybut before that, lets look at what we currently have.
$mvndependency:tree
[INFO]com.example:myproject:jar:0.0.1SNAPSHOT
The mvndependency:tree command prints a tree representation of your project dependencies. You can see that
springbootstarterparent provides no dependencies by itself. Lets edit our pom.xml and add the springbootstarterweb
dependency just below the parent section:
<dependencies>
<dependency>
</dependency>
</dependencies>
If you run mvndependency:tree again, you will see that there are now a number of additional dependencies, including the Tomcat web
server and Spring Boot itself.
11.3Writing the code

To nish our application we need to create a single Java le. Maven will compile sources from src/main/java by default so you need to
create that folder structure, then add a le named src/main/java/Example.java :
importorg.springframework.boot.*;
importorg.springframework.boot.autoconfigure.*;
importorg.springframework.stereotype.*;
importorg.springframework.web.bind.annotation.*;
@RestController
@EnableAutoConfiguration
publicclassExample{
Stringhome(){
return"HelloWorld!";
}
publicstaticvoidmain(String[]args)throwsException{
SpringApplication.run(Example.class,args);
}
Although there isnt much code here, quite a lot is going on. Lets step through the important parts.
11.3.1The @RestController and @RequestMapping annotations

The rst annotation on our Example 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 specic role. In this case, our class is a web @Controller so Spring will consider it when
handling incoming web requests.
The @RequestMapping annotation provides routing information. It is telling 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 (they are not specic to Spring Boot).
See the MVC section in the Spring Reference Documentation for more details.
11.3.2The @EnableAutoConguration annotation
The second class-level annotation is @EnableAutoConfiguration . This annotation tells Spring Boot to guess how you will want to congure
Spring, based on the jar dependencies that you have added. Since springbootstarterweb added Tomcat and Spring MVC, the auto-
conguration will assume that you are developing a web application and setup Spring accordingly.
Starters and Auto-Conguration
Auto-conguration 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 and Spring Boot will still do its best to auto-congure your application.
11.3.3The main method

The nal part of our application is the main method. This is just a standard method that follows the Java convention for an application entry
point. Our main method delegates to Spring Boots SpringApplication class by calling run . SpringApplication will bootstrap our
application, starting Spring which will in turn start the auto-congured Tomcat web server. We need to pass Example.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.
11.4Running the example

At this point our application should work. Since we have used the springbootstarterparent POM we have a useful run goal that we
can use to start the application. Type mvnspringboot:run from the root project directory to start the application:
$mvnspringboot:run
._________
/\\/___'_____(_)______\\\\
(()\___|'_|'_||'_\/_`|\\\\
\\/___)||_)|||||||(_||))))
'|____|.__|_||_|_||_\__,|////
=========|_|==============|___/=/_/_/_/
::SpringBoot::(v2.0.0.BUILDSNAPSHOT)
..........
..........(logoutputhere)
..........
........StartedExamplein2.222seconds(JVMrunningfor6.514)
If you open a web browser to localhost:8080 you should see the following output:
HelloWorld!
To gracefully exit the application hit ctrlc .
11.5Creating an executable jar

Lets nish our example by creating a completely self-contained executable jar le 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.
Executable jars and Java
Java does not provide any standard way to load nested jar les (i.e. jar les 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 simply packages all classes, from all jars, into a single archive. The
problem with this approach is that it becomes hard to see which libraries you are actually using in your application. It can also be
problematic if the same lename is used (but with different content) in multiple jars.
Spring Boot takes a different approach and allows you to actually nest jars directly.
To create an executable jar we need to add the springbootmavenplugin to our pom.xml . Insert the following lines just below the
dependencies section:
<build>
<plugins>
<plugin>
</plugin>
</plugins>
</build>
The springbootstarterparent POM includes <executions> conguration to bind the repackage goal. If you are not
using the parent POM you will need to declare this conguration yourself. See the plugin documentation for details.
Save your pom.xml and run mvnpackage from the command line:
$mvnpackage
[INFO]Scanningforprojects...
[INFO]
[INFO]
[INFO]Buildingmyproject0.0.1SNAPSHOT
[INFO]
[INFO]......
[INFO]mavenjarplugin:2.4:jar(defaultjar)@myproject
[INFO]Buildingjar:/Users/developer/example/springbootexample/target/myproject0.0.1SNAPSHOT.jar
[INFO]
[INFO]springbootmavenplugin:2.0.0.BUILDSNAPSHOT:repackage(default)@myproject
[INFO]
[INFO]BUILDSUCCESS
[INFO]
If you look in the target directory you should see myproject0.0.1SNAPSHOT.jar . The le should be around 10 MB in size. If you want to
peek inside, you can use jartvf :
$jartvftarget/myproject0.0.1SNAPSHOT.jar
You should also see a much smaller le named myproject0.0.1SNAPSHOT.jar.original in the target directory. This is the original jar
le that Maven created before it was repackaged by Spring Boot.
To run that application, use the javajar command:
$javajartarget/myproject0.0.1SNAPSHOT.jar
._________
/\\/___'_____(_)______\\\\
(()\___|'_|'_||'_\/_`|\\\\
\\/___)||_)|||||||(_||))))
'|____|.__|_||_|_||_\__,|////
=========|_|==============|___/=/_/_/_/
::SpringBoot::(v2.0.0.BUILDSNAPSHOT)
..........
..........(logoutputhere)
..........
........StartedExamplein2.536seconds(JVMrunningfor2.864)
As before, to gracefully exit the application hit ctrlc .
12.What to read next

Hopefully this section has provided you with some of the Spring Boot basics, and got you on your way to writing your own applications. If youre
a task-oriented type of developer you might want to jump over to spring.io and check out some of the getting started guides that solve specic
How do I do that with Spring problems; we also have Spring Boot-specic How-to reference documentation.
The Spring Boot repository has also a bunch of samples you can run. The samples are independent of the rest of the code (that is you dont
need to build the rest to run or use the samples).
Otherwise, the next logical step is to read PartIII, Using Spring Boot. If youre really impatient, you could also jump ahead and read about
Spring Boot features.
PartIII.Using Spring Boot

This section goes into more detail about how you should use Spring Boot. It covers topics such as build systems, auto-conguration 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, will make your development process just a little
easier.
If youre just starting out with Spring Boot, you should probably read the Getting Started guide before diving into this section.
13.Build systems
It is strongly recommended that you choose a build system that supports dependency management, and one 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 will not be particularly well supported.
13.1Dependency management
Each release of Spring Boot provides a curated list of dependencies it supports. In practice, you do not need to provide a version for any of
these dependencies in your build conguration as Spring Boot is managing that for you. When you upgrade Spring Boot itself, these
dependencies will be upgraded as well in a consistent way.
You can still specify a version and override Spring Boots recommendations if you feel thats necessary.
The curated list contains all the spring modules that you can use with Spring Boot as well as a rened list of third party libraries. The list is
available as a standard Bills of Materials ( springbootdependencies ) and additional dedicated support for Maven and Gradle are available
as well.
Each release of Spring Boot is associated with a base version of the Spring Framework so we highly recommend you to not
specify its version on your own.
13.2Maven
Maven users can inherit from the springbootstarterparent project to obtain sensible defaults. The parent project provides the following
features:
Java 1.8 as the default compiler level.

UTF-8 source encoding.
A Dependency Management section, allowing you to omit <version> tags for common dependencies, inherited from the
springbootdependencies POM.
Sensible resource ltering.
Sensible plugin conguration (exec plugin, surere, Git commit ID, shade).
Sensible resource ltering for application.properties and application.yml including prole-specic les (e.g.
applicationfoo.properties and applicationfoo.yml )
On the last point: since the default cong les accept Spring style placeholders ( ${
} ) the Maven ltering is changed to use @..@
placeholders (you can override that with a Maven property resource.delimiter ).
13.2.1Inheriting the starter parent

To congure your project to inherit from the springbootstarterparent simply set the parent :
<!InheritdefaultsfromSpringBoot>
<parent>
</parent>
You should only need to specify the Spring Boot version number on this dependency. If you import additional starters, you can
safely omit the version number.
With that setup, you can also override individual dependencies by overriding a property in your own project. For instance, to upgrade to another
Spring Data release train youd add the following to your pom.xml .
<properties>
<springdatareleasetrain.version>FowlerSR2</springdatareleasetrain.version>
</properties>
Check the springbootdependencies pom for a list of supported properties.
13.2.2Using Spring Boot without the parent POM

Not everyone likes inheriting from the springbootstarterparent POM. You may have your own corporate standard parent that you need
to use, or you may just prefer to explicitly declare all your Maven conguration.
If you dont want to use the springbootstarterparent , you can still keep the benet of the dependency management (but not the plugin
management) by using a scope=import dependency:
<dependencyManagement>
<dependencies>
<dependency>
<!ImportdependencymanagementfromSpringBoot>
<artifactId>springbootdependencies</artifactId>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
That setup does not allow you to override individual dependencies using a property as explained above. To achieve the same result, youd need
to add an entry in the dependencyManagement of your project before the springbootdependencies entry. For instance, to upgrade to
another Spring Data release train youd add the following to your pom.xml .
<dependencyManagement>
<dependencies>
<!OverrideSpringDatareleasetrainprovidedbySpringBoot>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>springdatareleasetrain</artifactId>
<version>FowlerSR2</version>
<type>pom</type>
</dependency>
<dependency>
<artifactId>springbootdependencies</artifactId>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
In the example above, we specify a BOM but any dependency type can be overridden that way.
13.2.3Using the Spring Boot Maven plugin

Spring Boot includes a Maven plugin that can package the project as an executable jar. Add the plugin to your <plugins> section if you want
to use it:
<build>
<plugins>
<plugin>
</plugin>
</plugins>
</build>
If you use the Spring Boot starter parent pom, you only need to add the plugin, there is no need for to congure it unless you want
to change the settings dened in the parent.
13.3Gradle
Gradle users can directly import starters in their dependencies section. Unlike Maven, there is no super parent to import to share some
conguration.
repositories{
maven{url"http://repo.spring.io/snapshot"}
maven{url"http://repo.spring.io/milestone"}
}
dependencies{
compile("org.springframework.boot:springbootstarterweb:2.0.0.BUILDSNAPSHOT")
}
The springbootgradleplugin is also available and provides tasks to create executable jars and run projects from source. It also
provides dependency management that, among other capabilities, allows you to omit the version number for any dependencies that are
managed by Spring Boot:
buildscript{
repositories{
jcenter()
}
dependencies{
classpath'org.springframework.boot:springbootgradleplugin:2.0.0.BUILDSNAPSHOT'
}
}
applyplugin:'java'
repositories{
jcenter()
}
dependencies{
testCompile("org.springframework.boot:springbootstartertest")
}
13.4Ant
It is possible to build a Spring Boot project using Apache Ant+Ivy. The springbootantlib AntLib module is also available to help Ant
create executable jars.
To declare dependencies a typical ivy.xml le will look something like this:
<ivymoduleversion="2.0">
<infoorganisation="org.springframework.boot"module="springbootsampleant"/>
<configurations>
<confname="compile"description="everythingneededtocompilethismodule"/>
<confname="runtime"extends="compile"description="everythingneededtorunthismodule"/>
</configurations>
<dependencies>
<dependencyorg="org.springframework.boot"name="springbootstarter"
rev="${springboot.version}"conf="compile"/>
</dependencies>
</ivymodule>
A typical build.xml will look like this:
<project
xmlns:ivy="antlib:org.apache.ivy.ant"
xmlns:springboot="antlib:org.springframework.boot.ant"
name="myapp"default="build">
<propertyname="springboot.version"value="1.3.0.BUILDSNAPSHOT"/>
<targetname="resolve"description=">retrievedependencieswithivy">
<ivy:retrievepattern="lib/[conf]/[artifact][type][revision].[ext]"/>
</target>
<targetname="classpaths"depends="resolve">
<pathid="compile.classpath">
<filesetdir="lib/compile"includes="*.jar"/>
</path>
</target>
<targetname="init"depends="classpaths">
<mkdirdir="build/classes"/>
</target>
<targetname="compile"depends="init"description="compile">
<javacsrcdir="src/main/java"destdir="build/classes"classpathref="compile.classpath"/>
</target>
<targetname="build"depends="compile">
<springboot:exejardestfile="build/myapp.jar"classes="build/classes">
<springboot:lib>
<filesetdir="lib/runtime"/>
</springboot:lib>
</springboot:exejar>
</target>
</project>
See the Section83.10, Build an executable archive from Ant without using spring-boot-antlib How-to if you dont want to use
the springbootantlib module.
13.5Starters
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 technology 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, just include the springbootstarterdatajpa dependency in your
project, and you are good to go.
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.
Whats in a name
All ofcial starters follow a similar naming pattern; springbootstarter* , where * is a particular type of application. This naming
structure is intended to help when you need to nd a starter. The Maven integration in many IDEs allow you to search dependencies by
name. For example, with the appropriate Eclipse or STS plugin installed, you can simply hit ctrlspace 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 springboot as it is reserved for ofcial
Spring Boot artifacts. A third-party starter for acme will be typically named acmespringbootstarter .
The following application starters are provided by Spring Boot under the org.springframework.boot group:
Table13.1.Spring Boot application starters
Name Description Pom
springbootstarterthymeleaf Starter for building MVC web applications using Thymeleaf views Pom
springbootstarterdatacouchbase Starter for using Couchbase document-oriented database and Spring Pom
Data Couchbase
springbootstarterartemis Starter for JMS messaging using Apache Artemis Pom
springbootstarterwebservices Starter for using Spring Web Services Pom
springbootstartermail Starter for using Java Mail and Spring Frameworks email sending Pom
support
springbootstarterdataredis Starter for using Redis key-value data store with Spring Data Redis and Pom
the Jedis client
springbootstarterdatamongodbreactive Starter for using MongoDB document-oriented database and Spring Pom
Data MongoDB Reactive
springbootstarterweb Starter for building web, including RESTful, applications using Spring Pom
MVC. Uses Tomcat as the default embedded container
springbootstarteractivemq Starter for JMS messaging using Apache ActiveMQ Pom
springbootstarterdataelasticsearch Starter for using Elasticsearch search and analytics engine and Spring Pom
Data Elasticsearch
springbootstarterintegration Starter for using Spring Integration Pom
springbootstartertest Starter for testing Spring Boot applications with libraries including JUnit, Pom
Hamcrest and Mockito
springbootstarterwebflux Starter for building WebFlux applications using Spring Frameworks Pom
Reactive Web support
springbootstarterjdbc Starter for using JDBC with the Tomcat JDBC connection pool Pom
springbootstartermobile Starter for building web applications using Spring Mobile Pom
springbootstartervalidation Starter for using Java Bean Validation with Hibernate Validator Pom
springbootstarterhateoas Starter for building hypermedia-based RESTful web application with Pom
Spring MVC and Spring HATEOAS
springbootstarterjersey Starter for building RESTful web applications using JAX-RS and Jersey. Pom
An alternative to springbootstarterweb
springbootstarterdataneo4j Starter for using Neo4j graph database and Spring Data Neo4j Pom
springbootstarterdataldap Starter for using Spring Data LDAP Pom
springbootstarterwebsocket Starter for building WebSocket applications using Spring Frameworks Pom
WebSocket support
springbootstarteraop Starter for aspect-oriented programming with Spring AOP and AspectJ Pom
springbootstarteramqp Starter for using Spring AMQP and Rabbit MQ Pom
springbootstarterdatacassandra Starter for using Cassandra distributed database and Spring Data Pom
Cassandra
springbootstartersocialfacebook Starter for using Spring Social Facebook Pom
springbootstarterjtaatomikos Starter for JTA transactions using Atomikos Pom
springbootstartersecurity Starter for using Spring Security Pom
springbootstartermustache Starter for building MVC web applications using Mustache views Pom
springbootstarterdatajpa Starter for using Spring Data JPA with Hibernate Pom
springbootstarter Core starter, including auto-conguration support, logging and YAML Pom
springbootstartergroovytemplates Starter for building MVC web applications using Groovy Templates Pom
views
springbootstarterfreemarker Starter for building MVC web applications using FreeMarker views Pom
springbootstarterbatch Starter for using Spring Batch Pom
springbootstartersociallinkedin Stater for using Spring Social LinkedIn Pom
springbootstartercache Starter for using Spring Frameworks caching support Pom
springbootstarterdatasolr Starter for using the Apache Solr search platform with Spring Data Solr Pom
springbootstarterdatamongodb Starter for using MongoDB document-oriented database and Spring Pom
Data MongoDB
springbootstarterjooq Starter for using jOOQ to access SQL databases. An alternative to Pom
springbootstarterdatajpa or springbootstarterjdbc
springbootstarterjtanarayana Spring Boot Narayana JTA Starter Pom
springbootstartercloudconnectors Starter for using Spring Cloud Connectors which simplies connecting Pom
to services in cloud platforms like Cloud Foundry and Heroku
springbootstarterjtabitronix Starter for JTA transactions using Bitronix Pom
springbootstartersocialtwitter Starter for using Spring Social Twitter Pom
springbootstarterdatarest Starter for exposing Spring Data repositories over REST using Spring Pom
Data REST
In addition to the application starters, the following starters can be used to add production ready features:
Table13.2.Spring Boot production starters
springbootstarteractuator Starter for using Spring Boots Actuator which provides production ready features to Pom
help you monitor and manage your application
Finally, Spring Boot also includes some starters that can be used if you want to exclude or swap specic technical facets:
Table13.3.Spring Boot technical starters
springbootstarterundertow Starter for using Undertow as the embedded servlet container. An alternative to Pom
springbootstartertomcat
springbootstarterjetty Starter for using Jetty as the embedded servlet container. An alternative to Pom
springbootstartertomcat
springbootstarterreactornetty Starter for using Reactor Netty as the embedded reactive HTTP server. Pom
springbootstarterlogging Starter for logging using Logback. Default logging starter Pom
springbootstartertomcat Starter for using Tomcat as the embedded servlet container. Default servlet Pom
container starter used by springbootstarterweb
springbootstarterlog4j2 Starter for using Log4j2 for logging. An alternative to Pom

springbootstarterlogging
For a list of additional community contributed starters, see the README le in the springbootstarters module on GitHub.
14.Structuring your code

Spring Boot does not require any specic code layout to work, however, there are some best practices that help.
14.1Using the default package

When a class doesnt 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 @ComponentScan ,
@EntityScan or @SpringBootApplication annotations, since every class from every jar, will be read.
We recommend that you follow Javas recommended package naming conventions and use a reversed domain name (for
example, com.example.project ).
14.2Locating the main application class

We generally recommend that you locate your main application class in a root package above other classes. The
@EnableAutoConfiguration annotation is often placed on your main class, and it implicitly denes a base search package for certain items.
For example, if you are writing a JPA application, the package of the @EnableAutoConfiguration annotated class will be used to search for
@Entity items.
Using a root package also allows the @ComponentScan annotation to be used without needing to specify a basePackage attribute. You can
also use the @SpringBootApplication annotation if your main class is in the root package.
Here is a typical layout:
com
+example
+myproject
+Application.java
|
+domain
|+Customer.java
|+CustomerRepository.java
|
+service
|+CustomerService.java
|
+web
+CustomerController.java
The Application.java le would declare the main method, along with the basic @Configuration .
packagecom.example.myproject;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.EnableAutoConfiguration;
importorg.springframework.context.annotation.ComponentScan;
importorg.springframework.context.annotation.Configuration;
@Configuration
@ComponentScan
publicclassApplication{
publicstaticvoidmain(String[]args){
SpringApplication.run(Application.class,args);
}
15.Conguration classes
Spring Boot favors Java-based conguration. Although it is possible to call SpringApplication.run() with an XML source, we generally
recommend that your primary source is a @Configuration class. Usually the class that denes the main method is also a good candidate as
the primary @Configuration .
Many Spring conguration examples have been published on the Internet that use XML conguration. Always try to use the
equivalent Java-based conguration if possible. Searching for enable* annotations can be a good starting point.
15.1Importing additional conguration classes

You dont need to put all your @Configuration into a single class. The @Import annotation can be used to import additional conguration
classes. Alternatively, you can use @ComponentScan to automatically pick up all Spring components, including @Configuration classes.
15.2Importing XML conguration

If you absolutely must use XML based conguration, we recommend that you still start with a @Configuration class. You can then use an
additional @ImportResource annotation to load XML conguration les.
16.Auto-conguration
Spring Boot auto-conguration attempts to automatically congure 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 congured any database connection beans, then we will auto-
congure an in-memory database.
You need to opt-in to auto-conguration by adding the @EnableAutoConfiguration or @SpringBootApplication annotations to one of your
@Configuration classes.
You should only ever add one @EnableAutoConfiguration annotation. We generally recommend that you add it to your primary
@Configuration class.
16.1Gradually replacing auto-conguration

Auto-conguration is noninvasive, at any point you can start to dene your own conguration to replace specic parts of the auto-conguration.
For example, if you add your own DataSource bean, the default embedded database support will back away.
If you need to nd out what auto-conguration is currently being applied, and why, start your application with the debug switch. This will
enable debug logs for a selection of core loggers and log an auto-conguration report to the console.
16.2Disabling specic auto-conguration

If you nd that specic auto-congure classes are being applied that you dont want, you can use the exclude attribute of
@EnableAutoConfiguration to disable them.
importorg.springframework.boot.autoconfigure.*;
importorg.springframework.boot.autoconfigure.jdbc.*;
importorg.springframework.context.annotation.*;
@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
publicclassMyConfiguration{
}
If the class is not on the classpath, you can use the excludeName attribute of the annotation and specify the fully qualied name instead.
Finally, you can also control the list of auto-conguration classes to exclude via the spring.autoconfigure.exclude property.
You can dene exclusions both at the annotation level and using the property.
17.Spring Beans and dependency injection

You are free to use any of the standard Spring Framework techniques to dene your beans and their injected dependencies. For simplicity, we
often nd that using @ComponentScan to nd your beans, in combination with @Autowired constructor injection works well.
If you structure your code as suggested above (locating your application class in a root package), you can add @ComponentScan without any
arguments. All of your application components ( @Component , @Service , @Repository , @Controller etc.) will be automatically registered
as Spring Beans.
Here is an example @Service Bean that uses constructor injection to obtain a required RiskAssessor bean.
packagecom.example.service;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.stereotype.Service;
@Service
publicclassDatabaseAccountServiceimplementsAccountService{
privatefinalRiskAssessorriskAssessor;
@Autowired
publicDatabaseAccountService(RiskAssessorriskAssessor){
this.riskAssessor=riskAssessor;
}
//...
Notice how using constructor injection allows the riskAssessor eld to be marked as final , indicating that it cannot be
subsequently changed.
18.Using the @SpringBootApplication annotation

Many Spring Boot developers always have their main class annotated with @Configuration , @EnableAutoConfiguration and
@ComponentScan . Since these annotations are so frequently used together (especially if you follow the best practices above), Spring Boot
provides a convenient @SpringBootApplication alternative.
The @SpringBootApplication annotation is equivalent to using @Configuration , @EnableAutoConfiguration and @ComponentScan

with their default attributes:
packagecom.example.myproject;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication//sameas@Configuration@EnableAutoConfiguration@ComponentScan
}
@SpringBootApplication also provides aliases to customize the attributes of @EnableAutoConfiguration and

@ComponentScan .
19.Running your application

One of the biggest advantages of packaging your application as jar and using an embedded HTTP server is that you can run your application as
you would any other. Debugging Spring Boot applications is also easy; you dont need any special IDE plugins or extensions.
This section only covers jar based packaging, If you choose to package your application as a war le you should refer to your
server and IDE documentation.
19.1Running from an IDE

You can run a Spring Boot application from your IDE as a simple Java application, however, rst you will need to import your project. Import
steps will vary depending on your IDE and build system. Most IDEs can import Maven projects directly, for example Eclipse users can select
Import ExistingMavenProjects from the File menu.
If you cant directly import your project into your IDE, you may be able to generate IDE metadata 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 will see a Port already in use error. STS users can use the Relaunch button
rather than Run to ensure that any existing instance is closed.
19.2Running 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 javajar . For example:
$javajartarget/myproject0.0.1SNAPSHOT.jar
It is also possible to run a packaged application with remote debugging support enabled. This allows you to attach a debugger to your packaged
application:
$javaXdebugXrunjdwp:server=y,transport=dt_socket,address=8000,suspend=n\
jartarget/myproject0.0.1SNAPSHOT.jar
19.3Using the Maven plugin

The Spring Boot Maven plugin includes a run goal which can be used to quickly compile and run your application. Applications run in an
exploded form just like in your IDE.
$mvnspringboot:run
You might also want to use the useful operating system environment variable:
$exportMAVEN_OPTS=Xmx1024m
19.4Using the Gradle plugin

The Spring Boot Gradle plugin also includes a bootRun task which can be used to run your application in an exploded form. The bootRun
task is added whenever you import the springbootgradleplugin :
$gradlebootRun
You might also want to use this useful operating system environment variable:
$exportJAVA_OPTS=Xmx1024m
19.5Hot swapping
Since Spring Boot applications are just 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 or the Spring Loaded project can be used. The
springbootdevtools module also includes support for quick application restarts.
See the Chapter20, Developer tools section below and the Hot swapping How-to for details.
20.Developer tools
Spring Boot includes an additional set of tools that can make the application development experience a little more pleasant. The
springbootdevtools module can be included in any project to provide additional development-time features. To include devtools support,
simply add the module dependency to your build:
Maven.
<dependencies>
<dependency>
<artifactId>springbootdevtools</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
Gradle.
dependencies{
compile("org.springframework.boot:springbootdevtools")
}
Developer tools are automatically disabled when running a fully packaged application. If your application is launched using
javajar or if its started using a special classloader, then it is considered a production application. Flagging the dependency
as optional is a best practice that prevents devtools from being transitively applied to other modules using your project. Gradle
does not support optional dependencies out-of-the-box so you may want to have a look to the propdepsplugin in the
meantime.
repackaged archives do not contain devtools by default. If you want to use certain remote devtools feature, youll need to disable
the excludeDevtools build property to include it. The property is supported with both the Maven and Gradle plugins.
20.1Property defaults
Several of the libraries supported by Spring Boot use caches to improve performance. For example, template engines will cache compiled
templates to avoid repeatedly parsing template les. Also, Spring MVC can add HTTP caching headers to responses when serving static
resources.
Whilst caching is very benecial 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 will disable those caching options by default.
Cache options are usually congured by settings in your application.properties le. For example, Thymeleaf offers the
spring.thymeleaf.cache property. Rather than needing to set these properties manually, the springbootdevtools module will
automatically apply sensible development-time conguration.
For a complete list of the properties that are applied see DevToolsPropertyDefaultsPostProcessor.
20.2Automatic restart
Applications that use springbootdevtools will automatically restart whenever les 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 folder will
be 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 modied le will cause the classpath to be updated
and trigger a restart. In IntelliJ IDEA, building the project ( BuildMakeProject ) will have the same effect.
You can also start your application via the supported build plugins (i.e. Maven and Gradle) as long as forking is enabled since
DevTools need an isolated application classloader to operate properly. Gradle and Maven do that by default when they detect
DevTools on the classpath.
Automatic restart works very well when used with LiveReload. See below for details. If you use JRebel automatic restarts will be
disabled in favor of dynamic class reloading. Other devtools features (such as LiveReload and property overrides) can still be
used.
DevTools relies on the application contexts shutdown hook to close it during a restart. It will not work correctly if you have
disabled the shutdown hook ( SpringApplication.setRegisterShutdownHook(false) ).
When deciding if an entry on the classpath should trigger a restart when it changes, DevTools automatically ignores projects
named springboot , springbootdevtools , springbootautoconfigure , springbootactuator , and
springbootstarter .
Restart vs Reload
The restart technology provided by Spring Boot works by using two classloaders. Classes that dont change (for example, those from
third-party jars) are loaded into a base classloader. Classes that youre 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 nd that restarts arent 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. Spring Loaded provides another option, however it doesnt support as many frameworks and it isnt commercially supported.
20.2.1Excluding resources
Certain resources dont necessarily need to trigger a restart when they are changed. For example, Thymeleaf templates can just be edited in-
place. By default changing resources in /METAINF/maven , /METAINF/resources , /resources , /static , /public or /templates will
not trigger a restart but will 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 would set the following:
spring.devtools.restart.exclude=static/**,public/**
if you want to keep those defaults and add additional exclusions, use the spring.devtools.restart.additionalexclude
property instead.
20.2.2Watching additional paths

You may want your application to be restarted or reloaded when you make changes to les that are not on the classpath. To do so, use the
spring.devtools.restart.additionalpaths property to congure additional paths to watch for changes. You can use the
spring.devtools.restart.exclude property described above to control whether changes beneath the additional paths will trigger a full
restart or just a live reload.
20.2.3Disabling restart
If you dont want to use the restart feature you can disable it using the spring.devtools.restart.enabled property. In most cases you can
set this in your application.properties (this will still initialize the restart classloader but it wont watch for le changes).
If you need to completely disable restart support, for example, because it doesnt work with a specic library, you need to set a System
property before calling SpringApplication.run(
) . For example:
System.setProperty("spring.devtools.restart.enabled","false");
SpringApplication.run(MyApp.class,args);
}
20.2.4Using a trigger le
If you work with an IDE that continuously compiles changed les, you might prefer to trigger restarts only at specic times. To do this you can
use a trigger le, which is a special le that must be modied when you want to actually trigger a restart check. Changing the le only triggers
the check and the restart will only occur if Devtools has detected it has to do something. The trigger le could be updated manually, or via an
IDE plugin.
To use a trigger le use the spring.devtools.restart.triggerfile property.
You might want to set spring.devtools.restart.triggerfile as a global setting so that all your projects behave in the
same way.
20.2.5Customizing the restart classloader

As described in the Restart vs Reload section above, restart functionality is implemented by using two classloaders. For most applications this
approach works well, however, sometimes it can cause classloading issues.
By default, any open project in your IDE will be loaded using the restart classloader, and any regular .jar le will be loaded using the base
classloader. If you work on a multi-module project, and not each module is imported into your IDE, you may need to customize things. To do this
you can create a METAINF/springdevtools.properties le.
The springdevtools.properties le can contain restart.exclude. and restart.include. prexed properties. 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 will be applied to the classpath.
For example:
restart.exclude.companycommonlibs=/mycorpcommon[\\w]+\.jar
restart.include.projectcommon=/mycorpmyproj[\\w]+\.jar
All property keys must be unique. As long as a property starts with restart.include. or restart.exclude. it will be
considered.
All METAINF/springdevtools.properties from the classpath will be loaded. You can package les inside your project, or in
the libraries that the project consumes.
20.2.6Known limitations
Restart functionality does not work well with objects that are deserialized using a standard ObjectInputStream . If you need to deserialize
data, you may need to use Springs ConfigurableObjectInputStream in combination with
Thread.currentThread().getContextClassLoader() .
Unfortunately, several third-party libraries deserialize without considering the context classloader. If you nd such a problem, you will need to
request a x with the original authors.
20.3LiveReload
The springbootdevtools 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 dont want to start the LiveReload server when your application runs you can set the spring.devtools.livereload.enabled property
to false .
You can only run one LiveReload server at a time. Before starting your application, ensure that no other LiveReload servers are
running. If you start multiple applications from your IDE, only the rst will have LiveReload support.
20.4Global settings
You can congure global devtools settings by adding a le named .springbootdevtools.properties to your $HOME folder (note that the
lename starts with .). Any properties added to this le will apply to all Spring Boot applications on your machine that use devtools. For
example, to congure restart to always use a trigger le, you would add the following:
~/.spring-boot-devtools.properties.
spring.devtools.reload.triggerfile=.reloadtrigger
20.5Remote applications
The Spring Boot developer tools are not just limited to local development. You can also use several features when running applications
remotely. Remote support is opt-in, to enable it you need to make sure that devtools is included in the repackaged archive:
<build>
<plugins>
<plugin>
<configuration>
<excludeDevtools>false</excludeDevtools>
</configuration>
</plugin>
</plugins>
</build>
Then you need to set a spring.devtools.remote.secret property, for example:
spring.devtools.remote.secret=mysecret
Enabling springbootdevtools on a remote application is a security risk. You should never enable support on a production
deployment.
Remote devtools support is provided in two parts; there is 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.
20.5.1Running 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 using the same classpath as the remote project that youre connecting
to. The non-option argument passed to the application should be the remote URL that you are connecting to.
For example, if you are using Eclipse or STS, and you have a project named myapp that youve deployed to Cloud Foundry, you would do the
following:
Select RunConfigurationsfrom the Run menu.

Create a new JavaApplication launch conguration.
Browse for the myapp project.
Use org.springframework.boot.devtools.RemoteSpringApplication as the main class.
Add https://myapp.cfapps.io to the Programarguments (or whatever your remote URL is).
A running remote client will look like this:
._________
/\\/___'_____(_)__________\\\\
(()\___|'_|'_||'_\/_`||_\_________||____\\\\
\\/___)||_)|||||||(_|[]::::::[]/_)'\/_\_/_)))))
'|____|.__|_||_|_||_\__,||_|_\___|_|_|_\___/\__\___|////
=========|_|==============|___/===================================/_/_/_/
::SpringBootRemote::2.0.0.BUILDSNAPSHOT
2015061018:25:06.632INFO14938[main]o.s.b.devtools.RemoteSpringApplication:StartingRemoteSpringApplication
2015061018:25:06.671INFO14938[main]s.c.a.AnnotationConfigApplicationContext:Refreshingorg.springframework.c
2015061018:25:07.043WARN14938[main]o.s.b.d.r.c.RemoteClientConfiguration:Theconnectiontohttp://localho
2015061018:25:07.074INFO14938[main]o.s.b.d.a.OptionalLiveReloadServer:LiveReloadserverisrunningon
2015061018:25:07.130INFO14938[main]o.s.b.devtools.RemoteSpringApplication:StartedRemoteSpringApplication
Because the remote client is using the same classpath as the real application it can directly read application properties. This is
how the spring.devtools.remote.secret property is read and passed to the server for authentication.
Its always advisable to use https:// as the connection protocol so that trafc is encrypted and passwords cannot be
intercepted.
If you need to use a proxy to access the remote application, congure the spring.devtools.remote.proxy.host and
spring.devtools.remote.proxy.port properties.
20.5.2Remote update
The remote client will monitor your application classpath for changes in the same way as the local restart. Any updated resource will be pushed
to the remote application and (if required) trigger a restart. This can be quite helpful if you are iterating on a feature that uses a cloud service
that you dont have locally. Generally remote updates and restarts are much quicker than a full rebuild and deploy cycle.
Files are only monitored when the remote client is running. If you change a le before starting the remote client, it wont be
pushed to the remote server.
20.5.3Remote debug tunnel

Java remote debugging is useful when diagnosing issues on a remote application. Unfortunately, its not always possible to enable remote
debugging when your application is deployed outside of your data center. Remote debugging can also be tricky to setup if you are using a
container based technology such as Docker.
To help work around these limitations, devtools supports tunneling of remote debug trafc over HTTP. The remote client provides a local server
on port 8000 that you can attach a remote debugger to. Once a connection is established, debug trafc is sent over HTTP to the remote
application. You can use the spring.devtools.remote.debug.localport property if you want to use a different port.
Youll need to ensure that your remote application is started with remote debugging enabled. Often this can be achieved by conguring
JAVA_OPTS . For example, with Cloud Foundry you can add the following to your manifest.yml :

env:
JAVA_OPTS:"XdebugXrunjdwp:server=y,transport=dt_socket,suspend=n"
Notice that you dont need to pass an address=NNNN option to Xrunjdwp . If omitted Java will simply pick a random free port.
Debugging a remote service over the Internet can be slow and you might need to increase timeouts in your IDE. For example, in
Eclipse you can select Java Debug from Preferencesand change the Debuggertimeout(ms) to a more suitable
value ( 60000 works well in most situations).
When using the remote debug tunnel with IntelliJ IDEA, all breakpoints must be congured to suspend the thread rather than the
VM. By default, breakpoints in IntelliJ IDEA suspend the entire VM rather than only suspending the thread that hit the breakpoint.
This has the unwanted side-effect of suspending the thread that manages the remote debug tunnel, causing your debugging
session to freeze. When using the remote debug tunnel with IntelliJ IDEA, all breakpoints should be congured to suspend the
thread rather than the VM. Please see IDEA-165769 for further details.
21.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
springbootactuator . See PartV, Spring Boot Actuator: Production-ready features for details.

You should now have good understanding of how you can use Spring Boot along with some best practices that you should follow. You can now
go on to learn about specic Spring Boot features in depth, or you could skip ahead and read about the production ready aspects of Spring
Boot.
PartIV.Spring Boot features
This section dives into the details of Spring Boot. Here you can learn about the key features that you will want to use and customize. If you
havent already, you might want to read the PartII, Getting started and PartIII, Using Spring Boot sections so that you have a good
grounding of the basics.
23.SpringApplication
The SpringApplication class provides a convenient way to bootstrap a Spring application that will be started from a main() method. In
many situations you can just delegate to the static SpringApplication.run method:
SpringApplication.run(MySpringConfiguration.class,args);
}
When your application starts you should see something similar to the following:
._________
/\\/___'_____(_)______\\\\
(()\___|'_|'_||'_\/_`|\\\\
\\/___)||_)|||||||(_||))))
'|____|.__|_||_|_||_\__,|////
=========|_|==============|___/=/_/_/_/
::SpringBoot::v2.0.0.BUILDSNAPSHOT
2013073100:08:16.117INFO56603[main]o.s.b.s.app.SampleApplication:StartingSampleApplicationv0.1.
2013073100:08:16.166INFO56603[main]ationConfigEmbeddedWebApplicationContext:Refreshingorg.springframework.b
2014030413:09:54.912INFO41370[main].t.TomcatEmbeddedServletContainerFactory:Serverinitializedwithport:80
2014030413:09:56.501INFO41370[main]o.s.b.s.app.SampleApplication:StartedSampleApplicationin2.9
By default INFO logging messages will be shown, including some relevant startup details such as the user that launched the application.
23.1Startup failure
If your application fails to start, registered FailureAnalyzers get a chance to provide a dedicated error message and a concrete action to x
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:
***************************
APPLICATIONFAILEDTOSTART
***************************
Description:
Embeddedservletcontainerfailedtostart.Port8080wasalreadyinuse.
Action:
Identifyandstoptheprocessthat'slisteningonport8080orconfigurethisapplicationtolistenonanotherport.
Spring Boot provides numerous FailureAnalyzer implementations and you can add your own very easily.
If no failure analyzers are able to handle the exception, you can still display the full auto-conguration 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.AutoConfigurationReportLoggingInitializer .
For instance, if you are running your application using javajar you can enable the debug property as follows:
$javajarmyproject0.0.1SNAPSHOT.jardebug
23.2Customizing the Banner

The banner that is printed on start up can be changed by adding a banner.txt le to your classpath, or by setting banner.location to the
location of such a le. If the le has an unusual encoding you can set banner.charset (default is UTF8 ). In addition to a text le, you can
also add a banner.gif , banner.jpg or banner.png image le to your classpath, or set a banner.image.location property. Images will
be converted into an ASCII art representation and printed above any text banner.
Inside your banner.txt le you can use any of the following placeholders:
Table23.1.Banner variables
Variable Description
${application.version} The version number of your application as declared in MANIFEST.MF . For example
ImplementationVersion:1.0 is printed as 1.0 .
${application.formattedversion} The version number of your application as declared in MANIFEST.MF formatted for
display (surrounded with brackets and prexed with v ). For example (v1.0) .
${springboot.version} The Spring Boot version that you are using. For example
2.0.0.BUILDSNAPSHOT .
${springboot.formattedversion} The Spring Boot version that you are using formatted for display (surrounded with
brackets and prexed with v ). For example (v2.0.0.BUILDSNAPSHOT) .
${Ansi.NAME} (or ${AnsiColor.NAME} , Where NAME is the name of an ANSI escape code. See AnsiPropertySource for
${AnsiBackground.NAME} , details.
${AnsiStyle.NAME} )
${application.title} The title of your application as declared in MANIFEST.MF . For example

ImplementationTitle:MyApp is printed as MyApp .
The SpringApplication.setBanner(
) method can be used if you want to generate a banner programmatically. Use the
org.springframework.boot.Banner interface and implement your own printBanner() method.
You can also use the spring.main.bannermode property to determine if the banner has to be printed on System.out ( console ), using the
congured logger ( log ) or not at all ( off ).
The printed banner will be registered as a singleton bean under the name springBootBanner .
YAML maps off to false so make sure to add quotes if you want to disable the banner in your application.
spring:
main:
bannermode:"off"
23.3Customizing SpringApplication
If the SpringApplication defaults arent to your taste you can instead create a local instance and customize it. For example, to turn off the
banner you would write:
SpringApplicationapp=newSpringApplication(MySpringConfiguration.class);
app.setBannerMode(Banner.Mode.OFF);
app.run(args);
}
The constructor arguments passed to SpringApplication are conguration sources for spring beans. In most cases these will
be references to @Configuration classes, but they could also be references to XML conguration or to packages that should be
scanned.
It is also possible to congure the SpringApplication using an application.properties le. See Chapter24, Externalized Conguration
for details.
For a complete list of the conguration options, see the SpringApplication Javadoc.
23.4Fluent builder API

If you need to build an ApplicationContext hierarchy (multiple contexts with a parent/child relationship), or if you just prefer using a uent
builder API, you can use the SpringApplicationBuilder .
The SpringApplicationBuilder allows you to chain together multiple method calls, and includes parent and child methods that allow
you to create a hierarchy.
For example:
newSpringApplicationBuilder()
.sources(Parent.class)
.child(Application.class)
.bannerMode(Banner.Mode.OFF)
.run(args);
There are some restrictions when creating an ApplicationContext hierarchy, e.g. Web components must be contained within
the child context, and the same Environment will be used for both parent and child contexts. See the
SpringApplicationBuilder Javadoc for full details.
23.5Application events and listeners

In addition to the usual Spring Framework events, such as ContextRefreshedEvent , a SpringApplication sends some additional
application events.
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 via the SpringApplication.addListeners(
) or
) methods.
SpringApplicationBuilder.listeners(
If you want those listeners to be registered automatically regardless of the way the application is created you can add a
METAINF/spring.factories le to your project and reference your listener(s) using the
org.springframework.context.ApplicationListener key.
org.springframework.context.ApplicationListener=com.example.project.MyListener
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 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 ApplicationPreparedEvent is sent just before the refresh is started, but after bean denitions have been loaded.
4. An ApplicationReadyEvent is sent after the refresh and any related callbacks have been processed to indicate the application is ready
to service requests.
5. An ApplicationFailedEvent is sent if there is an exception on startup.
You often wont need to use application events, but it can be handy to know that they exist. Internally, Spring Boot uses events to
handle a variety of tasks.
23.6Web environment
A SpringApplication will attempt to create the right type of ApplicationContext on your behalf. By default, an
AnnotationConfigApplicationContext or AnnotationConfigEmbeddedWebApplicationContext will be used, depending on whether
you are developing a web application or not.
The algorithm used to determine a web environment is fairly simplistic (based on the presence of a few classes). You can use
setWebEnvironment(booleanwebEnvironment) if you need to override the default.
It is also possible to take complete control of the ApplicationContext type that will be used by calling setApplicationContextClass(
).
It is often desirable to call setWebEnvironment(false) when using SpringApplication within a JUnit test.
23.7Accessing 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 nonoption arguments:
importorg.springframework.boot.*
importorg.springframework.beans.factory.annotation.*
importorg.springframework.stereotype.*
@Component
publicclassMyBean{
@Autowired
publicMyBean(ApplicationArgumentsargs){
booleandebug=args.containsOption("debug");
List<String>files=args.getNonOptionArgs();
//ifrunwith"debuglogfile.txt"debug=true,files=["logfile.txt"]
}
Spring Boot will also register a CommandLinePropertySource with the Spring Environment . This allows you to also inject
single application arguments using the @Value annotation.
23.8Using the ApplicationRunner or CommandLineRunner

If you need to run some specic 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 will be called just before
) completes.
SpringApplication.run(
The CommandLineRunner interfaces provides access to application arguments as a simple string array, whereas the ApplicationRunner
uses the ApplicationArguments interface discussed above.
importorg.springframework.boot.*
@Component
publicclassMyBeanimplementsCommandLineRunner{
publicvoidrun(String...args){
//Dosomething...
}
You can additionally implement the org.springframework.core.Ordered interface or use the

org.springframework.core.annotation.Order annotation if several CommandLineRunner or ApplicationRunner beans are dened
that must be called in a specic order.
23.9Application exit
Each SpringApplication will register a shutdown hook with the JVM to ensure that the ApplicationContext is closed 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 specic exit code
when the application ends.
23.10Admin 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 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 with key local.server.port .
Take care when enabling this feature as the MBean exposes a method to shutdown the application.
24.Externalized Conguration
Spring Boot allows you to externalize your conguration so you can work with the same application code in different environments. You can use
properties les, YAML les, environment variables and command-line arguments to externalize conguration. Property values can be injected
directly into your beans using the @Value annotation, accessed via Springs Environment abstraction or bound to structured objects via
@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:
1. Devtools global settings properties on your home directory ( ~/.springbootdevtools.properties when devtools is active).
2. @TestPropertySource annotations on your tests.
3. @SpringBootTest#properties annotation attribute on your tests.
4. Command line arguments.
5. Properties from SPRING_APPLICATION_JSON (inline JSON embedded in an environment variable or system property)
6. ServletConfig init parameters.
7. ServletContext init parameters.
8. JNDI attributes from java:comp/env .
9. Java System properties ( System.getProperties() ).
10. OS environment variables.
11. A RandomValuePropertySource that only has properties in random.* .
12. Prole-specic application properties outside of your packaged jar ( application{profile}.properties and YAML variants)
13. Prole-specic application properties packaged inside your jar ( application{profile}.properties and YAML variants)
14. Application properties outside of your packaged jar ( application.properties and YAML variants).
15. Application properties packaged inside your jar ( application.properties and YAML variants).
16. @PropertySource annotations on your @Configuration classes.
17. Default properties (specied using SpringApplication.setDefaultProperties ).
To provide a concrete example, suppose you develop a @Component that uses a name property:
importorg.springframework.beans.factory.annotation.*
@Component
publicclassMyBean{
@Value("${name}")
privateStringname;
//...
On your application classpath (e.g. inside your jar) you can have an application.properties that provides a sensible default property value
for name . When running in a new environment, an application.properties can be provided outside of your jar that overrides the name ;
and for one-off testing, you can launch with a specic command line switch (e.g. javajarapp.jarname="Spring" ).
The SPRING_APPLICATION_JSON properties can be supplied on the command line with an environment variable. For example in
a UN*X shell:
$SPRING_APPLICATION_JSON='{"foo":{"bar":"spam"}}'javajarmyapp.jar
In this example you will end up with foo.bar=spam in the Spring Environment . You can also supply the JSON as
spring.application.json in a System variable:
$javaDspring.application.json='{"foo":"bar"}'jarmyapp.jar
or command line argument:
$javajarmyapp.jarspring.application.json='{"foo":"bar"}'
or as a JNDI variable java:comp/env/spring.application.json .
24.1Conguring random values

The RandomValuePropertySource is useful for injecting random values (e.g. into secrets or test cases). It can produce integers, longs, uuids
or strings, e.g.
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]}
The random.int* syntax is OPENvalue(,max)CLOSE where the OPEN,CLOSE are any character and value,max are integers. If max is
provided then value is the minimum value and max is the maximum (exclusive).
24.2Accessing command line properties

By default SpringApplication will convert any command line option arguments (starting with --, e.g. server.port=9000 ) to a
property and add it to the Spring Environment . As mentioned above, command line properties always take precedence over other property
sources.
If you dont want command line properties to be added to the Environment you can disable them using
SpringApplication.setAddCommandLineProperties(false) .
24.3Application property les

SpringApplication will load properties from application.properties les in the following locations and add them to the Spring
Environment :
1. A /config subdirectory of the current directory.

2. The current directory
3. A classpath /config package
4. The classpath root
The list is ordered by precedence (properties dened in locations higher in the list override those dened in lower locations).
You can also use YAML ('.yml') les as an alternative to '.properties'.
If you dont like application.properties as the conguration le name you can switch to another by specifying a spring.config.name
environment property. You can also refer to an explicit location using the spring.config.location environment property (comma-separated
list of directory locations, or le paths).
$javajarmyproject.jarspring.config.name=myproject
or
$javajarmyproject.jarspring.config.location=classpath:/default.properties,classpath:/override.properties
spring.config.name and spring.config.location are used very early to determine which les have to be loaded so they
have to be dened as an environment property (typically OS env, system property or command line argument).
If spring.config.location contains directories (as opposed to les) they should end in / (and will be appended with the names generated
from spring.config.name before being loaded, including prole-specic le names). Files specied in spring.config.location are used
as-is, with no support for prole-specic variants, and will be overridden by any prole-specic properties.
The default search path classpath:,classpath:/config,file:,file:config/ is always used, irrespective of the value of
spring.config.location . This search path is ordered from lowest to highest precedence ( file:config/ wins). If you do specify your own
locations, they take precedence over all of the default locations and use the same lowest to highest precedence ordering. In that way you can
set up default values for your application in application.properties (or whatever other basename you choose with
spring.config.name ) and override it at runtime with a different le, keeping the defaults.
If you use environment variables rather than system properties, most operating systems disallow period-separated key names,
but you can use underscores instead (e.g. SPRING_CONFIG_NAME instead of spring.config.name ).
If you are running in a container then JNDI properties (in java:comp/env ) or servlet context initialization parameters can be
used instead of, or as well as, environment variables or system properties.
24.4Prole-specic properties
In addition to application.properties les, prole-specic properties can also be dened using the naming convention
application{profile}.properties . The Environment has a set of default proles (by default [default] ) which are used if no active
proles are set (i.e. if no proles are explicitly activated then properties from applicationdefault.properties are loaded).
Prole-specic properties are loaded from the same locations as standard application.properties , with prole-specic les always
overriding the non-specic ones irrespective of whether the prole-specic les are inside or outside your packaged jar.
If several proles are specied, a last wins strategy applies. For example, proles specied by the spring.profiles.active property are
added after those congured via the SpringApplication API and therefore take precedence.
If you have specied any les in spring.config.location , prole-specic variants of those les will not be considered. Use
directories in`spring.cong.location` if you also want to also use prole-specic properties.
24.5Placeholders in properties
The values in application.properties are ltered through the existing Environment when they are used so you can refer back to
previously dened values (e.g. from System properties).
app.name=MyApp
app.description=${app.name}isaSpringBootapplication
You can also use this technique to create short variants of existing Spring Boot properties. See the Section71.4, Use short
command line arguments how-to for details.
24.6Using YAML instead of Properties

YAML is a superset of JSON, and as such is a very convenient format for specifying hierarchical conguration data. The SpringApplication
class will automatically support YAML as an alternative to properties whenever you have the SnakeYAML library on your classpath.
If you use Starters SnakeYAML will be automatically provided via springbootstarter .
24.6.1Loading YAML
Spring Framework provides two convenient classes that can be used to load YAML documents. The YamlPropertiesFactoryBean will load
YAML as Properties and the YamlMapFactoryBean will load YAML as a Map .
For example, the following YAML document:
environments:
dev:
url:http://dev.bar.com
name:DeveloperSetup
prod:
url:http://foo.bar.com
name:MyCoolApp
Would be transformed into these properties:
environments.dev.url=http://dev.bar.com
environments.dev.name=DeveloperSetup
environments.prod.url=http://foo.bar.com
environments.prod.name=MyCoolApp
YAML lists are represented as property keys with [index] dereferencers, for example this YAML:
my:
servers:
dev.bar.com
foo.bar.com
Would be transformed into these properties:
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com
To bind to properties like that using the Spring DataBinder utilities (which is what @ConfigurationProperties does) you need to have a
property in the target bean of type java.util.List (or Set ) and you either need to provide a setter, or initialize it with a mutable value, e.g.
this will bind to the properties above
@ConfigurationProperties(prefix="my")
publicclassConfig{
privateList<String>servers=newArrayList<String>();
publicList<String>getServers(){
returnthis.servers;
}
}
24.6.2Exposing YAML as properties in the Spring Environment

The YamlPropertySourceLoader class can be used to expose YAML as a PropertySource in the Spring Environment . This allows you to
use the familiar @Value annotation with placeholders syntax to access YAML properties.
24.6.3Multi-prole YAML documents

You can specify multiple prole-specic YAML documents in a single le by using a spring.profiles key to indicate when the document
applies. For example:
server:
address:192.168.1.100

spring:
profiles:development
server:
address:127.0.0.1

spring:
profiles:production
server:
address:192.168.1.120
In the example above, the server.address property will be 127.0.0.1 if the development prole is active. If the development and
production proles are not enabled, then the value for the property will be 192.168.1.100 .
The default proles are activated if none are explicitly active when the application context starts. So in this YAML we set a value for
security.user.password that is only available in the "default" prole:
server:
port:8000

spring:
profiles:default
security:
user:
password:weak
whereas in this example, the password is always set because it isnt attached to any prole, and it would have to be explicitly reset in all other
proles as necessary:
server:
port:8000
security:
user:
password:weak
Spring proles designated using the "spring.proles" element may optionally be negated using the ! character. If both negated and non-
negated proles are specied for a single document, at least one non-negated prole must match and no negated proles may match.
24.6.4YAML shortcomings
YAML les cant be loaded via the @PropertySource annotation. So in the case that you need to load values that way, you need to use a
properties le.
24.6.5Merging YAML lists

As we have seen above, any YAML content is ultimately transformed to properties. That process may be counter intuitive when overriding list
properties via a prole.
For example, assume a MyPojo object with name and description attributes that are null by default. Lets expose a list of MyPojo from
FooProperties :
@ConfigurationProperties("foo")
publicclassFooProperties{
privatefinalList<MyPojo>list=newArrayList<>();
publicList<MyPojo>getList(){
returnthis.list;
}
Consider the following conguration:
foo:
list:
name:myname
description:mydescription

spring:
profiles:dev
foo:
list:
name:myanothername
If the dev prole isnt active, FooProperties.list will contain one MyPojo entry as dened above. If the dev prole is enabled however,
the list will still only contain one entry (with name my another name and description null ). This conguration will not add a second
MyPojo instance to the list, and it wont merge the items.
When a collection is specied in multiple proles, the one with highest priority is used (and only that one):
foo:
list:
name:myname
description:mydescription
name:anothername
description:anotherdescription

spring:
profiles:dev
foo:
list:
name:myanothername
In the example above, considering that the dev prole is active, FooProperties.list will contain one MyPojo entry (with name my another
name and description null ).
24.7Type-safe Conguration Properties

Using the @Value("${property}") annotation to inject conguration 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 allows
strongly typed beans to govern and validate the conguration of your application.
packagecom.example;
importjava.net.InetAddress;
importjava.util.ArrayList;
importjava.util.Collections;
importjava.util.List;
importorg.springframework.boot.context.properties.ConfigurationProperties;
privatebooleanenabled;
privateInetAddressremoteAddress;
privatefinalSecuritysecurity=newSecurity();
publicbooleanisEnabled(){...}
publicvoidsetEnabled(booleanenabled){...}
publicInetAddressgetRemoteAddress(){...}
publicvoidsetRemoteAddress(InetAddressremoteAddress){...}
publicSecuritygetSecurity(){...}
publicstaticclassSecurity{
privateStringusername;
privateStringpassword;
privateList<String>roles=newArrayList<>(Collections.singleton("USER"));
publicStringgetUsername(){...}
publicvoidsetUsername(Stringusername){...}
publicStringgetPassword(){...}
publicvoidsetPassword(Stringpassword){...}
publicList<String>getRoles(){...}
publicvoidsetRoles(List<String>roles){...}
}
}
The POJO above denes the following properties:
foo.enabled , false by default

foo.remoteaddress , with a type that can be coerced from String
foo.security.username , with a nested "security" whose name is determined by the name of the property. In particular the return type is
not used at all there and could have been SecurityProperties
foo.security.password
foo.security.roles , with a collection of String
Getters and setters are usually mandatory, since binding is via standard Java Beans property descriptors, just like in Spring MVC.
There are cases where a setter may be omitted:
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 either accessed via an index (typically with YAML) or 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 example above)
If nested POJO properties are initialized (like the Security eld in the example above), a setter is not required. If you want
the binder to create the instance on-the-y using its default constructor, you will need a setter.
Some people use Project Lombok to add getters and setters automatically. Make sure that Lombok doesnt generate any
particular constructor for such type as it will be used automatically by the container to instantiate the object.
See also the differences between @Value and @ConfigurationProperties .
You also need to list the properties classes to register in the @EnableConfigurationProperties annotation:
@Configuration
@EnableConfigurationProperties(FooProperties.class)
}
When @ConfigurationProperties bean is registered that way, the bean will have a conventional name: <prefix><fqn> ,
where <prefix> is the environment key prex specied in the @ConfigurationProperties annotation and <fqn> the fully
qualied name of the bean. If the annotation does not provide any prex, only the fully qualied name of the bean is used.
The bean name in the example above will be foocom.example.FooProperties .
Even if the conguration above will create a regular bean for FooProperties , we recommend that @ConfigurationProperties only deal
with the environment and in particular does not inject other beans from the context. Having said that, The
@EnableConfigurationProperties annotation is also automatically applied to your project so that any existing bean annotated with
@ConfigurationProperties will be congured from the Environment . You could shortcut MyConfiguration above by making sure
FooProperties is a already a bean:
@Component
@ConfigurationProperties(prefix="foo")
//...seeabove
This style of conguration works particularly well with the SpringApplication external YAML conguration:
#application.yml
foo:
remoteaddress:192.168.1.1
security:
username:foo
roles:
USER
ADMIN
#additionalconfigurationasrequired
To work with @ConfigurationProperties beans you can just inject them in the same way as any other bean.
@Service
publicclassMyService{
privatefinalFooPropertiesproperties;
@Autowired
publicMyService(FooPropertiesproperties){
this.properties=properties;
}
//...
@PostConstruct
publicvoidopenConnection(){
Serverserver=newServer(this.properties.getRemoteAddress());
//...
}
Using @ConfigurationProperties also allows you to generate meta-data les that can be used by IDEs to offer auto-
completion for your own keys, see the AppendixB, Conguration meta-data appendix for details.
24.7.1Third-party conguration
As well as using @ConfigurationProperties to annotate a class, you can also use it on public @Bean methods. This can be particularly
useful when you want to bind properties to third-party components that are outside of your control.
To congure a bean from the Environment properties, add @ConfigurationProperties to its bean registration:
@ConfigurationProperties(prefix="bar")
@Bean
publicBarComponentbarComponent(){
...
}
Any property dened with the bar prex will be mapped onto that BarComponent bean in a similar manner as the FooProperties example
above.
24.7.2Relaxed binding
Spring Boot uses some relaxed rules for binding Environment properties to @ConfigurationProperties beans, so there doesnt need to be
an exact match between the Environment property name and the bean property name. Common examples where this is useful include
dashed separated (e.g. contextpath binds to contextPath ), and capitalized (e.g. PORT binds to port ) environment properties.
For example, given the following @ConfigurationProperties class:
@ConfigurationProperties(prefix="person")
publicclassOwnerProperties{
privateStringfirstName;
publicStringgetFirstName(){
returnthis.firstName;
}
publicvoidsetFirstName(StringfirstName){
this.firstName=firstName;
}
The following properties names can all be used:
Table24.1.relaxed binding
Property Note
person.firstName Standard camel case syntax.
person.firstname Dashed notation, recommended for use in .properties and .yml les.
person.first_name Underscore notation, alternative format for use in .properties and .yml les.
PERSON_FIRST_NAME Upper case format. Recommended when using a system environment variables.
24.7.3Properties conversion
Spring will attempt 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 bean id conversionService ) or custom property
editors (via a CustomEditorConfigurer bean) or custom Converters (with bean denitions annotated as
@ConfigurationPropertiesBinding ).
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
want to rename your custom ConversionService if its not required for conguration keys coercion and only rely on custom
converters qualied with @ConfigurationPropertiesBinding .
24.7.4@CongurationProperties Validation
Spring Boot will attempt to validate @ConfigurationProperties classes whenever they are annotated with Springs @Validated annotation.
You can use JSR-303 javax.validation constraint annotations directly on your conguration class. Simply ensure that a compliant JSR-303
implementation is on your classpath, then add constraint annotations to your elds:
@ConfigurationProperties(prefix="foo")
@Validated
@NotNull
//...gettersandsetters
In order to validate values of nested properties, you must annotate the associated eld as @Valid to trigger its validation. For example,
building upon the above FooProperties example:
@ConfigurationProperties(prefix="connection")
@Validated
@NotNull
@Valid
privatefinalSecuritysecurity=newSecurity();
publicstaticclassSecurity{
@NotEmpty
publicStringusername;
You can also add a custom Spring Validator by creating a bean denition called configurationPropertiesValidator . The @Bean
method should be declared static . The conguration properties validator is created very early in the applications lifecycle and declaring the
@Bean method as static allows the bean to be created without having to instantiate the @Configuration class. This avoids any problems that
may be caused by early instantiation. There is a property validation sample so you can see how to set things up.
The springbootactuator module includes an endpoint that exposes all @ConfigurationProperties beans. Simply point
your web browser to /configprops or use the equivalent JMX endpoint. See the Production ready features. section for details.
24.7.5@CongurationProperties vs. @Value
@Value is a core container feature and it does not provide the same features as type-safe Conguration Properties. The table below
summarizes the features that are supported by @ConfigurationProperties and @Value :
Feature @ConfigurationProperties @Value
Relaxed binding Yes No
Meta-data support Yes No
SpEL evaluation No Yes
If you dene a set of conguration keys for your own components, we recommend you to group them in a POJO annotated with
@ConfigurationProperties . Please also be aware that since @Value does not support relaxed binding, it isnt a great candidate if you need
to provide the value using environment variables.
Finally, while you can write a SpEL expression in @Value , such expressions are not processed from Application property les.
25.Proles
Spring Proles provide a way to segregate parts of your application conguration and make it only available in certain environments. Any
@Component or @Configuration can be marked with @Profile to limit when it is loaded:
@Configuration
@Profile("production")
publicclassProductionConfiguration{
//...
In the normal Spring way, you can use a spring.profiles.active Environment property to specify which proles are active. You can
specify the property in any of the usual ways, for example you could include it in your application.properties :
spring.profiles.active=dev,hsqldb
or specify on the command line using the switch spring.profiles.active=dev,hsqldb .
25.1Adding active proles

The spring.profiles.active property follows the same ordering rules as other properties, the highest PropertySource will win. This
means that you can specify active proles in application.properties then replace them using the command line switch.
Sometimes it is useful to have prole-specic properties that add to the active proles rather than replace them. The
spring.profiles.include property can be used to unconditionally add active proles. The SpringApplication entry point also has a
Java API for setting additional proles (i.e. on top of those activated by the spring.profiles.active property): see the
setAdditionalProfiles() method.
For example, when an application with following properties is run using the switch spring.profiles.active=prod the proddb and
prodmq proles will also be activated:

my.property:fromyamlfile

spring.profiles:prod
spring.profiles.include:
proddb
prodmq
Remember that the spring.profiles property can be dened in a YAML document to determine when this particular document
is included in the conguration. See Section71.7, Change conguration depending on the environment for more details.
25.2Programmatically setting proles
You can programmatically set active proles by calling SpringApplication.setAdditionalProfiles(
) before your application runs. It is
also possible to activate proles using Springs ConfigurableEnvironment interface.
25.3Prole-specic conguration les

Prole-specic variants of both application.properties (or application.yml ) and les referenced via @ConfigurationProperties
are considered as les are loaded. See Section24.4, Prole-specic properties for details.
26.Logging
Spring Boot uses Commons Logging for all internal logging, but leaves the underlying log implementation open. Default congurations are
provided for Java Util Logging, Log4J2 and Logback. In each case loggers are pre-congured to use console output with optional le output
also available.
By default, If you use the Starters, Logback will be used for logging. Appropriate Logback routing is also included to ensure that dependent
libraries that use Java Util Logging, Commons Logging, Log4J or SLF4J will all work correctly.
There are a lot of logging frameworks available for Java. Dont worry if the above list seems confusing. Generally you wont need
to change your logging dependencies and the Spring Boot defaults will work just ne.
26.1Log format
The default log output from Spring Boot looks like this:
2014030510:57:51.112INFO45469[main]org.apache.catalina.core.StandardEngine:StartingServletEngine:Apache
2014030510:57:51.253INFO45469[oststartStop1]o.a.c.c.C.[Tomcat].[localhost].[/]:InitializingSpringembeddedWeb
2014030510:57:51.253INFO45469[oststartStop1]o.s.web.context.ContextLoader:RootWebApplicationContext:init
2014030510:57:51.698INFO45469[oststartStop1]o.s.b.c.e.ServletRegistrationBean:Mappingservlet:'dispatcherServ
2014030510:57:51.702INFO45469[oststartStop1]o.s.b.c.embedded.FilterRegistrationBean:Mappingfilter:'hiddenHttpMetho
The following items are output:
Date and TimeMillisecond 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 nameEnclosed in square brackets (may be truncated for console output).
Logger nameThis is usually the source class name (often abbreviated).
The log message.
Logback does not have a FATAL level (it is mapped to ERROR )
26.2Console output
The default log conguration will echo messages to the console as they are written. By default ERROR , WARN and INFO level messages are
logged. You can also enable a debug mode by starting your application with a debug ag.
$javajarmyapp.jardebug
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 congured to output more
information. Enabling the debug mode does not congure your application to log all messages with DEBUG level.
Alternatively, you can enable a trace mode by starting your application with a trace ag (or trace=true in your
application.properties ). This will enable trace logging for a selection of core loggers (embedded container, Hibernate schema generation
and the whole Spring portfolio).
26.2.1Color-coded output
If your terminal supports ANSI, color output will be used to aid readability. You can set spring.output.ansi.enabled to a supported value to
override the auto detection.
Color coding is congured using the %clr conversion word. In its simplest form the converter will color the output according to the log level, for
example:
%clr(%5p)
The mapping of log level to a color is as follows:
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:
%clr(%d{yyyyMMddHH:mm:ss.SSS}){yellow}
The following colors and styles are supported:
blue
cyan
faint
green
magenta
red
yellow
26.3File output
By default, Spring Boot will only log to the console and will not write log les. If you want to write log les in addition to the console output you
need to set a logging.file or logging.path property (for example in your application.properties ).
The following table shows how the logging.* properties can be used together:
Table26.1.Logging properties
logging.file logging.path Example Description
(none) (none) Console only logging.
Specic le (none) my.log Writes to the specied log le. Names can be an exact location or relative to the
current directory.
(none) Specic directory /var/log Writes spring.log to the specied directory. Names can be an exact location or
relative to the current directory.
Log les will rotate when they reach 10 MB and as with console output, ERROR , WARN and INFO level messages are logged by default.
The logging system is initialized early in the application lifecycle and as such logging properties will not be found in property les
loaded via @PropertySource annotations.
Logging properties are independent of the actual logging infrastructure. As a result, specic conguration keys (such as
logback.configurationFile for Logback) are not managed by spring Boot.
26.4Log Levels
All the supported logging systems can have the logger levels set in the Spring Environment (so for example in application.properties )
using logging.level.*=LEVEL where LEVEL is one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF. The root logger can be
congured using logging.level.root . Example application.properties :
logging.level.root=WARN
logging.level.org.springframework.web=DEBUG
logging.level.org.hibernate=ERROR
By default Spring Boot remaps Thymeleaf INFO messages so that they are logged at DEBUG level. This helps to reduce noise in
the standard log output. See LevelRemappingAppender for details of how you can apply remapping in your own conguration.
26.5Custom log conguration

The various logging systems can be activated by including the appropriate libraries on the classpath, and further customized by providing a
suitable conguration le in the root of the classpath, or in a location specied by the Spring Environment property logging.config .
You can force Spring Boot to use a particular logging system using the org.springframework.boot.logging.LoggingSystem system
property. The value should be the fully-qualied class name of a LoggingSystem implementation. You can also disable Spring Boots logging
conguration entirely by using a value of none .
Since logging is initialized before the ApplicationContext is created, it isnt possible to control logging from
@PropertySources in Spring @Configuration les. System properties and the conventional Spring Boot external
conguration les work just ne.)
Depending on your logging system, the following les will be loaded:
Logging System Customization
Logback logbackspring.xml , logbackspring.groovy , logback.xml or logback.groovy
Log4j2 log4j2spring.xml or log4j2.xml
JDK (Java Util Logging) logging.properties
When possible we recommend that you use the spring variants for your logging conguration (for example
logbackspring.xml rather than logback.xml ). If you use standard conguration locations, Spring cannot completely control
log initialization.
There are known classloading issues with Java Util Logging that cause problems when running from an executable jar. We
recommend that you avoid it if at all possible.
To help with the customization some other properties are transferred from the Spring Environment to System properties:
Spring Environment System Property Comments
logging.exceptionconversionword LOG_EXCEPTION_CONVERSION_WORD The conversion word thats used when logging

exceptions.
Spring Environment System Property Comments
logging.file LOG_FILE Used in default log conguration if dened.
logging.path LOG_PATH Used in default log conguration if dened.
logging.pattern.console CONSOLE_LOG_PATTERN The log pattern to use on the console (stdout). (Only
supported with the default logback setup.)
logging.pattern.file FILE_LOG_PATTERN The log pattern to use in a le (if LOG_FILE

enabled). (Only supported with the default logback
setup.)
logging.pattern.level LOG_LEVEL_PATTERN The format to use to render the log level (default
%5p ). (Only supported with the default logback
setup.)
PID PID The current process ID (discovered if possible and

when not already dened as an OS environment
variable).
All the logging systems supported can consult System properties when parsing their conguration les. See the default congurations in
springboot.jar for examples.
If you want to use a placeholder in a logging property, you should use Spring Boots syntax and not the syntax of the underlying
framework. Notably, if youre using Logback, you should use : as the delimiter between a property name and its default value
and not : .
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 will contain an MDC entry for "user" if it exists, e.g.
2015093012:30:04.031user:juergenINFO22174[nio8080exec0]demo.Controller
Handlingauthenticatedrequest
26.6Logback extensions
Spring Boot includes a number of extensions to Logback which can help with advanced conguration. You can use these extensions in your
logbackspring.xml conguration le.
You cannot use extensions in the standard logback.xml conguration le since its loaded too early. You need to either use
logbackspring.xml or dene a logging.config property.
The extensions cannot be used with Logbacks conguration scanning. If you attempt to do so, making changes to the
conguration le will result in an error similar to one of the following being logged:
ERRORinch.qos.logback.core.joran.spi.Interpreter@4:71noapplicableactionfor[springProperty],currentElementPathis[[configu
ERRORinch.qos.logback.core.joran.spi.Interpreter@4:71noapplicableactionfor[springProfile],currentElementPathis[[configur
26.6.1Prole-specic conguration
The <springProfile> tag allows you to optionally include or exclude sections of conguration based on the active Spring proles. Prole
sections are supported anywhere within the <configuration> element. Use the name attribute to specify which prole accepts the
conguration. Multiple proles can be specied using a comma-separated list.
<springProfilename="staging">
<!configurationtobeenabledwhenthe"staging"profileisactive>
</springProfile>
<springProfilename="dev,staging">
<!configurationtobeenabledwhenthe"dev"or"staging"profilesareactive>
</springProfile>
<springProfilename="!production">
<!configurationtobeenabledwhenthe"production"profileisnotactive>
</springProfile>
26.6.2Environment properties
The <springProperty> tag allows you to surface properties from the Spring Environment for use within Logback. This can be useful if you
want to access values from your application.properties le in your logback conguration. The tag works in a similar way to Logbacks
standard <property> tag, but rather than specifying a direct value you specify the source of the property (from the Environment ). You
can use the scope attribute if you need to store the property somewhere other than in local scope. If you need a fallback value in case the
property is not set in the Environment , you can use the defaultValue attribute.
<springPropertyscope="context"name="fluentHost"source="myapp.fluentd.host"
defaultValue="localhost"/>
<appendername="FLUENT"class="ch.qos.logback.more.appenders.DataFluentAppender">
<remoteHost>${fluentHost}</remoteHost>
...
</appender>
The RelaxedPropertyResolver is used to access Environment properties. If specify the source in dashed notation
( mypropertyname ) all the relaxed variations will be tried ( myPropertyName , MY_PROPERTY_NAME etc).
27.Developing web applications

Spring Boot is well suited for web application development. You can easily create a self-contained HTTP server using embedded Tomcat, Jetty,
or Undertow. Most web applications will use the springbootstarterweb module to get up and running quickly.
If you havent yet developed a Spring Boot web application you can follow the "Hello World!" example in the Getting started section.
27.1The Spring Web MVC framework

The Spring Web MVC framework (often referred to as simply 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 using @RequestMapping annotations.
Here is a typical example @RestController to serve JSON data:
@RestController
@RequestMapping(value="/users")
publicclassMyRestController{
@RequestMapping(value="/{user}",method=RequestMethod.GET)
publicUsergetUser(@PathVariableLonguser){
//...
}
@RequestMapping(value="/{user}/customers",method=RequestMethod.GET)
List<Customer>getUserCustomers(@PathVariableLonguser){
//...
}
@RequestMapping(value="/{user}",method=RequestMethod.DELETE)
publicUserdeleteUser(@PathVariableLonguser){
//...
}
Spring MVC is part of the core Spring Framework and detailed information is available in the reference documentation. There are also several
guides available at spring.io/guides that cover Spring MVC.
27.1.1Spring MVC auto-conguration

Spring Boot provides auto-conguration for Spring MVC that works well with most applications.
The auto-conguration adds the following features on top of Springs defaults:
Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.

Support for serving static resources, including support for WebJars (see below).
Automatic registration of Converter , GenericConverter , Formatter beans.
Support for HttpMessageConverters (see below).
Automatic registration of MessageCodesResolver (see below).
Static index.html support.
Custom Favicon support (see below).
Automatic use of a ConfigurableWebBindingInitializer bean (see below).
If you want to keep Spring Boot MVC features, and you just want to add additional MVC conguration (interceptors, formatters, view controllers
etc.) you can add your own @Configuration class of type WebMvcConfigurerAdapter , but without @EnableWebMvc . If you wish to provide
custom instances of RequestMappingHandlerMapping , RequestMappingHandlerAdapter or ExceptionHandlerExceptionResolver you
can declare a WebMvcRegistrationsAdapter instance providing such components.
If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc .
27.1.2HttpMessageConverters
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 (using the Jackson library) or XML (using the Jackson XML extension if
available, else using JAXB). Strings are encoded using UTF8 by default.
If you need to add or customize converters you can use Spring Boots HttpMessageConverters class:
importorg.springframework.boot.autoconfigure.web.HttpMessageConverters;
importorg.springframework.context.annotation.*;
importorg.springframework.http.converter.*;
@Configuration
@Bean
publicHttpMessageConverterscustomConverters(){
HttpMessageConverter<?>additional=...
HttpMessageConverter<?>another=...
returnnewHttpMessageConverters(additional,another);
}
Any HttpMessageConverter bean that is present in the context will be added to the list of converters. You can also override default converters
that way.
27.1.3Custom JSON Serializers and Deserializers

If youre using 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 via a Module, but Spring Boot provides an alternative @JsonComponent
annotation which makes it easier to directly register Spring Beans.
You can use @JsonComponent directly on JsonSerializer or JsonDeserializer implementations. You can also use it on classes that
contains serializers/deserializers as inner-classes. For example:
importjava.io.*;
importcom.fasterxml.jackson.core.*;
importcom.fasterxml.jackson.databind.*;
importorg.springframework.boot.jackson.*;
@JsonComponent
publicclassExample{
publicstaticclassSerializerextendsJsonSerializer<SomeObject>{
//...
}
publicstaticclassDeserializerextendsJsonDeserializer<SomeObject>{
//...
}
All @JsonComponent beans in the ApplicationContext will be automatically registered with Jackson, and since @JsonComponent is meta-
annotated with @Component , the usual component-scanning rules apply.
Spring Boot also provides JsonObjectSerializer and JsonObjectDeserializer base classes which provide useful alternatives to the
standard Jackson versions when serializing Objects. See the Javadoc for details.
27.1.4MessageCodesResolver
Spring MVC has a strategy for generating error codes for rendering error messages from binding errors: MessageCodesResolver . Spring Boot
will create one for you if you set the spring.mvc.messagecodesresolver.format property PREFIX_ERROR_CODE or
POSTFIX_ERROR_CODE (see the enumeration in DefaultMessageCodesResolver.Format ).
27.1.5Static Content
By default Spring Boot will serve static content from a directory called /static (or /public or /resources or /METAINF/resources ) in
the classpath or from the root of the ServletContext . It uses the ResourceHttpRequestHandler from Spring MVC so you can modify that
behavior by adding your own WebMvcConfigurerAdapter 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 will not happen (unless you modify the default MVC conguration)
because Spring will always be able to handle requests through the DispatcherServlet .
By default, resources are mapped on /** but you can tune that via spring.mvc.staticpathpattern . For instance, relocating all
resources to /resources/** can be achieved as follows:
spring.mvc.staticpathpattern=/resources/**
You can also customize the static resource locations using spring.resources.staticlocations (replacing the default values with a list of
directory locations). If you do this the default welcome page detection will switch to your custom locations, so if there is an index.html in any
of your locations on startup, it will be the home page of the application.
In addition to the standard static resource locations above, a special case is made for Webjars content. Any resources with a path in
/webjars/** will be served from jar les if they are packaged in the Webjars format.
Do not use the src/main/webapp directory if your application will be packaged as a jar. Although this directory is a common
standard, it will only work with war packaging and it will be silently ignored by most build tools if you generate a jar.
Spring Boot also supports 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, simply add the webjarslocator dependency. Then declare your Webjar, taking jQuery for
example, as "/webjars/jquery/dist/jquery.min.js" which results in "/webjars/jquery/x.y.z/dist/jquery.min.js" where x.y.z
is the Webjar version.
If you are using JBoss, youll need to declare the webjarslocatorjbossvfs dependency instead of the webjarslocator ;
otherwise all Webjars resolve as a 404 .
To use cache busting, the following conguration will congure a cache busting solution for all static resources, effectively adding a content
hash in URLs, such as <linkhref="/css/spring2a2d595e6ed9a0b24f027f2b63b134d6.css"/> :
spring.resources.chain.strategy.content.enabled=true
spring.resources.chain.strategy.content.paths=/**
Links to resources are rewritten at runtime in template, thanks to a ResourceUrlEncodingFilter , auto-congured for
Thymeleaf and FreeMarker. You should manually declare this lter when using JSPs. Other template engines arent automatically
supported right now, 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 les is not an option. Thats why other strategies
are also supported and can be combined. A "xed" strategy will add a static version string in the URL, without changing the le name:
spring.resources.chain.strategy.content.enabled=true
spring.resources.chain.strategy.content.paths=/**
spring.resources.chain.strategy.fixed.enabled=true
spring.resources.chain.strategy.fixed.paths=/js/lib/
spring.resources.chain.strategy.fixed.version=v12
With this conguration, JavaScript modules located under "/js/lib/" will use a xed versioning strategy "/v12/js/lib/mymodule.js"
while other resources will still use the content one <linkhref="/css/spring2a2d595e6ed9a0b24f027f2b63b134d6.css"/> .
See ResourceProperties for more of the supported options.
This feature has been thoroughly described in a dedicated blog post and in Spring Frameworks reference documentation.
27.1.6Custom Favicon
Spring Boot looks for a favicon.ico in the congured static content locations and the root of the classpath (in that order). If such le is
present, it is automatically used as the favicon of the application.
27.1.7CongurableWebBindingInitializer
Spring MVC uses a WebBindingInitializer to initialize a WebDataBinder for a particular request. If you create your own
ConfigurableWebBindingInitializer @Bean , Spring Boot will automatically congure Spring MVC to use it.
27.1.8Template 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. Many other templating engines also ship their own Spring MVC integrations.
Spring Boot includes auto-conguration support for the following templating engines:
FreeMarker
Groovy
Thymeleaf
Mustache
JSPs should be avoided if possible, there are several known limitations when using them with embedded servlet containers.
When youre using one of these templating engines with the default conguration, your templates will be picked up automatically from
src/main/resources/templates .
IntelliJ IDEA orders the classpath differently depending on how you run your application. Running your application in the IDE via
its main method will result in a different ordering to when you run your application using Maven or Gradle or from its packaged jar.
This can cause Spring Boot to fail to nd the templates on the classpath. If youre affected by this problem you can reorder the
classpath in the IDE to place the modules classes and resources rst. Alternatively, you can congure the template prex to
search every templates directory on the classpath: classpath*:/templates/ .
27.1.9Error Handling
Spring Boot provides an /error mapping by default 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 will produce 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 just add a View that resolves
to error). To replace the default behaviour completely you can implement ErrorController and register a bean denition of that type, or
simply 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 default is to handle text/html specically and provide a fallback for
everything else). To do that just extend BasicErrorController and add a public method with a @RequestMapping that has a
produces attribute, and create a bean of your new type.
You can also dene a @ControllerAdvice to customize the JSON document to return for a particular controller and/or exception type.
@ControllerAdvice(basePackageClasses=FooController.class)
publicclassFooControllerAdviceextendsResponseEntityExceptionHandler{
@ExceptionHandler(YourException.class)
@ResponseBody
ResponseEntity<?>handleControllerException(HttpServletRequestrequest,Throwableex){
HttpStatusstatus=getStatus(request);
returnnewResponseEntity<>(newCustomErrorType(status.value(),ex.getMessage()),status);
}
privateHttpStatusgetStatus(HttpServletRequestrequest){
IntegerstatusCode=(Integer)request.getAttribute("javax.servlet.error.status_code");
if(statusCode==null){
returnHttpStatus.INTERNAL_SERVER_ERROR;
}
returnHttpStatus.valueOf(statusCode);
}
In the example above, if YourException is thrown by a controller dened in the same package as FooController , a json representation of
the CustomerErrorType POJO will be used instead of the ErrorAttributes representation.
Custom error pages

If you want to display a custom HTML error page for a given status code, you add a le to an /error folder. Error pages can either be static
HTML (i.e. added under any of the static resource folders) or built using templates. The name of the le should be the exact status code or a
series mask.
For example, to map 404 to a static HTML le, your folder structure would look like this:
src/
+main/
+java/
|+<sourcecode>
+resources/
+public/
+error/
|+404.html
+<otherpublicassets>
To map all 5xx errors using a FreeMarker template, youd have a structure like this:
src/
+main/
+java/
|+<sourcecode>
+resources/
+templates/
+error/
|+5xx.ftl
+<othertemplates>
For more complex mappings you can also add beans that implement the ErrorViewResolver interface.
publicclassMyErrorViewResolverimplementsErrorViewResolver{
@Override
publicModelAndViewresolveErrorView(HttpServletRequestrequest,
HttpStatusstatus,Map<String,Object>model){
//UsetherequestorstatustooptionallyreturnaModelAndView
return...
}
You can also use regular Spring MVC features like @ExceptionHandler methods and @ControllerAdvice . The ErrorController will
then pick up any unhandled exceptions.
Mapping error pages outside of Spring MVC

For applications that arent using Spring MVC, you can use the ErrorPageRegistrar interface to directly register ErrorPages . This
abstraction works directly with the underlying embedded servlet container and will work even if you dont have a Spring MVC
DispatcherServlet .
@Bean
publicErrorPageRegistrarerrorPageRegistrar(){
returnnewMyErrorPageRegistrar();
}
//...
privatestaticclassMyErrorPageRegistrarimplementsErrorPageRegistrar{
@Override
publicvoidregisterErrorPages(ErrorPageRegistryregistry){
registry.addErrorPages(newErrorPage(HttpStatus.BAD_REQUEST,"/400"));
}
N.B. if you register an ErrorPage with a path that will end up being handled by a Filter (e.g. as is common with some non-Spring web
frameworks, like Jersey and Wicket), then the Filter has to be explicitly registered as an ERROR dispatcher, e.g.
@Bean
publicFilterRegistrationBeanmyFilter(){
FilterRegistrationBeanregistration=newFilterRegistrationBean();
registration.setFilter(newMyFilter());
...
registration.setDispatcherTypes(EnumSet.allOf(DispatcherType.class));
returnregistration;
}
(the default FilterRegistrationBean does not include the ERROR dispatcher type).
Error Handling on WebSphere Application Server

When deployed to a servlet container, a Spring Boot uses its error page lter to forward a request with an error status to the appropriate error
page. The request can only be forwarded 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 servlets service method. You should disable this
behaviour by setting com.ibm.ws.webcontainer.invokeFlushAfterService to false
27.1.10Spring HATEOAS
If youre developing a RESTful API that makes use of hypermedia, Spring Boot provides auto-conguration for Spring HATEOAS that works well
with most applications. The auto-conguration 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 congured to
correctly marshal responses into the desired representation. The ObjectMapper will be customized based on the spring.jackson.*
properties or a Jackson2ObjectMapperBuilder bean if one exists.
You can take control of Spring HATEOASs conguration by using @EnableHypermediaSupport . Note that this will disable the ObjectMapper
customization described above.
27.1.11CORS support
Cross-origin resource sharing (CORS) is a W3C specication implemented by most browsers that allows you to specify in a exible way what
kind of cross domain requests are authorized, instead of using some less secure and less powerful approaches like IFRAME or JSONP.
As of version 4.2, Spring MVC supports CORS out of the box. Using controller method CORS conguration with @CrossOrigin annotations in
your Spring Boot application does not require any specic conguration. Global CORS conguration can be dened by registering a
WebMvcConfigurer bean with a customized addCorsMappings(CorsRegistry) method:
@Configuration
@Bean
publicWebMvcConfigurercorsConfigurer(){
returnnewWebMvcConfigurerAdapter(){
@Override
publicvoidaddCorsMappings(CorsRegistryregistry){
registry.addMapping("/api/**");
}
};
}
}
27.2JAX-RS and Jersey

If you prefer the JAX-RS programming model for REST endpoints you can use one of the available implementations instead of Spring MVC.
Jersey 1.x and Apache CXF work quite well out of the box if you just register their Servlet or Filter as a @Bean in your application
context. Jersey 2.x has some native Spring support so we also provide auto-conguration support for it in Spring Boot together with a starter.
To get started with Jersey 2.x just include the springbootstarterjersey as a dependency and then you need one @Bean of type
ResourceConfig in which you register all the endpoints:
@Component
publicclassJerseyConfigextendsResourceConfig{
publicJerseyConfig(){
register(Endpoint.class);
}
Jerseys support for scanning executable archives is rather limited. For example, it cannot scan for endpoints in a package found
in WEBINF/classes when running an executable war le. To avoid this limitation, the packages method should not be used
and endpoints should be registered individually using the register method as shown above.
You can also register an arbitrary number of beans implementing ResourceConfigCustomizer for more advanced customizations.
All the registered endpoints should be @Components with HTTP resource annotations ( @GET etc.), e.g.
@Component
@Path("/hello")
publicclassEndpoint{
@GET
publicStringmessage(){
return"Hello";
}
Since the Endpoint is a Spring @Component its lifecycle is managed by Spring and you can @Autowired dependencies and inject external
conguration with @Value . The Jersey servlet will be registered and mapped to /* by default. You can change the mapping by adding
@ApplicationPath to your ResourceConfig .
By default Jersey will be set up as a Servlet in a @Bean of type ServletRegistrationBean named jerseyServletRegistration . By
default, the servlet will be initialized lazily but you can customize it with spring.jersey.servlet.loadonstartup .You can disable or
override that bean by creating one of your own with the same name. You can also use a Filter instead of a Servlet by setting
spring.jersey.type=filter (in which case the @Bean to replace or override is jerseyFilterRegistration ). The servlet has an
@Order which you can set with spring.jersey.filter.order . Both the Servlet and the Filter registrations can be given init parameters
using spring.jersey.init.* to specify a map of properties.
There is a Jersey sample so you can see how to set things up. There is also a Jersey 1.x sample. Note that in the Jersey 1.x sample that the
spring-boot maven plugin has been congured to unpack some Jersey jars so they can be scanned by the JAX-RS implementation (because
the sample asks for them to be scanned in its Filter registration). You may need to do the same if any of your JAX-RS resources are
packaged as nested jars.
27.3Embedded servlet container support

Spring Boot includes support for embedded Tomcat, Jetty, and Undertow servers. Most developers will simply use the appropriate Starter to
obtain a fully congured instance. By default the embedded server will listen for HTTP requests on port 8080 .
If you choose to use Tomcat on CentOS be aware that, by default, a temporary directory is used to store compiled JSPs, le
uploads etc. This directory may be deleted by tmpwatch while your application is running leading to failures. To avoid this, you
may want to customize your tmpwatch conguration so that tomcat.* directories are not deleted, or congure
server.tomcat.basedir so that embedded Tomcat uses a different location.
27.3.1Servlets, Filters, and listeners

When using an embedded servlet container you can register Servlets, Filters and all the listeners from the Servlet spec (e.g.
HttpSessionListener ) 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 will be registered with the embedded container. This can be
particularly convenient if you want to refer to a value from your application.properties during conguration.
By default, if the context contains only a single Servlet it will be mapped to / . In the case of multiple Servlet beans the bean name will be used
as a path prex. Filters will map to /* .
If convention-based mapping is not exible enough you can use the ServletRegistrationBean , FilterRegistrationBean and
ServletListenerRegistrationBean classes for complete control.
27.3.2Servlet Context Initialization

Embedded servlet containers will not directly execute the Servlet 3.0+ javax.servlet.ServletContainerInitializer interface, or Springs
org.springframework.web.WebApplicationInitializer interface. This is an intentional design decision intended to reduce the risk that
3rd party libraries designed to run inside a war will 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.context.embedded.ServletContextInitializer interface. The single onStartup method provides access
to the ServletContext , and can easily be used as an adapter to an existing WebApplicationInitializer if necessary.
Scanning for Servlets, Filters, and listeners

When using an embedded container, automatic registration of @WebServlet , @WebFilter , and @WebListener annotated classes can be
enabled using @ServletComponentScan .
@ServletComponentScan will have no effect in a standalone container, where the containers built-in discovery mechanisms will
be used instead.
27.3.3The EmbeddedWebApplicationContext
Under the hood Spring Boot uses a new type of ApplicationContext for embedded servlet container support. The
EmbeddedWebApplicationContext is a special type of WebApplicationContext that bootstraps itself by searching for a single
EmbeddedServletContainerFactory bean. Usually a TomcatEmbeddedServletContainerFactory ,
JettyEmbeddedServletContainerFactory , or UndertowEmbeddedServletContainerFactory will have been auto-congured.
You usually wont need to be aware of these implementation classes. Most applications will be auto-congured and the
appropriate ApplicationContext and EmbeddedServletContainerFactory will be created on your behalf.
27.3.4Customizing embedded servlet containers

Common servlet container settings can be congured using Spring Environment properties. Usually you would dene the properties in your
application.properties le.
Common server settings include:
Network settings: listen port for incoming HTTP requests ( server.port ), interface address to bind to server.address , etc.
Session settings: whether the session is persistent ( server.session.persistence ), session timeout ( server.session.timeout ),
location of session data ( server.session.storedir ) and session-cookie conguration ( server.session.cookie.* ).
Error management: location of the error page ( server.error.path ), etc.
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-specic customizations (see server.tomcat and server.undertow ). For instance, access logs can be congured with specic
features of the embedded servlet container.
See the ServerProperties class for a complete list.
Programmatic customization
If you need to congure your embedded servlet container programmatically you can register a Spring bean that implements the
EmbeddedServletContainerCustomizer interface. EmbeddedServletContainerCustomizer provides access to the
ConfigurableEmbeddedServletContainer which includes numerous customization setter methods.
importorg.springframework.boot.context.embedded.*;
importorg.springframework.stereotype.Component;
@Component
publicclassCustomizationBeanimplementsEmbeddedServletContainerCustomizer{
@Override
publicvoidcustomize(ConfigurableEmbeddedServletContainercontainer){
container.setPort(9000);
}
Customizing CongurableEmbeddedServletContainer directly

If the above customization techniques are too limited, you can register the TomcatEmbeddedServletContainerFactory ,
JettyEmbeddedServletContainerFactory or UndertowEmbeddedServletContainerFactory bean yourself.
@Bean
publicEmbeddedServletContainerFactoryservletContainer(){
TomcatEmbeddedServletContainerFactoryfactory=newTomcatEmbeddedServletContainerFactory();
factory.setPort(9000);
factory.setSessionTimeout(10,TimeUnit.MINUTES);
factory.addErrorPages(newErrorPage(HttpStatus.NOT_FOUND,"/notfound.html"));
returnfactory;
}
Setters are provided for many conguration options. Several protected method hooks are also provided should you need to do something more
exotic. See the source code documentation for details.
27.3.5JSP 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 Tomcat it should work if you use war packaging, i.e. an executable war will work, and will also be deployable to a standard container
(not limited to, but including Tomcat). An executable jar will not work because of a hard coded le pattern in Tomcat.
With Jetty it should work if you use war packaging, i.e. an executable war will work, and will also be deployable to any standard container.
Undertow does not support JSPs.
Creating a custom error.jsp page wont override the default view for error handling, custom error pages should be used instead.
There is a JSP sample so you can see how to set things up.
28.Security
If Spring Security is on the classpath then web applications will be secure by default with basic authentication on all HTTP endpoints. 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.
The default AuthenticationManager has a single user (user username and random password, printed at INFO level when the application
starts up)
Usingdefaultsecuritypassword:78fa095d3f4c48b1ad50e24c31d5cf35
If you ne-tune your logging conguration, ensure that the org.springframework.boot.autoconfigure.security category is
set to log INFO messages, otherwise the default password will not be printed.
You can change the password by providing a security.user.password . This and other useful properties are externalized via
SecurityProperties (properties prex "security").
The default security conguration is implemented in SecurityAutoConfiguration and in the classes imported from there
( SpringBootWebSecurityConfiguration for web security and AuthenticationManagerConfiguration for authentication conguration
which is also relevant in non-web applications). To switch off the default web application security conguration completely you can add a bean
with @EnableWebSecurity (this does not disable the authentication manager conguration or Actuators security). To customize it you
normally use external properties and beans of type WebSecurityConfigurerAdapter (e.g. to add form-based login). To also switch off the
authentication manager conguration you can add a bean of type AuthenticationManager , or else congure the global
AuthenticationManager by autowiring an AuthenticationManagerBuilder into a method in one of your @Configuration classes.
There are several secure applications in the Spring Boot samples to get you started with common use cases.
The basic features you get out of the box in a web application are:
An AuthenticationManager bean with in-memory store and a single user (see SecurityProperties.User for the properties of the
user).
Ignored (insecure) paths for common static resource locations ( /css/** , /js/** , /images/** , /webjars/** and **/favicon.ico ).
HTTP Basic security for all other endpoints.
Security events published to Springs ApplicationEventPublisher (successful and unsuccessful authentication and access denied).
Common low-level features (HSTS, XSS, CSRF, caching) provided by Spring Security are on by default.
All of the above can be switched on and off or modied using external properties ( security.* ). To override the access rules without changing
any other auto-congured features add a @Bean of type WebSecurityConfigurerAdapter with
@Order(SecurityProperties.ACCESS_OVERRIDE_ORDER) and congure it to meet your needs.
By default, a WebSecurityConfigurerAdapter will match any path. If you dont want to completely override Spring Boots auto-
congured access rules, your adapter must explicitly congure the paths that you do want to override.
28.1OAuth2
If you have springsecurityoauth2 on your classpath you can take advantage of some auto-conguration to make it easy to set up
Authorization or Resource Server. For full details, see the Spring Security OAuth 2 Developers Guide.
28.1.1Authorization Server
To create an Authorization Server and grant access tokens you need to use @EnableAuthorizationServer and provide
security.oauth2.client.clientid and security.oauth2.client.clientsecret] properties. The client will be registered for you in
an in-memory repository.
Having done that you will be able to use the client credentials to create an access token, for example:
$curlclient:secret@localhost:8080/oauth/tokendgrant_type=passworddusername=userdpassword=pwd
The basic auth credentials for the /token endpoint are the clientid and clientsecret . The user credentials are the normal Spring
Security user details (which default in Spring Boot to user and a random password).
To switch off the auto-conguration and congure the Authorization Server features yourself just add a @Bean of type
AuthorizationServerConfigurer .
28.1.2Resource Server
To use the access token you need a Resource Server (which can be the same as the Authorization Server). Creating a Resource Server is
easy, just add @EnableResourceServer and provide some conguration to allow the server to decode access tokens. If your application is
also an Authorization Server it already knows how to decode tokens, so there is nothing else to do. If your app is a standalone service then you
need to give it some more conguration, one of the following options:
security.oauth2.resource.userinfouri to use the /me resource (e.g. https://uaa.run.pivotal.io/userinfo on PWS)

security.oauth2.resource.tokeninfouri to use the token decoding endpoint (e.g. https://uaa.run.pivotal.io/check_token
on PWS).
If you specify both the userinfouri and the tokeninfouri then you can set a ag to say that one is preferred over the other
( prefertokeninfo=true is the default).
Alternatively (instead of userinfouri or tokeninfouri ) if the tokens are JWTs you can congure a
security.oauth2.resource.jwt.keyvalue to decode them locally (where the key is a verication key). The verication key value is either
a symmetric secret or PEM-encoded RSA public key. If you dont have the key and its public you can provide a URI where it can be
downloaded (as a JSON object with a value eld) with security.oauth2.resource.jwt.keyuri . E.g. on PWS:
$curlhttps://uaa.run.pivotal.io/token_key
{"alg":"SHA256withRSA","value":"BEGINPUBLICKEY\nMIIBI...\nENDPUBLICKEY\n"}
If you use the security.oauth2.resource.jwt.keyuri the authorization server needs to be running when your application
starts up. It will log a warning if it cant nd the key, and tell you what to do to x it.
OAuth2 resources are protected by a lter chain with order security.oauth2.resource.filterorder and the default is after the lter
protecting the actuator endpoints by default (so actuator endpoints will stay on HTTP Basic unless you change the order).
28.2Token Type in User Info

Google, and certain other 3rd party identity providers, are more strict about the token type name that is sent in the headers to the user info
endpoint. The default is Bearer which suits most providers and matches the spec, but if you need to change it you can set
security.oauth2.resource.tokentype .
28.3Customizing the User Info RestTemplate

If you have a userinfouri , the resource server features use an OAuth2RestTemplate internally to fetch user details for authentication.
This is provided as a @Bean of type UserInfoRestTemplateFactory . The default should be ne for most providers, but occasionally you
might need to add additional interceptors, or change the request authenticator (which is how the token gets attached to outgoing requests). To
add a customization just create a bean of type UserInfoRestTemplateCustomizer - it has a single method that will be called after the bean
is created but before it is initialized. The rest template that is being customized here is only used internally to carry out authentication.
Alternatively, you could dene your own UserInfoRestTemplateFactory @Bean to take full control.
To set an RSA key value in YAML use the pipe continuation marker to split it over multiple lines (|) and remember to indent the
key value (its a standard YAML language feature). Example:
security:
oauth2:
resource:
jwt:
keyValue:|
BEGINPUBLICKEY
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC...
ENDPUBLICKEY
28.3.1Client
To make your web-app into an OAuth2 client you can simply add @EnableOAuth2Client and Spring Boot will create a
OAuth2ClientContext and OAuth2ProtectedResourceDetails that are necessary to create an OAuth2RestOperations . Spring Boot
does not automatically create such bean but you can easily create your own:
@Bean
publicOAuth2RestTemplateoauth2RestTemplate(OAuth2ClientContextoauth2ClientContext,
OAuth2ProtectedResourceDetailsdetails){
returnnewOAuth2RestTemplate(details,oauth2ClientContext);
}
You may want to add a qualier and review your conguration as more than one RestTemplate may be dened in your
application.
This conguration uses security.oauth2.client.* as credentials (the same as you might be using in the Authorization Server), but in
addition it will need to know the authorization and token URIs in the Authorization Server. For example:
application.yml.
security:
oauth2:
client:
clientId:bd1c0a783ccdd1c9b9e4
clientSecret:1a9030fbca47a5b2c28e92f19050bb77824b5ad1
accessTokenUri:https://github.com/login/oauth/access_token
userAuthorizationUri:https://github.com/login/oauth/authorize
clientAuthenticationScheme:form
An application with this conguration will redirect to Github for authorization when you attempt to use the OAuth2RestTemplate . If you are
already signed into Github you wont even notice that it has authenticated. These specic credentials will only work if your application is running
on port 8080 (register your own client app in Github or other provider for more exibility).
To limit the scope that the client asks for when it obtains an access token you can set security.oauth2.client.scope (comma separated or
an array in YAML). By default the scope is empty and it is up to Authorization Server to decide what the defaults should be, usually depending
on the settings in the client registration that it holds.
There is also a setting for security.oauth2.client.clientauthenticationscheme which defaults to header (but you
might need to set it to form if, like Github for instance, your OAuth2 provider doesnt like header authentication). In fact, the
security.oauth2.client.* properties are bound to an instance of AuthorizationCodeResourceDetails so all its
properties can be specied.
In a non-web application you can still create an OAuth2RestOperations and it is still wired into the
security.oauth2.client.* conguration. In this case it is a client credentials token grant you will be asking for if you use it
(and there is no need to use @EnableOAuth2Client or @EnableOAuth2Sso ). To prevent that infrastructure to be dened, just
remove the security.oauth2.client.clientid from your conguration (or make it the empty string).
28.3.2Single Sign On
An OAuth2 Client can be used to fetch user details from the provider (if such features are available) and then convert them into an
Authentication token for Spring Security. The Resource Server above support this via the userinfouri property This is the basis for a
Single Sign On (SSO) protocol based on OAuth2, and Spring Boot makes it easy to participate by providing an annotation @EnableOAuth2Sso .
The Github client above can protect all its resources and authenticate using the Github /user/ endpoint, by adding that annotation and
declaring where to nd the endpoint (in addition to the security.oauth2.client.* conguration already listed above):
application.yml.
security:
oauth2:
...
resource:
userInfoUri:https://api.github.com/user
preferTokenInfo:false
Since all paths are secure by default, there is no home page that you can show to unauthenticated users and invite them to login (by visiting
the /login path, or the path specied by security.oauth2.sso.loginpath ).
To customize the access rules or paths to protect, so you can add a home page for instance, @EnableOAuth2Sso can be added to a
WebSecurityConfigurerAdapter and the annotation will cause it to be decorated and enhanced with the necessary pieces to get the
/login path working. For example, here we simply allow unauthenticated access to the home page at "/" and keep the default for everything
else:
@Configuration
publicclassWebSecurityConfigurationextendsWebSecurityConfigurerAdapter{
@Override
publicvoidinit(WebSecurityweb){
web.ignore("/");
}
@Override
protectedvoidconfigure(HttpSecurityhttp)throwsException{
http.antMatcher("/**").authorizeRequests().anyRequest().authenticated();
}
28.4Actuator Security
If the Actuator is also in use, you will nd:
The management endpoints are secure even if the application endpoints are insecure.
Security events are transformed into AuditEvent instances and published to the AuditEventRepository .
The default user will have the ACTUATOR role as well as the USER role.
The Actuator security features can be modied using external properties ( management.security.* ). To override the application access rules
add a @Bean of type WebSecurityConfigurerAdapter and use @Order(SecurityProperties.ACCESS_OVERRIDE_ORDER) if you dont
want to override the actuator access rules, or @Order(ManagementServerProperties.ACCESS_OVERRIDE_ORDER) if you do want to override
the actuator access rules.
29.Working with 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.
29.1Congure a DataSource
Javas 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.
Check also the How-to section for more advanced examples, typically to take full control over the conguration of the
DataSource.
29.1.1Embedded Database Support

Its often convenient to develop applications using an in-memory embedded database. Obviously, in-memory databases do not provide
persistent storage; you will need to populate your database when your application starts and be prepared to throw away data when your
application ends.
The How-to section includes a section on how to initialize a database
Spring Boot can auto-congure embedded H2, HSQL and Derby databases. You dont need to provide any connection URLs, simply include a
build dependency to the embedded database that you want to use.
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 that you use. If you want to make sure that each context has a separate embedded database,
you should set spring.datasource.generateuniquename to true .
For example, typical POM dependencies would be:
<dependency>
<artifactId>springbootstarterdatajpa</artifactId>
</dependency>
<dependency>
<groupId>org.hsqldb</groupId>
<artifactId>hsqldb</artifactId>
<scope>runtime</scope>
</dependency>
You need a dependency on springjdbc for an embedded database to be auto-congured. In this example its pulled in
transitively via springbootstarterdatajpa .
If, for whatever reason, you do congure the connection URL for an embedded database, care should be taken to ensure that the
databases automatic shutdown is disabled. If youre using H2 you should use DB_CLOSE_ON_EXIT=FALSE to do so. If youre
using HSQLDB, you should ensure that shutdown=true is not used. Disabling the databases automatic shutdown allows Spring
Boot to control when the database is closed, thereby ensuring that it happens once access to the database is no longer needed.
29.1.2Connection to a production database

Production database connections can also be auto-congured using a pooling DataSource . Heres the algorithm for choosing a specic
implementation:
We prefer the Tomcat pooling DataSource for its performance and concurrency, so if that is available we always choose it.
Otherwise, if HikariCP is available we will use it.
If neither the Tomcat pooling datasource nor HikariCP are available and if Commons DBCP2 is available we will use it.
If you use the springbootstarterjdbc or springbootstarterdatajpa starters you will automatically get a dependency to
tomcatjdbc .
You can bypass that algorithm completely and specify the connection pool to use via the spring.datasource.type property.
This is especially important if you are running your application in a Tomcat container as tomcatjdbc is provided by default.
Additional connection pools can always be congured manually. If you dene your own DataSource bean, auto-conguration will
not occur.
DataSource conguration is controlled by external conguration properties in spring.datasource.* . For example, you might declare the
following section in application.properties :
spring.datasource.url=jdbc:mysql://localhost/test
spring.datasource.username=dbuser
spring.datasource.password=dbpass
spring.datasource.driverclassname=com.mysql.jdbc.Driver
You should at least specify the url using the spring.datasource.url property or Spring Boot will attempt to auto-congure an
embedded database.
You often wont need to specify the driverclassname since Spring boot can deduce it for most databases from the url .
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. I.e. if you set spring.datasource.driverclassname=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 ne-tune implementation-specic settings using their respective prex ( spring.datasource.tomcat.* ,
spring.datasource.hikari.* , and spring.datasource.dbcp2.* ). Refer to the documentation of the connection pool implementation you
are using for more details.
For instance, if you are using the Tomcat connection pool you could customize many additional settings:
#Numberofmstowaitbeforethrowinganexceptionifnoconnectionisavailable.
spring.datasource.tomcat.maxwait=10000
#Maximumnumberofactiveconnectionsthatcanbeallocatedfromthispoolatthesametime.
spring.datasource.tomcat.maxactive=50
#Validatetheconnectionbeforeborrowingitfromthepool.
spring.datasource.tomcat.testonborrow=true
29.1.3Connection to a JNDI DataSource

If you are deploying your Spring Boot application to an Application Server you might want to congure and manage your DataSource using your
Application Servers built-in features and access it using JNDI.
The spring.datasource.jndiname 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 specic JNDI location.
For example, the following section in application.properties shows how you can access a JBoss AS dened DataSource :
spring.datasource.jndiname=java:jboss/datasources/customers
29.2Using JdbcTemplate
Springs JdbcTemplate and NamedParameterJdbcTemplate classes are auto-congured and you can @Autowire them directly into your
own beans:
importorg.springframework.jdbc.core.JdbcTemplate;
@Component
publicclassMyBean{
privatefinalJdbcTemplatejdbcTemplate;
@Autowired
publicMyBean(JdbcTemplatejdbcTemplate){
this.jdbcTemplate=jdbcTemplate;
}
//...
29.3JPA and Spring Data

The Java Persistence API is a standard technology that allows you to map objects to relational databases. The
springbootstarterdatajpa POM provides a quick way to get started. It provides the following key dependencies:
HibernateOne of the most popular JPA implementations.

Spring Data JPAMakes it easy to implement JPA-based repositories.
Spring ORMsCore ORM support from the Spring Framework.
We wont go into too many details of JPA or Spring Data here. You can follow the Accessing Data with JPA guide from spring.io
and read the Spring Data JPA and Hibernate reference documentation.
29.3.1Entity Classes
Traditionally, JPA Entity classes are specied in a persistence.xml le. With Spring Boot this le is not necessary and instead Entity
Scanning is used. By default all packages below your main conguration class (the one annotated with @EnableAutoConfiguration or
@SpringBootApplication ) will be searched.
Any classes annotated with @Entity , @Embeddable or @MappedSuperclass will be considered. A typical entity class would look something
like this:
packagecom.example.myapp.domain;
importjava.io.Serializable;
importjavax.persistence.*;
@Entity
publicclassCityimplementsSerializable{
@Id
@GeneratedValue
privateLongid;
@Column(nullable=false)
privateStringname;
@Column(nullable=false)
privateStringstate;
//...additionalmembers,ofteninclude@OneToManymappings
protectedCity(){
//noargsconstructorrequiredbyJPAspec
//thisoneisprotectedsinceitshouldn'tbeuseddirectly
}
publicCity(Stringname,Stringstate){
this.name=name;
this.country=country;
}
publicStringgetName(){
returnthis.name;
}
publicStringgetState(){
returnthis.state;
}
//...etc
You can customize entity scanning locations using the @EntityScan annotation. See the Section76.4, Separate @Entity
denitions from Spring conguration how-to.
29.3.2Spring Data JPA Repositories

Spring Data JPA repositories are interfaces that you can dene to access data. JPA queries are created automatically from your method names.
For example, a CityRepository interface might declare a findAllByState(Stringstate) method to nd all cities in a given state.
For more complex queries you can annotate your method using Spring Datas Query annotation.
Spring Data repositories usually extend from the Repository or CrudRepository interfaces. If you are using auto-conguration, repositories
will be searched from the package containing your main conguration class (the one annotated with @EnableAutoConfiguration or
@SpringBootApplication ) down.
Here is a typical Spring Data repository:
importorg.springframework.data.domain.*;
importorg.springframework.data.repository.*;
publicinterfaceCityRepositoryextendsRepository<City,Long>{
Page<City>findAll(Pageablepageable);
CityfindByNameAndCountryAllIgnoringCase(Stringname,Stringcountry);
We have barely scratched the surface of Spring Data JPA. For complete details check their reference documentation.
29.3.3Creating and dropping JPA databases

By default, JPA databases will be automatically created only if you use an embedded database (H2, HSQL or Derby). You can explicitly
congure JPA settings using spring.jpa.* properties. For example, to create and drop tables you can add the following to your
application.properties .
spring.jpa.hibernate.ddlauto=createdrop
Hibernates 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 properties, using spring.jpa.properties.* (the prex is stripped before adding them to
the entity manager). Example:
spring.jpa.properties.hibernate.globally_quoted_identifiers=true
passes hibernate.globally_quoted_identifiers 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.generateddl ag, but it is not used if Hibernate autocong is active because the ddlauto settings are more ne-grained.
29.3.4Open EntityManager in View

If you are running a web application, Spring Boot will by default register OpenEntityManagerInViewInterceptor to apply the "Open
EntityManager in View" pattern, i.e. to allow for lazy loading in web views. If you dont want this behavior you should set
spring.jpa.openinview to false in your application.properties .
29.4Using H2s web console

The H2 database provides a browser-based console that Spring Boot can auto-congure for you. The console will be auto-congured when the
following conditions are met:
You are developing a web application

com.h2database:h2 is on the classpath
You are using Spring Boots developer tools
If you are not using Spring Boots developer tools, but would still like to make use of H2s console, then you can do so by
conguring the spring.h2.console.enabled property with a value of true . The H2 console is only intended for use during
development so care should be taken to ensure that spring.h2.console.enabled is not set to true in production.
29.4.1Changing the H2 consoles path

By default the console will be available at /h2console . You can customize the consoles path using the spring.h2.console.path
property.
29.4.2Securing the H2 console
When Spring Security is on the classpath and basic auth is enabled, the H2 console will be automatically secured using basic auth. The
following properties can be used to customize the security conguration:
security.user.role
security.basic.authorizemode
security.basic.enabled
29.5Using jOOQ
Java 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 uent API. Both the commercial and open source editions can be used with Spring Boot.
29.5.1Code 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 are using the jooqcodegenmaven plugin (and you also use the springbootstarterparent parent POM)
you can safely omit the plugins <version> tag. You can also use Spring Boot dened version variables (e.g. h2.version ) to declare the
plugins database dependency. Heres an example:
<plugin>
<groupId>org.jooq</groupId>
<artifactId>jooqcodegenmaven</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>
29.5.2Using DSLContext
The uent API offered by jOOQ is initiated via the org.jooq.DSLContext interface. Spring Boot will auto-congure a DSLContext as a
Spring Bean and connect it to your application DataSource . To use the DSLContext you can just @Autowire it:
@Component
publicclassJooqExampleimplementsCommandLineRunner{
privatefinalDSLContextcreate;
@Autowired
publicJooqExample(DSLContextdslContext){
this.create=dslContext;
}
The jOOQ manual tends to use a variable named create to hold the DSLContext , weve done the same for this example.
You can then use the DSLContext to construct your queries:
publicList<GregorianCalendar>authorsBornAfter1980(){
returnthis.create.selectFrom(AUTHOR)
.where(AUTHOR.DATE_OF_BIRTH.greaterThan(newGregorianCalendar(1980,0,1)))
.fetch(AUTHOR.DATE_OF_BIRTH);
}
29.5.3Customizing jOOQ
You can customize the SQL dialect used by jOOQ by setting spring.jooq.sqldialect in your application.properties . For example,
to specify Postgres you would add:
spring.jooq.sqldialect=Postgres
More advanced customizations can be achieved by dening your own @Bean denitions which will be used when the jOOQ Configuration is
created. You can dene beans for the following jOOQ Types:
ConnectionProvider
TransactionProvider
RecordMapperProvider
RecordListenerProvider
ExecuteListenerProvider
VisitListenerProvider
You can also create your own org.jooq.Configuration @Bean if you want to take complete control of the jOOQ conguration.
30.Working with NoSQL technologies

Spring Data provides additional projects that help you access a variety of NoSQL technologies including MongoDB, Neo4J, Elasticsearch, Solr,
Redis, Gemre, Cassandra, Couchbase and LDAP. Spring Boot provides auto-conguration for Redis, MongoDB, Neo4j, Elasticsearch, Solr
Cassandra, Couchbase and LDAP; you can make use of the other projects, but you will need to congure them yourself. Refer to the
appropriate reference documentation at projects.spring.io/spring-data.
30.1Redis
Redis is a cache, message broker and richly-featured key-value store. Spring Boot offers basic auto-conguration for the Jedis client library and
abstractions on top of it provided by Spring Data Redis. There is a springbootstarterdataredis Starter for collecting the
dependencies in a convenient way.
30.1.1Connecting to Redis
You can inject an auto-congured RedisConnectionFactory , StringRedisTemplate or vanilla RedisTemplate instance as you would any
other Spring Bean. By default the instance will attempt to connect to a Redis server using localhost:6379 :
@Component
publicclassMyBean{
privateStringRedisTemplatetemplate;
@Autowired
publicMyBean(StringRedisTemplatetemplate){
this.template=template;
}
//...
If you add a @Bean of your own of any of the auto-congured types it will replace the default (except in the case of RedisTemplate the
exclusion is based on the bean name redisTemplate not its type). If commonspool2 is on the classpath you will get a pooled connection
factory by default.
30.2MongoDB
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 springbootstarterdatamongodb and
springbootstarterdatamongodbreactive Starters.
30.2.1Connecting to a MongoDB database

You can inject an auto-congured org.springframework.data.mongodb.MongoDbFactory to access Mongo databases. By default the
instance will attempt to connect to a MongoDB server using the URL mongodb://localhost/test :
importorg.springframework.data.mongodb.MongoDbFactory;
importcom.mongodb.DB;
@Component
publicclassMyBean{
privatefinalMongoDbFactorymongo;
@Autowired
publicMyBean(MongoDbFactorymongo){
this.mongo=mongo;
}
//...
publicvoidexample(){
DBdb=mongo.getDb();
//...
}
You can set spring.data.mongodb.uri property to change the URL and congure additional settings such as the replica set:
spring.data.mongodb.uri=mongodb://user:secret@mongo1.example.com:12345,mongo2.example.com:23456/test
Alternatively, as long as youre using Mongo 2.x, specify a host / port . For example, you might declare the following in your
application.properties :
spring.data.mongodb.host=mongoserver
spring.data.mongodb.port=27017
spring.data.mongodb.host and spring.data.mongodb.port are not supported if youre using the Mongo 3.0 Java driver. In
such cases, spring.data.mongodb.uri should be used to provide all of the conguration.
If spring.data.mongodb.port is not specied the default of 27017 is used. You could simply delete this line from the sample
above.
If you arent using Spring Data Mongo you can inject com.mongodb.Mongo beans instead of using MongoDbFactory .
You can also declare your own MongoDbFactory or Mongo bean if you want to take complete control of establishing the MongoDB
connection.
30.2.2MongoTemplate
Spring Data Mongo provides a MongoTemplate class that is very similar in its design to Springs JdbcTemplate . As with JdbcTemplate
Spring Boot auto-congures a bean for you to simply inject:
importorg.springframework.data.mongodb.core.MongoTemplate;
@Component
publicclassMyBean{
privatefinalMongoTemplatemongoTemplate;
@Autowired
publicMyBean(MongoTemplatemongoTemplate){
this.mongoTemplate=mongoTemplate;
}
//...
See the MongoOperations Javadoc for complete details.
30.2.3Spring 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 for you automatically based on method names.
In fact, both Spring Data JPA and Spring Data MongoDB share the same common infrastructure; so you could take the JPA example from
earlier and, assuming that City is now a Mongo data class rather than a JPA @Entity , it will work in the same way.
publicinterfaceCityRepositoryextendsRepository<City,Long>{
CityfindByNameAndCountryAllIgnoringCase(Stringname,Stringcountry);
For complete details of Spring Data MongoDB, including its rich object mapping technologies, refer to their reference
documentation.
30.2.4Embedded Mongo
Spring Boot offers auto-conguration for Embedded Mongo. To use it in your Spring Boot application add a dependency on
de.flapdoodle.embed:de.flapdoodle.embed.mongo .
The port that Mongo will listen on can be congured using the spring.data.mongodb.port property. To use a randomly allocated free port
use a value of zero. The MongoClient created by MongoAutoConfiguration will be automatically congured to use the randomly allocated
port.
If you do not congure a custom port, the embedded support will use a random port by default (rather than 27017).
If you have SLF4J on the classpath, output produced by Mongo will be 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 instances conguration and logging
routing.
30.3Neo4j
Neo4j is an open-source NoSQL graph database that uses a rich data model of nodes related by rst 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
springbootstarterdataneo4j Starter.
30.3.1Connecting to a Neo4j database

You can inject an auto-congured Neo4jSession , Session or Neo4jOperations instance as you would any other Spring Bean. By default
the instance will attempt to connect to a Neo4j server using localhost:7474 :
@Component
publicclassMyBean{
privatefinalNeo4jTemplateneo4jTemplate;
@Autowired
publicMyBean(Neo4jTemplateneo4jTemplate){
this.neo4jTemplate=neo4jTemplate;
}
//...
You can take full control of the conguration by adding a org.neo4j.ogm.config.Configuration @Bean of your own. Also, adding a
@Bean of type Neo4jOperations disables the auto-conguration.
You can congure the user and credentials to use via the spring.data.neo4j.* properties:
spring.data.neo4j.uri=http://myserver:7474
spring.data.neo4j.username=neo4j
spring.data.neo4j.password=secret
30.3.2Using the embedded mode

If you add org.neo4j:neo4jogmembeddeddriver to the dependencies of your application, Spring Boot will automatically congure an in-
process embedded instance of Neo4j that will not persist any data when your application shuts down. You can explicitly disable that mode using
spring.data.neo4j.embedded.enabled=false . You can also enable persistence for the embedded mode:
spring.data.neo4j.uri=file://var/tmp/graph.db
30.3.3Neo4jSession
By default, if you are running a web application, the session is bound to the thread for the entire processing of the request (i.e. the "Open
Session in View" pattern). If you dont want this behavior add the following to your application.properties :
spring.data.neo4j.openinview=false
30.3.4Spring Data Neo4j repositories

Spring Data includes repository support for Neo4j.
In fact, both Spring Data JPA and Spring Data Neo4j share the same common infrastructure; so you could take the JPA example from earlier
and, assuming that City is now a Neo4j OGM @NodeEntity rather than a JPA @Entity , it will work in the same way.
You can customize entity scanning locations using the @EntityScan annotation.
To enable repository support (and optionally support for @Transactional ), add the following two annotations to your Spring conguration:
@EnableNeo4jRepositories(basePackages="com.example.myapp.repository")
@EnableTransactionManagement
30.3.5Repository example
publicinterfaceCityRepositoryextendsGraphRepository<City>{
CityfindByNameAndCountry(Stringname,Stringcountry);
For complete details of Spring Data Neo4j, including its rich object mapping technologies, refer to their reference documentation.
30.4Gemre
Spring Data Gemre provides convenient Spring-friendly tools for accessing the Pivotal Gemre data management platform. There is a
springbootstarterdatagemfire Starter for collecting the dependencies in a convenient way. There is currently no auto-conguration
support for Gemre, but you can enable Spring Data Repositories with a single annotation ( @EnableGemfireRepositories ).
30.5Solr
Apache Solr is a search engine. Spring Boot offers basic auto-conguration for the Solr 5 client library and abstractions on top of it provided by
Spring Data Solr. There is a springbootstarterdatasolr Starter for collecting the dependencies in a convenient way.
30.5.1Connecting to Solr
You can inject an auto-congured SolrClient instance as you would any other Spring bean. By default the instance will attempt to connect to
a server using localhost:8983/solr :
@Component
publicclassMyBean{
privateSolrClientsolr;
@Autowired
publicMyBean(SolrClientsolr){
this.solr=solr;
}
//...
If you add a @Bean of your own of type SolrClient it will replace the default.
30.5.2Spring Data Solr repositories

Spring Data includes repository support for Apache Solr. As with the JPA repositories discussed earlier, the basic principle is that queries are
In fact, both Spring Data JPA and Spring Data Solr share the same common infrastructure; so you could take the JPA example from earlier and,
assuming that City is now a @SolrDocument class rather than a JPA @Entity , it will work in the same way.
For complete details of Spring Data Solr, refer to their reference documentation.
30.6Elasticsearch
Elasticsearch is an open source, distributed, real-time search and analytics engine. Spring Boot offers basic auto-conguration for the
Elasticsearch and abstractions on top of it provided by Spring Data Elasticsearch. There is a springbootstarterdataelasticsearch
Starter for collecting the dependencies in a convenient way. Spring Boot also supports Jest.
30.6.1Connecting to Elasticsearch using Jest

If you have Jest on the classpath, you can inject an auto-congured JestClient targeting localhost:9200 by default. You can further
tune how the client is congured:
spring.elasticsearch.jest.uris=http://search.example.com:9200
spring.elasticsearch.jest.readtimeout=10000
spring.elasticsearch.jest.username=user
spring.elasticsearch.jest.password=secret
You can also register an arbitrary number of beans implementing HttpClientConfigBuilderCustomizer for more advanced customizations.
The example below tunes additional HTTP settings:
staticclassHttpSettingsCustomizerimplementsHttpClientConfigBuilderCustomizer{
@Override
publicvoidcustomize(HttpClientConfig.Builderbuilder){
builder.maxTotalConnection(100).defaultMaxTotalConnectionPerRoute(5);
}
To take full control over the registration, dene a JestClient bean.
30.6.2Connecting to Elasticsearch using Spring Data

You can inject an auto-congured ElasticsearchTemplate or Elasticsearch Client instance as you would any other Spring Bean. By
default the instance will embed a local in-memory server (a Node in Elasticsearch terms) and use the current working directory as the home
directory for the server. In this setup, the rst thing to do is to tell Elasticsearch where to store its les:
spring.data.elasticsearch.properties.path.home=/foo/bar
Alternatively, you can switch to a remote server (i.e. a TransportClient ) by setting spring.data.elasticsearch.clusternodes to a
comma-separated host:port list.
spring.data.elasticsearch.clusternodes=localhost:9300
@Component
publicclassMyBean{
privateElasticsearchTemplatetemplate;
@Autowired
publicMyBean(ElasticsearchTemplatetemplate){
}
//...
If you add a @Bean of your own of type ElasticsearchTemplate it will replace the default.
30.6.3Spring Data Elasticsearch repositories

Spring Data includes repository support for Elasticsearch. As with the JPA repositories discussed earlier, the basic principle is that queries are
In fact, both Spring Data JPA and Spring Data Elasticsearch share the same common infrastructure; so you could take the JPA example from
earlier and, assuming that City is now an Elasticsearch @Document class rather than a JPA @Entity , it will work in the same way.
For complete details of Spring Data Elasticsearch, refer to their reference documentation.
30.7Cassandra
Cassandra is an open source, distributed database management system designed to handle large amounts of data across many commodity
servers. Spring Boot offers auto-conguration for Cassandra and abstractions on top of it provided by Spring Data Cassandra. There is a
springbootstarterdatacassandra Starter for collecting the dependencies in a convenient way.
30.7.1Connecting to Cassandra
You can inject an auto-congured CassandraTemplate or a Cassandra Session instance as you would with any other Spring Bean. The
spring.data.cassandra.* properties can be used to customize the connection. Generally you will provide keyspacename and
contactpoints properties:
spring.data.cassandra.keyspacename=mykeyspace
spring.data.cassandra.contactpoints=cassandrahost1,cassandrahost2
@Component
publicclassMyBean{
privateCassandraTemplatetemplate;
@Autowired
publicMyBean(CassandraTemplatetemplate){
}
//...
If you add a @Bean of your own of type CassandraTemplate it will replace the default.
30.7.2Spring Data Cassandra repositories

Spring Data includes basic repository support for Cassandra. Currently this is more limited than the JPA repositories discussed earlier, and will
need to annotate nder methods with @Query .
For complete details of Spring Data Cassandra, refer to their reference documentation.
30.8Couchbase
Couchbase is an open-source, distributed multi-model NoSQL document-oriented database that is optimized for interactive applications. Spring
Boot offers auto-conguration for Couchbase and abstractions on top of it provided by Spring Data Couchbase. There is a
springbootstarterdatacouchbase Starter for collecting the dependencies in a convenient way.
30.8.1Connecting to Couchbase
You can very easily get a Bucket and Cluster by adding the Couchbase SDK and some conguration. The spring.couchbase.*
properties can be used to customize the connection. Generally you will provide the bootstrap hosts, bucket name and password:
spring.couchbase.bootstraphosts=myhost1,192.168.1.123
spring.couchbase.bucket.name=mybucket
spring.couchbase.bucket.password=secret
You need to provide at least the bootstrap host(s), in which case the bucket name is default and the password is the empty
String. Alternatively, you can dene your own org.springframework.data.couchbase.config.CouchbaseConfigurer
@Bean to take control over the whole conguration.
It is also possible to customize some of the CouchbaseEnvironment settings. For instance the following conguration changes the timeout to
use to open a new Bucket and enables SSL support:
spring.couchbase.env.timeouts.connect=3000
spring.couchbase.env.ssl.keystore=/location/of/keystore.jks
spring.couchbase.env.ssl.keystorepassword=secret
Check the spring.couchbase.env.* properties for more details.
30.8.2Spring Data Couchbase repositories

Spring Data includes repository support for Couchbase. For complete details of Spring Data Couchbase, refer to their reference documentation.
You can inject an auto-congured CouchbaseTemplate instance as you would with any other Spring Bean as long as a default
CouchbaseConfigurer is available (that happens when you enable the couchbase support as explained above).
@Component
publicclassMyBean{
privatefinalCouchbaseTemplatetemplate;
@Autowired
publicMyBean(CouchbaseTemplatetemplate){
}
//...
There are a few beans that you can dene in your own conguration to override those provided by the auto-conguration:
A CouchbaseTemplate @Bean with name couchbaseTemplate

An IndexManager @Bean with name couchbaseIndexManager
A CustomConversions @Bean with name couchbaseCustomConversions
To avoid hard-coding those names in your own cong, you can reuse BeanNames provided by Spring Data Couchbase. For instance, you can
customize the converters to use as follows:
@Configuration
publicclassSomeConfiguration{
@Bean(BeanNames.COUCHBASE_CUSTOM_CONVERSIONS)
publicCustomConversionsmyCustomConversions(){
returnnewCustomConversions(...);
}
//...
If you want to fully bypass the auto-conguration for Spring Data Couchbase, provide your own
org.springframework.data.couchbase.config.AbstractCouchbaseDataConfiguration implementation.
30.9LDAP
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-conguration 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 springbootstarterdataldap Starter for collecting the dependencies
in a convenient way.
30.9.1Connecting to an LDAP server

To connect to an LDAP server make sure you declare a dependency on the springbootstarterdataldap Starter or
springldapcore then declare the URLs of your server in your application.properties:
spring.ldap.urls=ldap://myserver:1235
spring.ldap.username=admin
spring.ldap.password=secret
If you need to customize connection settings you can use the spring.ldap.base and spring.ldap.baseenvironment properties.
30.9.2Spring Data LDAP repositories

Spring Data includes repository support for LDAP. For complete details of Spring Data LDAP, refer to their reference documentation.
You can also inject an auto-congured LdapTemplate instance as you would with any other Spring Bean.
@Component
publicclassMyBean{
privatefinalLdapTemplatetemplate;
@Autowired
publicMyBean(LdapTemplatetemplate){
}
//...
30.9.3Embedded in-memory LDAP server

For testing purposes Spring Boot supports auto-conguration of an in-memory LDAP server from UnboundID. To congure the server add a
dependency to com.unboundid:unboundidldapsdk and declare a basedn property:
spring.ldap.embedded.basedn=dc=spring,dc=io
By default the server will start on a random port and they trigger the regular LDAP support (there is no need to specify a spring.ldap.urls
property).
If there is a schema.ldif le on your classpath it will be used to initialize the server. You can also use the spring.ldap.embedded.ldif
property if you want to load the initialization script from a different resource.
31.Caching
The Spring Framework provides support for transparently adding caching to an application. At its core, the abstraction applies caching to
methods, reducing thus the number of executions based on the information available in the cache. The caching logic is applied transparently,
without any interference to the invoker.
Check the relevant section of the Spring Framework reference for more details.
In a nutshell, adding caching to an operation of your service is as easy as adding the relevant annotation to its method:
importjavax.cache.annotation.CacheResult;
@Component
publicclassMathService{
@CacheResult
publicintcomputePiDecimal(inti){
//...
}
You can either use the standard JSR-107 (JCache) annotations or Springs own caching annotations transparently. We strongly
advise you however to not mix and match them.
It is also possible to update or evict data from the cache transparently.
31.1Supported 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. Spring Boot auto-congures a suitable CacheManager according to the
implementation as long as the caching support is enabled via the @EnableCaching annotation.
If you are using the cache infrastructure with beans that are not interface-based, make sure to enable the proxyTargetClass
attribute of @EnableCaching .
Use the springbootstartercache Starter to quickly add basic caching dependencies. The starter brings
springcontextsupport : if you are adding dependencies manually, you must include it if you intend to use the JCache,
EhCache 2.x or Guava support.
If you havent dened a bean of type CacheManager or a CacheResolver named cacheResolver (see CachingConfigurer ), Spring Boot
tries to detect the following providers (in this order):
Generic
JCache (JSR-107) (EhCache 3, Hazelcast, Innispan, etc)
EhCache 2.x
Hazelcast
Innispan
Couchbase
Redis
Caffeine
Simple
It is also possible to force the cache provider to use via the spring.cache.type property. Use this property if you need to
disable caching altogether in certain environment (e.g. tests).
If the CacheManager is auto-congured by Spring Boot, you can further tune its conguration before it is fully initialized by exposing a bean
implementing the CacheManagerCustomizer interface. The following sets the cache names to use.
@Bean
publicCacheManagerCustomizer<ConcurrentMapCacheManager>cacheManagerCustomizer(){
returnnewCacheManagerCustomizer<ConcurrentMapCacheManager>(){
@Override
publicvoidcustomize(ConcurrentMapCacheManagercacheManager){
cacheManager.setCacheNames(Arrays.asList("one","two"));
}
};
}
In the example above, a ConcurrentMapCacheManager is expected to be congured. If that is not the case, the customizer wont
be invoked at all. You can have as many customizers as you want and you can also order them as usual using @Order or
Ordered .
31.1.1Generic
Generic caching is used if the context denes at least one org.springframework.cache.Cache bean, a CacheManager wrapping them is
congured.
31.1.2JCache (JSR-107)
JCache is bootstrapped via the presence of a javax.cache.spi.CachingProvider on the classpath (i.e. a JSR-107 compliant caching
library) and the JCacheCacheManager provided by the springbootstartercache Starter. There are various compliant libraries out
there and Spring Boot provides dependency management for Ehcache 3, Hazelcast and Innispan. 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 specied. Even if the JSR-107 standard
does not enforce a standardized way to dene the location of the conguration le, Spring Boot does its best to accommodate with
implementation details.
#Onlynecessaryifmorethanoneproviderispresent
spring.cache.jcache.provider=com.acme.MyCachingProvider
spring.cache.jcache.config=classpath:acme.xml
Since a cache library may offer both a native implementation and JSR-107 support Spring Boot will prefer the JSR-107 support so
that the same features are available if you switch to a different JSR-107 implementation.
There are several ways to customize the underlying javax.cache.cacheManager :
Caches can be created on startup via the spring.cache.cachenames property. If a custom

javax.cache.configuration.Configuration bean is dened, 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 dened, it is wrapped automatically in a

org.springframework.cache.CacheManager implementation that the abstraction expects. No further customization is applied
on it.
31.1.3EhCache 2.x
EhCache 2.x is used if a le named ehcache.xml can be found at the root of the classpath. If EhCache 2.x, the EhCacheCacheManager
provided by the springbootstartercache Starter and such le is present it is used to bootstrap the cache manager. An alternate
conguration le can be provided as well using:
spring.cache.ehcache.config=classpath:config/anotherconfig.xml
31.1.4Hazelcast
Spring Boot has a general support for Hazelcast. If a HazelcastInstance has been auto-congured, it is automatically wrapped in a
CacheManager .
If for some reason you need a different HazelcastInstance for caching, you can request Spring Boot to create a separate one that will be
only used by the CacheManager :
spring.cache.hazelcast.config=classpath:config/mycachehazelcast.xml
If a separate HazelcastInstance is created that way, it is not registered in the application context.
31.1.5Innispan
Innispan has no default conguration le location so it must be specied explicitly (or the default bootstrap is used).
spring.cache.infinispan.config=infinispan.xml
Caches can be created on startup via the spring.cache.cachenames property. If a custom ConfigurationBuilder bean is dened, it is
used to customize them.
31.1.6Couchbase
If the Couchbase java client and the couchbasespringcache implementation are available and Couchbase is congured, a
CouchbaseCacheManager will be auto-congured. It is also possible to create additional caches on startup using the
spring.cache.cachenames property. These will operate on the Bucket that was auto-congured. You can also create additional caches on
another Bucket using the customizer: assume you need two caches on the "main" Bucket ( foo and bar ) and one biz cache with a
custom time to live of 2sec on the another Bucket . First, you can create the two rst caches simply via conguration:
spring.cache.cachenames=foo,bar
Then dene this extra @Configuration to congure the extra Bucket and the biz cache:
@Configuration
publicclassCouchbaseCacheConfiguration{
privatefinalClustercluster;
publicCouchbaseCacheConfiguration(Clustercluster){
this.cluster=cluster;
}
@Bean
publicBucketanotherBucket(){
returnthis.cluster.openBucket("another","secret");
}
@Bean
publicCacheManagerCustomizer<CouchbaseCacheManager>cacheManagerCustomizer(){
returnc>{
c.prepareCache("biz",CacheBuilder.newInstance(anotherBucket())
.withExpiration(2));
};
}
This sample conguration reuses the Cluster that was created via auto-conguration.
31.1.7Redis
If Redis is available and congured, the RedisCacheManager is auto-congured. It is also possible to create additional caches on startup using
the spring.cache.cachenames property.
By default, a key prex is added to prevent that if two separate caches use the same key, Redis would have overlapping keys and
be likely to return invalid values. We strongly recommend to keep this setting enabled if you create your own
RedisCacheManager .
31.1.8Caffeine
Caffeine is a Java 8 rewrite of Guavas cache that supersede the Guava support. If Caffeine is present, a CaffeineCacheManager (provided
by the springbootstartercache Starter) is auto-congured. Caches can be created on startup using the spring.cache.cachenames
property and customized by one of the following (in this order):
1. A cache spec dened by spring.cache.caffeine.spec

2. A com.github.benmanes.caffeine.cache.CaffeineSpec bean is dened
3. A com.github.benmanes.caffeine.cache.Caffeine bean is dened
For instance, the following conguration creates a foo and bar caches with a maximum size of 500 and a time to live of 10 minutes
spring.cache.cachenames=foo,bar
spring.cache.caffeine.spec=maximumSize=500,expireAfterAccess=600s
Besides, if a com.github.benmanes.caffeine.cache.CacheLoader bean is dened, it is automatically associated to the

CaffeineCacheManager . Since the CacheLoader is going to be associated to all caches managed by the cache manager, it must be dened
as CacheLoader<Object,Object> . Any other generic type will be ignored by the auto-conguration.
31.1.9Simple
If none of these options worked out, a simple implementation using ConcurrentHashMap as cache store is congured. This is the default if no
caching library is present in your application.
31.1.10None
When @EnableCaching is present in your conguration, a suitable cache conguration 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:
spring.cache.type=none
32.Messaging
The Spring Framework provides extensive support for integrating with messaging systems: from simplied 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 and Spring Boot also provides auto-conguration options for RabbitTemplate and RabbitMQ. There is also
support for STOMP messaging natively in Spring WebSocket and Spring Boot has support for that through starters and a small amount of auto-
conguration. Spring Boot also has support for Apache Kafka.
32.1JMS
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 wont need to use it directly yourself and you can
instead rely on higher level messaging abstractions (see the relevant section of the Spring Framework reference documentation for details).
Spring Boot also auto-congures the necessary infrastructure to send and receive messages.
32.1.1ActiveMQ support
Spring Boot can also congure a ConnectionFactory when it detects that ActiveMQ is available on the classpath. If the broker is present, an
embedded broker is started and congured automatically (as long as no broker URL is specied through conguration).
If you are using springbootstarteractivemq the necessary dependencies to connect or embed an ActiveMQ instance are
provided, as well as the Spring infrastructure to integrate with JMS.
ActiveMQ conguration is controlled by external conguration properties in spring.activemq.* . For example, you might declare the following
section in application.properties :
spring.activemq.brokerurl=tcp://192.168.1.210:9876
spring.activemq.user=admin
spring.activemq.password=secret
See ActiveMQProperties for more of the supported options.
By default, ActiveMQ creates a destination if it does not exist yet, so destinations are resolved against their provided names.
32.1.2Artemis support
Spring Boot can auto-congure a ConnectionFactory when it detects that Artemis is available on the classpath. If the broker is present, an
embedded broker is started and congured automatically (unless the mode property has been explicitly set). The supported modes are:
embedded (to make explicit that an embedded broker is required and should lead to an error if the broker is not available in the classpath), and
native to connect to a broker using the netty transport protocol. When the latter is congured, Spring Boot congures a
ConnectionFactory connecting to a broker running on the local machine with the default settings.
If you are using springbootstarterartemis the necessary dependencies to connect to an existing Artemis instance are
provided, as well as the Spring infrastructure to integrate with JMS. Adding org.apache.activemq:artemisjmsserver to
your application allows you to use the embedded mode.
Artemis conguration is controlled by external conguration properties in spring.artemis.* . For example, you might declare the following
spring.artemis.mode=native
spring.artemis.host=192.168.1.210
spring.artemis.port=9876
spring.artemis.user=admin
spring.artemis.password=secret
When embedding the broker, you can choose if you want to enable persistence, and the list of destinations that should be made available.
These can be specied as a comma-separated list to create them with the default options; or you can dene 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 congurations respectively.
See ArtemisProperties for more of the supported options.
No JNDI lookup is involved at all and destinations are resolved against their names, either using the name attribute in the Artemis conguration
or the names provided through conguration.
32.1.3Using a JNDI ConnectionFactory

If you are running your application in an Application Server Spring Boot will attempt to locate a JMS ConnectionFactory using JNDI. By
default the locations java:/JmsXA and java:/XAConnectionFactory will be checked. You can use the spring.jms.jndiname property if
you need to specify an alternative location:
spring.jms.jndiname=java:/MyConnectionFactory
32.1.4Sending a message
Springs JmsTemplate is auto-congured and you can autowire it directly into your own beans:
importorg.springframework.jms.core.JmsTemplate;
@Component
publicclassMyBean{
privatefinalJmsTemplatejmsTemplate;
@Autowired
publicMyBean(JmsTemplatejmsTemplate){
this.jmsTemplate=jmsTemplate;
}
//...
JmsMessagingTemplate can be injected in a similar manner. If a DestinationResolver or MessageConverter beans are

dened, they are associated automatically to the auto-congured JmsTemplate .
32.1.5Receiving 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 dened, a default one is congured automatically. If a DestinationResolver or
MessageConverter beans are dened, they are associated automatically to the default factory.
The default factory is transactional by default. If you are running in an infrastructure where a JtaTransactionManager is present, it will be
associated to the listener container by default. If not, the sessionTransacted ag will be 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 will make sure 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.
The following component creates a listener endpoint on the someQueue destination:
@Component
publicclassMyBean{
@JmsListener(destination="someQueue")
publicvoidprocessMessage(Stringcontent){
//...
}
Check 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-congured.
For instance, the following exposes another factory that uses a specic MessageConverter :
@Configuration
staticclassJmsConfiguration{
@Bean
publicDefaultJmsListenerContainerFactorymyFactory(
DefaultJmsListenerContainerFactoryConfigurerconfigurer){
DefaultJmsListenerContainerFactoryfactory=
newDefaultJmsListenerContainerFactory();
configurer.configure(factory,connectionFactory());
factory.setMessageConverter(myMessageConverter());
returnfactory;
}
Then you can use in any @JmsListener -annotated method as follows:
@Component
publicclassMyBean{
@JmsListener(destination="someQueue",containerFactory="myFactory")
//...
}
32.2AMQP
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 development of AMQP-based messaging solutions. Spring Boot offers several conveniences
for working with AMQP via RabbitMQ, including the springbootstarteramqp Starter.
32.2.1RabbitMQ support
RabbitMQ is a lightweight, reliable, scalable and portable message broker based on the AMQP protocol. Spring uses RabbitMQ to
communicate using the AMQP protocol.
RabbitMQ conguration is controlled by external conguration properties in spring.rabbitmq.* . For example, you might declare the following
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=admin
spring.rabbitmq.password=secret
See RabbitProperties for more of the supported options.
Check Understanding AMQP, the protocol used by RabbitMQ for more details.
32.2.2Sending a message
Springs AmqpTemplate and AmqpAdmin are auto-congured and you can autowire them directly into your own beans:
importorg.springframework.amqp.core.AmqpAdmin;
importorg.springframework.amqp.core.AmqpTemplate;
@Component
publicclassMyBean{
privatefinalAmqpAdminamqpAdmin;
privatefinalAmqpTemplateamqpTemplate;
@Autowired
publicMyBean(AmqpAdminamqpAdmin,AmqpTemplateamqpTemplate){
this.amqpAdmin=amqpAdmin;
this.amqpTemplate=amqpTemplate;
}
//...
RabbitMessagingTemplate can be injected in a similar manner. If a MessageConverter bean is dened, it is associated

automatically to the auto-congured AmqpTemplate .
Any org.springframework.amqp.core.Queue that is dened as a bean will be automatically used to declare a corresponding queue on the
RabbitMQ instance if necessary.
You can enable retries on the AmqpTemplate to retry operations, for example in the event the broker connection is lost. Retries are disabled by
default.
32.2.3Receiving 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 dened, a default one is congured automatically. If a MessageConverter or
MessageRecoverer beans are dened, they are associated automatically to the default factory.
The following component creates a listener endpoint on the someQueue queue:
@Component
publicclassMyBean{
@RabbitListener(queues="someQueue")
//...
}
Check 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 that you can use to initialize a SimpleRabbitListenerContainerFactory with the
same settings as the one that is auto-congured.
For instance, the following exposes another factory that uses a specic MessageConverter :
@Configuration
staticclassRabbitConfiguration{
@Bean
publicSimpleRabbitListenerContainerFactorymyFactory(
SimpleRabbitListenerContainerFactoryConfigurerconfigurer){
SimpleRabbitListenerContainerFactoryfactory=
newSimpleRabbitListenerContainerFactory();
configurer.configure(factory,connectionFactory);
factory.setMessageConverter(myMessageConverter());
returnfactory;
}
Then you can use in any @RabbitListener -annotated method as follows:
@Component
publicclassMyBean{
@RabbitListener(queues="someQueue",containerFactory="myFactory")
//...
}
You can enable retries to handle situations where your listener throws an exception. By default RejectAndDontRequeueRecoverer is used but
you can dene a MessageRecoverer of your own. When retries are exhausted, the message will be rejected and either dropped or routed to a
dead-letter exchange if the broker is congured so. Retries are disabled by default.
Important
If retries are not enabled and the listener throws an exception, by default the delivery will be retried indenitely. You can modify
this behavior in two ways; set the defaultRequeueRejected property to false and zero re-deliveries will be attempted; or,
throw an AmqpRejectAndDontRequeueException to signal the message should be rejected. This is the mechanism used when
retries are enabled and the maximum delivery attempts are reached.
32.3Apache Kafka Support

Apache Kafka is supported by providing auto-conguration of the springkafka project.
Kafka conguration is controlled by external conguration properties in spring.kafka.* . For example, you might declare the following section
in application.properties :
spring.kafka.bootstrapservers=localhost:9092
spring.kafka.consumer.groupid=myGroup
See KafkaProperties for more of the supported options.
32.3.1Sending a Message
Springs KafkaTemplate is auto-congured and you can autowire them directly in your own beans:
@Component
publicclassMyBean{
privatefinalKafkaTemplatekafkaTemplate;
@Autowired
publicMyBean(KafkaTemplatekafkaTemplate){
this.kafkaTemplate=kafkaTemplate;
}
//...
32.3.2Receiving 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 dened, a default one is congured automatically with keys dened in
spring.kafka.listener.* .
The following component creates a listener endpoint on the someTopic topic:
@Component
publicclassMyBean{
@KafkaListener(topics="someTopic")
//...
}
32.3.3Additional Kafka Properties
The properties supported by auto conguration are shown in AppendixA, Common application properties. Note that these properties
(hyphenated or camelCase) map directly to the Apache Kafka dotted properties for the most part, refer to the Apache Kafka documentation for
details.
The rst few of these properties apply to both producers and consumers, but can be specied at the producer or consumer level if you wish to
use different values for each. Apache Kafka designates properties with an importance: HIGH, MEDIUM and LOW. Spring Boot auto
conguration supports all HIGH importance properties, some selected MEDIUM and LOW, and any that do not have a default value.
Only a subset of the properties supported by Kafka are available via the KafkaProperties class. If you wish to congure the producer or
consumer with additional properties that are not directly supported, use the following:
spring.kafka.properties.foo.bar=baz
This sets the common foo.bar Kafka property to baz .
These properties will be shared by both the consumer and producer factory beans. If you wish to customize these components with different
properties, such as to use a different metrics reader for each, you can override the bean denitions, as follows:
@Configuration
publicstaticclassCustomKafkaBeans{
/**
*CustomizedProducerFactorybean.
*@parampropertiesthekafkaproperties.
*@returnthebean.
*/
@Bean
publicProducerFactory<?,?>kafkaProducerFactory(KafkaPropertiesproperties){
Map<String,Object>producerProperties=properties.buildProducerProperties();
producerProperties.put(CommonClientConfigs.METRIC_REPORTER_CLASSES_CONFIG,
MyProducerMetricsReporter.class);
returnnewDefaultKafkaProducerFactory<Object,Object>(producerProperties);
}
/**
*CustomizedConsumerFactorybean.
*@parampropertiesthekafkaproperties.
*@returnthebean.
*/
@Bean
publicConsumerFactory<?,?>kafkaConsumerFactory(KafkaPropertiesproperties){
Map<String,Object>consumerProperties=properties.buildConsumerProperties();
consumerProperties.put(CommonClientConfigs.METRIC_REPORTER_CLASSES_CONFIG,
MyConsumerMetricsReporter.class);
returnnewDefaultKafkaConsumerFactory<Object,Object>(consumerProperties);
}
33.Calling REST services

If you need to call remote REST services from your application, you can use Spring Frameworks RestTemplate class. Since RestTemplate
instances often need to be customized before being used, Spring Boot does not provide any single auto-congured RestTemplate bean. It
does, however, auto-congure a RestTemplateBuilder which can be used to create RestTemplate instances when needed. The auto-
congured RestTemplateBuilder will ensure that sensible HttpMessageConverters are applied to RestTemplate instances.
Heres a typical example:
@Service
publicclassMyBean{
privatefinalRestTemplaterestTemplate;
publicMyBean(RestTemplateBuilderrestTemplateBuilder){
this.restTemplate=restTemplateBuilder.build();
}
publicDetailssomeRestCall(Stringname){
returnthis.restTemplate.getForObject("/{name}/details",Details.class,name);
}
RestTemplateBuilder includes a number of useful methods that can be used to quickly congure a RestTemplate . For
example, to add BASIC auth support you can use builder.basicAuthorization("user","password").build() .
33.1RestTemplate 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-congured RestTemplateBuilder and then call its methods
as required. Each method call returns a new RestTemplateBuilder instance so the customizations will only affect this use of the builder.
To make an application-wide, additive customization a RestTemplateCustomizer bean can be used. All such beans are automatically
registered with the auto-congured RestTemplateBuilder and will be applied to any templates that are built with it.
Heres an example of a customizer that congures the use of a proxy for all hosts except 192.168.0.5 :
staticclassProxyCustomizerimplementsRestTemplateCustomizer{
@Override
publicvoidcustomize(RestTemplaterestTemplate){
HttpHostproxy=newHttpHost("proxy.example.com");
HttpClienthttpClient=HttpClientBuilder.create()
.setRoutePlanner(newDefaultProxyRoutePlanner(proxy){
@Override
publicHttpHostdetermineProxy(HttpHosttarget,
HttpRequestrequest,HttpContextcontext)
throwsHttpException{
if(target.getHostName().equals("192.168.0.5")){
returnnull;
}
returnsuper.determineProxy(target,request,context);
}
}).build();
restTemplate.setRequestFactory(
newHttpComponentsClientHttpRequestFactory(httpClient));
}
Lastly, the most extreme (and rarely used) option is to create your own RestTemplateBuilder bean. This will switch off the auto-conguration
of a RestTemplateBuilder and will prevent any RestTemplateCustomizer beans from being used.
34.Validation
The method validation feature supported by Bean Validation 1.1 is automatically enabled as long as a JSR-303 implementation (e.g. Hibernate
validator) is on the classpath. This allows bean methods to 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 rst argument, making sure its size is between 8 and 10
@Service
@Validated
publicclassMyBean{
publicArchivefindByCodeAndAuthor(@Size(min=8,max=10)Stringcode,
Authorauthor){
...
}
35.Sending email
The Spring Framework provides an easy abstraction for sending email using the JavaMailSender interface and Spring Boot provides auto-
conguration for it as well as a starter module.
Check the reference documentation for a detailed explanation of how you can use JavaMailSender .
If spring.mail.host and the relevant libraries (as dened by springbootstartermail ) are available, a default JavaMailSender is
created if none exists. The sender can be further customized by conguration items from the spring.mail namespace, see the
MailProperties for more details.
In particular, certain default timeout values are innite and you may want to change that to avoid having a thread blocked by an unresponsive
mail server:
spring.mail.properties.mail.smtp.connecttimeout=5000
spring.mail.properties.mail.smtp.timeout=3000
spring.mail.properties.mail.smtp.writetimeout=5000
36.Distributed Transactions with JTA

Spring Boot supports distributed JTA transactions across multiple XA resources using either an Atomikos or Bitronix embedded transaction
manager. JTA transactions are also supported when deploying to a suitable Java EE Application Server.
When a JTA environment is detected, Springs JtaTransactionManager will be used to manage transactions. Auto-congured JMS,
DataSource and JPA beans will be 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-conguration.
36.1Using an Atomikos transaction manager

Atomikos is a popular open source transaction manager which can be embedded into your Spring Boot application. You can use the
springbootstarterjtaatomikos Starter to pull in the appropriate Atomikos libraries. Spring Boot will auto-congure Atomikos and
ensure that appropriate dependson settings are applied to your Spring beans for correct startup and shutdown ordering.
By default Atomikos transaction logs will be written to a transactionlogs directory in your application home directory (the directory in which
your application jar le resides). You can customize this directory by setting a spring.jta.logdir property in your
application.properties le. Properties starting spring.jta.atomikos.properties can also be used to customize the Atomikos
UserTransactionServiceImp . See the AtomikosProperties Javadoc for complete details.
To ensure that multiple transaction managers can safely coordinate the same resource managers, each Atomikos instance must
be congured with a unique ID. By default this ID is the IP address of the machine on which Atomikos is running. To ensure
uniqueness in production, you should congure the spring.jta.transactionmanagerid property with a different value for
each instance of your application.
36.2Using a Bitronix transaction manager

Bitronix is popular open source JTA transaction manager implementation. You can use the springbootstarterjtabitronix starter to
add the appropriate Bitronix dependencies to your project. As with Atomikos, Spring Boot will automatically congure Bitronix and post-process
your beans to ensure that startup and shutdown ordering is correct.
By default Bitronix transaction log les ( part1.btm and part2.btm ) will be written to a transactionlogs directory in your application
home directory. You can customize this directory by using the spring.jta.logdir property. Properties starting
spring.jta.bitronix.properties are also bound to the bitronix.tm.Configuration bean, allowing for complete customization. See
the Bitronix documentation for details.
To ensure that multiple transaction managers can safely coordinate the same resource managers, each Bitronix instance must be
congured with a unique ID. By default this ID is the IP address of the machine on which Bitronix is running. To ensure
uniqueness in production, you should congure the spring.jta.transactionmanagerid property with a different value for
each instance of your application.
36.3Using a Narayana transaction manager

Narayana is popular open source JTA transaction manager implementation supported by JBoss. You can use the
springbootstarterjtanarayana starter to add the appropriate Narayana dependencies to your project. As with Atomikos and Bitronix,
Spring Boot will automatically congure Narayana and post-process your beans to ensure that startup and shutdown ordering is correct.
By default Narayana transaction logs will be written to a transactionlogs directory in your application home directory (the directory in which
your application jar le resides). You can customize this directory by setting a spring.jta.logdir property in your
application.properties le. Properties starting spring.jta.narayana.properties can also be used to customize the Narayana
conguration. See the NarayanaProperties Javadoc for complete details.
To ensure that multiple transaction managers can safely coordinate the same resource managers, each Narayana instance must
be congured with a unique ID. By default this ID is set to 1 . To ensure uniqueness in production, you should congure the
spring.jta.transactionmanagerid property with a different value for each instance of your application.
36.4Using a Java EE managed transaction manager

If you are packaging your Spring Boot application as a war or ear le and deploying it to a Java EE application server, you can use your
application servers built-in transaction manager. Spring Boot will attempt to auto-congure a transaction manager by looking at common JNDI
locations ( java:comp/UserTransaction , java:comp/TransactionManager etc). If you are using a transaction service provided by your
application server, you will generally also want to ensure that all resources are managed by the server and exposed over JNDI. Spring Boot will
attempt to auto-congure JMS by looking for a ConnectionFactory at the JNDI path java:/JmsXA or java:/XAConnectionFactory and
you can use the spring.datasource.jndiname property to congure your DataSource .
36.5Mixing XA and non-XA JMS connections

When using JTA, the primary JMS ConnectionFactory bean will be XA aware and participate in distributed transactions. In some situations
you might want to process certain JMS messages 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 inject the nonXaJmsConnectionFactory bean rather than the @Primary
jmsConnectionFactory bean. For consistency the jmsConnectionFactory bean is also provided using the bean alias
xaJmsConnectionFactory .
For example:
//Injecttheprimary(XAaware)ConnectionFactory
@Autowired
privateConnectionFactorydefaultConnectionFactory;
//InjecttheXAawareConnectionFactory(usesthealiasandinjectsthesameasabove)
@Autowired
@Qualifier("xaJmsConnectionFactory")
privateConnectionFactoryxaConnectionFactory;
//InjectthenonXAawareConnectionFactory
@Autowired
@Qualifier("nonXaJmsConnectionFactory")
privateConnectionFactorynonXaConnectionFactory;
36.6Supporting an alternative embedded transaction manager

The XAConnectionFactoryWrapper and XADataSourceWrapper interfaces can be used to support alternative embedded transaction
managers. The interfaces are responsible for wrapping XAConnectionFactory and XADataSource beans and exposing them as regular
ConnectionFactory and DataSource beans which will transparently enroll in the distributed transaction. DataSource and JMS auto-
conguration will use JTA variants as long as you have a JtaTransactionManager bean and appropriate XA wrapper beans registered within
your ApplicationContext .
The BitronixXAConnectionFactoryWrapper and BitronixXADataSourceWrapper provide good examples of how to write XA wrappers.
37.Hazelcast
If hazelcast is on the classpath, Spring Boot will auto-congure an HazelcastInstance that you can inject in your application. The
HazelcastInstance is only created if a conguration is found.
You can dene a com.hazelcast.config.Config bean and well use that. If your conguration denes an instance name, well try to locate
an existing instance rather than creating a new one.
You could also specify the hazelcast.xml conguration le to use via conguration:
spring.hazelcast.config=classpath:config/myhazelcast.xml
Otherwise, Spring Boot tries to nd the Hazelcast conguration from the default locations, that is hazelcast.xml in the working directory or at
the root of the classpath. We also check if the hazelcast.config system property is set. Check the Hazelcast documentation for more
details.
Spring Boot also has an explicit caching support for Hazelcast. The HazelcastInstance is automatically wrapped in a
CacheManager implementation if caching is enabled.
38.Spring Integration
Spring Boot offers several conveniences for working with Spring Integration, including the springbootstarterintegration Starter.
Spring Integration provides abstractions over messaging and also other transports such as HTTP, TCP etc. If Spring Integration is available on
your classpath it will be initialized through the @EnableIntegration annotation. Message processing statistics will be published over JMX if
'springintegrationjmx' is also on the classpath. See the IntegrationAutoConfiguration class for more details.
39.Spring Session
Spring Boot provides Spring Session auto-conguration for a wide range of stores:
JDBC
MongoDB
Redis
Hazelcast
HashMap
If Spring Session is available, you must choose the StoreType that you wish to use to store the sessions. For instance to use JDBC as
backend store, youd congure your application as follows:
spring.session.storetype=jdbc
You can disable Spring Session by setting the storetype to none .
Each store has specic additional settings. For instance it is possible to customize the name of the table for the jdbc store:
spring.session.jdbc.tablename=SESSIONS
40.Monitoring and management over JMX

Java Management Extensions (JMX) provide a standard mechanism to monitor and manage applications. By default Spring Boot will create an
MBeanServer with bean id mbeanServer and expose any of your beans that are annotated with Spring JMX annotations
( @ManagedResource , @ManagedAttribute , @ManagedOperation ).
See the JmxAutoConfiguration class for more details.
41.Testing
Spring Boot provides a number of utilities and annotations to help when testing your application. Test support is provided by two modules;
springboottest contains core items, and springboottestautoconfigure supports auto-conguration for tests.
Most developers will just use the springbootstartertest Starter which imports both Spring Boot test modules as well has JUnit,
AssertJ, Hamcrest and a number of other useful libraries.
41.1Test scope dependencies

If you use the springbootstartertest Starter (in the test scope ), you will nd the following provided libraries:
JUnitThe de-facto standard for unit testing Java applications.

Spring Test & Spring Boot TestUtilities and integration test support for Spring Boot applications.
AssertJA uent assertion library.
HamcrestA library of matcher objects (also known as constraints or predicates).
MockitoA Java mocking framework.
JSONassertAn assertion library for JSON.
JsonPathXPath for JSON.
These are common libraries that we generally nd useful when writing tests. You are free to add additional test dependencies of your own if
these dont suit your needs.
41.2Testing Spring applications

One of the major advantages of dependency injection is that it should make your code easier to unit test. You can simply instantiate objects
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 actually involved in the
process). Its 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 just such integration testing. You can declare a dependency directly to
org.springframework:springtest or use the springbootstartertest Starter to pull it in transitively.
If you have not used the springtest module before you should start by reading the relevant section of the Spring Framework reference
documentation.
41.3Testing Spring Boot applications

A Spring Boot application is just 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. One thing to watch out for though is that the external properties, logging and other features of Spring
Boot are only installed in the context by default if you use SpringApplication to create it.
Spring Boot provides a @SpringBootTest annotation which can be used as an alternative to the standard springtest
@ContextConfiguration annotation when you need Spring Boot features. The annotation works by creating the ApplicationContext used
in your tests via SpringApplication .
You can use the webEnvironment attribute of @SpringBootTest to further rene how your tests will run:
MOCK Loads a WebApplicationContext and provides a mock servlet environment. Embedded servlet containers are not started when
using this annotation. If servlet APIs are not on your classpath this mode will transparently fallback to creating a regular non-web
ApplicationContext . Can be used in conjunction with @AutoConfigureMockMvc for MockMvc -based testing of your application.
RANDOM_PORT Loads an EmbeddedWebApplicationContext and provides a real servlet environment. Embedded servlet containers are
started and listening on a random port.
DEFINED_PORT Loads an EmbeddedWebApplicationContext and provides a real servlet environment. Embedded servlet containers
are started and listening on a dened port (i.e from your application.properties or on the default port 8080 ).
NONE Loads an ApplicationContext using SpringApplication but does not provide any servlet environment (mock or otherwise).
In addition to @SpringBootTest a number of other annotations are also provided for testing more specic slices of an
application. See below for details.
Dont forget to also add @RunWith(SpringRunner.class) to your test, otherwise the annotations will be ignored.
41.3.1Detecting test conguration

If youre 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 Boots @*Test annotations will search for your primary conguration
automatically whenever you dont explicitly dene one.
The search algorithm works up from the package that contains the test until it nds a @SpringBootApplication or
@SpringBootConfiguration annotated class. As long as youve structured your code in a sensible way your main conguration is usually
found.
If you want to customize the primary conguration, you can use a nested @TestConfiguration class. Unlike a nested @Configuration
class which would be used instead of a your applications primary conguration, a nested @TestConfiguration class will be used in addition
to your applications primary conguration.
Springs test framework will cache application contexts between tests. Therefore, as long as your tests share the same
conguration (no matter how its discovered), the potentially time consuming process of loading the context will only happen once.
41.3.2Excluding test conguration

If your application uses component scanning, for example if you use @SpringBootApplication or @ComponentScan , you may nd
components or congurations created only for specic tests accidentally get picked up everywhere.
To help prevent this, Spring Boot provides @TestComponent and @TestConfiguration annotations that can be used on classes in
src/test/java to indicate that they should not be picked up by scanning.
@TestComponent and @TestConfiguration are only needed on top level classes. If you dene @Configuration or
@Component as inner-classes within a test (any class that has @Test methods or @RunWith ), they will be automatically ltered.
If you directly use @ComponentScan (i.e. not via @SpringBootApplication ) you will need to register the TypeExcludeFilter
with it. See the Javadoc for details.
41.3.3Working with random ports

If you need to start a full running server for tests, we recommend that you use random ports. If you use
@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT) an available port will be 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 TestRestTemplate which will resolve relative links to the running server.
importorg.junit.Test;
importorg.junit.runner.RunWith;
importorg.springframework.boot.test.context.SpringBootTest;
importorg.springframework.boot.test.context.SpringBootTest.WebEnvironment;
importorg.springframework.boot.test.web.client.TestRestTemplate;
importorg.springframework.test.context.junit4.SpringRunner;
importstaticorg.assertj.core.api.Assertions.assertThat;
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)
publicclassRandomPortExampleTests{
@Autowired
privateTestRestTemplaterestTemplate;
@Test
publicvoidexampleTest(){
Stringbody=this.restTemplate.getForObject("/",String.class);
assertThat(body).isEqualTo("HelloWorld");
}
41.3.4Mocking and spying beans

Its sometimes necessary to mock certain components within your application context when running tests. For example, you may have a facade
over some remote service thats 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 dene a Mockito mock for a bean inside your ApplicationContext . You
can use the annotation to add new beans, or replace a single existing bean denition. The annotation can be used directly on test classes, on
elds within your test, or on @Configuration classes and elds. When used on a eld, the instance of the created mock will also be injected.
Mock beans are automatically reset after each test method.
Heres a typical example where we replace an existing RemoteService bean with a mock implementation:
importorg.junit.*;
importorg.junit.runner.*;
importorg.springframework.beans.factory.annotation.*;
importorg.springframework.boot.test.context.*;
importorg.springframework.boot.test.mock.mockito.*;
importorg.springframework.test.context.junit4.*;
importstaticorg.assertj.core.api.Assertions.*;
importstaticorg.mockito.BDDMockito.*;
@SpringBootTest
publicclassMyTests{
@MockBean
privateRemoteServiceremoteService;
@Autowired
privateReverserreverser;
@Test
publicvoidexampleTest(){
//RemoteServicehasbeeninjectedintothereverserbean
given(this.remoteService.someCall()).willReturn("mock");
Stringreverse=reverser.reverseSomeCall();
assertThat(reverse).isEqualTo("kcom");
}
Additionally you can also use @SpyBean to wrap any existing bean with a Mockito spy . See the Javadoc for full details.
41.3.5Auto-congured tests
Spring Boots auto-conguration system works well for applications, but can sometimes be a little too much for tests. Its often helpful to load
only the parts of the conguration 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 dont want to involve database calls in those tests; or you might be wanting to test JPA entities,
and youre not interested in web layer when those tests run.
The springboottestautoconfigure module includes a number of annotations that can be used to automatically congure such slices.
Each of them works in a similar way, providing a @
Test annotation that loads the ApplicationContext and one or more
@AutoConfigureannotations that can be used to customize auto-conguration settings.
Each slice loads a very restricted set of auto-conguration classes. If you need to exclude one of them, most @
Test annotations
provide an excludeAutoConfiguration attribute. Alternatively, you can use @ImportAutoConfiguration#exclude .
Its also possible to use the @AutoConfigureannotations with the standard @SpringBootTest annotation. You can use this
combination if youre not interested in slicing your application but you want some of the auto-congured test beans.
41.3.6Auto-congured JSON tests
To test that Object JSON serialization and deserialization is working as expected you can use the @JsonTest annotation. @JsonTest will
auto-congure Jackson ObjectMapper , any @JsonComponent beans and any Jackson Modules . It also congures Gson if you happen to
be using that instead of, or as well as, Jackson. If you need to congure elements of the auto-conguration you can use the
@AutoConfigureJsonTesters annotation.
Spring Boot includes AssertJ based helpers that work with the JSONassert and JsonPath libraries to check that JSON is as expected. The
JacksonTester , GsonTester and BasicJsonTester classes can be used for Jackson, Gson and Strings respectively. Any helper elds on
the test class can be @Autowired when using @JsonTest .
importorg.junit.*;
importorg.springframework.boot.test.autoconfigure.json.*;
importorg.springframework.boot.test.context.*;
importorg.springframework.boot.test.json.*;
importorg.springframework.test.context.junit4.*;
@JsonTest
publicclassMyJsonTests{
@Autowired
privateJacksonTester<VehicleDetails>json;
@Test
publicvoidtestSerialize()throwsException{
VehicleDetailsdetails=newVehicleDetails("Honda","Civic");
//Assertagainsta`.json`fileinthesamepackageasthetest
assertThat(this.json.write(details)).isEqualToJson("expected.json");
//OruseJSONpathbasedassertions
assertThat(this.json.write(details)).hasJsonPathStringValue("@.make");
assertThat(this.json.write(details)).extractingJsonPathStringValue("@.make")
.isEqualTo("Honda");
}
@Test
publicvoidtestDeserialize()throwsException{
Stringcontent="{\"make\":\"Ford\",\"model\":\"Focus\"}";
assertThat(this.json.parse(content))
.isEqualTo(newVehicleDetails("Ford","Focus"));
assertThat(this.json.parseObject(content).getMake()).isEqualTo("Ford");
}
JSON helper classes can also be used directly in standard unit tests. Simply call the initFields method of the helper in your
@Before method if you arent using @JsonTest .
A list of the auto-conguration that is enabled by @JsonTest can be found in the appendix.
41.3.7Auto-congured Spring MVC tests

To test Spring MVC controllers are working as expected you can use the @WebMvcTest annotation. @WebMvcTest will auto-congure the
Spring MVC infrastructure and limit scanned beans to @Controller , @ControllerAdvice , @JsonComponent , Filter ,
WebMvcConfigurer and HandlerMethodArgumentResolver . Regular @Component beans will not be scanned when using this annotation.
Often @WebMvcTest will be limited to a single controller and used in combination with @MockBean to provide mock implementations for
required collaborators.
@WebMvcTest also auto-congures MockMvc . Mock MVC offers a powerful way to quickly test MVC controllers without needing to start a full
HTTP server.
You can also auto-congure MockMvc in a non- @WebMvcTest (e.g. SpringBootTest ) by annotating it with
@AutoConfigureMockMvc .
importorg.junit.*;
importorg.springframework.boot.test.autoconfigure.web.servlet.*;
importstaticorg.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
importstaticorg.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
@WebMvcTest(UserVehicleController.class)
publicclassMyControllerTests{
@Autowired
privateMockMvcmvc;
@MockBean
privateUserVehicleServiceuserVehicleService;
@Test
publicvoidtestExample()throwsException{
given(this.userVehicleService.getVehicleDetails("sboot"))
.willReturn(newVehicleDetails("Honda","Civic"));
this.mvc.perform(get("/sboot/vehicle").accept(MediaType.TEXT_PLAIN))
.andExpect(status().isOk()).andExpect(content().string("HondaCivic"));
}
If you need to congure elements of the auto-conguration (for example when servlet lters should be applied) you can use
attributes in the @AutoConfigureMockMvc annotation.
If you use HtmlUnit or Selenium, auto-conguration will also provide a WebClient bean and/or a WebDriver bean. Here is an example that
uses HtmlUnit:
importcom.gargoylesoftware.htmlunit.*;
importorg.junit.*;
importorg.springframework.boot.test.autoconfigure.web.servlet.*;
@WebMvcTest(UserVehicleController.class)
publicclassMyHtmlUnitTests{
@Autowired
privateWebClientwebClient;
@MockBean
privateUserVehicleServiceuserVehicleService;
@Test
given(this.userVehicleService.getVehicleDetails("sboot"))
.willReturn(newVehicleDetails("Honda","Civic"));
HtmlPagepage=this.webClient.getPage("/sboot/vehicle.html");
assertThat(page.getBody().getTextContent()).isEqualTo("HondaCivic");
}
By default Spring Boot will put WebDriver beans in a special scope to ensure that the driver is quit after each test, and that a
new instance is injected. If you dont want this behavior you can add @Scope("singleton") to your WebDriver @Bean
denition.
A list of the auto-conguration that is enabled by @WebMvcTest can be found in the appendix.
41.3.8Auto-congured Data JPA tests

@DataJpaTest can be used if you want to test JPA applications. By default it will congure an in-memory embedded database, scan for
@Entity classes and congure Spring Data JPA repositories. Regular @Component beans will not be loaded into the ApplicationContext .
Data JPA tests are transactional and rollback at the end of each test by default, see the relevant section in the Spring Reference Documentation
for more details. If thats not what you want, you can disable transaction management for a test or for the whole class as follows:
importorg.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
importorg.springframework.transaction.annotation.Propagation;
importorg.springframework.transaction.annotation.Transactional;
@DataJpaTest
@Transactional(propagation=Propagation.NOT_SUPPORTED)
publicclassExampleNonTransactionalTests{
Data JPA tests may also inject a TestEntityManager bean which provides an alternative to the standard JPA EntityManager specically
designed for tests. If you want to use TestEntityManager outside of @DataJpaTests you can also use the
@AutoConfigureTestEntityManager annotation. A JdbcTemplate is also available if you need that.
importorg.junit.*;
importorg.springframework.boot.test.autoconfigure.orm.jpa.*;
@DataJpaTest
publicclassExampleRepositoryTests{
@Autowired
privateTestEntityManagerentityManager;
@Autowired
privateUserRepositoryrepository;
@Test
this.entityManager.persist(newUser("sboot","1234"));
Useruser=this.repository.findByUsername("sboot");
assertThat(user.getUsername()).isEqualTo("sboot");
assertThat(user.getVin()).isEqualTo("1234");
}
In-memory embedded databases generally work well for tests since they are fast and dont require any developer installation. If, however, you
prefer to run tests against a real database you can use the @AutoConfigureTestDatabase annotation:
@DataJpaTest
@AutoConfigureTestDatabase(replace=Replace.NONE)
publicclassExampleRepositoryTests{
//...
A list of the auto-conguration that is enabled by @DataJpaTest can be found in the appendix.
41.3.9Auto-congured JDBC tests

@JdbcTest is similar to @DataJpaTest but for pure jdbc-related tests. By default it will also congure an in-memory embedded database and
a JdbcTemplate . Regular @Component beans will not be loaded into the ApplicationContext .
JDBC tests are transactional and rollback at the end of each test by default, see the relevant section in the Spring Reference Documentation for
more details. If thats not what you want, you can disable transaction management for a test or for the whole class as follows:
importorg.springframework.boot.test.autoconfigure.jdbc.JdbcTest;
importorg.springframework.transaction.annotation.Propagation;
importorg.springframework.transaction.annotation.Transactional;
@JdbcTest
@Transactional(propagation=Propagation.NOT_SUPPORTED)
publicclassExampleNonTransactionalTests{
If you prefer your test to run against a real database, you can use the @AutoConfigureTestDatabase annotation the same way as for
DataJpaTest .
A list of the auto-conguration that is enabled by @JdbcTest can be found in the appendix.
41.3.10Auto-congured Data MongoDB tests

@DataMongoTest can be used if you want to test MongoDB applications. By default, it will congure an in-memory embedded MongoDB (if
available), congure a MongoTemplate , scan for @Document classes and congure Spring Data MongoDB repositories. Regular @Component
beans will not be loaded into the ApplicationContext :
importorg.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest;
importorg.springframework.data.mongodb.core.MongoTemplate;
@DataMongoTest
publicclassExampleDataMongoTests{
@Autowired
privateMongoTemplatemongoTemplate;
//
}
In-memory embedded MongoDB generally works well for tests since it is fast and doesnt require any developer installation. If, however, you
prefer to run tests against a real MongoDB server you should exclude the embedded MongoDB auto-conguration:
importorg.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration;
importorg.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest;
@DataMongoTest(excludeAutoConfiguration=EmbeddedMongoAutoConfiguration.class)
publicclassExampleDataMongoNonEmbeddedTests{
A list of the auto-conguration that is enabled by @DataMongoTest can be found in the appendix.
41.3.11Auto-congured REST clients

The @RestClientTest annotation can be used if you want to test REST clients. By default it will auto-congure Jackson and GSON support,
congure a RestTemplateBuilder and add support for MockRestServiceServer . The specic beans that you want to test should be
specied using value or components attribute of @RestClientTest :
@RestClientTest(RemoteVehicleDetailsService.class)
publicclassExampleRestClientTest{
@Autowired
privateRemoteVehicleDetailsServiceservice;
@Autowired
privateMockRestServiceServerserver;
@Test
publicvoidgetVehicleDetailsWhenResultIsSuccessShouldReturnDetails()
throwsException{
this.server.expect(requestTo("/greet/details"))
.andRespond(withSuccess("hello",MediaType.TEXT_PLAIN));
Stringgreeting=this.service.callRestService();
assertThat(greeting).isEqualTo("hello");
}
A list of the auto-conguration that is enabled by @RestClientTest can be found in the appendix.
41.3.12Auto-congured Spring REST Docs tests

The @AutoConfigureRestDocs annotation can be used if you want to use Spring REST Docs in your tests. It will automatically congure
MockMvc to use Spring REST Docs and remove the need for Spring REST Docs' JUnit rule.
importorg.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
importorg.springframework.http.MediaType;
importorg.springframework.test.web.servlet.MockMvc;
importstaticorg.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
importstaticorg.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
importstaticorg.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
@WebMvcTest(UserController.class)
@AutoConfigureRestDocs("target/generatedsnippets")
publicclassUserDocumentationTests{
@Autowired
privateMockMvcmvc;
@Test
publicvoidlistUsers()throwsException{
this.mvc.perform(get("/users").accept(MediaType.TEXT_PLAIN))
.andExpect(status().isOk())
.andDo(document("listusers"));
}
In addition to conguring the output directory, @AutoConfigureRestDocs can also congure the host, scheme, and port that will appear in any
documented URIs. If you require more control over Spring REST Docs' conguration a RestDocsMockMvcConfigurationCustomizer bean
can be used:
@TestConfiguration
staticclassCustomizationConfiguration
implementsRestDocsMockMvcConfigurationCustomizer{
@Override
publicvoidcustomize(MockMvcRestDocumentationConfigurerconfigurer){
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-conguration will call alwaysDo with this result handler, thereby causing each MockMvc
call to automatically generate the default snippets:
@TestConfiguration
staticclassResultHandlerConfiguration{
@Bean
publicRestDocumentationResultHandlerrestDocumentation(){
returnMockMvcRestDocumentation.document("{methodname}");
}
41.3.13Using Spock to test Spring Boot applications

If you wish to use Spock to test a Spring Boot application you should add a dependency on Spocks spockspring module to your
applications build. spockspring integrates Springs test framework into Spock. Exactly how you can use Spock to test a Spring Boot
application depends on the version of Spock that you are using.
Spring Boot provides dependency management for Spock 1.0. If you wish to use Spock 1.1 you should override the
spock.version property in your build.gradle or pom.xml le.
When using Spock 1.1, the annotations described above can only be used and you can annotate your Specification with
@SpringBootTest to suit the needs of your tests.
When using Spock 1.0, @SpringBootTest will not work for a web project. You need to use @SpringApplicationConfiguration and
@WebIntegrationTest(randomPort=true) . Being unable to use @SpringBootTest means that you also lose the auto-congured
TestRestTemplate bean. You can create an equivalent bean yourself using the following conguration:
@Configuration
staticclassTestRestTemplateConfiguration{
@Bean
publicTestRestTemplatetestRestTemplate(
ObjectProvider<RestTemplateBuilder>builderProvider,
Environmentenvironment){
RestTemplateBuilderbuilder=builderProvider.getIfAvailable();
TestRestTemplatetemplate=builder==null?newTestRestTemplate()
:newTestRestTemplate(builder.build());
template.setUriTemplateHandler(newLocalHostUriTemplateHandler(environment));
returntemplate;
}
41.4Test utilities
A few test utility classes are packaged as part of springboot that are generally useful when testing your application.
41.4.1CongFileApplicationContextInitializer
ConfigFileApplicationContextInitializer is an ApplicationContextInitializer that can apply to your tests to load Spring Boot
application.properties les. You can use this when you dont need the full features provided by @SpringBootTest .
@ContextConfiguration(classes=Config.class,
initializers=ConfigFileApplicationContextInitializer.class)
Using ConfigFileApplicationContextInitializer alone wont provide support for @Value("${

}") injection. Its only job is
to ensure that application.properties les are loaded into Springs Environment . For @Value support you need to either
additionally congure a PropertySourcesPlaceholderConfigurer or use @SpringBootTest where one will be auto-
congured for you.
41.4.2EnvironmentTestUtils
EnvironmentTestUtils allows you to quickly add properties to a ConfigurableEnvironment or ConfigurableApplicationContext .
Simply call it with key=value strings:
EnvironmentTestUtils.addEnvironment(env,"org=Spring","name=Boot");
41.4.3OutputCapture
OutputCapture is a JUnit Rule that you can use to capture System.out and System.err output. Simply declare the capture as a @Rule
then use toString() for assertions:
importorg.junit.Rule;
importorg.springframework.boot.test.rule.OutputCapture;
importstaticorg.hamcrest.Matchers.*;
importstaticorg.junit.Assert.*;
publicclassMyTest{
@Rule
publicOutputCapturecapture=newOutputCapture();
@Test
publicvoidtestName()throwsException{
System.out.println("HelloWorld!");
assertThat(capture.toString(),containsString("World"));
}
41.4.4TestRestTemplate
TestRestTemplate is a convenience alternative to Springs 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 will behave in a test-friendly way: not
following redirects (so you can assert the response location), ignoring cookies (so the template is stateless), and not throwing exceptions on
server-side errors. It is recommended, but not mandatory, to use Apache HTTP Client (version 4.3.2 or better), and if you have that on your
classpath the TestRestTemplate will respond by conguring the client appropriately.
publicclassMyTest{
privateTestRestTemplatetemplate=newTestRestTemplate();
@Test
publicvoidtestRequest()throwsException{
HttpHeadersheaders=template.getForEntity("http://myhost.com",String.class).getHeaders();
assertThat(headers.getLocation().toString(),containsString("myotherhost"));
}
If you are using the @SpringBootTest annotation with WebEnvironment.RANDOM_PORT or WebEnvironment.DEFINED_PORT , you can just
inject a fully congured TestRestTemplate and start using it. If necessary, additional customizations can be applied via the
RestTemplateBuilder bean:
@SpringBootTest
publicclassMyTest{
@Autowired
privateTestRestTemplatetemplate;
@Test
publicvoidtestRequest()throwsException{
HttpHeadersheaders=template.getForEntity("http://myhost.com",String.class).getHeaders();
assertThat(headers.getLocation().toString(),containsString("myotherhost"));
}
@TestConfiguration
staticclassConfig{
@Bean
publicRestTemplateBuilderrestTemplateBuilder(){
returnnewRestTemplateBuilder()
.additionalMessageConverters(...)
.customizers(...);
}
42.WebSockets
Spring Boot provides WebSockets auto-conguration for embedded Tomcat (8 and 7), Jetty 9 and Undertow. If youre deploying a war le to a
standalone container, Spring Boot assumes that the container will be responsible for the conguration of its WebSocket support.
Spring Framework provides rich WebSocket support that can be easily accessed via the springbootstarterwebsocket module.
43.Web Services
Spring Boot provides Web Services auto-conguration so that all is required is dening your Endpoints .
The Spring Web Services features can be easily accessed via the springbootstarterwebservices module.
44.Creating your own auto-conguration

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-conguration. Auto-conguration classes can be bundled in external jars and still be picked-up by Spring Boot.
Auto-conguration can be associated to a "starter" that provides the auto-conguration code as well as the typical libraries that you would use
with it. We will rst cover what you need to know to build your own auto-conguration and we will move on to the typical steps required to create
a custom starter.
A demo project is available to showcase how you can create a starter step by step.
44.1Understanding auto-congured beans

Under the hood, auto-conguration is implemented with standard @Configuration classes. Additional @Conditional annotations are used
to constrain when the auto-conguration should apply. Usually auto-conguration classes use @ConditionalOnClass and
@ConditionalOnMissingBean annotations. This ensures that auto-conguration only applies when relevant classes are found and when you
have not declared your own @Configuration .
You can browse the source code of springbootautoconfigure to see the @Configuration classes that we provide (see the
METAINF/spring.factories le).
44.2Locating auto-conguration candidates

Spring Boot checks for the presence of a METAINF/spring.factories le within your published jar. The le should list your conguration
classes under the EnableAutoConfiguration key.
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.mycorp.libx.autoconfigure.LibXAutoConfiguration,\
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration
You can use the @AutoConfigureAfter or @AutoConfigureBefore annotations if your conguration needs to be applied in a specic order.
For example, if you provide web-specic conguration, your class may need to be applied after WebMvcAutoConfiguration .
If you want to order certain auto-congurations that shouldnt 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-
conguration classes.
Auto-congurations have to be loaded that way only. Make sure that they are dened in a specic package space and that they
are never the target of component scan in particular.
44.3Condition annotations
You almost always want to include one or more @Conditional annotations on your auto-conguration class. The
@ConditionalOnMissingBean is one common example that is used to allow developers to override auto-conguration 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.
44.3.1Class conditions
The @ConditionalOnClass and @ConditionalOnMissingClass annotations allows conguration to be included based on the presence or
absence of specic classes. Due to the fact that annotation metadata is parsed using ASM you can actually 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 using a String value.
44.3.2Bean conditions
The @ConditionalOnBean and @ConditionalOnMissingBean annotations allow a bean to be included based on the presence or absence of
specic beans. You can use the value attribute to specify beans by type, or name to specify beans by name. The search attribute allows
you to limit the ApplicationContext hierarchy that should be considered when searching for beans.
You need to be very careful about the order that bean denitions are added as these conditions are evaluated based on what has
been processed so far. For this reason, we recommend only using @ConditionalOnBean and @ConditionalOnMissingBean
annotations on auto-conguration classes (since these are guaranteed to load after any user-dene beans denitions have been
added).
@ConditionalOnBean and @ConditionalOnMissingBean do not prevent @Configuration classes from being created. Using
these conditions at the class level is equivalent to marking each contained @Bean method with the annotation.
44.3.3Property conditions
The @ConditionalOnProperty annotation allows conguration to 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 will be matched.
You can also create more advanced checks using the havingValue and matchIfMissing attributes.
44.3.4Resource conditions
The @ConditionalOnResource annotation allows conguration to be included only when a specic resource is present. Resources can be
specied using the usual Spring conventions, for example, file:/home/user/test.dat .
44.3.5Web application conditions

The @ConditionalOnWebApplication and @ConditionalOnNotWebApplication annotations allow conguration to be included depending
on whether the application is a 'web application'. A web application is any application that is using a Spring WebApplicationContext , denes
a session scope or has a StandardServletEnvironment .
44.3.6SpEL expression conditions

The @ConditionalOnExpression annotation allows conguration to be included based on the result of a SpEL expression.
44.4Creating your own starter

A full Spring Boot starter for a library may contain the following components:
The autoconfigure module that contains the auto-conguration code.

The starter module that provides a dependency to the autocongure module as well as the library and any additional dependencies that
are typically useful. In a nutshell, adding the starter should be enough to start using that library.
You may combine the auto-conguration code and the dependency management in a single module if you dont need to separate
those two concerns.
44.4.1Naming
Please make sure to provide a proper namespace for your starter. Do not start your module names with springboot , even if you are using a
different Maven groupId. We may offer an ofcial support for the thing youre auto-conguring in the future.
Here is a rule of thumb. Lets assume that you are creating a starter for "acme", name the auto-congure module
acmespringbootautoconfigure and the starter acmespringbootstarter . If you only have one module combining the two, use
acmespringbootstarter .
Besides, if your starter provides conguration keys, use a proper namespace for them. In particular, do not include your keys in the
namespaces that Spring Boot uses (e.g. server , management , spring , etc). These are "ours" and we may improve/modify them in the
future in such a way it could break your things.
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
meta-data ( METAINF/springconfigurationmetadata.json ) to make sure your keys are properly documented.
44.4.2Autocongure module
The autocongure module contains everything that is necessary to get started with the library. It may also contain conguration keys denition
( @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 the autocongure module in your projects
more easily. If you do it that way, the library wont be provided and Spring Boot will back off by default.
44.4.3Starter module
The starter is an empty jar, really. Its only purpose is to provide the necessary dependencies to work with the library; see 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-conguring 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 bringing unnecessary dependencies for a typical usage of the library.

If you want to learn more about any of the classes discussed in this section you can check out the Spring Boot API documentation or you can
browse the source code directly. If you have specic questions, take a look at the how-to section.
If you are comfortable with Spring Boots core features, you can carry on and read about production-ready features.
PartV.Spring Boot Actuator: Production-ready features
Spring Boot includes a number of additional features to help you monitor and manage your application when its pushed to production. You can
choose to manage and monitor your application using HTTP endpoints or with JMX. Auditing, health and metrics gathering can be automatically
applied to your application.
Actuator HTTP endpoints are only available with a Spring MVC-based application. In particular, it will not work with Jersey unless you enable
Spring MVC as well.
46.Enabling production-ready features

The springbootactuator module provides all of Spring Boots production-ready features. The simplest way to enable the features is to
add a dependency to the springbootstarteractuator Starter.
Denition of Actuator
An actuator is a manufacturing term, referring 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>
<artifactId>springbootstarteractuator</artifactId>
</dependency>
</dependencies>
For Gradle, use the declaration:
dependencies{
compile("org.springframework.boot:springbootstarteractuator")
}
47.Endpoints
Actuator endpoints allow you to monitor and interact with your application. Spring Boot includes a number of built-in endpoints and you can also
add your own. For example the health endpoint provides basic application health information.
The way that endpoints are exposed will depend on the type of technology that you choose. Most applications choose HTTP monitoring, where
the ID of the endpoint is mapped to a URL. For example, by default, the health endpoint will be mapped to /health .
The following technology agnostic endpoints are available:
ID Description Sensitive
Default
actuator Provides a hypermedia-based discovery page for the other endpoints. Requires Spring HATEOAS to be true
on the classpath.
auditevents Exposes audit events information for the current application. true
autoconfig Displays an auto-conguration report showing all auto-conguration candidates and the reason why they true
were or were not applied.
beans Displays a complete list of all the Spring beans in your application. true
configprops Displays a collated list of all @ConfigurationProperties . true
dump Performs a thread dump. true
env Exposes properties from Springs ConfigurableEnvironment . true
flyway Shows any Flyway database migrations that have been applied. true
Default
health Shows application health information (when the application is secure, a simple status when accessed over false
an unauthenticated connection or full message details when authenticated).
info Displays arbitrary application info. false
loggers Shows and modies the conguration of loggers in the application. true
liquibase Shows any Liquibase database migrations that have been applied. true
metrics Shows metrics information for the current application. true
mappings Displays a collated list of all @RequestMapping paths. true
shutdown Allows the application to be gracefully shutdown (not enabled by default). true
trace Displays trace information (by default the last 100 HTTP requests). true
If you are using Spring MVC, the following additional endpoints can also be used:
Default
docs Displays documentation, including example requests and responses, for the Actuators endpoints. Requires false
springbootactuatordocs to be on the classpath.
heapdump Returns a GZip compressed hprof heap dump le. true
jolokia Exposes JMX beans over HTTP (when Jolokia is on the classpath). true
logfile Returns the contents of the logle (if logging.file or logging.path properties have been set). Supports true
the use of the HTTP Range header to retrieve part of the log les content.
Depending on how an endpoint is exposed, the sensitive property may be used as a security hint. For example, sensitive
endpoints will require a username/password when they are accessed over HTTP (or simply disabled if web security is not
enabled).
47.1Customizing endpoints
Endpoints can be customized using Spring properties. You can change if an endpoint is enabled , if it is considered sensitive and even its
id .
For example, here is an application.properties that changes the sensitivity and id of the beans endpoint and also enables shutdown .
endpoints.beans.id=springbeans
endpoints.beans.sensitive=false
endpoints.shutdown.enabled=true
The prex endpoints + . + name is used to uniquely identify the endpoint that is being congured.
By default, all endpoints except for shutdown are enabled. If you prefer to specically opt-in endpoint enablement you can use the
endpoints.enabled property. For example, the following will disable all endpoints except for info :
endpoints.enabled=false
endpoints.info.enabled=true
Likewise, you can also choose to globally set the sensitive ag of all endpoints. By default, the sensitive ag depends on the type of endpoint
(see the table above). For example, to mark all endpoints as sensitive except info :
endpoints.sensitive=true
endpoints.info.sensitive=false
47.2Hypermedia for actuator MVC endpoints

If endpoints.hypermedia.enabled is set to true and Spring HATEOAS is on the classpath (e.g. through the
springbootstarterhateoas or if you are using Spring Data REST) then the HTTP endpoints from the Actuator are enhanced with
hypermedia links, and a discovery page is added with links to all the endpoints. The discovery page is available on /actuator by default. It
is implemented as an endpoint, allowing properties to be used to congure its path ( endpoints.actuator.path ) and whether or not it is
enabled ( endpoints.actuator.enabled ).
When a custom management context path is congured, the discovery page will automatically move from /actuator to the root of the
management context. For example, if the management context path is /management then the discovery page will be available from
/management .
If the HAL Browser is on the classpath via its webjar ( org.webjars:halbrowser ), or via the springdataresthalbrowser then an
HTML discovery page, in the form of the HAL Browser, is also provided.
47.3CORS support
Cross-origin resource sharing (CORS) is a W3C specication that allows you to specify in a exible way what kind of cross domain requests are
authorized. Actuators MVC endpoints can be congured to support such scenarios.
CORS support is disabled by default and is only enabled once the endpoints.cors.allowedorigins property has been set. The
conguration below permits GET and POST calls from the example.com domain:
endpoints.cors.allowedorigins=http://example.com
endpoints.cors.allowedmethods=GET,POST
Check EndpointCorsProperties for a complete list of options.
47.4Adding custom endpoints

If you add a @Bean of type Endpoint then it will automatically be exposed over JMX and HTTP (if there is an server available). An HTTP
endpoints can be customized further by creating a bean of type MvcEndpoint . Your MvcEndpoint is not a @Controller but it can use
@RequestMapping (and @Managed* ) to expose resources.
If you are doing this as a library feature consider adding a conguration class annotated with
@ManagementContextConfiguration to /METAINF/spring.factories under the key
org.springframework.boot.actuate.autoconfigure.ManagementContextConfiguration . If you do that then the endpoint
will move to a child context with all the other MVC endpoints if your users ask for a separate management port or address. A
conguration declared this way can be a WebConfigurerAdapter if it wants to add static resources (for instance) to the
management endpoints.
47.5Health information
Health information can be used to check the status of your running application. It is often used by monitoring software to alert someone if a
production system goes down. The default information exposed by the health endpoint depends on how it is accessed. For an
unauthenticated connection in a secure application a simple status message is returned, and for an authenticated connection additional details
are also displayed (see Section48.7, HTTP health endpoint access restrictions for HTTP details).
Health information is collected from all HealthIndicator beans dened in your ApplicationContext . Spring Boot includes a number of
auto-congured HealthIndicators and you can also write your own.
47.6Security with HealthIndicators

Information returned by HealthIndicators is often somewhat sensitive in nature. For example, you probably dont want to publish details of
your database server to the world. For this reason, by default, only the health status is exposed over an unauthenticated HTTP connection. If
you are happy for complete health information to always be exposed you can set endpoints.health.sensitive to false .
Health responses are also cached to prevent denial of service attacks. Use the endpoints.health.timetolive property if you want to
change the default cache period of 1000 milliseconds.
47.6.1Auto-congured HealthIndicators
The following HealthIndicators are auto-congured by Spring Boot when appropriate:
Name Description
CassandraHealthIndicator Checks that a Cassandra database is up.
DiskSpaceHealthIndicator Checks for low disk space.
DataSourceHealthIndicator Checks that a connection to DataSource can be obtained.
ElasticsearchHealthIndicator Checks that an Elasticsearch cluster is up.
JmsHealthIndicator Checks that a JMS broker is up.
MailHealthIndicator Checks that a mail server is up.
MongoHealthIndicator Checks that a Mongo database is up.
RabbitHealthIndicator Checks that a Rabbit server is up.
RedisHealthIndicator Checks that a Redis server is up.
SolrHealthIndicator Checks that a Solr server is up.
It is possible to disable them all using the management.health.defaults.enabled property.
47.6.2Writing 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.
importorg.springframework.boot.actuate.health.Health;
importorg.springframework.boot.actuate.health.HealthIndicator;
@Component
publicclassMyHealthIndicatorimplementsHealthIndicator{
@Override
publicHealthhealth(){
interrorCode=check();//performsomespecifichealthcheck
if(errorCode!=0){
returnHealth.down().withDetail("ErrorCode",errorCode).build();
}
returnHealth.up().build();
}
The identier for a given HealthIndicator is the name of the bean without the HealthIndicator sufx if it exists. In the
example above, the health information will be available in an entry named my .
In addition to Spring Boots predened Status types, it is also possible for Health to return a custom Status that represents a new system
state. In such cases a custom implementation of the HealthAggregator interface also needs to be provided, or the default implementation
has to be congured using the management.health.status.order conguration property.
For example, assuming a new Status with code FATAL is being used in one of your HealthIndicator implementations. To congure the
severity order add the following to your application properties:
management.health.status.order=DOWN,OUT_OF_SERVICE,UNKNOWN,UP
You might also want to register custom status mappings with the HealthMvcEndpoint if you access the health endpoint over HTTP. For
example you could map FATAL to HttpStatus.SERVICE_UNAVAILABLE .
47.7Application information
Application information exposes various information collected from all InfoContributor beans dened in your ApplicationContext . Spring
Boot includes a number of auto-congured InfoContributors and you can also write your own.
47.7.1Auto-congured InfoContributors
The following InfoContributors are auto-congured by Spring Boot when appropriate:
Name Description
EnvironmentInfoContributor Expose any key from the Environment under the info key.
GitInfoContributor Expose git information if a git.properties le is available.
BuildInfoContributor Expose build information if a METAINF/buildinfo.properties le is available.
It is possible to disable them all using the management.info.defaults.enabled property.
47.7.2Custom application info information

You can customize the data exposed by the info endpoint by setting info.* Spring properties. All Environment properties under the info
key will be automatically exposed. For example, you could add the following to your application.properties :
info.app.encoding=UTF8
info.app.java.source=1.8
info.app.java.target=1.8
Rather than hardcoding those values you could also expand info properties at build time.
Assuming you are using Maven, you could rewrite the example above as follows:
info.app.encoding=@project.build.sourceEncoding@
info.app.java.source=@java.version@
info.app.java.target=@java.version@
47.7.3Git 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, the git.branch , git.commit.id and git.commit.time properties will be
exposed.
A GitProperties bean is auto-congured if a git.properties le is available at the root of the classpath. See Generate git
information for more details.
If you want to display the full git information (i.e. the full content of git.properties ), use the management.info.git.mode property:
management.info.git.mode=full
47.7.4Build information
The info endpoint can also publish information about your build if a BuildProperties bean is available. This happens if a
METAINF/buildinfo.properties le is available in the classpath.
The Maven and Gradle plugins can both generate that le, see Generate build information for more details.
47.7.5Writing custom InfoContributors

To provide custom application information you can register Spring beans that implement the InfoContributor interface.
The example below contributes an example entry with a single value:
importjava.util.Collections;
importorg.springframework.boot.actuate.info.Info;
importorg.springframework.boot.actuate.info.InfoContributor;
@Component
publicclassExampleInfoContributorimplementsInfoContributor{
@Override
publicvoidcontribute(Info.Builderbuilder){
builder.withDetail("example",
Collections.singletonMap("key","value"));
}
If you hit the info endpoint you should see a response that contains the following additional entry:
{
"example":{
"key":"value"
}
}
48.Monitoring and management over HTTP

If you are developing a Spring MVC application, Spring Boot Actuator will auto-congure all enabled endpoints to be exposed over HTTP. The
default convention is to use the id of the endpoint as the URL path. For example, health is exposed as /health .
48.1Accessing sensitive endpoints

By default all sensitive HTTP endpoints are secured such that only users that have an ACTUATOR role may access them. Security is enforced
using the standard HttpServletRequest.isUserInRole method.
Use the management.security.roles property if you want something different to ACTUATOR .
If you are deploying applications behind a rewall, you may prefer that all your actuator endpoints can be accessed without requiring
authentication. You can do this by changing the management.security.enabled property:
application.properties.
management.security.enabled=false
By default, actuator endpoints are exposed on the same port that serves regular HTTP trafc. Take care not to accidentally
expose sensitive information if you change the management.security.enabled property.
If youre deploying applications publicly, you may want to add Spring Security to handle user authentication. When Spring Security is added,
by default basic authentication will be used with the username user and a generated password (which is printed on the console when the
application starts).
Generated passwords are logged as the application starts. Search for Using default security password.
You can use Spring properties to change the username and password and to change the security role(s) required to access the endpoints. For
example, you might set the following in your application.properties :
security.user.name=admin
security.user.password=secret
management.security.roles=SUPERUSER
48.2Customizing the management endpoint paths

Sometimes it is useful to group all management endpoints under a single path. For example, your application might already use /info for
another purpose. You can use the management.contextpath property to set a prex for your management endpoint:
management.contextpath=/manage
The application.properties example above will change the endpoint from /{id} to /manage/{id} (e.g. /manage/info ).
You can also change the id of an endpoint (using endpoints.{name}.id ) which then changes the default resource path for the MVC
endpoint. Legal endpoint ids are composed only of alphanumeric characters (because they can be exposed in a number of places, including
JMX object names, where special characters are forbidden). The MVC path can be changed separately by conguring
endpoints.{name}.path , and there is no validation on those values (so you can use anything that is legal in a URL path). For example, to
change the location of the /health endpoint to /ping/me you can set endpoints.health.path=/ping/me .
If you provide a custom MvcEndpoint remember to include a settable path property, and default it to /{id} if you want your
code to behave like the standard MVC endpoints. (Take a look at the HealthMvcEndpoint to see how you might do that.) If your
custom endpoint is an Endpoint (not an MvcEndpoint ) then Spring Boot will take care of the path for you.
48.3Customizing the management server port

Exposing management endpoints 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 using a different HTTP port.
The management.port property can be used to change the HTTP port.
management.port=8081
Since your management port is often protected by a rewall, and not exposed to the public you might not need security on the management
endpoints, even if your main application is secure. In that case you will have Spring Security on the classpath, and you can disable
management security like this:
management.security.enabled=false
(If you dont have Spring Security on the classpath then there is no need to explicitly disable the management security in this way, and it might
even break the application.)
48.4Conguring management-specic SSL

When congured to use a custom port, the management server can also be congured with its own SSL using the various management.ssl.*
properties. For example, this allows a management server to be available via HTTP while the main application uses HTTPS:
server.port=8443
server.ssl.enabled=true
server.ssl.keystore=classpath:store.jks
server.ssl.keypassword=secret
management.ssl.enabled=false
Alternatively, both the main server and the management server can use SSL but with different key stores:
server.port=8443
server.ssl.enabled=true
server.ssl.keystore=classpath:main.jks
server.ssl.keypassword=secret
management.ssl.enabled=true
management.ssl.keystore=classpath:management.jks
management.ssl.keypassword=secret
48.5Customizing the management server address

You can customize the address that the management endpoints are available on by setting the management.address property. This can be
useful if you want to listen only on an internal or ops-facing network, or to only listen for connections from localhost .
You can only listen on a different address if the port is different to the main server port.
Here is an example application.properties that will not allow remote management connections:
management.address=127.0.0.1
48.6Disabling HTTP endpoints

If you dont want to expose endpoints over HTTP you can set the management port to 1 :
management.port=1
48.7HTTP health endpoint access restrictions

The information exposed by the health endpoint varies depending on whether or not its accessed anonymously, and whether or not the
enclosing application is secure. By default, when accessed anonymously in a secure application, any details about the servers health are
hidden and the endpoint will simply indicate whether or not the server is up or down. Furthermore the response is cached for a congurable
period to prevent the endpoint being used in a denial of service attack. The endpoints.health.timetolive property is used to congure
the caching period in milliseconds. It defaults to 1000, i.e. one second.
The above-described restrictions can be enhanced, thereby allowing only authenticated users full access to the health endpoint in a secure
application. To do so, set endpoints.health.sensitive to true . Heres a summary of behavior (with default sensitive ag value false
indicated in bold):
management.security.enabled endpoints.health.sensitive Unauthenticated Authenticated
false false Full content Full content
false true Status only Full content
true false Status only Full content
true true No content Full content
49.Monitoring and management over JMX

Java Management Extensions (JMX) provide a standard mechanism to monitor and manage applications. By default Spring Boot will expose
management endpoints as JMX MBeans under the org.springframework.boot domain.
49.1Customizing 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/Endpoint/healthEndpoint .
If your application contains more than one Spring ApplicationContext you may nd that names clash. To solve this problem you can set the
endpoints.jmx.uniquenames property to true so that MBean names are always unique.
You can also customize the JMX domain under which endpoints are exposed. Here is an example application.properties :
endpoints.jmx.domain=myapp
endpoints.jmx.uniquenames=true
49.2Disabling JMX endpoints

If you dont want to expose endpoints over JMX you can set the endpoints.jmx.enabled property to false :
endpoints.jmx.enabled=false
49.3Using Jolokia for JMX over HTTP

Jolokia is a JMX-HTTP bridge giving an alternative method of accessing JMX beans. To use Jolokia, simply include a dependency to
org.jolokia:jolokiacore . For example, using Maven you would add the following:
<dependency>
<groupId>org.jolokia</groupId>
<artifactId>jolokiacore</artifactId>
</dependency>
Jolokia can then be accessed using /jolokia on your management HTTP server.
49.3.1Customizing Jolokia
Jolokia has a number of settings that you would traditionally congure using servlet parameters. With Spring Boot you can use your
application.properties , simply prex the parameter with jolokia.config. :
jolokia.config.debug=true
49.3.2Disabling Jolokia
If you are using Jolokia but you dont want Spring Boot to congure it, simply set the endpoints.jolokia.enabled property to false :
endpoints.jolokia.enabled=false
50.Loggers
Spring Boot Actuator includes the ability to view and congure the log levels of your application at runtime. You can view either the entire list or
an individual loggers conguration which is made up of both the explicitly congured logging level as well as the effective logging level given to
it by the logging framework. These levels can be:
TRACE
DEBUG
INFO
WARN
ERROR
FATAL
OFF
null
with null indicating that there is no explicit conguration.
50.1Congure a Logger
In order to congure a given logger, you POST a partial entity to the resources URI:
{
"configuredLevel":"DEBUG"
}
51.Metrics
Spring Boot Actuator includes a metrics service with gauge and counter support. A gauge records a single value; and a counter records a
delta (an increment or decrement). Spring Boot Actuator also provides a PublicMetrics interface that you can implement to expose metrics
that you cannot record via one of those two mechanisms. Look at SystemPublicMetrics for an example.
Metrics for all HTTP requests are automatically recorded, so if you hit the metrics endpoint you should see a response similar to this:
{
"counter.status.200.root":20,
"counter.status.200.metrics":3,
"counter.status.200.starstar":5,
"counter.status.401.root":4,
"gauge.response.starstar":6,
"gauge.response.root":2,
"gauge.response.metrics":3,
"classes":5808,
"classes.loaded":5808,
"classes.unloaded":0,
"heap":3728384,
"heap.committed":986624,
"heap.init":262144,
"heap.used":52765,
"nonheap":0,
"nonheap.committed":77568,
"nonheap.init":2496,
"nonheap.used":75826,
"mem":986624,
"mem.free":933858,
"processors":8,
"threads":15,
"threads.daemon":11,
"threads.peak":15,
"threads.totalStarted":42,
"uptime":494836,
"instance.uptime":489782,
"datasource.primary.active":5,
"datasource.primary.usage":0.25
}
Here we can see basic memory , heap , classloading , processor and threadpool information along with some HTTP metrics. In this
instance the root (/) and /metrics URLs have returned HTTP200 responses 20 and 3 times respectively. It also appears that the root
URL returned HTTP401 (unauthorized) 4 times. The double asterisks ( starstar ) comes from a request matched by Spring MVC as /**
(normally a static resource).
The gauge shows the last response time for a request. So the last request to root took 2ms to respond and the last to /metrics took 3ms .
In this example we are actually accessing the endpoint over HTTP using the /metrics URL, this explains why metrics
appears in the response.
51.1System metrics
The following system metrics are exposed by Spring Boot:
The total system memory in KB ( mem )

The amount of free memory in KB ( mem.free )
The number of processors ( processors )
The system uptime in milliseconds ( uptime )
The application context uptime in milliseconds ( instance.uptime )
The average system load ( systemload.average )
Heap information in KB ( heap , heap.committed , heap.init , heap.used )
Thread information ( threads , thread.peak , thread.daemon )
Class load information ( classes , classes.loaded , classes.unloaded )
Garbage collection information ( gc.xxx.count , gc.xxx.time )
51.2DataSource metrics
The following metrics are exposed for each supported DataSource dened in your application:
The number of active connections ( datasource.xxx.active )

The current usage of the connection pool ( datasource.xxx.usage ).
All data source metrics share the datasource. prex. The prex is further qualied for each data source:
If the data source is the primary data source (that is either the only available data source or the one agged @Primary amongst the
existing ones), the prex is datasource.primary .
If the data source bean name ends with DataSource , the prex is the name of the bean without DataSource (i.e. datasource.batch
for batchDataSource ).
In all other cases, the name of the bean is used.
It is possible to override part or all of those defaults by registering a bean with a customized version of DataSourcePublicMetrics . By
default, Spring Boot provides metadata for all supported data sources; you can add additional DataSourcePoolMetadataProvider beans if
your favorite data source isnt supported out of the box. See DataSourcePoolMetadataProvidersConfiguration for examples.
51.3Cache metrics
The following metrics are exposed for each supported cache dened in your application:
The current size of the cache ( cache.xxx.size )

Hit ratio ( cache.xxx.hit.ratio )
Miss ratio ( cache.xxx.miss.ratio )
Cache providers do not expose the hit/miss ratio in a consistent way. While some expose an aggregated value (i.e. the hit ratio
since the last time the stats were cleared), others expose a temporal value (i.e. the hit ratio of the last second). Check your
caching provider documentation for more details.
If two different cache managers happen to dene the same cache, the name of the cache is prexed by the name of the CacheManager bean.
It is possible to override part or all of those defaults by registering a bean with a customized version of CachePublicMetrics . By default,
Spring Boot provides cache statistics for EhCache, Hazelcast, Innispan, JCache and Caffeine. You can add additional
CacheStatisticsProvider beans if your favorite caching library isnt supported out of the box. See CacheStatisticsAutoConfiguration
for examples.
51.4Tomcat session metrics

If you are using Tomcat as your embedded servlet container, session metrics will automatically be exposed. The httpsessions.active and
httpsessions.max keys provide the number of active and maximum sessions.
51.5Recording your own metrics

To record your own metrics inject a CounterService and/or GaugeService into your bean. The CounterService exposes increment ,
decrement and reset methods; the GaugeService provides a submit method.
Here is a simple example that counts the number of times that a method is invoked:
importorg.springframework.boot.actuate.metrics.CounterService;
importorg.springframework.stereotype.Service;
@Service
publicclassMyService{
privatefinalCounterServicecounterService;
@Autowired
publicMyService(CounterServicecounterService){
this.counterService=counterService;
}
publicvoidexampleMethod(){
this.counterService.increment("services.system.myservice.invoked");
}
You can use any string as a metric name but you should follow guidelines of your chosen store/graphing technology. Some good
guidelines for Graphite are available on Matt Aimonettis Blog.
51.6Adding your own public metrics

To add additional metrics that are computed every time the metrics endpoint is invoked, simply register additional PublicMetrics
implementation bean(s). By default, all such beans are gathered by the endpoint. You can easily change that by dening your own
MetricsEndpoint .
51.7Metric writers, exporters and aggregation

Spring Boot provides a couple of implementations of a marker interface called Exporter which can be used to copy metric readings from the
in-memory buffers to a place where they can be analyzed and displayed. Indeed, if you provide a @Bean that implements the MetricWriter
interface (or GaugeWriter for simple use cases) and mark it @ExportMetricWriter , then it will automatically be hooked up to an Exporter
and fed metric updates every 5 seconds (congured via spring.metrics.export.delaymillis ). In addition, any MetricReader that you
dene and mark as @ExportMetricReader will have its values exported by the default exporter.
This feature is enabling scheduling in your application ( @EnableScheduling ) which can be a problem if you run an integration
test as your own scheduled tasks will start. You can disable this behaviour by setting spring.metrics.export.enabled to
false .
The default exporter is a MetricCopyExporter which tries to optimize itself by not copying values that havent changed since it was last called
(the optimization can be switched off using a ag spring.metrics.export.sendlatest ). Note also that the Dropwizard MetricRegistry
has no support for timestamps, so the optimization is not available if you are using Dropwizard metrics (all metrics will be copied on every tick).
The default values for the export trigger ( delaymillis , includes , excludes and sendlatest ) can be set as
spring.metrics.export.* . Individual values for specic MetricWriters can be set as spring.metrics.export.triggers.<name>.*
where <name> is a bean name (or pattern for matching bean names).
The automatic export of metrics is disabled if you switch off the default MetricRepository (e.g. by using Dropwizard metrics).
You can get back the same functionality be declaring a bean of your own of type MetricReader and declaring it to be
@ExportMetricReader .
51.7.1Example: Export to Redis

If you provide a @Bean of type RedisMetricRepository and mark it @ExportMetricWriter the metrics are exported to a Redis cache for
aggregation. The RedisMetricRepository has two important parameters to congure it for this purpose: prefix and key (passed into its
constructor). It is best to use a prex that is unique to the application instance (e.g. using a random value and maybe the logical name of the
application to make it possible to correlate with other instances of the same application). The key is used to keep a global index of all metric
names, so it should be unique globally, whatever that means for your system (e.g. two instances of the same system could share a Redis
cache if they have distinct keys).
Example:
@Bean
@ExportMetricWriter
MetricWritermetricWriter(MetricExportPropertiesexport){
returnnewRedisMetricRepository(connectionFactory,
export.getRedis().getPrefix(),export.getRedis().getKey());
}
spring.metrics.export.redis.prefix:metrics.mysystem.${spring.application.name:application}.${random.value:0000}
spring.metrics.export.redis.key:keys.metrics.mysystem
The prex is constructed with the application name and id at the end, so it can easily be used to identify a group of processes with the same
logical name later.
Its important to set both the key and the prefix . The key is used for all repository operations, and can be shared by multiple
repositories. If multiple repositories share a key (like in the case where you need to aggregate across them), then you normally
have a read-only master repository that has a short, but identiable, prex (like metrics.mysystem), and many write-only
repositories with prexes that start with the master prex (like metrics.mysystem.* in the example above). It is efcient to read
all the keys from a master repository like that, but inefcient to read a subset with a longer prex (e.g. using one of the writing
repositories).
The example above uses MetricExportProperties to inject and extract the key and prex. This is provided to you as a
convenience by Spring Boot, congured with sensible defaults. There is nothing to stop you using your own values as long as
they follow the recommendations.
51.7.2Example: Export to Open TSDB

If you provide a @Bean of type OpenTsdbGaugeWriter and mark it @ExportMetricWriter metrics are exported to Open TSDB for
aggregation. The OpenTsdbGaugeWriter has a url property that you need to set to the Open TSDB /put endpoint, e.g.
localhost:4242/api/put ). It also has a namingStrategy that you can customize or congure to make the metrics match the data structure
you need on the server. By default it just passes through the metric name as an Open TSDB metric name, and adds the tags domain (with
value org.springframework.metrics) and process (with the value equal to the object hash of the naming strategy). Thus, after running the
application and generating some metrics you can inspect the metrics in the TSD UI (localhost:4242 by default).
Example:
curllocalhost:4242/api/query?start=1hago&m=max:counter.status.200.root
[
{
"metric":"counter.status.200.root",
"tags":{
"domain":"org.springframework.metrics",
"process":"b968a76"
},
"aggregateTags":[],
"dps":{
"1430492872":2,
"1430492875":6
}
}
]
51.7.3Example: Export to Statsd

To export metrics to Statsd, make sure rst that you have added com.timgroup:javastatsdclient as a dependency of your project
(Spring Boot provides a dependency management for it). Then add a spring.metrics.export.statsd.host value to your
application.properties le. Connections will be opened to port 8125 unless a spring.metrics.export.statsd.port override is
provided. You can use spring.metrics.export.statsd.prefix if you want a custom prex.
Alternatively, you can provide a @Bean of type StatsdMetricWriter and mark it @ExportMetricWriter :
@Value("${spring.application.name:application}.${random.value:0000}")
privateStringprefix="metrics";
@Bean
@ExportMetricWriter
MetricWritermetricWriter(){
returnnewStatsdMetricWriter(prefix,"localhost",8125);
}
51.7.4Example: Export to JMX

If you provide a @Bean of type JmxMetricWriter marked @ExportMetricWriter the metrics are exported as MBeans to the local server
(the MBeanExporter is provided by Spring Boot JMX auto-conguration as long as it is switched on). Metrics can then be inspected, graphed,
alerted etc. using any tool that understands JMX (e.g. JConsole or JVisualVM).
Example:
@Bean
@ExportMetricWriter
MetricWritermetricWriter(MBeanExporterexporter){
returnnewJmxMetricWriter(exporter);
}
Each metric is exported as an individual MBean. The format for the ObjectNames is given by an ObjectNamingStrategy which can be
injected into the JmxMetricWriter (the default breaks up the metric name and tags the rst two period-separated sections in a way that
should make the metrics group nicely in JVisualVM or JConsole).
51.8Aggregating metrics from multiple sources

There is an AggregateMetricReader that you can use to consolidate metrics from different physical sources. Sources for the same logical
metric just need to publish them with a period-separated prex, and the reader will aggregate (by truncating the metric names, and dropping the
prex). Counters are summed and everything else (i.e. gauges) take their most recent value.
This is very useful if multiple application instances are feeding to a central (e.g. Redis) repository and you want to display the results.
Particularly recommended in conjunction with a MetricReaderPublicMetrics for hooking up to the results to the /metrics endpoint.
Example:
@Autowired
privateMetricExportPropertiesexport;
@Bean
publicPublicMetricsmetricsAggregate(){
returnnewMetricReaderPublicMetrics(aggregatesMetricReader());
}
privateMetricReaderglobalMetricsForAggregation(){
returnnewRedisMetricRepository(this.connectionFactory,
this.export.getRedis().getAggregatePrefix(),this.export.getRedis().getKey());
}
privateMetricReaderaggregatesMetricReader(){
AggregateMetricReaderrepository=newAggregateMetricReader(
globalMetricsForAggregation());
returnrepository;
}
The example above uses MetricExportProperties to inject and extract the key and prex. This is provided to you as a
convenience by Spring Boot, and the defaults will be sensible. They are set up in MetricExportAutoConfiguration .
The MetricReaders above are not @Beans and are not marked as @ExportMetricReader because they are just collecting
and analyzing data from other repositories, and dont want to export their values.
51.9Dropwizard Metrics
A default MetricRegistry Spring bean will be created when you declare a dependency to the io.dropwizard.metrics:metricscore
library; you can also register you own @Bean instance if you need customizations. Users of the Dropwizard Metrics library will nd that Spring
Boot metrics are automatically published to com.codahale.metrics.MetricRegistry . Metrics from the MetricRegistry are also
automatically exposed via the /metrics endpoint
When Dropwizard metrics are in use, the default CounterService and GaugeService are replaced with a DropwizardMetricServices ,
which is a wrapper around the MetricRegistry (so you can @Autowired one of those services and use it as normal). You can also create
special Dropwizard metrics by prexing your metric names with the appropriate type (i.e. timer.* , histogram.* for gauges, and meter.*
for counters).
51.10Message channel integration

If a MessageChannel bean called metricsChannel exists, then a MetricWriter will be created that writes metrics to that channel. Each
message sent to the channel will contain a Delta or Metric payload and have a metricName header. The writer is automatically hooked up
to an exporter (as for all writers), so all metric values will appear on the channel, and additional analysis or actions can be taken by subscribers
(its up to you to provide the channel and any subscribers you need).
52.Auditing
Spring Boot Actuator has a exible audit framework that will publish events once Spring Security is in play (authentication success, failure and
access denied exceptions by default). This can be very useful for reporting, and also to implement a lock-out policy based on authentication
failures. To customize published security events you can provide your own implementations of AbstractAuthenticationAuditListener and
AbstractAuthorizationAuditListener .
You can also choose to use the audit services for your own business events. To do that you can either inject the existing
AuditEventRepository into your own components and use that directly, or you can simply publish AuditApplicationEvent via the Spring
ApplicationEventPublisher (using ApplicationEventPublisherAware ).
53.Tracing
Tracing is automatically enabled for all HTTP requests. You can view the trace endpoint and obtain basic information about the last 100
requests:
[{
"timestamp":1394343677415,
"info":{
"method":"GET",
"path":"/trace",
"headers":{
"request":{
"Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
"Connection":"keepalive",
"AcceptEncoding":"gzip,deflate",
"UserAgent":"Mozilla/5.0Gecko/Firefox",
"AcceptLanguage":"enUS,en;q=0.5",
"Cookie":"_ga=GA1.1.827067509.1390890128;..."
"Authorization":"Basic...",
"Host":"localhost:8080"
},
"response":{
"StrictTransportSecurity":"maxage=31536000;includeSubDomains",
"XApplicationContext":"application:8080",
"ContentType":"application/json;charset=UTF8",
"status":"200"
}
}
}
},{
"timestamp":1394343684465,
...
}]
53.1Custom tracing
If you need to trace additional events you can inject a TraceRepository into your Spring beans. The add method accepts a single Map
structure that will be converted to JSON and logged.
By default an InMemoryTraceRepository will be used that stores the last 100 events. You can dene your own instance of the
InMemoryTraceRepository bean if you need to expand the capacity. You can also create your own alternative TraceRepository
implementation if needed.
54.Process monitoring
In Spring Boot Actuator you can nd a couple of classes to create les that are useful for process monitoring:
ApplicationPidFileWriter creates a le containing the application PID (by default in the application directory with the le name
application.pid ).
EmbeddedServerPortFileWriter creates a le (or les) containing the ports of the embedded server (by default in the application
directory with the le name application.port ).
These writers are not activated by default, but you can enable them in one of the ways described below.
54.1Extend conguration
In METAINF/spring.factories le you can activate the listener(s) that writes a PID le. Example:
org.springframework.context.ApplicationListener=\
org.springframework.boot.system.ApplicationPidFileWriter,\
org.springframework.boot.actuate.system.EmbeddedServerPortFileWriter
54.2Programmatically
You can also activate a listener by invoking the SpringApplication.addListeners(
) method and passing the appropriate Writer object.
This method also allows you to customize the le name and path via the Writer constructor.
55.Cloud Foundry support

Spring Boots 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 NamedMvcEndpoint beans.
The extended support allows Cloud Foundry management UIs (such as the web application that you can use to view deployed applications) to
be augmented with Spring Boot actuator information. For example, an application status page may include full health information instead of the
typical running or stopped status.
The /cloudfoundryapplication path is not directly accessible to regular users. In order to use the endpoint a valid UAA token
must be passed with the request.
55.1Disabling extended Cloud Foundry actuator support

If you want to fully disable the /cloudfoundryapplication endpoints you can add the following to your application.properties le:
management.cloudfoundry.enabled=false
55.2Cloud Foundry self signed certicates

By default, the security verication for /cloudfoundryapplication endpoints makes SSL calls to various Cloud Foundry services. If your
Cloud Foundry UAA or Cloud Controller services use self-signed certicates you will need to set the following property:
management.cloudfoundry.skipsslvalidation=true
55.3Custom security conguration

If you dene custom security conguration, and you want extended Cloud Foundry actuator support, youll should ensure that
/cloudfoundryapplication/** paths are open. Without a direct open route, your Cloud Foundry application manager will not be able to
obtain endpoint data.
For Spring Security, youll typically include something like mvcMatchers("/cloudfoundryapplication/**").permitAll() in your
conguration:
@Override
protectedvoidconfigure(HttpSecurityhttp)throwsException{
http
.authorizeRequests()
.mvcMatchers("/cloudfoundryapplication/**")
.permitAll()
.mvcMatchers("/mypath")
.hasAnyRole("SUPERUSER")
.anyRequest()
.authenticated().and()
.httpBasic();
}

If you want to explore some of the concepts discussed in this chapter, you can take a look at the actuator sample applications. You also 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 Boots build tool
plugins.
PartVI.Deploying Spring Boot applications

Spring Boots exible packaging options provide a great deal of choice when it comes to deploying your application. You can easily deploy
Spring Boot applications to a variety of cloud platforms, to a container images (such as Docker) or to virtual/real machines.
This section covers some of the more common deployment scenarios.
57.Deploying to the cloud

Spring Boots 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 specically), so they need some intermediary
layer that adapts your application to the clouds 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 , it might be an embedded web server, or it might be a full-edged
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 well look at what it takes to get the simple application that we developed in the Getting Started section up and running in the
Cloud.
57.1Cloud Foundry
Cloud Foundry provides default buildpacks that come into play if no other buildpack is specied. 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 youve built your application (using, for example, mvncleanpackage ) and installed the cf command line tool, simply deploy your
application using the cfpush command as follows, substituting the path to your compiled .jar . Be sure to have logged in with your cf
command line client before pushing an application.
$cfpushacloudyspringtimeptarget/demo0.0.1SNAPSHOT.jar
See the cfpush documentation for more options. If there is a Cloud Foundry manifest.yml le present in the same directory, it will be
consulted.
Here we are substituting acloudyspringtime for whatever value you give cf as the name of your application.
At this point cf will start uploading your application:
Uploadingacloudyspringtime...OK
Preparingtostartacloudyspringtime...OK
>Downloadedapppackage(8.9M)
>JavaBuildpackVersion:v3.12(offline)|https://github.com/cloudfoundry/javabuildpack.git#6f25b7e
>DownloadingOpenJdkJRE1.8.0_121fromhttps://javabuildpack.cloudfoundry.org/openjdk/trusty/x86_64/openjdk1.8.0_121.tar.gz
ExpandingOpenJdkJREto.javabuildpack/open_jdk_jre(1.6s)
>DownloadingOpenJDKLikeMemoryCalculator2.0.2_RELEASEfromhttps://javabuildpack.cloudfoundry.org/memorycalculator/trust
MemorySettings:Xss349KXmx681574KXX:MaxMetaspaceSize=104857KXms681574KXX:MetaspaceSize=104857K
>DownloadingContainerCertificateTrustStore1.0.0_RELEASEfromhttps://javabuildpack.cloudfoundry.org/containercertificate
Addingcertificatesto.javabuildpack/container_certificate_trust_store/truststore.jks(0.6s)
>DownloadingSpringAutoReconfiguration1.10.0_RELEASEfromhttps://javabuildpack.cloudfoundry.org/autoreconfiguration/auto
Checkingstatusofapp'acloudyspringtime'...
0of1instancesrunning(1starting)
...
...
...
1of1instancesrunning(1running)
Appstarted
Congratulations! The application is now live!
Its easy to then verify the status of the deployed application:
$cfapps
Gettingapplicationsin...
OK
namerequestedstateinstancesmemorydiskurls
...
acloudyspringtimestarted1/1512M1Gacloudyspringtime.cfapps.io
...
Once Cloud Foundry acknowledges that your application has been deployed, you should be able to hit the application at the URI given, in this
case http://acloudyspringtime.cfapps.io/ .
57.1.1Binding 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 Foundrys polyglot (any language and platform can be
supported as a buildpack) nature; process-scoped environment variables are language agnostic.
Environment variables dont always make for the easiest API so Spring Boot automatically extracts them and attens the data into properties
that can be accessed through Springs Environment abstraction:
@Component
classMyBeanimplementsEnvironmentAware{
privateStringinstanceId;
@Override
publicvoidsetEnvironment(Environmentenvironment){
this.instanceId=environment.getProperty("vcap.application.instance_id");
}
//...
All Cloud Foundry properties are prexed 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 CloudFoundryVcapEnvironmentPostProcessor Javadoc for
complete details.
The Spring Cloud Connectors project is a better t for tasks such as conguring a DataSource. Spring Boot includes auto-
conguration support and a springbootstartercloudconnectors starter.
57.2Heroku
Heroku is another popular PaaS platform. To customize Heroku builds, you provide a Procfile , 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 congure your application to listen on the correct port. Heres the Procfile for our starter REST application:
web:javaDserver.port=$PORTjartarget/demo0.0.1SNAPSHOT.jar
Spring Boot makes D arguments available as properties accessible from a Spring Environment instance. The server.port conguration
property is fed to the embedded Tomcat, Jetty or Undertow instance which then uses it 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 workow for Heroku deployments is to gitpush the code to production.
$gitpushherokumaster
Initializingrepository,done.
Countingobjects:95,done.
Deltacompressionusingupto8threads.
Compressingobjects:100%(78/78),done.
Writingobjects:100%(95/95),8.66MiB|606.00KiB/s,done.
Total95(delta31),reused0(delta0)
>Javaappdetected
>InstallingOpenJDK1.8...done
>InstallingMaven3.3.1...done
>Installingsettings.xml...done
>Executing:mvnBDskipTests=truecleaninstall
[INFO]Scanningforprojects...
Downloading:http://repo.spring.io/...
Downloaded:http://repo.spring.io/...(818Bat1.8KB/sec)
....
Downloaded:http://s3pository.heroku.com/jvm/...(152KBat595.3KB/sec)
[INFO]Installing/tmp/build_0c35a5d2a0674abca23214b1fb7a8229/target/...
[INFO]Installing/tmp/build_0c35a5d2a0674abca23214b1fb7a8229/pom.xml...
[INFO]
[INFO]BUILDSUCCESS
[INFO]
[INFO]Totaltime:59.358s
[INFO]Finishedat:FriMar0707:28:25UTC2014
[INFO]FinalMemory:20M/493M
[INFO]
>Discoveringprocesstypes
Procfiledeclarestypes>web
>Compressing...done,70.4MB
>Launching...done,v6
http://agilesierra1405.herokuapp.com/deployedtoHeroku
Togit@heroku.com:agilesierra1405.git
*[newbranch]master>master
Your application should now be up and running on Heroku.
57.3OpenShift
OpenShift is the RedHat public (and enterprise) PaaS solution. Like Heroku, it works by running scripts triggered by git commits, so you can
script the launching of a Spring Boot application in pretty much any way you like as long as the Java runtime is available (which is a standard
feature you can ask for at OpenShift). To do this you can use the DIY Cartridge and hooks in your repository under
.openshift/action_hooks :
The basic model is to:
1. Ensure Java and your build tool are installed remotely, e.g. using a pre_build hook (Java and Maven are installed by default, Gradle is
not)
2. Use a build hook to build your jar (using Maven or Gradle), e.g.
#!/bin/bash
cd$OPENSHIFT_REPO_DIR
mvnpackages.openshift/settings.xmlDskipTests=true
3. Add a start hook that calls javajar
#!/bin/bash
cd$OPENSHIFT_REPO_DIR
nohupjavajartarget/*.jarserver.port=${OPENSHIFT_DIY_PORT}server.address=${OPENSHIFT_DIY_IP}&
4. Use a stop hook (since the start is supposed to return cleanly), e.g.
#!/bin/bash
source$OPENSHIFT_CARTRIDGE_SDK_BASH
PID=$(psef|grepjava.*\.jar|grepvgrep|awk'{print$2}')
if[z"$PID"]
then
client_result"Applicationisalreadystopped"
else
kill$PID
fi
5. Embed service bindings from environment variables provided by the platform in your application.properties , e.g.
spring.datasource.url:jdbc:mysql://${OPENSHIFT_MYSQL_DB_HOST}:${OPENSHIFT_MYSQL_DB_PORT}/${OPENSHIFT_APP_NAME}
spring.datasource.username:${OPENSHIFT_MYSQL_DB_USERNAME}
spring.datasource.password:${OPENSHIFT_MYSQL_DB_PASSWORD}
Theres a blog on running Gradle in OpenShift on their website that will get you started with a gradle build to run the app.
57.4Amazon 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 les with an embedded web server. Options include :
AWS Elastic Beanstalk

AWS Code Deploy
AWS OPS Works
AWS Cloud Formation
AWS Container Registry
Each has different features and pricing model, here we will describe only the simplest option : AWS Elastic Beanstalk.
57.4.1AWS Elastic Beanstalk

As described in the ofcial Elastic Beanstalk Java guide, there are two main options to deploy a Java application; You can either us the Tomcat
Platform or the Java SE platform.
Using the Tomcat platform

This option applies to Spring Boot projects producing a war le. There is no any special conguration required, just follow the ofcial guide.
Using the Java SE platform

This option applies to Spring Boot projects producing a jar le and running an embedded web container. Elastic Beanstalk environments run an
nginx instance on port 80 to proxy the actual application, running on port 5000. To congure it, add the following to your
application.properties :
server.port=5000
Best practices
Uploading binaries instead of sources

By default Elastic Beanstalk uploads sources and compile them in AWS. To upload the binaries instead, add the following to your
.elasticbeanstalk/config.yml le:
deploy:
artifact:target/demo0.0.1SNAPSHOT.jar
Reduce costs by setting the environment type

By default an Elastic Beanstalk environment is load balanced. The load balancer has a cost perspective, to avoid it, set the environment type to
Single instance as described in the Amazon documentation. Single instance environments can be created using the CLI as well using the
following command:
ebcreates
57.4.2Summary
This is one of the easiest way to get to AWS, but there are more things to cover, e.g.: how to integrate Elastic Beanstalk into any CI / CD tool,
using the Elastic Beanstalk maven plugin instead of the CLI, etc. There is a blog covering these topics more in detail.
57.5Boxfuse and Amazon Web Services

Boxfuse 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. Boxfuse comes with deep integration for Spring Boot and will use the information from your Spring Boot conguration le to
automatically congure ports and health check URLs. Boxfuse leverages this information both for the images it produces as well as for all the
resources it provisions (instances, security groups, elastic load balancers, etc).
Once you have created a Boxfuse account, connected it to your AWS account, and installed the latest version of the Boxfuse Client, you can
deploy your Spring Boot application to AWS as follows (ensure the application has been built by Maven or Gradle rst using, for example,
mvncleanpackage ):
$boxfuserunmyapp1.0.jarenv=prod
See the boxfuserun documentation for more options. If there is a boxfuse.com/docs/commandline/#conguration [ boxfuse.conf ] le
present in the current directory, it will be consulted.
By default Boxfuse will activate a Spring prole named boxfuse on startup and if your executable jar or war contains an
boxfuse.com/docs/payloads/springboot.html#conguration [ applicationboxfuse.properties ] le, Boxfuse will base its
conguration based on the properties it contains.
At this point boxfuse will create an image for your application, upload it, and then congure and start the necessary resources on AWS:
FusingImageformyapp1.0.jar...
Imagefusedin00:06.838s(53937K)>axelfontaine/myapp:1.0
Creatingaxelfontaine/myapp...
Pushingaxelfontaine/myapp:1.0...
Verifyingaxelfontaine/myapp:1.0...
CreatingElasticIP...
Mappingmyappaxelfontaine.boxfuse.ioto52.28.233.167...
WaitingforAWStocreateanAMIforaxelfontaine/myapp:1.0ineucentral1(thismaytakeupto50seconds)...
AMIcreatedin00:23.557s>amid23f38cf
Creatingsecuritygroupboxfusesg_axelfontaine/myapp:1.0...
Launchingt2.microinstanceofaxelfontaine/myapp:1.0(amid23f38cf)ineucentral1...
Instancelaunchedin00:30.306s>i92ef9f53
WaitingforAWStobootInstancei92ef9f53andPayloadtostartathttp://52.28.235.61/...
Payloadstartedin00:29.266s>http://52.28.235.61/
RemappingElasticIP52.28.233.167toi92ef9f53...
Waiting15sforAWStocompleteElasticIPZeroDowntimetransition...
Deploymentcompletedsuccessfully.axelfontaine/myapp:1.0isupandrunningathttp://myappaxelfontaine.boxfuse.io/
Your application should now be up and running on AWS.
Theres a blog on deploying Spring Boot apps on EC2 as well as documentation for the Boxfuse Spring Boot integration on their website that
will get you started with a Maven build to run the app.
57.6Google App Engine
Google App Engine is tied to the Servlet 2.5 API, so you cant deploy a Spring Application there without some modications. See the Servlet 2.5
section of this guide.
58.Installing Spring Boot applications

In additional to running Spring Boot applications using javajar it is also possible to make fully executable applications for Unix systems.
This makes it very easy to install and manage Spring Boot applications in common production environments.
To create a fully executable jar with Maven use the following plugin conguration:
<plugin>
<configuration>
<executable>true</executable>
</configuration>
</plugin>
With Gradle, the equivalent conguration would be:
springBoot{
executable=true
}
You can then run your application by typing ./myapplication.jar (where myapplication is the name of your artifact).
Fully executable jars work by embedding an extra script at the front of the le. Not all tools currently accept this format so you may
not always be able to use this technique.
The default script supports most Linux distributions and is tested on CentOS and Ubuntu. Other platforms, such as OS X and
FreeBSD, will require the use of a custom embeddedLaunchScript .
When a fully executable jar is run, it uses the jars directory as the working directory.
58.1Unix/Linux services
Spring Boot application can be easily started as Unix/Linux services using either init.d or systemd .
58.1.1Installation as an init.d service (System V)

If youve congured Spring Boots Maven or Gradle plugin to generate a fully executable jar, and youre not using a custom
embeddedLaunchScript , then your application can be used as an init.d service. Simply 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 le

Tracks applications PID 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 simply
create a symlink:
$sudolns/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:
$servicemyappstart
If your application fails to start, check the log le written to /var/log/<appname>.log for errors.
You can also ag the application to start automatically using your standard operating system tools. For example, on Debian:
$updaterc.dmyappdefaults<priority>
Securing an init.d service
The following is a set of guidelines on how to secure a Spring Boot application thats being run 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 will run the application as
the user which owns the jar le. You should never run a Spring Boot application as root so your applications jar le should never be owned by
root. Instead, create a specic user to run your application and use chown to make it the owner of the jar le. For example:
$chownbootapp:bootappyourapp.jar
In this case, the default executable script will run the application as the bootapp user.
To reduce the chances of the applications user account being compromised, you should consider preventing it from using a login
shell. Set the accounts shell to /usr/sbin/nologin , for example.
You should also take steps to prevent the modication of your applications jar le. Firstly, congure its permissions so that it cannot be written
and can only be read or executed by its owner:
$chmod500yourapp.jar
Secondly, you should also take steps to limit the damage if your application or the account thats running it is compromised. If an attacker does
gain access, they could make the jar le writable and change its contents. One way to protect against this is to make it immutable using
chattr :
$sudochattr+iyourapp.jar
This will prevent any user, including root, from modifying the jar.
If root is used to control the applications service and you use a .conf le to customize its startup, the .conf le will be read and evaluated
by the root user. It should be secured accordingly. Use chmod so that the le can only be read by the owner and use chown to make root the
owner:
$chmod400yourapp.conf
$sudochownroot:rootyourapp.conf
58.1.2Installation 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 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 using the following example and place it in /etc/systemd/system directory:
[Unit]
Description=myapp
After=syslog.target
[Service]
User=myapp
ExecStart=/var/myapp/myapp.jar
SuccessExitStatus=143
[Install]
WantedBy=multiuser.target
Remember to change the Description , User and ExecStart elds for your application.
Note that ExecStart eld does not declare the script action command, which means that run command is used by default.
Note that unlike when running as an init.d service, user that runs the application, PID le and console log le are managed by systemd
itself and therefore must be congured using appropriate elds in service script. Consult the service unit conguration man page for more
details.
To ag the application to start automatically on system boot use the following command:
$systemctlenablemyapp.service
Refer to mansystemctl for more details.
58.1.3Customizing 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 nd you cant customize something that you need to, you can always use
the embeddedLaunchScript option to write your own le entirely.
Customizing script when its written

It often makes sense to customize elements of the start script as its written into the jar le. For example, init.d scripts can provide a
description and, since you know this up front (and it wont 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 or Gradle plugins.
The following property substitutions are supported with the default script:
Name Description
mode The script mode. Defaults to auto .
initInfoProvides The Provides section of INIT INFO. Defaults to springbootapplication for Gradle and to
${project.artifactId} for Maven.
initInfoRequiredStart The RequiredStart section of INIT INFO. Defaults to $remote_fs$syslog$network .
initInfoRequiredStop The RequiredStop section of INIT INFO. Defaults to $remote_fs$syslog$network .
initInfoDefaultStart The DefaultStart section of INIT INFO. Defaults to 2345 .
initInfoDefaultStop The DefaultStop section of INIT INFO. Defaults to 016 .
initInfoShortDescription The ShortDescription section of INIT INFO. Defaults to SpringBootApplication for Gradle
and to ${project.name} for Maven.
initInfoDescription The Description section of INIT INFO. Defaults to SpringBootApplication for Gradle and to
${project.description} (falling back to ${project.name} ) for Maven.
initInfoChkconfig The chkconfig section of INIT INFO. Defaults to 23459901 .
confFolder The default value for CONF_FOLDER . Defaults to the folder containing the jar.
logFolder The default value for LOG_FOLDER . Only valid for an init.d service.
logFilename The default value for LOG_FILENAME . Only valid for an init.d service.
pidFolder The default value for PID_FOLDER . Only valid for an init.d service.
pidFilename The default value for the name of the pid le in PID_FOLDER . Only valid for an init.d service.
Name Description
useStartStopDaemon If the startstopdaemon command, when its available, should be used to control the process.
Defaults to true .
stopWaitTime The default value for STOP_WAIT_TIME . Only valid for an init.d service. Defaults to 60 seconds.
Customizing 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 cong le.
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 will usually be 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 just want to run the script in the foreground.
USE_START_STOP_DAEMON If the startstopdaemon command, when its available, should be used to 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 to put log les in ( /var/log by default).
CONF_FOLDER The name of the folder to read .conf les from (same folder as jar-le by default).
LOG_FILENAME The name of the log le 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, but 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 le at $JAVA_HOME/bin/java .
JAVA_OPTS Options that are passed to the JVM when it is launched.
JARFILE The explicit location of the jar le, in case the script is being used to launch a jar that it is not actually
embedded in.
DEBUG if not empty will set the x ag on the shell process, making it easy to see the logic in the script.
STOP_WAIT_TIME The time in seconds to wait when stopping the application before forcing a shutdown ( 60 by default).
The PID_FOLDER , LOG_FOLDER and LOG_FILENAME variables are only valid for an init.d service. With systemd the
equivalent customizations are made using service script. Check the service unit conguration man page for more details.
With the exception of JARFILE and APP_NAME , the above settings can be congured using a .conf le. The le is expected next to the jar
le and have the same name but sufxed with .conf rather than .jar . For example, a jar named /var/myapp/myapp.jar will use the
conguration le named /var/myapp/myapp.conf .
myapp.conf.
JAVA_OPTS=Xmx1024M
LOG_FOLDER=/custom/log/folder
You can use a CONF_FOLDER environment variable to customize the location of the cong le if you dont like it living next to the
jar.
To learn about securing this le appropriately, please refer to the guidelines for securing an init.d service.
58.2Microsoft Windows services

Spring Boot application can be started as Windows service using winsw .
A sample maintained separately to the core of Spring Boot describes step-by-step how you can create a Windows service for your Spring Boot
application.

Check out 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 youre free to
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.
PartVII.Spring Boot CLI

The Spring Boot CLI is a command line tool that can be used if you want to quickly develop with Spring. It allows you to 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.
60.Installing the CLI

The Spring Boot CLI can be installed manually; using SDKMAN! (the SDK Manager) or using Homebrew or MacPorts if you are an OSX user.
See Section10.2, Installing the Spring Boot CLI in the Getting started section for comprehensive installation instructions.
61.Using the CLI

Once you have installed the CLI you can run it by typing spring . If you run spring without any arguments, a simple help screen is displayed:
$spring
usage:spring[help][version]
<command>[<args>]
Availablecommandsare:
run[options]<files>[][args]
Runaspringgroovyscript
...morecommandhelpisshownhere
You can use help to get more details about any of the supported commands. For example:
$springhelprun
springrunRunaspringgroovyscript
usage:springrun[options]<files>[][args]
OptionDescription

autoconfigure[Boolean]Addautoconfigurecompiler
transformations(default:true)
classpath,cpAdditionalclasspathentries
e,editOpenthefilewiththedefaultsystem
editor
noguessdependenciesDonotattempttoguessdependencies
noguessimportsDonotattempttoguessimports
q,quietQuietlogging
v,verboseVerboseloggingofdependency
resolution
watchWatchthespecifiedfileforchanges
The version command provides a quick way to check which version of Spring Boot you are using.
$springversion
61.1Running applications using the CLI

You can compile and run Groovy source code using the run command. The Spring Boot CLI is completely self-contained so you dont need
any external Groovy installation.
Here is an example hello world web application written in Groovy:
hello.groovy.
@RestController
classWebApplication{
Stringhome(){
"HelloWorld!"
}
To compile and run the application type:
$springrunhello.groovy
To pass command line arguments to the application, you need to use a to separate them from the spring command arguments, e.g.
$springrunhello.groovyserver.port=9000
To set JVM command line arguments you can use the JAVA_OPTS environment variable, e.g.
$JAVA_OPTS=Xmx1024mspringrunhello.groovy
61.1.1Deduced grab dependencies

Standard Groovy includes a @Grab annotation which allows you to declare dependencies on a third-party libraries. This useful technique allows
Groovy to 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 will attempt to deduce which libraries to grab based on your code. For example, since the
WebApplication code above uses @RestController annotations, Tomcat and Spring MVC will be grabbed.
The following items are used as grab hints:
Items Grabs
JdbcTemplate , NamedParameterJdbcTemplate , DataSource JDBC Application.
@EnableJms JMS Application.
@EnableCaching Caching abstraction.
@Test JUnit.
@EnableRabbit RabbitMQ.
@EnableReactor Project Reactor.
Items Grabs
extends Specification Spock test.
@EnableBatchProcessing Spring Batch.
@MessageEndpoint @EnableIntegrationPatterns Spring Integration.
@EnableDeviceResolver Spring Mobile.
@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 understand exactly how customizations
are applied.
61.1.2Deduced grab coordinates

Spring Boot extends Groovys standard @Grab support by allowing you to specify a dependency without a group or version, for example
@Grab('freemarker') . This will consult Spring Boots default dependency metadata to deduce the artifacts group and version. Note that the
default metadata is tied to the version of the CLI that youre using it will only change when you move to a new version of the CLI, putting you
in control of when the 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.
61.1.3Default import statements

To help reduce the size of your Groovy code, several import statements are automatically included. Notice how the example above refers to
@Component , @RestController and @RequestMapping without needing to use fully-qualied names or import statements.
Many Spring annotations will work without using import statements. Try running your application to see what fails before adding
imports.
61.1.4Automatic main method

Unlike the equivalent Java application, you do not need to include a publicstaticvoidmain(String[]args) method with your Groovy
scripts. A SpringApplication is automatically created, with your compiled code acting as the source .
61.1.5Custom dependency management

By default, the CLI uses the dependency management declared in springbootdependencies when resolving @Grab dependencies.
Additional dependency management, that will override the default dependency management, can be congured using the
@DependencyManagementBom annotation. The annotations value should specify the coordinates ( groupId:artifactId:version ) of one or
more Maven BOMs.
For example, the following declaration:
@DependencyManagementBom("com.example.custombom:1.0.0")
Will pick up custombom1.0.0.pom in a Maven repository under com/example/customversions/1.0.0/ .
When multiple BOMs are specied they are applied in the order that theyre declared. For example:
@DependencyManagementBom(["com.example.custombom:1.0.0",
"com.example.anotherbom:1.0.0"])
indicates that dependency management in anotherbom will override the dependency management in custombom .
You can use @DependencyManagementBom anywhere that you can use @Grab , however, to ensure consistent ordering of the dependency
management, you can only use @DependencyManagementBom at most once in your application. A useful source of dependency management
(that is a superset of Spring Boots dependency management) is the Spring IO Platform, e.g.
@DependencyManagementBom('io.spring.platform:platformbom:1.1.2.RELEASE') .
61.2Testing your code

The test command allows you to compile and run tests for your application. Typical usage looks like this:
$springtestapp.groovytests.groovy
Total:1,Success:1,:Failures:0
Passed?true
In this example, tests.groovy contains JUnit @Test methods or Spock Specification classes. All the common framework annotations
and static methods should be available to you without having to import them.
Here is the tests.groovy le that we used above (with a JUnit test):
classApplicationTests{
@Test
voidhomeSaysHello(){
assertEquals("HelloWorld!",newWebApplication().home())
}
If you have more than one test source les, you might prefer to organize them into a test directory.
61.3Applications with multiple source les

You can use shell globbing with all commands that accept le input. This allows you to easily use multiple les from a single directory, e.g.
$springrun*.groovy
This technique can also be useful if you want to segregate your test or spec code from the main application code:
$springtestapp/*.groovytest/*.groovy
61.4Packaging your application

You can use the jar command to package your application into a self-contained executable jar le. For example:
$springjarmyapp.jar*.groovy
The resulting jar will contain the classes produced by compiling the application and all of the applications dependencies so that it can then be
run using javajar . The jar le will also contain entries from the applications classpath. You can add explicit paths to the jar using
include and exclude (both are comma-separated, and both accept prexes to the values + and - to signify that they should be
removed from the defaults). The default includes are
public/**,resources/**,static/**,templates/**,METAINF/**,*
and the default excludes are
.*,repository/**,build/**,target/**,**/*.jar,**/*.groovy
See the output of springhelpjar for more information.
61.5Initialize a new project

The init command allows you to create a new project using start.spring.io without leaving the shell. For example:
$springinitdependencies=web,datajpamyproject
Usingserviceathttps://start.spring.io
Projectextractedto'/Users/developer/example/myproject'
This creates a myproject directory with a Maven-based project using springbootstarterweb and
springbootstarterdatajpa . You can list the capabilities of the service using the list ag
$springinitlist
=======================================
Capabilitiesofhttps://start.spring.io
=======================================
Availabledependencies:

actuatorActuator:Productionreadyfeaturestohelpyoumonitorandmanageyourapplication
...
webWeb:Supportforfullstackwebdevelopment,includingTomcatandspringwebmvc
websocketWebsocket:SupportforWebSocketdevelopment
wsWS:SupportforSpringWebServices
Availableprojecttypes:

gradlebuildGradleConfig[format:build,build:gradle]
gradleprojectGradleProject[format:project,build:gradle]
mavenbuildMavenPOM[format:build,build:maven]
mavenprojectMavenProject[format:project,build:maven](default)
...
The init command supports many options, check the help output for more details. For instance, the following command creates a gradle
project using Java 8 and war packaging:
$springinitbuild=gradlejavaversion=1.8dependencies=websocketpackaging=warsampleapp.zip
Usingserviceathttps://start.spring.io
Contentsavedto'sampleapp.zip'
61.6Using the embedded shell

Spring Boot includes command-line completion scripts for BASH and zsh shells. If you dont use either of these shells (perhaps you are a
Windows user) then you can use the shell command to launch an integrated shell.
$springshell
SpringBoot(v2.0.0.BUILDSNAPSHOT)
HitTABtocomplete.Type\'help'andhitRETURNforhelp,and\'exit'toquit.
From inside the embedded shell you can run other commands directly:
$version
The embedded shell supports ANSI color output as well as tab completion. If you need to run a native command you can use the ! prex.
Hitting ctrlc will exit the embedded shell.
61.7Adding extensions to the CLI

You can add extensions to the CLI using the install command. The command takes one or more sets of artifact coordinates in the format
group:artifact:version . For example:
$springinstallcom.example:springbootcliextension:1.0.0.RELEASE
In addition to installing the artifacts identied by the coordinates you supply, all of the artifacts' dependencies will also be 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 group:artifact:version . For example:
$springuninstallcom.example:springbootcliextension:1.0.0.RELEASE
It will uninstall the artifacts identied by the coordinates you supply and their dependencies.
To uninstall all additional dependencies you can use the all option. For example:
$springuninstallall
62.Developing application with the Groovy beans DSL

Spring Framework 4.0 has native support for a beans{} DSL (borrowed from Grails), and you can embed bean denitions in your Groovy
application scripts using the same format. This is sometimes a good way to include external features like middleware declarations. For example:
@Configuration
classApplicationimplementsCommandLineRunner{
@Autowired
SharedServiceservice
@Override
voidrun(String...args){
printlnservice.message
}
importmy.company.SharedService
beans{
service(SharedService){
message="HelloWorld"
}
}
You can mix class declarations with beans{} in the same le as long as they stay at the top level, or you can put the beans DSL in a separate
le if you prefer.
63.Conguring the CLI with settings.xml

The Spring Boot CLI uses Aether, Mavens dependency resolution engine, to resolve dependencies. The CLI makes use of the Maven
conguration found in ~/.m2/settings.xml to congure Aether. The following conguration settings are honored by the CLI:
Ofine
Mirrors
Servers
Proxies
Proles
Activation
Repositories
Active proles
Please refer to Mavens settings documentation for further information.

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.
If you nd that you reach the limit of the CLI tool, you will probably want to look at converting your application to full Gradle or Maven built
groovy project. The next section covers Spring Boots Build tool plugins that you can use with Gradle or Maven.
PartVIII.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 Chapter13, Build systems from the PartIII, Using Spring Boot section rst.
65.Spring Boot Maven plugin

The Spring Boot Maven Plugin provides Spring Boot support in Maven, allowing you to package executable jar or war archives and run an
application in-place. To use it you must be using Maven 3.2 (or better).
Refer to the Spring Boot Maven Plugin Site for complete plugin documentation.
65.1Including the plugin

To use the Spring Boot Maven Plugin simply include the appropriate XML in the plugins section of your pom.xml
<!...>
<build>
<plugins>
<plugin>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
This conguration will repackage a jar or war that is built during the package phase of the Maven lifecycle. The following example shows both
the repackaged jar, as well as the original jar, in the target directory:
$mvnpackage
$lstarget/*.jar
target/myproject1.0.0.jartarget/myproject1.0.0.jar.original
If you dont include the <execution/> conguration as above, you can run the plugin on its own (but only if the package goal is used as well).
For example:
$mvnpackagespringboot:repackage
$lstarget/*.jar
target/myproject1.0.0.jartarget/myproject1.0.0.jar.original
If you are using a milestone or snapshot release you will also need to add appropriate pluginRepository elements:
<pluginRepository>
</pluginRepository>
<pluginRepository>
</pluginRepository>
65.2Packaging executable jar and war les
Once springbootmavenplugin has been included in your pom.xml it will automatically attempt to rewrite archives to make them
executable using the springboot:repackage goal. You should congure your project to build a jar or war (as appropriate) using the usual
packaging element:
<!...>
<packaging>jar</packaging>
<!...>
</project>
Your existing archive will be enhanced by Spring Boot during the package phase. The main class that you want to launch can either be
specied using a conguration option, or by adding a MainClass attribute to the manifest in the usual way. If you dont specify a main class
the plugin will search for a class with a publicstaticvoidmain(String[]args) method.
To build and run a project artifact, you can type the following:
$mvnpackage
$javajartarget/mymodule0.0.1SNAPSHOT.jar
To build a war le that is both executable and deployable into an external container you need to mark the embedded container dependencies as
provided, e.g:
<!...>
<packaging>war</packaging>
<!...>
<dependencies>
<dependency>
</dependency>
<dependency>
<artifactId>springbootstartertomcat</artifactId>
<scope>provided</scope>
</dependency>
<!...>
</dependencies>
</project>
See the Section84.1, Create a deployable war le section for more details on how to create a deployable war le.
Advanced conguration options and examples are available in the plugin info page.
66.Spring Boot Gradle plugin

The Spring Boot Gradle Plugin provides Spring Boot support in Gradle, allowing you to package executable jar or war archives, run Spring Boot
applications and use the dependency management provided by springbootdependencies .
66.1Including the plugin

To use the Spring Boot Gradle Plugin simply include a buildscript dependency and apply the springboot plugin:
buildscript{
repositories{
}
dependencies{
classpath'org.springframework.boot:springbootgradleplugin:2.0.0.BUILDSNAPSHOT''
}
}
66.2Gradle dependency management

The springboot plugin automatically applies the Dependency Management Plugin and congures it to import the
springbootstarterparent bom. This provides a similar dependency management experience to the one that is enjoyed by Maven users.
For example, it allows you to omit version numbers when declaring dependencies that are managed in the bom. To make use of this
functionality, simply declare dependencies in the usual way, but leave the version number empty:
dependencies{
compile("org.thymeleaf:thymeleafspring5")
compile("nz.net.ultraq.thymeleaf:thymeleaflayoutdialect")
}
The version of the springboot gradle plugin that you declare determines the version of the springbootstarterparent
bom that is imported (this ensures that builds are always repeatable). You should always set the version of the springboot
gradle plugin to the actual Spring Boot version that you wish to use. Details of the versions that are provided can be found in the
appendix.
To learn more about the capabilities of the Dependency Management Plugin, please refer to its documentation.
66.3Packaging executable jar and war les

Once the springboot plugin has been applied to your project it will automatically attempt to rewrite archives to make them executable using
the bootRepackage task. You should congure your project to build a jar or war (as appropriate) in the usual way.
The main class that you want to launch can either be specied using a conguration option, or by adding a MainClass attribute to the
manifest. If you dont specify a main class the plugin will search for a class with a publicstaticvoidmain(String[]args) method.
Check Section66.6, Repackage conguration for a full list of conguration options.
To build and run a project artifact, you can type the following:
$gradlebuild
$javajarbuild/libs/mymodule0.0.1SNAPSHOT.jar
To build a war le that is both executable and deployable into an external container, you need to mark the embedded container dependencies
as belonging to the war plugins providedRuntime conguration, e.g.:
...
applyplugin:'war'
war{
baseName='myapp'
version='0.5.0'
}
repositories{
jcenter()
maven{url"http://repo.spring.io/libssnapshot"}
}
dependencies{
providedRuntime("org.springframework.boot:springbootstartertomcat")
...
}
See the Section84.1, Create a deployable war le section for more details on how to create a deployable war le.
66.4Running a project in-place

To run a project in place without building a jar rst you can use the bootRun task:
$gradlebootRun
If devtools has been added to your project it will automatically monitor your application for changes. Alternatively, you can also run the
application so that your static classpath resources (i.e. in src/main/resources by default) are reloadable in the live application, which can be
helpful at development time.
bootRun{
addResources=true
}
Making static classpath resources reloadable means that bootRun does not use the output of the processResources task, i.e., when invoked
using bootRun , your application will use the resources in their unprocessed form.
66.5Spring Boot plugin conguration

The gradle plugin automatically extends your build script DSL with a springBoot element for global conguration of the Boot plugin. Set the
appropriate properties as you would with any other Gradle extension (see below for a list of conguration options):
springBoot{
backupSource=false
}
66.6Repackage conguration
The plugin adds a bootRepackage task which you can also congure directly, e.g.:
bootRepackage{
mainClass='demo.Application'
}
The following conguration options are available:
Name Description
enabled Boolean ag to switch the repackager off (sometimes useful if you want the other Boot features
but not this one)
mainClass The main class that should be run. If not specied, and you have applied the application plugin,
the mainClassName project property will be used. If the application plugin has not been applied
or no mainClassName has been specied, the archive will be searched for a suitable class.
"Suitable" means a unique class with a well-formed main() method (if more than one is found
the build will fail). If you have applied the application plugin, the main class can also be specied
via its "run" task ( main property) and/or its "startScripts" task ( mainClassName property) as an
alternative to using the "springBoot" conguration.
classifier A le name segment (before the extension) to add to the archive, so that the original is preserved
in its original location. Defaults to null in which case the archive is repackaged in place. The
default is convenient for many purposes, but if you want to use the original jar as a dependency in
another project you must use a classier to dene the executable archive.
withJarTask The name or value of the Jar task (defaults to all tasks of type Jar ) which is used to locate the
archive to repackage.
customConfiguration The name of the custom conguration which is used to populate the nested lib directory (without
specifying this you get all compile and runtime dependencies).
executable Boolean ag to indicate if jar les are fully executable on Unix like operating systems. Defaults to
false .
embeddedLaunchScript The embedded launch script to prepend to the front of the jar if it is fully executable. If not
specied the 'Spring Boot' default script will be used.
Name Description
embeddedLaunchScriptProperties Additional properties that to be expanded in the launch script. The default script supports a mode
property which can contain the values auto , service or run .
excludeDevtools Boolean ag to indicate if the devtools jar should be excluded from the repackaged archives.
Defaults to true .
66.7Repackage with custom Gradle conguration

Sometimes it may be more appropriate to not package default dependencies resolved from compile , runtime and provided scopes. If the
created executable jar le is intended to be run as it is, you need to have all dependencies nested inside it; however, if the plan is to explode a
jar le and run the main class manually, you may already have some of the libraries available via CLASSPATH . This is a situation where you can
repackage your jar with a different set of dependencies.
Using a custom conguration will automatically disable dependency resolving from compile , runtime and provided scopes. Custom
conguration can be either dened globally (inside the springBoot section) or per task.
taskclientJar(type:Jar){
appendix='client'
fromsourceSets.main.output
exclude('**/*Something*')
}
taskclientBoot(type:BootRepackage,dependsOn:clientJar){
withJarTask=clientJar
customConfiguration="mycustomconfiguration"
}
In above example, we created a new clientJar Jar task to package a customized le set from your compiled sources. Then we created a
new clientBoot BootRepackage task and instructed it to work with only clientJar task and mycustomconfiguration .
configurations{
mycustomconfiguration.excludegroup:'log4j'
}
dependencies{
mycustomconfigurationconfigurations.runtime
}
The conguration that we are referring to in BootRepackage is a normal Gradle conguration. In the above example we created a new
conguration named mycustomconfiguration instructing it to derive from a runtime and exclude the log4j group. If the clientBoot
task is executed, the repackaged boot jar will have all dependencies from runtime but no log4j jars.
66.7.1Conguration options
The following conguration options are available:
Name Description
mainClass The main class that should be run by the executable archive.
providedConfiguration The name of the provided conguration (defaults to providedRuntime ).
backupSource If the original source archive should be backed-up before being repackaged (defaults to true ).
customConfiguration The name of the custom conguration.
layout The type of archive, corresponding to how the dependencies are laid out inside (defaults to a guess based
on the archive type). See available layouts for more details.
'layoutFactory` A layout factory that can be used if a custom layout is required. Alternative layouts can be provided by 3rd
parties. Layout factories are only used when layout is not specied.
Name Description
requiresUnpack A list of dependencies (in the form groupId:artifactId that must be unpacked from fat jars in order to run.
Items are still packaged into the fat jar, but they will be automatically unpacked when it runs.
66.7.2Available layouts
The layout attribute congures the format of the archive and whether the bootstrap loader should be included or not. The following layouts
are available:
Name Description Executable
JAR Regular executable JAR layout. Yes
WAR Executable WAR layout. provided dependencies are placed in WEBINF/libprovided to avoid any Yes
clash when the war is deployed in a servlet container.
ZIP (alias Similar to JAR layout, using PropertiesLauncher . Yes

to DIR )
MODULE Bundle dependencies (excluding those with provided scope) and project resources. No
NONE Bundle all dependencies and project resources. No
66.7.3Using a custom layout

If you have custom requirements for how to arrange the dependencies and loader classes inside the repackaged jar, you can use a custom
layout. Any library which denes one or more LayoutFactory implementations can be added to the build script dependencies and then the
layout factory becomes available in the springBoot conguration. For example:
buildscript{
repositories{
mavenCentral()
}
dependencies{
classpath("org.springframework.boot:springbootgradleplugin:2.0.0.BUILDSNAPSHOT")
classpath("com.example:customlayout:1.0.0")
}
}
springBoot{
layoutFactory=newcom.example.CustomLayoutFactory()
}
If there is only one custom LayoutFactory on the build classpath and it is listed in METAINF/spring.factories then it is
unnecessary to explicitly set it in the springBoot conguration. Layout factories are only used when no explicit layout is
specied.
66.8Understanding how the Gradle plugin works

When springboot is applied to your Gradle project a default task named bootRepackage is created automatically. The bootRepackage
task depends on Gradle assemble task, and when executed, it tries to nd all jar artifacts whose qualier is empty (i.e. tests and sources jars
are automatically skipped).
Due to the fact that bootRepackage nds 'all' created jar artifacts, the order of Gradle task execution is important. Most projects only create a
single jar le, so usually this is not an issue; however, if you are planning to create a more complex project setup, with custom Jar and
BootRepackage tasks, there are few tweaks to consider.
If you are 'just' creating custom jar les from your project you can simply disable default jar and bootRepackage tasks:
jar.enabled=false
bootRepackage.enabled=false
Another option is to instruct the default bootRepackage task to only work with a default jar task.
bootRepackage.withJarTask=jar
If you have a default project setup where the main jar le is created and repackaged, 'and' you still want to create additional custom jars, you
can combine your custom repackage tasks together and use dependsOn so that the bootJars task will run after the default bootRepackage
task is executed:
taskbootJars
bootJars.dependsOn=[clientBoot1,clientBoot2,clientBoot3]
build.dependsOn(bootJars)
All the above tweaks are usually used to avoid situations where an already created boot jar is repackaged again. Repackaging an existing boot
jar will not break anything, but you may nd that it includes unnecessary dependencies.
66.9Publishing artifacts to a Maven repository using Gradle

If you are declaring dependencies without versions and you want to publish artifacts to a Maven repository you will need to congure the Maven
publication with details of Spring Boots dependency management. This can be achieved by conguring it to publish poms that inherit from
springbootstarterparent or that import dependency management from springbootdependencies . The exact details of this
conguration depend on how youre using Gradle and how youre trying to publish the artifacts.
66.9.1Conguring Gradle to produce a pom that inherits dependency management

The following is an example of conguring Gradle to generate a pom that inherits from springbootstarterparent . Please refer to the
Gradle User Guide for further information.
uploadArchives{
repositories{
mavenDeployer{
pom{
project{
parent{
groupId"org.springframework.boot"
artifactId"springbootstarterparent"
version"2.0.0.BUILDSNAPSHOT"
}
}
}
}
}
}
66.9.2Conguring Gradle to produce a pom that imports dependency management

The following is an example of conguring Gradle to generate a pom that imports the dependency management provided by
springbootdependencies . Please refer to the Gradle User Guide for further information.
uploadArchives{
repositories{
mavenDeployer{
pom{
project{
dependencyManagement{
dependencies{
dependency{
groupId"org.springframework.boot"
artifactId"springbootdependencies"
version"2.0.0.BUILDSNAPSHOT"
type"pom"
scope"import"
}
}
}
}
}
}
}
}
67.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 springboot namespace in your build.xml :
<projectxmlns:ivy="antlib:org.apache.ivy.ant"
xmlns:springboot="antlib:org.springframework.boot.ant"
name="myapp"default="build">
...
</project>
Youll need to remember to start Ant using the lib option, for example:
$antlib<foldercontainingspringbootantlib2.0.0.BUILDSNAPSHOT.jar>
The Using Spring Boot section includes a more complete example of using Apache Ant with springbootantlib
67.1Spring Boot Ant tasks

Once the springbootantlib namespace has been declared, the following additional tasks are available.
67.1.1spring-boot:exejar
The exejar task can be used to creates a Spring Boot executable jar. The following attributes are supported by the task:
Attribute Description Required
destfile The destination jar le to create Yes
classes The root directory of Java class les Yes
startclass The main application class to run No (default is rst class found declaring 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 le.
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.
67.1.2Examples
Specify start-class.
<springboot:exejardestfile="target/myapplication.jar"
classes="target/classes"startclass="com.foo.MyApplication">
<resources>
<filesetdir="src/main/resources"/>
</resources>
<lib>
<filesetdir="lib"/>
</lib>
</springboot:exejar>
Detect start-class.
<exejardestfile="target/myapplication.jar"classes="target/classes">
<lib>
<filesetdir="lib"/>
</lib>
</exejar>
67.2spring-boot:ndmainclass
The findmainclass task is used internally by exejar to locate a class declaring a main . You can also use this task directly in your build if
needed. The following attributes are supported
Attribute Description Required
classesroot The root directory of Java class les Yes (unless mainclass is specied)
mainclass Can be used to short-circuit the main class search No
property The Ant property that should be set with the result No (result will be logged if unspecied)
67.2.1Examples
Find and log.
<findmainclassclassesroot="target/classes"/>
Find and set.
<findmainclassclassesroot="target/classes"property="mainclass"/>
Override and set.
<findmainclassmainclass="com.foo.MainClass"property="mainclass"/>
68.Supporting other build systems

If you want to use a build tool other than Maven, Gradle or Ant, you will likely need to develop your own plugin. Executable jars need to follow a
specic 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 springbootloadertools to actually generate jars. You are also free to use
this library directly yourself if you need to.
68.1Repackaging 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 le or write to a new destination.
Various settings can also be congured on the repackager before it is run.
68.2Nested libraries
When repackaging an archive you can include references to dependency les using the
org.springframework.boot.loader.tools.Libraries interface. We dont provide any concrete implementations of Libraries here as
they are usually build system specic.
If your archive already includes libraries you can use Libraries.NONE .
68.3Finding a main class
If you dont use Repackager.setMainClass() to specify a main class, the repackager will use ASM to read class les and attempt to nd a
suitable class with a publicstaticvoidmain(String[]args) method. An exception is thrown if more than one candidate is found.
68.4Example repackage implementation

Here is a typical example repackage:
Repackagerrepackager=newRepackager(sourceJarFile);
repackager.setBackupSource(false);
repackager.repackage(newLibraries(){
@Override
publicvoiddoWithLibraries(LibraryCallbackcallback)throwsIOException{
//Buildsystemspecificimplementation,callbackforeachdependency
//callback.library(newLibrary(nestedFile,LibraryScope.COMPILE));
}
});

If youre interested in how the build tool plugins work you can look at the springboottools module on GitHub. More technical details of the
executable jar format are covered in the appendix.
If you have specic build-related questions you can check out the how-to guides.
PartIX.How-to guides
This section provides answers to some common how do I do that type of questions that often arise when using Spring Boot. This is by no
means an exhaustive list, but it does cover quite a lot.
If you are having a specic problem that we dont cover here, you might want to check out stackoverow.com to see if someone has already
provided an answer; this is also a great place to ask new questions (please use the springboot tag).
Were also more than happy to extend this section; If you want to add a how-to you can send us a pull request.
70.Spring Boot application
70.1Create your own FailureAnalyzer

FailureAnalyzer is a great way to intercept an exception on startup and turn it into a human-readable message, wrapped into a
FailureAnalysis . Spring Boot provides such analyzer for application context related exceptions, JSR-303 validations and more. It is actually
very easy to create your own.
AbstractFailureAnalyzer is a convenient extension of FailureAnalyzer that checks the presence of a specied 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 cant handle the exception, return null to give another implementation a chance to handle the exception.
FailureAnalyzer implementations are to be registered in a METAINF/spring.factories : the following registers

ProjectConstraintViolationFailureAnalyzer :
org.springframework.boot.diagnostics.FailureAnalyzer=\
com.example.ProjectConstraintViolationFailureAnalyzer
70.2Troubleshoot auto-conguration
The Spring Boot auto-conguration 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 will see it if you enable
DEBUG logging output. If you use the springbootactuator there is also an autoconfig endpoint that renders the report in JSON. Use
that to debug the application and see what features have been added (and which not) by Spring Boot at runtime.
Many more questions can be answered by looking at the source code and the Javadoc. Some rules of thumb:
Look for classes called *AutoConfiguration and read their sources, in particular the @Conditional* annotations to nd 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-conguration decisions that were made in your app. In a running Actuator app look at the autoconfig endpoint (/autocong or the
JMX equivalent) for the same information.
Look for classes that are @ConfigurationProperties (e.g. ServerProperties ) and read from there the available external
conguration options. The @ConfigurationProperties has a name attribute which acts as a prex to external properties, thus
ServerProperties has prefix="server" and its conguration properties are server.port , server.address etc. In a running
Actuator app look at the configprops endpoint.
Look for use of RelaxedPropertyResolver to pull conguration values explicitly out of the Environment . It often is used with a prex.
Look for @Value annotations that bind directly to the Environment . This is less exible than the RelaxedPropertyResolver approach,
but does allow some relaxed binding, specically for OS environment variables (so CAPITALS_AND_UNDERSCORES are synonyms for
period.separated ).
Look for @ConditionalOnExpression annotations that switch features on and off in response to SpEL expressions, normally evaluated
with placeholders resolved from the Environment .
70.3Customize 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 METAINF/spring.factories . There is
more than one way to register additional ones:
Programmatically per application by calling the addListeners and addInitializers methods on SpringApplication before you run
it.
Declaratively per application by setting context.initializer.classes or context.listener.classes .
Declaratively for all applications by adding a METAINF/spring.factories and packaging a jar le that the applications all use as a
library.
The SpringApplication sends some special ApplicationEvents to the listeners (even some before the context is created), and then
registers the listeners for events published by the ApplicationContext as well. See Section23.5, 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 using EnvironmentPostProcessor . Each
implementation should be registered in METAINF/spring.factories :
org.springframework.boot.env.EnvironmentPostProcessor=com.example.YourEnvironmentPostProcessor
70.4Build an ApplicationContext hierarchy (adding a parent or root context)

You can use the ApplicationBuilder class to create parent/child ApplicationContext hierarchies. See Section23.4, Fluent builder API
in the Spring Boot features section for more information.
70.5Create 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, then its easy with 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 rst thing
you can do to help it is to just leave the servlet API dependencies off the classpath. If you cant do that (e.g. you are running 2 applications from
the same code base) then you can explicitly call setWebEnvironment(false) 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 denition.
71.Properties & conguration
71.1Automatically expand properties at build time

Rather than hardcoding some properties that are also specied in your projects build conguration, you can automatically expand them using
the existing build conguration instead. This is possible in both Maven and Gradle.
71.1.1Automatic property expansion using Maven

You can automatically expand properties from the Maven project using resource ltering. If you use the springbootstarterparent you
can then refer to your Maven project properties via @..@ placeholders, e.g.
app.encoding=@project.build.sourceEncoding@
app.java.version=@java.version@
The springboot:run can add src/main/resources directly to the classpath (for hot reloading purposes) if you enable the
addResources ag. This circumvents the resource ltering and this feature. You can use the exec:java goal instead or
customize the plugins conguration, see the plugin usage page for more details.
If you dont use the starter parent, in your pom.xml you need (inside the <build/> element):
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
and (inside <plugins/> ):
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>mavenresourcesplugin</artifactId>
<version>2.7</version>
<configuration>
<delimiters>
<delimiter>@</delimiter>
</delimiters>
<useDefaultDelimiters>false</useDefaultDelimiters>
</configuration>
</plugin>
The useDefaultDelimiters property is important if you are using standard Spring placeholders in your conguration (e.g.
${foo} ). These may be expanded by the build if that property is not set to false .
71.1.2Automatic property expansion using Gradle

You can automatically expand properties from the Gradle project by conguring the Java plugins processResources task to do so:
processResources{
expand(project.properties)
}
You can then refer to your Gradle projects properties via placeholders, e.g.
app.name=${name}
app.description=${description}
Gradles expand method uses Groovys SimpleTemplateEngine which transforms ${..} tokens. The ${..} style conicts
with Springs own property placeholder mechanism. To use Spring property placeholders together with automatic expansion the
Spring property placeholders need to be escaped like \${..} .
71.2Externalize the conguration of SpringApplication

A SpringApplication has bean properties (mainly setters) so you can use its Java API as you create the application to modify its behavior.
Or you can externalize the conguration using properties in spring.main.* . E.g. in application.properties you might have.
spring.main.webenvironment=false
spring.main.bannermode=off
and then the Spring Boot banner will not be printed on startup, and the application will not be a web application.
The example above also demonstrates how exible binding allows the use of underscores ( _ ) as well as dashes ( ) in property
names.
Properties dened in external conguration overrides the values specied via the Java API with the notable exception of the sources used to
create the ApplicationContext . Lets consider this application
newSpringApplicationBuilder()
.bannerMode(Banner.Mode.OFF)
.sources(demo.MyApp.class)
.run(args);
used with the following conguration:
spring.main.sources=com.acme.Config,com.acme.ExtraConfig
spring.main.bannermode=console
The actual application will now show the banner (as overridden by conguration) and use three sources for the ApplicationContext (in that
order): demo.MyApp , com.acme.Config , com.acme.ExtraConfig .
71.3Change the location of external properties of an application

By default properties from different sources are added to the Spring Environment in a dened order (see Chapter24, Externalized
Conguration in the Spring Boot features section for the exact order).
A nice way to augment and modify this is to add @PropertySource annotations to your application sources. Classes passed to the
SpringApplication static convenience methods, and those added using setSources() are inspected to see if they have
@PropertySources , and if they do, those properties are added to the Environment early enough to be used in all phases of the
ApplicationContext lifecycle. Properties added in this way have lower priority than any added using the default locations (e.g.
application.properties ), system properties, environment variables or the command line.
You can also provide System properties (or environment variables) to change the behavior:
spring.config.name ( SPRING_CONFIG_NAME ), defaults to application as the root of the le name.

spring.config.location ( SPRING_CONFIG_LOCATION ) is the le to load (e.g. 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 will always load application.properties as described above. If YAML is used then
les with the .yml extension are also added to the list by default.
Spring Boot logs the conguration les that are loaded at DEBUG level and the candidates it has not found at TRACE level.
See ConfigFileApplicationListener for more detail.
71.4Use short command line arguments

Some people like to use (for example) port=9000 instead of server.port=9000 to set conguration properties on the command line.
You can easily enable this by using placeholders in application.properties , e.g.
server.port=${port:8080}
If you are inheriting from the springbootstarterparent POM, the default lter token of the mavenresourcesplugins
has been changed from ${*} to @ (i.e. @maven.token@ instead of ${maven.token} ) to prevent conicts with Spring-style
placeholders. If you have enabled maven ltering for the application.properties directly, you may want to also change the
default lter token to use other delimiters.
In this specic case the port binding will work in a PaaS environment like Heroku and Cloud Foundry, since in those two platforms
the PORT environment variable is set automatically and Spring can bind to capitalized synonyms for Environment properties.
71.5Use YAML for external properties

YAML is a superset of JSON and as such is a very convenient syntax for storing external properties in a hierarchical format. E.g.
spring:
application:
name:cruncher
datasource:
driverClassName:com.mysql.jdbc.Driver
url:jdbc:mysql://localhost/test
server:
port:9000
Create a le called application.yml and stick it in the root of your classpath, and also add snakeyaml to your dependencies (Maven
coordinates org.yaml:snakeyaml , already included if you use the springbootstarter ). A YAML le is parsed to a Java
Map<String,Object> (like a JSON object), and Spring Boot attens the map so that it is 1-level deep and has period-separated keys, a lot
like people are used to with Properties les in Java.
The example YAML above corresponds to an application.properties le
spring.application.name=cruncher
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost/test
server.port=9000
See Section24.6, Using YAML instead of Properties in the Spring Boot features section for more information about YAML.
71.6Set the active Spring proles

The Spring Environment has an API for this, but normally you would set a System property ( spring.profiles.active ) or an OS
environment variable ( SPRING_PROFILES_ACTIVE ). E.g. launch your application with a D argument (remember to put it before the main class
or jar archive):
$javajarDspring.profiles.active=productiondemo0.0.1SNAPSHOT.jar
In Spring Boot you can also set the active prole in application.properties , e.g.
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 proles without changing the
defaults.
See Chapter25, Proles in the Spring Boot features section for more information.
71.7Change conguration depending on the environment

A YAML le is actually a sequence of documents separated by lines, and each document is parsed separately to a attened map.
If a YAML document contains a spring.profiles key, then the proles value (comma-separated list of proles) is fed into the Spring
Environment.acceptsProfiles() and if any of those proles is active that document is included in the nal merge (otherwise not).
Example:
server:
port:9000

spring:
profiles:development
server:
port:9001
spring:
profiles:production
server:
port:0
In this example the default port is 9000, but if the Spring prole development is active then the port is 9001, and if production is active then it
is 0.
The YAML documents are merged in the order they are encountered (so later values override earlier ones).
To do the same thing with properties les you can use application${profile}.properties to specify prole-specic values.
71.8Discover built-in options for external properties

Spring Boot binds external properties from application.properties (or .yml ) (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 les 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
denitive list comes from searching the source code for @ConfigurationProperties and @Value annotations, as well as the occasional use
of RelaxedPropertyResolver .
72.Embedded servlet containers
72.1Add a Servlet, Filter or Listener to an application

There are two ways to add Servlet , Filter , ServletContextListener and the other listeners supported by the Servlet spec to your
application. You can either provide Spring beans for them, or enable scanning for Servlet components.
72.1.1Add a Servlet, Filter or Listener using a Spring bean

To add a Servlet , Filter , or Servlet *Listener provide a @Bean denition for it. This can be very useful when you want to inject
conguration or dependencies. However, you must be very careful that they dont cause eager initialization of too many other beans because
they have to be installed in the container very early in the application lifecycle (e.g. its not a good idea to have them depend on your
DataSource or JPA conguration). You can work around restrictions like that by initializing them lazily when rst 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
ServletRegistrationBean instead of or as well as the underlying component.
If no dispatcherType is specied on a lter registration, it will match FORWARD , INCLUDE and REQUEST . If async has been
enabled, it will match ASYNC as well.
If you are migrating a lter that has no dispatcher element in web.xml you will need to specify a dispatcherType yourself:
@Bean
publicFilterRegistrationBeanmyFilterRegistration(){
FilterRegistrationBeanregistration=newFilterRegistrationBean();
registration.setDispatcherTypes(DispatcherType.REQUEST);
....
returnregistration;
}
Disable registration of a Servlet or Filter

As described above any Servlet or Filter beans will be 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. For example:
@Bean
publicFilterRegistrationBeanregistration(MyFilterfilter){
FilterRegistrationBeanregistration=newFilterRegistrationBean(filter);
registration.setEnabled(false);
returnregistration;
}
72.1.2Add Servlets, Filters, and Listeners 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 will scan from the package of the annotated class.
72.2Change the HTTP port

In a standalone application the main HTTP port defaults to 8080 , but can be set with server.port (e.g. in application.properties or as
a System property). Thanks to relaxed binding of Environment values you can also use SERVER_PORT (e.g. as an OS environment variable).
To switch off the HTTP endpoints completely, but still create a WebApplicationContext , use server.port=1 (this is sometimes useful for
testing).
For more details look at Section27.3.4, Customizing embedded servlet containers in the Spring Boot features section, or the
ServerProperties source code.
72.3Use a random unassigned HTTP port

To scan for a free port (using OS natives to prevent clashes) use server.port=0 .
72.4Discover the HTTP port at runtime

You can access the port the server is running on from log output or from the EmbeddedWebApplicationContext via its EmbeddedWebServer .
The best way to get that and be sure that it has initialized is to add a @Bean of type
ApplicationListener<EmbeddedServletContainerInitializedEvent> 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 eld using the
@LocalServerPort annotation. For example:
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)
publicclassMyWebIntegrationTests{
@Autowired
EmbeddedWebApplicationContextserver;
@LocalServerPort
intport;
//...
@LocalServerPort is a meta-annotation for @Value("${local.server.port}") . Dont try to inject the port in a regular
application. As we just saw, the value is only set once the container has initialized; contrary to a test, application code callbacks
are processed early (i.e. before the value is actually available).
72.5Congure SSL
SSL can be congured declaratively by setting the various server.ssl.* properties, typically in application.properties or
application.yml . For example:
server.port=8443
server.ssl.keystore=classpath:keystore.jks
server.ssl.keystorepassword=secret
server.ssl.keypassword=anothersecret
See Ssl for details of all of the supported properties.
Using conguration like the example above means the application will no longer support plain HTTP connector at port 8080. Spring Boot
doesnt support the conguration of both an HTTP connector and an HTTPS connector via application.properties . If you want to have
both then youll need to congure one of them programmatically. Its recommended to use application.properties to congure HTTPS as
the HTTP connector is the easier of the two to congure programmatically. See the springbootsampletomcatmulticonnectors
sample project for an example.
72.6Congure Access Logging

Access logs can be congured for Tomcat and Undertow via their respective namespaces.
For instance, the following logs access on Tomcat with a custom pattern.
server.tomcat.basedir=mytomcat
server.tomcat.accesslog.enabled=true
server.tomcat.accesslog.pattern=%t%a"%r"%s(%Dms)
The default location for logs is a logs directory relative to the tomcat base dir and said directory is a temp directory by default so
you may want to x Tomcats base directory or use an absolute path for the logs. In the example above, the logs will be available
in mytomcat/logs relative to the working directory of the application.
Access logging for undertow can be congured in a similar fashion
server.undertow.accesslog.enabled=true
server.undertow.accesslog.pattern=%t%a"%r"%s(%Dms)
Logs are stored in a logs directory relative to the working directory of the application. This can be customized via
server.undertow.accesslog.directory .
72.7Use behind a front-end proxy server

Your application might need to send 302 redirects or render content with absolute links back to itself. When running behind a proxy, the caller
wants a link to the proxy, and not to the physical address of the machine hosting your app. Typically such situations are handled via a contract
with the proxy, which will add headers to tell the back end how to construct links to itself.
If the proxy adds conventional XForwardedFor and XForwardedProto headers (most do this out of the box) the absolute links should be
rendered correctly as long as server.useforwardheaders is set to true in your application.properties .
If your application is running in Cloud Foundry or Heroku the server.useforwardheaders property will default to true if not
specied. In all other instances it defaults to false .
72.7.1Customize Tomcats proxy conguration

If you are using Tomcat you can additionally congure the names of the headers used to carry forwarded information:
server.tomcat.remoteipheader=xyourremoteipheader
server.tomcat.protocolheader=xyourprotocolheader
Tomcat is also congured 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 valves conguration by adding an entry to
application.properties , e.g.
server.tomcat.internalproxies=192\\.168\\.\\d{1,3}\\.\\d{1,3}
The double backslashes are only required when youre using a properties le for conguration. If you are using YAML, single
backslashes are sufcient and a value thats equivalent to the one shown above would be 192\.168\.\d{1,3}\.\d{1,3} .
You can trust all proxies by setting the internalproxies to empty (but dont do this in production).
You can take complete control of the conguration of Tomcats RemoteIpValve by switching the automatic one off (i.e. set
server.useforwardheaders=false ) and adding a new valve instance in a TomcatEmbeddedServletContainerFactory bean.
72.8Congure Tomcat
Generally you can follow the advice from Section71.8, Discover built-in options for external properties about @ConfigurationProperties
( ServerProperties is the main one here), but also look at EmbeddedServletContainerCustomizer and various Tomcat-specic
*Customizers that you can add in one of those. The Tomcat APIs are quite rich so once you have access to the
TomcatEmbeddedServletContainerFactory you can modify it in a number of ways. Or the nuclear option is to add your own
TomcatEmbeddedServletContainerFactory .
72.9Enable Multiple Connectors with Tomcat

Add a org.apache.catalina.connector.Connector to the TomcatEmbeddedServletContainerFactory which can allow multiple
connectors, e.g. HTTP and HTTPS connector:
@Bean
publicEmbeddedServletContainerFactoryservletContainer(){
TomcatEmbeddedServletContainerFactorytomcat=newTomcatEmbeddedServletContainerFactory();
tomcat.addAdditionalTomcatConnectors(createSslConnector());
returntomcat;
}
privateConnectorcreateSslConnector(){
Connectorconnector=newConnector("org.apache.coyote.http11.Http11NioProtocol");
Http11NioProtocolprotocol=(Http11NioProtocol)connector.getProtocolHandler();
try{
Filekeystore=newClassPathResource("keystore").getFile();
Filetruststore=newClassPathResource("keystore").getFile();
connector.setScheme("https");
connector.setSecure(true);
connector.setPort(8443);
protocol.setSSLEnabled(true);
protocol.setKeystoreFile(keystore.getAbsolutePath());
protocol.setKeystorePass("changeit");
protocol.setTruststoreFile(truststore.getAbsolutePath());
protocol.setTruststorePass("changeit");
protocol.setKeyAlias("apitester");
returnconnector;
}
catch(IOExceptionex){
thrownewIllegalStateException("can'taccesskeystore:["+"keystore"
+"]ortruststore:["+"keystore"+"]",ex);
}
}
72.10Use Tomcats LegacyCookieProcessor

The embedded Tomcat used by Spring Boot does not support "Version 0" of the Cookie format out of the box, and you may see the following
error:
java.lang.IllegalArgumentException:Aninvalidcharacter[32]waspresentintheCookievalue
If at all possible, you should consider updating your code to only store values compliant with later Cookie specications. If, however, youre
unable to change the way that cookies are written, you can instead congure Tomcat to use a LegacyCookieProcessor . To switch to the
LegacyCookieProcessor use an EmbeddedServletContainerCustomizer bean that adds a TomcatContextCustomizer :
@Bean
publicEmbeddedServletContainerCustomizercookieProcessorCustomizer(){
returnnewEmbeddedServletContainerCustomizer(){
@Override
publicvoidcustomize(ConfigurableEmbeddedServletContainercontainer){
if(containerinstanceofTomcatEmbeddedServletContainerFactory){
((TomcatEmbeddedServletContainerFactory)container)
.addContextCustomizers(newTomcatContextCustomizer(){
@Override
publicvoidcustomize(Contextcontext){
context.setCookieProcessor(newLegacyCookieProcessor());
}
});
}
}
};
}
72.11Use Jetty instead of Tomcat

The Spring Boot starters ( springbootstarterweb in particular) use Tomcat as an embedded container by default. You need to exclude
those dependencies and include the Jetty one instead. Spring Boot provides Tomcat and Jetty dependencies bundled together as separate
starters to help make this process as easy as possible.
Example in Maven:
<dependency>
<exclusions>
<exclusion>
</exclusion>
</exclusions>
</dependency>
<dependency>
<artifactId>springbootstarterjetty</artifactId>
</dependency>
Example in Gradle:
configurations{
compile.excludemodule:"springbootstartertomcat"
}
dependencies{
compile("org.springframework.boot:springbootstarterjetty:2.0.0.BUILDSNAPSHOT")
//...
}
72.12Congure Jetty
( ServerProperties is the main one here), but also look at EmbeddedServletContainerCustomizer . The Jetty APIs are quite rich so once
you have access to the JettyEmbeddedServletContainerFactory you can modify it in a number of ways. Or the nuclear option is to add
your own JettyEmbeddedServletContainerFactory .
72.13Use Undertow instead of Tomcat

Using Undertow instead of Tomcat is very similar to using Jetty instead of Tomcat. You need to exclude the Tomcat dependencies and include
the Undertow starter instead.
Example in Maven:
<dependency>
<exclusions>
<exclusion>
</exclusion>
</exclusions>
</dependency>
<dependency>
<artifactId>springbootstarterundertow</artifactId>
</dependency>
Example in Gradle:
configurations{
compile.excludemodule:"springbootstartertomcat"
}
dependencies{
compile("org.springframework.boot:springbootstarterundertow:2.0.0.BUILDSNAPSHOT")
//...
}
72.14Congure Undertow
( ServerProperties and ServerProperties.Undertow are the main ones here), but also look at
EmbeddedServletContainerCustomizer . Once you have access to the UndertowEmbeddedServletContainerFactory you can use an
UndertowBuilderCustomizer to modify Undertows conguration to meet your needs. Or the nuclear option is to add your own
UndertowEmbeddedServletContainerFactory .
72.15Enable Multiple Listeners with Undertow

Add an UndertowBuilderCustomizer to the UndertowEmbeddedServletContainerFactory and add a listener to the Builder :
@Bean
publicUndertowEmbeddedServletContainerFactoryembeddedServletContainerFactory(){
UndertowEmbeddedServletContainerFactoryfactory=newUndertowEmbeddedServletContainerFactory();
factory.addBuilderCustomizers(newUndertowBuilderCustomizer(){
@Override
publicvoidcustomize(Builderbuilder){
builder.addHttpListener(8080,"0.0.0.0");
}
});
returnfactory;
}
72.16Create 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 :
@Bean
publicServerEndpointExporterserverEndpointExporter(){
returnnewServerEndpointExporter();
}
This bean will register 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.
72.17Enable HTTP response compression

HTTP response compression is supported by Jetty, Tomcat, and Undertow. It can be enabled via application.properties :
server.compression.enabled=true
By default, responses must be at least 2048 bytes in length for compression to be performed. This can be congured using the
server.compression.minresponsesize property.
By default, responses will only be compressed if their content type is one of the following:
text/html
text/xml
text/plain
text/css
This can be congured using the server.compression.mimetypes property.
73.Spring MVC
73.1Write 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.
For example:
@RestController
publicclassMyController{
@RequestMapping("/thing")
publicMyThingthing(){
returnnewMyThing();
}
As long as MyThing can be serialized by Jackson2 (e.g. a normal POJO or Groovy object) then localhost:8080/thing will serve a JSON
representation of it by default. Sometimes in a browser you might see XML responses because browsers tend to send accept headers that
prefer XML.
73.2Write an XML REST service

If you have the Jackson XML extension ( jacksondataformatxml ) on the classpath, it will be used to render XML responses and the very
same example as we used for JSON would work. To use it, add the following dependency to your project:
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jacksondataformatxml</artifactId>
</dependency>
You may also want to add a dependency on Woodstox. Its faster than the default StAX implementation provided by the JDK and also adds
pretty print support and improved namespace handling:
<dependency>
<groupId>org.codehaus.woodstox</groupId>
<artifactId>woodstoxcoreasl</artifactId>
</dependency>
If Jacksons XML extension is not available, JAXB (provided by default in the JDK) will be used, with the additional requirement to have
MyThing annotated as @XmlRootElement :
@XmlRootElement
publicclassMyThing{
privateStringname;
//..gettersandsetters
}
To get the server to render XML instead of JSON you might have to send an Accept:text/xml header (or use a browser).
73.3Customize the Jackson ObjectMapper
Spring MVC (client and server side) uses HttpMessageConverters to negotiate content conversion in 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-congured
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
Spring Boot has also some features to make it easier to customize this behavior.
You can congure the ObjectMapper and XmlMapper instances using the environment. Jackson provides an extensive suite of simple on/off
features that can be used to congure various aspects of its processing. These features are described in six enums in Jackson which map onto
properties in the environment:
Jackson enum Environment property
com.fasterxml.jackson.databind.DeserializationFeature spring.jackson.deserialization.<feature_name>=true|false
com.fasterxml.jackson.core.JsonGenerator.Feature spring.jackson.generator.<feature_name>=true|false
com.fasterxml.jackson.databind.MapperFeature spring.jackson.mapper.<feature_name>=true|false
com.fasterxml.jackson.core.JsonParser.Feature spring.jackson.parser.<feature_name>=true|false
com.fasterxml.jackson.databind.SerializationFeature spring.jackson.serialization.<feature_name>=true|false
com.fasterxml.jackson.annotation.JsonInclude.Include spring.jackson.defaultpropertyinclusion=always|non_null|non_absen
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 doesnt have to match the case of the corresponding enum constant which is INDENT_OUTPUT .
This environment-based conguration is applied to the auto-congured Jackson2ObjectMapperBuilder bean, and will apply to any mappers
created using the builder, including the auto-congured ObjectMapper bean.
The contexts Jackson2ObjectMapperBuilder can be customized by one or more Jackson2ObjectMapperBuilderCustomizer beans.

Such customizer beans can be ordered and Boots own customizer has an order of 0, allowing additional customization to be applied both
before and after Boots customization.
Any beans of type com.fasterxml.jackson.databind.Module will be automatically registered with the auto-congured
Jackson2ObjectMapperBuilder and 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.
If you want to replace the default ObjectMapper completely, either dene a @Bean of that type and mark it as @Primary , or, if you prefer the
builder-based approach, dene a Jackson2ObjectMapperBuilder @Bean . Note that in either case this will disable all auto-conguration of
the `ObjectMapper.
If you provide any @Beans of type MappingJackson2HttpMessageConverter then they will replace the default value in the MVC
conguration. Also, a convenience bean is provided of type HttpMessageConverters (always available if you use the default MVC
conguration) which has some useful methods to access the default and user-enhanced message converters.
See also the Section73.4, Customize the @ResponseBody rendering section and the WebMvcAutoConfiguration source code for more
details.
73.4Customize the @ResponseBody rendering

Spring uses HttpMessageConverters to render @ResponseBody (or responses from @RestController ). You can contribute additional
converters by simply adding beans of that type in a Spring Boot context. If a bean you add is of a type that would have been included by default
anyway (like MappingJackson2HttpMessageConverter for JSON conversions) then it will replace the default value. A convenience bean is
provided of type HttpMessageConverters (always available if you use the default MVC conguration) which has some useful methods to
access the default and user-enhanced message converters (useful, for example if you want to manually inject them into a custom
RestTemplate ).
As in normal MVC usage, any WebMvcConfigurerAdapter beans that you provide can also contribute converters by overriding the
configureMessageConverters method, but 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 conguration by
providing your own @EnableWebMvc conguration, then you can take control completely and do everything manually using
getMessageConverters from WebMvcConfigurationSupport .
See the WebMvcAutoConfiguration source code for more details.
73.5Handling Multipart File Uploads

Spring Boot embraces the Servlet 3 javax.servlet.http.Part API to support uploading les. By default Spring Boot congures Spring MVC
with a maximum le of 1MB per le and a maximum of 10MB of le data in a single request. You may override these values, as well as the
location to which intermediate data is stored (e.g., to the /tmp directory) and the threshold past which data is ushed to disk by using the
properties exposed in the MultipartProperties class. If you want to specify that les be unlimited, for example, set the
spring.http.multipart.maxfilesize property to 1 .
The multipart support is helpful when you want to receive multipart encoded le data as a @RequestParam -annotated parameter of type
MultipartFile in a Spring MVC controller handler method.
See the MultipartAutoConfiguration source for more details.
73.6Switch off the Spring MVC DispatcherServlet

Spring Boot wants to serve all content from the root of your application / down. If you would rather map your own servlet to that URL you can
do it, but of course you may lose some of the other Boot MVC features. To add your own servlet and map it to the root resource just declare a
@Bean of type Servlet and give it the special bean name dispatcherServlet (You can also create a bean of a different type with that
name if you want to switch it off and not replace it).
73.7Switch off the Default MVC conguration

The easiest way to take complete control over MVC conguration is to provide your own @Configuration with the @EnableWebMvc
annotation. This will leave all MVC conguration in your hands.
73.8Customize 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 nds on the classpath and in the application context. The
DispatcherServlet uses all the resolvers it nds in the application context, trying each one in turn until it gets a result, so if you are adding
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:
An InternalResourceViewResolver with bean id defaultViewResolver. This one locates physical resources that can be rendered using
the DefaultServlet (e.g. static resources and JSP pages if you are using those). It applies a prex and a sufx to the view name and
then looks for a physical resource with that path in the servlet context (defaults are both empty, but accessible for external conguration via
spring.mvc.view.prefix and spring.mvc.view.suffix ). It can be overridden by providing a bean of the same type.
A BeanNameViewResolver with id beanNameViewResolver. This is a useful member of the view resolver chain and will pick up any
beans with the same name as the View being resolved. It shouldnt be necessary to override or replace it.
A ContentNegotiatingViewResolver with id viewResolver is only added if there are actually beans of type View present. This is a
master resolver, delegating to all the others and attempting to nd 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 also look at the source code for
detail. You can switch off the auto-congured ContentNegotiatingViewResolver by dening a bean named viewResolver.
If you use Thymeleaf you will also have a ThymeleafViewResolver with id thymeleafViewResolver. It looks for resources by surrounding
the view name with a prex and sufx (externalized to spring.thymeleaf.prefix and spring.thymeleaf.suffix , defaults
classpath:/templates/ and .html respectively). It can be overridden by providing a bean of the same name.
If you use FreeMarker you will also have a FreeMarkerViewResolver with id freeMarkerViewResolver. It looks for resources in a loader
path (externalized to spring.freemarker.templateLoaderPath , default classpath:/templates/) by surrounding the view name with a
prex and sufx (externalized to spring.freemarker.prefix and spring.freemarker.suffix , with empty and .ftl defaults
respectively). It can be overridden by providing a bean of the same name.
If you use Groovy templates (actually if groovy-templates is on your classpath) you will also have a GroovyMarkupViewResolver with id
groovyMarkupViewResolver. It looks for resources in a loader path by surrounding the view name with a prex and sufx (externalized to
spring.groovy.template.prefix and spring.groovy.template.suffix , defaults classpath:/templates/ and .tpl respectively). It
can be overridden by providing a bean of the same name.
Check out WebMvcAutoConfiguration , ThymeleafAutoConfiguration , FreeMarkerAutoConfiguration and

GroovyTemplateAutoConfiguration
74.HTTP clients
74.1Congure RestTemplate to use a proxy

As described in Section33.1, RestTemplate customization, a RestTemplateCustomizer can be used with RestTemplateBuilder to build
a customized RestTemplate . This is the recommended approach for creating a RestTemplate congured to use a proxy.
The exact details of the proxy conguration depend on the underlying client request factory that is being used. Heres an example of conguring
HttpComponentsClientRequestFactory with an HttpClient that uses a proxy for all hosts except 192.168.0.5 .
staticclassProxyCustomizerimplementsRestTemplateCustomizer{
@Override
publicvoidcustomize(RestTemplaterestTemplate){
HttpHostproxy=newHttpHost("proxy.example.com");
HttpClienthttpClient=HttpClientBuilder.create()
.setRoutePlanner(newDefaultProxyRoutePlanner(proxy){
@Override
publicHttpHostdetermineProxy(HttpHosttarget,
HttpRequestrequest,HttpContextcontext)
throwsHttpException{
if(target.getHostName().equals("192.168.0.5")){
returnnull;
}
returnsuper.determineProxy(target,request,context);
}
}).build();
restTemplate.setRequestFactory(
newHttpComponentsClientHttpRequestFactory(httpClient));
}
75.Logging
Spring Boot has no mandatory logging dependency, except for the Commons Logging API, of which there are many implementations to choose
from. To use Logback you need to include it and jcloverslf4j (which implements the Commons Logging API) on the classpath. The
simplest way to do that is through the starters which all depend on springbootstarterlogging . For a web application you only need
springbootstarterweb since it depends transitively on the logging starter. For example, using Maven:
<dependency>
</dependency>
Spring Boot has a LoggingSystem abstraction that attempts to congure logging based on the content of the classpath. If Logback is available
it is the rst choice.
If the only change you need to make to logging is to set the levels of various loggers then you can do that in application.properties using
the "logging.level" prex, e.g.
logging.level.org.springframework.web=DEBUG
logging.level.org.hibernate=ERROR
You can also set the location of a le to log to (in addition to the console) using "logging.le".
To congure the more ne-grained settings of a logging system you need to use the native conguration format supported by the
LoggingSystem in question. By default Spring Boot picks up the native conguration from its default location for the system (e.g.
classpath:logback.xml for Logback), but you can set the location of the cong le using the "logging.cong" property.
75.1Congure Logback for logging

If you put a logback.xml in the root of your classpath it will be picked up from there (or logbackspring.xml to take advantage of the
templating features provided by Boot). Spring Boot provides a default base conguration that you can include if you just want to set levels, e.g.
<configuration>
<includeresource="org/springframework/boot/logging/logback/base.xml"/>
<loggername="org.springframework.web"level="DEBUG"/>
</configuration>
If you look at that base.xml in the spring-boot jar, you will see that it uses some useful System properties which the LoggingSystem takes
care of creating for you. These are:
${PID} the current process ID.

${LOG_FILE} if logging.file was set in Boots external conguration.
${LOG_PATH} if logging.path was set (representing a directory for log les to live in).
${LOG_EXCEPTION_CONVERSION_WORD} if logging.exceptionconversionword was set in Boots external conguration.
Spring Boot also provides some nice ANSI colour terminal output on a console (but not in a log le) using a custom Logback converter. See the
default base.xml conguration for details.
If Groovy is on the classpath you should be able to congure Logback with logback.groovy as well (it will be given preference if present).
75.1.1Congure logback for le only output

If you want to disable console logging and write output only to a le you need a custom logbackspring.xml that imports
fileappender.xml but not consoleappender.xml :
<configuration>
<includeresource="org/springframework/boot/logging/logback/defaults.xml"/>
<propertyname="LOG_FILE"value="${LOG_FILE:${LOG_PATH:${LOG_TEMP:${java.io.tmpdir:/tmp}}/}spring.log}"/>
<includeresource="org/springframework/boot/logging/logback/fileappender.xml"/>
<rootlevel="INFO">
<appenderrefref="FILE"/>
</root>
</configuration>
You also need to add logging.file to your application.properties :
logging.file=myapplication.log
75.2Congure Log4j for logging

Spring Boot supports Log4j 2 for logging conguration if it is on the classpath. If you are using the starters for assembling dependencies that
means you have to exclude Logback and then include log4j 2 instead. If you arent using the starters then you need to provide
jcloverslf4j (at least) in addition to Log4j 2.
The simplest path is probably through the starters, even though it requires some jiggling with excludes, .e.g. in Maven:
<dependency>
</dependency>
<dependency>
<artifactId>springbootstarter</artifactId>
<exclusions>
<exclusion>
<artifactId>springbootstarterlogging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<artifactId>springbootstarterlog4j2</artifactId>
</dependency>
The use of the Log4j starters gathers together the dependencies for common logging requirements (e.g. including having Tomcat
use java.util.logging but conguring the output using Log4j 2). See the Actuator Log4j 2 samples for more detail and to see
it in action.
75.2.1Use YAML or JSON to congure Log4j 2

In addition to its default XML conguration format, Log4j 2 also supports YAML and JSON conguration les. To congure Log4j 2 to use an
alternative conguration le format, add the appropriate dependencies to the classpath and name your conguration les to match your chosen
le format:
Format Dependencies File names
YAML com.fasterxml.jackson.core:jacksondatabind log4j2.yaml

com.fasterxml.jackson.dataformat:jacksondataformatyaml log4j2.yml
JSON com.fasterxml.jackson.core:jacksondatabind log4j2.json

log4j2.jsn
76.Data Access
76.1Congure a custom DataSource

To congure your own DataSource dene a @Bean of that type in your conguration. Spring Boot will reuse your DataSource anywhere one
is required, including database initialization. If you need to externalize some settings, you can easily bind your DataSource to the environment
(see Section24.7.1, Third-party conguration).
@Bean
@ConfigurationProperties(prefix="app.datasource")
publicDataSourcedataSource(){
returnnewFancyDataSource();
}
app.datasource.url=jdbc:h2:mem:mydb
app.datasource.username=sa
app.datasource.poolsize=30
Assuming that your FancyDataSource has regular JavaBean properties for the url, the username and the pool size, these settings will be
bound automatically before the DataSource is made available to other components. The regular database initialization will also happen (so the
relevant sub-set of spring.datasource.* can still be used with your custom conguration).
You can apply the same principle if you are conguring a custom JNDI DataSource :
@Bean(destroyMethod="")
@ConfigurationProperties(prefix="app.datasource")
publicDataSourcedataSource()throwsException{
JndiDataSourceLookupdataSourceLookup=newJndiDataSourceLookup();
returndataSourceLookup.getDataSource("java:comp/env/jdbc/YourDS");
}
Spring Boot also provides a utility builder class 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 whats available on the classpath. It also auto detects the driver based on the JDBC
url.
@Bean
@ConfigurationProperties("app.datasource")
publicDataSourcedataSource(){
returnDataSourceBuilder.create().build();
}
To run an app with that DataSource , all that is needed really is the connection information; pool-specic settings can also be provided, check
the implementation that is going to be used at runtime for more details.
app.datasource.url=jdbc:mysql://localhost/test
app.datasource.username=dbuser
app.datasource.password=dbpass
app.datasource.poolsize=30
There is a catch however. 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 (The DataSource interface doesnt expose any property). Also, if you happen
to only have Hikari on the classpath, this basic setup will not work because Hikari has no url parameter (but a jdbcUrl parameter). You will
have to rewrite your conguration as follows:
app.datasource.jdbcurl=jdbc:mysql://localhost/test
app.datasource.maximumpoolsize=30
You can x that by forcing the connection pool to use and return a dedicated implementation rather than DataSource . You wont be able to
change the implementation at runtime but the list of options will be explicit.
@Bean
publicHikariDataSourcedataSource(){
return(HikariDataSource)DataSourceBuilder.create()
.type(HikariDataSource.class).build();
}
You can even go further by leveraging what DataSourceProperties does for you, that is providing a default embedded database if no url is
provided with a sensible username and password for it. You can easily initialize a DataSourceBuilder from the state of any
DataSourceProperties so you could just as well inject the one Spring Boot creates automatically. However, that would split your
conguration in 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 redene a custom DataSourceProperties on your custom namespace:
@Bean
@Primary
publicDataSourcePropertiesdataSourceProperties(){
returnnewDataSourceProperties();
}
@Bean
publicHikariDataSourcedataSource(DataSourcePropertiesproperties){
return(HikariDataSource)properties.initializeDataSourceBuilder()
.type(HikariDataSource.class).build();
}
This setup puts you in pair 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 same namespace. Because DataSourceProperties is taking care of the url / jdbcUrl translation for you, you
can congure it like this:
app.datasource.url=jdbc:mysql://localhost/test
app.datasource.maximumpoolsize=30
Because your custom conguration chooses to go with Hikari, app.datasource.type will have no effect. In practice the builder
will be initialized with whatever value you might set there and then overridden by the call to .type()` .
See Section29.1, Congure a DataSource in the Spring Boot features section and the DataSourceAutoConfiguration class for more
details.
76.2Congure Two DataSources
If you need to congure multiple data sources, you can apply the same tricks that are described in the previous section. You must, however,
mark one of the DataSource @Primary as various auto-congurations down the road expect to be able to get one by type.
If you create your own DataSource , the auto-conguration will back off. In the example below, we provide the exact same features set than
what the auto-conguration provides on the primary data source:
@Bean
@Primary
@ConfigurationProperties("app.datasource.foo")
publicDataSourcePropertiesfooDataSourceProperties(){
}
@Bean
@Primary
publicDataSourcefooDataSource(){
returnfooDataSourceProperties().initializeDataSourceBuilder().build();
}
@Bean
@ConfigurationProperties("app.datasource.bar")
publicBasicDataSourcebarDataSource(){
return(BasicDataSource)DataSourceBuilder.create()
.type(BasicDataSource.class).build();
}
fooDataSourceProperties has to be agged @Primary so that the database initializer feature uses your copy (should you
use that).
Both data sources are also bound for advanced customizations. For instance you could congure them as follows:
app.datasource.foo.type=com.zaxxer.hikari.HikariDataSource
app.datasource.foo.maximumpoolsize=30
app.datasource.bar.url=jdbc:mysql://localhost/test
app.datasource.bar.username=dbuser
app.datasource.bar.password=dbpass
app.datasource.bar.maxtotal=30
Of course, you can apply the same concept to the secondary DataSource as well:
@Bean
@Primary
publicDataSourcePropertiesfooDataSourceProperties(){
}
@Bean
@Primary
publicDataSourcefooDataSource(){
returnfooDataSourceProperties().initializeDataSourceBuilder().build();
}
@Bean
publicDataSourcePropertiesbarDataSourceProperties(){
}
@Bean
publicDataSourcebarDataSource(){
returnbarDataSourceProperties().initializeDataSourceBuilder().build();
}
This nal example congures two data sources on custom namespaces with the same logic than what Spring Boot would do in auto-
conguration.
76.3Use Spring Data repositories

Spring Data can create implementations for you of @Repository interfaces of various avors. Spring Boot will handle 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 will need is to put the right Spring Data dependencies on your classpath (there is a
springbootstarterdatajpa for JPA and a springbootstarterdatamongodb for Mongodb), create some repository interfaces to
handle your @Entity objects. Examples are in the JPA sample or the Mongodb sample.
Spring Boot tries to guess the location of your @Repository denitions, based on the @EnableAutoConfiguration it nds. To get more
control, use the @EnableJpaRepositories annotation (from Spring Data JPA).
76.4Separate @Entity denitions from Spring conguration

Spring Boot tries to guess the location of your @Entity denitions, based on the @EnableAutoConfiguration it nds. To get more control,
you can use the @EntityScan annotation, e.g.
@Configuration
@EntityScan(basePackageClasses=City.class)
//...
76.5Congure JPA properties

Spring Data JPA already provides some vendor-independent conguration options (e.g. for SQL logging) and Spring Boot exposes those, and a
few more for hibernate as external conguration properties. Some of them are automatically detected according to the context so you shouldnt
have to set them.
The spring.jpa.hibernate.ddlauto is a special case in that it has different defaults depending on whether you are using an embedded
database ( createdrop ) or not ( none ). The dialect to use is also automatically detected based on the current DataSource but you can set
spring.jpa.database yourself if you want to be explicit and bypass that check on startup.
Specifying a database leads to the conguration of a well-dened Hibernate dialect. Several databases have more than one
Dialect and this may not suit your need. In that case, you can either set spring.jpa.database to default to let Hibernate
gure things out or set the dialect using the spring.jpa.databaseplatform property.
The most common options to set are:
spring.jpa.hibernate.naming.physicalstrategy=com.example.MyPhysicalNamingStrategy
spring.jpa.showsql=true
In addition all properties in spring.jpa.properties.* are passed through as normal JPA properties (with the prex stripped) when the local
EntityManagerFactory is created.
Hibernate denes Physical and Implicit naming strategies: Spring Boot congures SpringPhysicalNamingStrategy by default. This
implementation provides the same table structure as Hibernate 4. If youd rather use Hibernate 5s default instead, set the following property:
spring.jpa.hibernate.naming.physicalstrategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
See HibernateJpaAutoConfiguration and JpaBaseConfiguration for more details.
76.6Use a custom EntityManagerFactory

To take full control of the conguration of the EntityManagerFactory , you need to add a @Bean named entityManagerFactory. Spring Boot
auto-conguration switches off its entity manager based on the presence of a bean of that type.
76.7Use Two EntityManagers
Even if the default EntityManagerFactory works ne, you will need to dene a new one because otherwise the presence of the second bean
of that type will switch off the default. To make it easy to do that you can use the convenient EntityManagerBuilder provided by Spring Boot,
or if you prefer you can just use the LocalContainerEntityManagerFactoryBean directly from Spring ORM.
Example:
//addtwodatasourcesconfiguredasabove
@Bean
publicLocalContainerEntityManagerFactoryBeancustomerEntityManagerFactory(
EntityManagerFactoryBuilderbuilder){
returnbuilder
.dataSource(customerDataSource())
.packages(Customer.class)
.persistenceUnit("customers")
.build();
}
@Bean
publicLocalContainerEntityManagerFactoryBeanorderEntityManagerFactory(
EntityManagerFactoryBuilderbuilder){
returnbuilder
.dataSource(orderDataSource())
.packages(Order.class)
.persistenceUnit("orders")
.build();
}
The conguration above almost works on its own. To complete the picture you need to congure TransactionManagers for the two
EntityManagers as well. One of them could be picked up by the default JpaTransactionManager in Spring Boot if you mark it as
@Primary . The other would have to be explicitly injected into a new instance. Or you might be able to use a JTA transaction manager spanning
both.
If you are using Spring Data, you need to congure @EnableJpaRepositories accordingly:
@Configuration
@EnableJpaRepositories(basePackageClasses=Customer.class,
entityManagerFactoryRef="customerEntityManagerFactory")
publicclassCustomerConfiguration{
...
}
@Configuration
@EnableJpaRepositories(basePackageClasses=Order.class,
entityManagerFactoryRef="orderEntityManagerFactory")
publicclassOrderConfiguration{
...
}
76.8Use a traditional persistence.xml

Spring doesnt require the use of XML to congure the JPA provider, and Spring Boot assumes you want to take advantage of that feature. If
you prefer to use persistence.xml then you need to dene your own @Bean of type LocalEntityManagerFactoryBean (with id
entityManagerFactory, and set the persistence unit name there.
See JpaBaseConfiguration for the default settings.
76.9Use Spring Data JPA and Mongo repositories

Spring Data JPA and Spring Data Mongo can both create Repository implementations for you automatically. If they are both present on the
classpath, you might have to do some extra conguration to tell Spring Boot which one (or both) you want to create repositories for you. The
most explicit way to do that is to use the standard Spring Data @Enable*Repositories and tell it the location of your Repository interfaces
(where * is Jpa or Mongo or both).
There are also ags spring.data.*.repositories.enabled that you can use to switch the auto-congured repositories on and off in
external conguration. This is useful for instance in case you want to switch off the Mongo repositories and still use the auto-congured
MongoTemplate .
The same obstacle and the same features exist for other auto-congured Spring Data repository types (Elasticsearch, Solr). Just change the
names of the annotations and ags respectively.
76.10Expose Spring Data repositories as REST endpoint

Spring Data REST can expose the Repository implementations as REST endpoints for you as long as Spring MVC has been enabled for the
application.
Spring Boot exposes as 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 dont specify any order on your custom RepositoryRestConfigurer it will run after the one Spring Boot uses internally. If
you need to specify an order, make sure it is higher than 0.
76.11Congure a component that is used by JPA

If you want to congure a component that will be used by JPA then you need to ensure that the component is initialized before JPA. Where the
component is auto-congured Spring Boot will take care of this for you. For example, when Flyway is auto-congured, Hibernate is congured
to depend upon Flyway so that the latter has a chance to initialize the database before Hibernate tries to use it.
If you are conguring a component yourself, you can use an EntityManagerFactoryDependsOnPostProcessor subclass as a convenient
way of setting up the necessary dependencies. For example, if you are using Hibernate Search with Elasticsearch as its index manager then
any EntityManagerFactory beans must be congured to depend on the elasticsearchClient bean:
/**
*{@linkEntityManagerFactoryDependsOnPostProcessor}thatensuresthat
*{@linkEntityManagerFactory}beansdependonthe{@codeelasticsearchClient}bean.
*/
@Configuration
staticclassElasticsearchJpaDependencyConfiguration
extendsEntityManagerFactoryDependsOnPostProcessor{
ElasticsearchJpaDependencyConfiguration(){
super("elasticsearchClient");
}
77.Database initialization
An SQL database can be initialized in different ways depending on what your stack is. Or of course you can do it manually as long as the
database is a separate process.
77.1Initialize 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.generateddl (boolean) switches the feature on and off and is vendor independent.
spring.jpa.hibernate.ddlauto (enum) is a Hibernate feature that controls the behavior in a more ne-grained way. See below for
more detail.
77.2Initialize a database using Hibernate

You can set spring.jpa.hibernate.ddlauto explicitly and the standard Hibernate property values are none , validate , update ,
create , createdrop . Spring Boot chooses a default value for you based on whether it thinks your database is embedded (default
createdrop ) or not (default none ). An embedded database is detected by looking at the Connection type: hsqldb , h2 and derby are
embedded, the rest are not. Be careful when switching from in-memory to a real database that you dont make assumptions about the
existence of the tables and data in the new platform. You either have to set ddlauto 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 is done for you automatically if you enable
the debug mode.
In addition, a le named import.sql in the root of the classpath will be executed on startup if Hibernate creates the schema from scratch (that
is if the ddlauto property is set to create or createdrop ). This can be useful for demos and for testing if you are careful, but probably
not something you want to be on the classpath in production. It is a Hibernate feature (nothing to do with Spring).
77.3Initialize a database using Spring JDBC

Spring JDBC has a DataSource initializer feature. Spring Boot enables it by default and loads SQL from the standard locations schema.sql
and data.sql (in the root of the classpath). In addition Spring Boot will load the schema${platform}.sql and data${platform}.sql
les (if present), where platform is the value of spring.datasource.platform , e.g. you might choose to set it to the vendor name of the
database ( hsqldb , h2 , oracle , mysql , postgresql etc.). Spring Boot enables the fail-fast feature of the Spring JDBC initializer by
default, so if the scripts cause exceptions the application will fail to start. The script locations can be changed by setting
spring.datasource.schema and spring.datasource.data , and neither location will be processed if
spring.datasource.initialize=false .
To disable the fail-fast you can set spring.datasource.continueonerror=true . This can be useful once an application has matured and
been deployed a few times, since the scripts can act as poor mans migrationsinserts that fail mean that the data is already there, so there
would be no need to prevent the application from running, for instance.
If you want to use the schema.sql initialization in a JPA app (with Hibernate) then ddlauto=createdrop will lead to errors if Hibernate
tries to create the same tables. To avoid those errors set ddlauto explicitly to "" (preferable) or "none". Whether or not you use
ddlauto=createdrop you can always use data.sql to initialize new data.
77.4Initialize a Spring Batch database

If you are using Spring Batch then it comes pre-packaged with SQL initialization scripts for most popular database platforms. Spring Boot will
detect your database type, and execute those scripts by default, and in this case will switch the fail fast setting to false (errors are logged but do
not prevent the application from starting). This is because the scripts are known to be reliable and generally do not contain bugs, so errors are
ignorable, and ignoring them makes the scripts idempotent. You can switch off the initialization explicitly using
spring.batch.initializer.enabled=false .
77.5Use a higher-level database migration tool

Spring Boot supports two higher-level migration tools: Flyway and Liquibase.
77.5.1Execute Flyway database migrations on startup

To automatically run Flyway database migrations on startup, add the org.flywaydb:flywaycore to your classpath.
The migrations are scripts in the form V<VERSION>__<NAME>.sql (with <VERSION> an underscore-separated version, e.g. 1 or 2_1). By
default they live in a folder classpath:db/migration but you can modify that using flyway.locations . You can also add a special
{vendor} placeholder to use vendor-specic scripts. Assume the following:
flyway.locations=db/migration/{vendor}
Rather than using db/migration , this conguration will set the folder to use according to the type of the database (i.e. db/migration/mysql
for MySQL). The list of supported database are available in DatabaseDriver .
See also the Flyway class from yway-core for details of available settings like schemas etc. In addition Spring Boot provides a small set of
properties in FlywayProperties that can be used to disable the migrations, or switch off the location checking. Spring Boot will call
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 folder. To
use Java-based callbacks, create one or more beans that implement FlywayCallback or, preferably, extend BaseFlywayCallback . Any
such beans will be automatically registered with Flyway . They can be ordered using @Order or by implementing Ordered .
By default Flyway will autowire the ( @Primary ) DataSource in your context and use that for migrations. If you like to use a different
DataSource you can create one and mark its @Bean as @FlywayDataSource - if you do that remember to create another one and mark it as
@Primary if you want two data sources. Or you can use Flyways native DataSource by setting flyway.[url,user,password] in external
properties.
There is a Flyway sample so you can see how to set things up.
You can also use Flyway to provide data for specic scenarios. For example, you can place test-specic migrations in src/test/resources
and they will only be run when your application starts for testing. If you want to be more sophisticated you can use prole-specic conguration
to customize flyway.locations so that certain migrations will only run when a particular prole is active. For example, in
applicationdev.properties you could set flyway.locations to classpath:/db/migration,classpath:/dev/db/migration and
migrations in dev/db/migration will only run when the dev prole is active.
77.5.2Execute Liquibase database migrations on startup

To automatically run Liquibase database migrations on startup, add the org.liquibase:liquibasecore to your classpath.
The master change log is by default read from db/changelog/db.changelogmaster.yaml but can be set using liquibase.changelog .
In addition to YAML, Liquibase also supports JSON, XML, and SQL change log formats.
By default Liquibase will autowire the ( @Primary ) DataSource in your context and use that for migrations. If you like to use a different
DataSource you can create one and mark its @Bean as @LiquibaseDataSource - if you do that remember to create another one and mark it
as @Primary if you want two data sources. Or you can use Liquibases native DataSource by setting liquibase.[url,user,password] in
external properties.
See LiquibaseProperties for details of available settings like contexts, default schema etc.
There is a Liquibase sample so you can see how to set things up.
78.Messaging
78.1Disable transacted JMS session

If your JMS broker does not support transacted session, you will have to disable the support of transactions altogether. If you create your own
JmsListenerContainerFactory there is nothing to do since it wont be transacted by default. If you want to use the
DefaultJmsListenerContainerFactoryConfigurer to reuse Spring Boots default, you can disable transacted session as follows:
@Bean
publicDefaultJmsListenerContainerFactoryjmsListenerContainerFactory(
ConnectionFactoryconnectionFactory,
DefaultJmsListenerContainerFactoryConfigurerconfigurer){
DefaultJmsListenerContainerFactorylistenerFactory=
newDefaultJmsListenerContainerFactory();
configurer.configure(listenerFactory,connectionFactory);
listenerFactory.setTransactionManager(null);
listenerFactory.setSessionTransacted(false);
returnlistenerFactory;
}
This overrides the default factory and this should be applied to any other factory that your application denes, if any.
79.Batch applications
By default, batch applications require a DataSource to store job details. If you want to deviate from that, youll need to implement
BatchConfigurer , see The Javadoc of @EnableBatchProcessing for more details.
79.1Execute Spring Batch jobs on startup

Spring Batch auto-conguration is enabled by adding @EnableBatchProcessing (from Spring Batch) somewhere in your context.
By default it executes all Jobs in the application context on startup (see JobLauncherCommandLineRunner for details). You can narrow down
to a specic job or jobs by specifying spring.batch.job.names (comma-separated job name patterns).
If the application context includes a JobRegistry then the jobs in spring.batch.job.names are looked up in the registry instead of being
autowired from the context. This is a common pattern with more complex systems where multiple jobs are dened in child contexts and
registered centrally.
See BatchAutoConguration and @EnableBatchProcessing for more details.
80.Actuator
80.1Change 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.port . To listen on a completely different network address (e.g. if you have an internal network for
management and an external one for user applications) you can also set management.address to a valid IP address that the server is able to
bind to.
For more detail look at the ManagementServerProperties source code and Section48.3, Customizing the management server port in the
Production-ready features section.
80.2Customize the whitelabel error page

Spring Boot installs a whitelabel error page that you will see in browser client if you encounter a server error (machine clients consuming JSON
and other media types should see a sensible response with the right error code).
Set server.error.whitelabel.enabled=false to switch the default error page off which will restore the default of the servlet
container that you are using. Note that Spring Boot will still attempt to resolve the error view so youd probably add you own error
page rather than disabling it completely.
Overriding the error page with your own depends on the templating technology that you are using. For example, if you are using Thymeleaf you
would add an error.html template and if you are using FreeMarker you would add an error.ftl template. In general what you need is a
View that resolves with a name of error , and/or a @Controller that handles the /error path. Unless you replaced some of the default
conguration you should nd a BeanNameViewResolver in your ApplicationContext so a @Bean with id error would be a simple way of
doing that. Look at ErrorMvcAutoConfiguration for more options.
See also the section on Error Handling for details of how to register handlers in the servlet container.
80.3Actuator and Jersey

Actuator HTTP endpoints are only available for Spring MVC-based applications. If you want to use Jersey and still use the actuator you will
need to enable Spring MVC (by depending on springbootstarterweb , for example). By default, both Jersey and the Spring MVC
dispatcher servlet are mapped to the same path ( / ). You will need to change the path for one of them (by conguring server.servlet.path
for Spring MVC or spring.jersey.applicationpath for Jersey). For example, if you add server.servlet.path=/system into
application.properties , the actuator HTTP endpoints will be available under /system .
81.Security
81.1Switch off the Spring Boot security conguration

If you dene a @Configuration with @EnableWebSecurity anywhere in your application it will switch off the default webapp security settings
in Spring Boot (but leave the Actuators security enabled). To tweak the defaults try setting properties in security.* (see
SecurityProperties for details of available settings) and SECURITY section of Common application properties.
81.2Change the AuthenticationManager and add user accounts

If you provide a @Bean of type AuthenticationManager the default one will not be created, so you have the full feature set of Spring Security
available (e.g. various authentication options).
Spring Security also provides a convenient AuthenticationManagerBuilder which can be used to build an AuthenticationManager with
common options. The recommended way to use this in a webapp is to inject it into a void method in a WebSecurityConfigurerAdapter , e.g.
@Configuration
publicclassSecurityConfigurationextendsWebSecurityConfigurerAdapter{
@Autowired
publicvoidconfigureGlobal(AuthenticationManagerBuilderauth)throwsException{
auth.inMemoryAuthentication()
.withUser("barry").password("password").roles("USER");//...etc.
}
//...otherstuffforapplicationsecurity
You will get the best results if you put this in a nested class, or a standalone class (i.e. not mixed in with a lot of other @Beans that might be
allowed to inuence the order of instantiation). The secure web sample is a useful template to follow.
If you experience instantiation issues (e.g. using JDBC or JPA for the user detail store) it might be worth extracting the
AuthenticationManagerBuilder callback into a GlobalAuthenticationConfigurerAdapter (in the init() method so it happens
before the authentication manager is needed elsewhere), e.g.
@Configuration
publicclassAuthenticationManagerConfigurationextends
GlobalAuthenticationConfigurerAdapter{
@Override
publicvoidinit(AuthenticationManagerBuilderauth){
auth.inMemoryAuthentication()//...etc.
}
81.3Enable 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 are using Tomcat as a
servlet container, then Spring Boot will add Tomcats 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 ( xforwardedfor and
xforwardedproto ), 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 , e.g.
server.tomcat.remote_ip_header=xforwardedfor
server.tomcat.protocol_header=xforwardedproto
(The presence of either of those properties will switch on the valve. Or you can add the RemoteIpValve yourself by adding a
TomcatEmbeddedServletContainerFactory bean.)
Spring Security can also be congured to require a secure channel for all (or some requests). To switch that on in a Spring Boot application you
just need to set security.require_ssl to true in application.properties .
82.Hot swapping
82.1Reload static content

There are several options for hot reloading. The recommended approach is to use springbootdevtools as it provides additional
development-time features such as support for fast application restarts and LiveReload as well as sensible development-time conguration (e.g.
template caching). Devtools works by monitoring the classpath for changes. This means that static resource changes must be "built" for the
change to take affect. By default, this happens automatically in Eclipse when you save your changes. In IntelliJ IDEA, Make Project will trigger
the necessary build. Due to the default restart exclusions, changes to static resources will not trigger a restart of your application. They will,
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 hot-swapping of Java class changes).
Finally, the Maven and Gradle plugins can be congured (see the addResources property) to support running from the command line with
reloading of static les directly from source. You can use that with an external css/js compiler process if you are writing that code with higher
level tools.
82.2Reload templates without restarting the container

Most of the templating technologies supported by Spring Boot include a conguration option to disable caching (see below for details). If youre
using the springbootdevtools module these properties will be automatically congured for you at development time.
82.2.1Thymeleaf templates
If you are using Thymeleaf, then set spring.thymeleaf.cache to false . See ThymeleafAutoConfiguration for other Thymeleaf
customization options.
82.2.2FreeMarker templates
If you are using FreeMarker, then set spring.freemarker.cache to false . See FreeMarkerAutoConfiguration for other FreeMarker
customization options.
82.2.3Groovy templates
If you are using Groovy templates, then set spring.groovy.template.cache to false . See GroovyTemplateAutoConfiguration for
other Groovy customization options.
82.3Fast application restarts

The springbootdevtools module includes support for automatic application restarts. Whilst not as fast a technologies such as JRebel or
Spring Loaded its usually signicantly faster than a cold start. You should probably give it a try before investigating some of the more complex
reload options discussed below.
For more details see the Chapter20, Developer tools section.
82.4Reload Java classes without restarting the container

Modern IDEs (Eclipse, IDEA, etc.) all support hot swapping of bytecode, so if you make a change that doesnt affect class or method signatures
it should reload cleanly with no side effects.
Spring Loaded goes a little further in that it can reload class denitions with changes in the method signatures. With some customization it can
force an ApplicationContext to refresh itself (but there is no general mechanism to ensure that would be safe for a running application
anyway, so it would only ever be a development time trick probably).
82.4.1Conguring Spring Loaded for use with Maven

To use Spring Loaded with the Maven command line, just add it as a dependency in the Spring Boot plugin declaration, e.g.
<plugin>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>springloaded</artifactId>
<version>1.2.6.RELEASE</version>
</dependency>
</dependencies>
</plugin>
This normally works pretty well with Eclipse and IntelliJ IDEA as long as they have their build conguration aligned with the Maven defaults
(Eclipse m2e does this out of the box).
82.4.2Conguring Spring Loaded for use with Gradle and IntelliJ IDEA
You need to jump through a few hoops if you want to use Spring Loaded in combination with Gradle and IntelliJ IDEA. By default, IntelliJ IDEA
will compile classes into a different location than Gradle, causing Spring Loaded monitoring to fail.
To congure IntelliJ IDEA correctly you can use the idea Gradle plugin:
buildscript{
repositories{jcenter()}
dependencies{
classpath"org.springframework.boot:springbootgradleplugin:2.0.0.BUILDSNAPSHOT"
classpath'org.springframework:springloaded:1.2.6.RELEASE'
}
}
applyplugin:'idea'
idea{
module{
inheritOutputDirs=false
outputDir=file("$buildDir/classes/main/")
}
}
//...
IntelliJ IDEA must be congured to use the same Java version as the command line Gradle task and springloaded must be
included as a buildscript dependency.
You can also additionally enable Make Project Automatically inside IntelliJ IDEA to automatically compile your code whenever a le is saved.
83.Build
83.1Generate build information

Both the Maven and Gradle plugin allow to generate build information containing the coordinates, name and version of the project. The plugin
can also be congured to add additional properties through conguration. When such le is present, Spring Boot auto-congures a
BuildProperties bean.
To generate build information with Maven, add an execution for the buildinfo goal:
<build>
<plugins>
<plugin>
<executions>
<execution>
<goals>
<goal>buildinfo</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
Check the Spring Boot Maven Plugin documentation for more details.
And to do the same with Gradle:
springBoot{
buildInfo()
}
Additional properties can be added using the DSL:
springBoot{
buildInfo{
additionalProperties=[
'foo':'bar'
]
}
}
83.2Generate git information

Both Maven and Gradle allow to generate a git.properties le containing information about the state of your git source code repository
when the project was built.
For Maven users the springbootstarterparent POM includes a pre-congured plugin to generate a git.properties le. Simply add
the following declaration to your POM:
<build>
<plugins>
<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>gitcommitidplugin</artifactId>
</plugin>
</plugins>
</build>
Gradle users can achieve the same result using the gradlegitproperties plugin
plugins{
id"com.gorylenko.gradlegitproperties"version"1.4.17"
}
83.3Customize dependency versions

If you use a Maven build that inherits directly or indirectly from springbootdependencies (for instance springbootstarterparent )
but you want to override a specic third-party dependency you can add appropriate <properties> elements. Browse the
springbootdependencies POM for a complete list of properties. For example, to pick a different slf4j version you would add the
following:
<properties>
<slf4j.version>1.7.5<slf4j.version>
</properties>
This only works if your Maven project inherits (directly or indirectly) from springbootdependencies . If you have added
springbootdependencies in your own dependencyManagement section with <scope>import</scope> you have to
redene the artifact yourself instead of overriding the property.
Each Spring Boot release is designed and tested against a specic set of third-party dependencies. Overriding versions may
cause compatibility issues.
To override dependency versions in Gradle, you can specify a version as shown below:
ext['slf4j.version']='1.7.5'
For additional information, please refer to the Gradle Dependency Management Plugin documentation.
83.4Create an executable JAR with Maven

The springbootmavenplugin can be used to create an executable fat JAR. If you are using the springbootstarterparent POM
you can simply declare the plugin and your jars will be repackaged:
<build>
<plugins>
<plugin>
</plugin>
</plugins>
</build>
If you are not using the parent POM you can still use the plugin, however, you must additionally add an <executions> section:
<build>
<plugins>
<plugin>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
See the plugin documentation for full usage details.
83.5Use a Spring Boot application as a dependency

Like a war le, 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 Boots Maven and Gradle plugins must be congured 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 BOOTINF/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 classier must be specied. This classier is
applied to the name of the executable archive, leaving the default archive for use as dependency.
To congure a classier of exec in Maven, the following conguration can be used:
<build>
<plugins>
<plugin>
<configuration>
<classifier>exec</classifier>
</configuration>
</plugin>
</plugins>
</build>
And when using Gradle, the following conguration can be used:
bootRepackage{
classifier='exec'
}
83.6Extract specic 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 jrubycomplete.jar is always directly available as a le in its
own right.
To deal with any problematic libraries, you can ag that specic nested jars should be automatically unpacked to the temp folder when the
executable jar rst runs.
For example, to indicate that JRuby should be agged for unpack using the Maven Plugin you would add the following conguration:
<build>
<plugins>
<plugin>
<configuration>
<requiresUnpack>
<dependency>
<groupId>org.jruby</groupId>
<artifactId>jrubycomplete</artifactId>
</dependency>
</requiresUnpack>
</configuration>
</plugin>
</plugins>
</build>
And to do that same with Gradle:
springBoot{
requiresUnpack=['org.jruby:jrubycomplete']
}
83.7Create a non-executable JAR with exclusions

Often if you have an executable and a non-executable jar as build products, the executable version will have additional conguration les that
are not needed in a library jar. E.g. the application.yml conguration le might excluded from the non-executable JAR.
The mavenjarplugin used to expose a forceCreation attribute that allows you to create the jar again once the repackage goal has
ran. Arguably, this was a bit fragile anyway since it was relying on the order of plugin executions. In Maven, the executable jar must be the main
artifact and you can add a classied jar for the library:
<build>
<plugins>
<plugin>
</plugin>
<plugin>
<artifactId>mavenjarplugin</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>
In Gradle you can create a new JAR archive with standard task DSL features, and then have the bootRepackage task depend on that one
using its withJarTask property:
jar{
baseName='springbootsampleprofile'
version='0.0.0'
excludes=['**/application.yml']
}
task('execJar',type:Jar,dependsOn:'jar'){
baseName='springbootsampleprofile'
version='0.0.0'
classifier='exec'
fromsourceSets.main.output
}
bootRepackage{
withJarTask=tasks['execJar']
}
83.8Remote debug a Spring Boot application started with Maven

To attach a remote debugger to a Spring Boot application started with Maven you can use the jvmArguments property of the maven plugin.
Check this example for more details.
83.9Remote debug a Spring Boot application started with Gradle

To attach a remote debugger to a Spring Boot application started with Gradle you can use the jvmArgs property of bootRun task or
debugjvm command line option.
build.gradle :
bootRun{
jvmArgs"agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005"
}
Command line:
$gradlebootRundebugjvm
Check Gradle Application Plugin for more details.
83.10Build 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
springbootantlib module, or you can follow these instructions:
1. If you are building a jar, package the applications classes and resources in a nested BOOTINF/classes directory. If you are building a
war, package the applications classes in a nested WEBINF/classes directory as usual.
2. Add the runtime dependencies in a nested BOOTINF/lib directory for a jar or WEBINF/lib for a war. Remember not to compress the
entries in the archive.
3. Add the provided (embedded container) dependencies in a nested BOOTINF/lib directory for jar or WEBINF/libprovided for a
war. Remember not to compress the entries in the archive.
4. Add the springbootloader classes at the root of the archive (so the MainClass is available).
5. Use the appropriate launcher, e.g. JarLauncher for a jar le, as a MainClass attribute in the manifest and specify the other properties it
needs as manifest entries, principally a StartClass .
Example:
<targetname="build"depends="compile">
<jardestfile="target/${ant.project.name}${springboot.version}.jar"compress="false">
<mappedresources>
<filesetdir="target/classes"/>
<globmapperfrom="*"to="BOOTINF/classes/*"/>
</mappedresources>
<mappedresources>
<filesetdir="src/main/resources"erroronmissingdir="false"/>
<globmapperfrom="*"to="BOOTINF/classes/*"/>
</mappedresources>
<mappedresources>
<filesetdir="${lib.dir}/runtime"/>
<globmapperfrom="*"to="BOOTINF/lib/*"/>
</mappedresources>
<zipfilesetsrc="${lib.dir}/loader/springbootloaderjar${springboot.version}.jar"/>
<manifest>
<attributename="MainClass"value="org.springframework.boot.loader.JarLauncher"/>
<attributename="StartClass"value="${startclass}"/>
</manifest>
</jar>
</target>
The Ant Sample has a build.xml with a manual task that should work if you run it with
$antlib<foldercontainingivy2.2.jar>cleanmanual
after which you can run the application with
$javajartarget/*.jar
84.Traditional deployment
84.1Create a deployable war le

The rst step in producing a deployable war le is to provide a SpringBootServletInitializer subclass and override its configure
method. This makes use of Spring Frameworks Servlet 3.0 support and allows you to congure your application when its launched by the
servlet container. Typically, you update your applications main class to extend SpringBootServletInitializer :
@SpringBootApplication
publicclassApplicationextendsSpringBootServletInitializer{
@Override
protectedSpringApplicationBuilderconfigure(SpringApplicationBuilderapplication){
returnapplication.sources(Application.class);
}
publicstaticvoidmain(String[]args)throwsException{
}
The next step is to update your build conguration so that your project produces a war le rather than a jar le. If youre using Maven and using
springbootstarterparent (which congures Mavens war plugin for you) all you need to do is to modify pom.xml to change the
packaging to war:
<packaging>war</packaging>
If youre using Gradle, you need to modify build.gradle to apply the war plugin to the project:
applyplugin:'war'
The nal step in the process is to ensure that the embedded servlet container doesnt interfere with the servlet container to which the war le
will be deployed. To do so, you need to mark the embedded servlet container dependency as provided.
If youre using Maven:
<dependencies>
<!>
<dependency>
<scope>provided</scope>
</dependency>
<!>
</dependencies>
And if youre using Gradle:
dependencies{
//
providedRuntime'org.springframework.boot:springbootstartertomcat'
//
}
If you are using a version of Gradle that supports compile only dependencies (2.12 or later), you should continue to use
providedRuntime . Among other limitations, compileOnly dependencies are not on the test classpath so any web-based
integration tests will fail.
If youre using the Spring Boot build tools, marking the embedded servlet container dependency as provided will produce an executable war le
with the provided dependencies packaged in a libprovided directory. This means that, in addition to being deployable to a servlet container,
you can also run your application using javajar on the command line.
Take a look at Spring Boots sample applications for a Maven-based example of the above-described conguration.
84.2Create a deployable war le for older servlet containers

Older Servlet containers dont have support for the ServletContextInitializer bootstrap process used in Servlet 3.0. You can still use
Spring and Spring Boot in these containers but you are going to need to add a web.xml to your application and congure it to load an
ApplicationContext via a DispatcherServlet .
84.3Convert an existing application to Spring Boot

For a non-web application it should be easy (throw away the code that creates your ApplicationContext and replace it with calls to
SpringApplication or SpringApplicationBuilder ). Spring MVC web applications are generally amenable to rst creating a deployable
war application, and then migrating it later to an executable war and/or jar. Useful reading is in the Getting Started Guide on Converting a jar to
a war.
Create a deployable war by extending SpringBootServletInitializer (e.g. in a class called Application ), and add the Spring Boot
@SpringBootApplication annotation. Example:
@Override
protectedSpringApplicationBuilderconfigure(SpringApplicationBuilderapplication){
//Customizetheapplicationorcallapplication.sources(...)toaddsources
//Sinceourexampleisitselfa@Configurationclass(via@SpringBootApplication)
//weactuallydon'tneedtooverridethismethod.
returnapplication;
}
Remember that whatever you put in the sources is just a Spring ApplicationContext and 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 rst.
Static resources can be moved to /public (or /static or /resources or /METAINF/resources ) in the classpath root. Same for
messages.properties (Spring Boot detects this automatically 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, using other servlets or lters for instance, then you may need to add some conguration to your Application context, 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 was a <servlet/> and
<servletmapping/> in web.xml .
A @Bean of type Filter or FilterRegistrationBean behaves similarly (like a <filter/> and <filtermapping/> .
An ApplicationContext in an XML le can be added to an @Import in your Application . Or simple cases where annotation
conguration is heavily used already can be recreated in a few lines as @Bean denitions.
Once the war is working we make it executable by adding a main method to our Application , e.g.
}
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 the main method, something like:
@Override
protectedSpringApplicationBuilderconfigure(SpringApplicationBuilderbuilder){
returnconfigureApplication(builder);
}
configureApplication(newSpringApplicationBuilder()).run(args);
}
privatestaticSpringApplicationBuilderconfigureApplication(SpringApplicationBuilderbuilder){
returnbuilder.sources(Application.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 tricks.
Servlet 3.0+ applications might translate pretty easily if they already use the Spring Servlet 3.0+ 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 (e.g. if it uses AbstractDispatcherServletInitializer ) then you might be able to squash all your
context sources into a single SpringApplication . The main complication you might encounter is if that doesnt 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-specic
features will usually need 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 a Spring Boot application, and the guidance above might help, but
your mileage may vary.
84.4Deploying 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 would be something like this:
importorg.springframework.boot.autoconfigure.SpringBootApplication;
importorg.springframework.boot.context.web.SpringBootServletInitializer;
importorg.springframework.web.WebApplicationInitializer;
publicclassMyApplicationextendsSpringBootServletInitializerimplementsWebApplicationInitializer{
If you use logback, you will also need to tell WebLogic to prefer the packaged version rather than the version that pre-installed with the server.
You can do this by adding a WEBINF/weblogic.xml le with the following contents:
<wls:weblogicwebapp
xmlns:wls="http://xmlns.oracle.com/weblogic/weblogicwebapp"
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/ejbjar_3_0.xsd
http://xmlns.oracle.com/weblogic/weblogicwebapp
http://xmlns.oracle.com/weblogic/weblogicwebapp/1.4/weblogicwebapp.xsd">
<wls:containerdescriptor>
<wls:preferapplicationpackages>
<wls:packagename>org.slf4j</wls:packagename>
</wls:preferapplicationpackages>
</wls:containerdescriptor>
</wls:weblogicwebapp>
84.5Deploying a WAR in an Old (Servlet 2.5) Container

Spring Boot uses Servlet 3.0 APIs to initialize the ServletContext (register Servlets etc.) so you cant use the same application out of the
box in a Servlet 2.5 container. It is however possible to run a Spring Boot application on an older container with some special tools. If you
include org.springframework.boot:springbootlegacy as a dependency (maintained separately to the core of Spring Boot and currently
available at 1.0.2.RELEASE), all you should need to do is create a web.xml and declare a context listener to create the application context
and your lters and servlets. The context listener is a special purpose one for Spring Boot, but the rest of it is normal for a Spring application in
Servlet 2.5. Example:
<webappversion="2.5"xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaeehttp://java.sun.com/xml/ns/javaee/webapp_2_5.xsd">
<contextparam>
<paramname>contextConfigLocation</paramname>
<paramvalue>demo.Application</paramvalue>
</contextparam>
<listener>
<listenerclass>org.springframework.boot.legacy.context.web.SpringBootContextLoaderListener</listenerclass>
</listener>
<filter>
<filtername>metricsFilter</filtername>
<filterclass>org.springframework.web.filter.DelegatingFilterProxy</filterclass>
</filter>
<filtermapping>
<filtername>metricsFilter</filtername>
<urlpattern>/*</urlpattern>
</filtermapping>
<servlet>
<servletname>appServlet</servletname>
<servletclass>org.springframework.web.servlet.DispatcherServlet</servletclass>
<initparam>
<paramname>contextAttribute</paramname>
<paramvalue>org.springframework.web.context.WebApplicationContext.ROOT</paramvalue>
</initparam>
<loadonstartup>1</loadonstartup>
</servlet>
<servletmapping>
<servletname>appServlet</servletname>
<urlpattern>/</urlpattern>
</servletmapping>
</webapp>
In this example we are using a single application context (the one created by the context listener) and attaching it to the DispatcherServlet
using an init parameter. This is normal in a Spring Boot application (you normally only have one application context).
PartX.Appendices
AppendixA.Common application properties

Various properties can be specied inside your application.properties / application.yml le or as command line switches. This section
provides a list of common Spring Boot properties and references to the underlying classes that consume them.
Property contributions can come from additional jar les on your classpath so you should not consider this an exhaustive list. It is
also perfectly legit to dene your own properties.
This sample le is meant as a guide only. Do not copy/paste the entire content into your application; rather pick only the
properties that you need.
#===================================================================
#COMMONSPRINGBOOTPROPERTIES
#
#Thissamplefileisprovidedasaguideline.DoNOTcopyitinits
#entiretytoyourownapplication.^^^
#===================================================================
#
#COREPROPERTIES
#
#BANNER
banner.charset=UTF8#Bannerfileencoding.
banner.location=classpath:banner.txt#Bannerfilelocation.
banner.image.location=classpath:banner.gif#Bannerimagefilelocation(jpg/pngcanalsobeused).
banner.image.width=#Widthofthebannerimageinchars(default76)
banner.image.height=#Heightofthebannerimageinchars(defaultbasedonimageheight)
banner.image.margin=#Lefthandimagemargininchars(default2)
banner.image.invert=#Ifimagesshouldbeinvertedfordarkterminalthemes(defaultfalse)
#LOGGING
logging.config=#Locationoftheloggingconfigurationfile.Forinstance`classpath:logback.xml`forLogback
logging.exceptionconversionword=%wEx#Conversionwordusedwhenloggingexceptions.
logging.file=#Logfilename.Forinstance`myapp.log`
logging.level.*=#Loglevelsseveritymapping.Forinstance`logging.level.org.springframework=DEBUG`
logging.path=#Locationofthelogfile.Forinstance`/var/log`
logging.pattern.console=#Appenderpatternforoutputtotheconsole.Onlysupportedwiththedefaultlogbacksetup.
logging.pattern.file=#Appenderpatternforoutputtothefile.Onlysupportedwiththedefaultlogbacksetup.
logging.pattern.level=#Appenderpatternforloglevel(default%5p).Onlysupportedwiththedefaultlogbacksetup.
logging.registershutdownhook=false#Registerashutdownhookfortheloggingsystemwhenitisinitialized.
#AOP
spring.aop.auto=true#Add@EnableAspectJAutoProxy.
spring.aop.proxytargetclass=false#Whethersubclassbased(CGLIB)proxiesaretobecreated(true)asopposedtostandardJavaint
#IDENTITY(ContextIdApplicationContextInitializer)
spring.application.index=#Applicationindex.
spring.application.name=#Applicationname.
#ADMIN(SpringApplicationAdminJmxAutoConfiguration)
spring.application.admin.enabled=false#Enableadminfeaturesfortheapplication.
spring.application.admin.jmxname=org.springframework.boot:type=Admin,name=SpringApplication#JMXnameoftheapplicationadminMBea
#AUTOCONFIGURATION
spring.autoconfigure.exclude=#Autoconfigurationclassestoexclude.
#SPRINGCORE
spring.beaninfo.ignore=true#SkipsearchofBeanInfoclasses.
#SPRINGCACHE(CacheProperties)
spring.cache.cachenames=#Commaseparatedlistofcachenamestocreateifsupportedbytheunderlyingcachemanager.
spring.cache.caffeine.spec=#Thespectousetocreatecaches.CheckCaffeineSpecformoredetailsonthespecformat.
spring.cache.couchbase.expiration=0#Entryexpirationinmilliseconds.Bydefaulttheentriesneverexpire.
spring.cache.ehcache.config=#ThelocationoftheconfigurationfiletousetoinitializeEhCache.
spring.cache.hazelcast.config=#ThelocationoftheconfigurationfiletousetoinitializeHazelcast.
spring.cache.infinispan.config=#ThelocationoftheconfigurationfiletousetoinitializeInfinispan.
spring.cache.jcache.config=#Thelocationoftheconfigurationfiletousetoinitializethecachemanager.
spring.cache.jcache.provider=#FullyqualifiednameoftheCachingProviderimplementationtousetoretrievetheJSR107compliantc
spring.cache.type=#Cachetype,autodetectedaccordingtotheenvironmentbydefault.
#SPRINGCONFIGusingenvironmentpropertyonly(ConfigFileApplicationListener)
spring.config.location=#Configfilelocations.
spring.config.name=application#Configfilename.
#HAZELCAST(HazelcastProperties)
spring.hazelcast.config=#ThelocationoftheconfigurationfiletousetoinitializeHazelcast.
#PROJECTINFORMATION(ProjectInfoProperties)
spring.info.build.location=classpath:METAINF/buildinfo.properties#Locationofthegeneratedbuildinfo.propertiesfile.
spring.info.git.location=classpath:git.properties#Locationofthegeneratedgit.propertiesfile.
#JMX
spring.jmx.defaultdomain=#JMXdomainname.
spring.jmx.enabled=true#ExposemanagementbeanstotheJMXdomain.
spring.jmx.server=mbeanServer#MBeanServerbeanname.
#Email(MailProperties)
spring.mail.defaultencoding=UTF8#DefaultMimeMessageencoding.
spring.mail.host=#SMTPserverhost.Forinstance`smtp.example.com`
spring.mail.jndiname=#SessionJNDIname.Whenset,takesprecedencetoothersmailsettings.
spring.mail.password=#LoginpasswordoftheSMTPserver.
spring.mail.port=#SMTPserverport.
spring.mail.properties.*=#AdditionalJavaMailsessionproperties.
spring.mail.protocol=smtp#ProtocolusedbytheSMTPserver.
spring.mail.testconnection=false#Testthatthemailserverisavailableonstartup.
spring.mail.username=#LoginuseroftheSMTPserver.
#APPLICATIONSETTINGS(SpringApplication)
spring.main.bannermode=console#Modeusedtodisplaythebannerwhentheapplicationruns.
spring.main.sources=#Sources(classname,packagenameorXMLresourcelocation)toincludeintheApplicationContext.
spring.main.webenvironment=#Runtheapplicationinawebenvironment(autodetectedbydefault).
#FILEENCODING(FileEncodingApplicationListener)
spring.mandatoryfileencoding=#Expectedcharacterencodingtheapplicationmustuse.
#INTERNATIONALIZATION(MessageSourceAutoConfiguration)
spring.messages.alwaysusemessageformat=false#SetwhethertoalwaysapplytheMessageFormatrules,parsingevenmessageswithout
spring.messages.basename=messages#Commaseparatedlistofbasenames,eachfollowingtheResourceBundleconvention.
spring.messages.cacheseconds=1#Loadedresourcebundlefilescacheexpiration,inseconds.Whensetto1,bundlesarecachedfore
spring.messages.encoding=UTF8#Messagebundlesencoding.
spring.messages.fallbacktosystemlocale=true#SetwhethertofallbacktothesystemLocaleifnofilesforaspecificLocalehave
#REACTOR
spring.reactor.stacktracemode.enabled=true#SetwhetherReactorshouldcollectstacktraceinformationatruntime.
#OUTPUT
spring.output.ansi.enabled=detect#ConfiguretheANSIoutput.
#PIDFILE(ApplicationPidFileWriter)
spring.pid.failonwriteerror=#FailifApplicationPidFileWriterisusedbutitcannotwritethePIDfile.
spring.pid.file=#LocationofthePIDfiletowrite(ifApplicationPidFileWriterisused).
#PROFILES
spring.profiles.active=#Commaseparatedlist(orlistifusingYAML)ofactiveprofiles.
spring.profiles.include=#Unconditionallyactivatethespecifiedcommaseparatedprofiles(orlistofprofilesifusingYAML).
#SENDGRID(SendGridAutoConfiguration)
spring.sendgrid.apikey=#SendGridapikey(alternativetousername/password)
spring.sendgrid.username=#SendGridaccountusername
spring.sendgrid.password=#SendGridaccountpassword
spring.sendgrid.proxy.host=#SendGridproxyhost
spring.sendgrid.proxy.port=#SendGridproxyport
#
#WEBPROPERTIES
#
#EMBEDDEDSERVERCONFIGURATION(ServerProperties)
server.address=#Networkaddresstowhichtheservershouldbindto.
server.compression.enabled=false#Ifresponsecompressionisenabled.
server.compression.excludeduseragents=#Listofuseragentstoexcludefromcompression.
server.compression.mimetypes=#CommaseparatedlistofMIMEtypesthatshouldbecompressed.Forinstance`text/html,text/css,appli
server.compression.minresponsesize=#Minimumresponsesizethatisrequiredforcompressiontobeperformed.Forinstance2048
server.connectiontimeout=#TimeinmillisecondsthatconnectorswillwaitforanotherHTTPrequestbeforeclosingtheconnection.W
server.displayname=application#Displaynameoftheapplication.
server.maxhttpheadersize=0#MaximumsizeinbytesoftheHTTPmessageheader.
server.error.includestacktrace=never#Whentoincludea"stacktrace"attribute.
server.error.path=/error#Pathoftheerrorcontroller.
server.error.whitelabel.enabled=true#Enablethedefaulterrorpagedisplayedinbrowsersincaseofaservererror.
server.jetty.acceptors=#Numberofacceptorthreadstouse.
server.jetty.maxhttppostsize=0#MaximumsizeinbytesoftheHTTPpostorputcontent.
server.jetty.selectors=#Numberofselectorthreadstouse.
server.port=8080#ServerHTTPport.
server.serverheader=#ValuetousefortheServerresponseheader(noheaderissentifempty)
server.servlet.contextparameters.*=#Servletcontextinitparameters.Forinstance`server.servlet.contextparameters.a=alpha`
server.servlet.contextpath=#Contextpathoftheapplication.
server.servlet.jsp.classname=org.apache.jasper.servlet.JspServlet#TheclassnameoftheJSPservlet.
server.servlet.jsp.initparameters.*=#InitparametersusedtoconfiguretheJSPservlet
server.servlet.jsp.registered=true#WhetherornottheJSPservletisregistered
server.servlet.path=/#Pathofthemaindispatcherservlet.
server.useforwardheaders=#IfXForwarded*headersshouldbeappliedtotheHttpRequest.
server.session.cookie.comment=#Commentforthesessioncookie.
server.session.cookie.domain=#Domainforthesessioncookie.
server.session.cookie.httponly=#"HttpOnly"flagforthesessioncookie.
server.session.cookie.maxage=#Maximumageofthesessioncookieinseconds.
server.session.cookie.name=#Sessioncookiename.
server.session.cookie.path=#Pathofthesessioncookie.
server.session.cookie.secure=#"Secure"flagforthesessioncookie.
server.session.persistent=false#Persistsessiondatabetweenrestarts.
server.session.storedir=#Directoryusedtostoresessiondata.
server.session.timeout=#Sessiontimeoutinseconds.
server.session.trackingmodes=#Sessiontrackingmodes(oneormoreofthefollowing:"cookie","url","ssl").
server.ssl.ciphers=#SupportedSSLciphers.
server.ssl.clientauth=#Whetherclientauthenticationiswanted("want")orneeded("need").Requiresatruststore.
server.ssl.enabled=#EnableSSLsupport.
server.ssl.enabledprotocols=#EnabledSSLprotocols.
server.ssl.keyalias=#Aliasthatidentifiesthekeyinthekeystore.
server.ssl.keypassword=#Passwordusedtoaccessthekeyinthekeystore.
server.ssl.keystore=#PathtothekeystorethatholdstheSSLcertificate(typicallyajksfile).
server.ssl.keystorepassword=#Passwordusedtoaccessthekeystore.
server.ssl.keystoreprovider=#Providerforthekeystore.
server.ssl.keystoretype=#Typeofthekeystore.
server.ssl.protocol=TLS#SSLprotocoltouse.
server.ssl.truststore=#TruststorethatholdsSSLcertificates.
server.ssl.truststorepassword=#Passwordusedtoaccessthetruststore.
server.ssl.truststoreprovider=#Providerforthetruststore.
server.ssl.truststoretype=#Typeofthetruststore.
server.tomcat.acceptcount=#Maximumqueuelengthforincomingconnectionrequestswhenallpossiblerequestprocessingthreadsare
server.tomcat.accesslog.buffered=true#Bufferoutputsuchthatitisonlyflushedperiodically.
server.tomcat.accesslog.directory=logs#Directoryinwhichlogfilesarecreated.Canberelativetothetomcatbasedirorabsolute
server.tomcat.accesslog.enabled=false#Enableaccesslog.
server.tomcat.accesslog.pattern=common#Formatpatternforaccesslogs.
server.tomcat.accesslog.prefix=access_log#Logfilenameprefix.
server.tomcat.accesslog.renameonrotate=false#Deferinclusionofthedatestampinthefilenameuntilrotatetime.
server.tomcat.accesslog.requestattributesenabled=false#SetrequestattributesforIPaddress,Hostname,protocolandportusedfo
server.tomcat.accesslog.rotate=true#Enableaccesslogrotation.
server.tomcat.accesslog.suffix=.log#Logfilenamesuffix.
server.tomcat.additionaltldskippatterns=#CommaseparatedlistofadditionalpatternsthatmatchjarstoignoreforTLDscanning.
server.tomcat.backgroundprocessordelay=30#DelayinsecondsbetweentheinvocationofbackgroundProcessmethods.
server.tomcat.basedir=#Tomcatbasedirectory.Ifnotspecifiedatemporarydirectorywillbeused.
server.tomcat.internalproxies=10\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}|\\
192\\.168\\.\\d{1,3}\\.\\d{1,3}|\\
169\\.254\\.\\d{1,3}\\.\\d{1,3}|\\
127\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}|\\
172\\.1[69]{1}\\.\\d{1,3}\\.\\d{1,3}|\\
172\\.2[09]{1}\\.\\d{1,3}\\.\\d{1,3}|\\
172\\.3[01]{1}\\.\\d{1,3}\\.\\d{1,3}#regularexpressionmatchingtrustedIPaddresses.
server.tomcat.maxconnections=#Maximumnumberofconnectionsthattheserverwillacceptandprocessatanygiventime.
server.tomcat.maxhttppostsize=0#MaximumsizeinbytesoftheHTTPpostcontent.
server.tomcat.maxthreads=0#Maximumamountofworkerthreads.
server.tomcat.minsparethreads=0#Minimumamountofworkerthreads.
server.tomcat.portheader=XForwardedPort#NameoftheHTTPheaderusedtooverridetheoriginalportvalue.
server.tomcat.protocolheader=#Headerthatholdstheincomingprotocol,usuallynamed"XForwardedProto".
server.tomcat.protocolheaderhttpsvalue=https#ValueoftheprotocolheaderthatindicatesthattheincomingrequestusesSSL.
server.tomcat.redirectcontextroot=#Whetherrequeststothecontextrootshouldberedirectedbyappendinga/tothepath.
server.tomcat.remoteipheader=#Nameofthehttpheaderfromwhichtheremoteipisextracted.Forinstance`XFORWARDEDFOR`
server.tomcat.uriencoding=UTF8#CharacterencodingtousetodecodetheURI.
server.undertow.accesslog.dir=#Undertowaccesslogdirectory.
server.undertow.accesslog.enabled=false#Enableaccesslog.
server.undertow.accesslog.pattern=common#Formatpatternforaccesslogs.
server.undertow.accesslog.prefix=access_log.#Logfilenameprefix.
server.undertow.accesslog.rotate=true#Enableaccesslogrotation.
server.undertow.accesslog.suffix=log#Logfilenamesuffix.
server.undertow.buffersize=#Sizeofeachbufferinbytes.
server.undertow.buffersperregion=#Numberofbufferperregion.
server.undertow.directbuffers=#AllocatebuffersoutsidetheJavaheap.
server.undertow.iothreads=#NumberofI/Othreadstocreatefortheworker.
server.undertow.maxhttppostsize=0#MaximumsizeinbytesoftheHTTPpostcontent.
server.undertow.workerthreads=#Numberofworkerthreads.
#FREEMARKER(FreeMarkerAutoConfiguration)
spring.freemarker.allowrequestoverride=false#SetwhetherHttpServletRequestattributesareallowedtooverride(hide)controller
spring.freemarker.allowsessionoverride=false#SetwhetherHttpSessionattributesareallowedtooverride(hide)controllergenerat
spring.freemarker.cache=false#Enabletemplatecaching.
spring.freemarker.charset=UTF8#Templateencoding.
spring.freemarker.checktemplatelocation=true#Checkthatthetemplateslocationexists.
spring.freemarker.contenttype=text/html#ContentTypevalue.
spring.freemarker.enabled=true#EnableMVCviewresolutionforthistechnology.
spring.freemarker.exposerequestattributes=false#Setwhetherallrequestattributesshouldbeaddedtothemodelpriortomerging
spring.freemarker.exposesessionattributes=false#SetwhetherallHttpSessionattributesshouldbeaddedtothemodelpriortomerg
spring.freemarker.exposespringmacrohelpers=true#SetwhethertoexposeaRequestContextforusebySpring'smacrolibrary,under
spring.freemarker.preferfilesystemaccess=true#Preferfilesystemaccessfortemplateloading.Filesystemaccessenableshotdet
spring.freemarker.prefix=#PrefixthatgetsprependedtoviewnameswhenbuildingaURL.
spring.freemarker.requestcontextattribute=#NameoftheRequestContextattributeforallviews.
spring.freemarker.settings.*=#WellknownFreeMarkerkeyswhichwillbepassedtoFreeMarker'sConfiguration.
spring.freemarker.suffix=#SuffixthatgetsappendedtoviewnameswhenbuildingaURL.
spring.freemarker.templateloaderpath=classpath:/templates/#Commaseparatedlistoftemplatepaths.
spring.freemarker.viewnames=#Whitelistofviewnamesthatcanberesolved.
#GROOVYTEMPLATES(GroovyTemplateAutoConfiguration)
spring.groovy.template.allowrequestoverride=false#SetwhetherHttpServletRequestattributesareallowedtooverride(hide)contro
spring.groovy.template.allowsessionoverride=false#SetwhetherHttpSessionattributesareallowedtooverride(hide)controllerge
spring.groovy.template.cache=#Enabletemplatecaching.
spring.groovy.template.charset=UTF8#Templateencoding.
spring.groovy.template.checktemplatelocation=true#Checkthatthetemplateslocationexists.
spring.groovy.template.configuration.*=#SeeGroovyMarkupConfigurer
spring.groovy.template.contenttype=test/html#ContentTypevalue.
spring.groovy.template.enabled=true#EnableMVCviewresolutionforthistechnology.
spring.groovy.template.exposerequestattributes=false#Setwhetherallrequestattributesshouldbeaddedtothemodelpriortomer
spring.groovy.template.exposesessionattributes=false#SetwhetherallHttpSessionattributesshouldbeaddedtothemodelpriorto
spring.groovy.template.exposespringmacrohelpers=true#SetwhethertoexposeaRequestContextforusebySpring'smacrolibrary,u
spring.groovy.template.prefix=#PrefixthatgetsprependedtoviewnameswhenbuildingaURL.
spring.groovy.template.requestcontextattribute=#NameoftheRequestContextattributeforallviews.
spring.groovy.template.resourceloaderpath=classpath:/templates/#Templatepath.
spring.groovy.template.suffix=.tpl#SuffixthatgetsappendedtoviewnameswhenbuildingaURL.
spring.groovy.template.viewnames=#Whitelistofviewnamesthatcanberesolved.
#SPRINGHATEOAS(HateoasProperties)
spring.hateoas.usehalasdefaultjsonmediatype=true#Specifyifapplication/hal+jsonresponsesshouldbesenttorequeststhatac
#HTTPmessageconversion
spring.http.converters.preferredjsonmapper=jackson#PreferredJSONmappertouseforHTTPmessageconversion.Setto"gson"tofor
#HTTPencoding(HttpEncodingProperties)
spring.http.encoding.charset=UTF8#CharsetofHTTPrequestsandresponses.Addedtothe"ContentType"headerifnotsetexplicitly
spring.http.encoding.enabled=true#Enablehttpencodingsupport.
spring.http.encoding.force=#ForcetheencodingtotheconfiguredcharsetonHTTPrequestsandresponses.
spring.http.encoding.forcerequest=#ForcetheencodingtotheconfiguredcharsetonHTTPrequests.Defaultstotruewhen"force"ha
spring.http.encoding.forceresponse=#ForcetheencodingtotheconfiguredcharsetonHTTPresponses.
spring.http.encoding.mapping=#LocaletoEncodingmapping.
#MULTIPART(MultipartProperties)
spring.http.multipart.enabled=true#Enablesupportofmultipartuploads.
spring.http.multipart.filesizethreshold=0#Thresholdafterwhichfileswillbewrittentodisk.Valuescanusethesuffixed"MB"o
spring.http.multipart.location=#Intermediatelocationofuploadedfiles.
spring.http.multipart.maxfilesize=1MB#Maxfilesize.Valuescanusethesuffixed"MB"or"KB"toindicateaMegabyteorKilobyte
spring.http.multipart.maxrequestsize=10MB#Maxrequestsize.Valuescanusethesuffixed"MB"or"KB"toindicateaMegabyteorKi
spring.http.multipart.resolvelazily=false#Whethertoresolvethemultipartrequestlazilyatthetimeoffileorparameteraccess.
#JACKSON(JacksonProperties)
spring.jackson.dateformat=#Dateformatstringorafullyqualifieddateformatclassname.Forinstance`yyyyMMddHH:mm:ss`.
spring.jackson.defaultpropertyinclusion=#Controlstheinclusionofpropertiesduringserialization.
spring.jackson.deserialization.*=#Jacksonon/offfeaturesthataffectthewayJavaobjectsaredeserialized.
spring.jackson.generator.*=#Jacksonon/offfeaturesforgenerators.
spring.jackson.jodadatetimeformat=#Jodadatetimeformatstring.Ifnotconfigured,"dateformat"willbeusedasafallbackif
spring.jackson.locale=#Localeusedforformatting.
spring.jackson.mapper.*=#Jacksongeneralpurposeon/offfeatures.
spring.jackson.parser.*=#Jacksonon/offfeaturesforparsers.
spring.jackson.propertynamingstrategy=#OneoftheconstantsonJackson'sPropertyNamingStrategy.Canalsobeafullyqualifiedcl
spring.jackson.serialization.*=#Jacksonon/offfeaturesthataffectthewayJavaobjectsareserialized.
spring.jackson.timezone=#Timezoneusedwhenformattingdates.Forinstance`America/Los_Angeles`
#JERSEY(JerseyProperties)
spring.jersey.applicationpath=#PaththatservesasthebaseURIfortheapplication.Overridesthevalueof"@ApplicationPath"if
spring.jersey.filter.order=0#Jerseyfilterchainorder.
spring.jersey.init.*=#InitparameterstopasstoJerseyviatheservletorfilter.
spring.jersey.servlet.loadonstartup=1#LoadonstartuppriorityoftheJerseyservlet.
spring.jersey.type=servlet#Jerseyintegrationtype.
#SPRINGLDAP(LdapProperties)
spring.ldap.urls=#LDAPURLsoftheserver.
spring.ldap.base=#Basesuffixfromwhichalloperationsshouldoriginate.
spring.ldap.username=#Loginuseroftheserver.
spring.ldap.password=#Loginpasswordoftheserver.
spring.ldap.baseenvironment.*=#LDAPspecificationsettings.
#EMBEDDEDLDAP(EmbeddedLdapProperties)
spring.ldap.embedded.port=#EmbeddedLDAPport.
spring.ldap.embedded.credential.username=#EmbeddedLDAPusername.
spring.ldap.embedded.credential.password=#EmbeddedLDAPpassword.
spring.ldap.embedded.basedn=#ThebaseDN
spring.ldap.embedded.ldif=classpath:schema.ldif#Schema(LDIF)scriptresourcereference.
#SPRINGMOBILEDEVICEVIEWS(DeviceDelegatingViewResolverAutoConfiguration)
spring.mobile.devicedelegatingviewresolver.enablefallback=false#Enablesupportforfallbackresolution.
spring.mobile.devicedelegatingviewresolver.enabled=false#Enabledeviceviewresolver.
spring.mobile.devicedelegatingviewresolver.mobileprefix=mobile/#Prefixthatgetsprependedtoviewnamesformobiledevices.
spring.mobile.devicedelegatingviewresolver.mobilesuffix=#Suffixthatgetsappendedtoviewnamesformobiledevices.
spring.mobile.devicedelegatingviewresolver.normalprefix=#Prefixthatgetsprependedtoviewnamesfornormaldevices.
spring.mobile.devicedelegatingviewresolver.normalsuffix=#Suffixthatgetsappendedtoviewnamesfornormaldevices.
spring.mobile.devicedelegatingviewresolver.tabletprefix=tablet/#Prefixthatgetsprependedtoviewnamesfortabletdevices.
spring.mobile.devicedelegatingviewresolver.tabletsuffix=#Suffixthatgetsappendedtoviewnamesfortabletdevices.
#SPRINGMOBILESITEPREFERENCE(SitePreferenceAutoConfiguration)
spring.mobile.sitepreference.enabled=true#EnableSitePreferenceHandler.
#MUSTACHETEMPLATES(MustacheAutoConfiguration)
spring.mustache.allowrequestoverride=#SetwhetherHttpServletRequestattributesareallowedtooverride(hide)controllergenerat
spring.mustache.allowsessionoverride=#SetwhetherHttpSessionattributesareallowedtooverride(hide)controllergeneratedmode
spring.mustache.cache=#Enabletemplatecaching.
spring.mustache.charset=#Templateencoding.
spring.mustache.checktemplatelocation=#Checkthatthetemplateslocationexists.
spring.mustache.contenttype=#ContentTypevalue.
spring.mustache.enabled=#EnableMVCviewresolutionforthistechnology.
spring.mustache.exposerequestattributes=#Setwhetherallrequestattributesshouldbeaddedtothemodelpriortomergingwithth
spring.mustache.exposesessionattributes=#SetwhetherallHttpSessionattributesshouldbeaddedtothemodelpriortomergingwit
spring.mustache.exposespringmacrohelpers=#SetwhethertoexposeaRequestContextforusebySpring'smacrolibrary,underthena
spring.mustache.prefix=classpath:/templates/#Prefixtoapplytotemplatenames.
spring.mustache.requestcontextattribute=#NameoftheRequestContextattributeforallviews.
spring.mustache.suffix=.html#Suffixtoapplytotemplatenames.
spring.mustache.viewnames=#Whitelistofviewnamesthatcanberesolved.
#SPRINGMVC(WebMvcProperties)
spring.mvc.async.requesttimeout=#Amountoftime(inmilliseconds)beforeasynchronousrequesthandlingtimesout.
spring.mvc.dateformat=#Dateformattouse.Forinstance`dd/MM/yyyy`.
spring.mvc.dispatchtracerequest=false#DispatchTRACErequeststotheFrameworkServletdoServicemethod.
spring.mvc.dispatchoptionsrequest=true#DispatchOPTIONSrequeststotheFrameworkServletdoServicemethod.
spring.mvc.favicon.enabled=true#Enableresolutionoffavicon.ico.
spring.mvc.formcontent.putfilter.enabled=true#EnableSpring'sHttpPutFormContentFilter.
spring.mvc.ignoredefaultmodelonredirect=true#Ifthecontentofthe"default"modelshouldbeignoredduringredirectscenarios.
spring.mvc.locale=#Localetouse.Bydefault,thislocaleisoverriddenbythe"AcceptLanguage"header.
spring.mvc.localeresolver=acceptheader#Definehowthelocaleshouldberesolved.
spring.mvc.logresolvedexception=false#Enablewarnloggingofexceptionsresolvedbya"HandlerExceptionResolver".
spring.mvc.mediatypes.*=#Mapsfileextensionstomediatypesforcontentnegotiation.
spring.mvc.messagecodesresolverformat=#Formattingstrategyformessagecodes.Forinstance`PREFIX_ERROR_CODE`.
spring.mvc.servlet.loadonstartup=1#LoadonstartuppriorityoftheSpringWebServicesservlet.
spring.mvc.staticpathpattern=/**#Pathpatternusedforstaticresources.
spring.mvc.throwexceptionifnohandlerfound=false#Ifa"NoHandlerFoundException"shouldbethrownifnoHandlerwasfoundtopro
spring.mvc.view.prefix=#SpringMVCviewprefix.
spring.mvc.view.suffix=#SpringMVCviewsuffix.
#SPRINGRESOURCESHANDLING(ResourceProperties)
spring.resources.addmappings=true#Enabledefaultresourcehandling.
spring.resources.cacheperiod=#Cacheperiodfortheresourcesservedbytheresourcehandler,inseconds.
spring.resources.chain.cache=true#EnablecachingintheResourcechain.
spring.resources.chain.enabled=#EnabletheSpringResourceHandlingchain.Disabledbydefaultunlessatleastonestrategyhasbee
spring.resources.chain.gzipped=false#Enableresolutionofalreadygzippedresources.
spring.resources.chain.htmlapplicationcache=false#EnableHTML5applicationcachemanifestrewriting.
spring.resources.chain.strategy.content.enabled=false#EnablethecontentVersionStrategy.
spring.resources.chain.strategy.content.paths=/**#CommaseparatedlistofpatternstoapplytotheVersionStrategy.
spring.resources.chain.strategy.fixed.enabled=false#EnablethefixedVersionStrategy.
spring.resources.chain.strategy.fixed.paths=/**#CommaseparatedlistofpatternstoapplytotheVersionStrategy.
spring.resources.chain.strategy.fixed.version=#VersionstringtousefortheVersionStrategy.
spring.resources.staticlocations=classpath:/METAINF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/
#SPRINGSESSION(SessionProperties)
spring.session.hazelcast.flushmode=onsave#Sessionsflushmode.
spring.session.hazelcast.mapname=spring:session:sessions#Nameofthemapusedtostoresessions.
spring.session.jdbc.initializer.enabled=#Createtherequiredsessiontablesonstartupifnecessary.Enabledautomaticallyifthed
spring.session.jdbc.schema=classpath:org/springframework/session/jdbc/schema@@platform@@.sql#PathtotheSQLfiletousetoinitia
spring.session.jdbc.tablename=SPRING_SESSION#Nameofdatabasetableusedtostoresessions.
spring.session.mongo.collectionname=sessions#Collectionnameusedtostoresessions.
spring.session.redis.flushmode=onsave#Sessionsflushmode.
spring.session.redis.namespace=#Namespaceforkeysusedtostoresessions.
spring.session.storetype=#Sessionstoretype.
#SPRINGSOCIAL(SocialWebAutoConfiguration)
spring.social.autoconnectionviews=false#Enabletheconnectionstatusviewforsupportedproviders.
#SPRINGSOCIALFACEBOOK(FacebookAutoConfiguration)
spring.social.facebook.appid=#yourapplication'sFacebookAppID
spring.social.facebook.appsecret=#yourapplication'sFacebookAppSecret
#SPRINGSOCIALLINKEDIN(LinkedInAutoConfiguration)
spring.social.linkedin.appid=#yourapplication'sLinkedInAppID
spring.social.linkedin.appsecret=#yourapplication'sLinkedInAppSecret
#SPRINGSOCIALTWITTER(TwitterAutoConfiguration)
spring.social.twitter.appid=#yourapplication'sTwitterAppID
spring.social.twitter.appsecret=#yourapplication'sTwitterAppSecret
#THYMELEAF(ThymeleafAutoConfiguration)
spring.thymeleaf.cache=true#Enabletemplatecaching.
spring.thymeleaf.checktemplate=true#Checkthatthetemplateexistsbeforerenderingit.
spring.thymeleaf.checktemplatelocation=true#Checkthatthetemplateslocationexists.
spring.thymeleaf.contenttype=text/html#ContentTypevalue.
spring.thymeleaf.enabled=true#EnableMVCThymeleafviewresolution.
spring.thymeleaf.encoding=UTF8#Templateencoding.
spring.thymeleaf.excludedviewnames=#Commaseparatedlistofviewnamesthatshouldbeexcludedfromresolution.
spring.thymeleaf.mode=HTML#Templatemodetobeappliedtotemplates.Seealsoorg.thymeleaf.templatemode.TemplateMode.
spring.thymeleaf.prefix=classpath:/templates/#PrefixthatgetsprependedtoviewnameswhenbuildingaURL.
spring.thymeleaf.suffix=.html#SuffixthatgetsappendedtoviewnameswhenbuildingaURL.
spring.thymeleaf.templateresolverorder=#Orderofthetemplateresolverinthechain.
spring.thymeleaf.viewnames=#Commaseparatedlistofviewnamesthatcanberesolved.
#SPRINGWEBSERVICES(WebServicesProperties)
spring.webservices.path=/services#PaththatservesasthebaseURIfortheservices.
spring.webservices.servlet.init=#ServletinitparameterstopasstoSpringWebServices.
spring.webservices.servlet.loadonstartup=1#LoadonstartuppriorityoftheSpringWebServicesservlet.
#
#SECURITYPROPERTIES
#
#SECURITY(SecurityProperties)
security.basic.authorizemode=role#Securityauthorizemodetoapply.
security.basic.enabled=true#Enablebasicauthentication.
security.basic.path=/**#Commaseparatedlistofpathstosecure.
security.basic.realm=Spring#HTTPbasicrealmname.
security.enablecsrf=false#EnableCrossSiteRequestForgerysupport.
security.filterorder=0#Securityfilterchainorder.
security.filterdispatchertypes=ASYNC,FORWARD,INCLUDE,REQUEST#Securityfilterchaindispatchertypes.
security.headers.cache=true#EnablecachecontrolHTTPheaders.
security.headers.contentsecuritypolicy=#Valueforcontentsecuritypolicyheader.
security.headers.contentsecuritypolicymode=default#Contentsecuritypolicymode.
security.headers.contenttype=true#Enable"XContentTypeOptions"header.
security.headers.frame=true#Enable"XFrameOptions"header.
security.headers.hsts=all#HTTPStrictTransportSecurity(HSTS)mode(none,domain,all).
security.headers.xss=true#Enablecrosssitescripting(XSS)protection.
security.ignored=#Commaseparatedlistofpathstoexcludefromthedefaultsecuredpaths.
security.requiressl=false#Enablesecurechannelforallrequests.
security.sessions=stateless#Sessioncreationpolicy(always,never,if_required,stateless).
security.user.name=user#Defaultusername.
security.user.password=#Passwordforthedefaultusername.Arandompasswordisloggedonstartupbydefault.
security.user.role=USER#Grantedrolesforthedefaultusername.
#SECURITYOAUTH2CLIENT(OAuth2ClientProperties)
security.oauth2.client.clientid=#OAuth2clientid.
security.oauth2.client.clientsecret=#OAuth2clientsecret.Arandomsecretisgeneratedbydefault
#SECURITYOAUTH2RESOURCES(ResourceServerProperties)
security.oauth2.resource.filterorder=#Theorderofthefilterchainusedtoauthenticatetokens.
security.oauth2.resource.id=#Identifieroftheresource.
security.oauth2.resource.jwt.keyuri=#TheURIoftheJWTtoken.Canbesetifthevalueisnotavailableandthekeyispublic.
security.oauth2.resource.jwt.keyvalue=#TheverificationkeyoftheJWTtoken.CaneitherbeasymmetricsecretorPEMencodedRSA
security.oauth2.resource.prefertokeninfo=true#Usethetokeninfo,canbesettofalsetousetheuserinfo.
security.oauth2.resource.serviceid=resource#
security.oauth2.resource.tokeninfouri=#URIofthetokendecodingendpoint.
security.oauth2.resource.tokentype=#ThetokentypetosendwhenusingtheuserInfoUri.
security.oauth2.resource.userinfouri=#URIoftheuserendpoint.
#SECURITYOAUTH2SSO(OAuth2SsoProperties)
security.oauth2.sso.filterorder=#FilterordertoapplyifnotprovidinganexplicitWebSecurityConfigurerAdapter
security.oauth2.sso.loginpath=/login#Pathtotheloginpage,i.e.theonethattriggerstheredirecttotheOAuth2AuthorizationS
#
#DATAPROPERTIES
#
#FLYWAY(FlywayProperties)
flyway.baselinedescription=#
flyway.baselineversion=1#versiontostartmigration
flyway.baselineonmigrate=#
flyway.checklocation=false#Checkthatmigrationscriptslocationexists.
flyway.cleanonvalidationerror=#
flyway.enabled=true#Enableflyway.
flyway.encoding=#
flyway.ignorefailedfuturemigration=#
flyway.initsqls=#SQLstatementstoexecutetoinitializeaconnectionimmediatelyafterobtainingit.
flyway.locations=classpath:db/migration#locationsofmigrationsscripts
flyway.outoforder=#
flyway.password=#JDBCpasswordifyouwantFlywaytocreateitsownDataSource
flyway.placeholderprefix=#
flyway.placeholderreplacement=#
flyway.placeholdersuffix=#
flyway.placeholders.*=#
flyway.schemas=#schemastoupdate
flyway.sqlmigrationprefix=V#
flyway.sqlmigrationseparator=#
flyway.sqlmigrationsuffix=.sql#
flyway.table=#
flyway.url=#JDBCurlofthedatabasetomigrate.Ifnotset,theprimaryconfigureddatasourceisused.
flyway.user=#Loginuserofthedatabasetomigrate.
flyway.validateonmigrate=#
#LIQUIBASE(LiquibaseProperties)
liquibase.changelog=classpath:/db/changelog/db.changelogmaster.yaml#Changelogconfigurationpath.
liquibase.checkchangeloglocation=true#Checkthechangeloglocationexists.
liquibase.contexts=#Commaseparatedlistofruntimecontextstouse.
liquibase.defaultschema=#Defaultdatabaseschema.
liquibase.dropfirst=false#Dropthedatabaseschemafirst.
liquibase.enabled=true#Enableliquibasesupport.
liquibase.labels=#Commaseparatedlistofruntimelabelstouse.
liquibase.parameters.*=#Changelogparameters.
liquibase.password=#Loginpasswordofthedatabasetomigrate.
liquibase.rollbackfile=#FiletowhichrollbackSQLwillbewrittenwhenanupdateisperformed.
liquibase.url=#JDBCurlofthedatabasetomigrate.Ifnotset,theprimaryconfigureddatasourceisused.
liquibase.user=#Loginuserofthedatabasetomigrate.
#COUCHBASE(CouchbaseProperties)
spring.couchbase.bootstraphosts=#Couchbasenodes(hostorIPaddress)tobootstrapfrom.
spring.couchbase.bucket.name=default#Nameofthebuckettoconnectto.
spring.couchbase.bucket.password=#Passwordofthebucket.
spring.couchbase.env.endpoints.keyvalue=1#NumberofsocketspernodeagainsttheKey/valueservice.
spring.couchbase.env.endpoints.query=1#NumberofsocketspernodeagainsttheQuery(N1QL)service.
spring.couchbase.env.endpoints.view=1#Numberofsocketspernodeagainsttheviewservice.
spring.couchbase.env.ssl.enabled=#EnableSSLsupport.Enabledautomaticallyifa"keyStore"isprovidedunlessspecifiedotherwise.
spring.couchbase.env.ssl.keystore=#PathtotheJVMkeystorethatholdsthecertificates.
spring.couchbase.env.ssl.keystorepassword=#Passwordusedtoaccessthekeystore.
spring.couchbase.env.timeouts.connect=5000#Bucketconnectionstimeoutinmilliseconds.
spring.couchbase.env.timeouts.keyvalue=2500#Blockingoperationsperformedonaspecifickeytimeoutinmilliseconds.
spring.couchbase.env.timeouts.query=7500#N1QLqueryoperationstimeoutinmilliseconds.
spring.couchbase.env.timeouts.socketconnect=1000#Socketconnectconnectionstimeoutinmilliseconds.
spring.couchbase.env.timeouts.view=7500#Regularandgeospatialviewoperationstimeoutinmilliseconds.
#DAO(PersistenceExceptionTranslationAutoConfiguration)
spring.dao.exceptiontranslation.enabled=true#EnablethePersistenceExceptionTranslationPostProcessor.
#CASSANDRA(CassandraProperties)
spring.data.cassandra.clustername=#NameoftheCassandracluster.
spring.data.cassandra.compression=none#CompressionsupportedbytheCassandrabinaryprotocol.
spring.data.cassandra.connecttimeoutmillis=#Socketoption:connectiontimeout.
spring.data.cassandra.consistencylevel=#Queriesconsistencylevel.
spring.data.cassandra.contactpoints=localhost#Commaseparatedlistofclusternodeaddresses.
spring.data.cassandra.fetchsize=#Queriesdefaultfetchsize.
spring.data.cassandra.keyspacename=#Keyspacenametouse.
spring.data.cassandra.loadbalancingpolicy=#Classnameoftheloadbalancingpolicy.
spring.data.cassandra.port=#PortoftheCassandraserver.
spring.data.cassandra.password=#Loginpasswordoftheserver.
spring.data.cassandra.readtimeoutmillis=#Socketoption:readtimeout.
spring.data.cassandra.reconnectionpolicy=#Reconnectionpolicyclass.
spring.data.cassandra.retrypolicy=#Classnameoftheretrypolicy.
spring.data.cassandra.serialconsistencylevel=#Queriesserialconsistencylevel.
spring.data.cassandra.schemaaction=none#Schemaactiontotakeatstartup.
spring.data.cassandra.ssl=false#EnableSSLsupport.
spring.data.cassandra.username=#Loginuseroftheserver.
#DATACOUCHBASE(CouchbaseDataProperties)
spring.data.couchbase.autoindex=false#Automaticallycreateviewsandindexes.
spring.data.couchbase.consistency=readyourownwrites#Consistencytoapplybydefaultongeneratedqueries.
spring.data.couchbase.repositories.enabled=true#EnableCouchbaserepositories.
#ELASTICSEARCH(ElasticsearchProperties)
spring.data.elasticsearch.clustername=elasticsearch#Elasticsearchclustername.
spring.data.elasticsearch.clusternodes=#Commaseparatedlistofclusternodeaddresses.Ifnotspecified,startsaclientnode.
spring.data.elasticsearch.properties.*=#Additionalpropertiesusedtoconfiguretheclient.
spring.data.elasticsearch.repositories.enabled=true#EnableElasticsearchrepositories.
#DATALDAP
spring.data.ldap.repositories.enabled=true#EnableLDAPrepositories.
#MONGODB(MongoProperties)
spring.data.mongodb.authenticationdatabase=#Authenticationdatabasename.
spring.data.mongodb.database=test#Databasename.
spring.data.mongodb.fieldnamingstrategy=#FullyqualifiednameoftheFieldNamingStrategytouse.
spring.data.mongodb.gridfsdatabase=#GridFSdatabasename.
spring.data.mongodb.host=localhost#Mongoserverhost.Cannotbesetwithuri.
spring.data.mongodb.password=#Loginpasswordofthemongoserver.Cannotbesetwithuri.
spring.data.mongodb.port=27017#Mongoserverport.Cannotbesetwithuri.
spring.data.mongodb.reactiverepositories.enabled=true#EnableMongoreactiverepositories.
spring.data.mongodb.repositories.enabled=true#EnableMongorepositories.
spring.data.mongodb.uri=mongodb://localhost/test#MongodatabaseURI.Cannotbesetwithhost,portandcredentials.
spring.data.mongodb.username=#Loginuserofthemongoserver.Cannotbesetwithuri.
#DATAREDIS
spring.data.redis.repositories.enabled=true#EnableRedisrepositories.
#NEO4J(Neo4jProperties)
spring.data.neo4j.compiler=#Compilertouse.
spring.data.neo4j.embedded.enabled=true#Enableembeddedmodeiftheembeddeddriverisavailable.
spring.data.neo4j.openinview=false#RegisterOpenSessionInViewInterceptor.BindsaNeo4jSessiontothethreadfortheentireproc
spring.data.neo4j.password=#Loginpasswordoftheserver.
spring.data.neo4j.repositories.enabled=true#EnableNeo4jrepositories.
spring.data.neo4j.uri=#URIusedbythedriver.Autodetectedbydefault.
spring.data.neo4j.username=#Loginuseroftheserver.
#DATAREST(RepositoryRestProperties)
spring.data.rest.basepath=#BasepathtobeusedbySpringDataRESTtoexposerepositoryresources.
spring.data.rest.defaultpagesize=#Defaultsizeofpages.
spring.data.rest.detectionstrategy=default#Strategytousetodeterminewhichrepositoriesgetexposed.
spring.data.rest.enableenumtranslation=#EnableenumvaluetranslationviatheSpringDataRESTdefaultresourcebundle.
spring.data.rest.limitparamname=#NameoftheURLquerystringparameterthatindicateshowmanyresultstoreturnatonce.
spring.data.rest.maxpagesize=#Maximumsizeofpages.
spring.data.rest.pageparamname=#NameoftheURLquerystringparameterthatindicateswhatpagetoreturn.
spring.data.rest.returnbodyoncreate=#Returnaresponsebodyaftercreatinganentity.
spring.data.rest.returnbodyonupdate=#Returnaresponsebodyafterupdatinganentity.
spring.data.rest.sortparamname=#NameoftheURLquerystringparameterthatindicateswhatdirectiontosortresults.
#SOLR(SolrProperties)
spring.data.solr.host=http://127.0.0.1:8983/solr#Solrhost.Ignoredif"zkhost"isset.
spring.data.solr.repositories.enabled=true#EnableSolrrepositories.
spring.data.solr.zkhost=#ZooKeeperhostaddressintheformHOST:PORT.
#DATASOURCE(DataSourceAutoConfiguration&DataSourceProperties)
spring.datasource.continueonerror=false#Donotstopifanerroroccurswhileinitializingthedatabase.
spring.datasource.data=#Data(DML)scriptresourcereferences.
spring.datasource.datausername=#UserofthedatabasetoexecuteDMLscripts(ifdifferent).
spring.datasource.datapassword=#PasswordofthedatabasetoexecuteDMLscripts(ifdifferent).
spring.datasource.dbcp2.*=#CommonsDBCP2specificsettings
spring.datasource.driverclassname=#FullyqualifiednameoftheJDBCdriver.AutodetectedbasedontheURLbydefault.
spring.datasource.generateuniquename=false#Generatearandomdatasourcename.
spring.datasource.hikari.*=#Hikarispecificsettings
spring.datasource.initialize=true#Populatethedatabaseusing'data.sql'.
spring.datasource.jmxenabled=false#EnableJMXsupport(ifprovidedbytheunderlyingpool).
spring.datasource.jndiname=#JNDIlocationofthedatasource.Class,url,username&passwordareignoredwhenset.
spring.datasource.name=testdb#Nameofthedatasource.
spring.datasource.password=#Loginpasswordofthedatabase.
spring.datasource.platform=all#Platformtouseintheschemaresource(schema${platform}.sql).
spring.datasource.schema=#Schema(DDL)scriptresourcereferences.
spring.datasource.schemausername=#UserofthedatabasetoexecuteDDLscripts(ifdifferent).
spring.datasource.schemapassword=#PasswordofthedatabasetoexecuteDDLscripts(ifdifferent).
spring.datasource.separator=;#StatementseparatorinSQLinitializationscripts.
spring.datasource.sqlscriptencoding=#SQLscriptsencoding.
spring.datasource.tomcat.*=#Tomcatdatasourcespecificsettings
spring.datasource.type=#Fullyqualifiednameoftheconnectionpoolimplementationtouse.Bydefault,itisautodetectedfromthe
spring.datasource.url=#JDBCurlofthedatabase.
spring.datasource.username=
#JEST(ElasticsearchHTTPclient)(JestProperties)
spring.elasticsearch.jest.connectiontimeout=3000#Connectiontimeoutinmilliseconds.
spring.elasticsearch.jest.multithreaded=true#Enableconnectionrequestsfrommultipleexecutionthreads.
spring.elasticsearch.jest.password=#Loginpassword.
spring.elasticsearch.jest.proxy.host=#ProxyhosttheHTTPclientshoulduse.
spring.elasticsearch.jest.proxy.port=#ProxyporttheHTTPclientshoulduse.
spring.elasticsearch.jest.readtimeout=3000#Readtimeoutinmilliseconds.
spring.elasticsearch.jest.uris=http://localhost:9200#CommaseparatedlistoftheElasticsearchinstancestouse.
spring.elasticsearch.jest.username=#Loginuser.
#H2WebConsole(H2ConsoleProperties)
spring.h2.console.enabled=false#Enabletheconsole.
spring.h2.console.path=/h2console#Pathatwhichtheconsolewillbeavailable.
spring.h2.console.settings.trace=false#Enabletraceoutput.
spring.h2.console.settings.weballowothers=false#Enableremoteaccess.
#JOOQ(JooqAutoConfiguration)
spring.jooq.sqldialect=#SQLDialectJOOQusedwhencommunicatingwiththeconfigureddatasource.Forinstance`POSTGRES`
#JPA(JpaBaseConfiguration,HibernateJpaAutoConfiguration)
spring.data.jpa.repositories.enabled=true#EnableJPArepositories.
spring.jpa.database=#Targetdatabasetooperateon,autodetectedbydefault.Canbealternativelysetusingthe"databasePlatform"
spring.jpa.databaseplatform=#Nameofthetargetdatabasetooperateon,autodetectedbydefault.Canbealternativelysetusingt
spring.jpa.generateddl=false#Initializetheschemaonstartup.
spring.jpa.hibernate.ddlauto=#DDLmode.Thisisactuallyashortcutforthe"hibernate.hbm2ddl.auto"property.Defaultto"create
spring.jpa.hibernate.naming.implicitstrategy=#Implicitnamingstrategyfullyqualifiedname.
spring.jpa.hibernate.naming.physicalstrategy=#Physicalnamingstrategyfullyqualifiedname.
spring.jpa.hibernate.usenewidgeneratormappings=#UseHibernate'snewerIdentifierGeneratorforAUTO,TABLEandSEQUENCE.
spring.jpa.openinview=true#RegisterOpenEntityManagerInViewInterceptor.BindsaJPAEntityManagertothethreadfortheentirepr
spring.jpa.properties.*=#AdditionalnativepropertiestosetontheJPAprovider.
spring.jpa.showsql=false#EnableloggingofSQLstatements.
#JTA(JtaAutoConfiguration)
spring.jta.enabled=true#EnableJTAsupport.
spring.jta.logdir=#Transactionlogsdirectory.
spring.jta.transactionmanagerid=#Transactionmanageruniqueidentifier.
#ATOMIKOS(AtomikosProperties)
spring.jta.atomikos.connectionfactory.borrowconnectiontimeout=30#Timeout,inseconds,forborrowingconnectionsfromthepool.
spring.jta.atomikos.connectionfactory.ignoresessiontransactedflag=true#Whetherornottoignorethetransactedflagwhencreatin
spring.jta.atomikos.connectionfactory.localtransactionmode=false#Whetherornotlocaltransactionsaredesired.
spring.jta.atomikos.connectionfactory.maintenanceinterval=60#Thetime,inseconds,betweenrunsofthepool'smaintenancethread.
spring.jta.atomikos.connectionfactory.maxidletime=60#Thetime,inseconds,afterwhichconnectionsarecleanedupfromthepool.
spring.jta.atomikos.connectionfactory.maxlifetime=0#Thetime,inseconds,thataconnectioncanbepooledforbeforebeingdestroy
spring.jta.atomikos.connectionfactory.maxpoolsize=1#Themaximumsizeofthepool.
spring.jta.atomikos.connectionfactory.minpoolsize=1#Theminimumsizeofthepool.
spring.jta.atomikos.connectionfactory.reaptimeout=0#Thereaptimeout,inseconds,forborrowedconnections.0denotesnolimit.
spring.jta.atomikos.connectionfactory.uniqueresourcename=jmsConnectionFactory#Theuniquenameusedtoidentifytheresourcedurin
spring.jta.atomikos.datasource.borrowconnectiontimeout=30#Timeout,inseconds,forborrowingconnectionsfromthepool.
spring.jta.atomikos.datasource.defaultisolationlevel=#Defaultisolationlevelofconnectionsprovidedbythepool.
spring.jta.atomikos.datasource.logintimeout=#Timeout,inseconds,forestablishingadatabaseconnection.
spring.jta.atomikos.datasource.maintenanceinterval=60#Thetime,inseconds,betweenrunsofthepool'smaintenancethread.
spring.jta.atomikos.datasource.maxidletime=60#Thetime,inseconds,afterwhichconnectionsarecleanedupfromthepool.
spring.jta.atomikos.datasource.maxlifetime=0#Thetime,inseconds,thataconnectioncanbepooledforbeforebeingdestroyed.0d
spring.jta.atomikos.datasource.maxpoolsize=1#Themaximumsizeofthepool.
spring.jta.atomikos.datasource.minpoolsize=1#Theminimumsizeofthepool.
spring.jta.atomikos.datasource.reaptimeout=0#Thereaptimeout,inseconds,forborrowedconnections.0denotesnolimit.
spring.jta.atomikos.datasource.testquery=#SQLqueryorstatementusedtovalidateaconnectionbeforereturningit.
spring.jta.atomikos.datasource.uniqueresourcename=dataSource#Theuniquenameusedtoidentifytheresourceduringrecovery.
spring.jta.atomikos.properties.checkpointinterval=500#Intervalbetweencheckpoints.
spring.jta.atomikos.properties.consolefilecount=1#Numberofdebuglogsfilesthatcanbecreated.
spring.jta.atomikos.properties.consolefilelimit=1#Howmanybytescanbestoredatmostindebuglogsfiles.
spring.jta.atomikos.properties.consolefilename=tm.out#Debuglogsfilename.
spring.jta.atomikos.properties.consoleloglevel=warn#Consoleloglevel.
spring.jta.atomikos.properties.defaultjtatimeout=10000#DefaulttimeoutforJTAtransactions.
spring.jta.atomikos.properties.enablelogging=true#Enabledisklogging.
spring.jta.atomikos.properties.forceshutdownonvmexit=false#SpecifyifaVMshutdownshouldtriggerforcedshutdownofthetrans
spring.jta.atomikos.properties.logbasedir=#Directoryinwhichthelogfilesshouldbestored.
spring.jta.atomikos.properties.logbasename=tmlog#Transactionslogfilebasename.
spring.jta.atomikos.properties.maxactives=50#Maximumnumberofactivetransactions.
spring.jta.atomikos.properties.maxtimeout=300000#Maximumtimeout(inmilliseconds)thatcanbeallowedfortransactions.
spring.jta.atomikos.properties.outputdir=#Directoryinwhichtostorethedebuglogfiles.
spring.jta.atomikos.properties.serialjtatransactions=true#Specifyifsubtransactionsshouldbejoinedwhenpossible.
spring.jta.atomikos.properties.service=#Transactionmanagerimplementationthatshouldbestarted.
spring.jta.atomikos.properties.threadedtwophasecommit=true#Usedifferent(andconcurrent)threadsfortwophasecommitonthepa
spring.jta.atomikos.properties.transactionmanageruniquename=#Transactionmanager'suniquename.
#BITRONIX
spring.jta.bitronix.connectionfactory.acquireincrement=1#Numberofconnectionstocreatewhengrowingthepool.
spring.jta.bitronix.connectionfactory.acquisitioninterval=1#Time,inseconds,towaitbeforetryingtoacquireaconnectionagain
spring.jta.bitronix.connectionfactory.acquisitiontimeout=30#Timeout,inseconds,foracquiringconnectionsfromthepool.
spring.jta.bitronix.connectionfactory.allowlocaltransactions=true#WhetherornotthetransactionmanagershouldallowmixingXAa
spring.jta.bitronix.connectionfactory.applytransactiontimeout=false#WhetherornotthetransactiontimeoutshouldbesetontheX
spring.jta.bitronix.connectionfactory.automaticenlistingenabled=true#Whetherornotresourcesshouldbeenlistedanddelistedaut
spring.jta.bitronix.connectionfactory.cacheproducersconsumers=true#Whetherornotproducesandconsumersshouldbecached.
spring.jta.bitronix.connectionfactory.deferconnectionrelease=true#Whetherornottheprovidercanrunmanytransactionsonthesa
spring.jta.bitronix.connectionfactory.ignorerecoveryfailures=false#Whetherornotrecoveryfailuresshouldbeignored.
spring.jta.bitronix.connectionfactory.maxidletime=60#Thetime,inseconds,afterwhichconnectionsarecleanedupfromthepool.
spring.jta.bitronix.connectionfactory.maxpoolsize=10#Themaximumsizeofthepool.0denotesnolimit.
spring.jta.bitronix.connectionfactory.minpoolsize=0#Theminimumsizeofthepool.
spring.jta.bitronix.connectionfactory.password=#ThepasswordtousetoconnecttotheJMSprovider.
spring.jta.bitronix.connectionfactory.sharetransactionconnections=false#WhetherornotconnectionsintheACCESSIBLEstatecanb
spring.jta.bitronix.connectionfactory.testconnections=true#Whetherornotconnectionsshouldbetestedwhenacquiredfromthepool
spring.jta.bitronix.connectionfactory.twopcorderingposition=1#Thepositionthatthisresourceshouldtakeduringtwophasecommi
spring.jta.bitronix.connectionfactory.uniquename=jmsConnectionFactory#Theuniquenameusedtoidentifytheresourceduringrecover
spring.jta.bitronix.connectionfactory.usetmjoin=trueWhetherornotTMJOINshouldbeusedwhenstartingXAResources.
spring.jta.bitronix.connectionfactory.user=#TheusertousetoconnecttotheJMSprovider.
spring.jta.bitronix.datasource.acquireincrement=1#Numberofconnectionstocreatewhengrowingthepool.
spring.jta.bitronix.datasource.acquisitioninterval=1#Time,inseconds,towaitbeforetryingtoacquireaconnectionagainaftera
spring.jta.bitronix.datasource.acquisitiontimeout=30#Timeout,inseconds,foracquiringconnectionsfromthepool.
spring.jta.bitronix.datasource.allowlocaltransactions=true#WhetherornotthetransactionmanagershouldallowmixingXAandnon
spring.jta.bitronix.datasource.applytransactiontimeout=false#WhetherornotthetransactiontimeoutshouldbesetontheXAResour
spring.jta.bitronix.datasource.automaticenlistingenabled=true#Whetherornotresourcesshouldbeenlistedanddelistedautomatica
spring.jta.bitronix.datasource.cursorholdability=#Thedefaultcursorholdabilityforconnections.
spring.jta.bitronix.datasource.deferconnectionrelease=true#Whetherornotthedatabasecanrunmanytransactionsonthesameconn
spring.jta.bitronix.datasource.enablejdbc4connectiontest=#WhetherornotConnection.isValid()iscalledwhenacquiringaconnect
spring.jta.bitronix.datasource.ignorerecoveryfailures=false#Whetherornotrecoveryfailuresshouldbeignored.
spring.jta.bitronix.datasource.isolationlevel=#Thedefaultisolationlevelforconnections.
spring.jta.bitronix.datasource.localautocommit=#Thedefaultautocommitmodeforlocaltransactions.
spring.jta.bitronix.datasource.logintimeout=#Timeout,inseconds,forestablishingadatabaseconnection.
spring.jta.bitronix.datasource.maxidletime=60#Thetime,inseconds,afterwhichconnectionsarecleanedupfromthepool.
spring.jta.bitronix.datasource.maxpoolsize=10#Themaximumsizeofthepool.0denotesnolimit.
spring.jta.bitronix.datasource.minpoolsize=0#Theminimumsizeofthepool.
spring.jta.bitronix.datasource.preparedstatementcachesize=0#Thetargetsizeofthepreparedstatementcache.0disablesthecach
spring.jta.bitronix.datasource.sharetransactionconnections=false#WhetherornotconnectionsintheACCESSIBLEstatecanbeshare
spring.jta.bitronix.datasource.testquery=#SQLqueryorstatementusedtovalidateaconnectionbeforereturningit.
spring.jta.bitronix.datasource.twopcorderingposition=1#Thepositionthatthisresourceshouldtakeduringtwophasecommit(alwa
spring.jta.bitronix.datasource.uniquename=dataSource#Theuniquenameusedtoidentifytheresourceduringrecovery.
spring.jta.bitronix.datasource.usetmjoin=trueWhetherornotTMJOINshouldbeusedwhenstartingXAResources.
spring.jta.bitronix.properties.allowmultiplelrc=false#AllowmultipleLRCresourcestobeenlistedintothesametransaction.
spring.jta.bitronix.properties.asynchronous2pc=false#Enableasynchronouslyexecutionoftwophasecommit.
spring.jta.bitronix.properties.backgroundrecoveryintervalseconds=60#Intervalinsecondsatwhichtoruntherecoveryprocessin
spring.jta.bitronix.properties.currentnodeonlyrecovery=true#Recoveronlythecurrentnode.
spring.jta.bitronix.properties.debugzeroresourcetransaction=false#Logthecreationandcommitcallstacksoftransactionsexecut
spring.jta.bitronix.properties.defaulttransactiontimeout=60#Defaulttransactiontimeoutinseconds.
spring.jta.bitronix.properties.disablejmx=false#EnableJMXsupport.
spring.jta.bitronix.properties.exceptionanalyzer=#Setthefullyqualifiednameoftheexceptionanalyzerimplementationtouse.
spring.jta.bitronix.properties.filterlogstatus=false#Enablefilteringoflogssothatonlymandatorylogsarewritten.
spring.jta.bitronix.properties.forcebatchingenabled=true#Setifdiskforcesarebatched.
spring.jta.bitronix.properties.forcedwriteenabled=true#Setiflogsareforcedtodisk.
spring.jta.bitronix.properties.gracefulshutdowninterval=60#MaximumamountofsecondstheTMwillwaitfortransactionstogetdon
spring.jta.bitronix.properties.jnditransactionsynchronizationregistryname=#JNDInameoftheTransactionSynchronizationRegistry.
spring.jta.bitronix.properties.jndiusertransactionname=#JNDInameoftheUserTransaction.
spring.jta.bitronix.properties.journal=disk#Nameofthejournal.Canbe'disk','null'oraclassname.
spring.jta.bitronix.properties.logpart1filename=btm1.tlog#Nameofthefirstfragmentofthejournal.
spring.jta.bitronix.properties.logpart2filename=btm2.tlog#Nameofthesecondfragmentofthejournal.
spring.jta.bitronix.properties.maxlogsizeinmb=2#Maximumsizeinmegabytesofthejournalfragments.
spring.jta.bitronix.properties.resourceconfigurationfilename=#ResourceLoaderconfigurationfilename.
spring.jta.bitronix.properties.serverid=#ASCIIIDthatmustuniquelyidentifythisTMinstance.Defaulttothemachine'sIPaddres
spring.jta.bitronix.properties.skipcorruptedlogs=false#Skipcorruptedtransactionslogentries.
spring.jta.bitronix.properties.warnaboutzeroresourcetransaction=true#Logawarningfortransactionsexecutedwithoutasinglee
#NARAYANA(NarayanaProperties)
spring.jta.narayana.defaulttimeout=60#Transactiontimeoutinseconds.
spring.jta.narayana.expiryscanners=com.arjuna.ats.internal.arjuna.recovery.ExpiredTransactionStatusManagerScanner#Commaseparated
spring.jta.narayana.logdir=#Transactionobjectstoredirectory.
spring.jta.narayana.onephasecommit=true#Enableonephasecommitoptimisation.
spring.jta.narayana.periodicrecoveryperiod=120#Intervalinwhichperiodicrecoveryscansareperformedinseconds.
spring.jta.narayana.recoverybackoffperiod=10#Backoffperiodbetweenfirstandsecondphasesoftherecoveryscaninseconds.
spring.jta.narayana.recoverydbpass=#Databasepasswordtobeusedbyrecoverymanager.
spring.jta.narayana.recoverydbuser=#Databaseusernametobeusedbyrecoverymanager.
spring.jta.narayana.recoveryjmspass=#JMSpasswordtobeusedbyrecoverymanager.
spring.jta.narayana.recoveryjmsuser=#JMSusernametobeusedbyrecoverymanager.
spring.jta.narayana.recoverymodules=#Commaseparatedlistofrecoverymodules.
spring.jta.narayana.transactionmanagerid=1#Uniquetransactionmanagerid.
spring.jta.narayana.xaresourceorphanfilters=#Commaseparatedlistoforphanfilters.
#EMBEDDEDMONGODB(EmbeddedMongoProperties)
spring.mongodb.embedded.features=SYNC_DELAY#Commaseparatedlistoffeaturestoenable.
spring.mongodb.embedded.storage.databasedir=#Directoryusedfordatastorage.
spring.mongodb.embedded.storage.oplogsize=#Maximumsizeoftheoploginmegabytes.
spring.mongodb.embedded.storage.replsetname=#Nameofthereplicaset.
spring.mongodb.embedded.version=2.6.10#VersionofMongotouse.
#REDIS(RedisProperties)
spring.redis.cluster.maxredirects=#Maximumnumberofredirectstofollowwhenexecutingcommandsacrossthecluster.
spring.redis.cluster.nodes=#Commaseparatedlistof"host:port"pairstobootstrapfrom.
spring.redis.database=0#Databaseindexusedbytheconnectionfactory.
spring.redis.url=#ConnectionURL,willoverridehost,portandpassword(userwillbeignored),e.g.redis://user:password@example.
spring.redis.host=localhost#Redisserverhost.
spring.redis.password=#Loginpasswordoftheredisserver.
spring.redis.ssl=false#EnableSSLsupport.
spring.redis.pool.maxactive=8#Maxnumberofconnectionsthatcanbeallocatedbythepoolatagiventime.Useanegativevaluefo
spring.redis.pool.maxidle=8#Maxnumberof"idle"connectionsinthepool.Useanegativevaluetoindicateanunlimitednumberof
spring.redis.pool.maxwait=1#Maximumamountoftime(inmilliseconds)aconnectionallocationshouldblockbeforethrowinganexce
spring.redis.pool.minidle=0#Targetfortheminimumnumberofidleconnectionstomaintaininthepool.Thissettingonlyhasanef
spring.redis.port=6379#Redisserverport.
spring.redis.sentinel.master=#NameofRedisserver.
spring.redis.sentinel.nodes=#Commaseparatedlistofhost:portpairs.
spring.redis.timeout=0#Connectiontimeoutinmilliseconds.
#TRANSACTION(TransactionProperties)
spring.transaction.defaulttimeout=#Defaulttransactiontimeoutinseconds.
spring.transaction.rollbackoncommitfailure=#Performtherollbackoncommitfailures.
#
#INTEGRATIONPROPERTIES
#
#ACTIVEMQ(ActiveMQProperties)
spring.activemq.brokerurl=#URLoftheActiveMQbroker.Autogeneratedbydefault.Forinstance`tcp://localhost:61616`
spring.activemq.inmemory=true#SpecifyifthedefaultbrokerURLshouldbeinmemory.Ignoredifanexplicitbrokerhasbeenspecif
spring.activemq.password=#Loginpasswordofthebroker.
spring.activemq.user=#Loginuserofthebroker.
spring.activemq.packages.trustall=false#Trustallpackages.
spring.activemq.packages.trusted=#Commaseparatedlistofspecificpackagestotrust(whennottrustingallpackages).
spring.activemq.pool.configuration.*=#SeePooledConnectionFactory.
spring.activemq.pool.enabled=false#WhetheraPooledConnectionFactoryshouldbecreatedinsteadofaregularConnectionFactory.
spring.activemq.pool.expirytimeout=0#Connectionexpirationtimeoutinmilliseconds.
spring.activemq.pool.idletimeout=30000#Connectionidletimeoutinmilliseconds.
spring.activemq.pool.maxconnections=1#Maximumnumberofpooledconnections.
#ARTEMIS(ArtemisProperties)
spring.artemis.embedded.clusterpassword=#Clusterpassword.Randomlygeneratedonstartupbydefault.
spring.artemis.embedded.datadirectory=#Journalfiledirectory.Notnecessaryifpersistenceisturnedoff.
spring.artemis.embedded.enabled=true#EnableembeddedmodeiftheArtemisserverAPIsareavailable.
spring.artemis.embedded.persistent=false#Enablepersistentstore.
spring.artemis.embedded.queues=#Commaseparatedlistofqueuestocreateonstartup.
spring.artemis.embedded.serverid=#Serverid.Bydefault,anautoincrementedcounterisused.
spring.artemis.embedded.topics=#Commaseparatedlistoftopicstocreateonstartup.
spring.artemis.host=localhost#Artemisbrokerhost.
spring.artemis.mode=#Artemisdeploymentmode,autodetectedbydefault.
spring.artemis.password=#Loginpasswordofthebroker.
spring.artemis.port=61616#Artemisbrokerport.
spring.artemis.user=#Loginuserofthebroker.
#SPRINGBATCH(BatchProperties)
spring.batch.initializer.enabled=#Createtherequiredbatchtablesonstartupifnecessary.Enabledautomaticallyifnocustomtabl
spring.batch.job.enabled=true#ExecuteallSpringBatchjobsinthecontextonstartup.
spring.batch.job.names=#Commaseparatedlistofjobnamestoexecuteonstartup(Forinstance`job1,job2`).Bydefault,allJobsfo
spring.batch.schema=classpath:org/springframework/batch/core/schema@@platform@@.sql#PathtotheSQLfiletousetoinitializethe
spring.batch.tableprefix=#Tableprefixforallthebatchmetadatatables.
#JMS(JmsProperties)
spring.jms.jndiname=#ConnectionfactoryJNDIname.Whenset,takesprecedencetoothersconnectionfactoryautoconfigurations.
spring.jms.listener.acknowledgemode=#Acknowledgemodeofthecontainer.Bydefault,thelisteneristransactedwithautomaticackn
spring.jms.listener.autostartup=true#Startthecontainerautomaticallyonstartup.
spring.jms.listener.concurrency=#Minimumnumberofconcurrentconsumers.
spring.jms.listener.maxconcurrency=#Maximumnumberofconcurrentconsumers.
spring.jms.pubsubdomain=false#Specifyifthedefaultdestinationtypeistopic.
spring.jms.template.defaultdestination=#Defaultdestinationtouseonsend/receiveoperationsthatdonothaveadestinationparam
spring.jms.template.deliverydelay=#Deliverydelaytouseforsendcallsinmilliseconds.
spring.jms.template.deliverymode=#Deliverymode.EnableQoSwhenset.
spring.jms.template.priority=#Priorityofamessagewhensending.EnableQoSwhenset.
spring.jms.template.qosenabled=#EnableexplicitQoSwhensendingamessage.
spring.jms.template.receivetimeout=#Timeouttouseforreceivecallsinmilliseconds.
spring.jms.template.timetolive=#Timetoliveofamessagewhensendinginmilliseconds.EnableQoSwhenset.
#APACHEKAFKA(KafkaProperties)
spring.kafka.bootstrapservers=#Commadelimitedlistofhost:portpairstouseforestablishingtheinitialconnectiontotheKafka
spring.kafka.clientid=#Idtopasstotheserverwhenmakingrequests;usedforserversidelogging.
spring.kafka.consumer.autocommitinterval=#FrequencyinmillisecondsthattheconsumeroffsetsareautocommittedtoKafkaif'ena
spring.kafka.consumer.autooffsetreset=#WhattodowhenthereisnoinitialoffsetinKafkaorifthecurrentoffsetdoesnotexis
spring.kafka.consumer.bootstrapservers=#Commadelimitedlistofhost:portpairstouseforestablishingtheinitialconnectionto
spring.kafka.consumer.clientid=#Idtopasstotheserverwhenmakingrequests;usedforserversidelogging.
spring.kafka.consumer.enableautocommit=#Iftruetheconsumer'soffsetwillbeperiodicallycommittedinthebackground.
spring.kafka.consumer.fetchmaxwait=#Maximumamountoftimeinmillisecondstheserverwillblockbeforeansweringthefetchreque
spring.kafka.consumer.fetchminsize=#Minimumamountofdatatheservershouldreturnforafetchrequestinbytes.
spring.kafka.consumer.groupid=#Uniquestringthatidentifiestheconsumergroupthisconsumerbelongsto.
spring.kafka.consumer.heartbeatinterval=#Expectedtimeinmillisecondsbetweenheartbeatstotheconsumercoordinator.
spring.kafka.consumer.keydeserializer=#Deserializerclassforkeys.
spring.kafka.consumer.maxpollrecords=#Maximumnumberofrecordsreturnedinasinglecalltopoll().
spring.kafka.consumer.valuedeserializer=#Deserializerclassforvalues.
spring.kafka.listener.ackcount=#NumberofrecordsbetweenoffsetcommitswhenackModeis"COUNT"or"COUNT_TIME".
spring.kafka.listener.ackmode=#ListenerAckMode;seethespringkafkadocumentation.
spring.kafka.listener.acktime=#TimeinmillisecondsbetweenoffsetcommitswhenackModeis"TIME"or"COUNT_TIME".
spring.kafka.listener.concurrency=#Numberofthreadstoruninthelistenercontainers.
spring.kafka.listener.polltimeout=#Timeoutinmillisecondstousewhenpollingtheconsumer.
spring.kafka.producer.acks=#Numberofacknowledgmentstheproducerrequirestheleadertohavereceivedbeforeconsideringareques
spring.kafka.producer.batchsize=#Numberofrecordstobatchbeforesending.
spring.kafka.producer.bootstrapservers=#Commadelimitedlistofhost:portpairstouseforestablishingtheinitialconnectionto
spring.kafka.producer.buffermemory=#Totalbytesofmemorytheproducercanusetobufferrecordswaitingtobesenttotheserver.
spring.kafka.producer.clientid=#Idtopasstotheserverwhenmakingrequests;usedforserversidelogging.
spring.kafka.producer.compressiontype=#Compressiontypeforalldatageneratedbytheproducer.
spring.kafka.producer.keyserializer=#Serializerclassforkeys.
spring.kafka.producer.retries=#Whengreaterthanzero,enablesretryingoffailedsends.
spring.kafka.producer.valueserializer=#Serializerclassforvalues.
spring.kafka.properties.*=#Additionalpropertiesusedtoconfiguretheclient.
spring.kafka.ssl.keypassword=#Passwordoftheprivatekeyinthekeystorefile.
spring.kafka.ssl.keystorelocation=#Locationofthekeystorefile.
spring.kafka.ssl.keystorepassword=#Storepasswordforthekeystorefile.
spring.kafka.ssl.truststorelocation=#Locationofthetruststorefile.
spring.kafka.ssl.truststorepassword=#Storepasswordforthetruststorefile.
spring.kafka.template.defaulttopic=#Defaulttopictowhichmessageswillbesent.
#RABBIT(RabbitProperties)
spring.rabbitmq.addresses=#Commaseparatedlistofaddressestowhichtheclientshouldconnect.
spring.rabbitmq.cache.channel.checkouttimeout=#Numberofmillisecondstowaittoobtainachannelifthecachesizehasbeenreach
spring.rabbitmq.cache.channel.size=#Numberofchannelstoretaininthecache.
spring.rabbitmq.cache.connection.mode=channel#Connectionfactorycachemode.
spring.rabbitmq.cache.connection.size=#Numberofconnectionstocache.
spring.rabbitmq.connectiontimeout=#Connectiontimeout,inmilliseconds;zeroforinfinite.
spring.rabbitmq.dynamic=true#CreateanAmqpAdminbean.
spring.rabbitmq.host=localhost#RabbitMQhost.
spring.rabbitmq.listener.acknowledgemode=#Acknowledgemodeofcontainer.
spring.rabbitmq.listener.autostartup=true#Startthecontainerautomaticallyonstartup.
spring.rabbitmq.listener.concurrency=#Minimumnumberofconsumers.
spring.rabbitmq.listener.defaultrequeuerejected=#Whetherornottorequeuedeliveryfailures;default`true`.
spring.rabbitmq.listener.idleeventinterval=#Howoftenidlecontainereventsshouldbepublishedinmilliseconds.
spring.rabbitmq.listener.maxconcurrency=#Maximumnumberofconsumers.
spring.rabbitmq.listener.prefetch=#Numberofmessagestobehandledinasinglerequest.Itshouldbegreaterthanorequaltothe
spring.rabbitmq.listener.retry.enabled=false#Whetherornotpublishingretriesareenabled.
spring.rabbitmq.listener.retry.initialinterval=1000#Intervalbetweenthefirstandsecondattempttodeliveramessage.
spring.rabbitmq.listener.retry.maxattempts=3#Maximumnumberofattemptstodeliveramessage.
spring.rabbitmq.listener.retry.maxinterval=10000#Maximumintervalbetweenattempts.
spring.rabbitmq.listener.retry.multiplier=1.0#Amultipliertoapplytothepreviousdeliveryretryinterval.
spring.rabbitmq.listener.retry.stateless=true#Whetherornotretryisstatelessorstateful.
spring.rabbitmq.listener.transactionsize=#Numberofmessagestobeprocessedinatransaction.Forbestresultsitshouldbeless
spring.rabbitmq.password=#Logintoauthenticateagainstthebroker.
spring.rabbitmq.port=5672#RabbitMQport.
spring.rabbitmq.publisherconfirms=false#Enablepublisherconfirms.
spring.rabbitmq.publisherreturns=false#Enablepublisherreturns.
spring.rabbitmq.requestedheartbeat=#Requestedheartbeattimeout,inseconds;zerofornone.
spring.rabbitmq.ssl.enabled=false#EnableSSLsupport.
spring.rabbitmq.ssl.keystore=#PathtothekeystorethatholdstheSSLcertificate.
spring.rabbitmq.ssl.keystorepassword=#Passwordusedtoaccessthekeystore.
spring.rabbitmq.ssl.truststore=#TruststorethatholdsSSLcertificates.
spring.rabbitmq.ssl.truststorepassword=#Passwordusedtoaccessthetruststore.
spring.rabbitmq.ssl.algorithm=#SSLalgorithmtouse.Bydefaultconfigurebytherabbitclientlibrary.
spring.rabbitmq.template.mandatory=false#Enablemandatorymessages.
spring.rabbitmq.template.receivetimeout=0#Timeoutfor`receive()`methods.
spring.rabbitmq.template.replytimeout=5000#Timeoutfor`sendAndReceive()`methods.
spring.rabbitmq.template.retry.enabled=false#Settotruetoenableretriesinthe`RabbitTemplate`.
spring.rabbitmq.template.retry.initialinterval=1000#Intervalbetweenthefirstandsecondattempttopublishamessage.
spring.rabbitmq.template.retry.maxattempts=3#Maximumnumberofattemptstopublishamessage.
spring.rabbitmq.template.retry.maxinterval=10000#Maximumnumberofattemptstopublishamessage.
spring.rabbitmq.template.retry.multiplier=1.0#Amultipliertoapplytothepreviouspublishingretryinterval.
spring.rabbitmq.username=#Loginusertoauthenticatetothebroker.
spring.rabbitmq.virtualhost=#Virtualhosttousewhenconnectingtothebroker.
#
#ACTUATORPROPERTIES
#
#ENDPOINTS(AbstractEndpointsubclasses)
endpoints.enabled=true#Enableendpoints.
endpoints.sensitive=#Defaultendpointsensitivesetting.
endpoints.actuator.enabled=true#Enabletheendpoint.
endpoints.actuator.path=#EndpointURLpath.
endpoints.actuator.sensitive=false#Enablesecurityontheendpoint.
endpoints.auditevents.enabled=#Enabletheendpoint.
endpoints.auditevents.path=#Endpointpath.
endpoints.auditevents.sensitive=false#Enablesecurityontheendpoint.
endpoints.autoconfig.enabled=#Enabletheendpoint.
endpoints.autoconfig.id=#Endpointidentifier.
endpoints.autoconfig.path=#Endpointpath.
endpoints.autoconfig.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.beans.enabled=#Enabletheendpoint.
endpoints.beans.id=#Endpointidentifier.
endpoints.beans.path=#Endpointpath.
endpoints.beans.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.configprops.enabled=#Enabletheendpoint.
endpoints.configprops.id=#Endpointidentifier.
endpoints.configprops.keystosanitize=password,secret,key,token,.*credentials.*,vcap_services#Keysthatshouldbesanitized.Keys
endpoints.configprops.path=#Endpointpath.
endpoints.configprops.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.docs.curies.enabled=false#Enablethecuriegeneration.
endpoints.docs.enabled=true#Enableactuatordocsendpoint.
endpoints.docs.path=/docs#
endpoints.docs.sensitive=false#
endpoints.dump.enabled=#Enabletheendpoint.
endpoints.dump.id=#Endpointidentifier.
endpoints.dump.path=#Endpointpath.
endpoints.dump.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.env.enabled=#Enabletheendpoint.
endpoints.env.id=#Endpointidentifier.
endpoints.env.keystosanitize=password,secret,key,token,.*credentials.*,vcap_services#Keysthatshouldbesanitized.Keyscanbes
endpoints.env.path=#Endpointpath.
endpoints.env.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.flyway.enabled=#Enabletheendpoint.
endpoints.flyway.id=#Endpointidentifier.
endpoints.flyway.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.health.enabled=#Enabletheendpoint.
endpoints.health.id=#Endpointidentifier.
endpoints.health.mapping.*=#MappingofhealthstatusestoHttpStatuscodes.Bydefault,registeredhealthstatusesmaptosensible
endpoints.health.path=#Endpointpath.
endpoints.health.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.health.timetolive=1000#Timetoliveforcachedresult,inmilliseconds.
endpoints.heapdump.enabled=#Enabletheendpoint.
endpoints.heapdump.path=#Endpointpath.
endpoints.heapdump.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.hypermedia.enabled=false#Enablehypermediasupportforendpoints.
endpoints.info.enabled=#Enabletheendpoint.
endpoints.info.id=#Endpointidentifier.
endpoints.info.path=#Endpointpath.
endpoints.info.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.jolokia.enabled=true#EnableJolokiaendpoint.
endpoints.jolokia.path=/jolokia#EndpointURLpath.
endpoints.jolokia.sensitive=true#Enablesecurityontheendpoint.
endpoints.liquibase.enabled=#Enabletheendpoint.
endpoints.liquibase.id=#Endpointidentifier.
endpoints.liquibase.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.logfile.enabled=true#Enabletheendpoint.
endpoints.logfile.externalfile=#ExternalLogfiletobeaccessed.
endpoints.logfile.path=/logfile#EndpointURLpath.
endpoints.logfile.sensitive=true#Enablesecurityontheendpoint.
endpoints.loggers.enabled=true#Enabletheendpoint.
endpoints.loggers.id=#Endpointidentifier.
endpoints.loggers.path=/logfile#Endpointpath.
endpoints.loggers.sensitive=true#Markiftheendpointexposessensitiveinformation.
endpoints.mappings.enabled=#Enabletheendpoint.
endpoints.mappings.id=#Endpointidentifier.
endpoints.mappings.path=#Endpointpath.
endpoints.mappings.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.metrics.enabled=#Enabletheendpoint.
endpoints.metrics.filter.enabled=true#Enablethemetricsservletfilter.
endpoints.metrics.filter.gaugesubmissions=merged#Httpfiltergaugesubmissions(merged,perhttpmethod)
endpoints.metrics.filter.countersubmissions=merged#Httpfiltercountersubmissions(merged,perhttpmethod)
endpoints.metrics.id=#Endpointidentifier.
endpoints.metrics.path=#Endpointpath.
endpoints.metrics.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.shutdown.enabled=#Enabletheendpoint.
endpoints.shutdown.id=#Endpointidentifier.
endpoints.shutdown.path=#Endpointpath.
endpoints.shutdown.sensitive=#Markiftheendpointexposessensitiveinformation.
endpoints.trace.enabled=#Enabletheendpoint.
endpoints.trace.id=#Endpointidentifier.
endpoints.trace.path=#Endpointpath.
endpoints.trace.sensitive=#Markiftheendpointexposessensitiveinformation.
#ENDPOINTSCORSCONFIGURATION(EndpointCorsProperties)
endpoints.cors.allowcredentials=#Setwhethercredentialsaresupported.Whennotset,credentialsarenotsupported.
endpoints.cors.allowedheaders=#Commaseparatedlistofheaderstoallowinarequest.'*'allowsallheaders.
endpoints.cors.allowedmethods=GET#Commaseparatedlistofmethodstoallow.'*'allowsallmethods.
endpoints.cors.allowedorigins=#Commaseparatedlistoforiginstoallow.'*'allowsallorigins.Whennotset,CORSsupportisdis
endpoints.cors.exposedheaders=#Commaseparatedlistofheaderstoincludeinaresponse.
endpoints.cors.maxage=1800#Howlong,inseconds,theresponsefromapreflightrequestcanbecachedbyclients.
#JMXENDPOINT(EndpointMBeanExportProperties)
endpoints.jmx.domain=#JMXdomainname.Initializedwiththevalueof'spring.jmx.defaultdomain'ifset.
endpoints.jmx.enabled=true#EnableJMXexportofallendpoints.
endpoints.jmx.staticnames=#AdditionalstaticpropertiestoappendtoallObjectNamesofMBeansrepresentingEndpoints.
endpoints.jmx.uniquenames=false#EnsurethatObjectNamesaremodifiedincaseofconflict.
#JOLOKIA(JolokiaProperties)
jolokia.config.*=#SeeJolokiamanual
#MANAGEMENTHTTPSERVER(ManagementServerProperties)
management.addapplicationcontextheader=true#Addthe"XApplicationContext"HTTPheaderineachresponse.
management.address=#Networkaddressthatthemanagementendpointsshouldbindto.
management.contextpath=#Managementendpointcontextpath.Forinstance`/actuator`
management.cloudfoundry.enabled=#EnableextendedCloudFoundryactuatorendpoints
management.cloudfoundry.skipsslvalidation=#SkipSSLverificationforCloudFoundryactuatorendpointsecuritycalls
management.port=#ManagementendpointHTTPport.Usesthesameportastheapplicationbydefault.Configureadifferentporttouse
management.security.enabled=true#Enablesecurity.
management.security.roles=ACTUATOR#Commaseparatedlistofrolesthatcanaccessthemanagementendpoint.
management.security.sessions=stateless#Sessioncreatingpolicytouse(always,never,if_required,stateless).
management.ssl.ciphers=#SupportedSSLciphers.Requiresacustommanagement.port.
management.ssl.clientauth=#Whetherclientauthenticationiswanted("want")orneeded("need").Requiresatruststore.Requiresa
management.ssl.enabled=#EnableSSLsupport.Requiresacustommanagement.port.
management.ssl.enabledprotocols=#EnabledSSLprotocols.Requiresacustommanagement.port.
management.ssl.keyalias=#Aliasthatidentifiesthekeyinthekeystore.Requiresacustommanagement.port.
management.ssl.keypassword=#Passwordusedtoaccessthekeyinthekeystore.Requiresacustommanagement.port.
management.ssl.keystore=#PathtothekeystorethatholdstheSSLcertificate(typicallyajksfile).Requiresacustommanagement
management.ssl.keystorepassword=#Passwordusedtoaccessthekeystore.Requiresacustommanagement.port.
management.ssl.keystoreprovider=#Providerforthekeystore.Requiresacustommanagement.port.
management.ssl.keystoretype=#Typeofthekeystore.Requiresacustommanagement.port.
management.ssl.protocol=TLS#SSLprotocoltouse.Requiresacustommanagement.port.
management.ssl.truststore=#TruststorethatholdsSSLcertificates.Requiresacustommanagement.port.
management.ssl.truststorepassword=#Passwordusedtoaccessthetruststore.Requiresacustommanagement.port.
management.ssl.truststoreprovider=#Providerforthetruststore.Requiresacustommanagement.port.
management.ssl.truststoretype=#Typeofthetruststore.Requiresacustommanagement.port.
#HEALTHINDICATORS
management.health.db.enabled=true#Enabledatabasehealthcheck.
management.health.cassandra.enabled=true#Enablecassandrahealthcheck.
management.health.couchbase.enabled=true#Enablecouchbasehealthcheck.
management.health.defaults.enabled=true#Enabledefaulthealthindicators.
management.health.diskspace.enabled=true#Enablediskspacehealthcheck.
management.health.diskspace.path=#Pathusedtocomputetheavailablediskspace.
management.health.diskspace.threshold=0#Minimumdiskspacethatshouldbeavailable,inbytes.
management.health.elasticsearch.enabled=true#Enableelasticsearchhealthcheck.
management.health.elasticsearch.indices=#Commaseparatedindexnames.
management.health.elasticsearch.responsetimeout=100#Thetime,inmilliseconds,towaitforaresponsefromthecluster.
management.health.jms.enabled=true#EnableJMShealthcheck.
management.health.ldap.enabled=true#EnableLDAPhealthcheck.
management.health.mail.enabled=true#EnableMailhealthcheck.
management.health.mongo.enabled=true#EnableMongoDBhealthcheck.
management.health.rabbit.enabled=true#EnableRabbitMQhealthcheck.
management.health.redis.enabled=true#EnableRedishealthcheck.
management.health.solr.enabled=true#EnableSolrhealthcheck.
management.health.status.order=DOWN,OUT_OF_SERVICE,UP,UNKNOWN#Commaseparatedlistofhealthstatusesinorderofseverity.
#INFOCONTRIBUTORS(InfoContributorProperties)
management.info.build.enabled=true#Enablebuildinfo.
management.info.defaults.enabled=true#Enabledefaultinfocontributors.
management.info.env.enabled=true#Enableenvironmentinfo.
management.info.git.enabled=true#Enablegitinfo.
management.info.git.mode=simple#Modetousetoexposegitinformation.
#TRACING(TraceProperties)
management.trace.include=requestheaders,responseheaders,cookies,errors#Itemstobeincludedinthetrace.
#METRICSEXPORT(MetricExportProperties)
spring.metrics.export.aggregate.keypattern=#Patternthattellstheaggregatorwhattodowiththekeysfromthesourcerepository.
spring.metrics.export.aggregate.prefix=#Prefixforglobalrepositoryifactive.
spring.metrics.export.delaymillis=5000#Delayinmillisecondsbetweenexportticks.Metricsareexportedtoexternalsourcesonas
spring.metrics.export.enabled=true#Flagtoenablemetricexport(assumingaMetricWriterisavailable).
spring.metrics.export.excludes=#Listofpatternsformetricnamestoexclude.Appliedaftertheincludes.
spring.metrics.export.includes=#Listofpatternsformetricnamestoinclude.
spring.metrics.export.redis.key=keys.spring.metrics#Keyforredisrepositoryexport(ifactive).
spring.metrics.export.redis.prefix=spring.metrics#Prefixforredisrepositoryifactive.
spring.metrics.export.sendlatest=#Flagtoswitchoffanyavailableoptimizationsbasedonnotexportingunchangedmetricvalues.
spring.metrics.export.statsd.host=#Hostofastatsdservertoreceiveexportedmetrics.
spring.metrics.export.statsd.port=8125#Portofastatsdservertoreceiveexportedmetrics.
spring.metrics.export.statsd.prefix=#Prefixforstatsdexportedmetrics.
spring.metrics.export.triggers.*=#SpecifictriggerpropertiesperMetricWriterbeanname.
#
#DEVTOOLSPROPERTIES
#
#DEVTOOLS(DevToolsProperties)
spring.devtools.livereload.enabled=true#Enablealivereload.comcompatibleserver.
spring.devtools.livereload.port=35729#Serverport.
spring.devtools.restart.additionalexclude=#Additionalpatternsthatshouldbeexcludedfromtriggeringafullrestart.
spring.devtools.restart.additionalpaths=#Additionalpathstowatchforchanges.
spring.devtools.restart.enabled=true#Enableautomaticrestart.
spring.devtools.restart.exclude=METAINF/maven/**,METAINF/resources/**,resources/**,static/**,public/**,templates/**,**/*Test.class,
spring.devtools.restart.pollinterval=1000#Amountoftime(inmilliseconds)towaitbetweenpollingforclasspathchanges.
spring.devtools.restart.quietperiod=400#Amountofquiettime(inmilliseconds)requiredwithoutanyclasspathchangesbeforeares
spring.devtools.restart.triggerfile=#Nameofaspecificfilethatwhenchangedwilltriggertherestartcheck.Ifnotspecifiedan
#REMOTEDEVTOOLS(RemoteDevToolsProperties)
spring.devtools.remote.contextpath=/.~~springboot!~#Contextpathusedtohandletheremoteconnection.
spring.devtools.remote.debug.enabled=true#Enableremotedebugsupport.
spring.devtools.remote.debug.localport=8000#Localremotedebugserverport.
spring.devtools.remote.proxy.host=#Thehostoftheproxytousetoconnecttotheremoteapplication.
spring.devtools.remote.proxy.port=#Theportoftheproxytousetoconnecttotheremoteapplication.
spring.devtools.remote.restart.enabled=true#Enableremoterestart.
spring.devtools.remote.secret=#Asharedsecretrequiredtoestablishaconnection(requiredtoenableremotesupport).
spring.devtools.remote.secretheadername=XAUTHTOKEN#HTTPheaderusedtotransferthesharedsecret.
#
#TESTINGPROPERTIES
#
spring.test.database.replace=any#TypeofexistingDataSourcetoreplace.
spring.test.mockmvc.print=default#MVCPrintoption.
AppendixB.Conguration meta-data
Spring Boot jars are shipped with meta-data les that provide details of all supported conguration properties. The les are designed to allow
IDE developers to offer contextual help and code completion as users are working with application.properties or application.yml
les.
The majority of the meta-data le is generated automatically at compile time by processing all items annotated with
@ConfigurationProperties . However, it is possible to write part of the meta-data manually for corner cases or more advanced use cases.
B.1Meta-data format
Conguration meta-data les are located inside jars under METAINF/springconfigurationmetadata.json They use a simple JSON
format with items categorized under either groups or properties and additional values hint categorized under "hints":
{"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.servlet.path",
"type":"java.lang.String",
"sourceType":"org.springframework.boot.autoconfigure.web.ServerProperties",
"defaultValue":"/"
},
{
"name":"spring.jpa.hibernate.ddlauto",
"type":"java.lang.String",
"description":"DDLmode.Thisisactuallyashortcutforthe\"hibernate.hbm2ddl.auto\"property.",
"sourceType":"org.springframework.boot.autoconfigure.orm.jpa.JpaProperties$Hibernate"
}
...
],"hints":[
{
"name":"spring.jpa.hibernate.ddlauto",
"values":[
{
"value":"none",
"description":"DisableDDLhandling."
},
{
"value":"validate",
"description":"Validatetheschema,makenochangestothedatabase."
},
{
"value":"update",
"description":"Updatetheschemaifnecessary."
},
{
"value":"create",
"description":"Createtheschemaanddestroypreviousdata."
},
{
"value":"createdrop",
"description":"Createandthendestroytheschemaattheendofthesession."
}
]
}
]}
Each property is a conguration item that the user species with a given value. For example server.port and server.servlet.path
might be specied in application.properties as follows:
server.port=9090
server.servlet.path=/home
The groups are higher level items that dont themselves specify a value, but instead provide a contextual grouping for properties. For example
the server.port and server.servlet.path properties are part of the server group.
It is not required that every property has a group, some properties might just exist in their own right.
Finally, hints are additional information used to assist the user in conguring a given property. When conguring the
spring.jpa.hibernate.ddlauto property, a tool can use it to offer some auto-completion help for the none , validate , update ,
create and createdrop values.
B.1.1Group Attributes
The JSON object contained in the groups array can contain the following attributes:
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 was based on a class annotated with
@ConfigurationProperties the attribute would contain the fully qualied name of that class. If it was based
on a @Bean method, it would be the return type of that method. The attribute may be omitted if the type is not
known.
description String A short description of the group that can be displayed to users. May be omitted if no description is available. It
is recommended that descriptions are a short paragraphs, with the rst 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 was based on a @Bean
method annotated with @ConfigurationProperties this attribute would contain the fully qualied name of
the @Configuration class containing the method. The attribute may be omitted if the source type is not
known.
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. May be omitted if the
source method is not known.
B.1.2Property Attributes
The JSON object contained in the properties array can contain the following attributes:
Name Type Purpose
name String The full name of the property. Names are in lowercase dashed form (e.g. server.servlet.path ).
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.util.String,acme.MyEnum> . This attribute can be used
to guide the user as to the types of values that they can enter. For consistency, the type of a primitive is
specied using its wrapper counterpart, i.e. boolean becomes java.lang.Boolean . Note that this
class may be a complex type that gets converted from a String as values are bound. May be omitted if
the type is not known.
description String A short description of the group that can be displayed to users. May be omitted if no description is
available. It is recommended that descriptions are a short paragraphs, with the rst line providing a
concise summary. The last line in the description should end with a period ( . ).
Name Type Purpose
sourceType String The class name of the source that contributed this property. For example, if the property was from a
class annotated with @ConfigurationProperties this attribute would contain the fully qualied name
of that class. May be omitted if the source type is not known.
defaultValue Object The default value which will be used if the property is not specied. Can also be an array of value(s) if
the type of the property is an array. May be omitted if the default value is not known.
deprecation Deprecation Specify if the property is deprecated. May be omitted if the eld is not deprecated or if that information is
not known. See below for more details.
The JSON object contained in the deprecation attribute of each properties element can contain the following attributes:
Name Type Purpose
reason String A short description of the reason why the property was deprecated. May be omitted if no reason is available. It
replacement String The full name of the property that is replacing this deprecated property. May be omitted if there is no
replacement for this property.
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 no longer be used. If no reason and replacement are available, an empty
deprecation object should be set.
Deprecation can also be specied declaratively in code by adding the @DeprecatedConfigurationProperty annotation to the getter
exposing the deprecated property. For instance, lets assume the app.foo.target property was confusing and was renamed to
app.foo.name
@ConfigurationProperties("app.foo")
privateStringname;
publicStringgetName(){...}
publicvoidsetName(Stringname){...}
@DeprecatedConfigurationProperty(replacement="app.foo.name")
@Deprecated
publicStringgetTarget(){
returngetName();
}
@Deprecated
publicvoidsetTarget(Stringtarget){
setName(target);
}
}
The code above 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 meta-data will go away as
well.
B.1.3Hint Attributes
The JSON object contained in the hints array can contain the following attributes:
Name Type Purpose
name String The full name of the property that this hint refers to. Names are in lowercase dashed form (e.g.
server.servlet.path ). If the property refers to a map (e.g. system.contexts ) the hint either
applies to the keys of the map ( system.context.keys ) or the values ( system.context.values ).
This attribute is mandatory.
values ValueHint[] A list of valid values as dened by the ValueHint object (see below). Each entry denes the value and
may have a description
providers ValueProvider[] A list of providers as dened by the ValueProvider object (see below). Each entry denes 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 following attributes:
Name Type Purpose
value Object A valid value for the element to which the hint refers to. Can also be an array of value(s) if the type of the
property is an array. This attribute is mandatory.
description String A short description of the value that can be displayed to users. May be omitted if no description is available. It
The JSON object contained in the providers attribute of each hint element can contain the following attributes:
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 to.
parameters JSON Any additional parameter that the provider supports (check the documentation of the provider for more
object details).
B.1.4Repeated meta-data items

It is perfectly acceptable for property and group objects with the same name to appear multiple times within a meta-data le. For example,
you could bind two separate classes to the same prex, with each potentially offering overlap of property names. While this is not supposed to
be a frequent scenario, consumers of meta-data should take care to ensure that they support such scenarios.
B.2Providing manual hints

To improve the user experience and further assist the user in conguring a given property, you can provide additional meta-data that:
1. Describes the list of potential values for a property.

2. Associates a provider to attach a well-dened semantic to a property so that a tool can discover the list of potential values based on the
projects context.
B.2.1Value hint
The name attribute of each hint refers to the name of a property. In the initial example above, we provide 5 values for the
spring.jpa.hibernate.ddlauto property: none , validate , update , create and createdrop . 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 sufxes must be used to refer to the keys and the values respectively.
Lets assume a foo.contexts that maps magic String values to an integer:
privateMap<String,Integer>contexts;
//gettersandsetters
}
The magic values are foo and bar for instance. In order to offer additional content assistance for the keys, you could add the following to the
manual meta-data of the module:
{"hints":[
{
"name":"foo.contexts.keys",
"values":[
{
"value":"foo"
},
{
"value":"bar"
}
]
}
]}
Of course, you should have an Enum for those two values instead. This is by far the most effective approach to auto-completion if
your IDE supports it.
B.2.2Value provider
Providers are a powerful way of attaching semantics to a property. We dene in the section below the ofcial providers that you can use for your
own hints. Bare in mind however that your favorite IDE may implement some of these or none of them. It could eventually provide its own as
well.
As this is a new feature, IDE vendors will have to catch up with this new feature.
The table below summarizes the list of supported providers:
Name Description
any Permit any additional value to be provided.
classreference Auto-complete the classes available in the project. Usually constrained by a base class that is specied via
the target parameter.
handleas Handle the property as if it was dened by the type dened via the mandatory target parameter.
loggername Auto-complete valid logger names. Typically, package and class names available in the current project can
be auto-completed.
springbeanreference Auto-complete the available bean names in the current project. Usually constrained by a base class that is
specied via the target parameter.
springprofilename Auto-complete the available Spring prole names in the project.
No more than one provider can be active for a given property but you can specify several providers if they can all manage the
property in some ways. Make sure to place the most powerful provider rst as the IDE must use the rst one in the JSON section
it can handle. If no provider for a given property is supported, no special content assistance is provided either.
Any
The any provider permits any additional values to be provided. Regular value validation based on the property type should be applied if this is
supported.
This provider will be typically used if you have a list of values and any extra values are still to be considered as valid.
The example below offers on and off as auto-completion values for system.state ; any other value is also allowed:
{"hints":[
{
"name":"system.state",
"values":[
{
"value":"on"
},
{
"value":"off"
}
],
"providers":[
{
"name":"any"
}
]
}
]}
Class reference
The class-reference provider auto-completes classes available in the project. This provider supports these parameters:
Parameter Type Default Description

value
target String none The fully qualied name of the class that should be assignable to the chosen value. Typically used
( Class ) to lter 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 if only concrete classes are to be considered as valid candidates.
The meta-data snippet below corresponds to the standard server.servlet.jsp.classname property that denes the JspServlet class
name to use:
{"hints":[
{
"name":"server.servlet.jsp.classname",
"providers":[
{
"name":"classreference",
"parameters":{
"target":"javax.servlet.http.HttpServlet"
}
}
]
}
]}
Handle As
The handle-as provider allows you to 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 dont want your conguration classes to rely on classes that may not be on the classpath. This
provider supports these parameters:

value
target String none The fully qualied name of the type to consider for the property. This parameter is
( Class ) mandatory.
The following types can be used:
Any java.lang.Enum that lists the possible values for the property (By all means, try to dene the property with the Enum type instead as
no further hint should be required for the IDE to auto-complete the values).
java.nio.charset.Charset : auto-completion of charset/encoding values (e.g. UTF8 )
java.util.Locale : auto-completion of locales (e.g. en_US )
org.springframework.util.MimeType : auto-completion of content type values (e.g. text/plain )
org.springframework.core.io.Resource : auto-completion of Springs Resource abstraction to refer to a le on the lesystem or on the
classpath. (e.g. classpath:/foo.properties )
If multiple values can be provided, use a Collection or Array type to teach the IDE about it.
The meta-data snippet below corresponds to the standard liquibase.changelog property that denes 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 as we need to keep the original
String value to pass it to the Liquibase API.
{"hints":[
{
"name":"liquibase.changelog",
"providers":[
{
"name":"handleas",
"parameters":{
"target":"org.springframework.core.io.Resource"
}
}
]
}
]}
Logger name
The logger-name provider auto-completes valid logger names. Typically, package and class names available in the current project can be auto-
completed. Specic frameworks may have extra magic logger names that could be supported as well.
Since a logger name can be any arbitrary name, really, this provider should allow any value but could highlight valid packages and class names
that are not available in the projects classpath.
The meta-data snippet below corresponds to the standard logging.level property, keys are logger names and values correspond to the
standard log levels or any custom level:
{"hints":[
{
"name":"logging.level.keys",
"values":[
{
"value":"root",
"description":"Rootloggerusedtoassignthedefaultlogginglevel."
}
],
"providers":[
{
"name":"loggername"
}
]
},
{
"name":"logging.level.values",
"values":[
{
"value":"trace"
},
{
"value":"debug"
},
{
"value":"info"
},
{
"value":"warn"
},
{
"value":"error"
},
{
"value":"fatal"
},
{
"value":"off"
}
],
"providers":[
{
"name":"any"
}
]
}
]}
Spring bean reference

The spring-bean-reference provider auto-completes the beans that are dened in the conguration of the current project. This provider
supports these parameters:

value
target String none The fully qualied name of the bean class that should be assignable to the candidate. Typically
( Class ) used to lter out non candidate beans.
The meta-data snippet below corresponds to the standard spring.jmx.server property that denes the name of the MBeanServer bean to
use:
{"hints":[
{
"name":"spring.jmx.server",
"providers":[
{
"name":"springbeanreference",
"parameters":{
"target":"javax.management.MBeanServer"
}
}
]
}
]}
The binder is not aware of the meta-data so if you provide that hint, you will still need to transform the bean name into an actual
Bean reference using the ApplicationContext .
Spring prole name

The spring-prole-name provider auto-completes the Spring proles that are dened in the conguration of the current project.
The meta-data snippet below corresponds to the standard spring.profiles.active property that denes the name of the Spring prole(s) to
enable:
{"hints":[
{
"name":"spring.profiles.active",
"providers":[
{
"name":"springprofilename"
}
]
}
]}
B.3Generating your own meta-data using the annotation processor
You can easily generate your own conguration meta-data le from items annotated with @ConfigurationProperties by using the
springbootconfigurationprocessor jar. The jar includes a Java annotation processor which is invoked as your project is compiled. To
use the processor, simply include springbootconfigurationprocessor as an optional dependency, for example with Maven you would
add:
<dependency>
<artifactId>springbootconfigurationprocessor</artifactId>
<optional>true</optional>
</dependency>
With Gradle, you can use the propdeps-plugin and specify:
dependencies{
optional"org.springframework.boot:springbootconfigurationprocessor"
}
compileJava.dependsOn(processResources)
You need to add compileJava.dependsOn(processResources) to your build to ensure that resources are processed before
code is compiled. Without this directive any additionalspringconfigurationmetadata.json les will not be processed.
The processor will pick up both classes and methods that are annotated with @ConfigurationProperties . The Javadoc for eld values
within conguration classes will be used to populate the description attribute.
You should only use simple text with @ConfigurationProperties eld Javadoc since they are not processed before being
added to the JSON.
Properties are discovered via the presence of standard getters and setters with special handling for collection types (that will be detected even if
only a getter is present). The annotation processor also supports the use of the @Data , @Getter and @Setter lombok annotations.
If you are using AspectJ in your project, you need to make sure that the annotation processor only runs once. There are several
ways to do this: with Maven, you can congure the mavenaptplugin 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
mavencompilerplugin conguration:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>mavencompilerplugin</artifactId>
<configuration>
<proc>none</proc>
</configuration>
</plugin>
B.3.1Nested properties
The annotation processor will automatically consider inner classes as nested properties. For example, the following class:
@ConfigurationProperties(prefix="server")
publicclassServerProperties{
privateStringname;
privateHosthost;
//...getterandsetters
privatestaticclassHost{
privateStringip;
privateintport;
//...getterandsetters
}
Will produce meta-data information for server.name , server.host.ip and server.host.port properties. You can use the
@NestedConfigurationProperty annotation on a eld to indicate that a regular (non-inner) class should be treated as if it were nested.
B.3.2Adding additional meta-data

Spring Boots conguration le handling is quite exible; 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 allow you to
provide custom "hints", the annotation processor will automatically merge items from
METAINF/additionalspringconfigurationmetadata.json into the main meta-data le.
If you refer to a property that has been detected automatically, the description, default value and deprecation information are overridden if
specied. If the manual property declaration is not identied in the current module, it is added as a brand new property.
The format of the additionalspringconfigurationmetadata.json le is exactly the same as the regular

springconfigurationmetadata.json . The additional properties le is optional, if you dont have any additional properties, simply dont
add it.
AppendixC.Auto-conguration classes
Here is a list of all auto-conguration classes provided by Spring Boot with links to documentation and source code. Remember to also look at
the autocong report in your application for more details of which features are switched on. (start the app with debug or Ddebug , or in an
Actuator application use the autoconfig endpoint).
C.1From the spring-boot-autocongure module

The following auto-conguration classes are from the springbootautoconfigure module:
Conguration Class Links
ActiveMQAutoConfiguration javadoc
AopAutoConfiguration javadoc
ArtemisAutoConfiguration javadoc
BatchAutoConfiguration javadoc
CacheAutoConfiguration javadoc
CassandraAutoConfiguration javadoc
CassandraDataAutoConfiguration javadoc
CassandraRepositoriesAutoConfiguration javadoc
CloudAutoConfiguration javadoc
ConfigurationPropertiesAutoConfiguration javadoc
CouchbaseAutoConfiguration javadoc
CouchbaseDataAutoConfiguration javadoc
CouchbaseRepositoriesAutoConfiguration javadoc
DataSourceAutoConfiguration javadoc
DataSourceTransactionManagerAutoConfiguration javadoc
DeviceDelegatingViewResolverAutoConfiguration javadoc
DeviceResolverAutoConfiguration javadoc
DispatcherServletAutoConfiguration javadoc
ElasticsearchAutoConfiguration javadoc
ElasticsearchDataAutoConfiguration javadoc
ElasticsearchRepositoriesAutoConfiguration javadoc
EmbeddedLdapAutoConfiguration javadoc
EmbeddedMongoAutoConfiguration javadoc
EmbeddedServletContainerAutoConfiguration javadoc
ErrorMvcAutoConfiguration javadoc
FacebookAutoConfiguration javadoc
FallbackWebSecurityAutoConfiguration javadoc
FlywayAutoConfiguration javadoc
FreeMarkerAutoConfiguration javadoc
GroovyTemplateAutoConfiguration javadoc
GsonAutoConfiguration javadoc
H2ConsoleAutoConfiguration javadoc
HazelcastAutoConfiguration javadoc
HazelcastJpaDependencyAutoConfiguration javadoc
HibernateJpaAutoConfiguration javadoc
HttpEncodingAutoConfiguration javadoc
HttpMessageConvertersAutoConfiguration javadoc
HypermediaAutoConfiguration javadoc
IntegrationAutoConfiguration javadoc
JacksonAutoConfiguration javadoc
JdbcTemplateAutoConfiguration javadoc
JerseyAutoConfiguration javadoc
JestAutoConfiguration javadoc
JmsAutoConfiguration javadoc
JmxAutoConfiguration javadoc
JndiConnectionFactoryAutoConfiguration javadoc
JndiDataSourceAutoConfiguration javadoc
JooqAutoConfiguration javadoc
JpaRepositoriesAutoConfiguration javadoc
JtaAutoConfiguration javadoc
KafkaAutoConfiguration javadoc
LdapAutoConfiguration javadoc
LdapDataAutoConfiguration javadoc
LdapRepositoriesAutoConfiguration javadoc
LinkedInAutoConfiguration javadoc
LiquibaseAutoConfiguration javadoc
MailSenderAutoConfiguration javadoc
MailSenderValidatorAutoConfiguration javadoc
MessageSourceAutoConfiguration javadoc
MongoAutoConfiguration javadoc
MongoDataAutoConfiguration javadoc
MongoRepositoriesAutoConfiguration javadoc
MultipartAutoConfiguration javadoc
MustacheAutoConfiguration javadoc
Neo4jDataAutoConfiguration javadoc
Neo4jRepositoriesAutoConfiguration javadoc
OAuth2AutoConfiguration javadoc
PersistenceExceptionTranslationAutoConfiguration javadoc
ProjectInfoAutoConfiguration javadoc
PropertyPlaceholderAutoConfiguration javadoc
RabbitAutoConfiguration javadoc
ReactiveMongoAutoConfiguration javadoc
ReactiveMongoDataAutoConfiguration javadoc
ReactiveMongoRepositoriesAutoConfiguration javadoc
ReactorCoreAutoConfiguration javadoc
RedisAutoConfiguration javadoc
RedisRepositoriesAutoConfiguration javadoc
RepositoryRestMvcAutoConfiguration javadoc
SecurityAutoConfiguration javadoc
SecurityFilterAutoConfiguration javadoc
SendGridAutoConfiguration javadoc
SessionAutoConfiguration javadoc
SitePreferenceAutoConfiguration javadoc
SocialWebAutoConfiguration javadoc
SolrAutoConfiguration javadoc
SolrRepositoriesAutoConfiguration javadoc
SpringApplicationAdminJmxAutoConfiguration javadoc
SpringDataWebAutoConfiguration javadoc
ThymeleafAutoConfiguration javadoc
TransactionAutoConfiguration javadoc
TwitterAutoConfiguration javadoc
ValidationAutoConfiguration javadoc
WebClientAutoConfiguration javadoc
WebMvcAutoConfiguration javadoc
WebServicesAutoConfiguration javadoc
WebSocketAutoConfiguration javadoc
WebSocketMessagingAutoConfiguration javadoc
XADataSourceAutoConfiguration javadoc
C.2From the spring-boot-actuator module

The following auto-conguration classes are from the springbootactuator module:
AuditAutoConfiguration javadoc
CacheStatisticsAutoConfiguration javadoc
CloudFoundryActuatorAutoConfiguration javadoc
EndpointAutoConfiguration javadoc
EndpointMBeanExportAutoConfiguration javadoc
EndpointWebMvcAutoConfiguration javadoc
HealthIndicatorAutoConfiguration javadoc
InfoContributorAutoConfiguration javadoc
JolokiaAutoConfiguration javadoc
ManagementWebSecurityAutoConfiguration javadoc
MetricExportAutoConfiguration javadoc
MetricFilterAutoConfiguration javadoc
MetricRepositoryAutoConfiguration javadoc
MetricsChannelAutoConfiguration javadoc
MetricsDropwizardAutoConfiguration javadoc
PublicMetricsAutoConfiguration javadoc
TraceRepositoryAutoConfiguration javadoc
TraceWebFilterAutoConfiguration javadoc
AppendixD.Test auto-conguration annotations

Here is a table of the various @Test annotations that can be used to test slices of your application and the auto-conguration that they import
by default:
Test slice Imported auto-conguration
@DataJpaTest org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration
org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration
org.springframework.boot.test.autoconfigure.jdbc.TestDatabaseAutoConfiguration
org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManagerAutoConfiguration
Test slice Imported auto-conguration
@DataMongoTest org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration
org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.data.mongo.ReactiveMongoDataAutoConfiguration
org.springframework.boot.autoconfigure.data.mongo.ReactiveMongoRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration
org.springframework.boot.autoconfigure.mongo.ReactiveMongoAutoConfiguration
org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration
@JdbcTest org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration
org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration
org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration
org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration
org.springframework.boot.test.autoconfigure.jdbc.TestDatabaseAutoConfiguration
@JsonTest org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration
org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration
org.springframework.boot.test.autoconfigure.json.JsonTestersAutoConfiguration
@RestClientTest org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration
org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration
org.springframework.boot.test.autoconfigure.web.client.MockRestServiceServerAutoConfiguration
org.springframework.boot.test.autoconfigure.web.client.WebClientRestTemplateAutoConfiguration
@WebMvcTest org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration
org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration
org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration
org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration
org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration
org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration
org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration
org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration
org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration
org.springframework.boot.test.autoconfigure.web.servlet.MockMvcAutoConfiguration
org.springframework.boot.test.autoconfigure.web.servlet.MockMvcSecurityAutoConfiguration
org.springframework.boot.test.autoconfigure.web.servlet.MockMvcWebClientAutoConfiguration
org.springframework.boot.test.autoconfigure.web.servlet.MockMvcWebDriverAutoConfiguration
AppendixE.The executable jar format

The springbootloader modules allows Spring Boot to support executable jar and war les. If youre using the Maven or Gradle plugin,
executable jars are automatically generated and you generally wont 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 section
provides some background.
E.1Nested JARs
Java does not provide any standard way to load nested jar les (i.e. jar les that are themselves contained within a jar). This can be problematic
if you are looking to distribute a self-contained application that you can just run from the command line without unpacking.
To solve this problem, many developers use shaded jars. A shaded jar simply 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 you are actually using in your application. It can also be problematic if
the same lename is used (but with different content) in multiple jars. Spring Boot takes a different approach and allows you to actually nest jars
directly.
E.1.1The executable jar le structure

Spring Boot Loader compatible jar les should be structured in the following way:
example.jar
|
+METAINF
|+MANIFEST.MF
+org
|+springframework
|+boot
|+loader
|+<springbootloaderclasses>
+BOOTINF
+classes
|+mycompany
|+project
|+YourClasses.class
+lib
+dependency1.jar
+dependency2.jar
Application classes should be placed in a nested BOOTINF/classes directory. Dependencies should be placed in a nested BOOTINF/lib
directory.
E.1.2The executable war le structure

Spring Boot Loader compatible war les should be structured in the following way:
example.war
|
+METAINF
|+MANIFEST.MF
+org
|+springframework
|+boot
|+loader
|+<springbootloaderclasses>
+WEBINF
+classes
|+com
|+mycompany
|+project
|+YourClasses.class
+lib
|+dependency1.jar
|+dependency2.jar
+libprovided
+servletapi.jar
+dependency3.jar
Dependencies should be placed in a nested WEBINF/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 WEBINF/libprovided .
E.2Spring Boots JarFile class

The core class used to support loading nested jars is org.springframework.boot.loader.jar.JarFile . It allows you to load jar content
from a standard jar le, or from nested child jar data. When rst loaded, the location of each JarEntry is mapped to a physical le offset of the
outer jar:
myapp.jar
+++
|/BOOTINF/classes|/BOOTINF/lib/mylib.jar|
|++||+++|
||A.class|||B.class|C.class||
|++||+++|
+++
^^^
006334523980
The example above shows how A.class can be found in /BOOTINF/classes in myapp.jar position 0063 . B.class from the nested jar
can actually be found in myapp.jar position 3452 and C.class is at position 3980 .
Armed with this information, we can load specic nested entries by simply seeking to the appropriate part of the outer jar. We dont need to
unpack the archive and we dont need to read all entry data into memory.
E.2.1Compatibility 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 will return a URL that opens a
java.net.JarURLConnection compatible connection and can be used with Javas URLClassLoader .
E.3Launching executable jars

The org.springframework.boot.loader.Launcher class is a special bootstrap class that is used as an executable jars main entry point. It
is the actual MainClass in your jar le and its used to setup an appropriate URLClassLoader and ultimately call your main() method.
There are 3 launcher subclasses ( JarLauncher , WarLauncher and PropertiesLauncher ). Their purpose is to load resources ( .class
les etc.) from nested jar les or war les in directories (as opposed to explicitly on the classpath). In the case of JarLauncher and
WarLauncher the nested paths are xed. JarLauncher looks in BOOTINF/lib/ and WarLauncher looks in WEBINF/lib/ and
WEBINF/libprovided/ so you just add extra jars in those locations if you want more. The PropertiesLauncher looks in BOOTINF/lib/
in your application archive by default, but you can add additional locations by setting an environment variable LOADER_PATH or loader.path
in application.properties (comma-separated list of directories or archives).
E.3.1Launcher manifest
You need to specify an appropriate Launcher as the MainClass attribute of METAINF/MANIFEST.MF . The actual class that you want to
launch (i.e. the class that you wrote that contains a main method) should be specied in the StartClass attribute.
For example, here is a typical MANIFEST.MF for an executable jar le:
MainClass:org.springframework.boot.loader.JarLauncher
StartClass:com.mycompany.project.MyApplication
For a war le, it would be:
MainClass:org.springframework.boot.loader.WarLauncher
StartClass:com.mycompany.project.MyApplication
You do not need to specify ClassPath entries in your manifest le, the classpath will be deduced from the nested jars.
E.3.2Exploded archives
Certain PaaS implementations may choose to unpack archives before they run. For example, Cloud Foundry operates in this way. You can run
an unpacked archive by simply starting the appropriate launcher:
$unzipqmyapp.jar
$javaorg.springframework.boot.loader.JarLauncher
E.4PropertiesLauncher Features
PropertiesLauncher has a few special features that can be enabled with external properties (System properties, environment variables,
manifest entries or application.properties ).
Key Purpose
loader.path Comma-separated Classpath, e.g. lib,${HOME}/app/lib . Earlier entries take precedence, just like a
regular classpath on the javac command line.
loader.home Location of additional properties le, e.g. /opt/app (defaults to ${user.dir} )
loader.args Default arguments for the main method (space separated)
loader.main Name of main class to launch, e.g. com.app.Application .
loader.config.name Name of properties le, e.g. loader (defaults to application ).
loader.config.location Path to properties le, e.g. classpath:loader.properties (defaults to application.properties ).
loader.system Boolean ag to indicate that all properties should be added to System properties (defaults to false )
When specied as environment variables or manifest entries, the following names should be used:
Key Manifest entry Environment variable
loader.path LoaderPath LOADER_PATH
loader.home LOADER_HOME
loader.args LoaderArgs LOADER_ARGS
loader.main StartClass LOADER_MAIN
loader.config.location LOADER_CONFIG_LOCATION
loader.system LOADER_SYSTEM
Build plugins automatically move the MainClass attribute to StartClass when the fat jar is built. If you are using that,
specify the name of the class to launch using the MainClass attribute and leave out StartClass .
loader.home is the directory location of an additional properties le (overriding the default) as long as loader.config.location is not
specied.
loader.path can contain directories (scanned recursively for jar and zip les), archive paths, or wildcard patterns (for the default JVM
behavior).
loader.path (if empty) defaults to BOOTINF/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 conguration is provided.
Placeholder replacement is done from System and environment variables plus the properties le itself on all values before use.
E.5Executable jar restrictions

There are a number of restrictions that you need to consider when working with a Spring Boot Loader packaged application.
E.5.1Zip entry compression

The ZipEntry for a nested jar must be saved 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 le itself can still be compressed, as can any other entries in the outer jar.
E.5.2System ClassLoader
Launched applications should use Thread.getContextClassLoader() when loading classes (most libraries and frameworks will do this by
default). Trying to load nested jar classes via ClassLoader.getSystemClassLoader() will fail. Please be aware that java.util.Logging
always uses the system classloader, for this reason you should consider a different logging implementation.
E.6Alternative single jar solutions

If the above restrictions mean that you cannot use Spring Boot Loader the following alternatives could be considered:
Maven Shade Plugin

JarClassLoader
OneJar
AppendixF.Dependency versions
The table below provides details of all of the dependency versions that are provided by Spring Boot in its CLI, Maven dependency management
and Gradle plugin. When you declare a dependency on one of these artifacts without declaring a version the version that is listed in the table
will be used.
Group ID Artifact ID Version
antlr antlr 2.7.7
biz.paluch.redis lettuce 5.0.0.Beta1
ch.qos.logback logbackaccess 1.1.9
ch.qos.logback logbackclassic 1.1.9
ch.qos.logback logbackcore 1.1.9
com.atomikos transactionsjdbc 3.9.3
com.atomikos transactionsjms 3.9.3
com.atomikos transactionsjta 3.9.3
com.couchbase.client couchbasespringcache 2.1.0
com.couchbase.client javaclient 2.4.1
com.datastax.cassandra cassandradrivercore 3.1.3
com.datastax.cassandra cassandradrivermapping 3.1.3
com.fasterxml classmate 1.3.3
com.fasterxml.jackson.core jacksonannotations 2.8.0
com.fasterxml.jackson.core jacksoncore 2.8.6
com.fasterxml.jackson.core jacksondatabind 2.8.6
com.fasterxml.jackson.dataformat jacksondataformatavro 2.8.6
com.fasterxml.jackson.dataformat jacksondataformatcbor 2.8.6
com.fasterxml.jackson.dataformat jacksondataformatcsv 2.8.6
com.fasterxml.jackson.dataformat jacksondataformatproperties 2.8.6
com.fasterxml.jackson.dataformat jacksondataformatprotobuf 2.8.6
com.fasterxml.jackson.dataformat jacksondataformatsmile 2.8.6
com.fasterxml.jackson.dataformat jacksondataformatxml 2.8.6
com.fasterxml.jackson.dataformat jacksondataformatyaml 2.8.6
com.fasterxml.jackson.datatype jacksondatatypeguava 2.8.6
com.fasterxml.jackson.datatype jacksondatatypehibernate3 2.8.6
com.fasterxml.jackson.datatype jacksondatatypehppc 2.8.6
com.fasterxml.jackson.datatype jacksondatatypejaxrs 2.8.6
com.fasterxml.jackson.datatype jacksondatatypejdk8 2.8.6
com.fasterxml.jackson.datatype jacksondatatypejoda 2.8.6
com.fasterxml.jackson.datatype jacksondatatypejsonorg 2.8.6
com.fasterxml.jackson.datatype jacksondatatypejsr310 2.8.6
com.fasterxml.jackson.datatype jacksondatatypejsr353 2.8.6
com.fasterxml.jackson.datatype jacksondatatypepcollections 2.8.6
com.fasterxml.jackson.jaxrs jacksonjaxrsbase 2.8.6
com.fasterxml.jackson.jaxrs jacksonjaxrscborprovider 2.8.6
com.fasterxml.jackson.jaxrs jacksonjaxrsjsonprovider 2.8.6
com.fasterxml.jackson.jaxrs jacksonjaxrssmileprovider 2.8.6
com.fasterxml.jackson.jaxrs jacksonjaxrsxmlprovider 2.8.6
com.fasterxml.jackson.jaxrs jacksonjaxrsyamlprovider 2.8.6
com.fasterxml.jackson.jr jacksonjrall 2.8.6
com.fasterxml.jackson.jr jacksonjrobjects 2.8.6
com.fasterxml.jackson.jr jacksonjrretrofit2 2.8.6
com.fasterxml.jackson.jr jacksonjrstree 2.8.6
com.fasterxml.jackson.module jacksonmoduleafterburner 2.8.6
com.fasterxml.jackson.module jacksonmoduleguice 2.8.6
com.fasterxml.jackson.module jacksonmodulejaxbannotations 2.8.6
com.fasterxml.jackson.module jacksonmodulejsonSchema 2.8.6
com.fasterxml.jackson.module jacksonmodulekotlin 2.8.6
com.fasterxml.jackson.module jacksonmodulemrbean 2.8.6
com.fasterxml.jackson.module jacksonmoduleosgi 2.8.6
com.fasterxml.jackson.module jacksonmoduleparameternames 2.8.6
com.fasterxml.jackson.module jacksonmoduleparanamer 2.8.6
com.fasterxml.jackson.module jacksonmodulescala_2.10 2.8.6
com.github.benmanes.caffeine caffeine 2.3.5
com.github.mxab.thymeleaf.extras thymeleafextrasdataattribute 2.0.1
com.google.appengine appengineapi1.0sdk 1.9.48
com.google.code.gson gson 2.8.0
com.googlecode.jsonsimple jsonsimple 1.1.1
com.h2database h2 1.4.193
com.hazelcast hazelcast 3.7.5
com.hazelcast hazelcastclient 3.7.5
com.hazelcast hazelcasthibernate52 1.1.3
com.hazelcast hazelcastspring 3.7.5
com.jayway.jsonpath jsonpath 2.2.0
com.jayway.jsonpath jsonpathassert 2.2.0
com.microsoft.sqlserver mssqljdbc 6.1.0.jre8
com.querydsl querydslapt 4.1.4
com.querydsl querydslcollections 4.1.4
com.querydsl querydslcore 4.1.4
com.querydsl querydsljpa 4.1.4
com.querydsl querydslmongodb 4.1.4
com.samskivert jmustache 1.13
com.sendgrid sendgridjava 2.2.2
com.sun.mail javax.mail 1.5.6
com.timgroup javastatsdclient 3.1.0
com.unboundid unboundidldapsdk 3.2.1
com.zaxxer HikariCP 2.5.1
commonsbeanutils commonsbeanutils 1.9.3
commonscodec commonscodec 1.10
commonscollections commonscollections 3.2.2
commonsdigester commonsdigester 2.1
commonspool commonspool 1.6
de.flapdoodle.embed de.flapdoodle.embed.mongo 1.50.5
dom4j dom4j 1.6.1
io.dropwizard.metrics metricscore 3.1.2
io.dropwizard.metrics metricsganglia 3.1.2
io.dropwizard.metrics metricsgraphite 3.1.2
io.dropwizard.metrics metricsservlets 3.1.2
io.netty nettyall 4.1.7.Final
io.netty nettybuffer 4.1.7.Final
io.netty nettycodecsocks 4.1.7.Final
io.netty nettycodecstomp 4.1.7.Final
io.netty nettycommon 4.1.7.Final
io.netty nettyhandlerproxy 4.1.7.Final
io.netty nettyresolverdns 4.1.7.Final
io.netty nettytransport 4.1.7.Final
io.netty nettytransportrxtx 4.1.7.Final
io.netty nettytransportsctp 4.1.7.Final
io.netty nettytransportudt 4.1.7.Final
io.projectreactor reactorcore 3.0.4.RELEASE
io.projectreactor.addons reactoradapter 3.0.4.RELEASE
io.projectreactor.addons reactorlogback 3.0.4.RELEASE
io.projectreactor.addons reactortest 3.0.4.RELEASE
io.projectreactor.ipc reactoripc 0.6.0.RELEASE
io.projectreactor.ipc reactornetty 0.6.0.RELEASE
io.reactivex rxjava 1.2.5
io.reactivex rxjavareactivestreams 1.2.1
io.reactivex.rxjava2 rxjava 2.0.4
io.searchbox jest 2.0.4
io.undertow undertowcore 1.4.8.Final
io.undertow undertowservlet 1.4.8.Final
io.undertow undertowwebsocketsjsr 1.4.8.Final
javax.cache cacheapi 1.0.0
javax.jms javax.jmsapi 2.0.1
javax.mail javax.mailapi 1.5.6
javax.servlet javax.servletapi 3.1.0
javax.servlet jstl 1.2
javax.transaction javax.transactionapi 1.2
javax.validation validationapi 1.1.0.Final
jaxen jaxen 1.1.6
jodatime jodatime 2.9.7
junit junit 4.12
mysql mysqlconnectorjava 5.1.40
net.bytebuddy bytebuddy 1.6.0
net.java.dev.jna jna 4.2.2
net.sf.ehcache ehcache 2.10.3
net.sourceforge.htmlunit htmlunit 2.21
net.sourceforge.jtds jtds 1.3.1
net.sourceforge.nekohtml nekohtml 1.9.22
nz.net.ultraq.thymeleaf thymeleaflayoutdialect 2.1.2
org.apache.activemq activemqamqp 5.14.3
org.apache.activemq activemqblueprint 5.14.3
org.apache.activemq activemqbroker 5.14.3
org.apache.activemq activemqcamel 5.14.3
org.apache.activemq activemqclient 5.14.3
org.apache.activemq activemqconsole 5.14.3
org.apache.activemq activemqhttp 5.14.3
org.apache.activemq activemqjaas 5.14.3
org.apache.activemq activemqjdbcstore 5.14.3
org.apache.activemq activemqjmspool 5.14.3
org.apache.activemq activemqkahadbstore 5.14.3
org.apache.activemq activemqkaraf 5.14.3
org.apache.activemq activemqleveldbstore 5.14.3
org.apache.activemq activemqlog4jappender 5.14.3
org.apache.activemq activemqmqtt 5.14.3
org.apache.activemq activemqopenwiregenerator 5.14.3
org.apache.activemq activemqopenwirelegacy 5.14.3
org.apache.activemq activemqosgi 5.14.3
org.apache.activemq activemqpartition 5.14.3
org.apache.activemq activemqpool 5.14.3
org.apache.activemq activemqra 5.14.3
org.apache.activemq activemqrun 5.14.3
org.apache.activemq activemqruntimeconfig 5.14.3
org.apache.activemq activemqshiro 5.14.3
org.apache.activemq activemqspring 5.14.3
org.apache.activemq activemqstomp 5.14.3
org.apache.activemq activemqweb 5.14.3
org.apache.activemq artemisamqpprotocol 1.5.2
org.apache.activemq artemiscommons 1.5.2
org.apache.activemq artemiscoreclient 1.5.2
org.apache.activemq artemisjmsclient 1.5.2
org.apache.activemq artemisjmsserver 1.5.2
org.apache.activemq artemisjournal 1.5.2
org.apache.activemq artemisnative 1.5.2
org.apache.activemq artemisselector 1.5.2
org.apache.activemq artemisserver 1.5.2
org.apache.activemq artemisserviceextensions 1.5.2
org.apache.commons commonsdbcp2 2.1.1
org.apache.commons commonspool2 2.4.2
org.apache.derby derby 10.13.1.1
org.apache.httpcomponents httpasyncclient 4.1.2
org.apache.httpcomponents httpclient 4.5.2
org.apache.httpcomponents httpcore 4.4.6
org.apache.httpcomponents httpmime 4.5.2
org.apache.logging.log4j log4j1.2api 2.7
org.apache.logging.log4j log4japi 2.7
org.apache.logging.log4j log4japiscala_2.10 2.7
org.apache.logging.log4j log4japiscala_2.11 2.7
org.apache.logging.log4j log4jcore 2.7
org.apache.logging.log4j log4jflumeng 2.7
org.apache.logging.log4j log4jiostreams 2.7
org.apache.logging.log4j log4jjcl 2.7
org.apache.logging.log4j log4jjmxgui 2.7
org.apache.logging.log4j log4jjul 2.7
org.apache.logging.log4j log4jliquibase 2.7
org.apache.logging.log4j log4jnosql 2.7
org.apache.logging.log4j log4jslf4jimpl 2.7
org.apache.logging.log4j log4jtaglib 2.7
org.apache.logging.log4j log4jweb 2.7
org.apache.solr solrsolrj 5.5.3
org.apache.tomcat tomcatjdbc 8.5.11
org.apache.tomcat tomcatjspapi 8.5.11
org.apache.tomcat.embed tomcatembedcore 8.5.11
org.apache.tomcat.embed tomcatembedel 8.5.11
org.apache.tomcat.embed tomcatembedjasper 8.5.11
org.apache.tomcat.embed tomcatembedwebsocket 8.5.11
org.aspectj aspectjrt 1.8.9
org.aspectj aspectjtools 1.8.9
org.aspectj aspectjweaver 1.8.9
org.assertj assertjcore 3.6.2
org.codehaus.btm btm 2.1.4
org.codehaus.groovy groovy 2.4.7
org.codehaus.groovy groovyall 2.4.7
org.codehaus.groovy groovyant 2.4.7
org.codehaus.groovy groovybsf 2.4.7
org.codehaus.groovy groovyconsole 2.4.7
org.codehaus.groovy groovydocgenerator 2.4.7
org.codehaus.groovy groovygroovydoc 2.4.7
org.codehaus.groovy groovygroovysh 2.4.7
org.codehaus.groovy groovyjmx 2.4.7
org.codehaus.groovy groovyjson 2.4.7
org.codehaus.groovy groovyjsr223 2.4.7
org.codehaus.groovy groovynio 2.4.7
org.codehaus.groovy groovyservlet 2.4.7
org.codehaus.groovy groovysql 2.4.7
org.codehaus.groovy groovyswing 2.4.7
org.codehaus.groovy groovytemplates 2.4.7
org.codehaus.groovy groovytest 2.4.7
org.codehaus.groovy groovytestng 2.4.7
org.codehaus.groovy groovyxml 2.4.7
org.codehaus.janino janino 2.7.8
org.eclipse.jetty apachejsp 9.4.1.v20170120
org.eclipse.jetty apachejstl 9.4.1.v20170120
org.eclipse.jetty jettyannotations 9.4.1.v20170120
org.eclipse.jetty jettyclient 9.4.1.v20170120
org.eclipse.jetty jettycontinuation 9.4.1.v20170120
org.eclipse.jetty jettydeploy 9.4.1.v20170120
org.eclipse.jetty jettyhttp 9.4.1.v20170120
org.eclipse.jetty jettyio 9.4.1.v20170120
org.eclipse.jetty jettyjmx 9.4.1.v20170120
org.eclipse.jetty jettyplus 9.4.1.v20170120
org.eclipse.jetty jettyproxy 9.4.1.v20170120
org.eclipse.jetty jettysecurity 9.4.1.v20170120
org.eclipse.jetty jettyserver 9.4.1.v20170120
org.eclipse.jetty jettyservlet 9.4.1.v20170120
org.eclipse.jetty jettyservlets 9.4.1.v20170120
org.eclipse.jetty jettyutil 9.4.1.v20170120
org.eclipse.jetty jettywebapp 9.4.1.v20170120
org.eclipse.jetty jettyxml 9.4.1.v20170120
org.eclipse.jetty.orbit javax.servlet.jsp 2.2.0.v201112011158
org.eclipse.jetty.websocket javaxwebsocketserverimpl 9.4.1.v20170120
org.eclipse.jetty.websocket websocketclient 9.4.1.v20170120
org.eclipse.jetty.websocket websocketserver 9.4.1.v20170120
org.ehcache ehcache 3.2.0
org.ehcache ehcacheclustered 3.2.0
org.ehcache ehcachetransactions 3.2.0
org.elasticsearch elasticsearch 2.4.4
org.firebirdsql.jdbc jaybirdjdk16 2.2.12
org.flywaydb flywaycore 4.0.3
org.freemarker freemarker 2.3.25-incubating
org.glassfish javax.el 3.0.0
org.glassfish.jersey.containers jerseycontainerservlet 2.25.1
org.glassfish.jersey.containers jerseycontainerservletcore 2.25.1
org.glassfish.jersey.core jerseyserver 2.25.1
org.glassfish.jersey.ext jerseybeanvalidation 2.25.1
org.glassfish.jersey.ext jerseyspring3 2.25.1
org.glassfish.jersey.media jerseymediajsonjackson 2.25.1
org.hamcrest hamcrestcore 1.3
org.hamcrest hamcrestlibrary 1.3
org.hibernate hibernatecore 5.2.7.Final
org.hibernate hibernateehcache 5.2.7.Final
org.hibernate hibernateentitymanager 5.2.7.Final
org.hibernate hibernateenvers 5.2.7.Final
org.hibernate hibernatejava8 5.2.7.Final
org.hibernate hibernatejpamodelgen 5.2.7.Final
org.hibernate hibernatevalidator 5.3.4.Final
org.hibernate hibernatevalidatorannotationprocessor 5.3.4.Final
org.hsqldb hsqldb 2.3.3
org.infinispan infinispanjcache 8.2.5.Final
org.infinispan infinispanspring4common 8.2.5.Final
org.infinispan infinispanspring4embedded 8.2.5.Final
org.javassist javassist 3.21.0-GA
org.jboss jbosstransactionspi 7.5.0.Final
org.jboss.logging jbosslogging 3.3.0.Final
org.jboss.narayana.jta jdbc 5.5.1.Final
org.jboss.narayana.jta jms 5.5.1.Final
org.jboss.narayana.jta jta 5.5.1.Final
org.jboss.narayana.jts narayanajtsintegration 5.5.1.Final
org.jdom jdom2 2.0.6
org.jolokia jolokiacore 1.3.5
org.jooq jooq 3.9.1
org.jooq jooqcodegen 3.9.1
org.jooq jooqmeta 3.9.1
org.json json 20140107
org.liquibase liquibasecore 3.5.3
org.mariadb.jdbc mariadbjavaclient 1.5.7
org.mockito mockitocore 2.5.4
org.mongodb bson 3.4.1
org.mongodb mongodbdriver 3.4.1
org.mongodb mongodbdriverasync 3.4.1
org.mongodb mongodbdrivercore 3.4.1
org.mongodb mongodbdriverreactivestreams 1.2.0
org.mongodb mongojavadriver 3.4.1
org.mortbay.jasper apacheel 8.0.33
org.neo4j neo4jogmapi 2.1.1
org.neo4j neo4jogmcompiler 2.1.1
org.neo4j neo4jogmcore 2.1.1
org.neo4j neo4jogmhttpdriver 2.1.1
org.postgresql postgresql 9.4.1212.jre7
org.projectlombok lombok 1.16.12
org.reactivestreams reactivestreams 1.0.0
org.seleniumhq.selenium htmlunitdriver 2.21
org.seleniumhq.selenium seleniumapi 2.53.1
org.seleniumhq.selenium seleniumchromedriver 2.53.1
org.seleniumhq.selenium seleniumfirefoxdriver 2.53.1
org.seleniumhq.selenium seleniumiedriver 2.53.1
org.seleniumhq.selenium seleniumjava 2.53.1
org.seleniumhq.selenium seleniumremotedriver 2.53.1
org.seleniumhq.selenium seleniumsafaridriver 2.53.1
org.seleniumhq.selenium seleniumsupport 2.53.1
org.skyscreamer jsonassert 1.4.0
org.slf4j jcloverslf4j 1.7.22
org.slf4j jultoslf4j 1.7.22
org.slf4j log4joverslf4j 1.7.22
org.slf4j slf4japi 1.7.22
org.slf4j slf4jjdk14 1.7.22
org.slf4j slf4jlog4j12 1.7.22
org.slf4j slf4jsimple 1.7.22
org.spockframework spockcore 1.0-groovy-2.4
org.spockframework spockspring 1.0-groovy-2.4
org.springframework springaop 5.0.0.BUILD-SNAPSHOT
org.springframework springaspects 5.0.0.BUILD-SNAPSHOT
org.springframework springbeans 5.0.0.BUILD-SNAPSHOT
org.springframework springcontext 5.0.0.BUILD-SNAPSHOT
org.springframework springcontextindexer 5.0.0.BUILD-SNAPSHOT
org.springframework springcontextsupport 5.0.0.BUILD-SNAPSHOT
org.springframework springcore 5.0.0.BUILD-SNAPSHOT
org.springframework springexpression 5.0.0.BUILD-SNAPSHOT
org.springframework springinstrument 5.0.0.BUILD-SNAPSHOT
org.springframework springjdbc 5.0.0.BUILD-SNAPSHOT
org.springframework springjms 5.0.0.BUILD-SNAPSHOT
org.springframework springloaded 1.2.6.RELEASE
org.springframework springmessaging 5.0.0.BUILD-SNAPSHOT
org.springframework springorm 5.0.0.BUILD-SNAPSHOT
org.springframework springoxm 5.0.0.BUILD-SNAPSHOT
org.springframework springtest 5.0.0.BUILD-SNAPSHOT
org.springframework springtx 5.0.0.BUILD-SNAPSHOT
org.springframework springweb 5.0.0.BUILD-SNAPSHOT
org.springframework springwebflux 5.0.0.BUILD-SNAPSHOT
org.springframework springwebmvc 5.0.0.BUILD-SNAPSHOT
org.springframework springwebsocket 5.0.0.BUILD-SNAPSHOT
org.springframework.amqp springamqp 2.0.0.BUILD-SNAPSHOT
org.springframework.amqp springrabbit 2.0.0.BUILD-SNAPSHOT
org.springframework.batch springbatchcore 4.0.0.BUILD-SNAPSHOT
org.springframework.batch springbatchinfrastructure 4.0.0.BUILD-SNAPSHOT
org.springframework.batch springbatchintegration 4.0.0.BUILD-SNAPSHOT
org.springframework.batch springbatchtest 4.0.0.BUILD-SNAPSHOT
org.springframework.boot springboot 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootactuator 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootactuatordocs 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootautoconfigure 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootautoconfigureprocessor 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootconfigurationmetadata 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootconfigurationprocessor 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootdevtools 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootloader 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootloadertools 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarter 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarteractivemq 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarteractuator 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarteramqp 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarteraop 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterartemis 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterbatch 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartercache 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartercloudconnectors 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdatacassandra 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdatacouchbase 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdataelasticsearch 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdatajpa 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdataldap 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdatamongodb 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdatamongodbreactive 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdataneo4j 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdataredis 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdatarest 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterdatasolr 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterfreemarker 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartergroovytemplates 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterhateoas 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterintegration 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterjdbc 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterjersey 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterjetty 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterjooq 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterjtaatomikos 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterjtabitronix 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterjtanarayana 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterlog4j2 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterlogging 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartermail 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartermobile 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartermustache 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterreactornetty 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartersecurity 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartersocialfacebook 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartersociallinkedin 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartersocialtwitter 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartertest 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterthymeleaf 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartertomcat 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterundertow 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstartervalidation 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterweb 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterwebflux 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterwebservices 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springbootstarterwebsocket 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springboottest 2.0.0.BUILD-SNAPSHOT
org.springframework.boot springboottestautoconfigure 2.0.0.BUILD-SNAPSHOT
org.springframework.cloud springcloudcloudfoundryconnector 1.2.3.RELEASE
org.springframework.cloud springcloudcore 1.2.3.RELEASE
org.springframework.cloud springcloudherokuconnector 1.2.3.RELEASE
org.springframework.cloud springcloudlocalconfigconnector 1.2.3.RELEASE
org.springframework.cloud springcloudspringserviceconnector 1.2.3.RELEASE
org.springframework.data springcql 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatacassandra 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatacommons 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatacouchbase 3.0.0.BUILD-SNAPSHOT
org.springframework.data springdataelasticsearch 3.0.0.BUILD-SNAPSHOT
org.springframework.data springdataenvers 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatagemfire 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatajpa 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatakeyvalue 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdataldap 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatamongodb 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatamongodbcrossstore 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatamongodblog4j 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdataneo4j 5.0.0.BUILD-SNAPSHOT
org.springframework.data springdataredis 2.0.0.BUILD-SNAPSHOT
org.springframework.data springdatarestcore 3.0.0.BUILD-SNAPSHOT
org.springframework.data springdataresthalbrowser 3.0.0.BUILD-SNAPSHOT
org.springframework.data springdatarestwebmvc 3.0.0.BUILD-SNAPSHOT
org.springframework.data springdatasolr 3.0.0.BUILD-SNAPSHOT
org.springframework.hateoas springhateoas 0.23.0.RELEASE
org.springframework.integration springintegrationamqp 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationcore 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationevent 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationfeed 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationfile 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationftp 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationgemfire 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationgroovy 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationhttp 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationip 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationjdbc 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationjms 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationjmx 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationjpa 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationmail 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationmongodb 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationmqtt 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationredis 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationrmi 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationscripting 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationsecurity 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationsftp 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationstomp 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationstream 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationsyslog 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationtest 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationtwitter 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationwebsocket 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationws 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationxml 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationxmpp 5.0.0.BUILD-SNAPSHOT
org.springframework.integration springintegrationzookeeper 5.0.0.BUILD-SNAPSHOT
org.springframework.kafka springkafka 2.0.0.BUILD-SNAPSHOT
org.springframework.kafka springkafkatest 2.0.0.BUILD-SNAPSHOT
org.springframework.ldap springldapcore 2.3.1.RELEASE
org.springframework.ldap springldapcoretiger 2.3.1.RELEASE
org.springframework.ldap springldapldifbatch 2.3.1.RELEASE
org.springframework.ldap springldapldifcore 2.3.1.RELEASE
org.springframework.ldap springldapodm 2.3.1.RELEASE
org.springframework.ldap springldaptest 2.3.1.RELEASE
org.springframework.mobile springmobiledevice 2.0.0.M1
org.springframework.plugin springplugincore 1.2.0.RELEASE
org.springframework.plugin springpluginmetadata 1.2.0.RELEASE
org.springframework.restdocs springrestdocscore 1.2.0.BUILD-SNAPSHOT
org.springframework.restdocs springrestdocsmockmvc 1.2.0.BUILD-SNAPSHOT
org.springframework.restdocs springrestdocsrestassured 1.2.0.BUILD-SNAPSHOT
org.springframework.retry springretry 1.2.0.RELEASE
org.springframework.security springsecurityacl 4.2.1.RELEASE
org.springframework.security springsecurityaspects 4.2.1.RELEASE
org.springframework.security springsecuritycas 4.2.1.RELEASE
org.springframework.security springsecurityconfig 4.2.1.RELEASE
org.springframework.security springsecuritycore 4.2.1.RELEASE
org.springframework.security springsecuritycrypto 4.2.1.RELEASE
org.springframework.security springsecuritydata 4.2.1.RELEASE
org.springframework.security springsecurityjwt 1.0.7.RELEASE
org.springframework.security springsecurityldap 4.2.1.RELEASE
org.springframework.security springsecuritymessaging 4.2.1.RELEASE
org.springframework.security springsecurityopenid 4.2.1.RELEASE
org.springframework.security springsecurityremoting 4.2.1.RELEASE
org.springframework.security springsecuritytaglibs 4.2.1.RELEASE
org.springframework.security springsecuritytest 4.2.1.RELEASE
org.springframework.security springsecurityweb 4.2.1.RELEASE
org.springframework.security.oauth springsecurityoauth 2.0.13.BUILD-SNAPSHOT
org.springframework.security.oauth springsecurityoauth2 2.0.13.BUILD-SNAPSHOT
org.springframework.session springsession 2.0.0.BUILD-SNAPSHOT
org.springframework.session springsessiondatagemfire 2.0.0.BUILD-SNAPSHOT
org.springframework.session springsessiondatamongo 2.0.0.BUILD-SNAPSHOT
org.springframework.session springsessiondataredis 2.0.0.BUILD-SNAPSHOT
org.springframework.session springsessionhazelcast 2.0.0.BUILD-SNAPSHOT
org.springframework.session springsessionjdbc 2.0.0.BUILD-SNAPSHOT
org.springframework.social springsocialconfig 2.0.0.BUILD-SNAPSHOT
org.springframework.social springsocialcore 2.0.0.BUILD-SNAPSHOT
org.springframework.social springsocialfacebook 3.0.0.BUILD-SNAPSHOT
org.springframework.social springsocialfacebookweb 3.0.0.BUILD-SNAPSHOT
org.springframework.social springsociallinkedin 2.0.0.M1
org.springframework.social springsocialsecurity 2.0.0.BUILD-SNAPSHOT
org.springframework.social springsocialtwitter 2.0.0.BUILD-SNAPSHOT
org.springframework.social springsocialweb 2.0.0.BUILD-SNAPSHOT
org.springframework.social springsocialwebthymeleaf3 2.0.0.BUILD-SNAPSHOT
org.springframework.ws springwscore 2.4.0.RELEASE
org.springframework.ws springwssecurity 2.4.0.RELEASE
org.springframework.ws springwssupport 2.4.0.RELEASE
org.springframework.ws springwstest 2.4.0.RELEASE
org.thymeleaf thymeleaf 3.0.3.RELEASE
org.thymeleaf thymeleafspring5 3.0.3.M1
org.thymeleaf.extras thymeleafextrasjava8time 3.0.0.RELEASE
org.thymeleaf.extras thymeleafextrasspringsecurity4 3.0.1.RELEASE
org.webjars halbrowser 9f96c74
org.webjars webjarslocator 0.32
org.xerial sqlitejdbc 3.15.1
org.yaml snakeyaml 1.17
redis.clients jedis 2.9.0
wsdl4j wsdl4j 1.6.3
xmlapis xmlapis 1.4.01

Spring Boot

Uploaded by

Spring Boot

Uploaded by

2/20/2017 Spring Boot Reference Guide

Spring Boot Reference Guide

I. Spring Boot Documentation

5. Learning about Spring Boot features

II. Getting started

10. Installing Spring Boot

10.2. Installing the Spring Boot CLI

10.3. Upgrading from an earlier version of Spring Boot

11. Developing your rst Spring Boot application

11.4. Running the example

12. What to read next

III. Using Spring Boot

14. Structuring your code

15. Conguration classes

17. Spring Beans and dependency injection

19. Running your application

20. Developer tools

21. Packaging your application for production

22. What to read next

IV. Spring Boot features

24. Externalized Conguration

24.7. Type-safe Conguration Properties

26.3. File output

27. Developing web applications

27.2. JAX-RS and Jersey

28.2. Token Type in User Info

28.4. Actuator Security

29. Working with SQL databases

29.2. Using JdbcTemplate

29.4. Using H2s web console

29.5. Using jOOQ

30. Working with NoSQL technologies

32.3. Apache Kafka Support

33. Calling REST services

36. Distributed Transactions with JTA

39. Spring Session

41.4. Test utilities

44.4. Creating your own starter

45. What to read next

V. Spring Boot Actuator: Production-ready features

47.7. Application information

48. Monitoring and management over HTTP

49. Monitoring and management over JMX

51.8. Aggregating metrics from multiple sources

54. Process monitoring

55. Cloud Foundry support

56. What to read next

VI. Deploying Spring Boot applications

57.5. Boxfuse and Amazon Web Services

58. Installing Spring Boot applications

58.2. Microsoft Windows services

59. What to read next

VII. Spring Boot CLI

61.2. Testing your code

62. Developing application with the Groovy beans DSL

VIII. Build tool plugins

65. Spring Boot Maven plugin

66. Spring Boot Gradle plugin

66.8. Understanding how the Gradle plugin works

67. Spring Boot AntLib module

68. Supporting other build systems

69. What to read next

IX. How-to guides

71. Properties & conguration

71.2. Externalize the conguration of SpringApplication

72. Embedded servlet containers

72.2. Change the HTTP port

72.8. Congure Tomcat

73. Spring MVC

74. HTTP clients

75.2. Congure Log4j for logging

76. Data Access

77. Database initialization

79. Batch applications

82. Hot swapping

82.3. Fast application restarts