How to have a Guice module use another Guice module?

Question

Let's say I have a Guice module ProdModule that I would like to depend on other GuiceModules, ProdDbModule and ProdPubSubModule. How would I implement ProdModule's configure()?

user11153 · Accepted Answer · 2016-11-11 00:42:14Z

57

You would install your other modules

protected void configure(){
    install(new ProdDbModule());
    install(new ProdPubSubModule());
    // etc.
}

edited Nov 11, 2016 at 0:42

user11153

8,9866 gold badges52 silver badges51 bronze badges

answered Aug 19, 2011 at 23:13

Jeremy

22.5k4 gold badges71 silver badges82 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

ColinD · Accepted Answer · 2011-08-20 18:30:07Z

33

While it can be convenient to use install, you don't even need to install the other modules as long as you provide all the necessary modules when you create your Injector:

Injector injector = Guice.createInjector(new ProdDbModule(),
    new ProdPubSubModule(), new ProdModule());

This can give you more flexibility to change out just one of these modules in your entry point class without needing to modify ProdModule itself. You can also indicate in a module what bindings it requires other modules to provide using the requireBinding methods.

answered Aug 20, 2011 at 18:30

ColinD

110k30 gold badges205 silver badges205 bronze badges

Comments

Alexander Oh · Accepted Answer · 2016-12-06 10:56:31Z

11

You can use Modules.combine to create a new module that contains all the other modules. (See this link)

The differences:

this is not subject to tight coupling modules like install()
this creates a Module rather than an injector, which means you can easily add different modules to the injector.

Code

import com.google.inject.util.Modules;
Module module = Modules.combine(new ProdDbModule(),
  new ProdPubSubModule(), new ProdModule());
Injector injector = Guice.createInjector(module);

answered Dec 6, 2016 at 10:56

Alexander Oh

26k17 gold badges81 silver badges84 bronze badges

2 Comments

Óscar López Over a year ago

And what would be the difference w.r.t. simply calling Guice.createInjector(new ProdDbModule(), new ProdPubSubModule(), new ProdModule())?

Alexander Oh Over a year ago

nothing. combine is useful if you want to share the same list of modules in multiple places, and perhaps want a tree of modules instead of a list.

Collectives™ on Stack Overflow

How to have a Guice module use another Guice module?

3 Answers 3

Comments

Comments

Code

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Code

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related