diff --git a/spring-cloud-context/src/main/java/org/springframework/boot/context/config/ConfigFileApplicationListener.java b/spring-cloud-context/src/main/java/org/springframework/boot/context/config/ConfigFileApplicationListener.java deleted file mode 100644 index c6933d78..00000000 --- a/spring-cloud-context/src/main/java/org/springframework/boot/context/config/ConfigFileApplicationListener.java +++ /dev/null @@ -1,1006 +0,0 @@ -/* - * Copyright 2012-2020 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.springframework.boot.context.config; - -import java.io.File; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.Comparator; -import java.util.Deque; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.LinkedList; -import java.util.List; -import java.util.Map; -import java.util.Objects; -import java.util.Set; -import java.util.function.BiConsumer; -import java.util.function.Function; -import java.util.stream.Collectors; -import java.util.stream.Stream; - -import org.apache.commons.logging.Log; - -import org.springframework.beans.BeansException; -import org.springframework.beans.factory.config.BeanFactoryPostProcessor; -import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; -import org.springframework.boot.SpringApplication; -import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent; -import org.springframework.boot.context.event.ApplicationPreparedEvent; -import org.springframework.boot.context.properties.bind.Bindable; -import org.springframework.boot.context.properties.bind.Binder; -import org.springframework.boot.context.properties.bind.PropertySourcesPlaceholdersResolver; -import org.springframework.boot.context.properties.source.ConfigurationPropertySources; -import org.springframework.boot.env.DefaultPropertiesPropertySource; -import org.springframework.boot.env.EnvironmentPostProcessor; -import org.springframework.boot.env.PropertySourceLoader; -import org.springframework.boot.env.RandomValuePropertySource; -import org.springframework.boot.logging.DeferredLog; -import org.springframework.context.ApplicationEvent; -import org.springframework.context.ConfigurableApplicationContext; -import org.springframework.context.annotation.ConfigurationClassPostProcessor; -import org.springframework.context.event.SmartApplicationListener; -import org.springframework.core.Ordered; -import org.springframework.core.env.ConfigurableEnvironment; -import org.springframework.core.env.Environment; -import org.springframework.core.env.MutablePropertySources; -import org.springframework.core.env.Profiles; -import org.springframework.core.env.PropertySource; -import org.springframework.core.io.DefaultResourceLoader; -import org.springframework.core.io.FileSystemResource; -import org.springframework.core.io.Resource; -import org.springframework.core.io.ResourceLoader; -import org.springframework.core.io.support.ResourcePatternResolver; -import org.springframework.core.io.support.SpringFactoriesLoader; -import org.springframework.util.Assert; -import org.springframework.util.CollectionUtils; -import org.springframework.util.ObjectUtils; -import org.springframework.util.ResourceUtils; -import org.springframework.util.StringUtils; - -/** - * {@link EnvironmentPostProcessor} that configures the context environment by loading - * properties from well known file locations. By default properties will be loaded from - * 'application.properties' and/or 'application.yml' files in the following locations: - * - * The list is ordered by precedence (properties defined in locations higher in the list - * override those defined in lower locations). - *

- * Alternative search locations and names can be specified using - * {@link #setSearchLocations(String)} and {@link #setSearchNames(String)}. - *

- * Additional files will also be loaded based on active profiles. For example if a 'web' - * profile is active 'application-web.properties' and 'application-web.yml' will be - * considered. - *

- * The 'spring.config.name' property can be used to specify an alternative name to load - * and the 'spring.config.location' property can be used to specify alternative search - * locations or specific files. - *

- * - * @author Dave Syer - * @author Phillip Webb - * @author Stephane Nicoll - * @author Andy Wilkinson - * @author Eddú Meléndez - * @author Madhura Bhave - * @since 1.0.0 - * @deprecated since 2.4.0 in favor of {@link ConfigDataEnvironmentPostProcessor} - */ -@Deprecated -public class ConfigFileApplicationListener - implements EnvironmentPostProcessor, SmartApplicationListener, Ordered { - - // Note the order is from least to most specific (last one wins) - private static final String DEFAULT_SEARCH_LOCATIONS = "classpath:/,classpath:/config/,file:./,file:./config/*/,file:./config/"; - - private static final String DEFAULT_NAMES = "application"; - - private static final Set NO_SEARCH_NAMES = Collections.singleton(null); - - private static final Bindable STRING_ARRAY = Bindable.of(String[].class); - - private static final Bindable> STRING_LIST = Bindable - .listOf(String.class); - - private static final Set LOAD_FILTERED_PROPERTY; - - static { - Set filteredProperties = new HashSet<>(); - filteredProperties.add("spring.profiles.active"); - filteredProperties.add("spring.profiles.include"); - LOAD_FILTERED_PROPERTY = Collections.unmodifiableSet(filteredProperties); - } - - /** - * The "active profiles" property name. - */ - public static final String ACTIVE_PROFILES_PROPERTY = "spring.profiles.active"; - - /** - * The "includes profiles" property name. - */ - public static final String INCLUDE_PROFILES_PROPERTY = "spring.profiles.include"; - - /** - * The "config name" property name. - */ - public static final String CONFIG_NAME_PROPERTY = "spring.config.name"; - - /** - * The "config location" property name. - */ - public static final String CONFIG_LOCATION_PROPERTY = "spring.config.location"; - - /** - * The "config additional location" property name. - */ - public static final String CONFIG_ADDITIONAL_LOCATION_PROPERTY = "spring.config.additional-location"; - - /** - * The default order for the processor. - */ - public static final int DEFAULT_ORDER = Ordered.HIGHEST_PRECEDENCE + 10; - - private final Log logger; - - private static final Resource[] EMPTY_RESOURCES = {}; - - private static final Comparator FILE_COMPARATOR = Comparator - .comparing(File::getAbsolutePath); - - private String searchLocations; - - private String names; - - private int order = DEFAULT_ORDER; - - public ConfigFileApplicationListener() { - this(new DeferredLog()); - } - - ConfigFileApplicationListener(Log logger) { - this.logger = logger; - } - - @Override - public boolean supportsEventType(Class eventType) { - return ApplicationEnvironmentPreparedEvent.class.isAssignableFrom(eventType) - || ApplicationPreparedEvent.class.isAssignableFrom(eventType); - } - - @Override - public void onApplicationEvent(ApplicationEvent event) { - if (event instanceof ApplicationPreparedEvent) { - onApplicationPreparedEvent(event); - } - } - - List loadPostProcessors() { - return SpringFactoriesLoader.loadFactories(EnvironmentPostProcessor.class, - getClass().getClassLoader()); - } - - @Override - public void postProcessEnvironment(ConfigurableEnvironment environment, - SpringApplication application) { - addPropertySources(environment, application.getResourceLoader()); - } - - private void onApplicationPreparedEvent(ApplicationEvent event) { - // this.logger.switchTo(ConfigFileApplicationListener.class); - addPostProcessors(((ApplicationPreparedEvent) event).getApplicationContext()); - } - - /** - * Add config file property sources to the specified environment. - * @param environment the environment to add source to - * @param resourceLoader the resource loader - * @see #addPostProcessors(ConfigurableApplicationContext) - */ - protected void addPropertySources(ConfigurableEnvironment environment, - ResourceLoader resourceLoader) { - RandomValuePropertySource.addToEnvironment(environment); - new Loader(environment, resourceLoader).load(); - } - - /** - * Add appropriate post-processors to post-configure the property-sources. - * @param context the context to configure - */ - protected void addPostProcessors(ConfigurableApplicationContext context) { - context.addBeanFactoryPostProcessor( - new PropertySourceOrderingPostProcessor(context)); - } - - public void setOrder(int order) { - this.order = order; - } - - @Override - public int getOrder() { - return this.order; - } - - /** - * Set the search locations that will be considered as a comma-separated list. Each - * search location should be a directory path (ending in "/") and it will be prefixed - * by the file names constructed from {@link #setSearchNames(String) search names} and - * profiles (if any) plus file extensions supported by the properties loaders. - * Locations are considered in the order specified, with later items taking precedence - * (like a map merge). - * @param locations the search locations - */ - public void setSearchLocations(String locations) { - Assert.hasLength(locations, "Locations must not be empty"); - this.searchLocations = locations; - } - - /** - * Sets the names of the files that should be loaded (excluding file extension) as a - * comma-separated list. - * @param names the names to load - */ - public void setSearchNames(String names) { - Assert.hasLength(names, "Names must not be empty"); - this.names = names; - } - - /** - * {@link BeanFactoryPostProcessor} to re-order our property sources below any - * {@code @PropertySource} items added by the {@link ConfigurationClassPostProcessor}. - */ - private static class PropertySourceOrderingPostProcessor - implements BeanFactoryPostProcessor, Ordered { - - private ConfigurableApplicationContext context; - - PropertySourceOrderingPostProcessor(ConfigurableApplicationContext context) { - this.context = context; - } - - @Override - public int getOrder() { - return Ordered.HIGHEST_PRECEDENCE; - } - - @Override - public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) - throws BeansException { - reorderSources(this.context.getEnvironment()); - } - - private void reorderSources(ConfigurableEnvironment environment) { - DefaultPropertiesPropertySource.moveToEnd(environment); - } - - } - - /** - * Loads candidate property sources and configures the active profiles. - */ - private class Loader { - - private final Log logger = ConfigFileApplicationListener.this.logger; - - private final ConfigurableEnvironment environment; - - private final PropertySourcesPlaceholdersResolver placeholdersResolver; - - private final ResourceLoader resourceLoader; - - private final List propertySourceLoaders; - - private Deque profiles; - - private List processedProfiles; - - private boolean activatedProfiles; - - private Map loaded; - - private Map> loadDocumentsCache = new HashMap<>(); - - Loader(ConfigurableEnvironment environment, ResourceLoader resourceLoader) { - this.environment = environment; - this.placeholdersResolver = new PropertySourcesPlaceholdersResolver( - this.environment); - this.resourceLoader = (resourceLoader != null) ? resourceLoader - : new DefaultResourceLoader(null); - this.propertySourceLoaders = SpringFactoriesLoader.loadFactories( - PropertySourceLoader.class, getClass().getClassLoader()); - } - - void load() { - FilteredPropertySource.apply(this.environment, - DefaultPropertiesPropertySource.NAME, LOAD_FILTERED_PROPERTY, - this::loadWithFilteredProperties); - } - - private void loadWithFilteredProperties(PropertySource defaultProperties) { - this.profiles = new LinkedList<>(); - this.processedProfiles = new LinkedList<>(); - this.activatedProfiles = false; - this.loaded = new LinkedHashMap<>(); - initializeProfiles(); - while (!this.profiles.isEmpty()) { - Profile profile = this.profiles.poll(); - if (isDefaultProfile(profile)) { - addProfileToEnvironment(profile.getName()); - } - load(profile, this::getPositiveProfileFilter, - addToLoaded(MutablePropertySources::addLast, false)); - this.processedProfiles.add(profile); - } - load(null, this::getNegativeProfileFilter, - addToLoaded(MutablePropertySources::addFirst, true)); - addLoadedPropertySources(); - applyActiveProfiles(defaultProperties); - } - - /** - * Initialize profile information from both the {@link Environment} active - * profiles and any {@code spring.profiles.active}/{@code spring.profiles.include} - * properties that are already set. - */ - private void initializeProfiles() { - // The default profile for these purposes is represented as null. We add it - // first so that it is processed first and has lowest priority. - this.profiles.add(null); - Binder binder = Binder.get(this.environment); - Set activatedViaProperty = getProfiles(binder, - ACTIVE_PROFILES_PROPERTY); - Set includedViaProperty = getProfiles(binder, - INCLUDE_PROFILES_PROPERTY); - List otherActiveProfiles = getOtherActiveProfiles( - activatedViaProperty, includedViaProperty); - this.profiles.addAll(otherActiveProfiles); - // Any pre-existing active profiles set via property sources (e.g. - // System properties) take precedence over those added in config files. - this.profiles.addAll(includedViaProperty); - addActiveProfiles(activatedViaProperty); - if (this.profiles.size() == 1) { // only has null profile - for (String defaultProfileName : this.environment.getDefaultProfiles()) { - Profile defaultProfile = new Profile(defaultProfileName, true); - this.profiles.add(defaultProfile); - } - } - } - - private List getOtherActiveProfiles(Set activatedViaProperty, - Set includedViaProperty) { - return Arrays.stream(this.environment.getActiveProfiles()).map(Profile::new) - .filter((profile) -> !activatedViaProperty.contains(profile) - && !includedViaProperty.contains(profile)) - .collect(Collectors.toList()); - } - - void addActiveProfiles(Set profiles) { - if (profiles.isEmpty()) { - return; - } - if (this.activatedProfiles) { - if (this.logger.isDebugEnabled()) { - this.logger.debug("Profiles already activated, '" + profiles - + "' will not be applied"); - } - return; - } - this.profiles.addAll(profiles); - if (this.logger.isDebugEnabled()) { - this.logger.debug("Activated activeProfiles " - + StringUtils.collectionToCommaDelimitedString(profiles)); - } - this.activatedProfiles = true; - removeUnprocessedDefaultProfiles(); - } - - private void removeUnprocessedDefaultProfiles() { - this.profiles.removeIf( - (profile) -> (profile != null && profile.isDefaultProfile())); - } - - private DocumentFilter getPositiveProfileFilter(Profile profile) { - return (Document document) -> { - if (profile == null) { - return ObjectUtils.isEmpty(document.getProfiles()); - } - return ObjectUtils.containsElement(document.getProfiles(), - profile.getName()) - && this.environment - .acceptsProfiles(Profiles.of(document.getProfiles())); - }; - } - - private DocumentFilter getNegativeProfileFilter(Profile profile) { - return (Document document) -> (profile == null - && !ObjectUtils.isEmpty(document.getProfiles()) && this.environment - .acceptsProfiles(Profiles.of(document.getProfiles()))); - } - - private DocumentConsumer addToLoaded( - BiConsumer> addMethod, - boolean checkForExisting) { - return (profile, document) -> { - if (checkForExisting) { - for (MutablePropertySources merged : this.loaded.values()) { - if (merged.contains(document.getPropertySource().getName())) { - return; - } - } - } - MutablePropertySources merged = this.loaded.computeIfAbsent(profile, - (k) -> new MutablePropertySources()); - addMethod.accept(merged, document.getPropertySource()); - }; - } - - private void load(Profile profile, DocumentFilterFactory filterFactory, - DocumentConsumer consumer) { - getSearchLocations().forEach((location) -> { - boolean isDirectory = location.endsWith("/"); - Set names = isDirectory ? getSearchNames() : NO_SEARCH_NAMES; - names.forEach( - (name) -> load(location, name, profile, filterFactory, consumer)); - }); - } - - private void load(String location, String name, Profile profile, - DocumentFilterFactory filterFactory, DocumentConsumer consumer) { - if (!StringUtils.hasText(name)) { - for (PropertySourceLoader loader : this.propertySourceLoaders) { - if (canLoadFileExtension(loader, location)) { - load(loader, location, profile, - filterFactory.getDocumentFilter(profile), consumer); - return; - } - } - throw new IllegalStateException("File extension of config file location '" - + location - + "' is not known to any PropertySourceLoader. If the location is meant to reference " - + "a directory, it must end in '/'"); - } - Set processed = new HashSet<>(); - for (PropertySourceLoader loader : this.propertySourceLoaders) { - for (String fileExtension : loader.getFileExtensions()) { - if (processed.add(fileExtension)) { - loadForFileExtension(loader, location + name, "." + fileExtension, - profile, filterFactory, consumer); - } - } - } - } - - private boolean canLoadFileExtension(PropertySourceLoader loader, String name) { - return Arrays.stream(loader.getFileExtensions()) - .anyMatch((fileExtension) -> StringUtils.endsWithIgnoreCase(name, - fileExtension)); - } - - private void loadForFileExtension(PropertySourceLoader loader, String prefix, - String fileExtension, Profile profile, - DocumentFilterFactory filterFactory, DocumentConsumer consumer) { - DocumentFilter defaultFilter = filterFactory.getDocumentFilter(null); - DocumentFilter profileFilter = filterFactory.getDocumentFilter(profile); - if (profile != null) { - // Try profile-specific file & profile section in profile file (gh-340) - String profileSpecificFile = prefix + "-" + profile + fileExtension; - load(loader, profileSpecificFile, profile, defaultFilter, consumer); - load(loader, profileSpecificFile, profile, profileFilter, consumer); - // Try profile specific sections in files we've already processed - for (Profile processedProfile : this.processedProfiles) { - if (processedProfile != null) { - String previouslyLoaded = prefix + "-" + processedProfile - + fileExtension; - load(loader, previouslyLoaded, profile, profileFilter, consumer); - } - } - } - // Also try the profile-specific section (if any) of the normal file - load(loader, prefix + fileExtension, profile, profileFilter, consumer); - } - - private void load(PropertySourceLoader loader, String location, Profile profile, - DocumentFilter filter, DocumentConsumer consumer) { - Resource[] resources = getResources(location); - for (Resource resource : resources) { - try { - if (resource == null || !resource.exists()) { - if (this.logger.isTraceEnabled()) { - StringBuilder description = getDescription( - "Skipped missing config ", location, resource, - profile); - this.logger.trace(description); - } - continue; - } - if (!StringUtils.hasText( - StringUtils.getFilenameExtension(resource.getFilename()))) { - if (this.logger.isTraceEnabled()) { - StringBuilder description = getDescription( - "Skipped empty config extension ", location, resource, - profile); - this.logger.trace(description); - } - continue; - } - String name = "applicationConfig: [" - + getLocationName(location, resource) + "]"; - List documents = loadDocuments(loader, name, resource); - if (CollectionUtils.isEmpty(documents)) { - if (this.logger.isTraceEnabled()) { - StringBuilder description = getDescription( - "Skipped unloaded config ", location, resource, - profile); - this.logger.trace(description); - } - continue; - } - List loaded = new ArrayList<>(); - for (Document document : documents) { - if (filter.match(document)) { - addActiveProfiles(document.getActiveProfiles()); - addIncludedProfiles(document.getIncludeProfiles()); - loaded.add(document); - } - } - Collections.reverse(loaded); - if (!loaded.isEmpty()) { - loaded.forEach((document) -> consumer.accept(profile, document)); - if (this.logger.isDebugEnabled()) { - StringBuilder description = getDescription( - "Loaded config file ", location, resource, profile); - this.logger.debug(description); - } - } - } - catch (Exception ex) { - StringBuilder description = getDescription( - "Failed to load property source from ", location, resource, - profile); - throw new IllegalStateException(description.toString(), ex); - } - } - } - - private String getLocationName(String location, Resource resource) { - if (!location.contains("*")) { - return location; - } - if (resource instanceof FileSystemResource) { - return ((FileSystemResource) resource).getPath(); - } - return resource.getDescription(); - } - - private Resource[] getResources(String location) { - try { - if (location.contains("*")) { - return getResourcesFromPatternLocation(location); - } - return new Resource[] { this.resourceLoader.getResource(location) }; - } - catch (Exception ex) { - return EMPTY_RESOURCES; - } - } - - private Resource[] getResourcesFromPatternLocation(String location) - throws IOException { - String directoryPath = location.substring(0, location.indexOf("*/")); - Resource resource = this.resourceLoader.getResource(directoryPath); - File[] files = resource.getFile().listFiles(File::isDirectory); - if (files != null) { - String fileName = location.substring(location.lastIndexOf("/") + 1); - Arrays.sort(files, FILE_COMPARATOR); - return Arrays.stream(files) - .map((file) -> file - .listFiles((dir, name) -> name.equals(fileName))) - .filter(Objects::nonNull) - .flatMap((Function>) Arrays::stream) - .map(FileSystemResource::new).toArray(Resource[]::new); - } - return EMPTY_RESOURCES; - } - - private void addIncludedProfiles(Set includeProfiles) { - LinkedList existingProfiles = new LinkedList<>(this.profiles); - this.profiles.clear(); - this.profiles.addAll(includeProfiles); - this.profiles.removeAll(this.processedProfiles); - this.profiles.addAll(existingProfiles); - } - - private List loadDocuments(PropertySourceLoader loader, String name, - Resource resource) throws IOException { - DocumentsCacheKey cacheKey = new DocumentsCacheKey(loader, resource); - List documents = this.loadDocumentsCache.get(cacheKey); - if (documents == null) { - List> loaded = loader.load(name, resource); - documents = asDocuments(loaded); - this.loadDocumentsCache.put(cacheKey, documents); - } - return documents; - } - - private List asDocuments(List> loaded) { - if (loaded == null) { - return Collections.emptyList(); - } - return loaded.stream().map((propertySource) -> { - Binder binder = new Binder( - ConfigurationPropertySources.from(propertySource), - this.placeholdersResolver); - String[] profiles = binder.bind("spring.profiles", STRING_ARRAY) - .orElse(null); - Set activeProfiles = getProfiles(binder, - ACTIVE_PROFILES_PROPERTY); - Set includeProfiles = getProfiles(binder, - INCLUDE_PROFILES_PROPERTY); - return new Document(propertySource, profiles, activeProfiles, - includeProfiles); - }).collect(Collectors.toList()); - } - - private StringBuilder getDescription(String prefix, String location, - Resource resource, Profile profile) { - StringBuilder result = new StringBuilder(prefix); - try { - if (resource != null) { - String uri = resource.getURI().toASCIIString(); - result.append("'"); - result.append(uri); - result.append("' ("); - result.append(location); - result.append(")"); - } - } - catch (IOException ex) { - result.append(location); - } - if (profile != null) { - result.append(" for profile "); - result.append(profile); - } - return result; - } - - private Set getProfiles(Binder binder, String name) { - return binder.bind(name, STRING_ARRAY).map(this::asProfileSet) - .orElse(Collections.emptySet()); - } - - private Set asProfileSet(String[] profileNames) { - List profiles = new ArrayList<>(); - for (String profileName : profileNames) { - profiles.add(new Profile(profileName)); - } - return new LinkedHashSet<>(profiles); - } - - private void addProfileToEnvironment(String profile) { - for (String activeProfile : this.environment.getActiveProfiles()) { - if (activeProfile.equals(profile)) { - return; - } - } - this.environment.addActiveProfile(profile); - } - - private Set getSearchLocations() { - Set locations = getSearchLocations( - CONFIG_ADDITIONAL_LOCATION_PROPERTY); - if (this.environment.containsProperty(CONFIG_LOCATION_PROPERTY)) { - locations.addAll(getSearchLocations(CONFIG_LOCATION_PROPERTY)); - } - else { - locations.addAll( - asResolvedSet(ConfigFileApplicationListener.this.searchLocations, - DEFAULT_SEARCH_LOCATIONS)); - } - return locations; - } - - private Set getSearchLocations(String propertyName) { - Set locations = new LinkedHashSet<>(); - if (this.environment.containsProperty(propertyName)) { - for (String path : asResolvedSet( - this.environment.getProperty(propertyName), null)) { - if (!path.contains("$")) { - path = StringUtils.cleanPath(path); - Assert.state( - !path.startsWith( - ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX), - "Classpath wildcard patterns cannot be used as a search location"); - validateWildcardLocation(path); - if (!ResourceUtils.isUrl(path)) { - path = ResourceUtils.FILE_URL_PREFIX + path; - } - } - locations.add(path); - } - } - return locations; - } - - private void validateWildcardLocation(String path) { - if (path.contains("*")) { - Assert.state(StringUtils.countOccurrencesOf(path, "*") == 1, - () -> "Search location '" + path - + "' cannot contain multiple wildcards"); - String directoryPath = path.substring(0, path.lastIndexOf("/") + 1); - Assert.state(directoryPath.endsWith("*/"), - () -> "Search location '" + path + "' must end with '*/'"); - } - } - - private Set getSearchNames() { - if (this.environment.containsProperty(CONFIG_NAME_PROPERTY)) { - String property = this.environment.getProperty(CONFIG_NAME_PROPERTY); - Set names = asResolvedSet(property, null); - names.forEach(this::assertValidConfigName); - return names; - } - return asResolvedSet(ConfigFileApplicationListener.this.names, DEFAULT_NAMES); - } - - private Set asResolvedSet(String value, String fallback) { - List list = Arrays.asList(StringUtils.trimArrayElements( - StringUtils.commaDelimitedListToStringArray((value != null) - ? this.environment.resolvePlaceholders(value) : fallback))); - Collections.reverse(list); - return new LinkedHashSet<>(list); - } - - private void assertValidConfigName(String name) { - Assert.state(!name.contains("*"), - () -> "Config name '" + name + "' cannot contain wildcards"); - } - - private void addLoadedPropertySources() { - MutablePropertySources destination = this.environment.getPropertySources(); - List loaded = new ArrayList<>(this.loaded.values()); - Collections.reverse(loaded); - String lastAdded = null; - Set added = new HashSet<>(); - for (MutablePropertySources sources : loaded) { - for (PropertySource source : sources) { - if (added.add(source.getName())) { - addLoadedPropertySource(destination, lastAdded, source); - lastAdded = source.getName(); - } - } - } - } - - private void addLoadedPropertySource(MutablePropertySources destination, - String lastAdded, PropertySource source) { - if (lastAdded == null) { - if (destination.contains(DefaultPropertiesPropertySource.NAME)) { - destination.addBefore(DefaultPropertiesPropertySource.NAME, source); - } - else { - destination.addLast(source); - } - } - else { - destination.addAfter(lastAdded, source); - } - } - - private void applyActiveProfiles(PropertySource defaultProperties) { - List activeProfiles = new ArrayList<>(); - if (defaultProperties != null) { - Binder binder = new Binder( - ConfigurationPropertySources.from(defaultProperties), - new PropertySourcesPlaceholdersResolver(this.environment)); - activeProfiles - .addAll(getDefaultProfiles(binder, "spring.profiles.include")); - if (!this.activatedProfiles) { - activeProfiles - .addAll(getDefaultProfiles(binder, "spring.profiles.active")); - } - } - this.processedProfiles.stream().filter(this::isDefaultProfile) - .map(Profile::getName).forEach(activeProfiles::add); - this.environment.setActiveProfiles(activeProfiles.toArray(new String[0])); - } - - private boolean isDefaultProfile(Profile profile) { - return profile != null && !profile.isDefaultProfile(); - } - - private List getDefaultProfiles(Binder binder, String property) { - return binder.bind(property, STRING_LIST).orElse(Collections.emptyList()); - } - - } - - /** - * A Spring Profile that can be loaded. - */ - private static class Profile { - - private final String name; - - private final boolean defaultProfile; - - Profile(String name) { - this(name, false); - } - - Profile(String name, boolean defaultProfile) { - Assert.notNull(name, "Name must not be null"); - this.name = name; - this.defaultProfile = defaultProfile; - } - - String getName() { - return this.name; - } - - boolean isDefaultProfile() { - return this.defaultProfile; - } - - @Override - public boolean equals(Object obj) { - if (obj == this) { - return true; - } - if (obj == null || obj.getClass() != getClass()) { - return false; - } - return ((Profile) obj).name.equals(this.name); - } - - @Override - public int hashCode() { - return this.name.hashCode(); - } - - @Override - public String toString() { - return this.name; - } - - } - - /** - * Cache key used to save loading the same document multiple times. - */ - private static class DocumentsCacheKey { - - private final PropertySourceLoader loader; - - private final Resource resource; - - DocumentsCacheKey(PropertySourceLoader loader, Resource resource) { - this.loader = loader; - this.resource = resource; - } - - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null || getClass() != obj.getClass()) { - return false; - } - DocumentsCacheKey other = (DocumentsCacheKey) obj; - return this.loader.equals(other.loader) - && this.resource.equals(other.resource); - } - - @Override - public int hashCode() { - return this.loader.hashCode() * 31 + this.resource.hashCode(); - } - - } - - /** - * A single document loaded by a {@link PropertySourceLoader}. - */ - private static class Document { - - private final PropertySource propertySource; - - private String[] profiles; - - private final Set activeProfiles; - - private final Set includeProfiles; - - Document(PropertySource propertySource, String[] profiles, - Set activeProfiles, Set includeProfiles) { - this.propertySource = propertySource; - this.profiles = profiles; - this.activeProfiles = activeProfiles; - this.includeProfiles = includeProfiles; - } - - PropertySource getPropertySource() { - return this.propertySource; - } - - String[] getProfiles() { - return this.profiles; - } - - Set getActiveProfiles() { - return this.activeProfiles; - } - - Set getIncludeProfiles() { - return this.includeProfiles; - } - - @Override - public String toString() { - return this.propertySource.toString(); - } - - } - - /** - * Factory used to create a {@link DocumentFilter}. - */ - @FunctionalInterface - private interface DocumentFilterFactory { - - /** - * Create a filter for the given profile. - * @param profile the profile or {@code null} - * @return the filter - */ - DocumentFilter getDocumentFilter(Profile profile); - - } - - /** - * Filter used to restrict when a {@link Document} is loaded. - */ - @FunctionalInterface - private interface DocumentFilter { - - boolean match(Document document); - - } - - /** - * Consumer used to handle a loaded {@link Document}. - */ - @FunctionalInterface - private interface DocumentConsumer { - - void accept(Profile profile, Document document); - - } - -} diff --git a/spring-cloud-context/src/main/java/org/springframework/cloud/bootstrap/BootstrapConfigFileApplicationListener.java b/spring-cloud-context/src/main/java/org/springframework/cloud/bootstrap/BootstrapConfigFileApplicationListener.java new file mode 100644 index 00000000..d2f19176 --- /dev/null +++ b/spring-cloud-context/src/main/java/org/springframework/cloud/bootstrap/BootstrapConfigFileApplicationListener.java @@ -0,0 +1,37 @@ +/* + * Copyright 2013-2020 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.bootstrap; + +import org.springframework.boot.context.config.ConfigFileApplicationListener; +import org.springframework.context.ApplicationEvent; + +/** + * Overrides ConfigFileApplicationListener to disable exception. + * + * @author Spencer Gibb + * @since 3.0.0 + */ +@SuppressWarnings("deprecation") +public class BootstrapConfigFileApplicationListener + extends ConfigFileApplicationListener { + + @Override + public void onApplicationEvent(ApplicationEvent event) { + // do nothing, overrides exception thrown. + } + +} diff --git a/spring-cloud-context/src/main/java/org/springframework/cloud/context/refresh/LegacyContextRefresher.java b/spring-cloud-context/src/main/java/org/springframework/cloud/context/refresh/LegacyContextRefresher.java index 5bdcde14..a38e0f60 100644 --- a/spring-cloud-context/src/main/java/org/springframework/cloud/context/refresh/LegacyContextRefresher.java +++ b/spring-cloud-context/src/main/java/org/springframework/cloud/context/refresh/LegacyContextRefresher.java @@ -21,8 +21,8 @@ import java.util.Arrays; import org.springframework.boot.Banner; import org.springframework.boot.WebApplicationType; import org.springframework.boot.builder.SpringApplicationBuilder; -import org.springframework.boot.context.config.ConfigFileApplicationListener; import org.springframework.cloud.bootstrap.BootstrapApplicationListener; +import org.springframework.cloud.bootstrap.BootstrapConfigFileApplicationListener; import org.springframework.cloud.context.scope.refresh.RefreshScope; import org.springframework.context.ConfigurableApplicationContext; import org.springframework.core.env.MutablePropertySources; @@ -60,7 +60,7 @@ public class LegacyContextRefresher extends ContextRefresher { // listener because it has side effects) builder.application() .setListeners(Arrays.asList(new BootstrapApplicationListener(), - new ConfigFileApplicationListener())); + new BootstrapConfigFileApplicationListener())); capture = builder.run(); if (environment.getPropertySources().contains(REFRESH_ARGS_PROPERTY_SOURCE)) { environment.getPropertySources().remove(REFRESH_ARGS_PROPERTY_SOURCE);