2017-02-22 13:09:39 -05:00
|
|
|
@title
|
|
|
|
Hierarchical Dependency Injectors
|
|
|
|
|
|
|
|
@intro
|
|
|
|
Angular's hierarchical dependency injection system supports nested injectors in parallel with the component tree.
|
|
|
|
|
|
|
|
@description
|
2017-03-27 11:08:53 -04:00
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
You learned the basics of Angular Dependency injection in the
|
2017-03-11 10:36:40 -05:00
|
|
|
[Dependency Injection](guide/dependency-injection) guide.
|
2017-02-22 13:09:39 -05:00
|
|
|
|
|
|
|
Angular has a _Hierarchical Dependency Injection_ system.
|
|
|
|
There is actually a tree of injectors that parallel an application's component tree.
|
|
|
|
You can reconfigure the injectors at any level of that component tree.
|
|
|
|
|
|
|
|
This guide explores this system and how to use it to your advantage.
|
|
|
|
|
|
|
|
Try the <live-example></live-example>.
|
|
|
|
|
|
|
|
## The injector tree
|
|
|
|
|
2017-03-11 10:36:40 -05:00
|
|
|
In the [Dependency Injection](guide/dependency-injection) guide,
|
2017-02-22 13:09:39 -05:00
|
|
|
you learned how to configure a dependency injector and how to retrieve dependencies where you need them.
|
|
|
|
|
|
|
|
In fact, there is no such thing as ***the*** injector.
|
|
|
|
An application may have multiple injectors.
|
|
|
|
An Angular application is a tree of components. Each component instance has its own injector.
|
|
|
|
The tree of components parallels the tree of injectors.
|
|
|
|
|
2017-03-27 11:08:53 -04:00
|
|
|
|
|
|
|
~~~ {.l-sub-section}
|
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
The component's injector may be a _proxy_ for an ancestor injector higher in the component tree.
|
|
|
|
That's an implementation detail that improves efficiency.
|
|
|
|
You won't notice the difference and
|
|
|
|
your mental model should be that every component has its own injector.
|
2017-03-27 11:08:53 -04:00
|
|
|
|
|
|
|
|
|
|
|
~~~
|
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
Consider this guide's variation on the Tour of Heroes application.
|
|
|
|
At the top is the `AppComponent` which has some sub-components.
|
|
|
|
One of them is the `HeroesListComponent`.
|
|
|
|
The `HeroesListComponent` holds and manages multiple instances of the `HeroTaxReturnComponent`.
|
|
|
|
The following diagram represents the state of the this guide's three-level component tree when there are three instances of `HeroTaxReturnComponent`
|
|
|
|
open simultaneously.
|
|
|
|
|
2017-03-30 15:04:18 -04:00
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
<figure class='image-display'>
|
2017-03-06 05:43:33 -05:00
|
|
|
<img src="assets/images/devguide/dependency-injection/component-hierarchy.png" alt="injector tree" width="600"> </img>
|
2017-02-22 13:09:39 -05:00
|
|
|
</figure>
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
### Injector bubbling
|
2017-02-22 13:09:39 -05:00
|
|
|
|
|
|
|
When a component requests a dependency, Angular tries to satisfy that dependency with a provider registered in that component's own injector.
|
|
|
|
If the component's injector lacks the provider, it passes the request up to its parent component's injector.
|
|
|
|
If that injector can't satisfy the request, it passes it along to *its* parent injector.
|
|
|
|
The requests keep bubbling up until Angular finds an injector that can handle the request or runs out of ancestor injectors.
|
|
|
|
If it runs out of ancestors, Angular throws an error.
|
|
|
|
|
2017-03-27 11:08:53 -04:00
|
|
|
|
|
|
|
~~~ {.l-sub-section}
|
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
You can cap the bubbling. An intermediate component can declare that it is the "host" component.
|
|
|
|
The hunt for providers will climb no higher than the injector for that host component.
|
2017-03-11 08:44:25 -05:00
|
|
|
This is a topic for another day.
|
2017-03-27 11:08:53 -04:00
|
|
|
|
|
|
|
|
|
|
|
~~~
|
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
### Re-providing a service at different levels
|
2017-03-11 08:44:25 -05:00
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
You can re-register a provider for a particular dependency token at multiple levels of the injector tree.
|
2017-03-11 08:44:25 -05:00
|
|
|
You don't *have* to re-register providers. You shouldn't do so unless you have a good reason.
|
2017-02-22 13:09:39 -05:00
|
|
|
But you *can*.
|
|
|
|
|
|
|
|
As the resolution logic works upwards, the first provider encountered wins.
|
|
|
|
Thus, a provider in an intermediate injector intercepts a request for a service from something lower in the tree.
|
|
|
|
It effectively "reconfigures" and "shadows" a provider at a higher level in the tree.
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
If you only specify providers at the top level (typically the root `AppModule`), the tree of injectors appears to be flat.
|
2017-03-31 07:23:16 -04:00
|
|
|
All requests bubble up to the root <code>NgModule</code> injector that you configured with the `bootstrapModule` method.
|
2017-02-22 13:09:39 -05:00
|
|
|
|
|
|
|
## Component injectors
|
|
|
|
|
|
|
|
The ability to configure one or more providers at different levels opens up interesting and useful possibilities.
|
2017-03-11 08:44:25 -05:00
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
### Scenario: service isolation
|
|
|
|
|
|
|
|
Architectural reasons may lead you to restrict access to a service to the application domain where it belongs.
|
|
|
|
|
|
|
|
The guide sample includes a `VillainsListComponent` that displays a list of villains.
|
|
|
|
It gets those villains from a `VillainsService`.
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
While you _could_ provide `VillainsService` in the root `AppModule` (that's where you'll find the `HeroesService`),
|
2017-02-22 13:09:39 -05:00
|
|
|
that would make the `VillainsService` available everywhere in the application, including the _Hero_ workflows.
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
If you later modified the `VillainsService`, you could break something in a hero component somewhere.
|
|
|
|
That's not supposed to happen but providing the service in the root `AppModule` creates that risk.
|
2017-02-22 13:09:39 -05:00
|
|
|
|
|
|
|
Instead, provide the `VillainsService` in the `providers` metadata of the `VillainsListComponent` like this:
|
2017-03-27 11:08:53 -04:00
|
|
|
|
|
|
|
|
|
|
|
<code-example path="hierarchical-dependency-injection/src/app/villains-list.component.ts" linenums="false" title="src/app/villains-list.component.ts (metadata)" region="metadata">
|
|
|
|
|
|
|
|
</code-example>
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
By providing `VillainsService` in the `VillainsListComponent` metadata and nowhere else,
|
2017-02-22 13:09:39 -05:00
|
|
|
the service becomes available only in the `VillainsListComponent` and its sub-component tree.
|
|
|
|
It's still a singleton, but it's a singleton that exist solely in the _villain_ domain.
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
Now you know that a hero component can't access it. You've reduced your exposure to error.
|
2017-02-22 13:09:39 -05:00
|
|
|
|
|
|
|
### Scenario: multiple edit sessions
|
|
|
|
|
|
|
|
Many applications allow users to work on several open tasks at the same time.
|
2017-03-11 08:44:25 -05:00
|
|
|
For example, in a tax preparation application, the preparer could be working on several tax returns,
|
2017-02-22 13:09:39 -05:00
|
|
|
switching from one to the other throughout the day.
|
|
|
|
|
|
|
|
This guide demonstrates that scenario with an example in the Tour of Heroes theme.
|
|
|
|
Imagine an outer `HeroListComponent` that displays a list of super heroes.
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
To open a hero's tax return, the preparer clicks on a hero name, which opens a component for editing that return.
|
2017-02-22 13:09:39 -05:00
|
|
|
Each selected hero tax return opens in its own component and multiple returns can be open at the same time.
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
Each tax return component has the following characteristics:
|
2017-03-27 11:08:53 -04:00
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
* Is its own tax return editing session.
|
|
|
|
* Can change a tax return without affecting a return in another component.
|
|
|
|
* Has the ability to save the changes to its tax return or cancel them.
|
2017-02-22 13:09:39 -05:00
|
|
|
|
2017-03-30 15:04:18 -04:00
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
<figure class='image-display'>
|
2017-03-06 05:43:33 -05:00
|
|
|
<img src="assets/images/devguide/dependency-injection/hid-heroes-anim.gif" width="400" alt="Heroes in action"> </img>
|
2017-02-22 13:09:39 -05:00
|
|
|
</figure>
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
One might suppose that the `HeroTaxReturnComponent` has logic to manage and restore changes.
|
|
|
|
That would be a pretty easy task for a simple hero tax return.
|
2017-02-22 13:09:39 -05:00
|
|
|
In the real world, with a rich tax return data model, the change management would be tricky.
|
|
|
|
You might delegate that management to a helper service, as this example does.
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
Here is the `HeroTaxReturnService`.
|
2017-02-22 13:09:39 -05:00
|
|
|
It caches a single `HeroTaxReturn`, tracks changes to that return, and can save or restore it.
|
2017-03-11 08:44:25 -05:00
|
|
|
It also delegates to the application-wide singleton `HeroService`, which it gets by injection.
|
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
|
2017-03-27 11:08:53 -04:00
|
|
|
<code-example path="hierarchical-dependency-injection/src/app/hero-tax-return.service.ts">
|
|
|
|
|
|
|
|
</code-example>
|
2017-02-22 13:09:39 -05:00
|
|
|
|
|
|
|
Here is the `HeroTaxReturnComponent` that makes use of it.
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
|
2017-03-27 11:08:53 -04:00
|
|
|
<code-example path="hierarchical-dependency-injection/src/app/hero-tax-return.component.ts">
|
|
|
|
|
|
|
|
</code-example>
|
2017-02-22 13:09:39 -05:00
|
|
|
|
|
|
|
The _tax-return-to-edit_ arrives via the input property which is implemented with getters and setters.
|
|
|
|
The setter initializes the component's own instance of the `HeroTaxReturnService` with the incoming return.
|
|
|
|
The getter always returns what that service says is the current state of the hero.
|
|
|
|
The component also asks the service to save and restore this tax return.
|
|
|
|
|
|
|
|
There'd be big trouble if _this_ service were an application-wide singleton.
|
2017-03-11 08:44:25 -05:00
|
|
|
Every component would share the same service instance.
|
2017-02-22 13:09:39 -05:00
|
|
|
Each component would overwrite the tax return that belonged to another hero.
|
|
|
|
What a mess!
|
|
|
|
|
|
|
|
Look closely at the metadata for the `HeroTaxReturnComponent`. Notice the `providers` property.
|
2017-03-27 11:08:53 -04:00
|
|
|
|
|
|
|
|
|
|
|
<code-example path="hierarchical-dependency-injection/src/app/hero-tax-return.component.ts" linenums="false" title="src/app/hero-tax-return.component.ts (providers)" region="providers">
|
|
|
|
|
|
|
|
</code-example>
|
|
|
|
|
2017-03-11 08:44:25 -05:00
|
|
|
The `HeroTaxReturnComponent` has its own provider of the `HeroTaxReturnService`.
|
|
|
|
Recall that every component _instance_ has its own injector.
|
2017-02-22 13:09:39 -05:00
|
|
|
Providing the service at the component level ensures that _every_ instance of the component gets its own, private instance of the service.
|
|
|
|
No tax return overwriting. No mess.
|
|
|
|
|
2017-03-27 11:08:53 -04:00
|
|
|
|
|
|
|
~~~ {.l-sub-section}
|
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
The rest of the scenario code relies on other Angular features and techniques that you can learn about elsewhere in the documentation.
|
2017-03-11 08:44:25 -05:00
|
|
|
You can review it and download it from the <live-example></live-example>.
|
2017-03-27 11:08:53 -04:00
|
|
|
|
|
|
|
|
|
|
|
~~~
|
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
### Scenario: specialized providers
|
|
|
|
|
|
|
|
Another reason to re-provide a service is to substitute a _more specialized_ implementation of that service,
|
|
|
|
deeper in the component tree.
|
|
|
|
|
2017-03-11 10:36:40 -05:00
|
|
|
Consider again the Car example from the [Dependency Injection](guide/dependency-injection) guide.
|
2017-03-11 08:44:25 -05:00
|
|
|
Suppose you configured the root injector (marked as A) with _generic_ providers for
|
2017-02-22 13:09:39 -05:00
|
|
|
`CarService`, `EngineService` and `TiresService`.
|
|
|
|
|
|
|
|
You create a car component (A) that displays a car constructed from these three generic services.
|
|
|
|
|
|
|
|
Then you create a child component (B) that defines its own, _specialized_ providers for `CarService` and `EngineService`
|
|
|
|
that have special capabilites suitable for whatever is going on in component (B).
|
|
|
|
|
|
|
|
Component (B) is the parent of another component (C) that defines its own, even _more specialized_ provider for `CarService`.
|
|
|
|
|
2017-03-30 15:04:18 -04:00
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
<figure class='image-display'>
|
2017-03-06 05:43:33 -05:00
|
|
|
<img src="assets/images/devguide/dependency-injection/car-components.png" alt="car components" width="220"> </img>
|
2017-02-22 13:09:39 -05:00
|
|
|
</figure>
|
|
|
|
|
|
|
|
Behind the scenes, each component sets up its own injector with zero, one, or more providers defined for that component itself.
|
|
|
|
|
|
|
|
When you resolve an instance of `Car` at the deepest component (C),
|
|
|
|
its injector produces an instance of `Car` resolved by injector (C) with an `Engine` resolved by injector (B) and
|
|
|
|
`Tires` resolved by the root injector (A).
|
|
|
|
|
2017-03-30 15:04:18 -04:00
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
<figure class='image-display'>
|
2017-03-06 05:43:33 -05:00
|
|
|
<img src="assets/images/devguide/dependency-injection/injector-tree.png" alt="car injector tree" width="600"> </img>
|
2017-02-22 13:09:39 -05:00
|
|
|
</figure>
|
|
|
|
|
|
|
|
|
2017-03-27 11:08:53 -04:00
|
|
|
|
|
|
|
~~~ {.l-sub-section}
|
|
|
|
|
2017-02-22 13:09:39 -05:00
|
|
|
The code for this _cars_ scenario is in the `car.components.ts` and `car.services.ts` files of the sample
|
2017-03-27 11:08:53 -04:00
|
|
|
which you can review and download from the <live-example></live-example>.
|
|
|
|
|
|
|
|
~~~
|
|
|
|
|