diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-configuration-metadata.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-configuration-metadata.adoc index 0fbf463968..bc9b8aff1c 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-configuration-metadata.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-configuration-metadata.adoc @@ -333,6 +333,8 @@ To improve the user experience and further assist the user in configuring a give * Associates a provider, to attach a well defined semantic to a property, so that a tool can discover the list of potential values based on the project's context. + +[[configuration-metadata-providing-manual-hints-value-hint]] === Value Hint The `name` attribute of each hint refers to the `name` of a property. In the <>, we provide five values for the `spring.jpa.hibernate.ddl-auto` property: `none`, `validate`, `update`, `create`, and `create-drop`. @@ -378,6 +380,7 @@ If your IDE supports it, this is by far the most effective approach to auto-comp +[[configuration-metadata-providing-manual-hints-value-providers]] === Value Providers Providers are a powerful way to attach semantics to a property. In this section, we define the official providers that you can use for your own hints. @@ -421,6 +424,7 @@ If no provider for a given property is supported, no special content assistance +[[configuration-metadata-providing-manual-hints-any]] ==== Any The special **any** provider value permits any additional values to be provided. Regular value validation based on the property type should be applied if this is supported. @@ -453,6 +457,9 @@ The following example offers `on` and `off` as auto-completion values for `syste Note that, in the preceding example, any other value is also allowed. + + +[[configuration-metadata-providing-manual-hints-class-reference]] ==== Class Reference The **class-reference** provider auto-completes classes available in the project. This provider supports the following parameters: @@ -496,6 +503,7 @@ The following metadata snippet corresponds to the standard `server.servlet.jsp.c +[[configuration-metadata-providing-manual-hints-handle-as]] ==== Handle As The **handle-as** provider lets you substitute the type of the property to a more high-level type. This typically happens when the property has a `java.lang.String` type, because you do not want your configuration classes to rely on classes that may not be on the classpath. @@ -545,6 +553,7 @@ It is actually used internally as a `org.springframework.core.io.Resource` but c +[[configuration-metadata-providing-manual-hints-logger-name]] ==== Logger Name The **logger-name** provider auto-completes valid logger names and <>. Typically, package and class names available in the current project can be auto-completed. @@ -631,6 +640,7 @@ As Spring Boot defines a few logger groups out-of-the-box, dedicated value hints +[[configuration-metadata-providing-manual-hints-spring-bean-reference]] ==== Spring Bean Reference The **spring-bean-reference** provider auto-completes the beans that are defined in the configuration of the current project. This provider supports the following parameters: @@ -670,6 +680,7 @@ If you provide that hint, you still need to transform the bean name into an actu +[[configuration-metadata-providing-manual-hints-spring-profile-name]] ==== Spring Profile Name The **spring-profile-name** provider auto-completes the Spring profiles that are defined in the configuration of the current project. @@ -839,6 +850,7 @@ In order to document default values for properties in the class above, you could NOTE: Only the `name` of the property is required to document additional metadata for existing properties. + [[configuration-metadata-annotation-processor-metadata-generation-nested]] ==== Nested Properties The annotation processor automatically considers inner classes as nested properties. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-dependency-versions.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-dependency-versions.adoc index a52f6b0248..e1565ce93d 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-dependency-versions.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-dependency-versions.adoc @@ -5,6 +5,8 @@ include::attributes.adoc[] This appendix provides details of the dependencies that are managed by Spring Boot. + + [[dependency-versions-coordinates]] == Managed Dependency Coordinates @@ -13,6 +15,8 @@ When you declare a dependency on one of these artifacts without declaring a vers include::dependency-versions.adoc[] + + [[dependency-versions-properties]] == Version Properties diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-test-auto-configuration.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-test-auto-configuration.adoc index dc33154eae..bb5876804a 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-test-auto-configuration.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-test-auto-configuration.adoc @@ -5,6 +5,8 @@ include::attributes.adoc[] This appendix describes the `@…Test` auto-configuration annotations that Spring Boot provides to test slices of your application. + + [[test-auto-configuration-slices]] == Test Slices diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins.adoc index 9cb3488060..8ac813ce5b 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins.adoc @@ -20,6 +20,7 @@ Please refer to the plugin's documentation to learn more: * {spring-boot-maven-plugin-api}[API] + [[build-tool-plugins-gradle-plugin]] == Spring Boot Gradle Plugin The Spring Boot Gradle Plugin provides Spring Boot support in Gradle, letting you package executable jar or war archives, run Spring Boot applications, and use the dependency management provided by `spring-boot-dependencies`. @@ -104,7 +105,6 @@ The following nested elements can be used with the task: - [[spring-boot-ant-exejar-examples]] ==== Examples This section shows two examples of Ant tasks. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment.adoc index 8a42e7eb9e..1905d8c8e8 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment.adoc @@ -290,12 +290,14 @@ In this document, we describe to approach using AWS Elastic Beanstalk. +[[cloud-deployment-aws-beanstalk]] ==== AWS Elastic Beanstalk As described in the official https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/create_deploy_Java.html[Elastic Beanstalk Java guide], there are two main options to deploy a Java application. You can either use the "`Tomcat Platform`" or the "`Java SE platform`". +[[cloud-deployment-aws-tomcat-platform]] ===== Using the Tomcat Platform This option applies to Spring Boot projects that produce a war file. No special configuration is required. @@ -303,6 +305,7 @@ You need only follow the official guide. +[[cloud-deployment-aws-java-se-platform]] ===== Using the Java SE Platform This option applies to Spring Boot projects that produce a jar file and run an embedded web container. Elastic Beanstalk environments run an nginx instance on port 80 to proxy the actual application, running on port 5000. @@ -344,6 +347,7 @@ You can also create single instance environments by using the CLI and the follow +[[cloud-deployment-aws-summary]] ==== Summary This is one of the easiest ways to get to AWS, but there are more things to cover, such as how to integrate Elastic Beanstalk into any CI / CD tool, use the Elastic Beanstalk Maven plugin instead of the CLI, and others. There is a https://exampledriven.wordpress.com/2017/01/09/spring-boot-aws-elastic-beanstalk-example/[blog post] covering these topics more in detail. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation-overview.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation-overview.adoc index b618652f01..4c15dacaa4 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation-overview.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation-overview.adoc @@ -62,6 +62,7 @@ If you are getting started with Spring Boot or 'Spring' in general, start with < +[[boot-documentation-workingwith]] == Working with Spring Boot Ready to actually start using Spring Boot? <>: @@ -73,6 +74,7 @@ Ready to actually start using Spring Boot? <>: @@ -86,6 +88,7 @@ Need more details about Spring Boot's core features? +[[boot-documentation-production]] == Moving to Production When you are ready to push your Spring Boot application to production, we have <> that you might like: @@ -95,6 +98,7 @@ When you are ready to push your Spring Boot application to production, we have < +[[boot-documentation-advanced]] == Advanced Topics Finally, we have a few topics for more advanced users: diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto.adoc index 8e7104a588..23711c0c2b 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto.adoc @@ -603,6 +603,7 @@ If you still choose to use `h2c`, you can check <> can also be used to add active profiles if a given profile is active. + [[boot-features-profiles-groups]] === Profile Groups Occasionally the profiles that you define and use in your application are too fine-grained and become cumbersome to use. @@ -1966,6 +1975,7 @@ TIP: When you deploy your application to a servlet container or application serv This prevents logging performed by the container or other applications that have been deployed to it from appearing in your application's logs. + [[boot-features-logging-format]] === Log Format The default log output from Spring Boot resembles the following example: @@ -2381,6 +2391,7 @@ If you attempt to do so, making changes to the configuration file results in an +[[boot-features-logback-extensions-profile-specific]] ==== Profile-specific Configuration The `` tag lets you optionally include or exclude sections of configuration based on the active Spring profiles. Profile sections are supported anywhere within the `` element. @@ -2407,6 +2418,7 @@ The following listing shows three sample profiles: +[[boot-features-logback-environment-properties]] ==== Environment Properties The `` tag lets you expose properties from the Spring `Environment` for use within Logback. Doing so can be useful if you want to access values from your `application.properties` file in your Logback configuration. @@ -2732,6 +2744,8 @@ See {spring-boot-autoconfigure-module-code}/web/ResourceProperties.java[`Resourc This feature has been thoroughly described in a dedicated https://spring.io/blog/2014/07/24/spring-framework-4-1-handling-static-web-resources[blog post] and in Spring Framework's {spring-framework-docs}/web.html#mvc-config-static-resources[reference documentation]. ==== + + [[boot-features-spring-mvc-welcome-page]] ==== Welcome Page Spring Boot supports both static and templated welcome pages. @@ -3024,7 +3038,6 @@ To do so, set the `spring.security.filter.dispatcher-types` property to `async, - [[boot-features-spring-hateoas]] ==== Spring HATEOAS If you develop a RESTful API that makes use of hypermedia, Spring Boot provides auto-configuration for Spring HATEOAS that works well with most applications. @@ -3214,6 +3227,7 @@ Any resources with a path in `+/webjars/**+` are served from jar files if they a TIP: Spring WebFlux applications do not strictly depend on the Servlet API, so they cannot be deployed as war files and do not use the `src/main/webapp` directory. + [[boot-features-webflux-welcome-page]] ==== Welcome Page Spring Boot supports both static and templated welcome pages. @@ -3607,6 +3621,7 @@ The `spring-messaging` module of the Spring Framework provides support for RSock See the {spring-framework-docs}/web-reactive.html#rsocket-spring[RSocket section] of the Spring Framework reference for more details, including an overview of the RSocket protocol. + [[boot-features-rsocket-strategies-auto-configuration]] === RSocket Strategies Auto-configuration Spring Boot auto-configures an `RSocketStrategies` bean that provides all the required infrastructure for encoding and decoding RSocket payloads. @@ -3622,6 +3637,7 @@ Developers can customize the `RSocketStrategies` component by creating beans tha Note that their `@Order` is important, as it determines the order of codecs. + [[boot-features-rsocket-server-auto-configuration]] === RSocket server Auto-configuration Spring Boot provides RSocket server auto-configuration. @@ -3940,12 +3956,14 @@ Alternatively, you can define your own `OpaqueTokenIntrospector` bean for servle +[[boot-features-security-authorization-server]] ==== Authorization Server Currently, Spring Security does not provide support for implementing an OAuth 2.0 Authorization Server. However, this functionality is available from the {spring-security-oauth2}[Spring Security OAuth] project, which will eventually be superseded by Spring Security completely. Until then, you can use the `spring-security-oauth2-autoconfigure` module to easily set up an OAuth 2.0 authorization server; see its https://docs.spring.io/spring-security-oauth2-boot/[documentation] for instructions. + [[boot-features-security-saml]] === SAML 2.0 @@ -4413,6 +4431,7 @@ Both the commercial and open source editions can be used with Spring Boot. +[[boot-features-jooq-codegen]] ==== Code Generation In order to use jOOQ type-safe queries, you need to generate Java classes from your database schema. You can follow the instructions in the {jooq-docs}/#jooq-in-7-steps-step3[jOOQ user manual]. @@ -4449,6 +4468,7 @@ The following listing shows an example: +[[boot-features-jooq-dslcontext]] ==== Using DSLContext The fluent API offered by jOOQ is initiated through the `org.jooq.DSLContext` interface. Spring Boot auto-configures a `DSLContext` as a Spring Bean and connects it to your application `DataSource`. @@ -4484,6 +4504,7 @@ You can then use the `DSLContext` to construct your queries, as shown in the fol +[[boot-features-jooq-sqldialect]] ==== jOOQ SQL Dialect Unless the configprop:spring.jooq.sql-dialect[] property has been configured, Spring Boot determines the SQL dialect to use for your datasource. If Spring Boot could not detect the dialect, it uses `DEFAULT`. @@ -4492,6 +4513,7 @@ NOTE: Spring Boot can only auto-configure dialects supported by the open source +[[boot-features-jooq-customizing]] ==== Customizing jOOQ More advanced customizations can be achieved by defining your own `@Bean` definitions, which is used when the jOOQ `Configuration` is created. You can define beans for the following jOOQ Types: @@ -4967,6 +4989,7 @@ There is a `spring-boot-starter-data-solr` "`Starter`" for collecting the depend NOTE: As of Spring Boot 2.3, support for Spring Data Solr has been deprecated and will be removed in a future release. + [[boot-features-connecting-to-solr]] ==== Connecting to Solr You can inject an auto-configured `SolrClient` instance as you would any other Spring bean. @@ -5131,6 +5154,7 @@ You can choose to disable the repositories support with the following property: ---- + [[boot-features-cassandra]] === Cassandra https://cassandra.apache.org/[Cassandra] is an open source, distributed database management system designed to handle large amounts of data across many commodity servers. @@ -5674,7 +5698,6 @@ include::{code-examples}/cache/RedisCacheManagerCustomizationExample.java[tag=co - [[boot-features-caching-provider-caffeine]] ==== Caffeine https://github.com/ben-manes/caffeine[Caffeine] is a Java 8 rewrite of Guava's cache that supersedes support for Guava. @@ -6883,6 +6906,7 @@ This will cause the auto-configuration to back off. Spring Session can then be configured using the annotation's attributes rather than the previously described configuration properties. + [[boot-features-jmx]] == Monitoring and Management over JMX Java Management Extensions (JMX) provide a standard mechanism to monitor and manage applications. @@ -7066,7 +7090,6 @@ See {spring-boot-module-api}/context/TypeExcludeFilter.html[the Javadoc] for det - [[boot-features-testing-spring-boot-application-arguments]] ==== Using Application Arguments If your application expects <>, you can @@ -8540,11 +8563,13 @@ The following example shows how to use the `ConditionEvaluationReportLoggingList +[[boot-features-test-autoconfig-simulating-web-context]] ==== Simulating a Web Context If you need to test an auto-configuration that only operates in a Servlet or Reactive web application context, use the `WebApplicationContextRunner` or `ReactiveWebApplicationContextRunner` respectively. +[[boot-features-test-autoconfig-overriding-classpath]] ==== Overriding the Classpath It is also possible to test what happens when a particular class and/or package is not present at runtime. Spring Boot ships with a `FilteredClassLoader` that can easily be used by the runner. @@ -8823,6 +8848,7 @@ The version can be customized via the `kotlin-coroutines.version` property. TIP: `org.jetbrains.kotlinx:kotlinx-coroutines-reactor` dependency is provided by default if one bootstraps a Kotlin project with at least one reactive dependency on https://start.spring.io/#!language=kotlin[start.spring.io]. + [[boot-features-kotlin-configuration-properties]] === @ConfigurationProperties `@ConfigurationProperties` when used in combination with <> supports classes with immutable `val` properties as shown in the following example: @@ -8900,6 +8926,8 @@ The other issue is that putting your application's code and all its dependencies Since you probably recompile your code more often than you upgrade the version of Spring Boot you use, it’s often better to separate things a bit more. If you put jar files in the layer before your application classes, Docker often only needs to change the very bottom layer and can pick others up from its cache. + + [[boot-layering-docker-images]] === Layering Docker Images To make it easier to create optimized Docker images, Spring Boot supports adding a layer index file to the jar. @@ -8936,9 +8964,14 @@ Application code is more likely to change between builds so it is isolated in a For Maven, refer to the {spring-boot-maven-plugin-docs}#repackage-layers[packaging layered jars section] for more details on adding a layer index to the jar. For Gradle, refer to the {spring-boot-gradle-plugin-docs}#packaging-layered-jars[packaging layered jars section] of the Gradle plugin documentation. + + +[[boot-features-container-images-building]] === Building Container Images Spring Boot applications can be containerized <>, or by <>. + + [[boot-features-container-images-docker]] ==== Dockerfiles While it is possible to convert a Spring Boot fat jar into a docker image with just a few lines in the Dockerfile, we will use the <> to create an optimized docker image. @@ -9003,6 +9036,7 @@ Of course, a Dockerfile can be written without using the jarmode. You can use some combination of `unzip` and `mv` to move things to the right layer but jarmode simplifies that. + [[boot-features-container-images-buildpacks]] ==== Cloud Native Buildpacks Dockerfiles are just one way to build docker images. @@ -9023,6 +9057,8 @@ NOTE: In order to achieve reproducible builds and container image caching, Build You should ensure that your application does not rely on that metadata at runtime. Spring Boot can use that information when serving static resources, but this can be disabled with configprop:spring.web.resources.cache.use-last-modified[] + + [[boot-features-whats-next]] == What to Read Next If you want to learn more about any of the classes discussed in this section, you can check out the {spring-boot-api}/[Spring Boot API documentation] or you can browse the {spring-boot-code}[source code directly]. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using-spring-boot.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using-spring-boot.adoc index e66c218ae4..424c9bd928 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using-spring-boot.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using-spring-boot.adoc @@ -593,7 +593,7 @@ The way in which you cause the classpath to be updated depends on the IDE that y * In Eclipse, saving a modified file causes the classpath to be updated and triggers a restart. * In IntelliJ IDEA, building the project (`Build +->+ Build Project`) has the same effect. -* If using a build plugin, running `mvn compile` for Maven or `gradle build` for Gradle will trigger a restart. +* If using a build plugin, running `mvn compile` for Maven or `gradle build` for Gradle will trigger a restart. **** NOTE: If you are restarting with Maven or Gradle using the build plugin you must leave the `forking` set to `enabled`. @@ -642,6 +642,7 @@ To disable the logging of the report, set the following property: ---- + [[using-boot-devtools-restart-exclude]] ==== Excluding Resources Certain resources do not necessarily need to trigger a restart when they are changed. @@ -870,6 +871,7 @@ The client component must be launched manually. +[[running-remote-client-application]] ==== Running the Remote Client Application The remote client application is designed to be run from within your IDE. You need to run `org.springframework.boot.devtools.RemoteSpringApplication` with the same classpath as the remote project that you connect to.