Merge pull request #7175 from Phillip Johnson
* gh-7175: Document and test array support for spring.profiles.* Use data binding to access spring.profiles .active and .include
This commit is contained in:
commit
8757ca7785
|
|
@ -128,8 +128,8 @@ content into your application; rather pick only the properties that you need.
|
|||
spring.pid.file= # Location of the PID file to write (if ApplicationPidFileWriter is used).
|
||||
|
||||
# PROFILES
|
||||
spring.profiles.active= # Comma-separated list of <<howto-set-active-spring-profiles,active profiles>>.
|
||||
spring.profiles.include= # Unconditionally activate the specified comma separated profiles.
|
||||
spring.profiles.active= # Comma-separated list (or list if using YAML) of <<howto-set-active-spring-profiles,active profiles>>.
|
||||
spring.profiles.include= # Unconditionally activate the specified comma separated profiles (or list of profiles if using YAML).
|
||||
|
||||
# SENDGRID ({sc-spring-boot-autoconfigure}/sendgrid/SendGridAutoConfiguration.{sc-ext}[SendGridAutoConfiguration])
|
||||
spring.sendgrid.api-key= # SendGrid api key (alternative to username/password)
|
||||
|
|
|
|||
|
|
@ -1173,7 +1173,9 @@ For example, when an application with following properties is run using the swit
|
|||
my.property: fromyamlfile
|
||||
---
|
||||
spring.profiles: prod
|
||||
spring.profiles.include: proddb,prodmq
|
||||
spring.profiles.include:
|
||||
- proddb
|
||||
- prodmq
|
||||
----
|
||||
|
||||
NOTE: Remember that the `spring.profiles` property can be defined in a YAML document
|
||||
|
|
|
|||
|
|
@ -36,6 +36,8 @@ import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
|
|||
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.bind.PropertiesConfigurationFactory;
|
||||
import org.springframework.boot.bind.PropertySourcesPropertyValues;
|
||||
import org.springframework.boot.bind.RelaxedDataBinder;
|
||||
import org.springframework.boot.bind.RelaxedPropertyResolver;
|
||||
import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent;
|
||||
import org.springframework.boot.context.event.ApplicationPreparedEvent;
|
||||
|
|
@ -55,6 +57,7 @@ import org.springframework.core.env.ConfigurableEnvironment;
|
|||
import org.springframework.core.env.EnumerablePropertySource;
|
||||
import org.springframework.core.env.MutablePropertySources;
|
||||
import org.springframework.core.env.PropertySource;
|
||||
import org.springframework.core.env.PropertySources;
|
||||
import org.springframework.core.io.DefaultResourceLoader;
|
||||
import org.springframework.core.io.Resource;
|
||||
import org.springframework.core.io.ResourceLoader;
|
||||
|
|
@ -390,8 +393,8 @@ public class ConfigFileApplicationListener implements EnvironmentPostProcessor,
|
|||
}
|
||||
// Any pre-existing active profiles set via property sources (e.g. System
|
||||
// properties) take precedence over those added in config files.
|
||||
Set<Profile> activeProfiles = getProfilesForValue(
|
||||
this.environment.getProperty(ACTIVE_PROFILES_PROPERTY));
|
||||
Set<Profile> activeProfiles = bindSpringProfiles(
|
||||
this.environment.getPropertySources()).getActiveProfiles();
|
||||
maybeActivateProfiles(activeProfiles);
|
||||
return activeProfiles;
|
||||
}
|
||||
|
|
@ -506,12 +509,23 @@ public class ConfigFileApplicationListener implements EnvironmentPostProcessor,
|
|||
}
|
||||
|
||||
private void handleProfileProperties(PropertySource<?> propertySource) {
|
||||
Set<Profile> activeProfiles = getProfilesForValue(
|
||||
propertySource.getProperty(ACTIVE_PROFILES_PROPERTY));
|
||||
maybeActivateProfiles(activeProfiles);
|
||||
Set<Profile> includeProfiles = getProfilesForValue(
|
||||
propertySource.getProperty(INCLUDE_PROFILES_PROPERTY));
|
||||
addProfiles(includeProfiles);
|
||||
SpringProfiles springProfiles = bindSpringProfiles(propertySource);
|
||||
maybeActivateProfiles(springProfiles.getActiveProfiles());
|
||||
addProfiles(springProfiles.getIncludeProfiles());
|
||||
}
|
||||
|
||||
private SpringProfiles bindSpringProfiles(PropertySource<?> propertySource) {
|
||||
MutablePropertySources propertySources = new MutablePropertySources();
|
||||
propertySources.addFirst(propertySource);
|
||||
return bindSpringProfiles(propertySources);
|
||||
}
|
||||
|
||||
private SpringProfiles bindSpringProfiles(PropertySources propertySources) {
|
||||
SpringProfiles springProfiles = new SpringProfiles();
|
||||
RelaxedDataBinder dataBinder = new RelaxedDataBinder(springProfiles,
|
||||
"spring.profiles");
|
||||
dataBinder.bind(new PropertySourcesPropertyValues(propertySources));
|
||||
return springProfiles;
|
||||
}
|
||||
|
||||
private void maybeActivateProfiles(Set<Profile> profiles) {
|
||||
|
|
@ -540,16 +554,6 @@ public class ConfigFileApplicationListener implements EnvironmentPostProcessor,
|
|||
}
|
||||
}
|
||||
|
||||
private Set<Profile> getProfilesForValue(Object property) {
|
||||
String value = (property == null ? null : property.toString());
|
||||
Set<String> profileNames = asResolvedSet(value, null);
|
||||
Set<Profile> profiles = new LinkedHashSet<Profile>();
|
||||
for (String profileName : profileNames) {
|
||||
profiles.add(new Profile(profileName));
|
||||
}
|
||||
return profiles;
|
||||
}
|
||||
|
||||
private void addProfiles(Set<Profile> profiles) {
|
||||
for (Profile profile : profiles) {
|
||||
this.profiles.add(profile);
|
||||
|
|
@ -750,4 +754,48 @@ public class ConfigFileApplicationListener implements EnvironmentPostProcessor,
|
|||
|
||||
}
|
||||
|
||||
/**
|
||||
* Holder for {@code spring.profiles} properties.
|
||||
*/
|
||||
static final class SpringProfiles {
|
||||
|
||||
private List<String> active = new ArrayList<String>();
|
||||
|
||||
private List<String> include = new ArrayList<String>();
|
||||
|
||||
public List<String> getActive() {
|
||||
return this.active;
|
||||
}
|
||||
|
||||
public void setActive(List<String> active) {
|
||||
this.active = active;
|
||||
}
|
||||
|
||||
public List<String> getInclude() {
|
||||
return this.include;
|
||||
}
|
||||
|
||||
public void setInclude(List<String> include) {
|
||||
this.include = include;
|
||||
}
|
||||
|
||||
Set<Profile> getActiveProfiles() {
|
||||
return asProfileSet(this.active);
|
||||
}
|
||||
|
||||
Set<Profile> getIncludeProfiles() {
|
||||
return asProfileSet(this.include);
|
||||
}
|
||||
|
||||
private Set<Profile> asProfileSet(List<String> profileNames) {
|
||||
List<Profile> profiles = new ArrayList<Profile>();
|
||||
for (String profileName : profileNames) {
|
||||
profiles.add(new Profile(profileName));
|
||||
}
|
||||
Collections.reverse(profiles);
|
||||
return new LinkedHashSet<Profile>(profiles);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -536,6 +536,14 @@ public class ConfigFileApplicationListenerTests {
|
|||
"healthcheck");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void yamlSetsMultiProfilesWhenListProvided() throws Exception {
|
||||
this.initializer.setSearchNames("testsetmultiprofileslist");
|
||||
this.initializer.postProcessEnvironment(this.environment, this.application);
|
||||
assertThat(this.environment.getActiveProfiles()).containsExactly("dev",
|
||||
"healthcheck");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void yamlSetsMultiProfilesWithWhitespace() throws Exception {
|
||||
this.initializer.setSearchNames("testsetmultiprofileswhitespace");
|
||||
|
|
|
|||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
spring:
|
||||
profiles:
|
||||
active:
|
||||
- dev
|
||||
- healthcheck
|
||||
Loading…
Reference in New Issue