Address duplicate binding issues
- Deduplicate LinkedKeyBinding by key before falling back to the target key - Rather than just dropping the Guice keys during deduplication, retains the original Guice key if possible. Otherwise bindings may fail to resolve, as is the case with map bindings - Avoid duplicating beans for untargetted bindings - Avoid duplicating multibindings
This commit is contained in:
@@ -19,10 +19,15 @@ package org.springframework.guice;
|
||||
import com.google.inject.AbstractModule;
|
||||
import com.google.inject.CreationException;
|
||||
import com.google.inject.Module;
|
||||
import com.google.inject.Scopes;
|
||||
import com.google.inject.multibindings.Multibinder;
|
||||
import com.google.inject.multibindings.OptionalBinder;
|
||||
import org.junit.jupiter.api.AfterAll;
|
||||
import com.google.inject.name.Names;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
|
||||
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
@@ -33,20 +38,63 @@ import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
|
||||
|
||||
public class BindingDeduplicationTests {
|
||||
|
||||
@AfterAll
|
||||
public static void cleanUp() {
|
||||
@BeforeEach
|
||||
public void setup() {
|
||||
System.setProperty("spring.guice.dedup", "true");
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
public void cleanUp() {
|
||||
System.clearProperty("spring.guice.dedup");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void verifyNoDuplicateBindingErrorWhenDedupeEnabled() {
|
||||
System.setProperty("spring.guice.dedup", "true");
|
||||
try (AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
|
||||
BindingDeduplicationTestsConfig.class)) {
|
||||
Dependency dependency = context.getBean(Dependency.class);
|
||||
assertThat(dependency).isNotNull();
|
||||
|
||||
OptionalDependency optionalDependency = context.getBean(OptionalDependency.class);
|
||||
assertThat(optionalDependency).isNotNull();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void annotatedBindingDoesNotDuplicate() {
|
||||
try (AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
|
||||
BindingDeduplicationTestsConfig.class)) {
|
||||
FirstInterface firstInterface = context.getBean(FirstInterface.class);
|
||||
assertThat(firstInterface).isNotNull();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void untargettedBindingDoesNotDuplicate() {
|
||||
try (AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
|
||||
BindingDeduplicationTestsConfig.class)) {
|
||||
UntargettedDependency untargettedDependency = context.getBean(UntargettedDependency.class);
|
||||
assertThat(untargettedDependency).isNotNull();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void setBindingDoesNotDuplicate() {
|
||||
try (AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
|
||||
BindingDeduplicationTestsConfig.class)) {
|
||||
SetProvided setProvided = context.getBean(SetProvided.class);
|
||||
assertThat(setProvided).isNotNull();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void springBindingIsDuplicated() {
|
||||
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
|
||||
BindingDeduplicationTestsConfig.class);
|
||||
SomeDependency someDependency = context.getBean(SomeDependency.class);
|
||||
assertThat(someDependency).isNotNull();
|
||||
SomeOptionalDependency someOptionalDependency = context.getBean(SomeOptionalDependency.class);
|
||||
assertThat(someOptionalDependency).isNotNull();
|
||||
|
||||
assertThatExceptionOfType(NoUniqueBeanDefinitionException.class)
|
||||
.isThrownBy(() -> context.getBean(String.class));
|
||||
|
||||
context.close();
|
||||
}
|
||||
|
||||
@@ -60,11 +108,47 @@ public class BindingDeduplicationTests {
|
||||
});
|
||||
}
|
||||
|
||||
public static class SomeDependency {
|
||||
public interface Dependency {
|
||||
|
||||
}
|
||||
|
||||
public static class SomeOptionalDependency {
|
||||
private static class PrivateDependency implements Dependency {
|
||||
|
||||
}
|
||||
|
||||
public static class SomeSingleton {
|
||||
|
||||
}
|
||||
|
||||
public interface OptionalDependency {
|
||||
|
||||
}
|
||||
|
||||
public static class SomeOptionalDependency implements OptionalDependency {
|
||||
|
||||
}
|
||||
|
||||
interface FirstInterface {
|
||||
|
||||
}
|
||||
|
||||
interface SecondInterface {
|
||||
|
||||
}
|
||||
|
||||
static class MultiInterfaceSingleton implements FirstInterface, SecondInterface {
|
||||
|
||||
}
|
||||
|
||||
static class UntargettedDependency {
|
||||
|
||||
}
|
||||
|
||||
interface SetProvided {
|
||||
|
||||
}
|
||||
|
||||
public static class SomeSetProvided implements SetProvided {
|
||||
|
||||
}
|
||||
|
||||
@@ -73,23 +157,53 @@ public class BindingDeduplicationTests {
|
||||
static class BindingDeduplicationTestsConfig {
|
||||
|
||||
@Bean
|
||||
SomeDependency someBean() {
|
||||
return new SomeDependency();
|
||||
SomeSingleton someSingleton() {
|
||||
return new SomeSingleton();
|
||||
}
|
||||
|
||||
@Bean
|
||||
SomeOptionalDependency someOptionalBean() {
|
||||
PrivateDependency privateDependency() {
|
||||
return new PrivateDependency();
|
||||
}
|
||||
|
||||
@Bean
|
||||
OptionalDependency someOptionalDependency() {
|
||||
return new SomeOptionalDependency();
|
||||
}
|
||||
|
||||
@Bean
|
||||
String barString() {
|
||||
return "bar";
|
||||
}
|
||||
|
||||
@Bean
|
||||
SomeSetProvided someSetProvided() {
|
||||
return new SomeSetProvided();
|
||||
}
|
||||
|
||||
@Bean
|
||||
static Module module() {
|
||||
return new AbstractModule() {
|
||||
@Override
|
||||
protected void configure() {
|
||||
bind(SomeDependency.class).asEagerSingleton();
|
||||
OptionalBinder.newOptionalBinder(binder(), SomeOptionalDependency.class).setDefault()
|
||||
bind(Dependency.class).to(PrivateDependency.class);
|
||||
bind(SomeSingleton.class).asEagerSingleton();
|
||||
|
||||
OptionalBinder.newOptionalBinder(binder(), OptionalDependency.class).setDefault()
|
||||
.to(SomeOptionalDependency.class);
|
||||
|
||||
Multibinder<SetProvided> setBinder = Multibinder.newSetBinder(binder(), SetProvided.class);
|
||||
setBinder.addBinding().toInstance(new SomeSetProvided());
|
||||
|
||||
bind(UntargettedDependency.class);
|
||||
|
||||
// Untargetted binding to provide a singleton for the interface
|
||||
// bindings
|
||||
bind(MultiInterfaceSingleton.class).in(Scopes.SINGLETON);
|
||||
bind(FirstInterface.class).to(MultiInterfaceSingleton.class).in(Scopes.SINGLETON);
|
||||
bind(SecondInterface.class).to(MultiInterfaceSingleton.class).in(Scopes.SINGLETON);
|
||||
|
||||
bind(String.class).annotatedWith(Names.named("fooString")).toInstance("foo");
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user