Fix LoggingSystem package tangle
Introduce a new `LoggingSystemFactory` interface so that the `LoggingSystem` class can find implementations without needing to be directly tied to them. Closes gh-23387pull/23418/head
Phillip Webb
4 years ago
parent
54288678d1
commit
8f5959ba1d
@ -0,0 +1,53 @@
|
||||
/*
|
||||
* 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.logging;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.function.Function;
|
||||
|
||||
/**
|
||||
* {@link LoggingSystemFactory} that delegates to other factories.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
class DelegatingLoggingSystemFactory implements LoggingSystemFactory {
|
||||
|
||||
private final Function<ClassLoader, List<LoggingSystemFactory>> delegates;
|
||||
|
||||
/**
|
||||
* Create a new {@link DelegatingLoggingSystemFactory} instance.
|
||||
* @param delegates a function that provides the delegates
|
||||
*/
|
||||
DelegatingLoggingSystemFactory(Function<ClassLoader, List<LoggingSystemFactory>> delegates) {
|
||||
this.delegates = delegates;
|
||||
}
|
||||
|
||||
@Override
|
||||
public LoggingSystem getLoggingSystem(ClassLoader classLoader) {
|
||||
List<LoggingSystemFactory> delegates = (this.delegates != null) ? this.delegates.apply(classLoader) : null;
|
||||
if (delegates != null) {
|
||||
for (LoggingSystemFactory delegate : delegates) {
|
||||
LoggingSystem loggingSystem = delegate.getLoggingSystem(classLoader);
|
||||
if (loggingSystem != null) {
|
||||
return loggingSystem;
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,49 @@
|
||||
/*
|
||||
* 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.logging;
|
||||
|
||||
import org.springframework.boot.env.EnvironmentPostProcessorsFactory;
|
||||
import org.springframework.core.io.support.SpringFactoriesLoader;
|
||||
|
||||
/**
|
||||
* Factory class used by {@link LoggingSystem#get(ClassLoader)} to find an actual
|
||||
* implementation.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @since 2.4.0
|
||||
*/
|
||||
public interface LoggingSystemFactory {
|
||||
|
||||
/**
|
||||
* Return a logging system implementation or {@code null} if not logging system is
|
||||
* available.
|
||||
* @param classLoader the class loader to use
|
||||
* @return a logging system
|
||||
*/
|
||||
LoggingSystem getLoggingSystem(ClassLoader classLoader);
|
||||
|
||||
/**
|
||||
* Return a {@link EnvironmentPostProcessorsFactory} backed by
|
||||
* {@code spring.factories}.
|
||||
* @return an {@link LoggingSystemFactory} instance
|
||||
*/
|
||||
static LoggingSystemFactory fromSpringFactories() {
|
||||
return new DelegatingLoggingSystemFactory(
|
||||
(classLoader) -> SpringFactoriesLoader.loadFactories(LoggingSystemFactory.class, classLoader));
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,66 @@
|
||||
/*
|
||||
* 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.logging;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.mockito.Mockito.verifyNoInteractions;
|
||||
|
||||
/**
|
||||
* Tests for {@link DelegatingLoggingSystemFactory}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
class DelegatingLoggingSystemFactoryTests {
|
||||
|
||||
private ClassLoader classLoader = getClass().getClassLoader();
|
||||
|
||||
@Test
|
||||
void getLoggingSystemWhenDelegatesFunctionIsNullReturnsNull() {
|
||||
DelegatingLoggingSystemFactory factory = new DelegatingLoggingSystemFactory(null);
|
||||
assertThat(factory.getLoggingSystem(this.classLoader)).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void getLoggingSystemWhenDelegatesFunctionReturnsNullReturnsNull() {
|
||||
DelegatingLoggingSystemFactory factory = new DelegatingLoggingSystemFactory((cl) -> null);
|
||||
assertThat(factory.getLoggingSystem(this.classLoader)).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void getLoggingSystemReturnsFirstNonNullLoggingSystem() {
|
||||
List<LoggingSystemFactory> delegates = new ArrayList<>();
|
||||
delegates.add(mock(LoggingSystemFactory.class));
|
||||
delegates.add(mock(LoggingSystemFactory.class));
|
||||
delegates.add(mock(LoggingSystemFactory.class));
|
||||
LoggingSystem result = mock(LoggingSystem.class);
|
||||
given(delegates.get(1).getLoggingSystem(this.classLoader)).willReturn(result);
|
||||
DelegatingLoggingSystemFactory factory = new DelegatingLoggingSystemFactory((cl) -> delegates);
|
||||
assertThat(factory.getLoggingSystem(this.classLoader)).isSameAs(result);
|
||||
verify(delegates.get(0)).getLoggingSystem(this.classLoader);
|
||||
verify(delegates.get(1)).getLoggingSystem(this.classLoader);
|
||||
verifyNoInteractions(delegates.get(2));
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue