Add support for jakarta.inject to core Guice.

This does not add support for `toProvider(...)` to instances of `jakarta.inject.Provider` or classes/keys/typeLiterals of type `jakarta.inject.Provider`. See #1383 (comment) for details of the plans. The Guice 6.0 release will support `javax.inject` _and_ `jakarta.inject` (excluding `toProvider()` support for `jakarta.inject`), and the Guice 7.0+ release will remove the `javax.inject` references. Further background on these issues: * #1630 * #1679 * #1490 * #1383 PiperOrigin-RevId: 526763665
google · Apr 26, 2023 · 90f194e · 90f194e
1 parent e17e8af
commit 90f194e
Show file tree

Hide file tree

Showing 36 changed files with 1,235 additions and 82 deletions.
diff --git a/WORKSPACE b/WORKSPACE
@@ -36,6 +36,7 @@ maven_install(
         "com.google.guava:guava:31.0.1-jre",
         "commons-logging:commons-logging:1.2",
         "javax.inject:javax.inject:1",
+        "jakarta.inject:jakarta.inject-api:2.0.1",
         "javax.persistence:javax.persistence-api:2.2",
         "javax.servlet:servlet-api:2.5",
         "org.apache.struts:struts2-core:2.5.30",
@@ -75,6 +76,12 @@ maven_install(
             "1",
             testonly = True,
         ),
+        maven.artifact(
+            "jakarta.inject",
+            "jakarta.inject-tck",
+            "2.0.1",
+            testonly = True,
+        ),
         maven.artifact(
             "junit",
             "junit",

diff --git a/core/pom.xml b/core/pom.xml
@@ -18,6 +18,10 @@
       <groupId>javax.inject</groupId>
       <artifactId>javax.inject</artifactId>
     </dependency>
+    <dependency>
+      <groupId>jakarta.inject</groupId>
+      <artifactId>jakarta.inject-api</artifactId>
+    </dependency>
     <dependency>
       <groupId>aopalliance</groupId>
       <artifactId>aopalliance</artifactId>
@@ -90,6 +94,21 @@
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>animal-sniffer-maven-plugin</artifactId>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>3.11.0</version>
+        <configuration>
+          <testExcludes>
+            <!--
+              Don't compile the jakarta TCK b/c it would clash w/ the javax.inject TCK.
+              We test it with the Bazel build for now, and basic jakarta functionality is tested
+              with the JakartaTest in the same package.
+            -->
+            <testExclude>**/GuiceJakartaTck.java</testExclude>
+          </testExcludes>
+        </configuration>
+      </plugin>
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
         <configuration>

diff --git a/core/src/com/google/inject/BUILD b/core/src/com/google/inject/BUILD
@@ -97,6 +97,7 @@ java_library(
         "//third_party/java/error_prone:annotations",
         "//third_party/java/jsr305_annotations",
         "//third_party/java/jsr330_inject",
+        "//third_party/java/jakarta_inject",
     ],
 )
 

diff --git a/core/src/com/google/inject/Provider.java b/core/src/com/google/inject/Provider.java
@@ -21,24 +21,24 @@
  * by Guice:
  *
  * <ul>
- * <li>When the default means for obtaining instances (an injectable or parameterless constructor)
- *     is insufficient for a particular binding, the module can specify a custom {@code Provider}
- *     instead, to control exactly how Guice creates or obtains instances for the binding.
- * <li>An implementation class may always choose to have a {@code Provider<T>} instance injected,
- *     rather than having a {@code T} injected directly. This may give you access to multiple
- *     instances, instances you wish to safely mutate and discard, instances which are out of scope
- *     (e.g. using a {@code @RequestScoped} object from within a {@code @SessionScoped} object), or
- *     instances that will be initialized lazily.
- * <li>A custom {@link Scope} is implemented as a decorator of {@code Provider<T>}, which decides
- *     when to delegate to the backing provider and when to provide the instance some other way.
- * <li>The {@link Injector} offers access to the {@code Provider<T>} it uses to fulfill requests for
- *     a given key, via the {@link Injector#getProvider} methods.
+ *   <li>When the default means for obtaining instances (an injectable or parameterless constructor)
+ *       is insufficient for a particular binding, the module can specify a custom {@code Provider}
+ *       instead, to control exactly how Guice creates or obtains instances for the binding.
+ *   <li>An implementation class may always choose to have a {@code Provider<T>} instance injected,
+ *       rather than having a {@code T} injected directly. This may give you access to multiple
+ *       instances, instances you wish to safely mutate and discard, instances which are out of
+ *       scope (e.g. using a {@code @RequestScoped} object from within a {@code @SessionScoped}
+ *       object), or instances that will be initialized lazily.
+ *   <li>A custom {@link Scope} is implemented as a decorator of {@code Provider<T>}, which decides
+ *       when to delegate to the backing provider and when to provide the instance some other way.
+ *   <li>The {@link Injector} offers access to the {@code Provider<T>} it uses to fulfill requests
+ *       for a given key, via the {@link Injector#getProvider} methods.
  * </ul>
  *
  * @param <T> the type of object this provides
  * @author [email protected] (Bob Lee)
  */
-public interface Provider<T> extends javax.inject.Provider<T> {
+public interface Provider<T> extends javax.inject.Provider<T>, jakarta.inject.Provider<T> {
 
   /**
    * Provides an instance of {@code T}.

diff --git a/core/src/com/google/inject/Scopes.java b/core/src/com/google/inject/Scopes.java
@@ -69,7 +69,8 @@ public Boolean visitNoScoping() {
         @Override
         public Boolean visitScopeAnnotation(Class<? extends Annotation> scopeAnnotation) {
           return scopeAnnotation == Singleton.class
-              || scopeAnnotation == javax.inject.Singleton.class;
+              || scopeAnnotation == javax.inject.Singleton.class
+              || scopeAnnotation == jakarta.inject.Singleton.class;
         }
 
         @Override

diff --git a/core/src/com/google/inject/internal/Annotations.java b/core/src/com/google/inject/internal/Annotations.java
@@ -345,7 +345,9 @@ boolean hasAnnotations(Class<? extends Annotation> annotated) {
   }
 
   private static final AnnotationChecker scopeChecker =
-      new AnnotationChecker(Arrays.asList(ScopeAnnotation.class, javax.inject.Scope.class));
+      new AnnotationChecker(
+          Arrays.asList(
+              ScopeAnnotation.class, javax.inject.Scope.class, jakarta.inject.Scope.class));
 
   public static boolean isScopeAnnotation(Class<? extends Annotation> annotationType) {
     return scopeChecker.hasAnnotations(annotationType);
@@ -402,7 +404,8 @@ public static Annotation findBindingAnnotation(
   }
 
   private static final AnnotationChecker bindingAnnotationChecker =
-      new AnnotationChecker(Arrays.asList(BindingAnnotation.class, Qualifier.class));
+      new AnnotationChecker(
+          Arrays.asList(BindingAnnotation.class, Qualifier.class, jakarta.inject.Qualifier.class));
 
   /** Returns true if annotations of the specified type are binding annotations. */
   public static boolean isBindingAnnotation(Class<? extends Annotation> annotationType) {
@@ -416,6 +419,8 @@ public static boolean isBindingAnnotation(Class<? extends Annotation> annotation
   public static Annotation canonicalizeIfNamed(Annotation annotation) {
     if (annotation instanceof javax.inject.Named) {
       return Names.named(((javax.inject.Named) annotation).value());
+    } else if (annotation instanceof jakarta.inject.Named) {
+      return Names.named(((jakarta.inject.Named) annotation).value());
     } else {
       return annotation;
     }
@@ -427,7 +432,8 @@ public static Annotation canonicalizeIfNamed(Annotation annotation) {
    */
   public static Class<? extends Annotation> canonicalizeIfNamed(
       Class<? extends Annotation> annotationType) {
-    if (annotationType == javax.inject.Named.class) {
+    if (annotationType == javax.inject.Named.class
+        || annotationType == jakarta.inject.Named.class) {
       return Named.class;
     } else {
       return annotationType;

diff --git a/core/src/com/google/inject/internal/InjectorShell.java b/core/src/com/google/inject/internal/InjectorShell.java
@@ -339,6 +339,7 @@ public void configure(Binder binder) {
       binder = binder.withSource(SourceProvider.UNKNOWN_SOURCE);
       binder.bindScope(Singleton.class, SINGLETON);
       binder.bindScope(javax.inject.Singleton.class, SINGLETON);
+      binder.bindScope(jakarta.inject.Singleton.class, SINGLETON);
     }
   }
 

diff --git a/core/src/com/google/inject/internal/MoreTypes.java b/core/src/com/google/inject/internal/MoreTypes.java
@@ -77,8 +77,9 @@ public static <T> Key<T> canonicalizeKey(Key<T> key) {
   /**
    * Returns an type that's appropriate for use in a key.
    *
-   * <p>If the raw type of {@code typeLiteral} is a {@code javax.inject.Provider}, this returns a
-   * {@code com.google.inject.Provider} with the same type parameters.
+   * <p>If the raw type of {@code typeLiteral} is a {@code javax.inject.Provider} or {@code
+   * jakarta.inject.Provider}, this returns a {@code com.google.inject.Provider} with the same type
+   * parameters.
    *
    * <p>If the type is a primitive, the corresponding wrapper type will be returned.
    *
@@ -91,11 +92,12 @@ public static <T> TypeLiteral<T> canonicalizeForKey(TypeLiteral<T> typeLiteral)
       throw new ConfigurationException(errors.getMessages());
     }
 
-    if (typeLiteral.getRawType() == javax.inject.Provider.class) {
+    if (typeLiteral.getRawType() == javax.inject.Provider.class
+        || typeLiteral.getRawType() == jakarta.inject.Provider.class) {
       ParameterizedType parameterizedType = (ParameterizedType) type;
 
       // the following casts are generally unsafe, but com.google.inject.Provider extends
-      // javax.inject.Provider and is covariant
+      // javax.inject.Provider & jakarta.inject.Provider and is covariant
       @SuppressWarnings("unchecked")
       TypeLiteral<T> guiceProviderType =
           (TypeLiteral<T>)

diff --git a/core/src/com/google/inject/spi/InjectionPoint.java b/core/src/com/google/inject/spi/InjectionPoint.java
@@ -300,7 +300,8 @@ public static InjectionPoint forConstructorOf(TypeLiteral<?> type, boolean atInj
             .filter(
                 constructor ->
                     constructor.isAnnotationPresent(Inject.class)
-                        || constructor.isAnnotationPresent(javax.inject.Inject.class))
+                        || constructor.isAnnotationPresent(javax.inject.Inject.class)
+                        || constructor.isAnnotationPresent(jakarta.inject.Inject.class))
             .collect(Collectors.toList());
 
     Constructor<?> injectableConstructor = null;
@@ -477,20 +478,21 @@ private static boolean checkForMisplacedBindingAnnotations(Member member, Errors
   abstract static class InjectableMember {
     final TypeLiteral<?> declaringType;
     final boolean optional;
-    final boolean jsr330;
+    final boolean specInject;
     InjectableMember previous;
     InjectableMember next;
 
     InjectableMember(TypeLiteral<?> declaringType, Annotation atInject) {
       this.declaringType = declaringType;
 
-      if (atInject.annotationType() == javax.inject.Inject.class) {
+      if (atInject.annotationType() == javax.inject.Inject.class
+          || atInject.annotationType() == jakarta.inject.Inject.class) {
         optional = false;
-        jsr330 = true;
+        specInject = true;
         return;
       }
 
-      jsr330 = false;
+      specInject = false;
       optional = ((Inject) atInject).optional();
     }
 
@@ -536,6 +538,9 @@ public boolean isFinal() {
 
   static Annotation getAtInject(AnnotatedElement member) {
     Annotation a = member.getAnnotation(javax.inject.Inject.class);
+    if (a == null) {
+      a = member.getAnnotation(jakarta.inject.Inject.class);
+    }
     return a == null ? member.getAnnotation(Inject.class) : a;
   }
 
@@ -646,7 +651,7 @@ boolean removeIfOverriddenBy(
           InjectableMethod possiblyOverridden = iterator.next();
           if (overrides(method, possiblyOverridden.method)) {
             boolean wasGuiceInject =
-                !possiblyOverridden.jsr330 || possiblyOverridden.overrodeGuiceInject;
+                !possiblyOverridden.specInject || possiblyOverridden.overrodeGuiceInject;
             if (injectableMethod != null) {
               injectableMethod.overrodeGuiceInject = wasGuiceInject;
             }
@@ -719,7 +724,7 @@ private static Set<InjectionPoint> getInjectionPoints(
           Annotation atInject = getAtInject(field);
           if (atInject != null) {
             InjectableField injectableField = new InjectableField(current, field, atInject);
-            if (injectableField.jsr330 && Modifier.isFinal(field.getModifiers())) {
+            if (injectableField.specInject && Modifier.isFinal(field.getModifiers())) {
               errors.cannotInjectFinalField(field);
             }
             injectableMembers.add(injectableField);
@@ -837,7 +842,7 @@ private static boolean isEligibleForInjection(Method method, boolean statics) {
 
   private static boolean isValidMethod(InjectableMethod injectableMethod, Errors errors) {
     boolean result = true;
-    if (injectableMethod.jsr330) {
+    if (injectableMethod.specInject) {
       Method method = injectableMethod.method;
       if (Modifier.isAbstract(method.getModifiers())) {
         errors.cannotInjectAbstractMethod(method);