Merge pull request #18511 from bhaskar16/BAEL-6028-guice

davidmartinezbarua · web-flow · commit ee2342535f7e · 2025-05-26T14:21:04.000-03:00
[BAEL-6028] Guice Provider and @provides
diff --git a/di-modules/guice/src/main/java/com/baeldung/RunGuice.java b/di-modules/guice/src/main/java/com/baeldung/RunGuice.java
@@ -1,9 +1,9 @@
 
-package com.baeldung.examples;
+package com.baeldung;
 
-import com.baeldung.examples.guice.Communication;
-import com.baeldung.examples.guice.binding.AOPModule;
-import com.baeldung.examples.guice.modules.BasicModule;
+import com.baeldung.guice.Communication;
+import com.baeldung.guice.binding.AOPModule;
+import com.baeldung.guice.modules.BasicModule;
 import com.google.inject.Guice;
 import com.google.inject.Injector;
 import java.util.Scanner;
diff --git a/di-modules/guice/src/main/java/com/baeldung/examples/common/AccountService.java b/di-modules/guice/src/main/java/com/baeldung/examples/common/AccountService.java
diff --git a/di-modules/guice/src/main/java/com/baeldung/examples/common/AuthorService.java b/di-modules/guice/src/main/java/com/baeldung/examples/common/AuthorService.java
diff --git a/di-modules/guice/src/main/java/com/baeldung/examples/common/BookService.java b/di-modules/guice/src/main/java/com/baeldung/examples/common/BookService.java
diff --git a/di-modules/guice/src/main/java/com/baeldung/examples/common/PersonDao.java b/di-modules/guice/src/main/java/com/baeldung/examples/common/PersonDao.java
diff --git a/di-modules/guice/src/main/java/com/baeldung/examples/guice/Foo.java b/di-modules/guice/src/main/java/com/baeldung/examples/guice/Foo.java
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/Communication.java b/di-modules/guice/src/main/java/com/baeldung/guice/Communication.java
@@ -1,11 +1,9 @@
 
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
 import com.google.inject.Inject;
-import com.google.inject.name.Named;
+
 import java.util.Date;
-import java.util.LinkedList;
-import java.util.Queue;
 import java.util.logging.Logger;
 
 /**
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/CommunicationMode.java b/di-modules/guice/src/main/java/com/baeldung/guice/CommunicationMode.java
@@ -1,7 +1,7 @@
 
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
-import com.baeldung.examples.guice.constant.CommunicationModel;
+import com.baeldung.guice.constant.CommunicationModel;
 
 public interface CommunicationMode {
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/DefaultCommunicator.java b/di-modules/guice/src/main/java/com/baeldung/guice/DefaultCommunicator.java
@@ -1,7 +1,7 @@
 
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
-import com.baeldung.examples.guice.marker.Communicator;
+import com.baeldung.guice.marker.Communicator;
 import com.google.inject.Inject;
 import com.google.inject.name.Named;
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/EmailCommunicationMode.java b/di-modules/guice/src/main/java/com/baeldung/guice/EmailCommunicationMode.java
@@ -1,8 +1,8 @@
 
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
-import com.baeldung.examples.guice.aop.MessageSentLoggable;
-import com.baeldung.examples.guice.constant.CommunicationModel;
+import com.baeldung.guice.aop.MessageSentLoggable;
+import com.baeldung.guice.constant.CommunicationModel;
 
 /**
  *
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/Foo.java b/di-modules/guice/src/main/java/com/baeldung/guice/Foo.java
@@ -0,0 +1,4 @@
+package com.baeldung.guice;
+
+public class Foo {
+}
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/FooProcessor.java b/di-modules/guice/src/main/java/com/baeldung/guice/FooProcessor.java
@@ -1,4 +1,4 @@
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
 import com.google.inject.Inject;
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/GuicePersonService.java b/di-modules/guice/src/main/java/com/baeldung/guice/GuicePersonService.java
@@ -1,6 +1,6 @@
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
-import com.baeldung.examples.common.PersonDao;
+import com.baeldung.guice.common.PersonDao;
 import com.google.inject.Inject;
 
 public class GuicePersonService {
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/GuiceUserService.java b/di-modules/guice/src/main/java/com/baeldung/guice/GuiceUserService.java
@@ -1,6 +1,6 @@
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
-import com.baeldung.examples.common.AccountService;
+import com.baeldung.guice.common.AccountService;
 import com.google.inject.Inject;
 
 public class GuiceUserService {
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/IMCommunicationMode.java b/di-modules/guice/src/main/java/com/baeldung/guice/IMCommunicationMode.java
@@ -1,8 +1,8 @@
 
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
-import com.baeldung.examples.guice.aop.MessageSentLoggable;
-import com.baeldung.examples.guice.constant.CommunicationModel;
+import com.baeldung.guice.aop.MessageSentLoggable;
+import com.baeldung.guice.constant.CommunicationModel;
 import com.google.inject.Inject;
 import java.util.logging.Logger;
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/Person.java b/di-modules/guice/src/main/java/com/baeldung/guice/Person.java
@@ -1,4 +1,4 @@
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
 public class Person {
 	private String firstName;
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/SMSCommunicationMode.java b/di-modules/guice/src/main/java/com/baeldung/guice/SMSCommunicationMode.java
@@ -1,8 +1,8 @@
 
-package com.baeldung.examples.guice;
+package com.baeldung.guice;
 
-import com.baeldung.examples.guice.aop.MessageSentLoggable;
-import com.baeldung.examples.guice.constant.CommunicationModel;
+import com.baeldung.guice.aop.MessageSentLoggable;
+import com.baeldung.guice.constant.CommunicationModel;
 import com.google.inject.Inject;
 import java.util.logging.Logger;
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/aop/MessageLogger.java b/di-modules/guice/src/main/java/com/baeldung/guice/aop/MessageLogger.java
@@ -1,7 +1,6 @@
 
-package com.baeldung.examples.guice.aop;
+package com.baeldung.guice.aop;
 
-import com.google.inject.Inject;
 import java.util.logging.Logger;
 import org.aopalliance.intercept.MethodInterceptor;
 import org.aopalliance.intercept.MethodInvocation;
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/aop/MessageSentLoggable.java b/di-modules/guice/src/main/java/com/baeldung/guice/aop/MessageSentLoggable.java
@@ -1,5 +1,5 @@
 
-package com.baeldung.examples.guice.aop;
+package com.baeldung.guice.aop;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/binding/AOPModule.java b/di-modules/guice/src/main/java/com/baeldung/guice/binding/AOPModule.java
@@ -1,8 +1,8 @@
 
-package com.baeldung.examples.guice.binding;
+package com.baeldung.guice.binding;
 
-import com.baeldung.examples.guice.aop.MessageLogger;
-import com.baeldung.examples.guice.aop.MessageSentLoggable;
+import com.baeldung.guice.aop.MessageLogger;
+import com.baeldung.guice.aop.MessageSentLoggable;
 import com.google.inject.AbstractModule;
 import com.google.inject.matcher.Matchers;
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/binding/BasicModule.java b/di-modules/guice/src/main/java/com/baeldung/guice/binding/BasicModule.java
@@ -1,12 +1,12 @@
 
-package com.baeldung.examples.guice.binding;
+package com.baeldung.guice.binding;
 
-import com.baeldung.examples.guice.Communication;
-import com.baeldung.examples.guice.CommunicationMode;
-import com.baeldung.examples.guice.DefaultCommunicator;
-import com.baeldung.examples.guice.EmailCommunicationMode;
-import com.baeldung.examples.guice.IMCommunicationMode;
-import com.baeldung.examples.guice.SMSCommunicationMode;
+import com.baeldung.guice.Communication;
+import com.baeldung.guice.CommunicationMode;
+import com.baeldung.guice.DefaultCommunicator;
+import com.baeldung.guice.EmailCommunicationMode;
+import com.baeldung.guice.IMCommunicationMode;
+import com.baeldung.guice.SMSCommunicationMode;
 import com.google.inject.AbstractModule;
 import com.google.inject.name.Names;
 import java.util.logging.Level;
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/Account.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/Account.java
@@ -1,4 +1,4 @@
-package com.baeldung.examples.common;
+package com.baeldung.guice.common;
 
 public class Account {
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/AccountService.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/AccountService.java
@@ -0,0 +1,5 @@
+package com.baeldung.guice.common;
+
+public interface AccountService {
+
+}
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/AccountServiceImpl.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/AccountServiceImpl.java
@@ -1,4 +1,4 @@
-package com.baeldung.examples.common;
+package com.baeldung.guice.common;
 
 public class AccountServiceImpl implements AccountService {
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/AudioBookService.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/AudioBookService.java
@@ -1,4 +1,4 @@
-package com.baeldung.examples.common;
+package com.baeldung.guice.common;
 
 public interface AudioBookService {
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/AudioBookServiceImpl.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/AudioBookServiceImpl.java
@@ -1,4 +1,4 @@
-package com.baeldung.examples.common;
+package com.baeldung.guice.common;
 
 public class AudioBookServiceImpl implements AudioBookService {
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/AuthorService.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/AuthorService.java
@@ -0,0 +1,5 @@
+package com.baeldung.guice.common;
+
+public interface AuthorService {
+
+}
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/AuthorServiceImpl.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/AuthorServiceImpl.java
@@ -1,4 +1,4 @@
-package com.baeldung.examples.common;
+package com.baeldung.guice.common;
 
 public class AuthorServiceImpl implements AuthorService {
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/BookService.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/BookService.java
@@ -0,0 +1,5 @@
+package com.baeldung.guice.common;
+
+public interface BookService {
+
+}
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/BookServiceImpl.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/BookServiceImpl.java
@@ -1,4 +1,4 @@
-package com.baeldung.examples.common;
+package com.baeldung.guice.common;
 
 public class BookServiceImpl implements BookService {
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/PersonDao.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/PersonDao.java
@@ -0,0 +1,5 @@
+package com.baeldung.guice.common;
+
+public interface PersonDao {
+
+}
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/common/PersonDaoImpl.java b/di-modules/guice/src/main/java/com/baeldung/guice/common/PersonDaoImpl.java
@@ -1,4 +1,4 @@
-package com.baeldung.examples.common;
+package com.baeldung.guice.common;
 
 public class PersonDaoImpl implements PersonDao {
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/constant/CommunicationModel.java b/di-modules/guice/src/main/java/com/baeldung/guice/constant/CommunicationModel.java
@@ -1,5 +1,5 @@
 
-package com.baeldung.examples.guice.constant;
+package com.baeldung.guice.constant;
 
 /**
  *
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/marker/Communicator.java b/di-modules/guice/src/main/java/com/baeldung/guice/marker/Communicator.java
@@ -3,7 +3,7 @@
  * To change this template file, choose Tools | Templates
  * and open the template in the editor.
  */
-package com.baeldung.examples.guice.marker;
+package com.baeldung.guice.marker;
 
 /**
  *
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/modules/BasicModule.java b/di-modules/guice/src/main/java/com/baeldung/guice/modules/BasicModule.java
@@ -1,12 +1,12 @@
 
-package com.baeldung.examples.guice.modules;
+package com.baeldung.guice.modules;
 
-import com.baeldung.examples.guice.Communication;
-import com.baeldung.examples.guice.CommunicationMode;
-import com.baeldung.examples.guice.DefaultCommunicator;
-import com.baeldung.examples.guice.EmailCommunicationMode;
-import com.baeldung.examples.guice.IMCommunicationMode;
-import com.baeldung.examples.guice.SMSCommunicationMode;
+import com.baeldung.guice.Communication;
+import com.baeldung.guice.CommunicationMode;
+import com.baeldung.guice.DefaultCommunicator;
+import com.baeldung.guice.EmailCommunicationMode;
+import com.baeldung.guice.IMCommunicationMode;
+import com.baeldung.guice.SMSCommunicationMode;
 import com.google.inject.AbstractModule;
 import com.google.inject.name.Names;
 import java.util.logging.Level;
@@ -24,9 +24,9 @@ protected void configure() {
             bind(Communication.class).toConstructor(Communication.class.getConstructor(Boolean.class));
             bind(Boolean.class).toInstance(true);
         } catch (NoSuchMethodException ex) {
-            Logger.getLogger(com.baeldung.examples.guice.binding.BasicModule.class.getName()).log(Level.SEVERE, null, ex);
+            Logger.getLogger(com.baeldung.guice.binding.BasicModule.class.getName()).log(Level.SEVERE, null, ex);
         } catch (SecurityException ex) {
-            Logger.getLogger(com.baeldung.examples.guice.binding.BasicModule.class.getName()).log(Level.SEVERE, null, ex);
+            Logger.getLogger(com.baeldung.guice.binding.BasicModule.class.getName()).log(Level.SEVERE, null, ex);
         }
         bind(DefaultCommunicator.class).annotatedWith(Names.named("AnotherCommunicator")).to(DefaultCommunicator.class).asEagerSingleton();
 
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/modules/GuiceModule.java b/di-modules/guice/src/main/java/com/baeldung/guice/modules/GuiceModule.java
@@ -1,13 +1,13 @@
-package com.baeldung.examples.guice.modules;
+package com.baeldung.guice.modules;
 
-import com.baeldung.examples.common.AccountService;
-import com.baeldung.examples.common.AccountServiceImpl;
-import com.baeldung.examples.common.BookService;
-import com.baeldung.examples.common.BookServiceImpl;
-import com.baeldung.examples.common.PersonDao;
-import com.baeldung.examples.common.PersonDaoImpl;
-import com.baeldung.examples.guice.Foo;
-import com.baeldung.examples.guice.Person;
+import com.baeldung.guice.common.AccountService;
+import com.baeldung.guice.common.AccountServiceImpl;
+import com.baeldung.guice.common.BookService;
+import com.baeldung.guice.common.BookServiceImpl;
+import com.baeldung.guice.common.PersonDao;
+import com.baeldung.guice.common.PersonDaoImpl;
+import com.baeldung.guice.Foo;
+import com.baeldung.guice.Person;
 import com.google.inject.AbstractModule;
 import com.google.inject.Provider;
 import com.google.inject.Provides;
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/provider/EmailNotifier.java b/di-modules/guice/src/main/java/com/baeldung/guice/provider/EmailNotifier.java
@@ -0,0 +1,26 @@
+package com.baeldung.guice.provider;
+
+import com.google.inject.Provider;
+import java.util.logging.Logger;
+
+public class EmailNotifier implements Notifier, Provider<Notifier> {
+
+    private String smtpUrl;
+    private String user;
+    private String password;
+    private EmailNotifier emailNotifier;
+    Logger log = Logger.getLogger(EmailNotifier.class.getName());
+
+    @Override
+    public Notifier get() {
+        // perform some initialization for email notifier
+        this.smtpUrl = "smtp://localhost:25";
+        emailNotifier = new EmailNotifier();
+        return emailNotifier;
+    }
+
+    @Override
+    public void sendNotification(String message) {
+        log.info("Sending email notification: " + message);
+    }
+}
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/provider/Logger.java b/di-modules/guice/src/main/java/com/baeldung/guice/provider/Logger.java
@@ -0,0 +1,6 @@
+package com.baeldung.guice.provider;
+
+
+public interface Logger {
+    String log(String message);
+}
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/provider/MyGuiceModule.java b/di-modules/guice/src/main/java/com/baeldung/guice/provider/MyGuiceModule.java
@@ -0,0 +1,31 @@
+package com.baeldung.guice.provider;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.Provides;
+import com.google.inject.name.Names;
+
+public class MyGuiceModule extends AbstractModule {
+    /**
+     * This method is called when the Guice injector is created.
+     * It binds the Notifier interface to the EmailNotifier implementation.
+     */
+
+    @Override
+    protected void configure() {
+        bind(Notifier.class).annotatedWith(Names.named("Email"))
+          .toProvider(EmailNotifier.class);
+
+        bind(Notifier.class).annotatedWith(Names.named("Phone"))
+          .toProvider(PhoneNotifier.class);
+    }
+
+    @Provides
+    public Logger provideLogger() {
+        return new Logger() {
+            @Override
+            public String log(String message) {
+                return "Logging message: " + message;
+            }
+        };
+    }
+}
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/provider/MyService.java b/di-modules/guice/src/main/java/com/baeldung/guice/provider/MyService.java
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/provider/Notifier.java b/di-modules/guice/src/main/java/com/baeldung/guice/provider/Notifier.java
diff --git a/di-modules/guice/src/main/java/com/baeldung/guice/provider/PhoneNotifier.java b/di-modules/guice/src/main/java/com/baeldung/guice/provider/PhoneNotifier.java
diff --git a/di-modules/guice/src/test/java/com/baeldung/guice/GuiceProviderUnitTest.java b/di-modules/guice/src/test/java/com/baeldung/guice/GuiceProviderUnitTest.java
diff --git a/di-modules/guice/src/test/java/com/baeldung/guice/GuiceUnitTest.java b/di-modules/guice/src/test/java/com/baeldung/guice/GuiceUnitTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`
`2`		`-package com.baeldung.examples.guice;`
	`2`	`+package com.baeldung.guice;`
`3`	`3`
`4`		`-import com.baeldung.examples.guice.aop.MessageSentLoggable;`
`5`		`-import com.baeldung.examples.guice.constant.CommunicationModel;`
	`4`	`+import com.baeldung.guice.aop.MessageSentLoggable;`
	`5`	`+import com.baeldung.guice.constant.CommunicationModel;`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`*`