View Javadoc
1   /**
2    * This file Copyright (c) 2011-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.objectfactory.guice;
35  
36  import info.magnolia.objectfactory.MgnlInstantiationException;
37  import info.magnolia.objectfactory.ParameterInfo;
38  import info.magnolia.objectfactory.ParameterResolver;
39  
40  import java.lang.reflect.Modifier;
41  import java.lang.reflect.ParameterizedType;
42  import java.util.List;
43  import java.util.Optional;
44  
45  import javax.inject.Inject;
46  
47  import com.google.inject.Binding;
48  import com.google.inject.ConfigurationException;
49  import com.google.inject.Injector;
50  import com.google.inject.Key;
51  import com.google.inject.Provider;
52  import com.google.inject.TypeLiteral;
53  import com.google.inject.internal.Annotations;
54  import com.google.inject.internal.Errors;
55  import com.google.inject.internal.ErrorsException;
56  
57  /**
58   * Parameter resolver that finds parameters by querying for them in a Guice Injector. Will create javax.inject.Provider
59   * instances that match the parameter's type.
60   */
61  public class GuiceParameterResolver implements ParameterResolver {
62  
63      private final GuiceComponentProvider componentProvider;
64      private final Injector injector;
65  
66      /**
67       * @deprecated since 6.1 - use {@link #GuiceParameterResolver(GuiceComponentProvider)} instead.
68       */
69      @Deprecated
70      public GuiceParameterResolver(Injector injector) {
71          this.componentProvider = null;
72          this.injector = injector;
73      }
74  
75      public GuiceParameterResolver(GuiceComponentProvider componentProvider) {
76          this.componentProvider = componentProvider;
77          this.injector = componentProvider.getInjector();
78      }
79  
80      @Override
81      public Object resolveParameter(ParameterInfo parameter) {
82  
83          // We ask for an existing binding so Guice wont create jit bindings for things like Class and String
84          // This means that all parameters need to be explicitly bound
85  
86          Key<?> key = constructGuiceKey(parameter);
87          Binding<?> existingBinding = this.injector.getExistingBinding(key);
88  
89          if (existingBinding != null) {
90             return existingBinding.getProvider().get();
91          }
92  
93          final Class<?> parameterType = parameter.getParameterType();
94          /*
95           * Since Guice parameter resolver is a last resort one and seems like we're facing an-unresolvable param, let's try to fallback to the
96           * newInstance - flavored provisioning. This might occur in UI component injection cases, since there all the types are wired to a catch-all provider
97           * and Guice's just-in-time binding doesn't work.
98           */
99          if (this.componentProvider != null && parameter.getConstructor().isAnnotationPresent(Inject.class) && !parameterType.isInterface() && !Modifier.isAbstract(parameterType.getModifiers())) {
100             try {
101                 return this.componentProvider.newInstance(parameterType);
102             } catch (Exception e) {
103                 return  UNRESOLVED;
104             }
105         }
106         return  UNRESOLVED;
107     }
108 
109     private Key<?> constructGuiceKey(ParameterInfo parameter) {
110         // Get TypeLiteral for this parameter
111         TypeLiteral<?> declaringType = TypeLiteral.get(parameter.getDeclaringClass());
112         List<TypeLiteral<?>> parameterTypes = declaringType.getParameterTypes(parameter.getConstructor());
113         TypeLiteral<?> parameterType = parameterTypes.get(parameter.getParameterIndex());
114 
115         return constructGuiceKey(parameter, parameterType)
116                 .filter(key ->
117                         GuiceUtils.hasExplicitBindingFor(this.injector, key) ||
118                         Provider.class.isAssignableFrom(key.getTypeLiteral().getRawType()) ||
119                         javax.inject.Provider.class.isAssignableFrom(key.getTypeLiteral().getRawType()))
120                 .orElseGet(() -> {
121                     if (parameterType.getType() instanceof ParameterizedType) {
122                         // When it comes to generics, only the IoC Provider interfaces are handled gracefully (since they're part of the framework).
123                         // For other generic types we can improve the situation by resolving a raw-type key and attempt to inject it (with the hope
124                         // that everything is configured in such a way, that dynamic IoC logic will instantiate a correctly parameterised instance).
125                         return constructGuiceKey(parameter, TypeLiteral.get(parameterType.getRawType())).orElseThrow(() -> new MgnlInstantiationException("Failed to resolve Guice key for generic type [" + parameter.getParameterType() + "]"));
126                     }
127                     return Key.get(parameterType.getRawType());
128                 });
129     }
130 
131     private Optional<Key<?>> constructGuiceKey(ParameterInfo parameter, TypeLiteral<?> parameterType) {
132         try {
133             // Create Key object for this parameter
134             Errors errors = new Errors(parameter.getConstructor());
135             return Optional.of(Annotations.getKey(
136                     parameterType,
137                     parameter.getConstructor(),
138                     parameter.getParameterAnnotations(),
139                     errors));
140         } catch (ErrorsException | ConfigurationException e) {
141             // This might occur e.g. when the parameter type is generic and will be considered 'underspecified' by Guice
142             return Optional.empty();
143         } catch (Exception e) {
144             throw new MgnlInstantiationException("Failed to resolve Guice key for [" + parameter.getParameterType() + "]", e);
145         }
146     }
147 }