Spring Boot Reference Guide
		Next

Spring Boot Reference Guide

Authors

Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Dupuis, Sébastien Deleuze, Michael Simons

2.0.0.M1

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 first 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 @EnableAutoConfiguration annotation
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.5. Starters

14. Structuring your code

14.1. Using the “default” package
14.2. Locating the main application class

15. Configuration classes

15.1. Importing additional configuration classes
15.2. Importing XML configuration

16. Auto-configuration

16.1. Gradually replacing auto-configuration
16.2. Disabling specific auto-configuration

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 file
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

22. What to read next

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 Configuration

24.1. Configuring random values

24.2. Accessing command line properties

24.3. Application property files

24.4. Profile-specific 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-profile YAML documents
24.6.4. YAML shortcomings
24.6.5. Merging YAML lists

24.7. Type-safe Configuration Properties

24.7.1. Third-party configuration
24.7.2. Relaxed binding
24.7.3. Properties conversion
24.7.4. @ConfigurationProperties Validation
24.7.5. @ConfigurationProperties vs. @Value

25. Profiles

25.1. Adding active profiles
25.2. Programmatically setting profiles
25.3. Profile-specific configuration files

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 configuration

26.6. Logback extensions

26.6.1. Profile-specific configuration
26.6.2. Environment properties

27. Developing web applications

27.1. The ‘Spring Web MVC framework’

27.1.1. Spring MVC auto-configuration

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. ConfigurableWebBindingInitializer

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 ServletWebServerApplicationContext

27.3.4. Customizing embedded servlet containers

Programmatic customization
Customizing ConfigurableServletWebServerFactory 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. Configure 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 H2’s web console

29.4.1. Changing the H2 console’s 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. Gemfire

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.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. Infinispan
31.1.6. Couchbase
31.1.7. Redis
31.1.8. Caffeine
31.1.9. Simple
31.1.10. None

32. Messaging

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.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 configuration
41.3.2. Excluding test configuration
41.3.3. Working with random ports
41.3.4. Mocking and spying beans
41.3.5. Auto-configured tests
41.3.6. Auto-configured JSON tests
41.3.7. Auto-configured Spring MVC tests
41.3.8. Auto-configured Data JPA tests
41.3.9. Auto-configured JDBC tests
41.3.10. Auto-configured Data MongoDB tests
41.3.11. Auto-configured Data Neo4j tests
41.3.12. Auto-configured Data LDAP tests
41.3.13. Auto-configured REST clients
41.3.14. Auto-configured Spring REST Docs tests
41.3.15. Using Spock to test Spring Boot applications

41.4. Test utilities

41.4.1. ConfigFileApplicationContextInitializer
41.4.2. EnvironmentTestUtils
41.4.3. OutputCapture
41.4.4. TestRestTemplate

42. WebSockets

43. Web Services

44. Creating your own auto-configuration

44.1. Understanding auto-configured beans

44.2. Locating auto-configuration 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. Autoconfigure module
44.4.3. Starter module

45. What to read next

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-configured HealthIndicators
47.6.2. Writing custom HealthIndicators

47.7. Application information

47.7.1. Auto-configured 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. Configuring management-specific SSL
48.5. Customizing the management server address
48.6. Disabling HTTP endpoints
48.7. HTTP health endpoint format and 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. Configure 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 configuration
54.2. Programmatically

55. Cloud Foundry support

55.1. Disabling extended Cloud Foundry actuator support
55.2. Cloud Foundry self signed certificates
55.3. Custom security configuration

56. What to read next

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 it’s written
Customizing script when it runs

58.2. Microsoft Windows services

59. What to read next

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. Applications with multiple source files

61.3. Packaging your application

61.4. Initialize a new project

61.5. Using the embedded shell

61.6. Adding extensions to the CLI

62. Developing application with the Groovy beans DSL

63. Configuring the CLI with settings.xml

64. What to read next

VIII. Build tool plugins

65. Spring Boot Maven plugin

65.1. Including the plugin
65.2. Packaging executable jar and war files

66. Spring Boot Gradle plugin

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:findmainclass

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

69. What to read next

IX. ‘How-to’ guides

70. Spring Boot application

70.1. Create your own FailureAnalyzer
70.2. Troubleshoot auto-configuration
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 & configuration

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 configuration 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 profiles

71.7. Change configuration 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. Configure SSL

72.6. Configure Access Logging

72.7. Use behind a front-end proxy server

72.7.1. Customize Tomcat’s proxy configuration

72.8. Configure Tomcat

72.9. Enable Multiple Connectors with Tomcat

72.10. Use Tomcat’s LegacyCookieProcessor

72.11. Use Jetty instead of Tomcat

72.12. Configure Jetty

72.13. Use Undertow instead of Tomcat

72.14. Configure 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 configuration
73.8. Customize ViewResolvers

74. HTTP clients

74.1. Configure RestTemplate to use a proxy

75. Logging

75.1. Configure Logback for logging

75.1.1. Configure logback for file only output

75.2. Configure Log4j for logging

75.2.1. Use YAML or JSON to configure Log4j 2

76. Data Access

76.1. Configure a custom DataSource
76.2. Configure Two DataSources
76.3. Use Spring Data repositories
76.4. Separate @Entity definitions from Spring configuration
76.5. Configure 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. Configure 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 configuration
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

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 specific 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. Build an executable archive from Ant without using spring-boot-antlib

84. Traditional deployment

84.1. Create a deployable war file
84.2. Create a deployable war file 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
84.6. Use Lettuce instead of Jedis

X. Appendices

A. Common application properties

B. Configuration 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 profile 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-configuration classes

C.1. From the “spring-boot-autoconfigure” module
C.2. From the “spring-boot-actuator” module

D. Test auto-configuration annotations

E. The executable jar format

E.1. Nested JARs

E.1.1. The executable jar file structure
E.1.2. The executable war file structure

E.2. Spring Boot’s “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

		Next
		Part I. Spring Boot Documentation