Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright (C) 2006 Google Inc.
*
* 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 com.google.inject.internal;
import com.google.inject.Binder;
import com.google.inject.Binding;
import com.google.inject.ConfigurationException;
import com.google.inject.ImplementedBy;
import com.google.inject.Injector;
import com.google.inject.Key;
import com.google.inject.MembersInjector;
import com.google.inject.Module;
import com.google.inject.ProvidedBy;
import com.google.inject.Provider;
import com.google.inject.ProvisionException;
import com.google.inject.Scope;
import com.google.inject.Stage;
import com.google.inject.TypeLiteral;
import com.google.inject.internal.util.ImmutableList;
import com.google.inject.internal.util.ImmutableMap;
import com.google.inject.internal.util.ImmutableSet;
import com.google.inject.internal.util.Lists;
import com.google.inject.internal.util.Maps;
import com.google.inject.internal.util.Nullable;
import com.google.inject.internal.util.Objects;
import com.google.inject.internal.util.SourceProvider;
import com.google.inject.internal.util.ToStringBuilder;
import com.google.inject.spi.BindingTargetVisitor;
import com.google.inject.spi.ConvertedConstantBinding;
import com.google.inject.spi.Dependency;
import com.google.inject.spi.HasDependencies;
import com.google.inject.spi.InjectionPoint;
import com.google.inject.spi.ProviderBinding;
import com.google.inject.spi.TypeConverterBinding;
import com.google.inject.util.Providers;
import java.lang.annotation.Annotation;
import java.lang.reflect.GenericArrayType;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Default {@link Injector} implementation.
*
* @author [email protected] (Bob Lee)
*/
final class InjectorImpl implements Injector, Lookups {
public static final TypeLiteral STRING_TYPE = TypeLiteral.get(String.class);
/** Options that control how the injector behaves. */
static class InjectorOptions {
final Stage stage;
final boolean jitDisabled;
final boolean disableCircularProxies;
InjectorOptions(Stage stage, boolean jitDisabled, boolean disableCircularProxies) {
this.stage = stage;
this.jitDisabled = jitDisabled;
this.disableCircularProxies = disableCircularProxies;
}
@Override
public String toString() {
return new ToStringBuilder(getClass())
.add("stage", stage)
.add("jitDisabled", jitDisabled)
.add("disableCircularProxies", disableCircularProxies)
.toString();
}
}
/** some limitations on what just in time bindings are allowed. */
enum JitLimitation {
/** does not allow just in time bindings */
NO_JIT,
/** allows existing just in time bindings, but does not allow new ones */
EXISTING_JIT,
/** allows existing just in time bindings & allows new ones to be created */
NEW_OR_EXISTING_JIT,
}
final State state;
final InjectorImpl parent;
final BindingsMultimap bindingsMultimap = new BindingsMultimap();
final InjectorOptions options;
/** Just-in-time binding cache. Guarded by state.lock() */
final Map, BindingImpl> jitBindings = Maps.newHashMap();
Lookups lookups = new DeferredLookups(this);
InjectorImpl(@Nullable InjectorImpl parent, State state, InjectorOptions injectorOptions) {
this.parent = parent;
this.state = state;
this.options = injectorOptions;
if (parent != null) {
localContext = parent.localContext;
} else {
localContext = new ThreadLocal() {
protected Object[] initialValue() {
return new Object[1];
}
};
}
}
/** Indexes bindings by type. */
void index() {
for (Binding binding : state.getExplicitBindingsThisLevel().values()) {
index(binding);
}
}
void index(Binding binding) {
bindingsMultimap.put(binding.getKey().getTypeLiteral(), binding);
}
public List> findBindingsByType(TypeLiteral type) {
return bindingsMultimap.getAll(type);
}
/** Returns the binding for {@code key} */
public BindingImpl getBinding(Key key) {
Errors errors = new Errors(key);
try {
BindingImpl result = getBindingOrThrow(key, errors, JitLimitation.EXISTING_JIT);
errors.throwConfigurationExceptionIfErrorsExist();
return result;
} catch (ErrorsException e) {
throw new ConfigurationException(errors.merge(e.getErrors()).getMessages());
}
}
public BindingImpl getExistingBinding(Key key) {
// Check explicit bindings, i.e. bindings created by modules.
BindingImpl explicitBinding = state.getExplicitBinding(key);
if (explicitBinding != null) {
return explicitBinding;
}
synchronized (state.lock()) {
// See if any jit bindings have been created for this key.
for (InjectorImpl injector = this; injector != null; injector = injector.parent) {
@SuppressWarnings("unchecked")
BindingImpl jitBinding = (BindingImpl) injector.jitBindings.get(key);
if(jitBinding != null) {
return jitBinding;
}
}
}
// If Key is a Provider, we have to see if the type it is providing exists,
// and, if so, we have to create the binding for the provider.
if(isProvider(key)) {
try {
// This is safe because isProvider above ensures that T is a Provider
@SuppressWarnings("unchecked")
Key providedKey = (Key)getProvidedKey((Key)key, new Errors());
if(getExistingBinding(providedKey) != null) {
return getBinding(key);
}
} catch(ErrorsException e) {
throw new ConfigurationException(e.getErrors().getMessages());
}
}
// No existing binding exists.
return null;
}
/**
* Gets a binding implementation. First, it check to see if the parent has a binding. If the
* parent has a binding and the binding is scoped, it will use that binding. Otherwise, this
* checks for an explicit binding. If no explicit binding is found, it looks for a just-in-time
* binding.
*/
BindingImpl getBindingOrThrow(Key key, Errors errors, JitLimitation jitType)
throws ErrorsException {
// Check explicit bindings, i.e. bindings created by modules.
BindingImpl binding = state.getExplicitBinding(key);
if (binding != null) {
return binding;
}
// Look for an on-demand binding.
return getJustInTimeBinding(key, errors, jitType);
}
public Binding getBinding(Class type) {
return getBinding(Key.get(type));
}
public Injector getParent() {
return parent;
}
public Injector createChildInjector(Iterable modules) {
return new InternalInjectorCreator()
.parentInjector(this)
.addModules(modules)
.build();
}
public Injector createChildInjector(Module... modules) {
return createChildInjector(ImmutableList.of(modules));
}
/**
* Returns a just-in-time binding for {@code key}, creating it if necessary.
*
* @throws ErrorsException if the binding could not be created.
*/
private BindingImpl getJustInTimeBinding(Key key, Errors errors, JitLimitation jitType)
throws ErrorsException {
boolean jitOverride = isProvider(key) || isTypeLiteral(key) || isMembersInjector(key);
synchronized (state.lock()) {
// first try to find a JIT binding that we've already created
for (InjectorImpl injector = this; injector != null; injector = injector.parent) {
@SuppressWarnings("unchecked") // we only store bindings that match their key
BindingImpl binding = (BindingImpl) injector.jitBindings.get(key);
if (binding != null) {
// If we found a JIT binding and we don't allow them,
// fail. (But allow bindings created through TypeConverters.)
if (options.jitDisabled
&& jitType == JitLimitation.NO_JIT
&& !jitOverride
&& !(binding instanceof ConvertedConstantBindingImpl)) {
throw errors.jitDisabled(key).toException();
} else {
return binding;
}
}
}
return createJustInTimeBindingRecursive(key, errors, options.jitDisabled, jitType);
}
}
/** Returns true if the key type is Provider (but not a subclass of Provider). */
private static boolean isProvider(Key key) {
return key.getTypeLiteral().getRawType().equals(Provider.class);
}
private static boolean isTypeLiteral(Key key) {
return key.getTypeLiteral().getRawType().equals(TypeLiteral.class);
}
private static Key getProvidedKey(Key> key, Errors errors) throws ErrorsException {
Type providerType = key.getTypeLiteral().getType();
// If the Provider has no type parameter (raw Provider)...
if (!(providerType instanceof ParameterizedType)) {
throw errors.cannotInjectRawProvider().toException();
}
Type entryType = ((ParameterizedType) providerType).getActualTypeArguments()[0];
@SuppressWarnings("unchecked") // safe because T came from Key>
Key providedKey = (Key) key.ofType(entryType);
return providedKey;
}
/** Returns true if the key type is MembersInjector (but not a subclass of MembersInjector). */
private static boolean isMembersInjector(Key key) {
return key.getTypeLiteral().getRawType().equals(MembersInjector.class)
&& !(key.getAnnotationType() != null);
}
private BindingImpl> createMembersInjectorBinding(
Key> key, Errors errors) throws ErrorsException {
Type membersInjectorType = key.getTypeLiteral().getType();
if (!(membersInjectorType instanceof ParameterizedType)) {
throw errors.cannotInjectRawMembersInjector().toException();
}
@SuppressWarnings("unchecked") // safe because T came from Key>
TypeLiteral instanceType = (TypeLiteral) TypeLiteral.get(
((ParameterizedType) membersInjectorType).getActualTypeArguments()[0]);
MembersInjector membersInjector = membersInjectorStore.get(instanceType, errors);
InternalFactory> factory = new ConstantFactory>(
Initializables.of(membersInjector));
return new InstanceBindingImpl>(this, key, SourceProvider.UNKNOWN_SOURCE,
factory, ImmutableSet.of(), membersInjector);
}
/**
* Creates a synthetic binding to {@code Provider}, i.e. a binding to the provider from
* {@code Binding}.
*/
private BindingImpl> createProviderBinding(Key> key, Errors errors)
throws ErrorsException {
Key providedKey = getProvidedKey(key, errors);
BindingImpl delegate = getBindingOrThrow(providedKey, errors, JitLimitation.NO_JIT);
return new ProviderBindingImpl(this, key, delegate);
}
private static class ProviderBindingImpl extends BindingImpl>
implements ProviderBinding>, HasDependencies {
final BindingImpl providedBinding;
ProviderBindingImpl(InjectorImpl injector, Key> key, Binding providedBinding) {
super(injector, key, providedBinding.getSource(), createInternalFactory(providedBinding),
Scoping.UNSCOPED);
this.providedBinding = (BindingImpl) providedBinding;
}
static InternalFactory> createInternalFactory(Binding providedBinding) {
final Provider provider = providedBinding.getProvider();
return new InternalFactory>() {
public Provider get(Errors errors, InternalContext context, Dependency dependency, boolean linked) {
return provider;
}
};
}
public Key getProvidedKey() {
return providedBinding.getKey();
}
public V acceptTargetVisitor(BindingTargetVisitor, V> visitor) {
return visitor.visit(this);
}
public void applyTo(Binder binder) {
throw new UnsupportedOperationException("This element represents a synthetic binding.");
}
@Override public String toString() {
return new ToStringBuilder(ProviderBinding.class)
.add("key", getKey())
.add("providedKey", getProvidedKey())
.toString();
}
public Set> getDependencies() {
return ImmutableSet.>of(Dependency.get(getProvidedKey()));
}
@Override
public boolean equals(Object obj) {
if(obj instanceof ProviderBindingImpl) {
ProviderBindingImpl o = (ProviderBindingImpl)obj;
return getKey().equals(o.getKey())
&& getScoping().equals(o.getScoping())
&& Objects.equal(providedBinding, o.providedBinding);
} else {
return false;
}
}
@Override
public int hashCode() {
return Objects.hashCode(getKey(), getScoping(), providedBinding);
}
}
/**
* Converts a constant string binding to the required type.
*
* @return the binding if it could be resolved, or null if the binding doesn't exist
* @throws com.google.inject.internal.ErrorsException if there was an error resolving the binding
*/
private BindingImpl convertConstantStringBinding(Key key, Errors errors)
throws ErrorsException {
// Find a constant string binding.
Key stringKey = key.ofType(STRING_TYPE);
BindingImpl stringBinding = state.getExplicitBinding(stringKey);
if (stringBinding == null || !stringBinding.isConstant()) {
return null;
}
String stringValue = stringBinding.getProvider().get();
Object source = stringBinding.getSource();
// Find a matching type converter.
TypeLiteral type = key.getTypeLiteral();
TypeConverterBinding typeConverterBinding = state.getConverter(stringValue, type, errors, source);
if (typeConverterBinding == null) {
// No converter can handle the given type.
return null;
}
// Try to convert the string. A failed conversion results in an error.
try {
@SuppressWarnings("unchecked") // This cast is safe because we double check below.
T converted = (T) typeConverterBinding.getTypeConverter().convert(stringValue, type);
if (converted == null) {
throw errors.converterReturnedNull(stringValue, source, type, typeConverterBinding)
.toException();
}
if (!type.getRawType().isInstance(converted)) {
throw errors.conversionTypeError(stringValue, source, type, typeConverterBinding, converted)
.toException();
}
return new ConvertedConstantBindingImpl(this, key, converted, stringBinding,
typeConverterBinding);
} catch (ErrorsException e) {
throw e;
} catch (RuntimeException e) {
throw errors.conversionError(stringValue, source, type, typeConverterBinding, e)
.toException();
}
}
private static class ConvertedConstantBindingImpl
extends BindingImpl implements ConvertedConstantBinding {
final T value;
final Provider provider;
final Binding originalBinding;
final TypeConverterBinding typeConverterBinding;
ConvertedConstantBindingImpl(
InjectorImpl injector, Key key, T value, Binding originalBinding,
TypeConverterBinding typeConverterBinding) {
super(injector, key, originalBinding.getSource(),
new ConstantFactory(Initializables.of(value)), Scoping.UNSCOPED);
this.value = value;
provider = Providers.of(value);
this.originalBinding = originalBinding;
this.typeConverterBinding = typeConverterBinding;
}
@Override public Provider getProvider() {
return provider;
}
public V acceptTargetVisitor(BindingTargetVisitor visitor) {
return visitor.visit(this);
}
public T getValue() {
return value;
}
public TypeConverterBinding getTypeConverterBinding() {
return typeConverterBinding;
}
public Key getSourceKey() {
return originalBinding.getKey();
}
public Set> getDependencies() {
return ImmutableSet.>of(Dependency.get(getSourceKey()));
}
public void applyTo(Binder binder) {
throw new UnsupportedOperationException("This element represents a synthetic binding.");
}
@Override public String toString() {
return new ToStringBuilder(ConvertedConstantBinding.class)
.add("key", getKey())
.add("sourceKey", getSourceKey())
.add("value", value)
.toString();
}
@Override
public boolean equals(Object obj) {
if(obj instanceof ConvertedConstantBindingImpl) {
ConvertedConstantBindingImpl o = (ConvertedConstantBindingImpl)obj;
return getKey().equals(o.getKey())
&& getScoping().equals(o.getScoping())
&& Objects.equal(value, o.value);
} else {
return false;
}
}
@Override
public int hashCode() {
return Objects.hashCode(getKey(), getScoping(), value);
}
}
void initializeBinding(BindingImpl binding, Errors errors) throws ErrorsException {
if (binding instanceof ConstructorBindingImpl) {
((ConstructorBindingImpl) binding).initialize(this, errors);
}
}
void initializeJitBinding(BindingImpl binding, Errors errors) throws ErrorsException {
// Put the partially constructed binding in the map a little early. This enables us to handle
// circular dependencies. Example: FooImpl -> BarImpl -> FooImpl.
// Note: We don't need to synchronize on state.lock() during injector creation.
if (binding instanceof ConstructorBindingImpl) {
Key key = binding.getKey();
jitBindings.put(key, binding);
boolean successful = false;
ConstructorBindingImpl cb = (ConstructorBindingImpl)binding;
try {
cb.initialize(this, errors);
successful = true;
} finally {
if (!successful) {
// We do not pass cb.getInternalConstructor as the second parameter
// so that cached exceptions while constructing it get stored.
// See TypeListenerTest#testTypeListenerThrows
removeFailedJitBinding(key, null);
cleanup(binding, new HashSet());
}
}
}
}
/**
* Iterates through the binding's dependencies to clean up any stray bindings that were leftover
* from a failed JIT binding. This is required because the bindings are eagerly &
* optimistically added to allow circular dependency support, so dependencies may pass where they
* should have failed.
*/
private boolean cleanup(BindingImpl binding, Set encountered) {
boolean bindingFailed = false;
Set> deps = getInternalDependencies(binding);
for(Dependency dep : deps) {
Key depKey = dep.getKey();
InjectionPoint ip = dep.getInjectionPoint();
if(encountered.add(depKey)) { // only check if we haven't looked at this key yet
BindingImpl depBinding = jitBindings.get(depKey);
if(depBinding != null) { // if the binding still exists, validate
boolean failed = cleanup(depBinding, encountered); // if children fail, we fail
if(depBinding instanceof ConstructorBindingImpl) {
ConstructorBindingImpl ctorBinding = (ConstructorBindingImpl)depBinding;
ip = ctorBinding.getInternalConstructor();
if(!ctorBinding.isInitialized()) {
failed = true;
}
}
if(failed) {
removeFailedJitBinding(depKey, ip);
bindingFailed = true;
}
} else if(state.getExplicitBinding(depKey) == null) {
// ignore keys if they were explicitly bound, but if neither JIT
// nor explicit, it's also invalid & should let parent know.
bindingFailed = true;
}
}
}
return bindingFailed;
}
/** Cleans up any state that may have been cached when constructing the JIT binding. */
private void removeFailedJitBinding(Key key, InjectionPoint ip) {
jitBindings.remove(key);
membersInjectorStore.remove(key.getTypeLiteral());
if(ip != null) {
constructors.remove(ip);
}
}
/** Safely gets the dependencies of possibly not initialized bindings. */
@SuppressWarnings("unchecked")
private Set> getInternalDependencies(BindingImpl binding) {
if(binding instanceof ConstructorBindingImpl) {
return ((ConstructorBindingImpl)binding).getInternalDependencies();
} else if(binding instanceof HasDependencies) {
return ((HasDependencies)binding).getDependencies();
} else {
return ImmutableSet.of();
}
}
/**
* Creates a binding for an injectable type with the given scope. Looks for a scope on the type if
* none is specified.
*/
BindingImpl createUninitializedBinding(Key key, Scoping scoping, Object source,
Errors errors, boolean jitBinding) throws ErrorsException {
Class rawType = key.getTypeLiteral().getRawType();
// Don't try to inject arrays, or enums.
if (rawType.isArray() || rawType.isEnum()) {
throw errors.missingImplementation(key).toException();
}
// Handle TypeLiteral by binding the inner type
if (rawType == TypeLiteral.class) {
@SuppressWarnings("unchecked") // we have to fudge the inner type as Object
BindingImpl binding = (BindingImpl) createTypeLiteralBinding(
(Key>) key, errors);
return binding;
}
// Handle @ImplementedBy
ImplementedBy implementedBy = rawType.getAnnotation(ImplementedBy.class);
if (implementedBy != null) {
Annotations.checkForMisplacedScopeAnnotations(rawType, source, errors);
return createImplementedByBinding(key, scoping, implementedBy, errors);
}
// Handle @ProvidedBy.
ProvidedBy providedBy = rawType.getAnnotation(ProvidedBy.class);
if (providedBy != null) {
Annotations.checkForMisplacedScopeAnnotations(rawType, source, errors);
return createProvidedByBinding(key, scoping, providedBy, errors);
}
return ConstructorBindingImpl.create(this, key, null, source, scoping, errors, jitBinding && options.jitDisabled);
}
/**
* Converts a binding for a {@code Key>} to the value {@code TypeLiteral}. It's
* a bit awkward because we have to pull out the inner type in the type literal.
*/
private BindingImpl> createTypeLiteralBinding(
Key> key, Errors errors) throws ErrorsException {
Type typeLiteralType = key.getTypeLiteral().getType();
if (!(typeLiteralType instanceof ParameterizedType)) {
throw errors.cannotInjectRawTypeLiteral().toException();
}
ParameterizedType parameterizedType = (ParameterizedType) typeLiteralType;
Type innerType = parameterizedType.getActualTypeArguments()[0];
// this is unforunate. We don't support building TypeLiterals for type variable like 'T'. If
// this proves problematic, we can probably fix TypeLiteral to support type variables
if (!(innerType instanceof Class)
&& !(innerType instanceof GenericArrayType)
&& !(innerType instanceof ParameterizedType)) {
throw errors.cannotInjectTypeLiteralOf(innerType).toException();
}
@SuppressWarnings("unchecked") // by definition, innerType == T, so this is safe
TypeLiteral value = (TypeLiteral) TypeLiteral.get(innerType);
InternalFactory> factory = new ConstantFactory>(
Initializables.of(value));
return new InstanceBindingImpl>(this, key, SourceProvider.UNKNOWN_SOURCE,
factory, ImmutableSet.of(), value);
}
/** Creates a binding for a type annotated with @ProvidedBy. */
BindingImpl createProvidedByBinding(Key key, Scoping scoping,
ProvidedBy providedBy, Errors errors) throws ErrorsException {
final Class rawType = key.getTypeLiteral().getRawType();
final Class> providerType = providedBy.value();
// Make sure it's not the same type. TODO: Can we check for deeper loops?
if (providerType == rawType) {
throw errors.recursiveProviderType().toException();
}
// Assume the provider provides an appropriate type. We double check at runtime.
@SuppressWarnings("unchecked")
final Key> providerKey
= (Key>) Key.get(providerType);
final BindingImpl> providerBinding
= getBindingOrThrow(providerKey, errors, JitLimitation.NEW_OR_EXISTING_JIT);
InternalFactory internalFactory = new InternalFactory() {
public T get(Errors errors, InternalContext context, Dependency dependency, boolean linked)
throws ErrorsException {
errors = errors.withSource(providerKey);
Provider provider = providerBinding.getInternalFactory().get(
errors, context, dependency, true);
try {
Object o = provider.get();
if (o != null && !rawType.isInstance(o)) {
throw errors.subtypeNotProvided(providerType, rawType).toException();
}
@SuppressWarnings("unchecked") // protected by isInstance() check above
T t = (T) o;
return t;
} catch (RuntimeException e) {
throw errors.errorInProvider(e).toException();
}
}
};
Object source = rawType;
return new LinkedProviderBindingImpl(
this,
key,
source,
Scoping.scope(key, this, internalFactory, source, scoping),
scoping,
providerKey);
}
/** Creates a binding for a type annotated with @ImplementedBy. */
private BindingImpl createImplementedByBinding(Key key, Scoping scoping,
ImplementedBy implementedBy, Errors errors)
throws ErrorsException {
Class rawType = key.getTypeLiteral().getRawType();
Class implementationType = implementedBy.value();
// Make sure it's not the same type. TODO: Can we check for deeper cycles?
if (implementationType == rawType) {
throw errors.recursiveImplementationType().toException();
}
// Make sure implementationType extends type.
if (!rawType.isAssignableFrom(implementationType)) {
throw errors.notASubtype(implementationType, rawType).toException();
}
@SuppressWarnings("unchecked") // After the preceding check, this cast is safe.
Class subclass = (Class) implementationType;
// Look up the target binding.
final Key targetKey = Key.get(subclass);
final BindingImpl targetBinding = getBindingOrThrow(targetKey, errors, JitLimitation.NEW_OR_EXISTING_JIT);
InternalFactory internalFactory = new InternalFactory() {
public T get(Errors errors, InternalContext context, Dependency dependency, boolean linked)
throws ErrorsException {
return targetBinding.getInternalFactory().get(
errors.withSource(targetKey), context, dependency, true);
}
};
Object source = rawType;
return new LinkedBindingImpl(
this,
key,
source,
Scoping.scope(key, this, internalFactory, source, scoping),
scoping,
targetKey);
}
/**
* Attempts to create a just-in-time binding for {@code key} in the root injector, falling back to
* other ancestor injectors until this injector is tried.
*/
private BindingImpl createJustInTimeBindingRecursive(Key key, Errors errors,
boolean jitDisabled, JitLimitation jitType) throws ErrorsException {
// ask the parent to create the JIT binding
if (parent != null) {
try {
return parent.createJustInTimeBindingRecursive(key, new Errors(), jitDisabled,
parent.options.jitDisabled ? JitLimitation.NO_JIT : jitType);
} catch (ErrorsException ignored) {
}
}
if (state.isBlacklisted(key)) {
Set
