google / dagger

A fast dependency injector for Android and Java.
https://dagger.dev
Apache License 2.0
17.44k stars 2.01k forks source link

Component which dependent from other components with different scopes #747

Closed ultraon closed 7 years ago

ultraon commented 7 years ago

Hello, i have complex multi-tier architecture in my Android project.

Currently i want to use the following structure of the DI components and modules:

[Data Layer]
    @DataScope //scope is used for caching (Singleton) some Data Layer entities for whole application
    - DataComponent //exposes just interfaces which should be used on the BL Layer
        //Modules exposes entities for internal (Data Layer) injections and entities which exposed by DataComponent for BL Layer
        * DataModule1
        * DataModule2
        * DataModule3

[Business Logic Layer] (also has component dependency on DataComponent)
    @BlScope //scope is used for caching (Singleton) some BL Layer entities for whole application
    - BlComponent //exposes just interfaces which should be used on the Service Layer & Presentation Layer
        //Modules exposes entities for internal (BL Layer) injections and entities which exposed by BLComponent for the Service Layer & Presentation Layer
        * BlModule1
        * BlModule2

[Service Layer] (also has component dependency on BlComponent) - this layer has Android specific entities (Android Service, ContentProvider) not related to the Presentation Layer
    @ServiceScope //scope is used for caching (Singleton) some Service Layer entities for whole application
    - ServiceComponent //exposes just interfaces which should be used on the Presentation Layer
        * ServiceModule //Module exposes entities for internal (Service Layer) injections and entities which exposed by ServiceComponent for the Presentation Layer

[Presentation Layer] (also has component dependency on: ServiceComponent, BlComponent)
    @PresentationScope //scope is used for caching (Singleton) some Presentation Layer entities for whole application
    - PresentationComponent //exposes just interfaces which should be used on the current layer
        * PresentationModule //Module exposes entities injections on the current layer

To build the main graph i use the following code:

DataComponent dataComponent = DaggerDataComponent.builder().<addModules>.build();
BlComponent dataComponent = DaggerBlComponent.builder().<addModules>.dataComponent(dataComponent).build();
ServiceComponent serviceComponent = DaggerServiceComponent.builder().<addModule>.blComponent(blComponent).build();
PresentationComponent presentationComponent = DaggerPresentationComponent.builder().<addModule>.blComponent(blComponent).serviceComponent(serviceComponent).build();

In the PresentationLayer i use only "presentationComponent" to provide required dependencies from ServiceComponent/Layer and BLComponent/Layer.

Currently scenario above doesn't work, because PresentationComponent depends on the 2 scoped components with the error "...depends on more than one scoped component:...". Though it allows to use one scoped component with many non-scoped components. This architecture is directed to restrict to use internal layer entities on the upper layers and in the same time to have independent tests (unit & instrumentation) on each layer/module.

Could anybody help me to understand is it bug or desirable behavior of the Dagger processor? (and why?)

ronshapiro commented 7 years ago

Please ask this on Stack Overflow, not on the issue tracker.

ultraon commented 7 years ago

Sorry, but i think it's a bug, because i didn't find any reason in current Dagger2 doc. May be you can confirm fact of bug or not? (then if no - i'll ask my question on the Stack Overflow)

ronshapiro commented 7 years ago

It's not a bug. Component hierarchies that mix scopes in this way are not supported.

ultraon commented 7 years ago

Thank you, i hope i'll get more details about it. I asked question here: https://stackoverflow.com/questions/44157859/component-which-dependent-from-other-components-with-different-scopes-component

aouledissa commented 6 years ago

@ultraon I'm trying to implement the same setup using multi-layer android project and dagger 2.15. Can you please point me to how you have solved this problem? please consider that i want to abstract each layer and only expose the interfaces used to talk to other layers. Thanks in advance.

ultraon commented 6 years ago

@andromedcodes I solved this issue by extending ServiceComponent with BlComponent and PresentationComponent with ServiceComponent. But it is a hack and I don't like it. BTW PresentationScope can include others components as dependencies but only one from this components can has a scope. It is very strange for me.

Tagakov commented 6 years ago

I agree with @ultraon. What is the motivation behind the decision to allow having only one scoped component's dependency? The answer on SO explains nothing. As @ultraon mentioned on SO if component's dependencies don't expose the same types everything should be fine. In any case you can't know that the type provided by provision method is scoped or not (or distinguish its scope).

In my case I've used interfaces only with provision methods extracted from my components as dependencies, which hides the actual components and their scopes. After @guliash showed me this issue, I began to worry that by hiding components (and scopes) behind interfaces, I was using a bug in validation and as soon as it was fixed by forbidding usage of interfaces not marked by @Component annotation as component's dependencies, all my architecture would block me from updating dagger in project. @ronshapiro, is using interfaces without @Component annotation as dependencies of components a valid approach or is it a bug that would be fixed in future?

Tagakov commented 6 years ago

In the #1225 @ronshapiro confirmed usage of interfaces without @Component annotation as dependencies as valid approach.