root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Merge pull request #16622 from Kedar Joshi 

* pr/16622:
  Polish "Document use of @Profile with @ConfigurationProperties scanning"
  Document use of @Profile with @ConfigurationProperties scanning
This commit is contained in:
Madhura Bhave 2019-04-30 16:08:42 -07:00
parent 0b27f7c70e d4435e015c
commit 8b30ad21bb
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
View File

@ -1625,9 +1625,9 @@ property files>>.
[[boot-features-profiles]]
== Profiles
Spring Profiles provide a way to segregate parts of your application configuration and
make it be available only in certain environments. Any `@Component` or `@Configuration`
can be marked with `@Profile` to limit when it is loaded, as shown in the following
example:
make it be available only in certain environments. Any `@Component`, `@Configuration`
or `@ConfigurationProperties` can be marked with `@Profile` to limit when it is loaded,
as shown in the following example:
[source,java,indent=0]
----
@ -1640,6 +1640,11 @@ example:
}
----
NOTE: If `@ConfigurationProperties` beans are registered via `@EnableConfigurationProperties`
instead of automatic scanning, the `@Profile` annotation needs to be specified on the `@Configuration`
class that has the `@EnableConfigurationProperties` annotation. In the case where `@ConfigurationProperties`
are scanned, `@Profile` can be specified on the `@ConfigurationProperties` class itself.
You can use a `spring.profiles.active` `Environment` property to specify which profiles
are active. You can specify the property in any of the ways described earlier in this
chapter. For example, you could include it in your `application.properties`, as shown in