com.google.inject.internal.RealMultibinder Maven / Gradle / Ivy
package com.google.inject.internal;
import static com.google.inject.internal.Element.Type.MULTIBINDER;
import static com.google.inject.internal.Errors.checkConfiguration;
import static com.google.inject.internal.Errors.checkNotNull;
import static com.google.inject.name.Names.named;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import com.google.inject.AbstractModule;
import com.google.inject.Binder;
import com.google.inject.Binding;
import com.google.inject.Injector;
import com.google.inject.Key;
import com.google.inject.Module;
import com.google.inject.Provider;
import com.google.inject.TypeLiteral;
import com.google.inject.binder.LinkedBindingBuilder;
import com.google.inject.internal.InternalProviderInstanceBindingImpl.InitializationTiming;
import com.google.inject.multibindings.MultibinderBinding;
import com.google.inject.multibindings.MultibindingsTargetVisitor;
import com.google.inject.spi.BindingTargetVisitor;
import com.google.inject.spi.Dependency;
import com.google.inject.spi.Message;
import com.google.inject.spi.ProviderInstanceBinding;
import com.google.inject.spi.ProviderWithExtensionVisitor;
import com.google.inject.util.Types;
import java.lang.reflect.Type;
import java.util.Collection;
import java.util.List;
import java.util.Set;
import java.util.function.Function;
/**
* The actual multibinder plays several roles:
*
* As a Multibinder, it acts as a factory for LinkedBindingBuilders for each of the set's
* elements. Each binding is given an annotation that identifies it as a part of this set.
*
*
As a Module, it installs the binding to the set itself. As a module, this implements equals()
* and hashcode() in order to trick Guice into executing its configure() method only once. That
* makes it so that multiple multibinders can be created for the same target collection, but only
* one is bound. Since the list of bindings is retrieved from the injector itself (and not the
* multibinder), each multibinder has access to all contributions from all multibinders.
*
*
As a Provider, this constructs the set instances.
*
*
We use a subclass to hide 'implements Module, Provider' from the public API.
*/
public final class RealMultibinder implements Module {
/** Implementation of newSetBinder. */
public static RealMultibinder newRealSetBinder(Binder binder, Key key) {
RealMultibinder result = new RealMultibinder<>(binder, key);
binder.install(result);
return result;
}
@SuppressWarnings("unchecked") // wrapping a T in a Set safely returns a Set
static TypeLiteral> setOf(TypeLiteral elementType) {
Type type = Types.setOf(elementType.getType());
return (TypeLiteral>) TypeLiteral.get(type);
}
@SuppressWarnings("unchecked")
static TypeLiteral>> collectionOfProvidersOf(
TypeLiteral elementType) {
Type providerType = Types.providerOf(elementType.getType());
Type type = Types.collectionOf(providerType);
return (TypeLiteral>>) TypeLiteral.get(type);
}
@SuppressWarnings("unchecked")
static TypeLiteral>> collectionOfJakartaProvidersOf(
TypeLiteral elementType) {
Type providerType =
Types.newParameterizedType(jakarta.inject.Provider.class, elementType.getType());
Type type = Types.collectionOf(providerType);
return (TypeLiteral>>) TypeLiteral.get(type);
}
@SuppressWarnings("unchecked")
static TypeLiteral>> collectionOfJavaxProvidersOf(
TypeLiteral elementType) {
Type providerType =
Types.newParameterizedType(javax.inject.Provider.class, elementType.getType());
Type type = Types.collectionOf(providerType);
return (TypeLiteral>>) TypeLiteral.get(type);
}
@SuppressWarnings("unchecked")
static TypeLiteral> setOfExtendsOf(TypeLiteral elementType) {
Type extendsType = Types.subtypeOf(elementType.getType());
Type setOfExtendsType = Types.setOf(extendsType);
return (TypeLiteral>) TypeLiteral.get(setOfExtendsType);
}
private final BindingSelection bindingSelection;
private final Binder binder;
RealMultibinder(Binder binder, Key key) {
this.binder = checkNotNull(binder, "binder");
this.bindingSelection = new BindingSelection<>(key);
}
@SuppressWarnings({"unchecked", "rawtypes"}) // we use raw Key to link bindings together.
@Override
public void configure(Binder binder) {
checkConfiguration(!bindingSelection.isInitialized(), "Multibinder was already initialized");
// Bind the setKey to the provider wrapped w/ extension support.
binder
.bind(bindingSelection.getSetKey())
.toProvider(new RealMultibinderProvider<>(bindingSelection));
binder.bind(bindingSelection.getSetOfExtendsKey()).to(bindingSelection.getSetKey());
binder
.bind(bindingSelection.getCollectionOfProvidersKey())
.toProvider(new RealMultibinderCollectionOfProvidersProvider(bindingSelection));
// The collection this exposes is internally an ImmutableList, so it's OK to massage
// the guice Provider to jakarta Provider in the value (since the guice Provider implements
// jakarta Provider).
binder
.bind(bindingSelection.getCollectionOfJakartaProvidersKey())
.to((Key) bindingSelection.getCollectionOfProvidersKey());
// The collection this exposes is internally an ImmutableList, so it's OK to massage
// the guice Provider to javax Provider in the value (since the guice Provider implements
// javax Provider).
binder
.bind(bindingSelection.getCollectionOfJavaxProvidersKey())
.to((Key) bindingSelection.getCollectionOfProvidersKey());
}
public void permitDuplicates() {
binder.install(new PermitDuplicatesModule(bindingSelection.getPermitDuplicatesKey()));
}
/** Adds a new entry to the set and returns the key for it. */
Key getKeyForNewItem() {
checkConfiguration(!bindingSelection.isInitialized(), "Multibinder was already initialized");
return Key.get(
bindingSelection.getElementTypeLiteral(),
new RealElement(bindingSelection.getSetName(), MULTIBINDER, ""));
}
public LinkedBindingBuilder addBinding() {
return binder.bind(getKeyForNewItem());
}
// These methods are used by RealMapBinder
Key> getSetKey() {
return bindingSelection.getSetKey();
}
TypeLiteral getElementTypeLiteral() {
return bindingSelection.getElementTypeLiteral();
}
String getSetName() {
return bindingSelection.getSetName();
}
boolean permitsDuplicates(Injector injector) {
return bindingSelection.permitsDuplicates(injector);
}
boolean containsElement(com.google.inject.spi.Element element) {
return bindingSelection.containsElement(element);
}
/**
* Base implement of {@link InternalProviderInstanceBindingImpl.Factory} that works based on a
* {@link BindingSelection}, allowing provider instances for various bindings to be implemented
* with less duplication.
*/
private abstract static class BaseFactory
extends InternalProviderInstanceBindingImpl.Factory {
final Function, ImmutableSet>> dependenciesFn;
final BindingSelection bindingSelection;
BaseFactory(
BindingSelection bindingSelection,
Function, ImmutableSet>> dependenciesFn) {
// While Multibinders only depend on bindings created in modules so we could theoretically
// initialize eagerly, they also depend on
// 1. findBindingsByType returning results
// 2. being able to call BindingImpl.acceptTargetVisitor
// neither of those is available during eager initialization, so we use DELAYED
super(InitializationTiming.DELAYED);
this.bindingSelection = bindingSelection;
this.dependenciesFn = dependenciesFn;
}
@Override
void initialize(InjectorImpl injector, Errors errors) throws ErrorsException {
bindingSelection.initialize(injector, errors);
doInitialize();
}
abstract void doInitialize();
@Override
public Set> getDependencies() {
return dependenciesFn.apply(bindingSelection);
}
@Override
public boolean equals(Object obj) {
return getClass().isInstance(obj)
&& bindingSelection.equals(((BaseFactory) obj).bindingSelection);
}
@Override
public int hashCode() {
return bindingSelection.hashCode();
}
}
/**
* Provider instance implementation that provides the actual set of values. This is parameterized
* so it can be used to supply a {@code Set} and {@code Set}, the latter being
* useful for Kotlin support.
*/
private static final class RealMultibinderProvider extends BaseFactory>
implements ProviderWithExtensionVisitor>, MultibinderBinding> {
List> bindings;
SingleParameterInjector[] injectors;
boolean permitDuplicates;
RealMultibinderProvider(BindingSelection bindingSelection) {
// Note: method reference doesn't work for the 2nd arg for some reason when compiling on java8
super(bindingSelection, bs -> bs.getDependencies());
}
@Override
protected void doInitialize() {
bindings = bindingSelection.getBindings();
injectors = bindingSelection.getParameterInjectors();
permitDuplicates = bindingSelection.permitsDuplicates();
}
@Override
protected ImmutableSet doProvision(InternalContext context, Dependency dependency)
throws InternalProvisionException {
SingleParameterInjector[] localInjectors = injectors;
if (localInjectors == null) {
// if localInjectors == null, then we have no bindings so return the empty set.
return ImmutableSet.of();
}
// Ideally we would just add to an ImmutableSet.Builder, but if we did that and there were
// duplicates we wouldn't be able to tell which one was the duplicate. So to manage this we
// first put everything into an array and then construct the set. This way if something gets
// dropped we can figure out what it is.
@SuppressWarnings("unchecked")
T[] values = (T[]) new Object[localInjectors.length];
for (int i = 0; i < localInjectors.length; i++) {
SingleParameterInjector parameterInjector = localInjectors[i];
T newValue = parameterInjector.inject(context);
if (newValue == null) {
throw newNullEntryException(i);
}
values[i] = newValue;
}
ImmutableSet set = ImmutableSet.copyOf(values);
// There are fewer items in the set than the array. Figure out which one got dropped.
if (!permitDuplicates && set.size() < values.length) {
throw newDuplicateValuesException(values);
}
return set;
}
private InternalProvisionException newNullEntryException(int i) {
return InternalProvisionException.create(
ErrorId.NULL_ELEMENT_IN_SET,
"Set injection failed due to null element bound at: %s",
bindings.get(i).getSource());
}
private InternalProvisionException newDuplicateValuesException(T[] values) {
Message message =
new Message(
GuiceInternal.GUICE_INTERNAL,
ErrorId.DUPLICATE_ELEMENT,
new DuplicateElementError(
bindingSelection.getSetKey(), bindings, values, ImmutableList.of(getSource())));
return new InternalProvisionException(message);
}
@SuppressWarnings("unchecked")
@Override
public V acceptExtensionVisitor(
BindingTargetVisitor visitor, ProviderInstanceBinding binding) {
if (visitor instanceof MultibindingsTargetVisitor) {
return ((MultibindingsTargetVisitor, V>) visitor).visit(this);
} else {
return visitor.visit(binding);
}
}
@Override
public Key> getSetKey() {
return bindingSelection.getSetKey();
}
@Override
public ImmutableSet> getAlternateSetKeys() {
return ImmutableSet.of(
(Key) bindingSelection.getCollectionOfProvidersKey(),
(Key) bindingSelection.getCollectionOfJakartaProvidersKey(),
(Key) bindingSelection.getCollectionOfJavaxProvidersKey(),
(Key) bindingSelection.getSetOfExtendsKey());
}
@Override
public TypeLiteral getElementTypeLiteral() {
return bindingSelection.getElementTypeLiteral();
}
@Override
public List> getElements() {
return bindingSelection.getElements();
}
@Override
public boolean permitsDuplicates() {
return bindingSelection.permitsDuplicates();
}
@Override
public boolean containsElement(com.google.inject.spi.Element element) {
return bindingSelection.containsElement(element);
}
}
/**
* Implementation of BaseFactory that exposes a collection of providers of the values in the set.
*/
private static final class RealMultibinderCollectionOfProvidersProvider
extends BaseFactory>> {
ImmutableList> providers;
RealMultibinderCollectionOfProvidersProvider(BindingSelection bindingSelection) {
// Note: method reference doesn't work for the 2nd arg for some reason when compiling on java8
super(bindingSelection, bs -> bs.getProviderDependencies());
}
@Override
protected void doInitialize() {
ImmutableList.Builder> providers = ImmutableList.builder();
for (Binding binding : bindingSelection.getBindings()) {
providers.add(binding.getProvider());
}
this.providers = providers.build();
}
@Override
protected ImmutableList> doProvision(
InternalContext context, Dependency dependency) {
return providers;
}
}
private static final class BindingSelection {
// prior to initialization we declare just a dependency on the injector, but as soon as we are
// initialized we swap to dependencies on the elements.
private static final ImmutableSet> MODULE_DEPENDENCIES =
ImmutableSet.>of(Dependency.get(Key.get(Injector.class)));
private final TypeLiteral elementType;
private final Key> setKey;
// these are all lazily allocated
private String setName;
private Key>> collectionOfProvidersKey;
private Key>> collectionOfJakartaProvidersKey;
private Key>> collectionOfJavaxProvidersKey;
private Key> setOfExtendsKey;
private Key permitDuplicatesKey;
private boolean isInitialized;
/* a binding for each element in the set. null until initialization, non-null afterwards */
private ImmutableList> bindings;
// Starts out as Injector and gets set up properly after initialization
private ImmutableSet> dependencies = MODULE_DEPENDENCIES;
private ImmutableSet> providerDependencies = MODULE_DEPENDENCIES;
/** whether duplicates are allowed. Possibly configured by a different instance */
private boolean permitDuplicates;
private SingleParameterInjector[] parameterinjectors;
BindingSelection(Key key) {
this.setKey = key.ofType(setOf(key.getTypeLiteral()));
this.elementType = key.getTypeLiteral();
}
void initialize(InjectorImpl injector, Errors errors) throws ErrorsException {
// This will be called multiple times, once by each Factory. We only want
// to do the work to initialize everything once, so guard this code with
// isInitialized.
if (isInitialized) {
return;
}
List> bindings = Lists.newArrayList();
Set index = Sets.newHashSet();
Indexer indexer = new Indexer(injector);
List> dependencies = Lists.newArrayList();
List> providerDependencies = Lists.newArrayList();
for (Binding entry : injector.findBindingsByType(elementType)) {
if (keyMatches(entry.getKey())) {
@SuppressWarnings("unchecked") // protected by findBindingsByType()
Binding binding = (Binding) entry;
if (index.add(binding.acceptTargetVisitor(indexer))) {
// TODO(lukes): most of these are linked bindings since user bindings are linked to
// a user binding through the @Element annotation. Since this is an implementation
// detail we could 'dereference' the @Element if it is a LinkedBinding and avoid
// provisioning through the FactoryProxy at runtime.
// Ditto for OptionalBinder/MapBinder
bindings.add(binding);
Key key = binding.getKey();
// TODO(lukes): we should mark this as a non-nullable dependency since we don't accept
// null.
// Add a dependency on Key
dependencies.add(Dependency.get(key));
// and add a dependency on Key>
providerDependencies.add(
Dependency.get(key.ofType(Types.providerOf(key.getTypeLiteral().getType()))));
}
}
}
this.bindings = ImmutableList.copyOf(bindings);
this.dependencies = ImmutableSet.copyOf(dependencies);
this.providerDependencies = ImmutableSet.copyOf(providerDependencies);
this.permitDuplicates = permitsDuplicates(injector);
// This is safe because all our dependencies are assignable to T and we never assign to
// elements of this array.
@SuppressWarnings("unchecked")
SingleParameterInjector[] typed =
(SingleParameterInjector[]) injector.getParametersInjectors(dependencies, errors);
this.parameterinjectors = typed;
isInitialized = true;
}
boolean permitsDuplicates(Injector injector) {
return injector.getBindings().containsKey(getPermitDuplicatesKey());
}
ImmutableList> getBindings() {
checkConfiguration(isInitialized, "not initialized");
return bindings;
}
SingleParameterInjector[] getParameterInjectors() {
checkConfiguration(isInitialized, "not initialized");
return parameterinjectors;
}
ImmutableSet> getDependencies() {
return dependencies;
}
ImmutableSet> getProviderDependencies() {
return providerDependencies;
}
String getSetName() {
// lazily initialized since most selectors don't survive module installation.
if (setName == null) {
setName = Annotations.nameOf(setKey);
}
return setName;
}
Key getPermitDuplicatesKey() {
Key local = permitDuplicatesKey;
if (local == null) {
local =
permitDuplicatesKey = Key.get(Boolean.class, named(toString() + " permits duplicates"));
}
return local;
}
Key>> getCollectionOfProvidersKey() {
Key>> local = collectionOfProvidersKey;
if (local == null) {
local = collectionOfProvidersKey = setKey.ofType(collectionOfProvidersOf(elementType));
}
return local;
}
Key>> getCollectionOfJakartaProvidersKey() {
Key>> local = collectionOfJakartaProvidersKey;
if (local == null) {
local =
collectionOfJakartaProvidersKey =
setKey.ofType(collectionOfJakartaProvidersOf(elementType));
}
return local;
}
Key>> getCollectionOfJavaxProvidersKey() {
Key>> local = collectionOfJavaxProvidersKey;
if (local == null) {
local =
collectionOfJavaxProvidersKey =
setKey.ofType(collectionOfJavaxProvidersOf(elementType));
}
return local;
}
Key> getSetOfExtendsKey() {
Key> local = setOfExtendsKey;
if (local == null) {
local = setOfExtendsKey = setKey.ofType(setOfExtendsOf(elementType));
}
return local;
}
boolean isInitialized() {
return isInitialized;
}
// MultibinderBinding API methods
TypeLiteral getElementTypeLiteral() {
return elementType;
}
Key> getSetKey() {
return setKey;
}
@SuppressWarnings("unchecked")
List> getElements() {
if (isInitialized()) {
return (List>) (List) bindings; // safe because bindings is immutable.
} else {
throw new UnsupportedOperationException("getElements() not supported for module bindings");
}
}
boolean permitsDuplicates() {
if (isInitialized()) {
return permitDuplicates;
} else {
throw new UnsupportedOperationException(
"permitsDuplicates() not supported for module bindings");
}
}
boolean containsElement(com.google.inject.spi.Element element) {
if (element instanceof Binding) {
Binding binding = (Binding) element;
return keyMatches(binding.getKey())
|| binding.getKey().equals(getPermitDuplicatesKey())
|| binding.getKey().equals(setKey)
|| binding.getKey().equals(collectionOfProvidersKey)
|| binding.getKey().equals(collectionOfJakartaProvidersKey)
|| binding.getKey().equals(collectionOfJavaxProvidersKey)
|| binding.getKey().equals(setOfExtendsKey);
} else {
return false;
}
}
private boolean keyMatches(Key key) {
return key.getTypeLiteral().equals(elementType)
&& key.getAnnotation() instanceof Element
&& ((Element) key.getAnnotation()).setName().equals(getSetName())
&& ((Element) key.getAnnotation()).type() == MULTIBINDER;
}
@Override
public boolean equals(Object obj) {
if (obj instanceof BindingSelection) {
return setKey.equals(((BindingSelection) obj).setKey);
}
return false;
}
@Override
public int hashCode() {
return setKey.hashCode();
}
@Override
public String toString() {
return (getSetName().isEmpty() ? "" : getSetName() + " ")
+ "Multibinder<"
+ elementType
+ ">";
}
}
@Override
public boolean equals(Object o) {
return o instanceof RealMultibinder
&& ((RealMultibinder) o).bindingSelection.equals(bindingSelection);
}
@Override
public int hashCode() {
return bindingSelection.hashCode();
}
/**
* We install the permit duplicates configuration as its own binding, all by itself. This way, if
* only one of a multibinder's users remember to call permitDuplicates(), they're still permitted.
*
* This is like setting a global variable in the injector so that each instance of the
* multibinder will have the same value for permitDuplicates, even if it is only set on one of
* them.
*/
private static class PermitDuplicatesModule extends AbstractModule {
private final Key key;
PermitDuplicatesModule(Key key) {
this.key = key;
}
@Override
protected void configure() {
bind(key).toInstance(true);
}
@Override
public boolean equals(Object o) {
return o instanceof PermitDuplicatesModule && ((PermitDuplicatesModule) o).key.equals(key);
}
@Override
public int hashCode() {
return getClass().hashCode() ^ key.hashCode();
}
}
}