Browse Source
Refactor LoggingApplicationListener and LoggingSystem to restore Spring Boot 1.1 logging behavior. The LOG_FILE and LOG_PATH system properties are now set before configuring the logger. The `logging.path` property is now once again optional and will not be used when `logging.file` is specified. The documentation has also been updated to reflect the changes. Fixes gh-2121 Fixes gh-2117pull/2136/merge
Phillip Webb
11 years ago
16 changed files with 282 additions and 84 deletions
@ -0,0 +1,122 @@ |
|||||||
|
/* |
||||||
|
* Copyright 2012-2014 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 |
||||||
|
* |
||||||
|
* http://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.logging; |
||||||
|
|
||||||
|
import java.util.Properties; |
||||||
|
|
||||||
|
import org.springframework.core.env.Environment; |
||||||
|
import org.springframework.core.env.PropertyResolver; |
||||||
|
import org.springframework.util.Assert; |
||||||
|
import org.springframework.util.StringUtils; |
||||||
|
|
||||||
|
/** |
||||||
|
* A reference to a log output file. Log output files are specified using |
||||||
|
* {@code logging.file} or {@code logging.path} {@link Environment} properties. If the |
||||||
|
* {@code logging.file} property is not specified {@code "spring.log"} will be written in |
||||||
|
* the {@code logging.path} directory. |
||||||
|
* |
||||||
|
* @author Phillip Webb |
||||||
|
* @since 1.2.1 |
||||||
|
* @see #get(PropertyResolver) |
||||||
|
*/ |
||||||
|
public class LogFile { |
||||||
|
|
||||||
|
/** |
||||||
|
* The name of the Spring property that contains the name of the logging configuration |
||||||
|
* file. |
||||||
|
*/ |
||||||
|
public static final String FILE_PROPERTY = "logging.file"; |
||||||
|
|
||||||
|
/** |
||||||
|
* The name of the Spring property that contains the path where the logging |
||||||
|
* configuration can be found. |
||||||
|
*/ |
||||||
|
public static final String PATH_PROPERTY = "logging.path"; |
||||||
|
|
||||||
|
private final String file; |
||||||
|
|
||||||
|
private final String path; |
||||||
|
|
||||||
|
/** |
||||||
|
* Create a new {@link LogFile} instance. |
||||||
|
* @param file a reference to the file to write |
||||||
|
*/ |
||||||
|
LogFile(String file) { |
||||||
|
this(file, null); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Create a new {@link LogFile} instance. |
||||||
|
* @param file a reference to the file to write |
||||||
|
* @param path a reference to the logging path to use if {@code file} is not specified |
||||||
|
*/ |
||||||
|
LogFile(String file, String path) { |
||||||
|
Assert.isTrue(StringUtils.hasLength(file) || StringUtils.hasLength(path), |
||||||
|
"File or Path must not be empty"); |
||||||
|
this.file = file; |
||||||
|
this.path = path; |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Apply log file details to {@code LOG_PATH} and {@code LOG_FILE} system properties. |
||||||
|
*/ |
||||||
|
public void applyToSystemProperties() { |
||||||
|
applyTo(System.getProperties()); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Apply log file details to {@code LOG_PATH} and {@code LOG_FILE} map entries. |
||||||
|
*/ |
||||||
|
public void applyTo(Properties properties) { |
||||||
|
put(properties, "LOG_PATH", this.path); |
||||||
|
put(properties, "LOG_FILE", toString()); |
||||||
|
} |
||||||
|
|
||||||
|
private void put(Properties properties, String key, String value) { |
||||||
|
if (StringUtils.hasLength(value)) { |
||||||
|
properties.put(key, value); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
@Override |
||||||
|
public String toString() { |
||||||
|
if (StringUtils.hasLength(this.file)) { |
||||||
|
return this.file; |
||||||
|
} |
||||||
|
String path = this.path; |
||||||
|
if (!path.endsWith("/")) { |
||||||
|
path = path + "/"; |
||||||
|
} |
||||||
|
return StringUtils.applyRelativePath(path, "spring.log"); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Get a {@link LogFile} from the given Spring {@link Environment}. |
||||||
|
* @param propertyResolver the {@link PropertyResolver} used to obtain the logging |
||||||
|
* properties |
||||||
|
* @return a {@link LogFile} or {@code null} if the environment didn't contain any |
||||||
|
* suitable properties |
||||||
|
*/ |
||||||
|
public static LogFile get(PropertyResolver propertyResolver) { |
||||||
|
String file = propertyResolver.getProperty(FILE_PROPERTY); |
||||||
|
String path = propertyResolver.getProperty(PATH_PROPERTY); |
||||||
|
if (StringUtils.hasLength(file) || StringUtils.hasLength(path)) { |
||||||
|
return new LogFile(file, path); |
||||||
|
} |
||||||
|
return null; |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,91 @@ |
|||||||
|
/* |
||||||
|
* Copyright 2012-2014 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 |
||||||
|
* |
||||||
|
* http://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.logging; |
||||||
|
|
||||||
|
import java.util.LinkedHashMap; |
||||||
|
import java.util.Map; |
||||||
|
import java.util.Properties; |
||||||
|
|
||||||
|
import org.junit.Test; |
||||||
|
import org.springframework.core.env.MapPropertySource; |
||||||
|
import org.springframework.core.env.MutablePropertySources; |
||||||
|
import org.springframework.core.env.PropertyResolver; |
||||||
|
import org.springframework.core.env.PropertySource; |
||||||
|
import org.springframework.core.env.PropertySourcesPropertyResolver; |
||||||
|
|
||||||
|
import static org.hamcrest.Matchers.equalTo; |
||||||
|
import static org.hamcrest.Matchers.nullValue; |
||||||
|
import static org.junit.Assert.assertThat; |
||||||
|
|
||||||
|
/** |
||||||
|
* Tests for {@link LogFile}. |
||||||
|
* |
||||||
|
* @author Phillip Webb |
||||||
|
*/ |
||||||
|
public class LogFileTests { |
||||||
|
|
||||||
|
@Test |
||||||
|
public void noProperties() throws Exception { |
||||||
|
PropertyResolver resolver = getPropertyResolver(null, null); |
||||||
|
LogFile logFile = LogFile.get(resolver); |
||||||
|
assertThat(logFile, nullValue()); |
||||||
|
} |
||||||
|
|
||||||
|
@Test |
||||||
|
public void loggingFile() throws Exception { |
||||||
|
PropertyResolver resolver = getPropertyResolver("log.file", null); |
||||||
|
LogFile logFile = LogFile.get(resolver); |
||||||
|
Properties properties = new Properties(); |
||||||
|
logFile.applyTo(properties); |
||||||
|
assertThat(logFile.toString(), equalTo("log.file")); |
||||||
|
assertThat(properties.getProperty("LOG_FILE"), equalTo("log.file")); |
||||||
|
assertThat(properties.getProperty("LOG_PATH"), nullValue()); |
||||||
|
} |
||||||
|
|
||||||
|
@Test |
||||||
|
public void loggingPath() throws Exception { |
||||||
|
PropertyResolver resolver = getPropertyResolver(null, "logpath"); |
||||||
|
LogFile logFile = LogFile.get(resolver); |
||||||
|
Properties properties = new Properties(); |
||||||
|
logFile.applyTo(properties); |
||||||
|
assertThat(logFile.toString(), equalTo("logpath/spring.log")); |
||||||
|
assertThat(properties.getProperty("LOG_FILE"), equalTo("logpath/spring.log")); |
||||||
|
assertThat(properties.getProperty("LOG_PATH"), equalTo("logpath")); |
||||||
|
} |
||||||
|
|
||||||
|
@Test |
||||||
|
public void loggingFileAndPath() throws Exception { |
||||||
|
PropertyResolver resolver = getPropertyResolver("log.file", "logpath"); |
||||||
|
LogFile logFile = LogFile.get(resolver); |
||||||
|
Properties properties = new Properties(); |
||||||
|
logFile.applyTo(properties); |
||||||
|
assertThat(logFile.toString(), equalTo("log.file")); |
||||||
|
assertThat(properties.getProperty("LOG_FILE"), equalTo("log.file")); |
||||||
|
assertThat(properties.getProperty("LOG_PATH"), equalTo("logpath")); |
||||||
|
} |
||||||
|
|
||||||
|
private PropertyResolver getPropertyResolver(String file, String path) { |
||||||
|
Map<String, Object> properties = new LinkedHashMap<String, Object>(); |
||||||
|
properties.put("logging.file", file); |
||||||
|
properties.put("logging.path", path); |
||||||
|
PropertySource<?> propertySource = new MapPropertySource("properties", properties); |
||||||
|
MutablePropertySources propertySources = new MutablePropertySources(); |
||||||
|
propertySources.addFirst(propertySource); |
||||||
|
return new PropertySourcesPropertyResolver(propertySources); |
||||||
|
} |
||||||
|
|
||||||
|
} |
||||||
Loading…
Reference in new issue