Injecting a dependency into Guice Module

Question

I have a module that acquires and holds an API token (simplified):

@Singleton
public class KeyHolderModule extends AbstractModule {
    // This doesn't seem to be injected
    private @Inject TokenConnector connector;
    private DateTime keyLastRefreshed;
    private String key;
    private Credentials creds = config.getCreds();

    @Override protected void configure() {
        this.key = connector.getToken(creds);
        this.keyLastRefreshed = DateTime.now();
    }

    @Provides @Named("apiKey") public String getKey() {
        // logic to check key last refreshed and handle generating a new one
        return this.key;
    }
}

I get a null pointer error on the line where I try to access the connector (this.key = connector.getToken(creds);), so the connector is obviously not getting wired up correctly.

I've tried creating a constructor and using @Inject there, but I'm manually adding these modules via new to a list in my app bootstrap class, so that's sort of out.

Obviously I'm missing something here -- I could probably just new up a TokenConnector in this case since it doesn't have any dependencies itself, but that wouldn't fix my fundamental failure to grasp what's happening here. So if you want to see (simplified) other pieces of code, or less simplified pieces of this code, let me know.

score 20 · Accepted Answer · edited May 23 '17 at 10:34

20

Though you can't use @Inject for a Module (unless you get the Module from another Injector, which I recommend strongly against), you can easily inject into a @Provides method.

public class KeyHolderModule extends AbstractModule {
    private DateTime keyLastRefreshed;
    private String key;
    private Credentials creds = config.getCreds();

    @Override protected void configure() {}

    @Provides @Named("apiKey") public String getKey(
            TokenConnector connector) {
        // logic to check key last refreshed and handle generating a new one
        this.key = connector.getToken(creds);
        this.keyLastRefreshed = DateTime.now();

        return this.key;
    }
}

The trick here is that a Module is typically manually instantiated at injector creation time, but @Provides methods are invoked when the dependencies they provide are needed. Consequently, the Injector isn't ready to provide anything when the Module is constructed, but @Provides methods invoked throughout the application lifecycle have access to whatever other injector-provided dependencies they might need. When configure is run the Injector is not yet created, the best you can do is call getProvider (though you can't call get on those until the Injector is ready).

I wrote up a variety of other in-Module injection techniques as this SO answer.

edited May 23 '17 at 10:34

Community

1
1

answered Sep 28 '16 at 04:52

Jeff Bowman

90,959
16
217
251

Alternatively I think another way of doing that would be to bind a key-provider, which can be injected and encapsulates the logic + returns the key. Is that the same as using @Provides in terms of guice? – pandaadb Sep 28 '16 at 08:54
1

@pandaadb I don't know if you mean any technical _key-provider_ term I'm unfamiliar with, but I would certainly agree that this is getting a little heavy for a Module. Were this my code to review, I'd certainly consider moving this out to a `Provider` top-level class, or a random POJO that happened to provide keys on demand (which is probably what you meant). – Jeff Bowman Sep 28 '16 at 17:37
Cheers Jeff -- yeah, I actually ended up moving this to another class after all (, but was curious about the circumstances I'd found myself in, since it seemed to reflect a gap in my understanding of guice. Thanks for the answer, I'll mark as accepted. – a p Sep 28 '16 at 18:01
@JeffBowman that's exactly what I meant :) not a technical term, just a provider that provides the keys needed (a key-provider :)) instead of having them injected in the module – pandaadb Sep 29 '16 at 08:43

Injecting a dependency into Guice Module

1 Answers1