/*
* Copyright 2012 Netflix, 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.netflix.governator.guice;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.google.inject.AbstractModule;
import com.google.inject.Injector;
import com.google.inject.Key;
import com.google.inject.Module;
import com.google.inject.ScopeAnnotation;
import com.google.inject.Scopes;
import com.google.inject.TypeLiteral;
import com.google.inject.binder.ScopedBindingBuilder;
import com.google.inject.internal.MoreTypes;
import com.google.inject.multibindings.Multibinder;
import com.google.inject.util.Types;
import com.netflix.governator.annotations.AutoBind;
import com.netflix.governator.annotations.AutoBindSingleton;
import com.netflix.governator.guice.lazy.LazySingletonScope;
import com.netflix.governator.lifecycle.ClasspathScanner;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Collection;
import java.util.Set;
import javax.inject.Singleton;
class InternalAutoBindModule extends AbstractModule
{
private static final Logger LOG = LoggerFactory.getLogger(InternalAutoBindModule.class);
private final Set<Class<?>> ignoreClasses;
private final Injector injector;
private final ClasspathScanner classpathScanner;
InternalAutoBindModule(Injector injector, ClasspathScanner classpathScanner, Collection<Class<?>> ignoreClasses)
{
this.injector = injector;
this.classpathScanner = classpathScanner;
Preconditions.checkNotNull(ignoreClasses, "ignoreClasses cannot be null");
this.ignoreClasses = ImmutableSet.copyOf(ignoreClasses);
}
@Override
protected void configure()
{
bindAutoBindSingletons();
bindAutoBindConstructors();
bindAutoBindMethods();
bindAutoBindFields();
}
private void bindAutoBindFields()
{
for ( Field field : classpathScanner.getFields() )
{
if ( ignoreClasses.contains(field.getDeclaringClass()) )
{
continue;
}
bindAnnotations(field.getDeclaredAnnotations());
}
}
private void bindAutoBindMethods()
{
for ( Method method : classpathScanner.getMethods() )
{
if ( ignoreClasses.contains(method.getDeclaringClass()) )
{
continue;
}
bindParameterAnnotations(method.getParameterAnnotations());
}
}
private void bindAutoBindConstructors()
{
for ( Constructor constructor : classpathScanner.getConstructors() )
{
if ( ignoreClasses.contains(constructor.getDeclaringClass()) )
{
continue;
}
bindParameterAnnotations(constructor.getParameterAnnotations());
}
}
private void bindParameterAnnotations(Annotation[][] parameterAnnotations)
{
for ( Annotation[] annotations : parameterAnnotations )
{
bindAnnotations(annotations);
}
}
private void bindAnnotations(Annotation[] annotations)
{
for ( Annotation annotation : annotations )
{
AutoBindProvider autoBindProvider = getAutoBindProvider(annotation);
if ( autoBindProvider != null )
{
//noinspection unchecked
autoBindProvider.configure(binder(), annotation);
}
}
}
private AutoBindProvider getAutoBindProvider(Annotation annotation)
{
AutoBindProvider autoBindProvider = null;
if ( annotation.annotationType().isAnnotationPresent(AutoBind.class) )
{
ParameterizedType parameterizedType = Types.newParameterizedType(AutoBindProvider.class, annotation.annotationType());
autoBindProvider = (AutoBindProvider<?>)injector.getInstance(Key.get(TypeLiteral.get(parameterizedType)));
}
else if ( annotation.annotationType().isAssignableFrom(AutoBind.class) )
{
autoBindProvider = injector.getInstance(Key.get(new TypeLiteral<AutoBindProvider<AutoBind>>()
{
}));
}
return autoBindProvider;
}
@SuppressWarnings("unchecked")
private void bindAutoBindSingletons()
{
for ( Class<?> clazz : classpathScanner.getClasses() )
{
if ( ignoreClasses.contains(clazz) || !clazz.isAnnotationPresent(AutoBindSingleton.class) )
{
continue;
}
AutoBindSingleton annotation = clazz.getAnnotation(AutoBindSingleton.class);
if ( javax.inject.Provider.class.isAssignableFrom(clazz) )
{
Preconditions.checkState(annotation.value() == Void.class, "@AutoBindSingleton value cannot be set for Providers");
Preconditions.checkState(annotation.baseClass() == Void.class, "@AutoBindSingleton value cannot be set for Providers");
Preconditions.checkState(!annotation.multiple(), "@AutoBindSingleton(multiple=true) value cannot be set for Providers");
LOG.info("Installing @AutoBindSingleton " + clazz.getName());
ProviderBinderUtil.bind(binder(), (Class<javax.inject.Provider>)clazz, Scopes.SINGLETON);
}
else if ( Module.class.isAssignableFrom(clazz) )
{
// Modules are handled by {@link InteranlAutoBindModuleBootstrapModule}
continue;
}
else
{
bindAutoBindSingleton(annotation, clazz);
}
}
}
private void bindAutoBindSingleton(AutoBindSingleton annotation, Class<?> clazz)
{
LOG.info("Installing @AutoBindSingleton '{}'", clazz.getName());
LOG.info("***** @AutoBindSingleton for '{}' is deprecated as of 2015-10-10.\nPlease use a Guice module with bind({}.class).asEagerSingleton() instead.\nSee https://github.com/Netflix/governator/wiki/Auto-Binding",
clazz.getName(), clazz.getSimpleName() );
Singleton singletonAnnotation = clazz.getAnnotation(Singleton.class);
if (singletonAnnotation == null) {
LOG.info("***** {} should also be annotated with @Singleton to ensure singleton behavior", clazz.getName());
}
Class<?> annotationBaseClass = getAnnotationBaseClass(annotation);
if ( annotationBaseClass != Void.class ) // AutoBindSingleton.class is used as a marker to mean "default" because annotation defaults cannot be null
{
Object foundBindingClass = searchForBaseClass(clazz, annotationBaseClass, Sets.newHashSet());
if ( foundBindingClass == null )
{
throw new IllegalArgumentException(String.format("AutoBindSingleton class %s does not implement or extend %s", clazz.getName(), annotationBaseClass.getName()));
}
if ( foundBindingClass instanceof Class )
{
if ( annotation.multiple() )
{
Multibinder<?> multibinder = Multibinder.newSetBinder(binder(), (Class)foundBindingClass);
//noinspection unchecked
applyScope(
multibinder
.addBinding()
.to((Class)clazz),
clazz, annotation);
}
else
{
//noinspection unchecked
applyScope(
binder()
.withSource(getCurrentStackElement())
.bind((Class)foundBindingClass)
.to(clazz),
clazz, annotation);
}
}
else if ( foundBindingClass instanceof Type )
{
TypeLiteral typeLiteral = TypeLiteral.get((Type)foundBindingClass);
if ( annotation.multiple() )
{
Multibinder<?> multibinder = Multibinder.newSetBinder(binder(), typeLiteral);
//noinspection unchecked
applyScope(
multibinder
.addBinding()
.to((Class)clazz),
clazz, annotation);
}
else
{
//noinspection unchecked
applyScope(
binder()
.withSource(getCurrentStackElement())
.bind(typeLiteral).to(clazz),
clazz, annotation);
}
}
else
{
throw new RuntimeException("Unexpected binding class: " + foundBindingClass);
}
}
else
{
Preconditions.checkState(!annotation.multiple(), "@AutoBindSingleton(multiple=true) must have either value or baseClass set");
applyScope(
binder()
.withSource(getCurrentStackElement())
.bind(clazz),
clazz, annotation);
}
}
private StackTraceElement getCurrentStackElement() {
return Thread.currentThread().getStackTrace()[1];
}
private void applyScope(ScopedBindingBuilder builder, Class<?> clazz, AutoBindSingleton annotation) {
if (hasScopeAnnotation(clazz)) {
// Honor scoped annotations first
}
else if (annotation.eager())
{
builder.asEagerSingleton();
}
else
{
builder.in(LazySingletonScope.get());
}
}
private boolean hasScopeAnnotation(Class<?> clazz) {
Annotation scopeAnnotation = null;
for (Annotation annot : clazz.getAnnotations()) {
if (annot.annotationType().isAnnotationPresent(ScopeAnnotation.class)) {
Preconditions.checkState(scopeAnnotation == null, "Multiple scopes not allowed");
scopeAnnotation = annot;
}
}
return scopeAnnotation != null;
}
private Class<?> getAnnotationBaseClass(AutoBindSingleton annotation)
{
Class<?> annotationValue = annotation.value();
Class<?> annotationBaseClass = annotation.baseClass();
Preconditions.checkState((annotationValue == Void.class) || (annotationBaseClass == Void.class), "@AutoBindSingleton cannot have both value and baseClass set");
return (annotationBaseClass != Void.class) ? annotationBaseClass : annotationValue;
}
private Object searchForBaseClass(Class<?> clazz, Class<?> annotationBaseClass, Set<Object> usedSet)
{
if ( clazz == null )
{
return null;
}
if ( clazz.equals(annotationBaseClass) )
{
return clazz;
}
if ( !usedSet.add(clazz) )
{
return null;
}
for ( Type type : clazz.getGenericInterfaces() )
{
if ( MoreTypes.getRawType(type).equals(annotationBaseClass) )
{
return type;
}
}
if ( clazz.getGenericSuperclass() != null )
{
if ( MoreTypes.getRawType(clazz.getGenericSuperclass()).equals(annotationBaseClass) )
{
return clazz.getGenericSuperclass();
}
}
for ( Class<?> interfaceClass : clazz.getInterfaces() )
{
Object foundBindingClass = searchForBaseClass(interfaceClass, annotationBaseClass, usedSet);
if ( foundBindingClass != null )
{
return foundBindingClass;
}
}
return searchForBaseClass(clazz.getSuperclass(), annotationBaseClass, usedSet);
}
}